接口功能介绍
调用此接口可将弹性公网IP(Elastic IP Address,简称EIP)与相关云产品上绑定。
接口约束
- EIP 需为可用状态。
- EIP 可绑定到同区域的云主机、裸金属和高可用虚拟IP上。
URI
POST /v4/eip/associate
请求参数
请求Body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
clientToken | String | 是 | 客户端存根,用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
regionID | String | 是 | 资源池 ID | |
projectID | String | 否 | 企业项目 ID,默认为"0" | |
eipID | String | 是 | 绑定云产品实例的 EIP 的 ID | |
associationID | String | 是 | 绑定的实例的 ID | |
associationType | Integer | 是 | 绑定的实例类型:1 ECS 云主机 VM,2 VIP, 3 BM |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
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 |
请求示例
POST /v4/eip/associate
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"clientToken": "xxxx",
"eipID": "eip-c2f7vle3vr",
"associationID": "xxxx",
"associationType": 1
}
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description":""
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。