# 创建子网预留网段 - CreateVirsubnetCidrReservation #### 功能介绍 子网预留网段是子网网段范围的IP网段，此IP网段内的IP不会被子网内的实例占用。用户可以通过创建子网预留网段来预留某个IP网段，用于后续的特殊场景使用。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpc/vpc_api00_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpc:subnets:createReservation | Write | subnet \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | #### URI POST /v3/{project_id}/vpc/virsubnet-cidr-reservations 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 **取值范围**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | dry_run | 否 | Boolean | **参数解释**： 是否只预检此次请求。 **约束限制**： 不涉及。 **取值范围**： - true：发送检查请求，不会创建子网预留网段。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回响应码202。 - false：发送正常请求，并直接创建子网预留网段。 **默认取值**： false | | virsubnet_cidr_reservation | 是 | [CreateVirsubnetCidrReservationOption] object | **参数解释**： 创建子网预留网段的请求体。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表3CreateVirsubnetCidrReservationOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | virsubnet_id | 是 | String | **参数解释**： 子网预留网段所属的子网ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | ip_version | 是 | Integer | **参数解释**： 子网预留网段的IP版本，支持IPv4和IPv6。 **约束限制**： 不涉及。 **取值范围**： - 4：表示IPv4。 - 6：表示IPv6。 **默认取值**： 不涉及。 | | cidr | 否 | String | **参数解释**： 子网预留网段的IP网段。 **约束限制**： - CIDR格式，掩码长度最小值为"所属子网的网段掩码 + 2"，最大值为32（IPv4）或128（IPv6）。 - cidr和mask参数必须输入一个，两者同时输入时不能冲突。 - 子网预留网段不能包含所属子网的已使用的地址和系统预留地址（子网的第1个和最后2个地址）。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | mask | 否 | Integer | **参数解释**： 子网预留网段的IP网段掩码长度。 **约束限制**： - 整数，预留网段的掩码长度最小值为"所属子网的网段掩码 + 2"，最大值为32（IPv4）或128（IPv6）。 - cidr和mask参数必须输入一个，两者同时输入时不能冲突。 - 子网预留网段不能包含所属子网的已使用的地址和系统预留地址（子网的第1个和最后2个地址）。 - 指定掩码长度创建预留网段，最后mask与子网掩码的差值长度的bit位由系统自动分配，例如子网cidr为192.168.21.0/24，子网掩码长度24，指定预留网段长度为27，差值长度27 - 24 = 3，即第25,26,27这3个bit位由系统自动分配。例如： - 第25-27的bit位分配为011，最终创建出的子网预留网段cidr是192.168.21.96/27，其中96转为二进制是0110 0000； - 第25-27的bit位分配为110，最终创建出的子网预留网段cidr是192.168.21.192/27，其中192转为二进制是1100 0000。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | name | 否 | String | **参数解释**： 子网预留网段的名称。 **约束限制**： 1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | description | 否 | String | **参数解释**： 子网预留网段的描述信息。 **约束限制**： 0-255个字符，不能包含"\<"和"\>"。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：201** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。 | | virsubnet_cidr_reservation | [VirsubnetCidrReservation] object | **参数解释**： 创建子网预留网段的响应体。 **取值范围**： 不涉及。 | 表5VirsubnetCidrReservation | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 | #### 请求示例 创建子网预留网段，所属虚拟子网ID为fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19，IPv4版本，指定预留网段cidr为192.168.21.96/28，指定名称为test，描述为for test。 ``` POST https://{Endpoint}/v3/{project_id}/vpc/virsubnet-cidr-reservations { "virsubnet_cidr_reservation" : { "virsubnet_id" : "fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19", "ip_version" : 4, "cidr" : "192.168.21.96/28", "name" : "test", "description" : "for test" } } ``` #### 响应示例 **状态码：201** POST操作正常返回，更多状态码请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 ``` { "virsubnet_cidr_reservation" : { "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.96/28", "name" : "test", "description" : "for test", "project_id" : "11e8dd119c77479db890e266e68c1ecf", "created_at" : "2024-09-09T11:56:27Z", "updated_at" : "2024-09-09T11:56:27Z" }, "request_id" : "fd48620df5f57b04917f2cc5ebeaf277" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 创建子网预留网段，所属虚拟子网ID为fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19，IPv4版本，指定预留网段cidr为192.168.21.96/28，指定名称为test，描述为for test。 ``` 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 CreateVirsubnetCidrReservationSolution { 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("")) .build(); CreateVirsubnetCidrReservationRequest request = new CreateVirsubnetCidrReservationRequest(); CreateVirsubnetCidrReservationRequestBody body = new CreateVirsubnetCidrReservationRequestBody(); CreateVirsubnetCidrReservationOption virsubnetCidrReservationbody = new CreateVirsubnetCidrReservationOption(); virsubnetCidrReservationbody.withVirsubnetId("fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19") .withIpVersion(4) .withCidr("192.168.21.96/28") .withName("test") .withDescription("for test"); body.withVirsubnetCidrReservation(virsubnetCidrReservationbody); request.withBody(body); try { CreateVirsubnetCidrReservationResponse response = client.createVirsubnetCidrReservation(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()); } } } ``` - [Python] 创建子网预留网段，所属虚拟子网ID为fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19，IPv4版本，指定预留网段cidr为192.168.21.96/28，指定名称为test，描述为for test。 ``` # 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("")) \ .build() try: request = CreateVirsubnetCidrReservationRequest() virsubnetCidrReservationbody = CreateVirsubnetCidrReservationOption( virsubnet_id="fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19", ip_version=4, cidr="192.168.21.96/28", name="test", description="for test" ) request.body = CreateVirsubnetCidrReservationRequestBody( virsubnet_cidr_reservation=virsubnetCidrReservationbody ) response = client.create_virsubnet_cidr_reservation(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 创建子网预留网段，所属虚拟子网ID为fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19，IPv4版本，指定预留网段cidr为192.168.21.96/28，指定名称为test，描述为for test。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := vpc.VpcClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := vpc.NewVpcClient(hcClient) request := &model.CreateVirsubnetCidrReservationRequest{} cidrVirsubnetCidrReservation:= "192.168.21.96/28" nameVirsubnetCidrReservation:= "test" descriptionVirsubnetCidrReservation:= "for test" virsubnetCidrReservationbody := &model.CreateVirsubnetCidrReservationOption{ VirsubnetId: "fb0e2bd6-190f-0d1a-7728-a5f6b1d8dd19", IpVersion: int32(4), Cidr: &cidrVirsubnetCidrReservation, Name: &nameVirsubnetCidrReservation, Description: &descriptionVirsubnetCidrReservation, } request.Body = &model.CreateVirsubnetCidrReservationRequestBody{ VirsubnetCidrReservation: virsubnetCidrReservationbody, } response, err := client.CreateVirsubnetCidrReservation(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VPC/sdk?api=CreateVirsubnetCidrReservation&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | POST操作正常返回，更多状态码请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。