接口功能介绍
调用此接口可创建弹性公网IP（Elastic IP Address，简称EIP）。
接口约束
无。
URI
POST /v4/eip/create
请求参数
请求Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| regionID | String | 是 | 资源池 ID | |
| projectID | String | 否 | 不填默认为默认企业项目，如果需要指定企业项目，则需要填写 | 0 |
| cycleType | String | 是 | 订购类型：month（包月） / year（包年） / on_demand（按需） | month |
| cycleCount | Integer | 否 | 订购时长, 当 cycleType = month, 支持续订 1 - 11 个月; 当 cycleType = year, 支持续订 1 - 3 年, 当 cycleType = on_demand 时，可以不传 | 1 |
| name | String | 是 | 支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | acl11 |
| bandwidth | Integer | 否 | 弹性 IP 的带宽峰值，默认为 1 Mbps | |
| bandwidthID | String | 否 | 当 cycleType 为 on_demand 时，可以使用 bandwidthID，将弹性 IP 加入到共享带宽中 | |
| demandBillingType | String | 否 | 按需计费类型，当 cycleType 为 on_demand 时生效，支持 bandwidth（按带宽）/ upflowc（按流量） | bandwidth |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 | 返回结果 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| masterOrderID | String | 订单id。 | 55d531d7bf2d47658897c42ffb918423 |
| masterOrderNO | String | 订单编号, 可以为 null。 | 20221021191602644224 |
| masterResourceStatus | String | 资源状态: started（启用） / renewed（续订） / refunded（退订） / destroyed（销毁） / failed（失败） / starting（正在启用） / changed（变配）/ expired（过期）/ unknown（未知） | started |
| masterResourceID | String | 可以为 null。 | d48cace2da7b4c81b4c0444768a04608 |
| regionID | String | 可用区id。 | 81f7728662dd11ec810800155d307d5b |
| eipID | String | 弹性 IP id | 当 masterResourceStatus 不为 started 时，该值可能为 null |
请求示例
POST /v4/eip/create
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"clientToken": "Xxxxx",
"cycleType": "year",
"bandwidth": 5,
"cycleCount": 1,
"name": "test"
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": {
"masterOrderID": "ee508bcc586211ed961bacde48001122",
"masterOrderNO": null,
"masterResourceID": "d48cace2da7b4c81b4c0444768a04608",
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"eipID": "eip-xxxxx"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
