有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: ecdn.tencentcloudapi.com 。

DescribeIpStatus 用于查询域名所在加速平台的所有节点信息, 如果您的源站有白名单设置,可以通过本接口获取ECDN服务的节点IP进行加白, 本接口为内测接口,请联系腾讯云工程师开白。

由于产品服务节点常有更新,对于源站开白的使用场景,请定期调用接口获取最新节点信息,若新增服务节点发布7日后您尚未更新加白导致回源失败等问题,ECDN侧不对此承担责任。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIpStatus。
Version String 公共参数,本接口取值:2019-10-12。
Region String 公共参数,本接口不需要传递此参数。
Domain String 加速域名
示例值:www.test.com
Area String 查询区域:
mainland: 国内节点
overseas: 海外节点
global: 全球节点
示例值:global

3. 输出参数

参数名称 类型 描述
Ips Array of IpStatus 节点列表
TotalCount Integer 节点总个数
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询域名节点信息

输入示例

https://ecdn.tencentcloudapi.com/?Action=DescribeIpStatus
&Domain=www.test.com
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "b6e9964d-26a3-49d0-adab-993e17d2f950",
        "Ips": [
            {
                "Ip": "1.1.1.1",
                "District": "广东",
                "Isp": "电信",
                "City": "深圳",
                "Status": "online",
                "CreateTime": "2019-10-12 00:00:00"
            }
        ],
        "TotalCount": 0
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.EcdnConfigError 内部配置服务错误,请重试或联系客服人员解决。
InternalError.EcdnDbError 内部数据错误,请联系腾讯云工程师进一步排查。
InternalError.EcdnSystemError 系统错误,请联系腾讯云工程师进一步排查。
InvalidParameter.EcdnParamError 参数错误,请参考文档中示例参数填充。
ResourceNotFound.EcdnDomainNotExists 账号下无此域名,请确认后重试。
ResourceNotFound.EcdnHostNotExists 账号下无此域名,请确认后重试。
ResourceNotFound.EcdnUserNotExists 未开通ECDN服务,请开通后使用此接口。
UnauthorizedOperation.EcdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.EcdnDomainUnauthorized ECDN子账号加速域名未授权。
UnauthorizedOperation.EcdnHostUnauthorized ECDN子账号加速域名未授权。
UnauthorizedOperation.EcdnUserNoWhitelist 非内测白名单用户,无该功能使用权限。
UnauthorizedOperation.OperationTooOften 操作过于频繁,请稍后重试 。