说明:当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (ModifyInstanceAttributes) 用于修改实例的属性(目前只支持实例名称的修改)。
接口请求域名:cvm.api.qcloud.com
- “实例名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行实例管理操作的依据。
- 本接口仅支持单个实例的修改。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
instanceId | 是 | String | 待操作的实例ID。可通过 DescribeInstances API返回值中的 unInstanceId 获取。 |
instanceName | 是 | String | 实例名称,可任意命名,但不得超过60个字符。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码。0表示成功,其他值表示失败。 |
message | String | 模块错误信息描述,与接口相关。 |
4. 错误码
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见CVM错误码页面。
错误码 | 描述 |
---|---|
OperationConstraints.InvaildInstanceStatus | 实例状态不正确或获取实例状态失败(EC_CVM_STATUS_ERROR) |
5. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=ModifyInstanceAttributes &instanceId=ins-12345678 &instancesName=Tencent &<公共请求参数>
输出
{
"code" : 0,
"message" : "ok"
}