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

获取回源层节点的所有 IP

最近更新时间2023.08.11 14:39:49

首次发布时间2021.09.23 14:12:35

说明

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

API 说明

API 名称:DescribeCdnUpperIp
API 域名:cdn.volcengineapi.com
API 描述:通过 API 请求查询指定加速域名回源层的全量 IP 地址。

使用限制

节流限制:您每秒最多可以发送 20 个请求。

公共参数

在调用该 API 时,您在请求中必须包含公共参数。在这些公共参数中,以下两个查询参数的取值说明如下:

参数名称数据类型必选参数说明
Actionstring表示 API 的名称。该参数的取值是 DescribeCdnUpperIp
Versionstring表示 API 的版本。该参数的取值是 2021-03-01

请求鉴权

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见请求鉴权

请求正文参数

在您调用该 API 时,请求正文中可以包含的参数如下。

参数名称
数据类型
必选
参数说明
示例
Domain
string
指定一个域名
www.example.com
IpVersion
string
指定一个 IP 的网络层协议。该参数的可用值如下:
ipv4:查询网络层协议是 ipv4 的 IP;
ipv6:查询网络层协议是 ipv6 的 IP。

如果不指定该参数,表示查询全部 IP。
ipv4

响应正文

参数名称
数据类型
参数说明
示例
CdnIpv4
[]string
Ipv4 列表。
["192.168.0.1","192.168.0.2"]
CdnIpv6
[]string
Ipv6 列表。
["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"
}

响应示例

{
	"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
    }
}

错误代码

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