调用本接口查询指定 CDN 加速域名的访问者 IP 排行。
说明
多云CDN调用云服务商的相关接口获取热点 IP 数据。如果云服务商不支持热点 IP 数据查询,则无法查询相关数据。
每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制。
本接口提供了以下两种指定加速域名的方式,您只能选择其中一种方式来指定要查询的加速域名:
DomainId:DomainId 是多云CDN为每个同步到多云CDN的加速域名分配的唯一 ID。选择此方式时,不能设置 Domain、Vendor 和 SubProduct,否则请求会失败。Domain、Vendor 和 SubProduct。参数名称 | 数据类型 | 是否必选 | 参数说明 |
|---|---|---|---|
Action | String | 是 | 接口名称。当前 API 的名称为 DescribeCdnTopIp。 |
Version | String | 是 | 接口版本。当前 API 的版本为 2022-03-01。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
StartTime | Long | 是 | 指定一个开始时间,以查询从该开始时间(含)到 说明 不同云服务商平台允许查询的数据时间范围不同。若您设置的开始时间不符合云服务商平台的要求(如超出最长可查询时间),那么查询会失败。 | 1755619200 |
EndTime | Long | 是 | 指定一个结束时间,以查询从 说明 不同云服务商平台允许查询的数据时间跨度不同。若您设置的时间范围不符合云服务商平台的要求(如超出允许的时间跨度),那么查询会失败。 | 1755964800 |
SortBy | String | 否 | 指定返回数据的排序方式。该参数有以下取值:
| request |
Domain | String | 否 | 指定要查询的加速域名。只支持设置一个域名。 说明
| example.com |
Vendor | String | 否 | 指定一个云服务商,向该云服务商平台发起数据查询请求。 说明 如果您指定了 该参数有以下取值:
| volcengine |
DomainId | String | 否 | 指定要查询的加速域名的 ID。 说明
| 654a20acbd82bac3e2c6**** |
SubProduct | String | 否 | 指定一个产品类型。 说明 如果您指定了 该参数有以下取值:
| cdn |
参数名称 | 数据类型 | 参数说明 | 示例 |
|---|---|---|---|
Ips | Object[] | 查询得到的数据明细列表,包含访问者 IP 及其相关数据。 |
POST https://mcdn.volcengine-api.com/?Action=DescribeCdnTopIp&Version=2022-03-01 { "StartTime": 1755619200, "EndTime": 1755964800, "SortBy": "request", "Domain": "example.com", "Vendor": "volcengine", "SubProduct": "cdn" }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DescribeCdnTopIp", "Version": "2022-03-01", "Service": "mcdn", "Region": "cn-north-1" }, "Result": { "Ips": [ { "Ip": "192.0.2.1", "Flux": 467832647, "Request": 3456 } ] } }
如果响应正文的 ResponseMetadata 字段中包含 Error 字段,则表示 API 请求失败。关于更多错误码的信息,参见错误码。