内容分发网络 CDN
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 内容分发网络 CDN > API 文档 > 服务查询相关接口 > 查询域名节点状态

查询域名节点状态

最近更新时间：2024-03-12 01:14:31

我的收藏

本页目录：

1. 接口描述

接口请求域名： cdn.tencentcloudapi.com 。

DescribeIpStatus 用于查询域名所在加速平台的边缘节点、回源节点明细。注意事项：暂不支持查询边缘节点信息并且数据会存在一定延迟。

说明：

若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。

默认接口请求频率限制：10次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeIpStatus。
Version 是 String 公共参数，本接口取值：2018-06-06。
Region 否 String 公共参数，本接口不需要传递此参数。
Domain 是 String 加速域名
示例值：www.test.com
Layer 否 String 节点类型：
edge：表示边缘节点
last：表示回源层节点
不填充情况下，默认返回边缘节点信息
示例值：edge
Area 否 String 查询区域：
mainland: 国内节点
overseas: 海外节点
global: 全球节点
示例值：last
Segment 否 Boolean 是否以IP段的格式返回。
示例值：true/false
ShowIpv6 否 Boolean 是否查询节点 IPV6 信息。
示例值：true/false
AbbreviationIpv6 否 Boolean 是否对IPV6进行缩写。
示例值：true/false

3. 输出参数

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

4. 示例

示例1 查询域名节点信息

输入示例

POST / HTTP/1.1
Host: cdn.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIpStatus
<公共请求参数>

{
    "Domain": "www.test.com"
}

输出示例

{
    "Response": {
        "RequestId": "b6e9964d-26a3-49d0-adab-993e17d2f950",
        "TotalCount": 1,
        "Ips": [
            {
                "Ip": "1.1.1.1",
                "District": "广东",
                "Isp": "电信",
                "City": "深圳",
                "Status": "online",
                "Ipv6": null
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CamSystemError 内部鉴权系统错误。
InternalError.CdnConfigError 域名配置更新失败。
InternalError.CdnDbError 内部数据错误，请联系腾讯云工程师进一步排查。
InternalError.CdnQuerySystemError 内部查询错误，请重试或联系客服人员解决。
InternalError.CdnSystemError 系统错误，请联系腾讯云工程师进一步排查。
InternalError.Error 内部服务错误，请联系腾讯云工程师进一步排查。
InternalError.ProxyServer 内部服务错误，请联系腾讯云工程师进一步排查。
InvalidParameter.CdnConfigInvalidHost 域名不符合规范，请确认域名是否符合规范。
InvalidParameter.CdnParamError 参数错误，请参考文档中示例参数填充。
ResourceNotFound.CdnHostNotExists 未查询到该域名，请确认域名是否正确。
ResourceNotFound.CdnUserNotExists 未开通CDN服务，请开通后使用此接口。
UnauthorizedOperation.CdnCamUnauthorized 子账号未配置cam策略。
UnauthorizedOperation.CdnHostUnauthorized CDN子账号加速域名未授权。
UnauthorizedOperation.CdnUserNoWhitelist 非内测白名单用户，无该功能使用权限。
UnauthorizedOperation.OperationTooOften 操作超出调用频次限制。
中国站