1. 接口描述
接口请求域名: cdn.tencentcloudapi.com 。
查询指定域名的区域、运营商明细数据
注意事项:接口尚未全面开放,未在内测名单中的账号不支持调用
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDistrictIspData。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-06-06。 | 
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 | 
| Domains.N | 是 | Array of String | 域名列表,最多支持20个域名 示例值:["www.test.com"] | 
| StartTime | 是 | Timestamp | 查询起始时间,如:2018-09-04 10:40:00,返回结果大于等于指定时间 支持近 60 天内的数据查询,每次查询时间区间为 3 小时 示例值:2020-03-27 00:00:00 | 
| EndTime | 是 | Timestamp | 查询结束时间,如:2018-09-04 10:40:00,返回结果小于等于指定时间 结束时间与起始时间区间最大为 3 小时 示例值:2020-03-27 00:00:00 | 
| Metric | 是 | String | 指定查询指标,支持: bandwidth:带宽,单位为 bps flux:流量,单位为 byte request:请求数,单位为 次 statusCode:状态码,返回 0、2xx、3xx、4xx、5xx 汇总数据,单位为 次 2xx:返回 2xx 状态码汇总及各 2 开头状态码数据,单位为 次 3xx:返回 3xx 状态码汇总及各 3 开头状态码数据,单位为 次 4xx:返回 4xx 状态码汇总及各 4 开头状态码数据,单位为 次 5xx:返回 5xx 状态码汇总及各 5 开头状态码数据,单位为 次 支持指定具体状态码查询,若未产生过,则返回为空 示例值:bandwidth | 
| Districts.N | 否 | Array of Integer | 指定省份查询,不填充表示查询所有省份 省份、国家/地区编码可以查看 省份编码映射 示例值:[122] | 
| Isps.N | 否 | Array of Integer | 指定运营商查询,不填充表示查询所有运营商 运营商编码可以查看 运营商编码映射 示例值:[3947] | 
| Protocol | 否 | String | 指定协议查询,不填充表示查询所有协议 all:所有协议 http:指定查询 HTTP 对应指标 https:指定查询 HTTPS 对应指标 示例值:http | 
| IpProtocol | 否 | String | 指定IP协议查询,不填充表示查询所有协议 all:所有协议 ipv4:指定查询 ipv4 对应指标 ipv6:指定查询 ipv6 对应指标 指定IP协议查询时,不可同时指定省份、运营商查询 示例值:ipv4 | 
| Interval | 否 | String | 时间粒度,支持以下几种模式(默认5min): min:1 分钟粒度,支持近 60 天内的数据查询,每次查询时间区间不超过10分钟,可返回 1 分钟粒度明细数据 5min:5 分钟粒度,支持近 60 天内的数据查询,每次查询时间区间不超过3 小时,可返回 5 分钟粒度明细数据 示例值:5min | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Data | Array of DistrictIspInfo | 地区运营商数据明细 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 查询CDN地区运营商明细日志数据
查询域名用量的地区运营商分布情况
输入示例
https://cdn.tencentcloudapi.com/?Action=DescribeDistrictIspData
&StartTime=2020-03-27 00:00:00
&EndTime=2020-03-27 00:00:00
&Metric=bandwidth
&Domains.0=www.test.com
&Districts.0=122
&Isps.0=3947
&Protocol=http
&IpProtocol=ipv4
&<公共请求参数>输出示例
{
    "Response": {
        "RequestId": "abcd-efgh-ijkl-mnop",
        "Data": [
            {
                "Domain": "www.test.com",
                "Protocol": "http",
                "IpProtocol": "ipv4",
                "StartTime": "2020-03-27 00:00:00",
                "EndTime": "2020-03-27 00:00:00",
                "Interval": 5,
                "Metric": "bandwidth",
                "District": 122,
                "Isp": 3947,
                "DataPoints": [
                    0
                ],
                "DistrictName": "山东",
                "IspName": "中国铁通"
            }
        ]
    }
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| InternalError.CamSystemError | 内部鉴权系统错误。 | 
| InternalError.CdnConfigError | 域名配置更新失败。 | 
| InternalError.CdnDbError | 内部数据错误,请联系腾讯云工程师进一步排查。 | 
| InternalError.CdnQuerySystemError | 内部查询错误,请重试或联系客服人员解决。 | 
| InternalError.CdnSystemError | 系统错误,请联系腾讯云工程师进一步排查。 | 
| InternalError.Error | 内部服务错误,请联系腾讯云工程师进一步排查。 | 
| InternalError.ProxyServer | 内部服务错误,请联系腾讯云工程师进一步排查。 | 
| InternalError.RouteError | 内部服务错误,请联系腾讯云工程师进一步排查。 | 
| InvalidParameter.CdnInvalidParamInterval | 参数Interval错误,请确认后重试。 | 
| InvalidParameter.CdnParamError | 参数错误,请参考文档中示例参数填充。 | 
| InvalidParameter.CdnStatInvalidDate | 日期不合法,请参考文档中日期示例。 | 
| InvalidParameter.CdnStatInvalidMetric | 统计类型不合法,请参考文档中统计分析示例。 | 
| InvalidParameter.CdnStatTooManyDomains | 查询的域名数量超过限制。 | 
| ResourceNotFound.CdnHostNotExists | 未查询到该域名,请确认域名是否正确。 | 
| UnauthorizedOperation.CdnCamUnauthorized | 子账号未配置cam策略。 | 
| UnauthorizedOperation.CdnUserNoWhitelist | 非内测白名单用户,无该功能使用权限。 | 
| UnauthorizedOperation.OperationTooOften | 操作超出调用频次限制。 |