查询子网预留网段列表 - 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
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方式请参见获取项目ID。 取值范围: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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版本过滤。 取值范围:
|
|
name |
否 |
Array of strings |
参数解释: 子网预留网段的名称。可以使用该字段过滤满足条件的子网预留网段,支持传入多个名称过滤。 取值范围: 不涉及。 |
|
description |
否 |
Array of strings |
参数解释: 子网预留网段的描述信息。可以使用该字段过滤子网预留网段,支持传入多个描述信息进行过滤。 取值范围: 不涉及。 |
|
enterprise_project_id |
否 |
String |
参数解释: 子网预留网段所属的企业项目ID。可以使用该字段过滤某个企业项目下的子网预留网段。 取值范围:
|
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
virsubnet_cidr_reservations |
Array of VirsubnetCidrReservation objects |
参数解释: 查询子网预留网段列表的响应体。 取值范围: 不涉及。 |
|
request_id |
String |
参数解释: 请求ID。 取值范围: 不涉及。 |
|
page_info |
PageInfo object |
参数解释: 分页信息。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 子网预留网段的资源ID。子网预留网段创建成功后,会生成一个子网预留网段 ID,是子网预留网段对应的唯一标识。 取值范围: 带“-”的标准UUID格式。 |
|
virsubnet_id |
String |
参数解释: 子网预留网段所在子网的ID。 取值范围: 带“-”的标准UUID格式。 |
|
vpc_id |
String |
参数解释: 子网预留网段所在VPC的ID。 取值范围: 带“-”的标准UUID格式。 |
|
ip_version |
Integer |
参数解释: 子网预留网段的IP版本。 取值范围:
|
|
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。 |
请求示例
查询子网预留网段列表。
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"
}
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; public class ListVirsubnetCidrReservationsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("<YOUR REGION>")) .build(); ListVirsubnetCidrReservationsRequest request = new ListVirsubnetCidrReservationsRequest(); try { ListVirsubnetCidrReservationsResponse response = client.listVirsubnetCidrReservations(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListVirsubnetCidrReservationsRequest() response = client.list_virsubnet_cidr_reservations(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := vpc.NewVpcClient( vpc.VpcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListVirsubnetCidrReservationsRequest{} response, err := client.ListVirsubnetCidrReservations(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
GET操作正常返回,更多状态码请参见状态码。 |
错误码
请参见错误码。