获取桌面名称策略
功能介绍
获取桌面名称策略，用于自动生成桌面名称。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/desktop-name-policies
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_contain_user |
否 |
Boolean |
是否包含用户名的桌面名称策略。
|
|
policy_name |
否 |
String |
策略名称，由数字、字母、中文、下划线组成，必须以字母或下划线开头，长度范围为1~30个字符，支持模糊筛选。 |
|
policy_id |
否 |
String |
策略id。 |
|
offset |
否 |
Integer |
用于分页查询，查询的起始记录序号，从0开始。 |
|
limit |
否 |
Integer |
用于分页查询，取值范围0-50，默认值50。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
desktop_name_policy_infos |
Array of DesktopNamePolicyInfo objects |
桌面名称策略信息。 |
|
total_count |
Integer |
查询返回总条数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
policy_id |
String |
策略id。 |
|
policy_name |
String |
策略名称。 |
|
name_prefix |
String |
策略前缀。 |
|
digit_number |
Integer |
策略后缀有效位数。 |
|
start_number |
Integer |
策略后缀起始数字。 |
|
single_domain_user_inc |
Integer |
是否单用户名递增。
|
|
is_default_policy |
Boolean |
是否为默认策略，true默认策略。 |
|
is_contain_user |
Boolean |
是否包含用户名的桌面名称策略，true包含。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取桌面名称策略响应。 |
|
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
500 |
服务器内部错误。 |
错误码
请参见错误码。
