本接口支持通过自定义查询时间段,查询该时间段的域名的 CDN 流量命中率用量数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeImageXHitRateTrafficData | 接口名称。当前 API 的名称为 DescribeImageXHitRateTrafficData 。 |
Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01 。 |
ServiceIds | String | 否 | s1,s2 | 服务 ID。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的服务管理模块或者调用 GetAllImageServices 接口获取服务 ID。 |
DomainNames | String | 否 | d1,d2 | 域名。支持查询多个域名,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有域名。您可以通过调用 GetServiceDomains 获取服务下所有域名信息。 |
GroupBy | String | 否 | DomainName | 需要分组查询的参数。取值仅支持DomainName 。 |
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 | 否 |
| 查询数据的时间粒度,单位为秒。缺省时查询
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
HitRateData | Array of HitRateData | - | 命中率数据 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array of Data | - | 具体数据 |
DomainName | String | d1 | 域名,当GroupBy 指定了DomainName 时有返回值。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2023-01-01T00:00:00+08:00 | 统计时间点,时间片开始时刻,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。 |
Value | Float | 0.2 | 流量命中率。 |
GET https://imagex.volcengineapi.com/?Action=DescribeImageXHitRateTrafficData&Version=2023-05-01&ServiceIds=s1,s2&DomainNames=d1,d2&GroupBy=DomainName&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Interval=300
{ "ResponseMetadata": { "RequestId": "202306041104200100100232280022D31", "Action": "DescribeImageXHitRateTrafficData", "Version": "2023-05-01", "Service": "ImageX", "Region": "cn-north-1" }, "Result": { "HitRateData": [ { "Data": [ { "TimeStamp": "2023-01-01T00:00:00+08:00", "Value": 0.2 } ], "DomainName": "d1" } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter | Missing Parameter. | 请求参数错误,请检查您的请求参数是否正确。 |
401 | ParamAccountMismatch | Param {} did not belong to your account. | 请求参数不属于账号,请检查您的请求参数是否正确。 |
500 | InternalError | Internal Error. | 内部错误,请提交工单联系技术支持。 |
veImageX 提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。
2018-08-01 版本 DescribeImageXHitRateTrafficData 接口文档现已停止维护,建议您参考本文档使用最新版本。