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.

Authorization Information

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:tenants:listDesktopNamePolicies	List	-	-	-	-

URI

GET /v2/{project_id}/desktop-name-policies

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
is_contain_user	No	Boolean	Specifies whether the desktop name policy contains the username. true: yes false: no
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	Pagination query. The value ranges from 0 to 100 and defaults to 100.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
desktop_name_policy_infos	Array of DesktopNamePolicyInfo objects	Desktop name policy information.
total_count	Integer	Total number of returned records.

**Table 4** DesktopNamePolicyInfo
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 value 1 indicates that 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

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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