DescribeCdnUpperIp - 获取回源节点的 IP--内容分发网络-火山引擎

文档中心

立即注册

导航

DescribeCdnUpperIp - 获取回源节点的 IP

最近更新时间：2025.09.29 11:06:49首次发布时间：2021.09.23 14:12:35

获取火山引擎内容分发网络分配给加速域名的所有回源节点的 IP 地址。

说明

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

使用限制

节流限制：您每秒最多可以发送 20 个请求。
数据延时：如果分配给加速域名的回源节点发生了变化，可能需要 10-15 分钟才会体现在该 API 返回的 IP 地址列表中。

请求说明

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

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeCdnUpperIp`。
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 不支持返回 IPv6 地址。	`ipv4`
RsIp	Boolean	否	表示是否返回节点的物理 IP 地址。该参数有以下取值： `true`：表示返回节点的物理 IP 地址列表。这些地址用于接收来自边缘节点用户请求。 `false`：表示返回节点的虚拟 IP 地址列表。这些地址用于向源站发送请求。该参数的默认值是 `false`。	`false`

返回参数

参数名称	数据类型	参数说明	示例
CdnIpv4	String[]	表示一个 IPv4 地址的列表。说明如果 `IpVersion` 是 `ipv6`，该参数值为 `null`。	`["xxx.xxx.xx.26","xxx.xxx.xx.68"]`
CdnIpv6	String[]	表示一个 IPv6 地址的列表。当前，该 API 不支持返回 IPv6 地址，该参数值始终是 `null`。	`null`

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202109181438380101940990351D01315C",
        "Action": "DescribeCdnUpperIp",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "CdnIpv4": [
            "xxx.xxx.xx.26",
            "xxx.xxx.xx.58"
        ],
        "CdnIpv6": null
    }
}

错误码

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