1. 接口描述
接口请求域名: cvm.api3.gsesgpucloud.com。
本接口 (ModifyInstancesAttribute) 用于修改实例的属性(目前只支持修改实例的名称)。
- “实例名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行实例管理操作的依据。
 - 支持批量操作。每次请求批量实例的上限为100。
 
默认接口请求频率限制:10次/秒。
接口更新时间:2020-05-18 12:12:48。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 | 
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:ModifyInstancesAttribute | 
| Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 | 
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 | 
| InstanceIds | 是 | 否 | Array of String | 一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。示例值: ["ins-rf6ogz49"]  | 
| InstanceName | 否 | 否 | String | 实例显示名称。可任意命名,但不得超过60个字符。 示例值: MyInsName  | 
| UserData | 否 | 否 | String | 内部参数,用户数据。 示例值: TXlVc2VyRGF0YQo  | 
| SecurityGroups | 否 | 否 | Array of String | 内部参数,安全组Id列表。 示例值: ["sg-rf6ogz49"]  | 
| ResetNewCreationIdentify | 否 | 否 | Bool | 内部参数,未知。 示例值: false  | 
| DisableApiTermination | 否 | 否 | Bool | 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围: 默认取值:FALSE。 示例值: false  | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 | 
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 | 
|---|---|
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 | 
| InternalServerError | 操作内部错误。 | 
| InvalidInstanceName.TooLong | 指定的InstanceName字符串长度超出限制,必须小于等于60字节。 | 
| InvalidInstance.NotSupported | 不被支持的实例。 | 
| InvalidInstanceId.NotFound | 没有找到相应实例。 | 
| MissingParameter | 参数缺失。请求没有带必选参数。 | 
| InvalidInstanceId.Malformed | 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122。 | 
| InvalidParameterValue | 无效参数值。参数值格式错误或者参数值不被支持等。 |