文档中心

专有网络VPC API参考手册

最近更新时间：2023-04-16 17:00:00

1 专有网络管理

1.1 CreateVpc

调用 CreateVpc 接口创建一个专有网络 VPC。

1.1.1 使用说明

POST https://{Endpoint}/vpc/v1.0/vpcs

调用该接口创建 VPC 时，请注意：

• 一个 VPC 只能指定一个网段。

• VPC 创建后无法修改网段。

1.1.2 请求参数

1.1.3 返回数据

1.1.4 示例

1. 请求示例

POST https://{Endpoint}/vpc/v1.0/vpcs

{

"VpcName": "openapi-test111",

"Cidr": "192.168.0.0/16"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***",

"VpcId": "vpc-1bu96bw***",

"VpcName": "openapi",

"Cidr": "192.168.0.0/16",

"Status": "CREATING",

"TenantId": "210512011001***",

"Type": "tenant",

"DefaultVpc": "",

"RegionId": "",

"CreatedAt": "2022-05-11 13:54:56",

"UpdatedAt": "2022-05-11 13:54:56"

}

1.2 DeleteVpc

调用 DeleteVpc 接口删除一个专有网络 VPC。

1.2.1 使用说明

DELETE https://{Endpoint}/vpc/v1.0/vpcs/{vpc_id}

调用该接口删除 VPC 时，请注意：

• 删除 VPC 之前，需要先释放或转移 VPC 内的所有资源，包括交换机、云产品实例、高可用虚拟 IP 等。

• 只有处于“RUNNING”状态的 VPC 才可以被删除。

1.2.2 请求参数

1.2.3 返回数据

1.2.4 示例

1. 请求示例

DELETE https://{Endpoint}/vpc/v1.0/vpcs/{vpc_id}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId" : "c9d0bc5a82ca0bb2c320995cfe31f***"

}

1.3 RenameVpc

调用 RenameVpc 接口修改指定 VPC 的名称。

1.3.1 使用说明

PUT http://{Endpoint}/vpc/v1.0/vpcs/{vpc_id}

1.3.2 请求参数

1.3.3 返回数据

1.3.4 示例

1. 请求示例

PUT http://{Endpoint}/vpc/v1.0/vpcs/{vpc_id}

{

"VpcName": "openapi-new22"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "c9d0bc5a82ca0bb2c320995cfe31***",

"VpcId": "vpc-1bu96bw***",

"VpcName": "openapi-new22",

"Cidr": "192.168.0.0/16",

"Status": "RUNNING",

"TenantId": "210512011001***",

"Type": "tenant",

"DefaultVpc": "",

"RegionId": "",

"CreatedAt": "2022-05-11 13:54:56",

"UpdatedAt": "2022-05-11 13:57:08"

}

1.4 GetVpcDetail

调用 GetVpcDetail 接口查询指定 VPC 的配置信息。

1.4.1 使用说明

GET http://{Endpoint}/vpc/v1.0/vpcs/{vpc_id}

1.4.2 请求参数

1.4.3 返回数据

1.4.4 示例

1. 请求示例

GET http://{Endpoint}/vpc/v1.0/vpcs/{vpc_id}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***",

"VpcId": "vpc-1bu96bw***",

"VpcName": "openapi",

"Cidr": "192.168.0.0/16",

"Status": "RUNNING",

"TenantId": "210512011001***",

"Type": "tenant",

"DefaultVpc": "",

"RegionId": "",

"CreatedAt": "2022-05-11 13:54:56",

"UpdatedAt": "2022-05-11 13:57:08"

}

1.5 GetVpcList

调用 GetVpcList 接口查询已创建的 VPC 列表。

1.5.1 使用说明

GET http://{Endpoint}/vpc/v1.0/vpcs?PageNumber=1&PageSize=10&Status=0

1.5.2 请求参数

1.5.3 返回数据

1.5.4 示例

1. 请求示例（多个过滤参数使用&连接）

GET http://{Endpoint}/vpc/v1.0/vpcs?PageNumber=1&PageSize=10&Status=0

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"PageNumber": 1,

"PageSize": 10,

"RequestId": "4562b07f59c1979fef60a16899cc8***",

"TotalCount": 2,

"Vpcs": [

{

"VpcId": "vpc-1bu96bw***",

"VpcName": "openapi",

"Cidr": "192.168.0.0/16",

"TenantId": "210512011001110",

"RegionId": "",

"Status": "RUNNING",

"LbNumber": 0,

"EcsNumber": 0,

"SubnetNumber": 0,

"RouterNumber": 1

{

"VpcId": "vpc-9nwqv7w***",

"VpcName": "zql-acl-test",

"Cidr": "192.168.0.0/16",

"TenantId": "210512011001110",

"RegionId": "",

"Status": "RUNNING",

"LbNumber": 0,

"EcsNumber": 0,

"SubnetNumber": 3,

"RouterNumber": 1

}

]

}

1.6 错误码

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服