创建子网预留网段 - CreateVirsubnetCidrReservation
功能介绍
子网预留网段是子网网段范围的IP网段,此IP网段内的IP不会被子网内的实例占用。用户可以通过创建子网预留网段来预留某个IP网段,用于后续的特殊场景使用。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
vpc:subnets:createReservation
Write
subnet *
-
g:ResourceTag/<tag-key>
-
g:EnterpriseProjectId
-
-
-
URI
POST /v3/{project_id}/vpc/virsubnet-cidr-reservations
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方式请参见获取项目ID。 取值范围: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dry_run |
否 |
Boolean |
参数解释: 是否只预检此次请求。 约束限制: 不涉及。 取值范围:
默认取值: false |
|
virsubnet_cidr_reservation |
是 |
参数解释: 创建子网预留网段的请求体。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
virsubnet_id |
是 |
String |
参数解释: 子网预留网段所属的子网ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
ip_version |
是 |
Integer |
参数解释: 子网预留网段的IP版本,支持IPv4和IPv6。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
cidr |
否 |
String |
参数解释: 子网预留网段的IP网段。 约束限制:
取值范围: 不涉及。 默认取值: 不涉及。 |
|
mask |
否 |
Integer |
参数解释: 子网预留网段的IP网段掩码长度。 约束限制:
取值范围: 不涉及。 默认取值: 不涉及。 |
|
name |
否 |
String |
参数解释: 子网预留网段的名称。 约束限制: 1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
description |
否 |
String |
参数解释: 子网预留网段的描述信息。 约束限制: 0-255个字符,不能包含“<”和“>”。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
参数解释: 请求ID。 取值范围: 不涉及。 |
|
virsubnet_cidr_reservation |
VirsubnetCidrReservation 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。 |
请求示例
创建子网预留网段,所属虚拟子网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操作正常返回,更多状态码请参见状态码。
{
"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"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
POST操作正常返回,更多状态码请参见状态码。 |
错误码
请参见错误码。