You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /
  • 内容分发网络

获取边缘层节点的所有 IP

最近更新时间：2023.06.12 10:42:29

首次发布时间：2021.09.24 18:57:38

我的收藏

说明

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

API 说明

API 名称：DescribeCdnEdgeIp。
API 域名：cdn.volcengineapi.com。
PI 描述：查询指定的加速域名所对应的所有边缘层节点的 IP 地址。

使用限制

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

公共参数

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

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

请求鉴权

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

请求正文参数

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

参数名称数据类型必选参数说明示例

Domain

string

是

表示需要查询的域名。域名的状态不能是 已下线。您只能指定一个域名。

如果域名的状态是 已下线，查询结果中的 IP 地址列表是 null。

www.example.com

Status

string

否

表示查询特定状态的边缘层节点。该参数有以下取值：

  • Online：表示边缘层节点是在线的。

如果您不指定该参数，则查询所有状态的边缘层节点。

online

Isp

string

否

表示查询特定运营商的边缘层节点。您只能指定一个运营商代号。该参数的取值可以通过调用 DescribeCdnRegionAndIsp 获取。

如果您不指定该参数，则查询所有运营商的边缘层节点。

CTCC

Region

string

否

表示查询特定省份的边缘层节点。您只能指定一个省份代号。该参数的取值可以通过调用 DescribeCdnRegionAndIsp 获取。

如果您不指定该参数，则查询所有省份的边缘层节点。

BJ

IpVersion

string

否

表示查询返回的边缘层节点的 IP 地址的类型。您只能指定一个 IP 地址类型。该参数有以下取值：

  • ipv4：返回 IPv4 类型的 IP 地址。

  • ipv6：返回 IPv6 类型的 IP 地址。

如果您不指定该参数，查询结果中会同时包含 IPv4 和 IPv6 类型的 IP 地址。

说明

要查询 IPv6 地址，加速域名的 IPv6 特性必须是已启用的。如果未启用，IPv6 地址列表是 null。关于该特性的说明，参见 新增域名。

ipv4

响应正文

参数名称数据类型参数说明示例

CdnIpv4

[]string

表示 IPv4 类型的 IP 地址列表。

如果您在请求中指定了 IpVersion 为 ipv6，则该参数值为 null。

["192.168.0.1","192.168.0.2"]

CdnIpv6

[]string

表示 IPv6 类型的 IP 地址列表。

如果您在请求中指定了 IpVersion 为 ipv4，或者加速域名的 IPv6 特性未启用，该参数值是 null。

["240e:b1:e401:4::13","240e:b1:e401:4::14"]

示例

请求示例

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

响应示例

{
    "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",
            ...
        ]
    }
}

错误代码

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