文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ 子网预留网段/ 查询子网预留网段列表 - ListVirsubnetCidrReservations
更新时间：2025-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询子网预留网段列表 - ListVirsubnetCidrReservations

功能介绍

当您的子网预留网段创建成功后，您可以通过调用该接口查询所有子网预留网段信息，包括子网预留网段名称、IP网段等。

接口约束

查询提交请求的租户有权限查看的所有子网预留网段信息，单次查询最多返回2000条数据，超过2000后会返回分页标记。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    vpc:subnets:listReservations

    List

    subnet *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

GET /v3/{project_id}/vpc/virsubnet-cidr-reservations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方式请参见获取项目ID。

取值范围：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

每页返回的资源个数。

取值范围：

0~2000

marker

否

String

参数解释：

分页查询起始的资源ID，为空时查询第一页。

取值范围：

子网预留网段的资源ID。

id

否

Array of strings

参数解释：

子网预留网段的资源ID。可以使用该字段过滤子网预留网段，支持传入多个ID过滤。

取值范围：

不涉及。

virsubnet_id

否

Array of strings

参数解释：

子网预留网段所在的子网ID。可以使用该字段过滤子网预留网段，支持传入多个ID过滤。

取值范围：

不涉及。

cidr

否

Array of strings

参数解释：

子网预留网段的IP网段。可以使用该字段过滤子网预留网段，支持传入多个IP网段过滤。

取值范围：

不涉及。

ip_version

否

Array of integers

参数解释：

子网预留网段所在子网的IP版本。可以使用该字段过滤子网预留网段，支持传入多个IP版本过滤。

取值范围：

  • 4：过滤出IPv4子网预留网段。

  • 6：过滤出IPv6子网预留网段。

name

否

Array of strings

参数解释：

子网预留网段的名称。可以使用该字段过滤满足条件的子网预留网段，支持传入多个名称过滤。

取值范围：

不涉及。

description

否

Array of strings

参数解释：

子网预留网段的描述信息。可以使用该字段过滤子网预留网段，支持传入多个描述信息进行过滤。

取值范围：

不涉及。

enterprise_project_id

否

String

参数解释：

子网预留网段所属的企业项目ID。可以使用该字段过滤某个企业项目下的子网预留网段。

取值范围：

  • 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。

  • 若需要查询当前用户所有有权限查看企业项目绑定的子网预留网段，请传参all_granted_eps。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

virsubnet_cidr_reservations

Array of VirsubnetCidrReservation objects

参数解释：

查询子网预留网段列表的响应体。

取值范围：

不涉及。

request_id

String

参数解释：

请求ID。

取值范围：

不涉及。

page_info

PageInfo object

参数解释：

分页信息。

取值范围：

不涉及。
表4 VirsubnetCidrReservation

参数

参数类型

描述

id

String

参数解释：

子网预留网段的资源ID。子网预留网段创建成功后，会生成一个子网预留网段 ID，是子网预留网段对应的唯一标识。

取值范围：

带“-”的标准UUID格式。

virsubnet_id

String

参数解释：

子网预留网段所在子网的ID。

取值范围：

带“-”的标准UUID格式。

vpc_id

String

参数解释：

子网预留网段所在VPC的ID。

取值范围：

带“-”的标准UUID格式。

ip_version

Integer

参数解释：

子网预留网段的IP版本。

取值范围：

  • 4：IPv4

  • 6：IPv6

cidr

String

参数解释：

子网预留网段的IP网段。

取值范围：

CIDR格式，掩码长度最小值为“所属子网的网段掩码 + 2”，最大值为32（IPv4）或128（IPv6）。

name

String

参数解释：

子网预留网段的名称。

取值范围：

1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。

description

String

参数解释：

子网预留网段的描述信息。

取值范围：

0-255个字符，不能包含“<”和“>”。

project_id

String

参数解释：

子网预留网段所属的项目ID。

取值范围：

不涉及。

created_at

String

参数解释：

子网预留网段的创建时间。

取值范围：

UTC时间格式，yyyy-MM-ddTHH:mm:ssZ。

updated_at

String

参数解释：

子网预留网段最近一次更新的时间。

取值范围：

UTC时间格式，yyyy-MM-ddTHH:mm:ssZ。
表5 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释：

当前页的第一条记录。

取值范围：

不涉及。

current_count

Integer

参数解释：

当前页的资源总数。

取值范围：

不涉及。

next_marker

String

参数解释：

当前页的最后一条记录，最后一页时无next_marker字段。

取值范围：

不涉及。

请求示例

查询子网预留网段列表。

GET https://{Endpoint}/v3/{project_id}/vpc/virsubnet-cidr-reservations

响应示例

状态码：200

GET操作正常返回，更多状态码请参见状态码。

{
    "virsubnet_cidr_reservations": [
        {
            "id": "987d7959-9c48-ad49-2fdd-bf4146d6ebc4",
            "virsubnet_id": "fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19",
            "vpc_id": "cef5d621-6c20-d5df-74e8-746271fba734",
            "ip_version": 4,
            "cidr": "192.168.21.96/28",
            "name": "test",
            "description": "for test",
            "project_id": "11e8dd119c77479db890e266e68c1ecf",
            "created_at": "2024-09-09T10:20:35Z",
            "updated_at": "2024-09-09T10:20:35Z",
        },
        {
            "id": "ed4edb94-754c-7848-bb77-2d381906c535",
            "virsubnet_id": "fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19",
            "vpc_id": "cef5d621-6c20-d5df-74e8-746271fba734",
            "ip_version": 4,
            "cidr": "192.168.21.128/27",
            "name": "test2",
            "description": "for test",
            "project_id": "11e8dd119c77479db890e266e68c1ecf",
            "created_at": "2024-09-09T11:56:27Z",
            "updated_at": "2024-09-09T11:56:27Z",
        }
    ],
    "page_info": {
        "previous_marker": "987d7959-9c48-ad49-2fdd-bf4146d6ebc4",
        "current_count": 2
    },
    "request_id": "5cd6bbc22313ccb6933540d6f9302d81"
}

状态码

状态码

描述

200

GET操作正常返回，更多状态码请参见状态码。

错误码

请参见错误码。

父主题： 子网预留网段

相关文档