
# 更新桌面名称策略 - UpdateDesktopNamePolicy
#### 功能介绍
更新桌面名称策略，用于自动生成桌面名称。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=UpdateDesktopNamePolicy)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                       | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:tenants:updateDesktopNamePolicy | Write | -           | -   | -  | -      |
     
  
 
#### URI
PUT /v2/{project_id}/desktop-name-policies/{policy_id}
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
| policy_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默认策略。                                                                                                                                                                                                                                                                                                                                                                                                                |
| prefix_truncation_enabled | 否    | Boolean | 当名称前缀加数字长度生成的桌面名称长度超15位时，是否截断名称前缀部分。                                                                                                                                                                                                                                                                                                                                                                                             |
   
#### 响应参数
**状态码：204**
更新桌面名称策略正常响应。
**状态码：400**
表3响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：401**
表4响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：403**
表5响应Body参数 
| 参数                            | 参数类型   | 描述                                                           |
|:---|:---|:---|
| error_code                    | String | 错误码，失败时返回。                                                   |
| error_msg                     | String | 错误描述。                                                        |
| error_detail                  | String | 错误详情。                                                        |
| encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
   
**状态码：500**
表6响应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
}
```
#### 响应示例
**状态码：204**
更新桌面名称策略正常响应。
```
null
```
#### 状态码
| 状态码 | 描述                     |
|:---|:---|
| 204 | 更新桌面名称策略正常响应。          |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。 |
| 401 | 鉴权失败。                  |
| 403 | 没有操作权限。                |
| 500 | 服务器内部错误。               |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。
