eip列表
EIP列表
1. 描述
获取EIP列表
2. 请求地址
请求地址的格式如下：
https://<区域服务地址>/v1/eip/list
3. 请求参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| projectId | String | 是 | 项目ID |
| nameOrSn | String | 否 | 名称或SN |
| address | String | 否 | IP地址 |
| curPage | Integer | 否 | 当前页码，默认值1 |
| perPage | Integer | 否 | 每页显示条数，默认值10 |
4. 请求示例
以获取华东一区某项目的EIP列表为例：
4.1. 请求地址
POST https://cn-east-1.api.yovole.com/v1/eip/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": "xxxxxxxxxxx",
"curPage":1,
"perPage":10
}
5. 返回结果示例
5.1. 返回正确结果示例
{
"requestId":"9c92685b-5d22-410d-b1be-081ff74fb4bf",
"success":true,
"code":0,
"pager":{
"curPage":1,
"perPage":10,
"totalRecords":1,
"totalPages":1,
"pageData":[
{
"id":"787b1dc0-57ec-4b57-8bbb-b2813c8ce1ae",
"address":"10.3.29.4",
"bandwidth":2,
"status":"ACTIVE",
"sn":"EIP-218KP3Y",
"name":"a",
"regionSn":"CN-EAST-1",
"typeId":"BGP",
"typeName":"BGP",
"feeType":"FLOW",
"resStatus":"IDLE",
"created":"2019-05-09 17:40:57"
}
]
}
}
5.2. 返回错误结果示例
{
"requestId": "4416235a-e9c0-453f-823a-ad491ebd74ab",
"success": false,
"code": 605,
"message": "permission denied"
}
6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码，错误码信息和简单的错误分析方法可以参考公共错误码。