更新时间:2025-10-10 GMT+08:00
分享

查询订单详情

功能介绍

查询订单详情接口用于获取指定订单的详细信息。该接口适用于以下场景:当需要查看订单的状态、金额、商品信息或处理订单相关问题时,用户可通过此接口获取订单的详细数据。使用该接口的前提条件是订单已存在且用户具有访问该订单的权限。调用接口成功后,系统将返回订单的详细信息,包括订单号、商品列表、金额、支付状态、下单时间等。若订单不存在、用户无权限访问或订单信息未正确配置,接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/orders/{order_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:用户项目ID。获取方法请参见获取项目ID和名称

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

order_name

String

参数解释:订单ID。取值自订单列表返回的orderName字段。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:用户的token。

约束限制:不涉及。

取值范围:不涉及。

默认取值:不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:订单关联的资源数量。

取值范围:不涉及。

items

Array of OrderDetailItem objects

参数解释:订单关联的资源信息列表。

表4 OrderDetailItem

参数

参数类型

描述

resourcename

String

参数解释:资源的ID,取值自资源详情的metadata.name字段。

取值范围:不涉及。

action

String

参数解释:订单关联的资源变更动作类型。

取值范围:可选值如下:

  • createPool:创建资源池。

  • deletePool:删除资源池。

  • createNode:创建节点。

  • deleteNode:删除节点,主要是包周期节点退订场景。

  • renew:续费。

  • toPeriodic:转包周期。

status

String

参数解释:订单关联资源的变更状态。

取值范围:可选值如下:

  • processing:处理中,资源正在处理中。

  • succeed:成功,资源处理成功。

  • failed:失败,资源处理失败。

begintimestamp

String

参数解释:资源开始变更时间戳,形如1744285793000,单位毫秒。

取值范围:不涉及。

updatetimestamp

String

参数解释:资源变更最后更新时间戳,形如1744285793000,单位毫秒。

取值范围:不涉及。

message

String

参数解释:资源变更的执行信息,如失败原因。

取值范围:不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

参数解释:具体错误信息。

取值范围:不涉及。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:ModelArts错误码。

取值范围:不涉及。

error_msg

String

参数解释:具体错误信息。

取值范围:不涉及。

请求示例

查询订单详情中的资源信息。

GET /v1/{project_id}/orders/{order_name}

响应示例

状态码:200

OK。

{
  "count" : 4,
  "items" : [ {
    "action" : "createPool",
    "resourcename" : "pool-9495-6f5da086876d4cd084d36f8bd3346036",
    "status" : "succeed",
    "begintimestamp" : 1744285793000,
    "updatetimestamp" : 1744286479000
  }, {
    "action" : "createNode",
    "resourcename" : "os-node-created-8jsnk",
    "status" : "succeed",
    "begintimestamp" : 1744286228000,
    "updatetimestamp" : 1744286479000
  }, {
    "action" : "createNode",
    "resourcename" : "os-node-created-lq4f8",
    "status" : "succeed",
    "begintimestamp" : 1744286228000,
    "updatetimestamp" : 1744286479000
  }, {
    "action" : "createNode",
    "resourcename" : "os-node-created-ggthb",
    "status" : "succeed",
    "begintimestamp" : 1744286228000,
    "updatetimestamp" : 1744286479000
  } ]
}

状态码:400

Bad Request。

{
  "error_code" : "ModelArts.50004000",
  "error_msg" : "Bad request."
}

状态码:404

Not Found。

{
  "error_code" : "ModelArts.50015001",
  "error_msg" : "Order {name} not found."
}

状态码

状态码

描述

200

OK。

400

Bad Request。

404

Not Found。

错误码

请参见错误码

相关文档