说明:
当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (ModifyInstancesAttribute) 用于修改实例的属性(目前只支持修改实例的名称)。
接口请求域名:cvm.api.qcloud.com
- “实例名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行实例管理操作的依据。
- 支持批量操作。每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例,操作会以特定错误码返回。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Version | String | 是 | 表示API版本号,主要用于标识请求的不同API版本。 本接口第一版本可传:2017-03-12。 |
InstanceIds.N | String | 是 | 一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId 获取。每次请求允许操作的实例数量上限是100。 |
InstanceName | String | 是 | 实例显示名称。可任意命名,但不得超过60个字符。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求ID。每次请求都会返回RequestId 。当用户调用接口失败找后台研发人员处理时需提供该RequestId 。 |
4. 错误码
以下错误码表仅列出了该接口的业务逻辑错误码,更多错误码详见公共错误码。
错误码 | 描述 |
---|---|
MissingParameter | 参数缺失。请求没有带必选参数。 |
InvalidInstanceId.NotFound | 无效实例ID 。指定的实例ID 不存在。 |
InvalidInstanceId.Malformed | 无效实例ID 。指定的实例ID 格式错误。例如ID 长度错误ins-1122 。 |
InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |
InvalidInstanceName.TooLong | 无效实例名称。实例名称长度超过限制。 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
InvalidInstance.NotSupported | 实例不支持该操作。 |
InternalServerError | 内部服务错误。 |
5. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=ModifyInstancesAttribute &Version=2017-03-12 &InstanceIds.1=ins-r8hr2upy &InstanceIds.2=ins-5d8a23rs &InstanceName=Mysql_Server &<公共请求参数>
输出
{ "Response": { "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7" } }