接口功能介绍
调用此接口可查看EIP详情。
接口约束
无。
URI
GET /v4/eip/show
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池 ID | |
| eipID | String | 是 | 弹性公网IP的ID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Object | object | 返回结果 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| ID | String | eip ID | |
| name | String | eip 名称 | |
| description | String | 描述 | |
| eipAddress | String | eip 地址 | |
| associationID | String | 当前绑定的实例的 ID | |
| associationType | String | 当前绑定的实例类型: LOADBALANCER / INSTANCE / PORTFORWARDING / VIP / PHYSICALINSTANCE | |
| privateIpAddress | String | 交换机网段内的一个 IP 地址 | |
| bandwidth | Integer | 带宽峰值大小，单位 Mb | |
| status | String | 1.ACTIVE 2.DOWN 3.ERROR 4.UPDATING 5.BANDING_OR_UNBANGDING 6.DELETING 7.DELETED 8.EXPIRED | |
| tags | String | EIP 的标签集合 | |
| createdAt | String | 创建时间 | |
| updatedAt | String | 更新时间 | |
| expiredAt | String | 到期时间 | 2022-11-25T01:08:10Z |
请求示例
GET /v4/eip/show?regionID=xxx&clientToken=xxxx&eipID=eip-xxx
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"ID":"eip-c2f7vle3vr",
"name":"eip-test-0001234",
"eipAddress":"100.124.3.141",
"associationID":"",
"associationType":null,
"privateIpAddress":"",
"bandwidth":100,
"status":"DOWN",
"tags":"",
"createdAt": "2022-10-25T01:08:10Z",
"updatedAt": "2022-10-25T01:08:10Z",
"expiredAt": "2022-11-25T01:08:10Z"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
