You need to enable JavaScript to run this app.
导航
获取边缘层节点的所有 IP
最近更新时间:2024.06.13 14:34:37首次发布时间: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

表示一个加速域名。

说明

如果该加速域名的 statusoffline,在该 API 不返回任何 IP 地址。您可以调用 ListCdnDomains 获取加速域名的状态。

www.example.com
IpVersion
String

表示 IP 地址的版本,以获取该版本的 IP 地址。该参数的可用值如下:

  • ipv4:表示 IPv4 地址。
  • ipv6:表示 IPv6 地址。
如果不指定该参数,表示不使用该参数对该 API 返回的 IP 地址进行过滤。
ipv4
Isp
String

表示一个网络运营商的代码,以获取属于该网络运营商的 IP 地址。您可以调用 DescribeCdnRegionAndIsp 获取所有网络运营商的代码。

如果不指定该参数,表示不使用该参数对该 API 返回的 IP 地址进行过滤。
CTCC
Region
String

表示一个中国省级行政区的代码,以获取地理位置是该中国省级行政区的 IP 地址。您可以调用 DescribeCdnRegionAndIsp 获取所有中国省级行政区的代码。

如果不指定该参数,表示不使用该参数对该 API 返回的 IP 地址进行过滤。
BJ
Status
String

表示一个状态,以获取该状态下的边缘节点的 IP 地址。该参数有以下取值:

  • online:表示状态是在线。
该参数的默认值是 online
online

响应正文

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

表示一组边缘节点的 IPv4 地址。这些边缘节点是内容分发网络分配给 Domain 的。

说明

  • 如果 IpVersionipv6,该参数值为 null
  • 如果 Domainstatusoffline,该参数不会出现。
["192.168.0.1","192.168.0.2"]
CdnIpv6
String[]

表示一组边缘节点的 IPv6 地址。这些边缘节点是内容分发网络分配给 Domain 的。

说明

  • 如果 IpVersionipv4,该参数值为 null
  • 如果 Domainstatusoffline,该参数不会出现。
["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",
  "IpVersion":"ipv4"
}

返回示例

{
    "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 请求失败。更多关于错误码的信息,参见错误码