最近更新时间:2023.07.05 10:11:34
首次发布时间:2022.12.29 16:35:42
查询当前账号下对应域名的边缘请求次数。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeImageXEdgeRequest | 接口名称。DescribeImageXEdgeRequest |
Version | String | 是 | 2018-08-01 | 接口版本 |
ServiceIds | String | 否 |
| 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
|
DomainNames | String | 否 |
| 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 |
Regions | String | 否 |
| 区域。传入多个时用英文逗号作为分割符,缺省情况下表示查询所有区域。取值如下所示:
|
UserCountry | String | 否 |
| 客户端国家。传入多个时用英文逗号作为分割符,缺省情况下表示不过滤。可调用获取边缘分发地区列表获取 IP 解析后的客户端国家。取值如下所示:
|
UserProvince | String | 否 | 北京 | 客户端省份。传入多个用英文逗号分割。缺省情况下表示不过滤。可调用获取边缘分发地区列表获取 IP 解析后的客户端省份。 |
Protocols | String | 否 |
| 过滤网络协议。传入多个用英文逗号分割。缺省情况下表示不过滤。取值如下所示:
|
Isp | String | 否 |
| 过滤运营商。传入多个用英文逗号分割,缺省情况下表示不过滤。取值如下所示:
|
DataTypes | String | 是 |
| 状态码。传入多个时用英文逗号分隔。支持以下取值:
|
GroupBy | String | 否 |
| 需要分组查询的参数。传入多个用英文逗号分割。支持以下取值:
|
StartTime | String | 是 |
| 获取数据起始时间点。日期格式按照 说明 由于仅支持查询近 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 | 否 |
| 查询数据的时间粒度。单位为秒,缺省时查询
|
DetailedCode | Boolean | 否 |
| 是否拆分状态码。取值如下所示:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestCnt | Array of RequestCnt | 计量数据 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array of Data | 具体数据 | |
DataType | String | 500 | 状态码,当GroupBy 带有DataType 时有返回值。 |
DomainName | String | xxx.com | 域名,GroupBy 包含DomainName 时有返回值。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2022-10-19T00:00:00+08:00 | 统计时间点,时间片开始时刻。日期格式按照ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm ,比如 2019-06-02T00:00:00+08:00 。 |
Value | Integer | 211 | 请求次数,单位为次。 |
GET https://imagex.volcengineapi.com/?Action=DescribeImageXEdgeRequest&Version=2018-08-01&DataTypes=req_cnt%2C2xx%2C3xx&DetailedCode=true&DomainNames=xxx.com%2Cyyy.com&EndTime=2019-06-02T00%3A00%3A00%2B08%3A00&GroupBy=DomainName%2CDataType&Interval=300&Isp=%E7%A7%BB%E5%8A%A8%2C%E8%81%94%E9%80%9A&Protocols=HTTP%2CHTTPS&Regions=%E4%B8%AD%E5%9B%BD%E5%A4%A7%E9%99%86%2C%E5%8C%97%E7%BE%8E%E5%8C%BA&ServiceIds=ys%2A%2A%2A%2A%2A%2C4q%2A%2A%2A%2A%2A&StartTime=2019-06-02T00%3A00%3A00%2B08%3A00&UserCountry=%E4%B8%AD%E5%9B%BD&UserProvince=%E5%8C%97%E4%BA%AC
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"DescribeImageXEdgeRequest", "Version":"2018-08-01", "Service":"imagex", "Region":"cn-north-1", }, "Result":{ "RequestCnt":[ { "DataType":"500", "Data":[ { "TimeStamp":"2022-10-19T00:00:00+08:00", "Value":211 } ], "DomainName":"xxx.com" } ] } }
访问公共错误码和 veImageX 错误码获取详细信息。
为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: