You need to enable JavaScript to run this app.
导航

获取边缘层节点的所有 IP

最近更新时间2024.03.06 15:19:22

首次发布时间2021.09.24 18:57:38

查询指定加速域名在边缘层的所有节点的 IP 地址。

说明

如果您需要使用该 API,请 提交工单

使用限制

节流限制:您每秒最多可以发送 20 个请求。
数据延时:如果加速域名的边缘层节点发生了变化,可能需要 10-15 分钟才会体现在该接口返回的 IP 列表中。

请求说明

  • 请求方式:POST
  • 请求地址:https://cdn.volcengineapi.com/?Action=DescribeCdnEdgeIp&Version=2021-03-01

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
接口名称。当前 API 的名称为 DescribeCdnEdgeIp
Version
String
接口版本。当前 API 的版本为 2021-03-01

Body

参数名称
数据类型
是否必选
参数说明
示例
Domain
String
表示需要查询的域名。域名的状态不能是 已下线。您只能指定一个域名。
如果域名的状态是 已下线,查询结果中的 IP 地址列表是 null
www.example.com
IpVersion
String

表示查询返回的边缘层节点的 IP 地址的类型。您只能指定一个 IP 地址类型。该参数有以下取值:

  • ipv4:返回 IPv4 类型的 IP 地址。
  • ipv6:返回 IPv6 类型的 IP 地址。

如果您不指定该参数,查询结果中会同时包含 IPv4 和 IPv6 类型的 IP 地址。

说明

要查询 IPv6 地址,加速域名的 IPv6 特性必须是已启用的。如果未启用,IPv6 地址列表是 null。关于该特性的说明,参见 新增域名

ipv4
Isp
String
表示查询特定运营商的边缘层节点。您只能指定一个运营商代号。该参数的取值可以通过调用 DescribeCdnRegionAndIsp 获取。
如果您不指定该参数,则查询所有运营商的边缘层节点。
CTCC
Region
String
表示查询特定省份的边缘层节点。您只能指定一个省份代号。该参数的取值可以通过调用 DescribeCdnRegionAndIsp 获取。
如果您不指定该参数,则查询所有省份的边缘层节点。
BJ
Status
String

表示查询特定状态的边缘层节点。该参数有以下取值:

  • Online:表示边缘层节点是在线的。
如果您不指定该参数,则查询所有状态的边缘层节点。
online

响应正文

参数名称
数据类型
参数说明
示例
CdnIpv4
String[]

表示 IPv4 类型的 IP 地址列表。

如果您在请求中指定了 IpVersionipv6,则该参数值为 null
["192.168.0.1","192.168.0.2"]
CdnIpv6
String[]

表示 IPv6 类型的 IP 地址列表。

如果您在请求中指定了 IpVersionipv4,或者加速域名的 IPv6 特性未启用,该参数值是 null
["240e:b1:e401:4::13","240e:b1:e401:4::14"]

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeCdnEdgeIp&Version=2021-03-01
{
  "Domain": "www.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202211301702110102100671410480265A",
        "Action": "DescribeCdnEdgeIp",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "CdnIpv4": [
            "221.195.244.88",
            "221.195.244.89",
            ...
        ],
        "CdnIpv6": [
            "2408:871a:7000:ff00:8000:0:b00:92",
            "2408:871a:7000:ff00:8000:0:b00:93",
            ...
        ]
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段,则表示 API 请求失败。更多关于错误码的信息,参见错误码