最近更新时间:2023.07.04 20:07:09
首次发布时间:2022.12.29 16:35:53
查询当前账号下对应域名的 CDN 流量命中率用量数据。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeImageXHitRateTrafficData | 接口名称。DescribeImageXHitRateTrafficData |
Version | String | 是 | 2018-08-01 | 接口版本。当前 API 的版本为 2018-08-01 。 |
StartTime | String | 是 |
| 获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。例如 说明 由于仅支持查询近 93 天的历史数据,则若此刻时间为 |
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 | 否 |
| 查询数据的时间粒度,单位为秒。缺省时查询
|
ServiceIds | String | 否 |
| 限制查询的服务 ID,传入多个时用英文逗号分割。缺省情况下表示不限制服务 ID。
|
DomainNames | String | 否 |
| 限制查询的域名,传入多个时用英文逗号分割。缺省情况下表示不限制域名。 |
GroupBy | String | 否 | DomainName | 需要分组查询的参数。仅支持取值DomainName 。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
HitRateData | Array of HitRateData | 命中率数据 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array of Data | 具体数据 | |
DomainName | String | xxx.com | 域名,当GroupBy 指定了DomainName 时有返回值。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2022-10-19T00:00:00+08:00 | 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。 |
Value | Number | 0.2 | 流量命中率。 |
GET https://imagex.volcengineapi.com/?Action=DescribeImageXHitRateTrafficData&Version=2018-08-01&DomainNames=xxx.com%2Cyyy.com&EndTime=2019-06-02T00%3A00%3A00%2B08%3A00&GroupBy=DomainName&Interval=300&ServiceIds=yslwo7o7yj%2C4qprtghcn6&StartTime=2019-06-02T00%3A00%3A00%2B08%3A00
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"DescribeImageXHitRateTrafficData", "Version":"2018-08-01", "Service":"imagex", "Region":"cn-north-1", }, "Result": { "HitRateData": [ { "Data": [ { "TimeStamp": "2022-10-19T00:00:00+08:00", "Value": 0.2 } ], "DomainName": "xxx.com" } ] } }
访问公共错误码和 veImageX 错误码获取详细信息。
为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: