最近更新时间:2023.09.06 11:03:28
首次发布时间:2022.12.29 10:10:01
API 名称:DescribeCdnData
API 域名:open.volcengineapi.com
API 描述:查询用户对 CDN 节点的请求统计数据。
POST
在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
Action | String | 是 | API 的名称。该参数的取值是 DescribeCdnData 。 | DescribeCdnData |
Version | String | 是 | API 的版本。该参数的取值是 2022-03-01 。 | 2022-03-01 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
---|---|---|---|---|
StartTime | Integer | 是 | 指定一个时间段的起点,查询该时间段内(包含起点)的数据。使用时间戳表示,单位为秒。 时间段按照您设置的 Interval 值向前规整。示例:假设 Interval 为 5 分钟(对应秒级时间戳 300),那么 1644163200 和 1644163499 都会规整为 1644163200。 | 1668789300 |
EndTime | Integer | 是 | 指定一个时间段的终点,查询该时间段内(不包含终点)的数据。使用时间戳表示,单位为秒。 时间段按照您设置的 Interval 值向前规整。示例:假设 Interval 为 5 分钟(对应秒级时间戳 300),那么 1644163200 和 1644163499 都会规整为 1644163200。 | 1668790200 |
Metric | String | 是 | 指定一个要查询的指标。该参数有以下取值:
| flux |
Interval | String | 否 | 指定返回数据的时间间隔。该参数有以下取值:
| 5min |
Domain | String | 否 | 指定一个或多个域名,查询对应域名的数据。多个域名间使用半角逗号(,)分隔。最多允许设置 10 个域名。
| a.example.com,b.example.com |
DomainId | String | 否 | 指定一个或多个域名的 ID,查询对应域名的数据。多个域名 ID 间使用半角逗号(,)分隔。最多允许设置 10 个域名 ID。
| 63aa6f9a0708929612b2**** |
CloudAccountId | String | 否 | 指定一个或多个云服务商的账号 ID,查询对应云服务商账号的数据。多个账号 ID 间使用半角逗号(,)分隔。
| 6376e8be0b2233bf5431**** |
Country | String | 否 | 设置地区所属国家的英文代码。如果您设置 Region,则必须设置该参数为 CN。 | CN |
Region | String | 否 | 设置一个地区的英文代码,查询对应地区的数据。
| SH |
Isp | String | 否 | 设置一个运营商的英文名,查询对应运营商的数据。
| TELECOM |
Protocol | String | 否 | 设置客户端请求的应用层协议,查询对应协议的数据。该参数有以下取值:
| http |
IpVersion | String | 否 | 设置客户端请求的网络层协议,查询对应协议的数据。该参数有以下取值:
| ipv6 |
Aggregate | String | 否 | 查询多个域名、域名 ID、云服务商账号的数据时,设置返回数据的类型。该参数有以下取值:
| disaggregate |
参数名称 | 数据类型 | 参数说明 | 示例 |
---|---|---|---|
Resources | ResourceStatData[] | 查询到的数据明细。 | |
VendorsMetaData | VendorMetaData[] | 多云CDN向云服务商发起的查询请求的相关信息。 |
POST open.volcengineapi.com?Action=DescribeCdnData&Version=2022-03-01&<其他公共请求参数> { "StartTime": 1668789300, "EndTime": 1668790200, "Metric": "flux", "CloudAccountId": "6376e8be0b2233bf5431****" }
{ "ResponseMetadata": { "RequestID": "202212272213337222883A6F6C8D732329", "Action": "DescribeCdnData", "Version": "2022-03-01", "Service": "mcdn", "Region": "cn-north-1" }, "Result": { "Resources": [ { "Name": "total", "Metrics": [ { "Metric": "flux", "Values": [ { "Timestamp": 1668789300, "Value": 798820526.9 }, { "Timestamp": 1668789600, "Value": 797321710.9 }, { "Timestamp": 1668789900, "Value": 791070505.5 } ] } ] } ], "VendorsMetaData": null } }
如果响应正文的 ResponseMetadata
字段中包含 Error
字段,则表示 API 请求失败。关于更多错误码的信息,参见错误码。