文档中心

弹性公网EIP API参考手册

最近更新时间：2023-04-16 17:00:00

1 弹性公网管理

1.1 CreateEip

调用 CreateEip 接口创建弹性公网。

1.1.1 使用说明

POST http://{endpoint}/eip/v1.0/eips

1.1.2 请求参数

1.1.3 返回数据

1.1.4 示例

1. 请求示例

POST http://{endpoint}/eip/v1.0/eips

{

"EipName": "openapi-test",

"EipVersion": 4,

"BandWidthSize": 10,

"RegionId": "hanmei03",

"ZoneId": "zone-1",

"Duration": 1,

"PeriodType": "month",

"ChargingMode": "1"

}

2. 正常返回示例

{

"Eip": "120.0.0.72",

"EipId": "eip-49wqrupx7650",

"EipName": "openapi-test",

"Status": "DOWN",

"PrivateIp": "",

"TenantId": "210512011001110",

"BandwidthSize": 10,

"BandwidthId": "bw-xvr9v5k77vtx",

"RegionId": "wuhan",

"InstanceUid": "ecs-xxx",

"CreatedAt": "2022-01-06 15:09:53"

}

1.2 DeleteEip

调用 DeleteEip 接口删除弹性公网。

1.2.1 使用说明

DELETE http://{endpoint}/eip/v1.0/eips/{eip_id}

1.2.2 请求参数

1.2.3 返回数据

1.2.4 示例

1. 请求示例

DELETE http://{endpoint}/eip/v1.0/eips/{eip_id}

2. 正常返回示例

{

"RequestId": "500919a260f14721dec40b2ef9658***"

}

1.3 GetEipDetail

调用 GetEipDetail 接口查询指定 EIP 的配置信息。

1.3.1 使用说明

GET http://{endpoint}/eip/v1.0/eips/{eip_id}

1.3.2 请求参数

1.3.3 返回数据

1.3.4 示例

1. 请求示例

GET http://{endpoint}/eip/v1.0/eips/{eip_id}

2. 正常返回示例

{

"RequestId": "97263347dae4b35baf08b74bcd4c***",

"Eip": "120.0.0.72",

"EipId": "eip-49wqrupx7***",

"EipName": "openapi-test",

"Status": "DOWN",

"PrivateIp": "",

"TenantId": "210512011001110",

"BandwidthSzie": 10,

"BandwidthId": "bw-xvr9v5k77vtx",

"RegionId": "wuhan",

"InstanceUid": "ecs-xxx",

"CreatedAt": "2022-01-06 15:09:54"

}

1.4 GetEipList

调用 GetEipList 接口查询指定 EIP 的配置信息。

1.4.1 使用说明

GET http://{endpoint}/eip/v1.0/eips?PageSzie=10&PageNumber=1&Status=3

1.4.2 请求参数

1.4.3 返回数据

表1-1 EIP Object 表

1.4.4 示例

1. 请求示例

GET http://{endpoint}/eip/v1.0/eips?PageSzie=10&PageNumber=1&Status=3

2. 正常返回示例

{

"Eips": [

{

"Eip": "10.255.255.255",

"EipId": "eip-c9j7p8s6rf",

"EipName": "",

"Status": "DOWN",

"PrivateIp": "",

"TenantId": "210512011001",

"BandwidthSize": 10,

"BandwidthId": "bw-ul984o1oy1u3",

"RegionId": "hanmei03"，

"CreatedAt": "2021-12-22 09:57:01"

{

"Eip": "120.0.23.58",

"EipId": "eip-ydhcepxr2***",

"EipName": "",

"Status": "DOWN",

"PrivateIp": "",

"TenantId": "2105120110011",

"BandwidthSize": 10,

"BandwidthId": "bw-6unh38xin6",

"RegionId": "hanmei03"，

"CreatedAt": "2021-12-30 19:54:36"

}

"PageNumber": 1,

"PageSize": 10,

"RequestId": "ec6e7cd2fd7b4a67d69bbbe4c82bef**",

"TotalCount": 2

}

1.5 BindEip

调用 BindEip 接口绑定 EIP。

1.5.1 使用说明

PUT http://{endpoint}/eip/v1.0/eips/bind/{eip_id}

1.5.2 请求参数

1.5.3 返回数据

1.5.4 示例

1. 请求示例

PUT http://{endpoint}/eip/v1.0/eips/bind/{eip_id}

{

"InstanceUid": "ecs-xxx"

}

2. 正常返回示例

{

"RequestId": "500919a260f14721dec40b2ef9658***"

}

1.6 UnbindEip

调用 UnbindEip 接口解绑 EIP。

1.6.1 使用说明

PUT http://{endpoint}/eip/v1.0/eips/unbind/{eip_id}

1.6.2 请求参数

1.6.3 返回数据

1.6.4 示例

1. 请求示例

PUT http://{endpoint}/eip/v1.0/eips/unbind/{eip_id}

2. 正常返回示例

{

"RequestId": "500919a260f14721dec40b2ef9658***"

}

1.7 ModifyBandwidth

调用 ModifyBandwidth 接口修改 EIP 带宽。

1.7.1 使用说明

PUT http://{endpoint}/eip/v1.0/eips/{eip_id}

1.7.2 请求参数

1.7.3 返回数据

1.7.4 示例

1. 请求示例

PUT http://{endpoint}/eip/v1.0/eips/{eip_id}

{

"BandwidthSize": 20

}

2. 正常返回示例

{

"RequestId": "500919a260f14721dec40b2ef9658***"

}

1.8 RenewInstance

调用 RenewInstance 接口续费 EIP。

1.8.1 使用说明

PUT http://{endpoint}/eip/v1.0/eips/renew/{eip_id}

1.8.2 请求参数

1.8.3 返回数据

1.8.4 示例

1. 请求示例

PUT http://{endpoint}/eip/v1.0/eips/renew/{eip_id}

{

"Duration": 5,

"PeriodType": "month"

}

2. 正常返回示例

{

"RequestId": "500919a260f14721dec40b2ef9658***"

}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服