按需订单查询
接口功能介绍
按需订单查询，包括云企业路由器流量计费订单，网络实例计费订单
接口约束
无
URI
GET /v4/ec/tgw-order/query
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速ID | 3acd1ed4-426a-4ea0-a8e4-8584657cddee | |
resourceID | 否 | String | 资源ID | 795158016fed44fa9867433c9f162ed6 | |
orderType | 否 | String | 订单类型 取值范围: 1:云企业路由器流量计费订单 2:网络实例计费订单 | 1 | |
orderState | 否 | String | 订单状态 取值范围: 1:正常 2:冻结 | 1 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 | 800 | |
errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 示例 | 下级对象 |
|---|---|---|---|---|
currentCount | 否 | Integer | 3 | |
totalPage | 否 | Integer | 1 | |
totalCount | 否 | Integer | 3 | |
results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
ecID | 否 | String | 云间高速ID | 3acd1ed4-426a-4ea0-a8e4-8584657cddee | |
tenantID | 否 | String | 用户ID | 12450584-fe8f-49b0-9e09-ef915caeee10 | |
orderID | 否 | String | 订单ID | bb4e607c0da348a6ab6be71c10fc2a5b | |
resourceID | 否 | String | 资源ID | 795158016fed44fa9867433c9f162ed6 | |
orderType | 否 | String | 订单类型 取值范围: 1:云企业路由器流量计费订单 2:网络实例计费订单 | 1 | |
createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 | |
expireDate | 否 | String | 过期时间 | 2022-09-19 02:05:28 |
请求示例
请求url
v4/ec/tgw-order/query?ecID=194dd8fa-210f-42a9-867e-cdf859bc8f7c&orderType=1&orderState=1
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"traceID": "24ebd3188eac819bf44acedf6cfae80c",
"msg": "Query tgw order success",
"results": [
{
"orderID": "b8c52a60-cbb4-46be-b83f-6dc176833b90",
"expireDate": "2125-07-28 12:40:43",
"resourceID": "ad6dcb02687c40e8b5f589ae726d657f",
"orderType": 1,
"createDate": "2025-07-28 12:40:43",
"ecID": "194dd8fa-210f-42a9-867e-cdf859bc8f7c",
"tenantID": "f33f8afaa4a449d0b98cb9684d317c68"
}
]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.RouteMAPEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
