Help Center/ Workspace/ API Reference/ Workspace APIs/ Product Packages/ Querying the Collaboration Package List

Updated on 2025-07-14 GMT+08:00

View PDF

Querying the Collaboration Package List

Function

This interface is used to query the collaboration package list.

Debugging

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

URI

GET /v2/{project_id}/products/sharer

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
product_id	No	String	Product ID.
share_space_size	No	String	Number of collaboration parties. Maximum number of collaborative users supported by a package.
charge_mode	No	String	ID of a periodic package. 0 indicates yearly/monthly billing, 1 indicates pay-per-use billing, and 6 indicates one-off billing.
is_gpu	No	Integer	Whether the package is a GPU package. 1 indicates a GPU package, and 0 indicates a non-GPU package. The default value is null, indicating that all types are queried.
package_type	No	String	Package series. user_sharer indicates a user collaboration package, and desktop_sharer indicates a desktop collaboration package.
limit	No	Integer	Number of records on each page. The value ranges from 0 to 100 and defaults to 100.
offset	No	Integer	Offset. The default value is 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
products	Array of SharerProductInfo objects	Product list.
total_count	Integer	Number of objects.

**Table 5** SharerProductInfo
Parameter	Type	Description
product_id	String	Product ID.
is_gpu	Boolean	Whether the specifications are of the GPU type.
descriptions	String	Product description.
charge_mode	String	ID of a periodic package. 0 indicates yearly/monthly billing, 1 indicates pay-per-use billing, and 6 indicates one-off billing.
resource_type	String	Resource flavor.
cloud_service_type	String	Cloud service code
package_type	String	Package type. user_sharer: user-based collaborative package desktop_sharer: desktop collaboration package
name	Map<String,String>	Product name.
share_space_size	Integer	Number of collaboration parties. Maximum number of collaborative users supported by a package.

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.

Example Requests

None

Example Responses

Status code: 200

Response for querying the collaboration package list.

{
  "total_count" : 2,
  "products" : [ {
    "product_id" : "workspace.collaborativedesktop.6party.standard",
    "descriptions" : "Collaboration resource | 6 participants | Standard edition",
    "resource_type" : "hws.resource.type.collaborativedesktop",
    "cloud_service_type" : "hws.service.type.vdi",
    "package_type" : "desktop_sharer",
    "share_space_size" : "6",
    "charge_mode" : "0",
    "is_gpu" : true
  }, {
    "product_id" : "workspace.collaborativedesktop.collabpartsubusers.1",
    "descriptions" : "Subscription by collaboration participants | 1 user",
    "resource_type" : "hws.resource.type.collaborativedesktop",
    "cloud_service_type" : "hws.service.type.vdi",
    "package_type" : "user_sharer",
    "charge_mode" : "6"
  } ]
}

Status Codes

Status Code	Description
200	Response for querying the collaboration package list.
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.