查询虚拟私有云列表 - ListVpcs
功能介绍
获取虚拟私有云的列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
GET /v1/vpcs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
通过ID查询 |
|
limit |
否 |
Integer |
查询返回虚拟私有云列表数量。 |
|
name |
否 |
String |
通过name查询 |
|
offset |
否 |
Integer |
查询的偏移量。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
虚拟私有云的总数。 |
|
vpcs |
Array of Vpc objects |
虚拟私有云数组对象。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
虚拟私有云的ID。 |
|
name |
String |
虚拟私有云名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 约束：同一个帐号下的名称不能重复 |
|
cidr |
String |
虚拟私有云下可用子网的范围 取值范围： 10.0.0.0/8~24 172.16.0.0/12~24 192.168.0.0/16~24 约束：必须是cidr格式，例如:192.168.0.0/16 |
|
mode |
String |
虚拟私有云的模式，支持的取值范围如下： SYSTEM：该类型网络，系统会自动按照实际需要创建足够的子网。 CUSTOMER：该类型网络，用户需要完全按照自己站点的需要，去申请足够的子网。 |
|
subnet_num |
Integer |
子网的数目。 |
请求示例
GET https://{{endpoint}}/v1/vpcs?limit=1000&offset=0
响应示例
状态码：200
OK
{
"count" : 1,
"vpcs" : [ {
"id" : "ab96424b-aba2-4b08-b534-25e2dbd89519",
"name" : "dc_vpc_001",
"cidr" : "192.168.2.0/21",
"subnet_num" : 4,
"mode" : "SYSTEM"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
