更新时间:2025-08-19 GMT+08:00

查询子网预留网段列表

功能介绍

查询某租户下的子网预留网段列表。

接口约束

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

调用方法

请参见如何调用API

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

Array of strings

  • 功能说明:子网预留网段资源ID。可以使用该字段过滤子网预留网段,支持多个ID。

virsubnet_id

Array of strings

  • 功能说明:子网预留网段所在的虚拟子网ID。可以使用该字段过滤子网预留网段,支持多个ID。

cidr

Array of strings

  • 功能说明:子网预留网段CIDR。可以使用该字段过滤子网预留网段,支持多个CIDR。

ip_version

Array of integers

  • 功能说明:子网预留网段所在子网的IP版本,可以使用该字段过滤子网预留网段。

  • 取值范围: 4,6。

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

  • 功能描述:子网预留网段对应的唯一标识。

  • 取值范围:带“-”的标准UUID格式。

virsubnet_id

String

  • 功能描述:子网预留网段所在虚拟子网的ID。

  • 取值范围:带“-”的标准UUID格式。

vpc_id

String

  • 功能描述:子网预留网段所在VPC的ID。

  • 取值范围:带“-”的标准UUID格式。

ip_version

Integer

  • 功能描述:子网预留网段的IP版本。

  • 取值范围:

    • 4,IPv4

    • 6,IPv6

cidr

String

  • 功能说明:子网预留网段。

  • 取值范围: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操作正常返回,更多状态码请参见状态码

错误码

请参见错误码