You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/服务端 API 参考/点播 CDN/DescribeCdnEdgeIp - 查询域名所属边缘节点 IP
DescribeCdnEdgeIp - 查询域名所属边缘节点 IP
最近更新时间：2025.09.19 17:51:30首次发布时间：2025.09.19 14:32:28
复制全文
我的收藏
有用
有用
无用
无用

调用 DescribeCdnEdgeIp 接口获取视频点播 CDN 服务分配给加速域名的所有边缘节点的 IP 地址。这些边缘节点属于加速域名的加速区域。

注意事项

  • 本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
  • 数据延时：如果分配给加速域名的边缘节点发生了变化，可能需要 10-15 分钟才会体现在该 API 返回的 IP 列表中。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeCdnEdgeIp&Version=2023-07-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数
类型
是否必选
示例值
描述
Action
String
是
DescribeCdnEdgeIp
接口名称。当前 API 的名称为 DescribeCdnEdgeIp。
Version
String
是
2023-07-01
接口版本。当前 API 的版本为 2023-07-01。
SpaceName
String
是
test-space

点播空间名称。您可通过以下方式获取空间名称：

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
DomainType
String
是
play

域名类型。取值如下：

  • play：点播加速域名和自定义源站加速域名。
  • image：封面加速域名。

说明

详见域名类型介绍。

Domain
String
是
www.example.com

加速域名，以获取分配给该加速域名的所有边缘节点的 IP 地址。

说明

如果加速域名的 status 是 offline，该 API 返回的 IP 地址列表是 null。您可以调用 DescribeDomainConfig 接口通过返回参数 ConfigStatus 获取加速域名的状态。

IpVersion
String
否
ipv4

IP 地址的版本，取值如下：

  • ipv4：表示 IPv4 地址。
  • ipv6：表示 IPv6 地址。
如果不指定该参数，表示不使用该参数对该 API 返回的结果进行过滤。
Isp
String
否
CM
中国网络运营商的代码，以获取属于该网络运营商的 IP 地址。您可调用 DescribeCdnRegionAndIsp 获取所有中国网络运营商的代码。如果不指定该参数，表示不使用该参数对该 API 返回的结果进行过滤。
Region
String
否
BJ
国家或地区的代码，以获取属于该国家或地区的 IP 地址。您可调用 DescribeCdnRegionAndIsp 获取所有国家和地区的代码。如果不指定该参数，表示不使用该参数对该 API 返回的结果进行过滤。
Status
String
否
online

节点状态，以获取该状态下的边缘节点的 IP 地址。该参数有以下取值：

  • online：表示状态是在线。
如果不指定该参数，表示不使用该参数对该 API 返回的结果进行过滤。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
CdnIpv4
String[]
["xxx.xx.xxx.32","xxx.xx.xx.90"]
IPv4 地址列表。
CdnIpv6
String[]
["xxxx:xx:xxxx:4::13","xxxx:xx:xxxx:4::14"]
IPv6 地址列表

请求示例

https://vod.volcengineapi.com?Action=DescribeCdnEdgeIp&Version=2023-07-01
{
  "SpaceName": "test-space",
  "DomainType": "play",
  "Domain": "www.example.com"
}

返回示例

{
  "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": {
    "Action": "DescribeCdnEdgeIp",
    "Region": "cn-north-1",
    "Service": "vod",
    "Version": "2023-07-01",
    "RequestId": "20230604110420****100232280022D31"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

SDK

视频点播为 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：