接口功能介绍
调用此接口可批量检查弹性公网IP地址是否已经被使用。
接口约束
无。
URI
POST /v4/eip/check-addresses
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 否 | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| regionID | String | 是 | 资源池 ID | |
| projectID | String | 否 | 企业项目 ID，默认为"0" | |
| eipAddresses | Array of String | 是 | 弹性公网IP地址列表 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 | Array of Objects | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| eipAddress | String | "192.168.1.1" | 弹性公网IP地址 |
| used | Boolean | True | 是否被使用 |
请求示例
POST /v4/eip/check-addresses
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"clientToken": "Xxxxx",
"eipAddresses": ["192.168.1.1", "192.168.1.2"],
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": [{
"eipAddress": "92.168.1.1",
"used": True
},{
"eipAddress": "92.168.1.2",
"used": False
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
