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

创建桌面名称策略 - CreateDesktopNamePolicy

功能介绍

创建桌面名称策略，用于自动生成桌面名称。

调试

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

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

policy_name

是

String

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

name_prefix

是

String

策略前缀。

digit_number

是

Integer

策略后缀有效位数。

start_number

是

Integer

策略后缀起始数字。

single_domain_user_inc

是

Integer

是否单用户名递增。

  • 1 单用户名递增。

  • 0 租户递增。

is_default_policy

否

Boolean

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

policy_id

String

策略id。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

{
  "policy_name" : "MyPolicy",
  "name_prefix" : "abc$DomainUser$12",
  "digit_number" : 2,
  "start_number" : 1,
  "single_domain_user_inc" : 1,
  "is_default_policy" : false
}

响应示例

状态码：200

创建桌面名称策略响应。

{
  "policy_id" : "string"
}

状态码

状态码

描述

200

创建桌面名称策略响应。

400

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

401

鉴权失败。

403

没有操作权限。

500

服务器内部错误。

错误码

请参见错误码。

父主题：桌面名称策略