操作指南

最佳实践

运维指南

API 文档

修改实例vpc属性

最近更新时间:2020-08-04 08:09:11

1. 接口描述

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

本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性,如私有网络ip。

  • 此操作默认会关闭实例,完成后再启动。
  • 当指定私有网络ID和子网ID(子网必须在实例所在的可用区)与指定实例所在私有网络不一致时,会将实例迁移至指定的私有网络的子网下。执行此操作前请确保指定的实例上没有绑定弹性网卡负载均衡
  • 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyInstancesVpcAttribute。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 待操作的实例ID数组。可通过DescribeInstances接口返回值中的InstanceId获取。
VirtualPrivateCloud VirtualPrivateCloud 私有网络相关信息配置,通过该参数指定私有网络的ID,子网ID,私有网络ip等信息。
  • 当指定私有网络ID和子网ID(子网必须在实例所在的可用区)与指定实例所在私有网络不一致时,会将实例迁移至指定的私有网络的子网下。
  • 可通过PrivateIpAddresses指定私有网络子网IP,若需指定则所有已指定的实例均需要指定子网IP,此时InstanceIdsPrivateIpAddresses一一对应。
  • 不指定PrivateIpAddresses时随机分配私有网络子网IP。
  • ForceStop Boolean 是否对运行中的实例选择强制关机。默认为TRUE。
    ReserveHostName Boolean 是否保留主机名。默认为FALSE。

    3. 输出参数

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

    4. 示例

    示例1 迁移实例私有网络且指定子网IP

    实例 r8hr2upy 和 5d8a23rs 迁移至私有网络 1urkhbj4 子网 dcs9x3gz 中,指定实例 r8hr2upy 的私有网络IP为 10.0.0.18,实例 5d8a23rs 的私有网络IP为 10.0.0.19。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=ModifyInstancesVpcAttribute
    &InstanceIds.0=ins-r8hr2upy
    &InstanceIds.1=ins-5d8a23rs
    &VirtualPrivateCloud.SubnetId=subnet-dcs9x3gz
    &VirtualPrivateCloud.VpcId=vpc-1urkhbj4
    &VirtualPrivateCloud.PrivateIpAddresses.0=10.0.0.18
    &VirtualPrivateCloud.PrivateIpAddresses.1=10.0.0.19
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "3c14def19-cfes-470e-b241-90787u6jf5uj"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    EniNotAllowedChangeSubnet 弹性网卡不允许跨子网操作。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceState 指定实例的当前状态不能进行该操作。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试
    UnauthorizedOperation.MFAExpired 您无法进行当前操作,请确认多因子认证(MFA)是否失效
    UnauthorizedOperation.MFANotFound 没有权限进行此操作,请确认是否存在多因子认证(MFA)
    VpcAddrNotInSubNet 私有网络ip不在子网内。
    VpcIpIsUsed 私有网络ip已经被使用。
    目录