接口功能介绍
根据输入订单号masterOrderID查询出云主机的UUID
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
订单查询:通过创建云主机接口得到对应的主订单ID后,使用该接口获取订单状态,并在订单状态为成功之后获取对应的云主机ID
接口约束
确保订单号准确无误
URI
GET /v4/ecs/order/query-uuid
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
masterOrderID | 是 | String | 订单ID | ce57956bf6354827bc91ec7ade20cb11 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 英文描述信息 | SUCCESS | |
description | String | 中文描述信息 | 成功 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
orderStatus | String | 订单状态,详见枚举值表格 | 3 | |
instanceIDList | Array of Strings | 云主机的ID列表,订单处于创建中,返回为空列表。待订单完成后才能正常返回ID | ["ab83374c69f148dbbc1aeafdb205a79d"] |
枚举参数
参数名 orderStatus
枚举值 | 类型 | 说明 |
---|---|---|
1 | String | 待支付 |
2 | String | 已支付 |
3 | String | 完成 |
4 | String | 取消 |
5 | String | 施工失败 |
7 | String | 正在支付中 |
8 | String | 待审核 |
9 | String | 审核通过 |
10 | String | 审核未通过 |
11 | String | 撤单完成 |
12 | String | 退订中 |
13 | String | 退订完成 |
14 | String | 开通中 |
15 | String | 变更移除 |
16 | String | 自动撤单中 |
17 | String | 手动撤单中 |
18 | String | 终止中 |
22 | String | 支付失败 |
-2 | String | 待撤单 |
-1 | String | 未知 |
0 | String | 错误 |
140 | String | 已初始化 |
999 | String | 逻辑错误 |
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"returnObj":{
"instanceIDList":[
"ab83374c69f148dbbc1aeafdb205a79d"
],
"orderStatus":"3"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码