云服务器修改
云服务器修改
1. 描述
修改云服务器名称和备注信息。
2. 请求地址
请求地址的格式如下：
https://<区域服务地址>/v1/vm/update
3. 请求参数
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| projectId | String | 是 | 所属项目ID |
| id | String | 是 | 主机ID |
| name | String | 是 | 主机名称 |
| desc | String | 否 | 主机备注信息 |
4. 请求示例
4.1. 请求地址
POST https://cn-east-1.api.yovole.com/v1/vm/update HTTP/1.1
x-ycs-timestamp: 2019-06-19T14:26:26Z
x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=
4.2. 接口请求参数
{
"projectId":"8a83a0966a681da5016a874df50b10ce",
"id":"f75d31d7-f624-44ab-b334-814f23a624d4",
"name":"主机新的名称",
"desc":"主机备注信息"
}
5. 返回结果
5.1. 返回正确结果示例
{
"requestId": "2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9",
"success": true,
"code": 200,
"message": null,
"model": null
}
5.2. 返回错误结果示例
{
"requestId": "2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9",
"success": false,
"code": 400,
"message": "Required attribute 'projectId' not specified",
"errorCode": "Invalid argument"
}
6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码，错误码信息和简单的错误分析方法可以参考公共错误码。