1. VPC列表
1.1. 描述
获取VPC列表
1.2. 请求地址
请求地址的格式如下:
https://<区域服务地址>/v1/vpc/list
1.3. 请求参数
参数名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
projectId | String | 是 | 项目ID |
nameOrSn | String | 否 | VPC名称或SN |
curPage | Integer | 否 | 当前页码,默认值1 |
perPage | Integer | 否 | 每页显示条数,默认值10 |
1.4. 请求示例
以获取华东一区某项目的VPC列表为例:
1.4.1. 请求地址
POST https://cn-east-1.api.yovole.com/v1/vpc/list HTTP/1.1
x-ycs-timestamp: 2019-06-19T14:26:26Z
x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=
1.4.2. 接口请求参数
{
"projectId": "8a83a0966ade941a016ae906f4d10129",
"curPage":1,
"perPage":10
}
1.5. 返回结果
1.5.1. 返回正确结果示例
{
"requestId":"a1e6daaa-7a02-445e-b801-bbed2f428932",
"success":true,
"code":200,
"pager":{
"curPage":1,
"perPage":10,
"totalRecords":2,
"totalPages":1,
"pageData":[
{
"id":"0a022b83-02ef-41dc-a4c3-4a2c61eb1f98",
"name":"默认VPC",
"sn":"VPC-218KP43",
"regionSn":"CN-EAST-1",
"created":"2019-05-06 10:28:43",
"cidr":"10.1.0.0/16"
},
{
"id":"a611a074-7b60-4a8a-8d43-bff013e0eb64",
"name":"API Create vpc",
"sn":"VPC-218KP44",
"regionSn":"CN-EAST-1",
"created":"2019-05-06 10:28:43",
"cidr":"172.20.0.0/16"
}
]
}
}
1.5.2. 返回错误结果示例
{
"requestId": "19c0e7ff-5554-4e90-b3a5-3aab644a8e30",
"success": false,
"code": 401,
"message": "client enabled is false",
"errorCode": "InvalidUserAccount"
}
1.6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码,错误码信息和简单的错误分析方法可以参考公共错误码。