Policy for Obtaining Desktop Names
Function
Policy for obtaining desktop names, which is used to automatically generate desktop names.
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}/desktop-name-policies
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
is_contain_user |
No |
Boolean |
Specifies whether the desktop name policy contains the username. |
policy_name |
No |
String |
Policy name. The value is a string of 1 to 30 characters, including digits, letters, and underscores (). It must start with a letter or underscore (). Fuzzy filtering is supported. |
policy_id |
No |
String |
Specifies the policy ID. |
offset |
No |
Integer |
Start position for pagination query. The value starts from 0. |
limit |
No |
Integer |
This parameter is used for pagination query. The value ranges from 0 to 50, and the default value is 50. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
desktop_name_policy_infos |
Array of DesktopNamePolicyInfo objects |
Desktop name policy information. |
total_count |
Integer |
Total number of returned records. |
Parameter |
Type |
Description |
---|---|---|
policy_id |
String |
Policy ID. |
policy_name |
String |
Policy name. |
name_prefix |
String |
Policy prefix. |
digit_number |
Integer |
Number of valid digits in the policy suffix. |
start_number |
Integer |
Start number of the policy suffix. |
single_domain_user_inc |
Integer |
Indicates whether the user name increases in ascending order. - The user name increases in ascending order. - The value 0 indicates that the number of tenants increases. |
is_default_policy |
Boolean |
Indicates whether the policy is the default policy. The value true indicates the default policy. |
is_contain_user |
Boolean |
Specifies whether the desktop name policy of the username is included. The value true indicates that the desktop name policy is included. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, which is returned upon failure. |
error_msg |
String |
Error description. |
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
None
Example Responses
Status code: 200
Response to the request for obtaining the desktop name policy.
{ "desktop_name_policy_infos" : [ { "policy_id" : "string", "policy_name" : "string", "name_prefix" : "string", "digit_number" : 0, "start_number" : 0, "single_domain_user_inc" : 0, "is_default_policy" : false, "is_contain_user" : false } ], "total_count" : 0 }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for obtaining the desktop name policy. |
400 |
The request cannot be understood by the server due to malformed syntax. |
401 |
Authentication failed. |
403 |
No operation permission. |
500 |
Internal Server Error |
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