Querying the Collaboration Package List
Function
This interface is used to query the collaboration package list.
Request 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
Parameter |
Type |
Description |
---|---|---|
products |
Array of SharerProductInfo objects |
Product list. |
total_count |
Integer |
Number of objects. |
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.
|
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
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
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
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
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
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
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
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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot