Help Center/ Workspace/ API Reference/ Workspace APIs/ Order/ Creating a Resource Package Order

Updated on 2026-02-10 GMT+08:00

View PDF

Creating a Resource Package Order

Function

Creates a resource package order.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:orders:createResourcePackagesOrder	Write	-	-	-	-

URI

POST /v2/{project_id}/resource-packages/order

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. If this parameter is specified, the enterprise project is specified. If this parameter is not specified, all enterprise projects are applied.
resource_packages	Yes	Array of DesktopResourcePackage objects	Resource package.
resource_size	No	Integer	Quantity of purchased resource packages.
extend_param	No	OrderExtendParam object	Extended parameter of the order.

**Table 3** DesktopResourcePackage
Parameter	Mandatory	Type	Description
resource_package_name	Yes	String	Name of the resource package.
desktop_resource_spec_code	Yes	String	Product code of the desktop.
resource_spec_code	Yes	String	Product code of the resource package.
effective_time	No	String	Effective time. The format is yyyy-MM-ddTHH:mm:ssZ (2025-04-12T17:30:00Z).
is_auto_renew	No	Integer	Indicates whether auto-renewal is enabled.

**Table 4** OrderExtendParam
Parameter	Mandatory	Type	Description
is_auto_pay	No	String	Whether to automatically pay. true: yes; false (default value): no

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
order_id	String	Order ID, which is returned when an order is successfully placed.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 409

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

{
  "enterprise_project_id" : "string",
  "resource_packages" : [ {
    "resource_package_name" : "string",
    "desktop_resource_spec_code" : "string",
    "resource_spec_code" : "string"
  } ],
  "extend_param" : {
    "is_auto_pay" : "string"
  }
}

Example Responses

Status code: 200

Response body for placing an order.

{
  "order_id" : "string"
}

Status Codes

Status Code	Description
200	Response body for placing an order.
400	The request cannot be understood by the server due to malformed syntax.
409	Operation conflict.
500	Internal server error.