Updating the Desktop Name Policy
Function
Update the desktop name policy 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
PUT /v2/{project_id}/desktop-name-policies/{policy_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
policy_id |
Yes |
String |
Policy ID. |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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 (). |
name_prefix |
No |
String |
Policy prefix. |
digit_number |
No |
Integer |
Number of valid digits in the policy suffix. |
start_number |
No |
Integer |
Start number of the policy suffix. |
single_domain_user_inc |
No |
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 |
No |
Boolean |
Indicates whether the policy is the default policy. The value true indicates the default policy. |
Response Parameters
Status code: 204
Normal response to the request for updating the desktop name policy.
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
{ "policy_name" : "MyPolicy", "name_prefix" : "abc$DomainUser$12", "digit_number" : 2, "start_number" : 1, "single_domain_user_inc" : 1, "is_default_policy" : false }
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
204 |
Normal response to the request for updating 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