Help Center/ ModelArts/ API Reference/ Order Management/ Querying Order Details
Updated on 2025-11-19 GMT+08:00
View PDF
Share

Querying Order Details

Function

This API is used to query order details.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: User project ID. For details, see Obtaining a Project ID and Name.

Constraints: N/A

Range: N/A

Default Value: N/A

order_name

Yes

String

Range: N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Constraints: N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Definition: Number of resources associated with the order.

Constraints: N/A

Range: N/A

Default Value: N/A

items

Array of OrderDetailItem objects

Definition: Resource information list associated with the order.

Constraints: N/A

Range: N/A

Default Value: N/A
Table 4 OrderDetailItem

Parameter

Type

Description

resourcename

String

Definition: Resource ID. The value is obtained from the metadata.name field in resource details.

Constraints: N/A

Range: N/A

Default Value: N/A

action

String

Definition: Type of the resource change associated with the order.

Constraints: N/A

Range:

  • createPool: Create a resource pool.

  • deletePool: Delete a resource pool.

  • createNode: Create a node.

  • deleteNode: Delete a node. This option is mainly used for unsubscribing from yearly/monthly nodes.

  • renew: Renew a subscription.

  • toPeriodic: Change the billing mode to yearly/monthly.

Default Value: N/A

status

String

Definition: Change status of the resource associated with the order.

Constraints: N/A

Range:

  • processing: The resource is being processed.

  • succeed: The resource is processed.

  • failed: The resource fails to be processed.

Default Value: N/A

begintimestamp

String

Definition: Timestamp when the resource starts to change, in milliseconds. For example, 1744285793000.

Constraints: N/A

Range: N/A

Default Value: N/A

updatetimestamp

String

Definition: Timestamp when the resource is last updated, in milliseconds. For example, 1744285793000.

Constraints: N/A

Range: N/A

Default Value: N/A

message

String

Definition: Execution information of resource change, for example, failure cause.

Constraints: N/A

Range: N/A

Default Value: N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

  • Definition: ModelArts error code.

Range: N/A

error_msg

String

Definition: Error message.

Range: N/A

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

  • Definition: ModelArts error code.

Range: N/A

error_msg

String

Definition: Error message.

Range: N/A

Example Requests

Query resource information in the order details.

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

Example Responses

Status code: 200

Default Value: N/A

{
  "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
  } ]
}

Status code: 400

Bad request.

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

Status code: 404

Not found.

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

Status Codes

Status Code

Description

200

Default Value: N/A

400

Bad request.

404

Not found.

Error Codes

See Error Codes.

Parent topic: Order Management