批量檢查彈性 IP 是否被使用
更新時間 2023-07-19 13:57:28
最近更新時間: 2023-07-19 13:57:28
分享文章
接口功能介紹
調用此接口可批量檢查彈性公網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 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
