根据masterOrderID查询云主机ID
接口功能介绍
根据输入订单号masterOrderID查询出云主机的UUID
接口约束
请保证输入的订单号准确无误
URI
GET /v4/ecs/order/query-uuid
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
masterOrderID | 是 | String | 订单ID | ce57956bf6354827bc91ec7ade20cb11 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败)默认值:800 | 800 | |
errorCode | String | 错误码,为product.module.code三段式码。为空表示成功。 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | masterOrderID cannot be null | |
description | String | 失败时的错误描述,一般为中文描述 | [主订单ID]不能为空 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
orderStatus | String | 订单状态,具体值代表含义,请查看表orderStatus | 3 | |
instanceIDList | Array of Strings | 云主机的ID列表,订单处于创建中,返回为空列表。待订单完成后才能正常返回ID | ["ab83374c69f148dbbc1aeafdb205a79d"] |
表 orderStatus
值 | 说明 |
---|---|
1 | 待支付 |
2 | 已支付 |
3 | 完成 |
4 | 取消 |
5 | 施工失败 |
7 | 正在支付中 |
8 | 待审核 |
9 | 审核通过 |
10 | 审核未通过 |
11 | 撤单完成 |
12 | 退订中 |
13 | 退订完成 |
14 | 开通中 |
15 | 变更移除 |
16 | 自动撤单中 |
17 | 手动撤单中 |
18 | 终止中 |
22 | 支付失败 |
-2 | 待撤单 |
-1 | 未知 |
0 | 错误 |
140 | 已初始化 |
999 | 逻辑删除 |
请求示例
GET .../v4/ecs/order/query-uuid?masterOrderID=ce57956bf6354827bc91ec7ade20cb11
响应示例
{
"returnObj":{
"instanceIDList":[
"ab83374c69f148dbbc1aeafdb205a79d"
],
"orderStatus":"3"
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.OrderCheck.NotFound | 未找到当前masterOrderID对应订单 |