API名称:DescribeTopDomains 。
API域名:open.volcengineapi.com。
API描述:统计域名的排行数据。
Action和Version需要放在请求 URL 后方参数中。
参数名称 | 是否必选 | 参数类型 | 参数说明 |
---|---|---|---|
Action | 是 | String | API 名称,该参数的取值是 DescribeTopDomains 。 |
Version | 是 | String | API 版本,该参数的取值是 2021-04-01 。 |
参数名称 | 是否必选 | 参数类型 | 参数说明 | 示例值 |
---|---|---|---|---|
StartTime | 是 | String | 查询起始时间。 | 2021-01-01 00:00:00 |
EndTime | 是 | String | 查询结束时间。 | 2021-01-01 23:59:59 |
Sort | 是 | String | 指定排序指标,可指定值:traffic :流量。bandwidth :峰值带宽。request : 请求数。QPS : 峰值 QPS 。2xx : 2xx状态码数量 。3xx : 3xx状态码数量 。4xx :4xx状态码数量 。5xx : 5xx状态码数量 。 | request |
Domains | 是 | [ ]String | 指定查询域名列表,不填代表查询当前用户所有域名。 | ["www.bytedance.com"] |
Limit | 否 | Integer | 域名获取数量限制,默认为20,取值支持1~100 。 | 20 |
ProjectName | 否 | [ ]String | 指定查询域名所属的项目,为空代表查询当前用户所有项目。 | ["TEST"] |
IspNameEn | 否 | [ ]String | 指定运营商,为空时表示查询所有运营商,支持参数:
|
|
AcceleratingRegion | 否 | String | 加速区域,不填表示查询所有区域,支持参数:
|
|
Area | 否 | String | 客户端所在区域,不填表示查询所有区域,支持参数:
|
|
Region | 否 | [ ]String | 指定区域,为空时表示查询所有区域。当 Area为 China 或 Global 时,Region 支持的区域详见下表。 |
|
Protocol | 否 | [ ]String | 指定客户端请求应用层和传输层协议查询,为空时表示查询所有协议,支持参数:
|
|
Type | 否 | String | 指定访问类型,不填时表示查询所有类型,返回总和(相当于all),支持参数:
|
|
IPVersion | 否 | String | 指定ip类型查询,不填时表示查询所有类型,支持参数:
|
|
Area 取值 | 对应 Region 的取值范围 |
---|---|
China | ["BJ", "AH", "CQ", "FJ", "GD", "GS", "GX", "GZ", "HA", "HB", "HE", "HI", "HK", "HL", "HN", "JL", "JS", "JX", "LN", "MO", "NM", "NX", "QH", "SC", "SD", "SH", "SN", "SX", "TJ", "TW", "XJ", "XZ", "YN", "ZJ", "OTHERS"] |
Global | ["CHN", "CHE", "AZE", "PNG", "PSE", "FSM", "LVA", "KHM", "SPM", "MYS", "COG", "VNM", "GRD", "HND", "GUF", "WLF", "COK", "BFA", "LAO", "IOT", "SVK", "GUM", "MLI", "RWA", "SGS", "IRN", "BLR", "KEN", "SMR", "BVT", "MSR", "DOM", "GIN", "IMN", "BLZ", "NRU", "NFK", "TZA", "BHR", "LBY", "YEM", "ARE", "SXM", "CPV", "MKD", "HMD", "ZWE", "ESP", "ATG", "BGD", "TKM", "MYT", "IND", "GRC", "SAU", "PHL", "GHA", "ISR", "VGB", "JAM", "TON", "DNK", "TCA", "LBR", "NLD", "PAN", "VCT", "COM", "PYF", "SWE", "CRI", "GTM", "KNA", "TUV", "PAK", "TJK", "DZA", "FIN", "MHL", "SLV", "FJI", "PER", "WSM", "CAF", "ERI", "LSO", "GGY", "MAR", "CYP", "ISL", "GNB", "NOR", "IRQ", "VUT", "AND", "CXR", "JOR", "MEX", "MCO", "NER", "JPN", "FRA", "EST", "VEN", "UMI", "AUS", "PRT", "GIB", "LIE", "ALB", "KOR", "HRV", "MNE", "TUN", "QAT", "SGP", "COL", "CUB", "EGY", "ARG", "CHL", "LCA", "ZAF", "CCK", "NPL", "MTQ", "ATF", "THA", "SRB", "ETH", "SJM", "BDI", "PRK", "GNQ", "BMU", "UKR", "OMN", "SDN", "ZMB", "DEU", "MDG", "AIA", "GUY", "NIC", "GRL", "MMR", "LKA", "BEL", "PRY", "PRI", "MLT", "MNP", "IRL", "ABW", "CYM", "TCD", "CIV", "BRB", "ALA", "BGR", "HTI", "NIU", "COD", "DJI", "TGO", "ASM", "BIH", "KWT", "MWI", "MNG", "SYR", "KAZ", "BEN", "SHN", "UGA", "KIR", "SLE", "AFG", "UZB", "SEN", "REU", "TUR", "URY", "TTO", "NAM", "ITA", "BOL", "PCN", "BWA", "MDV", "VAT", "SSD", "CZE", "MUS", "SOM", "XKS", "SUR", "GBR", "BRA", "JEY", "ECU", "FLK", "NCL", "AGO", "MOZ", "POL", "PLW", "IDN", "SLB", "GMB", "LBN", "MAF", "BHS", "USA", "ARM", "GLP", "BTN", "CUW", "ESH", "ROU", "GEO", "NGA", "LTU", "VIR", "SYC", "ATA", "RUS", "TKL", "GAB", "CAN", "BRN", "STP", "NZL", "CMR", "SWZ", "TLS", "SVN", "LUX", "MDA", "HUN", "FRO", "MRT", "BLM", "AUT", "KGZ", "OTHERS"] |
为空 | 全部区域 |
参数名称 | 参数类型 | 参数说明 | 示例 |
---|---|---|---|
DomainCount | Integer | 查询加速域名中正在运行域名的数量。 | 20 |
StartTime | String | 查询起始时间。 | 2021-01-01 00:00:00 |
EndTime | String | 查询结束时间。 | 2021-01-01 23:59:59 |
TopDomains | TopDomains | Domain排名列表。 | - |
POST https://open.volcengineapi.com/?Version=2021-04-01&Action=DescribeTopDomains&<其他公共请求参数> { "StartTime":"2019-12-13 00:00:00", "EndTime":"2019-12-13 00:00:00", "Sort":"request" }
{ "ResponseMetadata": { "RequestId": "2021092620401201022508421706B81F53", "Action": "DescribeTopDomains", "Version": "2021-04-01", "Service": "dcdn", "Region": "cn-south-1" }, "Result": { "TopDomains": [ { "DomainName": "www.a.com", "Rank": 1, "Request":3, "Traffic":3, "Bandwidth":3, "QPS":3 }, { "DomainName": "www.b.com", "Rank": 2, "Request":3, "Traffic":3, "Bandwidth":3, "QPS":3 } ] } }