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

文档中心

立即注册

导航

获取回源层节点的所有 IP

最近更新时间：2024.06.28 19:18:53首次发布时间：2021.09.23 14:12:35

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

说明

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

使用限制

节流限制：您每秒最多可以发送 20 个请求。
数据延时：如果加速域名的回源层节点发生了变化，可能需要 10-15 分钟才会体现在该接口返回的 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	是	表示一个加速域名。	`www.example.com`
IpVersion	String	否	表示 IP 地址的版本，以获取该版本的 IP 地址。该参数的可用值如下： `ipv4`：表示 IPv4 地址。 `ipv6`：表示 IPv6 地址。如果不指定该参数，表示不使用该参数对该 API 返回的 IP 地址进行过滤。	`ipv4`

响应正文

参数名称	数据类型	参数说明	示例
CdnIpv4	String[]	表示一组回源节点的 IPv4 地址。这些回源节点是内容分发网络分配给 `Domain` 的。说明如果 `IpVersion` 是 `ipv6`，该参数值为 `null`。	`["192.168.0.1","192.168.0.2"]`
CdnIpv6	String[]	表示一组回源节点的 IPv6 地址。这些回源节点是内容分发网络分配给 `Domain` 的。说明如果 `IpVersion` 是 `ipv4`，该参数值为 `null`。	`["240e:b1:e401:4::13","240e:b1:e401:4::14"]`

请求示例

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

返回示例

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

错误码

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