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

文档中心

立即注册

边缘计算节点

请输入

IP地址池

获取IP地址段列表

本接口用于获取 IP 地址池中包含的 IP 地址段的列表。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ip_cidr_block_ids	String[]	否	`ipcidr-s2nkfjc9rhg****`	IP 地址段 ID 的列表。
order_option	Object	否	`-`	IP 地址段的排序设置。
ip_pool_ids	String[]	否	`ippool-phh9wg28qk8****`	IP 地址池 ID 的列表。您可以调用 ListIpPools 接口获取 IP 地址池的 ID。
status	String[]	否	`available`	IP 地址段的状态。取值范围： creating：创建中。 available：可用。 deleting：删除中。
page_option	Object	是	`-`	分页查询设置。

返回参数

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

参数	类型	示例值	描述
ip_cidr_blocks	Object[]	`-`	IP 地址段的列表。
total_count	Integer	`2`	IP 地址段的总数。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025073015443473FE3382FCB82A8****",
        "Action": "ListIpCidrBlocks",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "ip_cidr_blocks": [
            {
                "account_id": 210044****,
                "cidr": "9.**.**.122/31",
                "create_time": 1748399628,
                "end_time": 0,
                "ip_available_count": 1,
                "ip_cidr_block_id": "ipcidr-nwl4lw6tsr****",
                "ip_cidr_block_name": "未命名",
                "ip_pool_id": "ippool-dmbqbp9h8f****",
                "ip_total_count": 2,
                "start_time": 1748399630,
                "status": "available",
                "update_time": 1748399630
            }
        ],
        "total_count": 1
    }
}

错误码

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

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

这个页面对您有帮助吗？

有用

无用

边缘计算节点

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #