接口功能介绍
创建一个专有网络VPC。
接口约束
调用该接口创建 VPC 时,请注意:
- 一个 VPC 只能指定一个网段。
- VPC 创建后无法修改网段,但可以添加附加 IPv4 网段。
- 创建 VPC 后,会自动创建一个路由器和一个路由表。
URI
POST /v4/vpc/create
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
clientToken | String | 是 | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | |
regionID | String | 是 | 资源池 ID | |
projectID | String | 否 | 企业项目 ID,默认为"0" | 0 |
name | String | 是 | vpc 名称,只能由数字,字母,-组成不能以数字和-开头,最大长度 32 | vpcName |
description | String | 否 | vpc 描述。内容限制:1、长度限制 128 2、支持汉字,大小写字母,数字 3、支持英文特殊字符:!@#¥%……&*()——-+=《》?:”“{} ,。、;‘'【】4、 不支持特殊字符 英文字符(反引号`)(反斜杠) 中英文空格 | vpcName |
CIDR | String | 是 | VPC 的网段。建议您使用 192.168.0.0/16、172.16.0.0/12、10.0.0.0/8 三个 RFC 标准私网网段及其子网作为专有网络的主 IPv4 网段,网段掩码有效范围为 8~28 位 | 192.168.0.0/16 |
enableIpv6 | Bool | 否 | 是否开启 IPv6 网段。取值:false(默认值):不开启,true: 开启 | true |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 |
message | String | statusCode 为 900 时的错误信息, 英文 | |
description | String | statusCode 为 900 时的错误信息,中文 | |
returnObj | Object | 接口业务数据 | |
errorCode | String | 业务细分错误码,三段式:product.module.code |
returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
vpcID | String | vpc 示例 ID | vpc-tuid8d646e |
请求示例
POST /v4/vpc/create
请求体 body
{
"regionID": "79fa97e3-c48b-xxxx-9f46-6a13d8163678",
"clientToken": "81f7728662ddxxxx800155d307d5b",
"CIDR": "192.168.0.0/16",
"name": "vpc-test"
}
响应示例
{
"statusCode":800,
"errCode":"SUCCESS",
"message":"success",
"descritption": "",
"returnObj": {
"vpcID": "vpc-tuid8d646e"
}
}
失败:
{
"description": "请求参数错误",
"returnObj": "parameter: name",
"errorCode": "invalid.request.parameter",
"details": "",
"message": "request param error",
"statusCode": 900
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功 |
900 | 表示请求失败 |
错误码
请参考 错误码说明。