Help Center/ Workspace/ API Reference/ Workspace APIs/ Product Packages/ Listing Pay-per-Use Resource Packages

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

View PDF

Listing Pay-per-Use Resource Packages

Lists pay-per-use resource packages.

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

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:products:listResourcePackages	Read	-	-	-	-

GET /v2/{project_id}/products/resource-packages

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
resource_spec_code	No	String	Specification code of resources in the resource package.

None

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
desktop_resource_packages	Array of DesktopResourcePackage objects	Resource package list.
total_count	Integer	Total number.

**Table 4** DesktopResourcePackage
Parameter	Type	Description
cloud_service_type	String	Cloud service type.
resource_type	String	Resource type.
resource_spec_code	String	Resource specification code.
package_type	String	Specifications.
cpu	String	CPU.
architecture	String	Product architecture, Arm or x86.
memory	String	Memory.
domain_ids	Array of strings	ID of the dedicated domain (domainId) supported by the product package.
name	Map<String,String>	Product name <Language. Product description in each supported language>.
description	Map<String,String>	Product description <Language. The product name in each language>.
resource_packages	Array of ResourcePackage objects	List of pay-per-use package specifications.

**Table 5** ResourcePackage
Parameter	Type	Description
resource_spec_code	String	Resource specification code.
description	Map<String,String>	Product description <Language. The product name in each language>.
status	String	Product status. The options are normal/onSell, sellout, and abandon.
period_type	String	Term type. The value is MONTH.
period_value	Integer	Quantity, in months.
measurement_name	String	Resource package unit. The value is hour.
threshold	Integer	Total number of hours available in resource packages.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
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: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

None

None

Status Code	Description
200	Response to the request for querying products.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	Service unavailable.