获取IP地址池列表--边缘计算节点-火山引擎

文档中心

立即注册

边缘计算节点

请输入

IP地址池

获取IP地址池列表

本接口用于获取 IP 地址池列表。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=ListIpPools&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListIpPools`	接口名称。当前 API 的名称为 `ListIpPools`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
project	String	否	`default`	IP 地址池所属的项目。
ip_pool_ids	String[]	否	`ippool-phh9wg28qk8****`	IP 地址池 ID 的列表。
status	String[]	否	`available`	状态列表。取值范围： creating：创建中 available：可用 modifying：更新中 deleting：删除中
isps	String[]	否	`CMCC`	线路类型。取值范围： CMCC：中国移动 CUCC：中国联通 CTCC：中国电信
ip_versions	String[]	否	`ipv4`	IP 版本列表。取值范围： ipv4 ipv6
TagFilters	Object[]	否	`-`	IP 地址池的标签。
cluster_names	String[]	否	`****-zzcu01`	IP 地址池所属节点的名称。
page_option	Object	是	`-`	分页查询设置。
order_option	Object	否	`-`	IP 地址池的排序设置。

返回参数

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

参数	类型	示例值	描述
ip_pools	Object[]	`-`	IP 地址池的信息。
total_count	Integer	`2`	IP 地址池的总数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=ListIpPools&Version=2021-04-30
&<其他公共参数>
{
    "page_option": {
        "page_no": 1,
        "page_size": 10
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250730151522D19FCBB265831B9D****",
        "Action": "ListIpPools",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "ip_pools": [
            {
                "account_id": 21004****,
                "billing_method": "DailyPeak",
                "create_time": 1748399628,
                "desc": "",
                "end_time": 0,
                "ip_available_count": 1,
                "ip_pool_cluster": {
                    "alias": "nbct****",
                    "city": "330200",
                    "cluster_name": "nbct**-testing1",
                    "country": "CN",
                    "isp": "CTCC",
                    "province": "ZJ",
                    "region": "EastChina"
                },
                "ip_pool_id": "ippool-dmbqbp9h8****",
                "ip_pool_name": "电信-v4-地址段2",
                "ip_pool_status": "available",
                "ip_total_count": 2,
                "ip_version": "ipv4",
                "isp": "CTCC",
                "network_type": "external",
                "project": "default",
                "start_time": 1748399630,
                "update_time": 1748919149
            }
        ],
        "total_count": 1
    }
}

错误码

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

最近更新时间：2026.01.07 16:45:02

这个页面对您有帮助吗？

有用

无用

边缘计算节点

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #