接口功能介绍
保障型负载均衡退订
接口约束
无
URI
POST /v4/elb/refund-pgelb
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
| regionID | 是 | String | 区域ID | ||
| elbID | 是 | String | 负载均衡 ID | lb-xxxx |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | |
| error | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单id。 | 55d531d7bf2d47658897c42ffb918423 | |
| masterOrderNO | String | 订单编号, 可以为 null。 | 20221021191602644224 | |
| regionID | String | 可用区id。 | 81f7728662dd11ec810800155d307d5b | |
| masterResourceStatus | String | 资源状态: started（启用） / renewed（续订） / refunded（退订） / destroyed（销毁） / failed（失败） / starting（正在启用） / changed（变配）/ expired（过期）/ unknown（未知） | refunded |
枚举参数
无
请求示例
请求url
POST /v4/elb/refund-pgelb
请求头header
无
请求体body
{"clientToken": "xxxx","regionID": "81f7728662dd11ec810800155d307d5b","elbID": "lb-xxxx"}
响应示例
{"statusCode": 800,"message": "success","description": "成功","errorCode": "SUCCESS","returnObj": {"masterOrderID": "ee508bcc586211ed961bacde48001122","masterOrderNO": null,"regionID": "81f7728662dd11ec810800155d307d5b"}}
状态码
请参考 状态码
错误码
请参考 错误码
