DescribeCdnEdgeIp - 获取边缘节点的 IP--内容分发网络-火山引擎

文档中心

立即注册

导航

DescribeCdnEdgeIp - 获取边缘节点的 IP

最近更新时间：2025.09.29 11:06:49首次发布时间：2021.09.24 18:57:38

获取火山引擎内容分发网络（CDN）分配给加速域名的所有边缘节点的 IP 地址。这些边缘节点属于加速域名的加速区域。您可以指定多个过滤条件对这些 IP 地址进行过滤。

说明

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

使用限制

节流限制：您每秒最多可以发送 20 个请求。
数据延时：如果分配给加速域名的边缘节点发生了变化，可能需要 10-15 分钟才会体现在该 API 返回的 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 地址。说明如果加速域名的 `status` 是 `offline`，该 API 返回的 IP 地址列表是 `null`。您可以调用 ListCdnDomains 获取加速域名的状态。	`www.example.com`
IpVersion	String	否	表示 IP 地址的版本，以获取该版本的 IP 地址。该参数的取值如下： `ipv4`：表示 IPv4 地址。 `ipv6`：表示 IPv6 地址。如果不指定该参数，表示不使用该参数对该 API 返回的结果进行过滤。当 `RsIp` 为 `true` 时，该 API 仅返回 IPv4 地址。	`ipv4`
Isp	String	否	表示一个中国网络运营商的代码，以获取属于该网络运营商的 IP 地址。您可以调用 DescribeCdnRegionAndIsp 获取所有中国网络运营商的代码。如果不指定该参数，表示不使用该参数对该 API 返回的结果进行过滤。如果 `RsIp` 是 `true`，`Isp` 无效。	`CTCC`
Region	String	否	表示一个国家或地区的代码，以获取属于该国家或地区的 IP 地址。您可以调用 DescribeCdnRegionAndIsp 获取所有国家和地区的代码。如果不指定该参数，表示不使用该参数对该 API 返回的结果进行过滤。如果 `RsIp` 是 `true`，`Region` 无效。	`BJ`
Status	String	否	表示一个节点状态，以获取该状态下的边缘节点的 IP 地址。该参数有以下取值： `online`：表示状态是在线。如果不指定该参数，表示不使用该参数对该 API 返回的结果进行过滤。	`online`
RsIp	Boolean	否	表示是否返回节点的物理 IP 地址。该参数有以下取值： `true`：表示返回节点的物理 IP 地址列表。这些地址用于接收用户请求。 `false`：表示返回节点的虚拟 IP 地址列表。这些地址用于向回源节点发送请求。该参数的默认值是 `false`。	`false`

返回参数

参数名称	数据类型	参数说明	示例
CdnIpv4	String[]	表示一个 IPv4 地址的列表。说明如果 `IpVersion` 是 `ipv6`，该参数值为 `null`。	`["xxx.xx.xxx.32","xxx.xx.xx.90"]`
CdnIpv6	String[]	表示一个 IPv6 地址的列表。说明如果 `IpVersion` 是 `ipv4` 或者 `RIP` 是 `true`，该参数值为 `null`。	`["xxxx:xx:xxxx:4::13","xxxx:xx:xxxx: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": [
            "xxx.xxx.xxx.23",
            "xxx.xxx.xxx.80",
            ...
        ],
        "CdnIpv6": [
            "xxxx:xxxx:xxxx:xxxx:xxxx:0:b00:92",
            "xxxx:xxxx:xxxx:xxxx:xxxx:0:b00:93",
            ...
        ]
    }
}

错误码

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