接口功能介绍
调用此接口可创建弹性公网IP（Elastic IP Address，简称EIP）
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权 计费说明：确认创建弹性IP的计费方式和价格，详细查看计费说明
地域选择：选择创建弹性IP的资源池，详细查看地域和可用区
资源规格和配额限制：请确定弹性IP的带宽选择与配额限制，详细查看规格和使用限制
接口约束
1.共享带宽到期或欠费后将被冻结，冻结一段时间将对该共享带宽进行销毁，该共享带宽下的弹性IP将自动移出，并恢复原计费类型及1M的带宽峰值。
URI
POST /v4/ecs/eip/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，使用同一个ClientToken值， 则代表为同一个请求。保留时间为24小时 |
create-eip-test | |
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| projectID | 否 | String | 企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目 注：默认值为"0" |
0 | |
| cycleType | 是 | String | 订购类型，取值范围：month表示按月，year表示按年，on_demand表示按需 | month | |
| cycleCount | 是 | Integer | 订购时长, 当 cycleType = month 时, 支持订购1 - 11 个月，支持续订1 - 11 个月 ; 当 cycleType = year 时, 支持订购1 - 5 年，支持续订 1 - 3 年； 当 cycleType = on_demand 时，可以不传 |
1 | |
| name | 是 | String | 弹性 IP 名称，满足以下规则：支持拉丁字母、中文、数字，下划线，连字符，中文 / 英文字母开头，不能以 http: / https: 开头，长度 2 - 32 | eip-name | |
| bandwidth | 否 | Integer | 弹性 IP 的带宽峰值，默认为 1 Mbps | 5 | |
| bandwidthID | 否 | String | 共享带宽，当 cycleType 为 on_demand 时生效，将弹性 IP 加入到共享带宽中 | bandwidth-7hzv449r2j | |
| demandBillingType | 否 | String | 按需计费类型，当 cycleType 为 on_demand 时生效，支持 bandwidth（按带宽）/ upflowc（按流量） | bandwidth |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误信息 | success | |
| description | String | 失败时的错误描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，可以使用materOrderID进一步确认订单状态及资源状态 | 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 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：创建一个包年包月的弹性IP，购买时长1年，带宽为5Mbps，名称为eip-name
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"clientToken": "create-eip-test",
"cycleType": "year",
"bandwidth": 5,
"cycleCount": 1,
"name": "eip-name"
}
响应示例
{
"statusCode": 800,
"message": "SUCCESS",
"description": "成功",
"returnObj": {
"masterOrderID": "ee508bcc586211ed961bacde48001122",
"masterOrderNO": null,
"masterResourceID": "d48cace2da7b4c81b4c0444768a04608",
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
