接口功能介绍
查询租户购买的eip列表信息。
接口约束
天翼云用户。
URI
POST /osm/v2/console/listEip
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNumber | 是 | Integer | 当前分页 | 1 | |
| pageSize | 是 | Integer | 分页显示的数据条数 | 10 | |
| regionID | 否 | String | 资源池id | rs-848834 | |
| azName | 否 | String | 可用区名称 | az-834834 | |
| vpcID | 否 | String | vpc id | vpc-uijdsj3443 | |
| eipId | 否 | String | eip id | 700c065cbbd35b8aa07d551dba4a5141 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 接口错误详情 | ||
| statusCode | String | 接口请求状态码 | 00000表示成功，其他为失败 | |
| message | String | 请口操作结果说明 | 操作成功或失败说明 | |
| page | Object | 返回数据对像 | page | |
| returnObj | Array of Objects | 返回数据对像数组 | returnObj |
表 page
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| current | Integer | 当前分页 | 3 | |
| size | Integer | 分页数据记录数 | 10 | |
| total | Integer | 总数据量 | 54 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | eip id | 7uyewjjw977343 | |
| name | String | eip名称 | eip-osm | |
| eipAddress | String | eip地址 | 20.138.38.20 | |
| status | String | 状态 | ACTIVE: 激活,已绑定 DOWN: 未使用 | |
| bandwidth | String | 带宽 | 100Mbps | |
| createdAt | String | 创建时间 | 2024/10/10 10:10 | |
| expireDate | String | 到期时间 | 2024/10/10 10:10 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"pageNumber": 1,
"pageSize": 10,
"regionID": "rs-848834",
"azName": "az-834834",
"vpcID": "vpc-uijdsj3443",
"eipId": "700c065cbbd35b8aa07d551dba4a5141",
"name": "eip-8843843"
}
响应示例
{
"statusCode": "00000",
"message": "操作成功",
"page": {
"current": 3,
"size": 10,
"total": 54
},
"returnObj": [
{
"id": "7uyewjjw977343",
"name": "eip-osm",
"eipAddress": "20.138.38.20",
"status": "ACTIVE",
"bandwidth": "100Mbps",
"createdAt": "2024-10-10 10:10:10",
"expireDate": "2024-10-10 10:10:10"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
