最近更新时间:2023.08.22 15:00:57
首次发布时间:2021.02.23 10:42:25
本接口支持通过自定义查询时间段,获取该时间段的请求次数。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeImageXRequestCntUsage | 接口名称。当前 API 的名称为 DescribeImageXRequestCntUsage 。 |
Version | String | 是 | 2018-08-01 | 接口版本。当前 API 的版本为 2018-08-01 。 |
ServiceIds | String | 否 |
| 服务 ID。为空时表示不筛选,支持查询多个服务,使用英文逗号分隔不同的服务。
|
AdvFeats | String | 否 |
| 组件名称。为空时表示不筛选,支持查询多个 |
Templates | String | 否 |
| 模版。为空时表示不筛选,支持查询多个模板,不同的模板使用英文逗号分隔。 |
GroupBy | String | 否 |
| 维度拆分的维度值。不传表示不拆分维度,只能传入单个参数。支持取值如下:
|
StartTime | String | 是 |
| 获取数据起始时间点。日期格式按照 说明 由于仅支持查询近一年历史数据,则若此刻时间为 |
EndTime | String | 是 | 2019-06-02T00:00:00+08:00 | 获取数据结束时间点。日期格式按照ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm ,比如2019-06-02T00:00:00+08:00 。 |
Interval | String | 否 |
| 查询数据的时间粒度。单位为秒。缺省时查询 StartTime 和 EndTime 时间段全部数据,此时单次查询最大时间跨度为 93 天。支持取值如下:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestCntData | Array of RequestCntData | 请求次数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AdvFeat | String | enhance | 附加组件类型,GroupBy 包含AdvFeat 时有返回值。如:enhance,smartcut。取值为total ,表示包含所选AdvFeat 实际请求次数。 |
Data | Array of Data | 具体数据 | |
ServiceId | String | ih**9j | 服务 ID,GroupBy 包含ServiceId 时有返回值。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2019-06-02T00:00:00+08:00 | 统计时间点,时间片开始时刻。按照ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm 。 |
Value | Integer | 73538 | 请求次 |
GET https://imagex.volcengineapi.com/?Action=DescribeImageXRequestCntUsage&Version=2018-08-01&AdvFeats=a1%2Ca2&EndTime=2019-06-02T00%3A00%3A00%2B08%3A00&GroupBy=AdvFeat&Interval=300&ServiceIds=s1%2Cs2&StartTime=2019-06-02T00%3A00%3A00%2B08%3A00&Templates=tplv-xyz-xxx
{ "ResponseMetadata": { "RequestId": "20220322174114010204055149180006F0", "Action": "DescribeImageXRequestCntUsage", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1" }, "Result": { "RequestCntData": [ { "AdvFeat": "enhance", "Data": [ { "TimeStamp": "2022-07-10T00:00:00+08:00", "Value": 4402081 }, { "TimeStamp": "2022-07-11T00:00:00+08:00", "Value": 4184814 } ] } ] } }
访问公共错误码和 veImageX 错误码获取详细信息。
为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: