子网列表
子网列表
1. 描述
获取子网列表
2. 请求地址
请求地址的格式如下：
https://<区域服务地址>/v1/subnet/list
3. 请求参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| projectId | String | 是 | 项目ID |
| nameOrSn | String | 否 | 子网名称或SN |
| vpcSn | String | 否 | vpcSn |
| vpcId | String | 否 | vpcId |
| azSn | String | 否 | azSn |
| curPage | Integer | 否 | 当前页码，默认值1 |
| perPage | Integer | 否 | 每页显示条数，默认值10 |
4. 请求示例
以获取华东一区某项目下子网列表信息为例：
4.1. 请求地址
POST https://cn-east-1.api.yovole.com/v1/subnet/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=
4.2. 接口请求参数
{
"projectId": "8a83a0906b692378016b6d5ec5f40250",
"curPage":1,
"perPage":10
}
5. 返回结果
5.1. 返回正确结果示例
{
"success":true,
"code":0,
"pager":{
"curPage":1,
"perPage":10,
"totalRecords":2,
"totalPages":1,
"pageData":[
{
"id":"98e6bf98-3283-4bed-80c8-2132a510aebb",
"name":"API Create subnet",
"sn":"SN-21A-8KP4V",
"regionSn":"CN-EAST-1",
"azSn":"CN-EAST-1-A",
"created":"2019-05-07 10:55:09",
"cidr":"172.20.4.0/22",
"vpcId":"a611a074-7b60-4a8a-8d43-bff013e0eb64"
},
{
"id":"e9389c4b-27c1-44d0-9b9a-3f1d0aa71978",
"name":"默认子网",
"sn":"SN-21A-8KP4U",
"regionSn":"CN-EAST-1",
"azSn":"CN-EAST-1-A",
"created":"2019-05-06 10:28:59",
"cidr":"10.1.1.0/24",
"vpcId":"0a022b83-02ef-41dc-a4c3-4a2c61eb1f98"
}
]
}
}
5.2. 返回错误结果示例
{
"requestId": "4416235a-e9c0-453f-823a-ad491ebd74ab",
"success": false,
"code": 605,
"message": "permission denied"
}
6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码，错误码信息和简单的错误分析方法可以参考公共错误码。