文档首页/云桌面 Workspace/API参考/云桌面API/桌面名称策略/获取桌面名称策略 - ListDesktopNamePolicy
更新时间：2026-03-17 GMT+08:00
查看PDF
分享

获取桌面名称策略 - ListDesktopNamePolicy

功能介绍

获取桌面名称策略，用于自动生成桌面名称。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

is_contain_user

否

Boolean

是否包含用户名的桌面名称策略。

  • true 包含

  • false 不包含

policy_name

否

String

策略名称，由数字、字母、中文、下划线组成，必须以字母或下划线开头，长度范围为1~30个字符，支持模糊筛选。

policy_id

否

String

策略id。

offset

否

Integer

用于分页查询，查询的起始记录序号，从0开始。

limit

否

Integer

用于分页查询，取值范围0-100，默认值100。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

desktop_name_policy_infos

Array of DesktopNamePolicyInfo objects

桌面名称策略信息。

total_count

Integer

查询返回总条数。

表4 DesktopNamePolicyInfo

参数

参数类型

描述

policy_id

String

策略id。

policy_name

String

策略名称。

name_prefix

String

策略前缀。

digit_number

Integer

策略后缀有效位数。

start_number

Integer

策略后缀起始数字。

single_domain_user_inc

Integer

是否单用户名递增。

  • 1 单用户名递增。

  • 0 租户递增。

is_default_policy

Boolean

是否为默认策略，true默认策略。

is_contain_user

Boolean

是否包含用户名的桌面名称策略，true包含。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

无

响应示例

状态码：200

获取桌面名称策略响应。

{
  "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
}

状态码

状态码

描述

200

获取桌面名称策略响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

500

服务器内部错误。

错误码

请参见错误码。

父主题：桌面名称策略