接口功能介绍
修改云电脑别名
接口约束
无
URI
POST /v3/desktop/modifyNickname
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| desktopOid | 是 | String | 云电脑ID | D0023101301183998 | |
| nickname | 是 | String | 别名（最大长度20，只能包含数字、字母、汉字） | xiemushuapi |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ||
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据结构体。 | { } | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"desktopOid":"XXXXXXXXXXXXX6925","nickname":"foo-update-3I8SiEaM"}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码
