接入说明

1. 服务说明

服务名称: eip

服务类型:Regional 服务

访问控制:未接入子账号

2. HTTP 响应

返回信息格式统一为Json格式,不支持XML。

请求成功则返回 http status code 200/201,具体每个接口的返回都不完全一样。

请求失败则返回标准的 http status code,responseBody中包含 Code/Message/RequestId 信息, Code 使用字符串类型。

HTTP Code说明:

Code说明
2xx请求成功
4xx客户端错误
5xx服务端错误(客户端可重试)

返回说明:

错误码描述HTTP Code语义
SuccessAction is success200成功
InvalidFormatThe format of the input parameter "%s" is illegal.400您输入参数格式不正确:"%s"
TooManyIPsQuota has been exceeded.400您的配额已用完
MissingParameterclient params error, Required String parameter "%s" is not present400缺少输入参数:"%s"
IPNotEnoughNo more Eips available in our system.400系统内可用Eip不足
InternalServerErrorInternal server error.500服务器内部错误
InvalidTenantThis tenant does not exist in our system.400租户不存在
InvalidIPThe specified Eip not exist.404Eip不存在
ActionFailAction fail cause by Eip status.403Eip的状态不支持此操作
UnSupportChangeChange of this specified Eip is unsupported.400不支持对该Eip进行变更
ActionNotAllowYour pemission is not enough.403您的权限不足
UnSupportedActionUnsupported Action or Version404接口不存在或者不支持
ResourceNotFoundThe specified instance resouce not found.404Eip绑定或解绑的资源不存在
OrderNotExistThe specified order id error or not exist.400订单错误或不存在
OrderUnpaidThe specified order is unpaid.400订单未支付
OrderStateIllegalThe specified order state is illegal.400订单状态异常
BillErrorInternal billing server error.500服务器内部计费错误
InsufficientBalanceYour balance is insufficient.403您的余额不足
ResourceConflictThe specified Eip conflict.400Eip冲突
NetworkErrorInternal network error.500服务器内部网络错误
RenewConflictThe specified IP had an inactive renew order.400此Eip已存在未生效的续费订单

Eip Object字段说明:

Field描述类型是否必须其他约束条件
IdEip.IdStringyes合法的 UUID
CommentEip.CommentStringno256个长度限制
IpAddressIP 地址Stringyes合法的 IP 地址
MaxBandwidth带宽,单位 Mbpsintyes最小为1,最大为500
Status状态String Enumyes详见 Status 说明
PayType计费类型String EnumyesPostPaid: 后付费 PrePay: 预付费
NetworkChargeType网络资源计费类型String EnumyesPayByTraffic,按流量计费,PayByBandwidth,按带宽峰值计费,只有预付费(PrePay)时支持此类型
InstanceType绑定的资源类型String Enumnonvs 表示云主机,srv 表示容器,只有绑定才有
InstanceId绑定的资源 IDStringno只有绑定才有
InstanceName绑定的资源名称Stringno只有绑定才有
ActiveStatusEip的运行状态String EnumYesNormal 表示正常,Arrear 表示欠费停服
StartTime后付费开始时间LongNo只有预付费才有,List 接口和 Get 详情接口会返回
EndTime后付费结束时间LongNo只有预付费才有,List 接口和 Get 详情接口会返回
CreatedAt创建时间Stringyes2017-09-27T02:30:14Z的形式
UpdatedAt修改时间Stringyes2018-03-27T02:41:17Z的形式

Status 说明:

状态说明可进行的操作
Available可用绑定、释放
Associating绑定中
InUse已绑定解绑
Unassociating解绑中
Released已释放(只有释放 IP 的时候才会返回此状态)

3. 接口说明

Version 统一为 2017-12-14

如无特殊注明,接口均支持 GET 和 POST