操作指南

最佳实践

故障处理

API 文档

参与文档共建赢好礼> HOT

修改实例的属性

最近更新时间:2022-06-21 06:05:17

我的收藏

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (ModifyInstancesAttribute) 用于修改实例的属性(目前只支持修改实例的名称和关联的安全组)。

  • 每次请求必须指定实例的一种属性用于修改。
  • “实例名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为在线支持或是进行实例管理操作的依据。
  • 支持批量操作。每次请求批量实例的上限为100。
  • 修改关联安全组时,子机原来关联的安全组会被解绑。
  • 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyInstancesAttribute。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。
InstanceName String 实例名称。可任意命名,但不得超过60个字符。
说明

必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置

SecurityGroups.N Array of String 指定实例的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。
说明

必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置

CamRoleName String 给实例绑定用户角色,传空值为解绑操作
DisableApiTermination Boolean 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:
  • TRUE:表示开启实例保护,不允许通过api接口删除实例
  • FALSE:表示关闭实例保护,允许通过api接口删除实例

    默认取值:FALSE。
  • CamRoleType String 角色类别,与CamRoleName搭配使用,该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取,当前只接受user、system和service_linked三种类别。
    举例:一般CamRoleName中包含“LinkedRoleIn”(如TKE_QCSLinkedRoleInPrometheusService)时,DescribeRoleList和GetRole返回的RoleType为service_linked,则本参数也需要传递service_linked。
    该参数默认值为user,若CameRoleName为非service_linked类型,本参数可不传递。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 修改实例名称

    本示例用于修改两个实例的名称。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=ModifyInstancesAttribute
    &InstanceIds.0=ins-r8hr2upy
    &InstanceIds.1=ins-5d8a23rs
    &InstanceName=Mysql_Server
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    AuthFailure.CamRoleNameAuthenticateFailed 角色名鉴权失败
    FailedOperation.SecurityGroupActionFailed 安全组操作失败。
    InternalServerError 操作内部错误。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidInstanceName.TooLong 指定的InstanceName字符串长度超出限制,必须小于等于60字节。
    InvalidParameter.HostNameIllegal 指定的hostName不符合规范。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.CamRoleNameMalformed CamRoleName不合要求,只允许包含英文字母、数字或者 +=,.@_- 字符。
    InvalidParameterValue.InvalidUserDataFormat UserData格式错误, 需要base64编码格式
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidSecurityGroupId.NotFound 指定的安全组ID不存在。
    LimitExceeded.AssociateUSGLimitExceeded 一个实例绑定安全组数量不能超过5个
    LimitExceeded.CvmsVifsPerSecGroupLimitExceeded 安全组关联云主机弹性网卡配额超限。
    LimitExceeded.SingleUSGQuota 安全组限额不足
    MissingParameter 缺少参数错误。
    MutexOperation.TaskRunning 同样的任务正在运行。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    UnauthorizedOperation.MFANotFound 没有权限进行此操作,请确认是否存在多因子认证(MFA)。
    UnsupportedOperation.InstanceStateEnterRescueMode 请求不支持进入救援模式的实例
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate 不支持状态为 ENTER_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
    UnsupportedOperation.InstanceStateExitServiceLiveMigrate 不支持状态为 EXIT_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
    UnsupportedOperation.InstanceStateFreezing 操作不支持已冻结的实例。
    UnsupportedOperation.InstanceStateIsolating 请求不支持正在隔离状态的实例。
    UnsupportedOperation.InstanceStatePending 请求不支持创建未完成的实例
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateRescueMode 请求不支持救援模式的实例
    UnsupportedOperation.InstanceStateServiceLiveMigrate 不支持正在服务迁移的实例,请稍后再试
    UnsupportedOperation.InstanceStateShutdown 请求不支持隔离状态的实例
    UnsupportedOperation.InstanceStateStarting 实例开机中,不允许该操作。
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminated 不支持已销毁的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.InvalidInstanceNotSupportedProtectedInstance 不支持已经设置了释放时间的实例,请在实例详情页撤销实例定时销毁后再试。
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性
    目录