接入说明
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 | 语义 |
---|---|---|---|
Success | Action is success | 200 | 成功 |
InvalidFormat | The format of the input parameter "%s" is illegal. | 400 | 您输入参数格式不正确:"%s" |
TooManyIPs | Quota has been exceeded. | 400 | 您的配额已用完 |
MissingParameter | client params error, Required String parameter "%s" is not present | 400 | 缺少输入参数:"%s" |
IPNotEnough | No more Eips available in our system. | 400 | 系统内可用Eip不足 |
InternalServerError | Internal server error. | 500 | 服务器内部错误 |
InvalidTenant | This tenant does not exist in our system. | 400 | 租户不存在 |
InvalidIP | The specified Eip not exist. | 404 | Eip不存在 |
ActionFail | Action fail cause by Eip status. | 403 | Eip的状态不支持此操作 |
UnSupportChange | Change of this specified Eip is unsupported. | 400 | 不支持对该Eip进行变更 |
ActionNotAllow | Your pemission is not enough. | 403 | 您的权限不足 |
UnSupportedAction | Unsupported Action or Version | 404 | 接口不存在或者不支持 |
ResourceNotFound | The specified instance resouce not found. | 404 | Eip绑定或解绑的资源不存在 |
OrderNotExist | The specified order id error or not exist. | 400 | 订单错误或不存在 |
OrderUnpaid | The specified order is unpaid. | 400 | 订单未支付 |
OrderStateIllegal | The specified order state is illegal. | 400 | 订单状态异常 |
BillError | Internal billing server error. | 500 | 服务器内部计费错误 |
InsufficientBalance | Your balance is insufficient. | 403 | 您的余额不足 |
ResourceConflict | The specified Eip conflict. | 400 | Eip冲突 |
NetworkError | Internal network error. | 500 | 服务器内部网络错误 |
RenewConflict | The specified IP had an inactive renew order. | 400 | 此Eip已存在未生效的续费订单 |
Eip Object字段说明:
Field | 描述 | 类型 | 是否必须 | 其他约束条件 |
---|---|---|---|---|
Id | Eip.Id | String | yes | 合法的 UUID |
Comment | Eip.Comment | String | no | 256个长度限制 |
IpAddress | IP 地址 | String | yes | 合法的 IP 地址 |
MaxBandwidth | 带宽,单位 Mbps | int | yes | 最小为1,最大为500 |
Status | 状态 | String Enum | yes | 详见 Status 说明 |
PayType | 计费类型 | String Enum | yes | PostPaid: 后付费 PrePay: 预付费 |
NetworkChargeType | 网络资源计费类型 | String Enum | yes | PayByTraffic,按流量计费,PayByBandwidth,按带宽峰值计费,只有预付费(PrePay)时支持此类型 |
InstanceType | 绑定的资源类型 | String Enum | no | nvs 表示云主机,srv 表示容器,只有绑定才有 |
InstanceId | 绑定的资源 ID | String | no | 只有绑定才有 |
InstanceName | 绑定的资源名称 | String | no | 只有绑定才有 |
ActiveStatus | Eip的运行状态 | String Enum | Yes | Normal 表示正常,Arrear 表示欠费停服 |
StartTime | 后付费开始时间 | Long | No | 只有预付费才有,List 接口和 Get 详情接口会返回 |
EndTime | 后付费结束时间 | Long | No | 只有预付费才有,List 接口和 Get 详情接口会返回 |
CreatedAt | 创建时间 | String | yes | 2017-09-27T02:30:14Z的形式 |
UpdatedAt | 修改时间 | String | yes | 2018-03-27T02:41:17Z的形式 |
Status 说明:
状态 | 说明 | 可进行的操作 |
---|---|---|
Available | 可用 | 绑定、释放 |
Associating | 绑定中 | |
InUse | 已绑定 | 解绑 |
Unassociating | 解绑中 | |
Released | 已释放(只有释放 IP 的时候才会返回此状态) |
3. 接口说明
Version 统一为 2017-12-14
如无特殊注明,接口均支持 GET 和 POST