{ "name": "cvm", "display_name": "云服务器", "description": "介绍如何使用API对云服务器进行操作，包括使用并管理实例、镜像、密钥等资源。", "domain": "compute", "api_version": "2017-03-12", "endpoint": "cvm.tencentcloudapi.com", "actions": [ { "name": "AllocateHosts", "description": "本接口 (AllocateHosts) 用于创建一个或多个指定配置的CDH实例。 * 当HostChargeType为PREPAID时，必须指定HostChargePrepaid参数。", "status": "online", "parameters": [ { "name": "Placement", "type": "object", "required": true, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-4" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 `ProjectId` 字段来获取。默认取值0，表示默认项目。", "example": "0" }, { "name": "HostIds", "type": "array", "required": false, "description": "实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 的返回值中的 `HostId` 字段来获取。", "example": "[\"host-o5i742go\"]", "item_type": "string" }, { "name": "HostId", "type": "string", "required": false, "description": "实例所属的专用宿主机ID，仅用于出参。", "example": "host-o5i742go" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。", "example": "a521b4e4-c903-4d37-9de6-8606e3ad8eb7" }, { "name": "HostChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "HostChargeType", "type": "string", "required": false, "description": "实例计费类型。目前仅支持：PREPAID（预付费，即包年包月模式），默认为：'PREPAID'。", "example": "PREPAID" }, { "name": "HostType", "type": "string", "required": false, "description": "CDH实例机型，默认为：'HS1'。", "example": "HS1" }, { "name": "HostCount", "type": "integer", "required": false, "description": "购买CDH实例数量，默认为：1。", "example": "1" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] } ], "required": [ "Placement" ] }, { "name": "AssociateInstancesKeyPairs", "description": "本接口 (AssociateInstancesKeyPairs) 用于将密钥绑定到实例上。 * 仅支持对 `Linux` 操作系统实例进行绑定操作。 * 非强制关机场景下，仅支持对 [STOPPED](https://cloud.tencent.com/document/product/213/15753#InstanceStatus) 状态实例进行绑定操作。 * 强制关机场景下，先执行强制关机，再绑定密钥；如实例原状态为 [RUNNING](https://cloud.tencent.com/document/product/213/15753#InstanceStatus)，绑定完成后实例会自动开\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID，每次请求批量实例的上限为100。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的`InstanceId`获取实例ID。", "example": "[\"ins-1e4r6y8i\",\"ins-3e56fg78\"]", "item_type": "string" }, { "name": "KeyIds", "type": "array", "required": true, "description": "一个或多个待操作的密钥对ID，每次请求批量密钥对的上限为100。可以通过以下方式获取可用的密钥ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/sshkey)查询密钥ID。 通过调用接口 [DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699) ，取返回信息中的`KeyId`获取密钥对ID。", "example": "[\"skey-4e5ty7i8\"]", "item_type": "string" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否强制关机，默认值为 false。常规场景下，建议手动关机后绑定密钥。取值范围： true：先执行强制关机，再绑定密钥。 false：不执行强制关机，仅支持对已关机状态实例进行绑定操作。", "example": "false" } ], "required": [ "InstanceIds", "KeyIds" ] }, { "name": "AssociateSecurityGroups", "description": "本接口 (AssociateSecurityGroups) 用于绑定安全组到指定实例。 * 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。 多个安全组绑定至实例后，将以绑定顺序作为优先级顺序依次...", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要绑定的`安全组ID`，类似sg-efil73jd，只支持绑定单个安全组。可通过 [DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808) 接口返回值中的`SecurityGroupId`获取。", "example": "[\"sg-9id3l839\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "被绑定的`实例ID`，类似ins-lesecurk，支持指定多个实例，每次请求批量实例的上限为100。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "[\"ins-2zvpghhc\",\"ins-915zrb0p\"]", "item_type": "string" } ], "required": [ "SecurityGroupIds", "InstanceIds" ] }, { "name": "ConfigureChcAssistVpc", "description": "配置CHC物理服务器的带外和部署网络。传入带外网络和部署网络信息", "status": "online", "parameters": [ { "name": "ChcIds", "type": "array", "required": true, "description": "CHC物理服务器的实例Id。", "example": "[\"chc-123a4d5f\"]", "item_type": "string" }, { "name": "BmcVirtualPrivateCloud", "type": "object", "required": true, "description": "带外网络信息。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "BmcSecurityGroupIds", "type": "array", "required": false, "description": "带外网络的安全组列表", "example": "[\"sg-asda324a\"]", "item_type": "string" }, { "name": "DeployVirtualPrivateCloud", "type": "object", "required": false, "description": "部署网络信息。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "DeploySecurityGroupIds", "type": "array", "required": false, "description": "部署网络的安全组列表", "example": "[\"sg-asda324a\"]", "item_type": "string" }, { "name": "ChcDeployExtraConfig", "type": "object", "required": false, "description": "部署网络的附加参数，用于指定minios类型、bios引导模式等", "example": "无", "children": [ { "name": "MiniOsType", "type": "string", "required": true, "description": "minos类型。是使用腾讯云的minios，还是客户自己的minios。", "example": "public" }, { "name": "BootType", "type": "string", "required": true, "description": "服务器的架构和启动方式。取值为x86_legacy, arm_uefi。", "example": "x86_legacy" }, { "name": "BootFile", "type": "string", "required": false, "description": "PXE使用的引导文件。默认为pxelinux.0。", "example": "pxelinux.0" }, { "name": "NextServerAddress", "type": "string", "required": false, "description": "tftp服务器的ip地址。", "example": "169.254.68.10" } ] } ], "required": [ "ChcIds", "BmcVirtualPrivateCloud" ] }, { "name": "ConfigureChcDeployVpc", "description": "配置CHC物理服务器部署网络", "status": "online", "parameters": [ { "name": "ChcIds", "type": "array", "required": true, "description": "CHC物理服务器的实例Id。", "example": "[\"chc-123a4d5f\"]", "item_type": "string" }, { "name": "DeployVirtualPrivateCloud", "type": "object", "required": true, "description": "部署网络信息。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "DeploySecurityGroupIds", "type": "array", "required": false, "description": "部署网络的安全组列表。", "example": "[\"sg-asda324a\"]", "item_type": "string" }, { "name": "ChcDeployExtraConfig", "type": "object", "required": false, "description": "部署所需要的dhcp选项参数", "example": "无", "children": [ { "name": "MiniOsType", "type": "string", "required": true, "description": "minos类型。是使用腾讯云的minios，还是客户自己的minios。", "example": "public" }, { "name": "BootType", "type": "string", "required": true, "description": "服务器的架构和启动方式。取值为x86_legacy, arm_uefi。", "example": "x86_legacy" }, { "name": "BootFile", "type": "string", "required": false, "description": "PXE使用的引导文件。默认为pxelinux.0。", "example": "pxelinux.0" }, { "name": "NextServerAddress", "type": "string", "required": false, "description": "tftp服务器的ip地址。", "example": "169.254.68.10" } ] } ], "required": [ "ChcIds", "DeployVirtualPrivateCloud" ] }, { "name": "ConvertOperatingSystems", "description": "本接口(ConvertOperatingSystems)用于转换实例的操作系统，仅支持源操作系统为 CentOS 7、CentOS 8 的实例。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "执行操作系统转换的实例 ID。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。 仅支持操作系统为 CentOS 7、CentOS 8 的实例执行转换。", "example": "[\"ins-duqhvpt6\"]", "item_type": "string" }, { "name": "MinimalConversion", "type": "boolean", "required": false, "description": "是否最小规模转换。 默认值：false", "example": "false" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检。 默认值：false", "example": "false" }, { "name": "TargetOSType", "type": "string", "required": false, "description": "转换的目标操作系统类型。仅支持 TencentOS。 默认值：TencentOS", "example": "TencentOS" } ], "required": [ "InstanceIds" ] }, { "name": "CreateDisasterRecoverGroup", "description": "本接口 (CreateDisasterRecoverGroup)用于创建[分散置放群组](https://cloud.tencent.com/document/product/213/15486)。创建好的置放群组，可在[创建实例](https://cloud.tencent.com/document/api/213/15730)时指定。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "分散置放群组名称，长度1-60个字符，支持中、英文。", "example": "物理机容灾组" }, { "name": "Type", "type": "string", "required": true, "description": "分散置放群组类型，取值范围：HOST：物理机SW：交换机RACK：机架", "example": "HOST" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。更多详细信息请参阅：如何保证幂等性。", "example": "a521b4e4-c903-4d37-9de6-8906e3ad8eb7" }, { "name": "Affinity", "type": "integer", "required": false, "description": "置放群组的亲和度，在置放群组的实例会按该亲和度分布，亲和度的取值范围是：1-10，默认为1", "example": "3" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以绑定标签到置放群组。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] } ], "required": [ "Name", "Type" ] }, { "name": "CreateHpcCluster", "description": "创建高性能计算集群", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区信息。可用区信息可通过 [查询可用区信息](https://cloud.tencent.com/document/api/213/15707) 接口获取。", "example": "ap-guangzhou-2" }, { "name": "Name", "type": "string", "required": true, "description": "高性能计算集群名称，长度限制[1-60]。", "example": "MyHpcCluster" }, { "name": "Remark", "type": "string", "required": false, "description": "高性能计算集群备注，长度[1-256]。", "example": "备注" }, { "name": "HpcClusterType", "type": "string", "required": false, "description": "高性能计算集群类型，当前有三个取值：分别是CDC/CHC/STANDARD，其中STANDARD是默认的标准模式。", "example": "CDC/CHC/STANDARD" }, { "name": "HpcClusterBusinessId", "type": "string", "required": false, "description": "高性能计算集群对应的业务场景标识，当前只支持CDC场景类型。", "example": "例如cdc场景：cluster-iu5gustw，其他场景暂不支持。" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到相应的HPC高性能集群。集群信息可通过 [查询高性能集群信息](https://cloud.tencent.com/document/api/213/83220) 接口获取。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] } ], "required": [ "Zone", "Name" ] }, { "name": "CreateImage", "description": "本接口(CreateImage)用于将实例的系统盘制作为新镜像，创建后的镜像可以用于创建实例。", "status": "online", "parameters": [ { "name": "ImageName", "type": "string", "required": true, "description": "镜像名称。 最多支持60个字符。", "example": "MyImageName" }, { "name": "InstanceId", "type": "string", "required": false, "description": "需要制作镜像的实例ID。基于实例创建镜像时，为必填参数。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "ins-2v3sqe2t" }, { "name": "ImageDescription", "type": "string", "required": false, "description": "镜像描述。 最多支持 256 个字符。", "example": "MyImageDescription" }, { "name": "ForcePoweroff", "type": "string", "required": false, "description": "是否执行强制关机以制作镜像。 取值范围：true：表示关机之后制作镜像false：表示开机状态制作镜像默认取值：false。开机状态制作镜像，可能导致部分数据未备份，影响数据安全。", "example": "true" }, { "name": "Sysprep", "type": "string", "required": false, "description": "创建Windows镜像时是否启用Sysprep。 取值范围：true或false，传true表示启用Sysprep，传false表示不启用，默认取值为false。 关于Sysprep的详情请参考[链接](https://cloud.tencent.com/document/product/213/43498)。", "example": "false" }, { "name": "DataDiskIds", "type": "array", "required": false, "description": "基于实例创建整机镜像时，指定包含在镜像里的数据盘ID。 DataDiskIds 只能在指定 InstanceId 实例所包含的数据盘范围内指定。 可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的 `DataDisks` 获取。", "example": "[\"disk-6gabakqz\"]", "item_type": "string" }, { "name": "SnapshotIds", "type": "array", "required": false, "description": "基于快照创建镜像，指定快照ID，必须包含一个系统盘快照。不可与 InstanceId 同时传入。 InstanceId 和 SnapshotIds 为二选一必填参数。 可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647) 接口返回值中的`SnapshotId`获取。", "example": "[\"snap-kso6f712\", \"snap-l3rrf322\"]", "item_type": "string" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "检测本次请求的是否成功，但不会对操作的资源产生任何影响。默认取值为false。", "example": "false" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到自定义镜像。 可通过 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 接口返回值中的 `TagKey` 和 `TagValue` 获取。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] }, { "name": "ImageFamily", "type": "string", "required": false, "description": "镜像族", "example": "business-daily-update" } ], "required": [ "ImageName" ] }, { "name": "CreateKeyPair", "description": "本接口 (CreateKeyPair) 用于创建一个 `OpenSSH RSA` 密钥对，可以用于登录 `Linux` 实例。 * 开发者只需指定密钥对名称，即可由系统自动创建密钥对，并返回所生成的密钥对的 `ID` 及其公钥、私钥的内容。 * 密钥对名称不能和已经存在的密钥对的名称重复。 * 私钥的内容可以保存到文件中作为 `SSH` 的一种认证方式。 * 腾讯云不会保存用户的私钥，请妥善保管。", "status": "online", "parameters": [ { "name": "KeyName", "type": "string", "required": true, "description": "密钥对名称，可由数字、字母和下划线组成，长度不超过25个字符。密钥对名称不能和已经存在的密钥对名称重复。", "example": "Tencent" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "密钥对创建后所属的项目ID，ProjectId为0表示默认项目。 可以通过以下方式获取项目ID： 通过项目列表查询项目ID。 通过调用接口 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725)，取返回信息中的`projectId `获取项目ID。", "example": "0" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到密钥对。", "example": "[ { \"ResourceType\": \"keypair\", \"Tags\": [ { \"Key\": \"myTag\", \"Value\": \"cloud\" } ] } ]", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] } ], "required": [ "KeyName", "ProjectId" ] }, { "name": "CreateLaunchTemplate", "description": "本接口（CreateLaunchTemplate）用于创建实例启动模板。 实例启动模板是一种配置数据并可用于创建实例，其内容包含创建实例所需的配置，比如实例类型，数据盘和系统盘的类型和大小，以及安全组等信息。 初次创建实例模板后，其模板版本为默认版本1，新版本的创建可使用 [CreateLaunchTemplateVersion](https://cloud.tencent.com/document/product/213/66326) 创建，版本号递增。默认情况下，在[RunI...", "status": "online", "parameters": [ { "name": "LaunchTemplateName", "type": "string", "required": true, "description": "实例启动模板名称。长度为2~128个英文或中文字符。", "example": "MyLaunchTemplate" }, { "name": "Placement", "type": "object", "required": true, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，所属宿主机（在专用宿主机上创建子机时指定）等属性。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-4" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 `ProjectId` 字段来获取。默认取值0，表示默认项目。", "example": "0" }, { "name": "HostIds", "type": "array", "required": false, "description": "实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 的返回值中的 `HostId` 字段来获取。", "example": "[\"host-o5i742go\"]", "item_type": "string" }, { "name": "HostId", "type": "string", "required": false, "description": "实例所属的专用宿主机ID，仅用于出参。", "example": "host-o5i742go" } ] }, { "name": "ImageId", "type": "string", "required": true, "description": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-xxx`。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID：`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1\u0026imageType=PUBLIC_IMAGE)查询；`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查...", "example": "img-dkwyg6sr" }, { "name": "LaunchTemplateVersionDescription", "type": "string", "required": false, "description": "实例启动模板版本描述。长度为2~256个英文或中文字符，默认为空字符。", "example": "MyLaunchTemplateVersionDesc" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例机型。不同实例机型指定了不同的资源规格。 对于付费模式为PREPAID或POSTPAID\\_BY\\_HOUR的实例创建，具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。若不指定该参数，则系统将根据当前地域的资源售卖情况动态指定默认机型。对于付费模式为CDHPAID的实例\ufffd\ufffd...", "example": "S5.16XLARGE256" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘，详情请参考[ 云硬盘使用限制](https://cloud.tencent.com/document/product/362/5145)。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD\ufffd\ufffd...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘ID。 该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。", "example": "disk-ciezoimt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。", "example": "snap-6yczrj8x" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 `RunInstances` 接口。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD） 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1648zauv" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。", "example": "false" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "MyDiskName" } ] }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。若不指定该参数，则默认使用基础网络。若在此参数中指定了私有网络IP，即表示每个实例的主网卡IP；同时，InstanceCount参数必须与私有网络IP的个数一致且不能大于20。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。", "example": "BANDWIDTH_PREPAID" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。", "example": "10" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：true：表示分配公网IPfalse：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[ DescribeBandwidthPackages ](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。", "example": "bwp-h1ro" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646)。 如需为资源分配公网IPv4地址，请指定公网IPv4地址类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "WanIP" }, { "name": "IPv6AddressType", "type": "string", "required": false, "description": "弹性公网 IPv6 类型。 EIPv6：弹性公网 IPv6。 HighQualityEIPv6：精品 IPv6。仅中国香港支持精品IPv6。 如需为资源分配IPv6地址，请指定弹性公网IPv6类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "EIPv6" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" } ] }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "购买实例数量。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量，具体配额相关限制详见[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)。", "example": "1" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例显示名称。不指定实例显示名称则默认显示‘未命名’。购买多台实例，如果指定模式串`{R:x}`，表示生成数字`[x, x+n-1]`，其中`n`表示购买实例的数量，例如`server_{R:3}`，购买1台时，实例显示名称为`server_3`；购买2台时，实例显示名称分别为`server_3`，`server_4`。支持指定多个模式串`{R:x}`。购买多台实例，如果不指定模式串，则在实例显示名称添加后缀`1、2...n`，其中`n`表示购...", "example": "MyInstance" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置。通过该参数可以设置实例的登录方式为密钥或保持镜像的原始登录设置。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "123456@ABC" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"skey-3glfot13\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围：true：表示保持镜像的登录设置false：表示不保持镜像的登录设置默认取值：false。", "example": "true" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的 `SecurityGroupId` 字段来获取。若不指定该参数，则绑定指定项目下的默认安全组，如默认安全组不存在则将自动创建。", "example": "[\"sg-rf6ogz49\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认公共镜像开启云监控、云安全服务；自定义镜像与镜像市场镜像默认不开启云监控，云安全服务，而使用镜像里保留的服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：true：表示开启云安全服务false：表示不开启云安全服务默认取值：true。", "example": "false" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云监控](/document/product/248)服务。取值范围：true：表示开启云监控服务false：表示不开启云监控服务默认取值：true。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：true：表示开启云自动化助手服务false：表示不开启云自动化助手服务默认取值：false。", "example": "true" } ] } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "a521b4e4-c903-4d37-9de6-8096e3ad8eb7" }, { "name": "HostName", "type": "string", "required": false, "description": "云服务器的主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。", "example": "myHost" }, { "name": "ActionTimer", "type": "object", "required": false, "description": "定时任务。通过该参数可以为实例指定定时任务，目前仅支持定时销毁。", "example": "无", "children": [ { "name": "TimerAction", "type": "string", "required": false, "description": "定时器动作，目前仅支持销毁一个值：TerminateInstances。", "example": "TerminateInstances" }, { "name": "ActionTime", "type": "string", "required": false, "description": "执行时间，按照ISO8601标准表示，并且使用UTC时间。格式为 YYYY-MM-DDThh:mm:ssZ。例如 2018-05-29T11:26:40Z，执行时间必须大于当前时间5分钟。", "example": "2024-05-29T11:26:40Z" }, { "name": "Externals", "type": "object", "required": false, "description": "扩展数据。仅做出参使用。", "example": "无", "children": [ { "name": "ReleaseAddress", "type": "boolean", "required": false, "description": "释放地址", "example": "true" }, { "name": "UnsupportNetworks", "type": "array", "required": false, "description": "不支持的网络类型，取值范围：BASIC：基础网络VPC1.0：私有网络VPC1.0", "example": "VPC1.0", "item_type": "string" }, { "name": "StorageBlockAttr", "type": "object", "required": false, "description": "HDD本地存储属性", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "HDD本地存储类型，值为：LOCAL_PRO.", "example": "LOCAL_PRO" }, { "name": "MinSize", "type": "integer", "required": false, "description": "HDD本地存储的最小容量。单位：GiB。", "example": "100" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "HDD本地存储的最大容量。单位：GiB。", "example": "200" } ] } ] }, { "name": "ActionTimerId", "type": "string", "required": false, "description": "定时器ID。仅做出参使用。", "example": "57z0f8ef-8112-460f-8203-fab753580f68" }, { "name": "Status", "type": "string", "required": false, "description": "定时器状态，仅做出参使用。取值范围：UNDO：未执行 DOING：正在执行DONE：执行完成。", "example": "UNDO" }, { "name": "InstanceId", "type": "string", "required": false, "description": "定时器对应的实例ID。仅做出参使用。", "example": "ins-dpa3e3at" } ] }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "置放群组id，仅支持指定一个。该参数可以通过调用 [ DescribeDisasterRecoverGroups ](https://cloud.tencent.com/document/api/213/17810) 的返回值中的 `DisasterRecoverGroupId` 字段来获取。", "example": "[\"ps-3p88qhfo\"]", "item_type": "string" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例，当前仅支持绑定标签到云服务器实例。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数，若指定实例的付费模式为竞价付费则该参数必传。", "example": "无", "children": [ { "name": "SpotOptions", "type": "object", "required": true, "description": "竞价相关选项", "example": "0.12", "children": [ { "name": "MaxPrice", "type": "string", "required": true, "description": "竞价出价", "example": "0.01" }, { "name": "SpotInstanceType", "type": "string", "required": false, "description": "竞价请求类型，当前仅支持类型：one-time", "example": "one-time" } ] }, { "name": "MarketType", "type": "string", "required": false, "description": "市场选项类型，当前只支持取值：spot", "example": "spot" } ] }, { "name": "UserData", "type": "string", "required": false, "description": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。", "example": "YmFzZTY0Cg==" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例。", "example": "false" }, { "name": "CamRoleName", "type": "string", "required": false, "description": "CAM角色名称。可通过[ DescribeRoleList ](https://cloud.tencent.com/document/product/598/36223)接口返回值中的`RoleName `获取。", "example": "testroleName001" }, { "name": "HpcClusterId", "type": "string", "required": false, "description": "高性能计算集群ID。若创建的实例为高性能计算实例，需指定实例放置的集群，否则不可指定。该参数可以通过调用 [DescribeHpcClusters](https://cloud.tencent.com/document/api/213/83220) 的返回值中的 `HpcClusterId` 字段来获取。", "example": "hpc-a5n666lo" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费CDHPAID：独享子机（基于专用宿主机创建，宿主机部分的资源不收费）SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "PREPAID" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "DisableApiTermination", "type": "boolean", "required": false, "description": "实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：TRUE：表示开启实例保护，不允许通过api接口删除实例FALSE：表示关闭实例保护，允许通过api接口删除实例默认取值：FALSE。", "example": "false" }, { "name": "EnableJumboFrame", "type": "boolean", "required": false, "description": "实例是否开启巨型帧，取值范围： true：表示实例开启巨型帧，只有支持巨型帧的机型可设置为true。false：表示实例关闭巨型帧，只有支持巨型帧的机型可设置为false。 支持巨型帧的实例规格： [实例规格](https://cloud.tencent.com/document/product/213/11518)", "example": "false" }, { "name": "LaunchTemplateTagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以绑定标签到实例启动模板。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] }, { "name": "Metadata", "type": "object", "required": false, "description": "自定义metadata，支持创建 CVM 时添加自定义元数据键值对。 **注：内测中**。", "example": "无", "children": [ { "name": "Items", "type": "array", "required": true, "description": "自定义metadata键值对列表。", "example": "[{\"Key\": \"key\", \"Value\": \"value\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义metadata键，由大写字母（A-Z）、小写字母（a-z）、数字（0-9）、下划线（_）或连字符（-）组成，大小上限为128 字节。", "example": "\"key\"" }, { "name": "Value", "type": "string", "required": true, "description": "自定义metadata值，大小上限为256 KB。", "example": "\"value\"" } ] } ] }, { "name": "TemplateDataModifyAction", "type": "string", "required": false, "description": "只允许传递 Update 和 Replace 参数，在模板使用自定义 Metadata 且在 RunInstances 也传递 Metadata 时生效。默认采用 Replace。 - Update：设模板 t含本参数值为Update、 metadata=[k1:v1, k2:v2] ，则RunInstances（给metadata=[k2:v3]）+ t 创建的 cvm 使用metadata=[k1:v1, k2:v3] - Replace：模板 t含本参数值为Replace、 metadata=[k1:v1, k2:v2] ，则RunInstances（给metadata=[k2:v3]）+ t 创建的 cvm 使用metadata=[k2:v3] **注：内测中**。", "example": "Update" } ], "required": [ "LaunchTemplateName", "Placement", "ImageId" ] }, { "name": "CreateLaunchTemplateVersion", "description": "本接口（CreateLaunchTemplateVersion）根据指定的实例模板ID以及对应的模板版本号创建新的实例启动模板，若未指定模板版本号则使用默认版本号。每个实例启动模板最多创建30个版本。 * 新实例模板中未显式指定的参数值，使用指定版本号对应参数值覆盖。", "status": "online", "parameters": [ { "name": "Placement", "type": "object", "required": true, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，所属宿主机（在专用宿主机上创建子机时指定）等属性。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-4" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 `ProjectId` 字段来获取。默认取值0，表示默认项目。", "example": "0" }, { "name": "HostIds", "type": "array", "required": false, "description": "实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 的返回值中的 `HostId` 字段来获取。", "example": "[\"host-o5i742go\"]", "item_type": "string" }, { "name": "HostId", "type": "string", "required": false, "description": "实例所属的专用宿主机ID，仅用于出参。", "example": "host-o5i742go" } ] }, { "name": "LaunchTemplateId", "type": "string", "required": true, "description": "启动模板ID，新版本将基于该实例启动模板ID创建。可通过 [DescribeLaunchTemplates](https://cloud.tencent.com/document/api/213/66322) 接口返回值中的`LaunchTemplateId`获取。", "example": "lt-86v7g7g8" }, { "name": "LaunchTemplateVersion", "type": "integer", "required": false, "description": "若给定，新实例启动模板将基于给定的版本号创建。若未指定则使用默认版本,可以通过 [DescribeLaunchTemplateVersions](https://cloud.tencent.com/document/api/213/66323)查询默认版本。", "example": "1" }, { "name": "LaunchTemplateVersionDescription", "type": "string", "required": false, "description": "实例启动模板版本描述。长度为2~256个英文或中文字符，不指定该参数时默认为空字符。", "example": "new_version" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例机型。不同实例机型指定了不同的资源规格。 对于付费模式为PREPAID或POSTPAID\\_BY\\_HOUR的实例创建，具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。若不指定该参数，则系统将根据当前地域的资源售卖情况动态指定默认机型。对于付费模式为CDHPAID的实例\ufffd\ufffd...", "example": "PREPAID" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-xxx`。镜像类型分为四种：公共镜像自定义镜像共享镜像云镜像市场可通过以下方式获取可用的镜像ID：`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1\u0026imageType=PUBLIC_IMAGE)查询；`云镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查询。...", "example": "img-irmer45l" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD\ufffd\ufffd...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘ID。 该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。", "example": "disk-ciezoimt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。", "example": "snap-6yczrj8x" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 `RunInstances` 接口。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD） 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1648zauv" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。", "example": "false" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "MyDiskName" } ] }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。若不指定该参数，则默认使用基础网络。若在此参数中指定了私有网络IP，即表示每个实例的主网卡IP；同时，InstanceCount参数必须与私有网络IP的个数一致且不能大于20。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。", "example": "BANDWIDTH_PREPAID" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。", "example": "10" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：true：表示分配公网IPfalse：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[ DescribeBandwidthPackages ](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。", "example": "bwp-h1ro" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646)。 如需为资源分配公网IPv4地址，请指定公网IPv4地址类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "WanIP" }, { "name": "IPv6AddressType", "type": "string", "required": false, "description": "弹性公网 IPv6 类型。 EIPv6：弹性公网 IPv6。 HighQualityEIPv6：精品 IPv6。仅中国香港支持精品IPv6。 如需为资源分配IPv6地址，请指定弹性公网IPv6类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "EIPv6" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" } ] }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "购买实例数量。具体配额相关限制详见[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)。", "example": "1" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例显示名称。不指定实例显示名称则默认显示‘未命名’。购买多台实例，如果指定模式串`{R:x}`，表示生成数字`[x, x+n-1]`，其中`n`表示购买实例的数量，例如`server_{R:3}`，购买1台时，实例显示名称为`server_3`；购买2台时，实例显示名称分别为`server_3`，`server_4`。支持指定多个模式串`{R:x}`。购买多台实例，如果不指定模式串，则在实例显示名称添加后缀`1、2...n`，其中`n`表示购...", "example": "my_instance" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置。通过该参数可以设置实例的登录方式为密钥或保持镜像的原始登录设置。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "123456@ABC" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"skey-3glfot13\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围：true：表示保持镜像的登录设置false：表示不保持镜像的登录设置默认取值：false。", "example": "true" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。", "example": "[\"sg-rf6ogz49\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认公共镜像开启云监控、云安全服务；自定义镜像与云镜像市场镜像默认不开启云监控，云安全服务，而使用镜像里保留的服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：true：表示开启云安全服务false：表示不开启云安全服务默认取值：true。", "example": "false" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云监控](/document/product/248)服务。取值范围：true：表示开启云监控服务false：表示不开启云监控服务默认取值：true。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：true：表示开启云自动化助手服务false：表示不开启云自动化助手服务默认取值：false。", "example": "true" } ] } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "a521b4e4-c903-4d37-9de6-8096e3ad8eb7" }, { "name": "HostName", "type": "string", "required": false, "description": "云服务器的主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。", "example": "myHost" }, { "name": "ActionTimer", "type": "object", "required": false, "description": "定时任务。通过该参数可以为实例指定定时任务，目前仅支持定时销毁。", "example": "无", "children": [ { "name": "TimerAction", "type": "string", "required": false, "description": "定时器动作，目前仅支持销毁一个值：TerminateInstances。", "example": "TerminateInstances" }, { "name": "ActionTime", "type": "string", "required": false, "description": "执行时间，按照ISO8601标准表示，并且使用UTC时间。格式为 YYYY-MM-DDThh:mm:ssZ。例如 2018-05-29T11:26:40Z，执行时间必须大于当前时间5分钟。", "example": "2024-05-29T11:26:40Z" }, { "name": "Externals", "type": "object", "required": false, "description": "扩展数据。仅做出参使用。", "example": "无", "children": [ { "name": "ReleaseAddress", "type": "boolean", "required": false, "description": "释放地址", "example": "true" }, { "name": "UnsupportNetworks", "type": "array", "required": false, "description": "不支持的网络类型，取值范围：BASIC：基础网络VPC1.0：私有网络VPC1.0", "example": "VPC1.0", "item_type": "string" }, { "name": "StorageBlockAttr", "type": "object", "required": false, "description": "HDD本地存储属性", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "HDD本地存储类型，值为：LOCAL_PRO.", "example": "LOCAL_PRO" }, { "name": "MinSize", "type": "integer", "required": false, "description": "HDD本地存储的最小容量。单位：GiB。", "example": "100" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "HDD本地存储的最大容量。单位：GiB。", "example": "200" } ] } ] }, { "name": "ActionTimerId", "type": "string", "required": false, "description": "定时器ID。仅做出参使用。", "example": "57z0f8ef-8112-460f-8203-fab753580f68" }, { "name": "Status", "type": "string", "required": false, "description": "定时器状态，仅做出参使用。取值范围：UNDO：未执行 DOING：正在执行DONE：执行完成。", "example": "UNDO" }, { "name": "InstanceId", "type": "string", "required": false, "description": "定时器对应的实例ID。仅做出参使用。", "example": "ins-dpa3e3at" } ] }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "置放群组id，仅支持指定一个。可使用[DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/api/213/17810)接口获取。", "example": "[\"ps-3p88qhfo\"]", "item_type": "string" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例，当前仅支持绑定标签到云服务器实例。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数，若指定实例的付费模式为竞价付费则该参数必传。", "example": "无", "children": [ { "name": "SpotOptions", "type": "object", "required": true, "description": "竞价相关选项", "example": "0.12", "children": [ { "name": "MaxPrice", "type": "string", "required": true, "description": "竞价出价", "example": "0.01" }, { "name": "SpotInstanceType", "type": "string", "required": false, "description": "竞价请求类型，当前仅支持类型：one-time", "example": "one-time" } ] }, { "name": "MarketType", "type": "string", "required": false, "description": "市场选项类型，当前只支持取值：spot", "example": "spot" } ] }, { "name": "UserData", "type": "string", "required": false, "description": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。", "example": "YmFzZTY0Cg==" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例。", "example": "false" }, { "name": "CamRoleName", "type": "string", "required": false, "description": "CAM角色名称。可通过[ DescribeRoleList ](https://cloud.tencent.com/document/product/598/13887)接口返回值中的`roleName`获取。", "example": "testroleName001" }, { "name": "HpcClusterId", "type": "string", "required": false, "description": "高性能计算集群ID。若创建的实例为高性能计算实例，需指定实例放置的集群，否则不可指定。该参数可以通过调用 [DescribeHpcClusters](https://cloud.tencent.com/document/api/213/83220) 的返回值中的 `HpcClusterId` 字段来获取。", "example": "hpc-a5n666lo" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费CDHPAID：独享子机（基于专用宿主机创建，宿主机部分的资源不收费）SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "PREPAID" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "DisableApiTermination", "type": "boolean", "required": false, "description": "实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：TRUE：表示开启实例保护，不允许通过api接口删除实例FALSE：表示关闭实例保护，允许通过api接口删除实例默认取值：FALSE。", "example": "false" }, { "name": "EnableJumboFrame", "type": "boolean", "required": false, "description": "实例是否开启巨型帧，取值范围： true：表示实例开启巨型帧，只有支持巨型帧的机型可设置为true。false：表示实例关闭巨型帧，只有支持巨型帧的机型可设置为false。 支持巨型帧的实例规格： [实例规格](https://cloud.tencent.com/document/product/213/11518)", "example": "false" }, { "name": "Metadata", "type": "object", "required": false, "description": "自定义metadata，支持创建 CVM 时添加自定义元数据键值对。 **注：内测中**。", "example": "无", "children": [ { "name": "Items", "type": "array", "required": true, "description": "自定义metadata键值对列表。", "example": "[{\"Key\": \"key\", \"Value\": \"value\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义metadata键，由大写字母（A-Z）、小写字母（a-z）、数字（0-9）、下划线（_）或连字符（-）组成，大小上限为128 字节。", "example": "\"key\"" }, { "name": "Value", "type": "string", "required": true, "description": "自定义metadata值，大小上限为256 KB。", "example": "\"value\"" } ] } ] }, { "name": "TemplateDataModifyAction", "type": "string", "required": false, "description": "只允许传递 Update 和 Replace 参数，在模板使用自定义 Metadata 且在 RunInstances 也传递 Metadata 时生效。默认采用 Replace。 - Update：设模板 t含本参数值为Update、 metadata=[k1:v1, k2:v2] ，则RunInstances（给metadata=[k2:v3]）+ t 创建的 cvm 使用metadata=[k1:v1, k2:v3] - Replace：模板 t含本参数值为Replace、 metadata=[k1:v1, k2:v2] ，则RunInstances（给metadata=[k2:v3]）+ t 创建的 cvm 使用metadata=[k2:v3] **注：内测中**。", "example": "Update" } ], "required": [ "Placement", "LaunchTemplateId" ] }, { "name": "DeleteDisasterRecoverGroups", "description": "本接口 (DeleteDisasterRecoverGroups)用于删除[分散置放群组](https://cloud.tencent.com/document/product/213/15486)。只有空的置放群组才能被删除，非空的群组需要先销毁组内所有云服务器，才能执行删除操作，不然会产生删除置放群组失败的错误。", "status": "online", "parameters": [ { "name": "DisasterRecoverGroupIds", "type": "array", "required": true, "description": "分散置放群组ID列表，可通过[DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/api/213/17810)接口获取。每次请求允许操作的分散置放群组数量上限是10。", "example": "[\"ps-58l1hu01\"]", "item_type": "string" } ], "required": [ "DisasterRecoverGroupIds" ] }, { "name": "DeleteHpcClusters", "description": "当高性能计算集群为空, 即集群内没有任何设备时候, 可以删除该集群。", "status": "online", "parameters": [ { "name": "HpcClusterIds", "type": "array", "required": true, "description": "高性能计算集群ID列表。", "example": "[\"hpc-p64fdfa9\"]", "item_type": "string" } ], "required": [ "HpcClusterIds" ] }, { "name": "DeleteImages", "description": "本接口（DeleteImages）用于删除一个或多个镜像。 * 当[镜像状态](https://cloud.tencent.com/document/product/213/15753#Image) 为`创建中`、`复制中`、`导入中`时, 不允许删除。镜像状态可以通过[DescribeImages](https://cloud.tencent.com/document/api/213/9418)获取。 * 被共享的镜像，需要先取消共享关系，才能删除。 * 每个地域最多只支持创建500个自定义镜像，删除镜像可以释放账户的配额。 * 当镜像正在被\ufffd...", "status": "online", "parameters": [ { "name": "ImageIds", "type": "array", "required": true, "description": "删除的镜像 ID 列表。 可通过 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) 接口返回值中的`ImageId`获取。", "example": "[\"img-34vaef8fe\"]", "item_type": "string" }, { "name": "DeleteBindedSnap", "type": "boolean", "required": false, "description": "是否删除镜像关联的快照。 默认值：false", "example": "false" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "检测是否支持删除镜像。 默认值：false", "example": "true" } ], "required": [ "ImageIds" ] }, { "name": "DeleteInstancesActionTimer", "description": "本接口 (DeleteInstancesActionTimer) 用于删除定时任务。", "status": "online", "parameters": [ { "name": "ActionTimerIds", "type": "array", "required": true, "description": "定时任务ID列表，可以通过[ DescribeInstancesActionTimer ](https://cloud.tencent.com/document/product/213/103950)接口查询。只能删除未执行的定时任务。", "example": "[\"865d042d-0219-46c3-9821-6028c96cfb7c\"]", "item_type": "string" } ], "required": [ "ActionTimerIds" ] }, { "name": "DeleteKeyPairs", "description": "本接口 (DeleteKeyPairs) 用于删除已在腾讯云托管的密钥对。 * 可以同时删除多个密钥对。 * 不能删除已被实例或镜像引用的密钥对，所以需要独立判断是否所有密钥对都被成功删除。", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": true, "description": "一个或多个待操作的密钥对ID。每次请求批量密钥对的上限为100。可以通过以下方式获取可用的密钥ID：通过登录[控制台](https://console.cloud.tencent.com/cvm/sshkey)查询密钥ID。通过调用接口 [DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699) ，取返回信息中的 `KeyId` 获取密钥对ID。", "example": "[\"skey-mv9yzyjj\"]", "item_type": "string" } ], "required": [ "KeyIds" ] }, { "name": "DeleteLaunchTemplate", "description": "本接口（DeleteLaunchTemplate）用于删除一个实例启动模板。", "status": "online", "parameters": [ { "name": "LaunchTemplateId", "type": "string", "required": true, "description": "启动模板ID。可通过 [DescribeLaunchTemplates](https://cloud.tencent.com/document/api/213/66322) 接口返回值中的`LaunchTemplateId`获取。", "example": "lt-rf6ogz49" } ], "required": [ "LaunchTemplateId" ] }, { "name": "DeleteLaunchTemplateVersions", "description": "本接口（DeleteLaunchTemplateVersions）用于删除一个或者多个实例启动模板版本。", "status": "online", "parameters": [ { "name": "LaunchTemplateId", "type": "string", "required": true, "description": "启动模板ID。可通过 [DescribeLaunchTemplates](https://cloud.tencent.com/document/api/213/66322) 接口返回值中的`LaunchTemplateId`获取。", "example": "lt-irmer45l" }, { "name": "LaunchTemplateVersions", "type": "array", "required": true, "description": "实例启动模板版本列表。可通过 [DescribeLaunchTemplateVersions](https://cloud.tencent.com/document/api/213/66323) 接口返回值中的`LaunchTemplateVersion`获取。", "example": "[1,2,3]", "item_type": "integer" } ], "required": [ "LaunchTemplateId", "LaunchTemplateVersions" ] }, { "name": "DescribeAccountQuota", "description": "本接口(DescribeAccountQuota)用于查询用户配额详情。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "zone 按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。类型：String必选：否可选项：可用区列表 quota-type 按照【配额类型】进行过滤。配额类型形如：PostPaidQuotaSet。类型：String必选：否可选项：PostPaidQuotaSet: 后付费配额PrePaidQuotaSet: 预付费配额SpotPaidQuotaSet: 竞价配额ImageQuotaSet: 镜像配额DisasterRecoverGroupQuotaSet: 置放群组配额", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeChcDeniedActions", "description": "查询CHC物理服务器禁止做的操作，返回给用户", "status": "online", "parameters": [ { "name": "ChcIds", "type": "array", "required": true, "description": "CHC物理服务器实例id", "example": "[“chc-123456fd”]", "item_type": "string" } ], "required": [ "ChcIds" ] }, { "name": "DescribeChcHosts", "description": "本接口 (DescribeChcHosts) 用于查询一个或多个CHC物理服务器详细信息。 * 可以根据实例`ID`、实例名称或者设备类型等信息来查询实例的详细信息。过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的实例。", "status": "online", "parameters": [ { "name": "ChcIds", "type": "array", "required": false, "description": "CHC物理服务器实例ID。每次请求的实例的上限为100。参数不支持同时指定`ChcIds`和`Filters`。", "example": "[\"chc-1a2b3c4d\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "zone按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。类型：String必选：否可选项：可用区列表instance-name按照【实例名称】进行过滤。类型：String必选：否instance-state按照【实例状态】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)类型：String必选：否device-type按照【设备类型】进行过滤。类型：String必选：否vpc-id按照【私有网络唯一ID...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "10" } ], "required": [] }, { "name": "DescribeDisasterRecoverGroupQuota", "description": "本接口 (DescribeDisasterRecoverGroupQuota)用于查询[分散置放群组](https://cloud.tencent.com/document/product/213/15486)配额。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDisasterRecoverGroups", "description": "本接口 (DescribeDisasterRecoverGroups)用于查询[分散置放群组](https://cloud.tencent.com/document/product/213/15486)信息。", "status": "online", "parameters": [ { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "分散置放群组ID列表。每次请求允许操作的分散置放群组数量上限是10。", "example": "[\"ps-21q9ibvr\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": false, "description": "分散置放群组名称，支持模糊匹配。", "example": "myGroup" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "2" }, { "name": "Filters", "type": "array", "required": false, "description": "tag-key 按照【标签键】进行过滤。类型：String必选：否 tag-value 按照【标签值】进行过滤。类型：String必选：否 tag:tag-key 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。类型：String必选：否 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeHosts", "description": "本接口 (DescribeHosts) 用于获取一个或多个CDH实例的详细信息。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "zone 按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。类型：String必选：否可选项：可用区列表 project-id 按照【项目ID】进行过滤，可通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID形如：1002189。类型...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeHpcClusters", "description": "查询高性能集群信息", "status": "online", "parameters": [ { "name": "HpcClusterIds", "type": "array", "required": false, "description": "一个或多个待操作的高性能计算集群ID。集群ID信息可通过 [查询高性能集群信息](https://cloud.tencent.com/document/api/213/83220) 接口获取。每次请求高性能计算集群信息的批量上限为100，默认配合Limit传参数，不能超过Limit值，Limit默认20。", "example": "[\"hpc-p64fdfa9\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": false, "description": "高性能计算集群名称，长度限制[1-60]。", "example": "MyCluster" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区信息。可用区信息可通过 [查询可用区信息](https://cloud.tencent.com/document/api/213/15707) 接口获取。", "example": "ap-guangzhou-2" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量, 默认值0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "本次请求量, 默认值20，范围限制为[1-100]。", "example": "20" }, { "name": "HpcClusterType", "type": "string", "required": false, "description": "高性能计算集群类型，当前有三个取值：分别是CDC/CHC/STANDARD，其中STANDARD是默认的标准模式。", "example": "CDC/CHC/STANDARD" }, { "name": "HpcClusterBusinessId", "type": "string", "required": false, "description": "高性能计算集群对应的业务场景标识，当前只支持CDC场景类型。", "example": "例如cdc场景：cluster-iu5gustw，其他场景暂不支持。" }, { "name": "InstanceType", "type": "string", "required": false, "description": "高性能计算集群实例类型", "example": "HCCPNV4ane.58XLARGE1929" }, { "name": "Filters", "type": "array", "required": false, "description": "tag-key 按照【标签键】进行过滤。类型：String必选：否 tag-value 按照【标签值】进行过滤。类型：String必选：否 tag:tag-key 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。类型：String必选：否 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeImageFromFamily", "description": "本接口(DescribeImageFromFamily) 用于查看镜像族内可用镜像信息。", "status": "online", "parameters": [ { "name": "ImageFamily", "type": "string", "required": false, "description": "镜像族", "example": "business-daily-update" } ], "required": [] }, { "name": "DescribeImageQuota", "description": "本接口(DescribeImageQuota)用于查询用户账号的镜像配额。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeImageSharePermission", "description": "本接口（DescribeImageSharePermission）用于查询镜像分享信息。", "status": "online", "parameters": [ { "name": "ImageId", "type": "string", "required": true, "description": "需要共享的镜像 ID，可通过 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) 接口返回的`ImageId`获取。", "example": "img-6pb6lrmy" } ], "required": [ "ImageId" ] }, { "name": "DescribeImages", "description": "本接口(DescribeImages) 用于查看镜像列表。 * 可以通过指定镜像ID来查询指定镜像的详细信息，或通过设定过滤器来查询满足过滤条件的镜像的详细信息。 * 指定偏移(Offset)和限制(Limit)来选择结果中的一部分，默认返回满足条件的前20个镜像信息。", "status": "online", "parameters": [ { "name": "ImageIds", "type": "array", "required": false, "description": "镜像ID列表 。镜像ID如：`img-gvbnzy6f`。array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/15688)。镜像ID可以通过如下方式获取：通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。", "example": "[\"img-gvbnzy6f\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，每次请求的`Filters`的上限为10，`Filters.Values`的上限为5。参数不可以同时指定`ImageIds`和`Filters`。详细的过滤条件如下：image-id按照【镜像ID】进行过滤。类型：String必选：否image-type按照【镜像类型】进行过滤。类型：String必选：否可选项：PRIVATE_IMAGE: 自定义镜像 (本账户创建的镜像)PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "数量限制，默认为20，最大值为100。关于Limit详见[API简介](/document/api/213/568#.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0.E4.B8.8E.E8.BF.94.E5.9B.9E.E5.8F.82.E6.95.B0.E9.87.8A.E4.B9.89)。", "example": "20" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型，如 `SA5.MEDIUM2`。可通过 [DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/product/213/15749) 接口返回的 `InstanceType` 获取。", "example": "SA5.MEDIUM2" } ], "required": [] }, { "name": "DescribeImportImageOs", "description": "查看可以导入的镜像操作系统信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeInstanceFamilyConfigs", "description": "本接口（DescribeInstanceFamilyConfigs）查询当前用户和地域所支持的机型族列表信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeInstanceInternetBandwidthConfigs", "description": "本接口 (DescribeInstanceInternetBandwidthConfigs) 用于查询实例带宽配置。 * 只支持查询`BANDWIDTH_PREPAID`（ 预付费按带宽结算 ）计费模式的带宽配置。 * 接口返回实例的所有带宽配置信息（包含历史的带宽配置信息）。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "ins-6lafsaz0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceTypeConfigs", "description": "本接口 (DescribeInstanceTypeConfigs) 用于查询实例机型配置。 * 可以根据`zone`、`instance-family`、`instance-type`来查询实例机型配置。过滤条件详见过滤器[`Filter`](https://cloud.tencent.com/document/api/213/15753#Filter)。 * 如果参数为空，返回指定地域的所有实例机型配置。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "zone 按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。类型：String必选：否可选项：可用区列表 instance-family 按照【实例机型系列】进行过滤。实例机型系列形如：S1、I1、M1等。具体取值参见[实例类型](https://cloud.tencent.com/document/product/213/11518)描述。类型：String必选：否 instance-type 按照【实例类型】进行过滤。实例类型形如：S5.12XLARGE128、S5.12XLARGE96等。具体取值参见[实例规\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeInstanceVncUrl", "description": "本接口 ( DescribeInstanceVncUrl ) 用于查询实例管理终端地址，获取的地址可用于实例的 VNC 登录。 * 处于 `STOPPED` 状态的机器无法使用此功能。 * 管理终端地址的有效期为 15 秒，调用接口成功后如果 15 秒内不使用该链接进行访问，管理终端地址自动失效，您需要重新查询。 * 管理终端地址一旦被访问，将自动失效，您需要重新查询。 * 如果连接断开，每分钟内重新连接的次数不能\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "一个操作的实例ID。可通过[ DescribeInstances ](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "ins-r9hr2upy" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstances", "description": "本接口 (DescribeInstances) 用于查询一个或多个实例的详细信息。 * 可以根据实例`ID`、实例名称或者实例计费模式等信息来查询实例的详细信息。过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的实例。 * 支持查询实例的最新操作（LatestOperation）以及最新操作状态(LatestOperationState)。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "按照一个或者多个实例ID查询。实例ID例如：`ins-xxxxxxxx`。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。参数不支持同时指定`InstanceIds`和`Filters`。", "example": "[\"ins-rf6ogz49\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "zone 按照【可用区】进行过滤。可用区例如：ap-guangzhou-6。类型：String必选：否可选项：可用区列表 project-id 按照【项目ID】进行过滤，可通过调用[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)查询已创建的项目列表或登录[控制台](https://console.cloud.tencent.com/cvm/index)进行查看；也可以调用[AddProject](https://cloud.tencent.com/document/api/651/81952)创建新的项目。项目ID例如：1002189。类\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "5" } ], "required": [] }, { "name": "DescribeInstancesActionTimer", "description": "本接口 (DescribeInstancesActionTimer) 用于查询定时任务信息。", "status": "online", "parameters": [ { "name": "ActionTimerIds", "type": "array", "required": false, "description": "定时任务ID列表。", "example": "59337876-b254-4c21-847f-7d57d840d227", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "按照一个或者多个实例ID查询。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "[\"ins-37qv3ucj\"]", "item_type": "string" }, { "name": "TimerAction", "type": "string", "required": false, "description": "定时器动作，目前仅支持销毁一个值：TerminateInstances。", "example": "TerminateInstances" }, { "name": "EndActionTime", "type": "string", "required": false, "description": "定时任务执行时间的结束范围，用于条件筛选，格式如2018-05-01 19:00:00。", "example": "2024-11-06T08:00:32Z" }, { "name": "StartActionTime", "type": "string", "required": false, "description": "定时任务执行时间的开始范围，用于条件筛选，格式如2018-05-01 19:00:00。", "example": "2024-11-06T08:00:32Z" }, { "name": "StatusList", "type": "array", "required": false, "description": "定时任务状态列表。UNDO：未执行 DOING：正在执行DONE：执行完成。", "example": "UNDO", "item_type": "string" } ], "required": [] }, { "name": "DescribeInstancesAttributes", "description": "获取指定实例的属性，目前支持查询实例自定义数据User-Data。", "status": "online", "parameters": [ { "name": "Attributes", "type": "array", "required": true, "description": "需要获取的实例属性。可选值： UserData: 实例自定义数据", "example": "[\"UserData\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "[\"ins-lyxxskp2\"]", "item_type": "string" } ], "required": [ "Attributes", "InstanceIds" ] }, { "name": "DescribeInstancesModification", "description": "本接口 (DescribeInstancesModification) 用于查询指定实例支持调整的机型配置。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待查询的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为20。", "example": "[\"ins-4txox06m\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "status 按照【配置规格状态】进行过滤。配置规格状态形如：SELL(表示实例可售卖)、UNAVAILABLE(表示实例不可用)。类型：String必选：否 每次请求的`Filters`的上限为10，`Filter.Values`的上限为2。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [ "InstanceIds" ] }, { "name": "DescribeInstancesOperationLimit", "description": "本接口（DescribeInstancesOperationLimit）用于查询实例操作限制。 * 目前支持调整配置操作限制次数查询。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "按照一个或者多个实例ID查询，可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)API返回值中的InstanceId获取。实例ID形如：ins-xxxxxxxx。（此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的ids.N一节）。每次请求的实例的上限为100。", "example": "[\"ins-l26mwvil\"]", "item_type": "string" }, { "name": "Operation", "type": "string", "required": true, "description": "实例操作。 INSTANCE_DEGRADE：实例降配操作 INTERNET_CHARGE_TYPE_CHANGE：实例调整带宽付费模式操作", "example": "INSTANCE_DEGRADE" } ], "required": [ "InstanceIds", "Operation" ] }, { "name": "DescribeInstancesStatus", "description": "本接口 (DescribeInstancesStatus) 用于查询一个或多个实例的状态。 * 可以根据实例`ID`来查询实例的状态。 * 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的实例状态。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "按照一个或者多个实例ID查询。实例ID形如：`ins-dyzp06q6`。此参数的具体格式可参考API[简介](https://cloud.tencent.com/document/api/213/15688)的`ids.N`一节）。每次请求的实例的上限为100。", "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "2" } ], "required": [] }, { "name": "DescribeInternetChargeTypeConfigs", "description": "本接口（DescribeInternetChargeTypeConfigs）用于查询网络的计费类型。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeKeyPairs", "description": "本接口 (DescribeKeyPairs) 用于查询密钥对信息。 * 密钥对是通过一种算法生成的一对密钥，在生成的密钥对中，一个向外界公开，称为公钥；另一个用户自己保留，称为私钥。密钥对的公钥内容可以通过这个接口查询，但私钥内容系统不保留。", "status": "online", "parameters": [ { "name": "KeyIds", "type": "array", "required": false, "description": "密钥对ID，密钥对ID形如：`skey-11112222`（此接口支持同时传入多个ID进行过滤。此参数的具体格式可参考 API [简介](https://cloud.tencent.com/document/api/213/15688)的 `id.N` 一节）。参数不支持同时指定 `KeyIds` 和 `Filters`。密钥对ID可以通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询。", "example": "[\"skey-11112222\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 project-id - Integer - 是否必填：否 -（过滤条件）按照项目ID过滤。可以通过[项目列表](https://console.cloud.tencent.com/project)查询项目ID，或者调用接口 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725)，取返回信息中的projectId获取项目ID。 key-name - String - 是否必填：否 -（过滤条件）按照密钥对名称过滤。 tag-key - String - 是否必填：否 -（过滤条件）按照标签键过滤。 tag-v...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeLaunchTemplateVersions", "description": "本接口（DescribeLaunchTemplateVersions）用于查询实例模板版本信息。 - 不支持参数`LaunchTemplateVersions`与以下参数同时指定，包括 `MaxVersion`、`MinVersion`、`Limit`、`Offset`和`DefaultVersion`。", "status": "online", "parameters": [ { "name": "LaunchTemplateId", "type": "string", "required": true, "description": "启动模板ID。", "example": "\"lt-irmer45l\"" }, { "name": "LaunchTemplateVersions", "type": "array", "required": false, "description": "实例启动模板列表。", "example": "[1,2,3]", "item_type": "integer" }, { "name": "MinVersion", "type": "integer", "required": false, "description": "通过范围指定版本时的最小版本号，默认为0。", "example": "1" }, { "name": "MaxVersion", "type": "integer", "required": false, "description": "通过范围指定版本时的最大版本号，默认为30。", "example": "2" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "10" }, { "name": "DefaultVersion", "type": "boolean", "required": false, "description": "是否查询默认版本。默认值：false", "example": "false" } ], "required": [ "LaunchTemplateId" ] }, { "name": "DescribeLaunchTemplates", "description": "本接口（DescribeLaunchTemplates）用于查询一个或者多个实例启动模板。", "status": "online", "parameters": [ { "name": "LaunchTemplateIds", "type": "array", "required": false, "description": "启动模板ID，一个或者多个启动模板ID。若未指定，则显示用户所有模板。", "example": "[\"lt-irmer45l\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "LaunchTemplateName 按照【实例启动模板名称】进行过滤。类型：String必选：否 tag-key 按照【标签键】进行过滤。类型：String必选：否 tag-value 按照【标签值】进行过滤。类型：String必选：否 tag:tag-key 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。类型：String必选：否 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`LaunchTemplateIds`和`Filter...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "10" } ], "required": [] }, { "name": "DescribeRegions", "description": "本接口(DescribeRegions)用于查询地域信息。因平台策略原因，该接口暂时停止更新，为确保您正常调用，可切换至新链接：https://cloud.tencent.com/document/product/1596/77930。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeTaskInfo", "description": "本接口 (DescribeTaskInfo) 用于查询云服务器维修任务列表及详细信息。 - 可以根据实例ID、实例名称或任务状态等信息来查询维修任务列表。过滤信息详情可参考入参说明。 - 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的维修任务列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "返回数量，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "20" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。", "example": "0" }, { "name": "Product", "type": "string", "required": false, "description": "按照指定的产品类型查询，支持取值： - `CVM`：云服务器 - `CDH`：专用宿主机 - `CPM2.0`：裸金属云服务器 未传入或为空时，默认查询全部产品类型。", "example": "CVM" }, { "name": "TaskStatus", "type": "array", "required": false, "description": "按照一个或多个任务状态ID进行过滤。 `TaskStatus`（任务状态ID）与任务状态中文名的对应关系如下： - `1`：待授权 - `2`：处理中 - `3`：已结束 - `4`：已预约 - `5`：已取消 - `6`：已避免 各任务状态的具体含义，可参考 [任务状态](https://cloud.tencent.com/document/product/213/67789#.E4.BB.BB.E5.8A.A1.E7.8A.B6.E6.80.81)。", "example": "[1, 2, 3, 4, 5, 6]", "item_type": "integer" }, { "name": "TaskTypeIds", "type": "array", "required": false, "description": "按照一个或多个任务类型ID进行过滤。 `TaskTypeId`（任务类型ID）与任务类型中文名的对应关系如下： - `101`：实例运行隐患 - `102`：实例运行异常 - `103`：实例硬盘异常 - `104`：实例网络连接异常 - `105`：实例运行预警 - `106`：实例硬盘预警 - `107`：实例维护升级 各任务类型的具体含义，可参考 [维修任务分类](https://cloud.tencent.com/document/product/213/67789#.E7.BB.B4.E4.BF.AE.E4.BB.BB.E5.8A.A1.E5.88...", "example": "[101, 102, 103, 104, 105, 106, 107]", "item_type": "integer" }, { "name": "TaskIds", "type": "array", "required": false, "description": "按照一个或者多个任务ID查询。任务ID形如：`rep-xxxxxxxx`。", "example": "[\"rep-xxxxxxxx\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "按照一个或者多个实例ID查询。实例ID形如：`ins-xxxxxxxx`，可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "[\"ins-xxxxxxxx\"]", "item_type": "string" }, { "name": "Aliases", "type": "array", "required": false, "description": "按照一个或者多个实例名称查询。", "example": "[\"test-1\"]", "item_type": "string" }, { "name": "StartDate", "type": "string", "required": false, "description": "时间查询区间的起始位置，会根据任务创建时间`CreateTime`进行过滤，格式为`YYYY-MM-DD hh:mm:ss`。未传入时默认为当天`00:00:00`。", "example": "2023-01-01 00:00:00" }, { "name": "EndDate", "type": "string", "required": false, "description": "时间查询区间的终止位置，会根据任务创建时间`CreateTime`进行过滤，格式为`YYYY-MM-DD hh:mm:ss`。未传入时默认为当前时刻。", "example": "2023-02-01 00:00:00" }, { "name": "OrderField", "type": "string", "required": false, "description": "指定返回维修任务列表的排序字段，目前支持： - `CreateTime`：任务创建时间 - `AuthTime`：任务授权时间 - `EndTime`：任务结束时间 未传入时或为空时，默认按`CreateTime`字段进行排序。", "example": "CreateTime" }, { "name": "Order", "type": "integer", "required": false, "description": "排序方式，目前支持： - `0`：升序（默认） - `1`：降序 未传入或为空时，默认按升序排序。", "example": "1" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeZoneInstanceConfigInfos", "description": "本接口(DescribeZoneInstanceConfigInfos) 获取可用区的机型信息。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "zone 按照【可用区】进行过滤。可用区形如：ap-guangzhou-6。类型：String必选：否可选项：可用区列表 instance-family 按照【实例机型系列】进行过滤。实例机型系列形如：S1、I1、M1等。具体取值参见[实例类型](https://cloud.tencent.com/document/product/213/11518)描述。类型：String必选：否 instance-type 按照【实例机型】进行过滤。不同实例机型指定了不同的资源规格，具体取值可通过调用接口 [D...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "zone" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"ap-guangzhou-6\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeZones", "description": "本接口(DescribeZones)用于查询可用区信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DisassociateInstancesKeyPairs", "description": "本接口 (DisassociateInstancesKeyPairs) 用于解除实例的密钥绑定关系。 * 仅支持对 Linux 操作系统实例进行解绑操作。 * 非强制关机场景下，仅支持对 [STOPPED](https://cloud.tencent.com/document/product/213/15753#InstanceStatus) 状态实例进行解绑操作。 * 强制关机场景下，先执行强制关机，再解绑密钥；如实例原状态为 [RUNNING](https://cloud.tencent.com/document/product/213/15753#InstanceStatus)，解绑完成后实例会自\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID，每次请求批量实例的上限为100。可以通过以下方式获取可用的实例ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。 通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的 `InstanceId` 获取实例ID。", "example": "[\"ins-w34e5rl9\"]", "item_type": "string" }, { "name": "KeyIds", "type": "array", "required": true, "description": "密钥对ID列表，列表长度上限为100。可以通过以下方式获取可用的密钥ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/sshkey)查询密钥ID。 通过调用接口 [DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699) ，取返回信息中的 `KeyId` 获取密钥对ID。", "example": "[\"skey-e3r6y7ji\"]", "item_type": "string" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否强制关机，默认值为 false。常规场景下，建议手动关机后解绑密钥。取值范围： true：先执行强制关机，再解绑密钥。 false：不执行强制关机，仅支持对已关机状态实例进行解绑操作。", "example": "false" } ], "required": [ "InstanceIds", "KeyIds" ] }, { "name": "DisassociateSecurityGroups", "description": "本接口 (DisassociateSecurityGroups) 用于解绑实例的指定安全组。 * 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要解绑的`安全组ID`，类似sg-efil73jd，只支持解绑单个安全组。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`SecurityGroupIds`获取实例绑定的安全组。", "example": "[\"sg-9id3l839\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "被解绑的`实例ID`，类似ins-lesecurk，支持指定多个实例，每次请求批量实例的上限为100。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "[\"ins-2zvpghhc\", \"ins-915zrb0p\"]", "item_type": "string" } ], "required": [ "SecurityGroupIds", "InstanceIds" ] }, { "name": "EnterRescueMode", "description": "本接口（EnterRescueMode）用于进入救援模式。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "需要进入救援模式的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "ins-abcdefg" }, { "name": "Password", "type": "string", "required": true, "description": "救援模式下系统密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。", "example": "hello123456789" }, { "name": "Username", "type": "string", "required": false, "description": "救援模式下系统用户名", "example": "root" }, { "name": "StopType", "type": "string", "required": false, "description": "实例的关闭模式。取值范围：SOFT_FIRST：表示在正常关闭失败后进行强制关闭HARD：直接强制关闭SOFT：仅软关机默认取值：SOFT。", "example": "HARD" } ], "required": [ "InstanceId", "Password" ] }, { "name": "ExitRescueMode", "description": "本接口（ExitRescueMode）用于退出救援模式。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "退出救援模式的实例id。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "ins-axzc12s" } ], "required": [ "InstanceId" ] }, { "name": "ExportImages", "description": "提供导出自定义镜像到指定COS存储桶的能力", "status": "online", "parameters": [ { "name": "BucketName", "type": "string", "required": true, "description": "COS存储桶名称。 可通过 [List Buckets](https://cloud.tencent.com/document/product/436/8291) 接口查询请求者名下的所有存储桶列表或特定地域下的存储桶列表。", "example": "mybucketname" }, { "name": "ImageIds", "type": "array", "required": false, "description": "镜像ID列表。调用 ExportImages 接口时，参数 ImageIds 和 SnapshotIds 为二选一必填参数，目前参数 SnapshotIds 暂未对外开放。 可通过 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) 接口返回值中的`ImageId`获取。", "example": "img-72n9mi0y", "item_type": "string" }, { "name": "ExportFormat", "type": "string", "required": false, "description": "镜像文件导出格式。取值范围：RAW，QCOW2，VHD，VMDK。默认为RAW", "example": "RAW" }, { "name": "FileNamePrefixList", "type": "array", "required": false, "description": "导出文件的名称前缀列表。 默认导出文件无名称前缀。", "example": "[\"testfilename\"]", "item_type": "string" }, { "name": "OnlyExportRootDisk", "type": "boolean", "required": false, "description": "是否只导出系统盘。 默认值：false", "example": "true" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "检测镜像是否支持导出。 默认值：false", "example": "true" }, { "name": "RoleName", "type": "string", "required": false, "description": "角色名称。默认为CVM_QcsRole，发起请求前请确认是否存在该角色，以及是否已正确配置COS写入权限。", "example": "CVM_QcsRole" } ], "required": [ "BucketName" ] }, { "name": "ImportImage", "description": "本接口(ImportImage)用于导入镜像，导入后的镜像可用于创建实例。目前支持RAW、VHD、QCOW2、VMDK镜像格式。", "status": "online", "parameters": [ { "name": "Architecture", "type": "string", "required": true, "description": "导入镜像的操作系统架构。 取值范围包括：`x86_64` 、`i386`、`arm_64`", "example": "x86_64" }, { "name": "OsType", "type": "string", "required": true, "description": "导入镜像的操作系统类型 。 可通过 [DescribeImportImageOs](https://cloud.tencent.com/document/api/213/15718) 接口返回值中的`ImportImageOsListSupported`获取。", "example": "CentOS" }, { "name": "OsVersion", "type": "string", "required": true, "description": "导入镜像的操作系统版本。 可通过 [DescribeImportImageOs](https://cloud.tencent.com/document/api/213/15718) 接口返回值中的`ImportImageOsVersionSet`获取。", "example": "6" }, { "name": "ImageUrl", "type": "string", "required": true, "description": "导入镜像存放的cos地址", "example": "http://111-1251233127.cosd.myqcloud.com/Windows%20Server%202008%20R2%20x64a.vmdk" }, { "name": "ImageName", "type": "string", "required": true, "description": "镜像名称。 最多支持 60 个字符。", "example": "sample" }, { "name": "ImageDescription", "type": "string", "required": false, "description": "镜像描述。 最多支持 256 个字符。", "example": "sampleimage" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "只检查参数，不执行任务。 默认值：false", "example": "false" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制导入，参考[强制导入镜像](https://cloud.tencent.com/document/product/213/12849) 默认值：false", "example": "false" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到自定义镜像。", "example": "[{'ResourceType': 'image', 'Tags': [{'Key': 'ServiceInstance', 'Value': 'dfs-digital-facilities-system-isc-prod'}]}]", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] }, { "name": "LicenseType", "type": "string", "required": false, "description": "导入镜像后，激活操作系统采用的许可证类型。 默认值：TencentCloud 取值范围： TencentCloud: 腾讯云官方许可 BYOL: 自带许可（Bring Your Own License）", "example": "TencentCloud" }, { "name": "BootMode", "type": "string", "required": false, "description": "启动模式。 取值范围：`Legacy BIOS`、`UEFI` 默认值：Legacy BIOS", "example": "Legacy BIOS" }, { "name": "ImageFamily", "type": "string", "required": false, "description": "镜像族", "example": "business-daily-update" }, { "name": "ImportImageDataDiskList", "type": "array", "required": false, "description": "导入的数据盘列表", "example": "[{\"ImageUrl\": \"https://user-test-1317392000.cos.ap-guangzhou.myqcloud.com/snap-xxxx.qcow2\"}]", "item_type": "object", "children": [ { "name": "ImageUrl", "type": "string", "required": true, "description": "数据盘镜像 COS 链接", "example": "https://import-img.cos.ap-guangzhou.myqcloud.com/import-img.vpc" } ] } ], "required": [ "Architecture", "OsType", "OsVersion", "ImageUrl", "ImageName" ] }, { "name": "ImportInstancesActionTimer", "description": "本接口（ImportInstancesActionTimer）用于导入定时任务", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例id列表，可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "[\"ins-37qv3ucj\"]", "item_type": "string" }, { "name": "ActionTimer", "type": "object", "required": true, "description": "定时器任务信息，目前仅支持定时销毁。", "example": "无", "children": [ { "name": "TimerAction", "type": "string", "required": false, "description": "定时器动作，目前仅支持销毁一个值：TerminateInstances。", "example": "TerminateInstances" }, { "name": "ActionTime", "type": "string", "required": false, "description": "执行时间，按照ISO8601标准表示，并且使用UTC时间。格式为 YYYY-MM-DDThh:mm:ssZ。例如 2018-05-29T11:26:40Z，执行时间必须大于当前时间5分钟。", "example": "2024-05-29T11:26:40Z" }, { "name": "Externals", "type": "object", "required": false, "description": "扩展数据。仅做出参使用。", "example": "无", "children": [ { "name": "ReleaseAddress", "type": "boolean", "required": false, "description": "释放地址", "example": "true" }, { "name": "UnsupportNetworks", "type": "array", "required": false, "description": "不支持的网络类型，取值范围：BASIC：基础网络VPC1.0：私有网络VPC1.0", "example": "VPC1.0", "item_type": "string" }, { "name": "StorageBlockAttr", "type": "object", "required": false, "description": "HDD本地存储属性", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "HDD本地存储类型，值为：LOCAL_PRO.", "example": "LOCAL_PRO" }, { "name": "MinSize", "type": "integer", "required": false, "description": "HDD本地存储的最小容量。单位：GiB。", "example": "100" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "HDD本地存储的最大容量。单位：GiB。", "example": "200" } ] } ] }, { "name": "ActionTimerId", "type": "string", "required": false, "description": "定时器ID。仅做出参使用。", "example": "57z0f8ef-8112-460f-8203-fab753580f68" }, { "name": "Status", "type": "string", "required": false, "description": "定时器状态，仅做出参使用。取值范围：UNDO：未执行 DOING：正在执行DONE：执行完成。", "example": "UNDO" }, { "name": "InstanceId", "type": "string", "required": false, "description": "定时器对应的实例ID。仅做出参使用。", "example": "ins-dpa3e3at" } ] } ], "required": [ "InstanceIds", "ActionTimer" ] }, { "name": "ImportKeyPair", "description": "本接口 (ImportKeyPair) 用于导入密钥对。 * 本接口的功能是将密钥对导入到用户账户，并不会自动绑定到实例。如需绑定可以使用[AssociateInstancesKeyPairs](https://cloud.tencent.com/document/product/213/15698)接口。 * 需指定密钥对名称以及该密钥对的公钥文本。 * 如果用户只有私钥，可以通过 `SSL` 工具将私钥转换成公钥后再导入。", "status": "online", "parameters": [ { "name": "KeyName", "type": "string", "required": true, "description": "密钥对名称，可由数字，字母和下划线组成，长度不超过25个字符。", "example": "operation_key" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "密钥对创建后所属的[项目](https://cloud.tencent.com/document/product/378/10861)ID。可以通过以下方式获取项目ID：通过[项目列表](https://console.cloud.tencent.com/project)查询项目ID。通过调用接口 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725)，取返回信息中的 `projectId ` 获取项目ID。如果是默认项目，直接填0就可以。", "example": "0" }, { "name": "PublicKey", "type": "string", "required": true, "description": "密钥对的公钥内容，`OpenSSH RSA` 格式。", "example": "ssh-rsa XXXXXXXXXXXX== skey_45071" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到密钥对。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] } ], "required": [ "KeyName", "ProjectId", "PublicKey" ] }, { "name": "InquiryPriceModifyInstancesChargeType", "description": "本接口 (InquiryPriceModifyInstancesChargeType) 用于切换实例的计费模式询价。 * 关机不收费的实例、`批量计算型BC1`和`批量计算型BS1`机型族的实例、设置定时销毁的实例、竞价实例不支持该操作。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", "example": "[\"ins-r8hr2upy\"]", "item_type": "string" }, { "name": "InstanceChargeType", "type": "string", "required": true, "description": "修改后的实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID：预付费，即包年包月。POSTPAID_BY_HOUR：后付费，即按量付费。", "example": "PREPAID" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定修改后实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "ModifyPortableDataDisk", "type": "boolean", "required": false, "description": "是否同时切换弹性数据云盘计费模式。取值范围：true：表示切换弹性数据云盘计费模式false：表示不切换弹性数据云盘计费模式默认取值：false。", "example": "false" } ], "required": [ "InstanceIds", "InstanceChargeType" ] }, { "name": "InquiryPriceRenewHosts", "description": "本接口 (InquiryPriceRenewHosts) 用于续费包年包月`CDH`实例询价。 * 只支持查询包年包月`CDH`实例的续费价格。", "status": "online", "parameters": [ { "name": "HostIds", "type": "array", "required": true, "description": "一个或多个待操作的`CDH`实例`ID`。可通过[`DescribeHosts`](https://cloud.tencent.com/document/api/213/16474)接口返回值中的`HostId`获取。每次请求批量实例的上限为100。", "example": "[\"host-xxxxxxxx\"]", "item_type": "string" }, { "name": "HostChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。如果检查不通过，则返回对应错误码；如果检查通过，则返回RequestId.false（默认）：发送正常请求，通过检查后直接创建实例", "example": "false" } ], "required": [ "HostIds", "HostChargePrepaid" ] }, { "name": "InquiryPriceRenewInstances", "description": "本接口 (InquiryPriceRenewInstances) 用于续费包年包月实例询价。 * 只支持查询包年包月实例的续费价格。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", "example": "[\"ins-2zvpghhc\"]", "item_type": "string" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "DryRun", "type": "boolean", "required": false, "description": "试运行，测试使用，不执行具体逻辑。取值范围：true：跳过执行逻辑false：执行逻辑默认取值：false。", "example": "false" }, { "name": "RenewPortableDataDisk", "type": "boolean", "required": false, "description": "是否续费弹性数据盘。取值范围：true：表示续费包年包月实例同时续费其挂载的弹性数据盘false：表示续费包年包月实例同时不再续费其挂载的弹性数据盘默认取值：true。", "example": "false" } ], "required": [ "InstanceIds", "InstanceChargePrepaid" ] }, { "name": "InquiryPriceResetInstance", "description": "本接口 (InquiryPriceResetInstance) 用于重装实例询价。 * 如果指定了`ImageId`参数，则使用指定的镜像进行重装询价；否则按照当前实例使用的镜像进行重装询价。 * 目前只支持[系统盘类型](https://cloud.tencent.com/document/api/213/15753#SystemDisk)是`CLOUD_BSSD `、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口实现`Linux`和`Windows`操作系统切换的重装询价。 * 目前不支持境外地域的实例使用该接口实\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。", "example": "ins-fd8spnmq" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的[镜像](/document/product/213/4940)ID，格式形如`img-xxx`。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID：`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1\u0026imageType=PUBLIC_IMAGE)查询；`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查询。通过调用接口 ...", "example": "img-8toqc6s3" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。系统盘为云盘的实例可以通过该参数指定重装后的系统盘大小来实现对系统盘的扩容操作，若不指定则默认系统盘大小保持不变。系统盘大小只支持扩容不支持缩容；重装只支持修改系统盘的大小，不能修改系统盘的类型。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "123456@ABC" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"skey-3glfot13\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围：true：表示保持镜像的登录设置false：表示不保持镜像的登录设置默认取值：false。", "example": "true" } ] }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：true：表示开启云安全服务false：表示不开启云安全服务默认取值：true。", "example": "false" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云监控](/document/product/248)服务。取值范围：true：表示开启云监控服务false：表示不开启云监控服务默认取值：true。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：true：表示开启云自动化助手服务false：表示不开启云自动化助手服务默认取值：false。", "example": "true" } ] } ] }, { "name": "UserData", "type": "string", "required": false, "description": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。", "example": "TXlVc2VyRGF0YQo" } ], "required": [ "InstanceId" ] }, { "name": "InquiryPriceResetInstancesInternetMaxBandwidth", "description": "本接口 (InquiryPriceResetInstancesInternetMaxBandwidth) 用于调整实例公网带宽上限询价。 * 不同机型带宽上限范围不一致，具体限制详见[公网带宽上限](https://cloud.tencent.com/document/product/213/12523)。 * 对于`BANDWIDTH_PREPAID`计费方式的带宽，目前不支持调小带宽，且需要输入参数`StartTime`和`EndTime`，指定调整后的带宽的生效时间段。在这种场景下会涉及扣费，请确保账户余额充足。可通过 [Descr...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。当调整 `BANDWIDTH_PREPAID` 和 `BANDWIDTH_POSTPAID_BY_HOUR` 计费方式的带宽时，只支持一个实例。", "example": "[\"ins-fd8spnmq\"]", "item_type": "string" }, { "name": "InternetAccessible", "type": "object", "required": true, "description": "公网出带宽配置。不同机型带宽上限范围不一致，具体限制详见带宽限制对账表。暂时只支持`InternetMaxBandwidthOut`参数。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。", "example": "BANDWIDTH_PREPAID" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。", "example": "10" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：true：表示分配公网IPfalse：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[ DescribeBandwidthPackages ](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。", "example": "bwp-h1ro" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646)。 如需为资源分配公网IPv4地址，请指定公网IPv4地址类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "WanIP" }, { "name": "IPv6AddressType", "type": "string", "required": false, "description": "弹性公网 IPv6 类型。 EIPv6：弹性公网 IPv6。 HighQualityEIPv6：精品 IPv6。仅中国香港支持精品IPv6。 如需为资源分配IPv6地址，请指定弹性公网IPv6类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "EIPv6" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" } ] }, { "name": "StartTime", "type": "string", "required": false, "description": "带宽生效的起始时间。格式：`YYYY-MM-DD`，例如：`2016-10-30`。起始时间不能早于当前时间。如果起始时间是今天则新设置的带宽立即生效。该参数只对包年包月带宽有效，其他模式带宽不支持该参数，否则接口会以相应错误码返回。", "example": "2016-10-30" }, { "name": "EndTime", "type": "string", "required": false, "description": "带宽生效的终止时间。格式：`YYYY-MM-DD`，例如：`2016-10-30`。新设置的带宽的有效期包含终止时间此日期。终止时间不能晚于包年包月实例的到期时间。实例的到期时间可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`ExpiredTime`获取。该参数只对包年包月带宽有效，其他模式带宽不支持该参数，否则接口会以相应错误码返回。", "example": "2016-11-30" } ], "required": [ "InstanceIds", "InternetAccessible" ] }, { "name": "InquiryPriceResetInstancesType", "description": "本接口 (InquiryPriceResetInstancesType) 用于调整实例的机型询价。 * 目前只支持[系统盘类型](https://cloud.tencent.com/document/product/213/15753#SystemDisk)是`CLOUD_BSSD`、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口进行调整机型询价。 * 目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口调整机型询价。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。本接口每次请求批量实例的上限为1。", "example": "[\"ins-2zvpghhc\"]", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": true, "description": "实例机型。不同实例机型指定了不同的资源规格，具体取值可参见附表[实例资源规格](https://cloud.tencent.com/document/product/213/11518)对照表，也可以调用查询[实例资源规格列表](https://cloud.tencent.com/document/product/213/15749)接口获得最新的规格表。", "example": "S5.16XLARGE256" } ], "required": [ "InstanceIds", "InstanceType" ] }, { "name": "InquiryPriceResizeInstanceDisks", "description": "本接口 (InquiryPriceResizeInstanceDisks) 用于扩容实例的数据盘询价。 * 目前只支持扩容非弹性数据盘（[DescribeDisks ](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性）询价。 * 目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口扩容数据盘询价。 * 目前只支持扩容一块数据盘询价。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待操作的实例ID。可通过[ DescribeInstances ](https://cloud.tencent.com/document/api/213/15728)接口返回值中的`InstanceId`获取。", "example": "ins-fd8spnmq" }, { "name": "DataDisks", "type": "array", "required": false, "description": "待扩容的数据盘配置信息。只支持扩容非弹性数据盘[ DescribeDisks ](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性）。数据盘容量单位：GB。最小扩容步长：10G。关于数据盘类型的选择请参考硬盘产品简介。可选数据盘类型受到实例类型`InstanceType`限制。另外允许扩容的最大容量也因数据盘类型的不同而有所差异。 您必须指定参数DataDisks与SystemDis...", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD\ufffd\ufffd...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘ID。 该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。", "example": "disk-ciezoimt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。", "example": "snap-6yczrj8x" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 `RunInstances` 接口。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD） 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1648zauv" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。", "example": "false" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "MyDiskName" } ] }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再重置用户密码。取值范围：true：表示在正常关机失败后进行强制关机false：表示在正常关机失败后不进行强制关机默认取值：false。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。", "example": "true" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "待扩容的系统盘配置信息。只支持扩容云盘。 您必须指定参数DataDisks与SystemDisk的其中一个，但不能同时指定。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "ResizeOnline", "type": "boolean", "required": false, "description": "是否在线扩容", "example": "true" } ], "required": [ "InstanceId" ] }, { "name": "InquiryPriceRunInstances", "description": "本接口(InquiryPriceRunInstances)用于创建实例询价。本接口仅允许针对购买限制范围内的实例配置进行询价, 详见：[创建实例](https://cloud.tencent.com/document/api/213/15730)。", "status": "online", "parameters": [ { "name": "Placement", "type": "object", "required": true, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。 注：如果您不指定LaunchTemplate参数，则Placement为必选参数。若同时传递Placement和LaunchTemplate，则默认覆盖LaunchTemplate中对应的Placement的值。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-4" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 `ProjectId` 字段来获取。默认取值0，表示默认项目。", "example": "0" }, { "name": "HostIds", "type": "array", "required": false, "description": "实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 的返回值中的 `HostId` 字段来获取。", "example": "[\"host-o5i742go\"]", "item_type": "string" }, { "name": "HostId", "type": "string", "required": false, "description": "实例所属的专用宿主机ID，仅用于出参。", "example": "host-o5i742go" } ] }, { "name": "ImageId", "type": "string", "required": true, "description": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-xxx`。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID：`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1\u0026imageType=PUBLIC_IMAGE)查询；`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查...", "example": "img-pmqg1cw7" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费SPOTPAID：竞价付费默认值：POSTPAID_BY_HOUR。", "example": "PREPAID" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例机型。不同实例机型指定了不同的资源规格。 对于付费模式为PREPAID或POSTPAID_BY_HOUR的实例创建，具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。若不指定该参数，则系统将根据当前地域的资源售卖情况动态指定默认机型。对于付费模式为CDHPAID的实例创\ufffd...", "example": "S5.MEDIUM2" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD\ufffd\ufffd...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘ID。 该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。", "example": "disk-ciezoimt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。", "example": "snap-6yczrj8x" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 `RunInstances` 接口。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD） 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1648zauv" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。", "example": "false" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "MyDiskName" } ] }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。若不指定该参数，则默认使用基础网络。若在此参数中指定了私有网络IP，那么InstanceCount参数只能为1。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。", "example": "BANDWIDTH_PREPAID" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。", "example": "10" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：true：表示分配公网IPfalse：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[ DescribeBandwidthPackages ](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。", "example": "bwp-h1ro" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646)。 如需为资源分配公网IPv4地址，请指定公网IPv4地址类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "WanIP" }, { "name": "IPv6AddressType", "type": "string", "required": false, "description": "弹性公网 IPv6 类型。 EIPv6：弹性公网 IPv6。 HighQualityEIPv6：精品 IPv6。仅中国香港支持精品IPv6。 如需为资源分配IPv6地址，请指定弹性公网IPv6类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "EIPv6" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" } ] }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "购买实例数量。取值范围：[1，100]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量，具体配额相关限制详见[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)。", "example": "1" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例显示名称。不指定实例显示名称则默认显示‘未命名’。购买多台实例，如果指定模式串`{R:x}`，表示生成数字`[x, x+n-1]`，其中`n`表示购买实例的数量，例如`server_{R:3}`，购买1台时，实例显示名称为`server_3`；购买2台时，实例显示名称分别为`server_3`，`server_4`。支持指定多个模式串`{R:x}`。购买多台实例，如果不指定模式串，则在实例显示名称添加后缀`1、2...n`，其中`n`表示购...", "example": "myInstance" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "123456@ABC" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"skey-3glfot13\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围：true：表示保持镜像的登录设置false：表示不保持镜像的登录设置默认取值：false。", "example": "true" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的 `SecurityGroupId` 字段来获取。若不指定该参数，则绑定指定项目下的默认安全组，如默认安全组不存在则将自动创建。", "example": "[\"sg-efil73jd\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：true：表示开启云安全服务false：表示不开启云安全服务默认取值：true。", "example": "false" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云监控](/document/product/248)服务。取值范围：true：表示开启云监控服务false：表示不开启云监控服务默认取值：true。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：true：表示开启云自动化助手服务false：表示不开启云自动化助手服务默认取值：false。", "example": "true" } ] } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "a521b4e4-c903-4d37-9de6-8096e3ad8eb7" }, { "name": "HostName", "type": "string", "required": false, "description": "云服务器的主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 30]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。", "example": "myHost" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例，当前仅支持绑定标签到云服务器实例。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数", "example": "无", "children": [ { "name": "SpotOptions", "type": "object", "required": true, "description": "竞价相关选项", "example": "0.12", "children": [ { "name": "MaxPrice", "type": "string", "required": true, "description": "竞价出价", "example": "0.01" }, { "name": "SpotInstanceType", "type": "string", "required": false, "description": "竞价请求类型，当前仅支持类型：one-time", "example": "one-time" } ] }, { "name": "MarketType", "type": "string", "required": false, "description": "市场选项类型，当前只支持取值：spot", "example": "spot" } ] }, { "name": "Metadata", "type": "object", "required": false, "description": "自定义metadata，支持创建 CVM 时添加自定义元数据键值对。 **注：内测中**。", "example": "无", "children": [ { "name": "Items", "type": "array", "required": true, "description": "自定义metadata键值对列表。", "example": "[{\"Key\": \"key\", \"Value\": \"value\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义metadata键，由大写字母（A-Z）、小写字母（a-z）、数字（0-9）、下划线（_）或连字符（-）组成，大小上限为128 字节。", "example": "\"key\"" }, { "name": "Value", "type": "string", "required": true, "description": "自定义metadata值，大小上限为256 KB。", "example": "\"value\"" } ] } ] }, { "name": "HpcClusterId", "type": "string", "required": false, "description": "高性能计算集群ID。", "example": "hpc-a5n666lo" }, { "name": "CpuTopology", "type": "object", "required": false, "description": "描述了实例CPU拓扑结构的相关信息。若不指定该参数，则按系统资源情况决定。", "example": "无", "children": [ { "name": "CoreCount", "type": "integer", "required": false, "description": "决定启用的CPU物理核心数。", "example": "4" }, { "name": "ThreadPerCore", "type": "integer", "required": false, "description": "每核心线程数。该参数决定是否开启或关闭超线程。1 表示关闭超线程 2 表示开启超线程 不设置时，实例使用默认的超线程策略。开关超线程请参考文档：[开启与关闭超线程](https://cloud.tencent.com/document/product/213/103798)。", "example": "2" } ] }, { "name": "LaunchTemplate", "type": "object", "required": false, "description": "实例启动模板。", "example": "无", "children": [ { "name": "LaunchTemplateId", "type": "string", "required": false, "description": "实例启动模板ID，通过该参数可使用实例模板中的预设参数创建实例。", "example": "lt-rf6ogz48" }, { "name": "LaunchTemplateVersion", "type": "integer", "required": false, "description": "实例启动模板版本号，若给定，新实例启动模板将基于给定的版本号创建", "example": "1" } ] } ], "required": [ "Placement", "ImageId" ] }, { "name": "InquiryPriceTerminateInstances", "description": "本接口 (InquiryPriceTerminateInstances) 用于退还实例询价。 * 查询退还实例可以返还的费用。 * 在退还包年包月实例时，使用ReleasePrepaidDataDisks参数，会在返回值中包含退还挂载的包年包月数据盘返还的费用。 * 支持批量操作，每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", "example": "[\"ins-rfmme2si\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "ModifyChcAttribute", "description": "修改CHC物理服务器的属性", "status": "online", "parameters": [ { "name": "ChcIds", "type": "array", "required": true, "description": "CHC物理服务器ID。", "example": "[\"chc-1234abcd\"]", "item_type": "string" }, { "name": "InstanceName", "type": "string", "required": false, "description": "CHC物理服务器名称", "example": "服务器名称" }, { "name": "DeviceType", "type": "string", "required": false, "description": "服务器类型", "example": "CHC_HS1" }, { "name": "BmcUser", "type": "string", "required": false, "description": "合法字符为字母,数字, 横线和下划线", "example": "albert" }, { "name": "Password", "type": "string", "required": false, "description": "密码8-16位字符, 允许数字，字母， 和特殊字符()`~!@#$%^\u0026*-+=_|{}[]:;',.?/", "example": "Test@1234" }, { "name": "BmcSecurityGroupIds", "type": "array", "required": false, "description": "bmc网络的安全组列表", "example": "[\"sg-1a2b34af\"]", "item_type": "string" } ], "required": [ "ChcIds" ] }, { "name": "ModifyDisasterRecoverGroupAttribute", "description": "本接口 (ModifyDisasterRecoverGroupAttribute)用于修改[分散置放群组](https://cloud.tencent.com/document/product/213/15486)属性。", "status": "online", "parameters": [ { "name": "DisasterRecoverGroupId", "type": "string", "required": true, "description": "分散置放群组ID，可使用[DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/api/213/17810)接口获取。", "example": "ps-58l1hu01" }, { "name": "Name", "type": "string", "required": true, "description": "分散置放群组名称，长度1-60个字符，支持中、英文。", "example": "物理机容灾组1" } ], "required": [ "DisasterRecoverGroupId", "Name" ] }, { "name": "ModifyHostsAttribute", "description": "本接口（ModifyHostsAttribute）用于修改CDH实例的属性，如实例名称和续费标记等。参数HostName和RenewFlag必须设置其中一个，但不能同时设置。", "status": "online", "parameters": [ { "name": "HostIds", "type": "array", "required": true, "description": "一个或多个待操作的CDH实例ID。", "example": "[\"host-ey16rkyg\"]", "item_type": "string" }, { "name": "HostName", "type": "string", "required": false, "description": "CDH实例显示名称。可任意命名，但不得超过60个字符。", "example": "webserver" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID。项目可以使用 [AddProject](https://cloud.tencent.com/document/api/651/81952) 接口创建。可通过 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725) 接口返回值中的`projectId`获取。后续使用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 接口查询实例时，项目ID可用于过滤结果。", "example": "0" } ], "required": [ "HostIds" ] }, { "name": "ModifyHpcClusterAttribute", "description": "修改高性能计算集群属性。", "status": "online", "parameters": [ { "name": "HpcClusterId", "type": "string", "required": true, "description": "高性能计算集群ID。集群ID可通过 [查询高性能集群信息](https://cloud.tencent.com/document/api/213/83220) 接口获取。", "example": "hpc-jtynq57p" }, { "name": "Name", "type": "string", "required": false, "description": "高性能计算集群新名称，长度限制[1-60]。", "example": "MyHpcCluster" }, { "name": "Remark", "type": "string", "required": false, "description": "高性能计算集群新备注，长度[1-256]。", "example": "myRemark" } ], "required": [ "HpcClusterId" ] }, { "name": "ModifyImageAttribute", "description": "本接口（ModifyImageAttribute）用于修改镜像属性。 * 已分享的镜像无法修改属性。", "status": "online", "parameters": [ { "name": "ImageId", "type": "string", "required": true, "description": "镜像ID，形如`img-gvbnzy6f`。镜像ID可以通过如下方式获取：通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。", "example": "img-6pb6lrmy" }, { "name": "ImageName", "type": "string", "required": false, "description": "设置新的镜像名称；必须满足下列限制 不得超过60个字符。 镜像名称不能与已有镜像重复。", "example": "sample" }, { "name": "ImageDescription", "type": "string", "required": false, "description": "设置新的镜像描述；必须满足下列限制： 不得超过 256 个字符。", "example": "sample" }, { "name": "ImageFamily", "type": "string", "required": false, "description": "设置镜像族；", "example": "business-daily-update" }, { "name": "ImageDeprecated", "type": "boolean", "required": false, "description": "设置镜像是否废弃；", "example": "false" } ], "required": [ "ImageId" ] }, { "name": "ModifyImageSharePermission", "description": "本接口（ModifyImageSharePermission）用于修改镜像共享信息。 * 共享镜像后，被共享账户可以通过该镜像创建实例。 * 每个自定义镜像最多可共享给500个账户。 * 共享镜像无法更改名称，描述，仅可用于创建实例。 * 只支持共享到对方账户相同地域。", "status": "online", "parameters": [ { "name": "ImageId", "type": "string", "required": true, "description": "镜像ID，形如`img-gvbnzy6f`。镜像Id可以通过如下方式获取：通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。 镜像ID必须指定为状态为`NORMAL`的镜像。镜像状态请参考[镜像数据表](https://cloud.tencent.com/document/product/213/15753#Image)。", "example": "img-6pb6lrmy" }, { "name": "AccountIds", "type": "array", "required": true, "description": "接收共享镜像的主账号ID列表，array型参数的格式可以参考[API简介](/document/api/213/568)。账号ID不同于QQ号，查询用户主账号ID请查看[账号信息](https://console.cloud.tencent.com/developer)中的账号ID栏。", "example": "[\"103849387508\"]", "item_type": "string" }, { "name": "Permission", "type": "string", "required": true, "description": "操作，包括 `SHARE`，`CANCEL`。其中`SHARE`代表共享操作，`CANCEL`代表取消共享操作。", "example": "SHARE" } ], "required": [ "ImageId", "AccountIds", "Permission" ] }, { "name": "ModifyInstanceDiskType", "description": "本接口 (ModifyInstanceDiskType) 用于修改实例硬盘介质类型。 * 只支持实例的本地系统盘、本地数据盘转化成指定云硬盘介质。 * 只支持实例在关机状态下转换成指定云硬盘介质。 * 不支持竞价实例类型。 * 若实例同时存在本地系统盘和本地数据盘，需同时调整系统盘和数据盘的介质类型，不支持单独针对本地系统盘或本地数据盘修改介质类型。 * 修改前请确保账户余额充足。可通...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "ins-r8hr2upy" }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息，只需要指定要转换的目标云硬盘的介质类型，指定DiskType的值，当前只支持一个数据盘转化。只支持CDHPAID类型实例指定CdcId参数。", "example": "[{\"DiskType\": \"CLOUD_PREMIUM\"}]", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD\ufffd\ufffd...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘ID。 该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。", "example": "disk-ciezoimt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。", "example": "snap-6yczrj8x" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 `RunInstances` 接口。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD） 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1648zauv" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。", "example": "false" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "MyDiskName" } ] }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息，只需要指定要转换的目标云硬盘的介质类型，指定DiskType的值。只支持CDHPAID类型实例指定CdcId参数。", "example": "{\"DiskType\": \"CLOUD_PREMIUM\"}", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] } ], "required": [ "InstanceId" ] }, { "name": "ModifyInstancesAttribute", "description": "本接口 (ModifyInstancesAttribute) 用于修改实例的属性。 * 每次请求必须指定实例的一种属性用于修改。 * “实例名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为在线支持或是进行实例管理操作的依据。 * 支持批量操作。每次请求批量实例的上限为100。 * 修改关联安全组时，子机原来关联的安全组会被解绑。 * 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent....", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。", "example": "[\"ins-rf6ogz49\"]", "item_type": "string" }, { "name": "InstanceName", "type": "string", "required": false, "description": "修改后实例名称。可任意命名，但不得超过60个字符。", "example": "MyInsName" }, { "name": "UserData", "type": "string", "required": false, "description": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526) 和 [Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。", "example": "TXlVc2VyRGF0YQo" }, { "name": "SecurityGroups", "type": "array", "required": false, "description": "指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。", "example": "[\"sg-rf6ogz49\"]", "item_type": "string" }, { "name": "CamRoleName", "type": "string", "required": false, "description": "给实例绑定用户角色，传空值为解绑操作", "example": "TKE_QCSLinkedRoleInPrometheusService" }, { "name": "HostName", "type": "string", "required": false, "description": "修改后实例的主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。注意点\ufffd...", "example": "myhostname" }, { "name": "DisableApiTermination", "type": "boolean", "required": false, "description": "实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：true：表示开启实例保护，不允许通过api接口删除实例false：表示关闭实例保护，允许通过api接口删除实例默认取值：false。", "example": "false" }, { "name": "CamRoleType", "type": "string", "required": false, "description": "角色类别，与CamRoleName搭配使用，该值可从CAM [ DescribeRoleList ](https://cloud.tencent.com/document/product/598/36223)或[ GetRole ](https://cloud.tencent.com/document/product/598/36221)接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。 举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_...", "example": "user" }, { "name": "AutoReboot", "type": "boolean", "required": false, "description": "修改实例主机名是否自动重启实例，不传默认自动重启。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。 注意点：本参数仅对修改主机名生效。", "example": "true" } ], "required": [ "InstanceIds" ] }, { "name": "ModifyInstancesChargeType", "description": "本接口 (ModifyInstancesChargeType) 用于切换实例的计费模式。 * 关机不收费的实例、`批量计算型BC1`和`批量计算型BS1`机型族的实例、设置定时销毁的实例不支持该操作。 * 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(Lates...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口返回值中的`InstanceId`获取。每次请求批量实例的上限为20。", "example": "[\"ins-r8hr2upy\"]", "item_type": "string" }, { "name": "InstanceChargeType", "type": "string", "required": true, "description": "修改后实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。 PREPAID：预付费，即包年包月。 POSTPAID_BY_HOUR：后付费，即按量付费。", "example": "PREPAID" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "修改后预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "ModifyPortableDataDisk", "type": "boolean", "required": false, "description": "是否同时切换弹性数据云盘计费模式。取值范围： true：表示切换弹性数据云盘计费模式 false：表示不切换弹性数据云盘计费模式默认取值：false。", "example": "false" } ], "required": [ "InstanceIds", "InstanceChargeType" ] }, { "name": "ModifyInstancesDisasterRecoverGroup", "description": "本接口 (ModifyInstancesDisasterRecoverGroup) 用于调整实例所在置放群组。 * 目前只支持基础网络或私有网络实例。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过[ DescribeInstances ](https://cloud.tencent.com/document/api/213/15728)接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100", "example": "[\"ins-r8hr2upy\"]", "item_type": "string" }, { "name": "DisasterRecoverGroupId", "type": "string", "required": false, "description": "分散置放群组ID，可使用[DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/api/213/17810)接口获取", "example": "ps-a66w6rlb" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制更换实例宿主机。取值范围：true：表示允许实例更换宿主机，允许重启实例。本地盘子机不支持指定此参数。false：不允许实例更换宿主机，只在当前宿主机上加入置放群组。这可能导致更换置放群组失败。默认取值：false", "example": "false" } ], "required": [ "InstanceIds" ] }, { "name": "ModifyInstancesProject", "description": "本接口 (ModifyInstancesProject) 用于修改实例所属项目。 * 项目为一个虚拟概念，用户可以在一个账户下面建立多个项目，每个项目中管理不同的资源；将多个不同实例分属到不同项目中，后续使用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口查询实例，项目ID可用于过滤结果。 * 绑定负载均衡的实例不支持修改实例所属项目，请先使用[DeregisterInstancesFromLoadBalancer](https:/...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。", "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID。项目可以使用[ AddProject ](https://cloud.tencent.com/document/api/651/81952)接口创建。可通过[ DescribeProject ](https://cloud.tencent.com/document/api/651/78725) 接口返回值中的`projectId`获取。后续使用[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口查询实例时，项目ID可用于过滤结果。", "example": "1045" } ], "required": [ "InstanceIds", "ProjectId" ] }, { "name": "ModifyInstancesRenewFlag", "description": "本接口 (ModifyInstancesRenewFlag) 用于修改包年包月实例续费标识。 * 实例被标识为自动续费后，每次在实例到期时，会自动续费一个月。 * 支持批量操作。每次请求批量实例的上限为100。 * 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。", "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "item_type": "string" }, { "name": "RenewFlag", "type": "string", "required": true, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ], "required": [ "InstanceIds", "RenewFlag" ] }, { "name": "ModifyInstancesVpcAttribute", "description": "本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性，如私有网络IP。 * 此操作默认会关闭实例，完成后再启动。 * 当指定私有网络ID和子网ID（子网必须在实例所在的可用区）与指定实例所在私有网络不一致时，会将实例迁移至指定的私有网络的子网下。执行此操作前请确保指定的实例上没有绑定[弹性网卡](https://cloud.tencent.com/document/product/576)和[负载均衡](https://cloud.tencent.com/docum...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "待操作的实例ID数组。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "item_type": "string" }, { "name": "VirtualPrivateCloud", "type": "object", "required": true, "description": "私有网络相关信息配置，通过该参数指定私有网络的ID，子网ID，私有网络ip等信息。当指定私有网络ID和子网ID（子网必须在实例所在的可用区）与指定实例所在私有网络不一致时，会将实例迁移至指定的私有网络的子网下。可通过`PrivateIpAddresses`指定私有网络子网IP，若需指定则所有已指定的实例均需要指定子网IP，此时`InstanceIds`与`PrivateIpAddresses`一一对应。不指定`PrivateIpAddres...", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否对运行中的实例选择强制关机。默认为true。", "example": "false" }, { "name": "ReserveHostName", "type": "boolean", "required": false, "description": "是否保留主机名。默认为false。", "example": "false" } ], "required": [ "InstanceIds", "VirtualPrivateCloud" ] }, { "name": "ModifyKeyPairAttribute", "description": "本接口 (ModifyKeyPairAttribute) 用于修改密钥对属性。 * 修改密钥对ID所指定的密钥对的名称和描述信息。 * 密钥对名称不能和已经存在的密钥对的名称重复。 * 密钥对ID是密钥对的唯一标识，不可修改。 * 密钥对名称和描述信息必须指定其中之一，也支持同时指定。", "status": "online", "parameters": [ { "name": "KeyId", "type": "string", "required": true, "description": "密钥对ID。可以通过以下方式获取可用的密钥 ID： 通过登录[控制台](https://console.cloud.tencent.com/cvm/sshkey)查询密钥 ID。 通过调用接口 [DescribeKeyPairs](https://cloud.tencent.com/document/api/213/9403) ，取返回信息中的 `KeyId` 获取密钥对 ID。", "example": "skey-mv9yzyjj" }, { "name": "KeyName", "type": "string", "required": false, "description": "修改后的密钥对名称，可由数字，字母和下划线组成，长度不超过25个字符。", "example": "Tencent" }, { "name": "Description", "type": "string", "required": false, "description": "修改后的密钥对描述信息。可任意命名，但不得超过60个字符。", "example": "KeyPair" } ], "required": [ "KeyId" ] }, { "name": "ModifyLaunchTemplateDefaultVersion", "description": "本接口（ModifyLaunchTemplateDefaultVersion）用于修改实例启动模板默认版本。", "status": "online", "parameters": [ { "name": "LaunchTemplateId", "type": "string", "required": true, "description": "启动模板ID。可通过 [DescribeLaunchTemplates](https://cloud.tencent.com/document/api/213/66322) 接口返回值中的`LaunchTemplateId `获取。", "example": "lt-irmer45l" }, { "name": "DefaultVersion", "type": "integer", "required": true, "description": "待设置的默认版本号。可通过 [DescribeLaunchTemplateVersions](https://cloud.tencent.com/document/api/213/66323) 接口返回值中的`LaunchTemplateVersion`获取。", "example": "2" } ], "required": [ "LaunchTemplateId", "DefaultVersion" ] }, { "name": "ProgramFpgaImage", "description": "本接口(ProgramFpgaImage)用于在线烧录由客户提供的FPGA镜像文件到指定实例的指定FPGA卡上。 * 只支持对单个实例发起在线烧录FPGA镜像的操作。 * 支持对单个实例的多块FPGA卡同时烧录FPGA镜像，DBDFs参数为空时，默认对指定实例的所有FPGA卡进行烧录。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例的ID信息。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "ins-kdjnfkda" }, { "name": "FPGAUrl", "type": "string", "required": true, "description": "FPGA镜像文件的COS URL地址。", "example": "fpga-test-123456.cos.ap-guangzhou.myqcloud.com/test.xclbin" }, { "name": "DBDFs", "type": "array", "required": false, "description": "实例上FPGA卡的DBDF号，不填默认烧录FPGA镜像到实例所拥有的所有FPGA卡。", "example": "[\"0000:00:08.0\", \"0000:00:09.0\"]", "item_type": "string" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "试运行，不会执行实际的烧录动作，默认为False。", "example": "true" } ], "required": [ "InstanceId", "FPGAUrl" ] }, { "name": "RebootInstances", "description": "本接口 (RebootInstances) 用于重启实例。 * 只有状态为`RUNNING`的实例才可以进行此操作。 * 接口调用成功时，实例会进入`REBOOTING`状态；重启实例成功时，实例会进入`RUNNING`状态。 * 支持强制重启。强制重启的效果等同于关闭物理计算机的电源开关再重新启动。强制重启可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常重启时使用。 * 支持批量操作，每次请求批量实例\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "item_type": "string" }, { "name": "StopType", "type": "string", "required": false, "description": "关机类型。取值范围：SOFT：表示软关机HARD：表示硬关机SOFT_FIRST：表示优先软关机，失败再执行硬关机默认取值：SOFT。", "example": "SOFT" } ], "required": [ "InstanceIds" ] }, { "name": "RemoveChcAssistVpc", "description": "清理CHC物理服务器的带外网络和部署网络", "status": "online", "parameters": [ { "name": "ChcIds", "type": "array", "required": true, "description": "CHC物理服务器Id。", "example": "[\"chc-2324adf5\"]", "item_type": "string" } ], "required": [ "ChcIds" ] }, { "name": "RemoveChcDeployVpc", "description": "清理CHC物理服务器的部署网络", "status": "online", "parameters": [ { "name": "ChcIds", "type": "array", "required": true, "description": "CHC物理服务器Id。", "example": "[\"chc-2324adf5\"]", "item_type": "string" } ], "required": [ "ChcIds" ] }, { "name": "RenewHosts", "description": "本接口 (RenewHosts) 用于续费包年包月CDH实例。 * 只支持操作包年包月实例，否则操作会以特定[错误码](#6.-.E9.94.99.E8.AF.AF.E7.A0.81)返回。 * 续费时请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。", "status": "online", "parameters": [ { "name": "HostIds", "type": "array", "required": true, "description": "一个或多个待操作的CDH实例ID。每次请求的CDH实例的上限为100。", "example": "[\"host-ey16rkyg\"]", "item_type": "string" }, { "name": "HostChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" } ] } ], "required": [ "HostIds", "HostChargePrepaid" ] }, { "name": "RenewInstances", "description": "本接口 (RenewInstances) 用于续费包年包月实例。 * 只支持操作包年包月实例。 * 续费时请确保账户余额充足。可通过[DescribeAccountBalance](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。 * 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", "example": "[\"ins-r8hr2upy\"]", "item_type": "string" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。 包年包月实例该参数为必传参数。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "RenewPortableDataDisk", "type": "boolean", "required": false, "description": "是否续费弹性数据盘。取值范围：true：表示续费包年包月实例同时续费其挂载的弹性数据盘false：表示续费包年包月实例同时不再续费其挂载的弹性数据盘默认取值：true。", "example": "false" } ], "required": [ "InstanceIds" ] }, { "name": "RepairTaskControl", "description": "本接口（RepairTaskControl）用于对待授权状态的维修任务进行授权操作。 - 仅当任务状态处于`待授权`状态时，可通过此接口对待授权的维修任务进行授权。 - 调用时需指定产品类型、实例ID、维修任务ID、操作类型。 - 可授权立即处理，或提前预约计划维护时间之前的指定时间进行处理（预约时间需晚于当前时间至少5分钟，且在48小时之内）。 - 针对不同类型的维修任务，提供的...", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "待授权任务实例对应的产品类型，支持取值： - `CVM`：云服务器 - `CDH`：专用宿主机 - `CPM2.0`：裸金属云服务器", "example": "CVM" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "指定待操作的实例ID列表，仅允许对列表中的实例ID相关的维修任务发起授权，可通过 [DescribeTaskInfo](https://cloud.tencent.com/document/api/213/87933) 接口返回值中的`InstanceId`获取。", "example": "[\"ins-xxxxxxx1\", \"ins-xxxxxxx2\"]", "item_type": "string" }, { "name": "TaskId", "type": "string", "required": true, "description": "指定待操作的维修任务ID，可通过 [DescribeTaskInfo](https://cloud.tencent.com/document/api/213/87933) 接口返回值中的`TaskId`获取。", "example": "rep-xxxxxxxx" }, { "name": "Operate", "type": "string", "required": true, "description": "操作类型，当前只支持传入`AuthorizeRepair`。", "example": "AuthorizeRepair" }, { "name": "OrderAuthTime", "type": "string", "required": false, "description": "预约授权时间，形如`2023-01-01 12:00:00`。预约时间需晚于当前时间至少5分钟，且在48小时之内。", "example": "2023-01-01 12:00:00" }, { "name": "TaskSubMethod", "type": "string", "required": false, "description": "附加的授权处理策略，不传或为空时，按默认授权方式进行处理。对于支持弃盘迁移授权的维修任务，当且仅当传入`LossyLocal`时，代表本次授权可允许发起弃盘迁移。 注意： 1. 指定`TaskSubMethod`为`LossyLocal`调用接口发起**弃盘迁移授权**时，本地盘实例的**所有本地盘数据都会清空**，相当于**重新部署本地盘实例**。 2. 对于非本地盘实例，或不支持弃盘迁移选项的任务，指定`Task...", "example": "NA" } ], "required": [ "Product", "InstanceIds", "TaskId", "Operate" ] }, { "name": "ResetInstance", "description": "本接口 (ResetInstance) 用于重装指定实例上的操作系统。 * 如果指定了`ImageId`参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。 * 系统盘将会被格式化，并重置；请确保系统盘中无重要文件。 * 密码不指定将会通过站内信下发随机密码。 * 目前只支持[系统盘类型](https://cloud.tencent.com/document/api/213/9452#SystemDisk)是`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`、`CLOUD_BSSD`类\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。", "example": "ins-r8hr2upy" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-xxx`。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID：`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1\u0026imageType=PUBLIC_IMAGE)查询；`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查...", "example": "img-pmqg1cw7" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。系统盘为云盘的实例可以通过该参数指定重装后的系统盘大小来实现对系统盘的扩容操作。系统盘大小只支持扩容不支持缩容；重装只支持修改系统盘的大小，不能修改系统盘的类型。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "123456@ABC" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"skey-3glfot13\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围：true：表示保持镜像的登录设置false：表示不保持镜像的登录设置默认取值：false。", "example": "true" } ] }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认公共镜像开启云监控、云安全服务；自定义镜像与镜像市场镜像默认不开启云监控，云安全服务，而使用镜像里保留的服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：true：表示开启云安全服务false：表示不开启云安全服务默认取值：true。", "example": "false" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云监控](/document/product/248)服务。取值范围：true：表示开启云监控服务false：表示不开启云监控服务默认取值：true。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：true：表示开启云自动化助手服务false：表示不开启云自动化助手服务默认取值：false。", "example": "true" } ] } ] }, { "name": "HostName", "type": "string", "required": false, "description": "重装系统时，可以指定修改实例的主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横\ufffd\ufffd...", "example": "myHost" }, { "name": "UserData", "type": "string", "required": false, "description": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。", "example": "TXlVc2VyRGF0YQo" } ], "required": [ "InstanceId" ] }, { "name": "ResetInstancesInternetMaxBandwidth", "description": "本接口 (ResetInstancesInternetMaxBandwidth) 用于调整实例公网带宽上限。 * 不同机型带宽上限范围不一致，具体限制详见[公网带宽上限](https://cloud.tencent.com/document/product/213/12523)。 * 对于 `BANDWIDTH_PREPAID` 计费方式的带宽，需要输入参数 `StartTime` 和 `EndTime` ，指定调整后的带宽的生效时间段。在这种场景下目前不支持调小带宽，会涉及扣费，请确保账户余额充足。可通过 [DescribeAccountBalan...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/9388)接口返回值中的 `InstanceId` 获取。 每次请求批量实例的上限为100。当调整 `BANDWIDTH_PREPAID` 和 `BANDWIDTH_POSTPAID_BY_HOUR` 计费方式的带宽时，只支持一个实例。", "example": "[\"ins-r8hr2upy\"]", "item_type": "string" }, { "name": "InternetAccessible", "type": "object", "required": true, "description": "公网出带宽配置。不同机型带宽上限范围不一致，具体限制详见带宽限制对账表。暂时只支持 `InternetMaxBandwidthOut` 参数。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。", "example": "BANDWIDTH_PREPAID" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。", "example": "10" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：true：表示分配公网IPfalse：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[ DescribeBandwidthPackages ](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。", "example": "bwp-h1ro" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646)。 如需为资源分配公网IPv4地址，请指定公网IPv4地址类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "WanIP" }, { "name": "IPv6AddressType", "type": "string", "required": false, "description": "弹性公网 IPv6 类型。 EIPv6：弹性公网 IPv6。 HighQualityEIPv6：精品 IPv6。仅中国香港支持精品IPv6。 如需为资源分配IPv6地址，请指定弹性公网IPv6类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "EIPv6" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" } ] }, { "name": "StartTime", "type": "string", "required": false, "description": "带宽生效的起始时间。格式：`YYYY-MM-DD`，例如：`2016-10-30`。起始时间不能早于当前时间。如果起始时间是今天则新设置的带宽立即生效。该参数只对包年包月带宽有效，其他模式带宽不支持该参数，否则接口会以相应错误码返回。", "example": "2017-03-15" }, { "name": "EndTime", "type": "string", "required": false, "description": "带宽生效的终止时间。格式： `YYYY-MM-DD` ，例如：`2016-10-30` 。新设置的带宽的有效期包含终止时间此日期。终止时间不能晚于包年包月实例的到期时间。实例的到期时间可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/9388)接口返回值中的`ExpiredTime`获取。该参数只对包年包月带宽有效，其他模式带宽不支持该参数，否则接口会以相应错误码返回。", "example": "2017-03-16" } ], "required": [ "InstanceIds", "InternetAccessible" ] }, { "name": "ResetInstancesPassword", "description": "本接口 (ResetInstancesPassword) 用于将实例操作系统的密码重置为用户指定的密码。 *如果是修改系统管理员密码：实例的操作系统不同，管理员账号也会不一样(`Windows`为`Administrator`，`Ubuntu`为`ubuntu`，其它系统为`root`)。 * 重置处于运行中状态的实例密码，需要设置关机参数`ForceStop`为`TRUE`。如果没有显式指定强制关机参数，则只有处于关机状态的实例才允许执行重置密码操作。 * \ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。", "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "item_type": "string" }, { "name": "Password", "type": "string", "required": true, "description": "重置后的实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux 实例密码必须8-30位，推荐使用12位以上密码，不能以“/”开头，至少包含以下字符中的三种不同字符，字符种类：小写字母：[a-z]大写字母：[A-Z]数字：0-9特殊字符： ()\\`\\~!@#$%^\u0026\\*-+=\\_|{}[]:;',.?/Windows 实例密码必须12\\~30位，不能以“/”开头且不包括用户名，至少包含以下字符中的三种不同字符小写...", "example": "abc123ABC!@#" }, { "name": "UserName", "type": "string", "required": false, "description": "待重置密码的实例操作系统的用户名。不得超过64个字符。", "example": "asdc21" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再重置用户密码。取值范围：true：表示在正常关机失败后进行强制关机false：表示在正常关机失败后不进行强制关机默认取值：false。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。", "example": "true" } ], "required": [ "InstanceIds", "Password" ] }, { "name": "ResetInstancesType", "description": "本接口 (ResetInstancesType) 用于调整实例的机型。 * 目前只支持[系统盘类型](/document/api/213/9452#block_device)是CLOUD_BASIC、CLOUD_PREMIUM、CLOUD_SSD、CLOUD_BSSD类型的实例使用该接口进行机型调整。 * 目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口调整机型。对于包年包月实例，使用该接口会涉及扣费，请确保账户余额充足。可通过[DescribeAccountBalance](https://cloud.tencent.com/docu...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。本接口目前仅支持每次操作1个实例。", "example": "[\"ins-r8hr2upy\"]", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": true, "description": "调整后的实例机型。不同实例机型指定了不同的资源规格，具体取值可通过调用接口[ DescribeInstanceTypeConfigs ](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例类型](https://cloud.tencent.com/document/product/213/11518)描述。", "example": "S5.16XLARGE256" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机。取值范围：true：表示在正常关机失败后进行强制关机false：表示在正常关机失败后不进行强制关机默认取值：false。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。", "example": "false" } ], "required": [ "InstanceIds", "InstanceType" ] }, { "name": "ResizeInstanceDisks", "description": "本接口 (ResizeInstanceDisks) 用于扩容实例的磁盘。 * 目前只支持扩容非弹性盘（[ DescribeDisks ](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性）。 * 对于包年包月实例，使用该接口会涉及扣费，请确保账户余额充足。可通过[ DescribeAccountBalance ](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。 * 目前只支持扩容一块数据盘。 * 默认扩容方\ufffd...", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待操作的实例ID。可通过[ DescribeInstances ](https://cloud.tencent.com/document/api/213/15728)接口返回值中的`InstanceId`获取。", "example": "ins-r8hr2upy" }, { "name": "DataDisks", "type": "array", "required": false, "description": "待扩容的数据盘配置信息，仅支持指定待扩容盘的目的容量。只支持扩容非弹性数据盘（[ DescribeDisks ](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性）。数据盘容量单位：GiB。最小扩容步长：10GiB。关于数据盘类型的选择请参考[硬盘产品简介](https://cloud.tencent.com/document/product/362/2353)。可选数据盘类型受到实例类型`InstanceType`限制。另外允许扩容...", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD\ufffd\ufffd...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘ID。 该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。", "example": "disk-ciezoimt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。", "example": "snap-6yczrj8x" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 `RunInstances` 接口。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD） 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1648zauv" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。", "example": "false" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "MyDiskName" } ] }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再扩容实例磁盘。取值范围：true：表示在正常关机失败后进行强制关机false：表示在正常关机失败后不进行强制关机默认取值：false。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。", "example": "true" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "待扩容的系统盘配置信息，仅支持指定待扩容盘的目的容量。只支持扩容云盘。 您必须指定参数DataDisks与SystemDisk的其中一个，但不能同时指定。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "ResizeOnline", "type": "boolean", "required": false, "description": "扩容云盘的方式是否为在线扩容。", "example": "true" } ], "required": [ "InstanceId" ] }, { "name": "RunInstances", "description": "本接口 (RunInstances) 用于创建一个或多个指定配置的实例。 * 实例创建成功后将自动开机启动，[实例状态](https://cloud.tencent.com/document/product/213/15753#InstanceStatus)变为“运行中”。 * 预付费实例的购买会预先扣除本次实例购买所需金额，按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额，在调用本接口前请确保账户余额充足。 * 调用本接口创建实例，支持代金券自\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceChargeType", "type": "string", "required": false, "description": "实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费CDHPAID：独享子机（基于专用宿主机创建，宿主机部分的资源不收费）SPOTPAID：竞价付费CDCPAID：专用集群付费默认值：POSTPAID_BY_HOUR。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。", "example": "DISABLE_NOTIFY_AND_MANUAL_RENEW" } ] }, { "name": "Placement", "type": "object", "required": false, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，所属宿主机（在专用宿主机上创建子机时指定）等属性。 注：如果您不指定LaunchTemplate参数，则Placement为必选参数。若同时传递Placement和LaunchTemplate，则默认覆盖LaunchTemplate中对应的Placement的值。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "ap-guangzhou-4" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 `ProjectId` 字段来获取。默认取值0，表示默认项目。", "example": "0" }, { "name": "HostIds", "type": "array", "required": false, "description": "实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 的返回值中的 `HostId` 字段来获取。", "example": "[\"host-o5i742go\"]", "item_type": "string" }, { "name": "HostId", "type": "string", "required": false, "description": "实例所属的专用宿主机ID，仅用于出参。", "example": "host-o5i742go" } ] }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例机型。不同实例机型指定了不同的资源规格。 对于付费模式为PREPAID或POSTPAID\\_BY\\_HOUR的实例创建，具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。若不指定该参数，则系统将根据当前地域的资源售卖情况动态指定默认机型。对于付费模式为CDHPAID的实例\ufffd\ufffd...", "example": "S5.LARGE4" }, { "name": "ImageId", "type": "string", "required": false, "description": "指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID，格式形如`img-xxx`。镜像类型分为四种：公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID：`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1\u0026imageType=PUBLIC_IMAGE)查询；`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查...", "example": "img-irmer45l" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD云硬盘 CLOUD_PREMIUM：高性能云硬盘 CLOUD_BSSD：通用型SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘 默认取值：当前有库存的硬盘类型。", "example": "CLOUD_HSSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "系统盘ID。 该参数目前仅用于 [DescribeInstances](https://cloud.tencent.com/document/product/213/15728) 等查询类接口的返回参数，不可用于 [RunInstances](https://cloud.tencent.com/document/product/213/15730) 等写接口的入参。", "example": "disk-xyzw1a3x" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GiB。默认值为 50", "example": "50" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-xxxxxx" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "name" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "实例数据盘配置信息。若不指定该参数，则默认不购买数据盘。支持购买的时候指定21块数据盘，其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘，最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小，单位：GiB。最小调整步长为10GiB，不同数据盘类型取值范围不同，具体限制详见：[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0，表示不购买数据盘。更多限制详见产品文档。", "example": "50" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围：LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地SSD硬盘LOCAL_NVME：本地NVME硬盘，与InstanceType强相关，不支持指定LOCAL_PRO：本地HDD硬盘，与InstanceType强相关，不支持指定CLOUD_BASIC：普通云硬盘 CLOUD_PREMIUM：高性能云硬盘CLOUD_SSD：SSD云硬盘 CLOUD_HSSD：增强型SSD云硬盘 CLOUD_TSSD：极速型SSD云硬盘CLOUD_BSSD\ufffd\ufffd...", "example": "CLOUD_SSD" }, { "name": "DiskId", "type": "string", "required": false, "description": "数据盘ID。 该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。", "example": "disk-ciezoimt" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "数据盘是否随子机销毁。取值范围：true：子机销毁时，销毁数据盘，只支持按小时后付费云盘false：子机销毁时，保留数据盘默认取值：true 该参数目前仅用于 `RunInstances` 接口。", "example": "true" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。", "example": "snap-6yczrj8x" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "数据盘是否加密。取值范围：true：加密false：不加密默认取值：false该参数目前仅用于 `RunInstances` 接口。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "自定义CMK对应的ID，取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 `RunInstances` 接口。 注意：此字段可能返回 null，表示取不到有效值。", "example": "kms-abcd1234" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "云硬盘性能，单位：MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD） 注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "CdcId", "type": "string", "required": false, "description": "所属的独享集群ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "cdc-1648zauv" }, { "name": "BurstPerformance", "type": "boolean", "required": false, "description": "突发性能 注：内测中。", "example": "false" }, { "name": "DiskName", "type": "string", "required": false, "description": "磁盘名称，长度不超过128 个字符。", "example": "MyDiskName" } ] }, { "name": "VirtualPrivateCloud", "type": "object", "required": false, "description": "私有网络相关信息配置。通过该参数可以指定私有网络的ID，子网ID等信息。若在此参数中指定了私有网络IP，即表示每个实例的主网卡IP；同时，InstanceCount参数必须与私有网络IP的个数一致且不能大于20。", "example": "无", "children": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID，形如`vpc-xxx`。有效的VpcId可通过登录[控制台](https://console.cloud.tencent.com/vpc/vpc?rid=1)查询；也可以调用接口 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) ，从接口返回中的`VpcId `字段获取。若在创建子机时VpcId与SubnetId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "vpc-2ij" }, { "name": "SubnetId", "type": "string", "required": true, "description": "私有网络子网ID，形如`subnet-xxx`。有效的私有网络子网ID可通过登录[控制台](https://console.cloud.tencent.com/vpc/subnet?rid=1)查询；也可以调用接口 [DescribeSubnets](https://cloud.tencent.com/document/product/215/15784) ，从接口返回中的`SubnetId `字段获取。若在创建子机时SubnetId与VpcId同时传入`DEFAULT`，则强制使用默认vpc网络。", "example": "subnet-2ks" }, { "name": "AsVpcGateway", "type": "boolean", "required": false, "description": "是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true：表示用作公网网关false：表示不作为公网网关默认取值：false。", "example": "false" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。", "example": "[\"10.0.0.1\"]", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的 IPv6 地址数量。", "example": "1" } ] }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "公网带宽相关信息设置。若不指定该参数，则默认公网带宽为0Mbps。", "example": "无", "children": [ { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费类型。取值范围：BANDWIDTH_PREPAID：预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费BANDWIDTH_PACKAGE：带宽包用户默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。", "example": "BANDWIDTH_PREPAID" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。", "example": "10" }, { "name": "PublicIpAssigned", "type": "boolean", "required": false, "description": "是否分配公网IP。取值范围：true：表示分配公网IPfalse：表示不分配公网IP当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。", "example": "false" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包ID。可通过[ DescribeBandwidthPackages ](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。", "example": "bwp-h1ro" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "线路类型。各种线路类型及支持地区详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值： CMCC：中国移动 CTCC：中国电信 CUCC：中国联通 注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "IPv4AddressType", "type": "string", "required": false, "description": "公网 IP 类型。 WanIP：普通公网IP。 HighQualityEIP：精品 IP。仅新加坡和中国香港支持精品IP。 AntiDDoSEIP：高防 IP。仅部分地域支持高防IP，详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646)。 如需为资源分配公网IPv4地址，请指定公网IPv4地址类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "WanIP" }, { "name": "IPv6AddressType", "type": "string", "required": false, "description": "弹性公网 IPv6 类型。 EIPv6：弹性公网 IPv6。 HighQualityEIPv6：精品 IPv6。仅中国香港支持精品IPv6。 如需为资源分配IPv6地址，请指定弹性公网IPv6类型。 此功能仅部分地区灰度开放，如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category)", "example": "EIPv6" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包唯一ID，申请高防IP时，该字段必传。", "example": "bgp-00000000" } ] }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "购买实例数量。包年包月实例取值范围：[1，500]，按量计费实例取值范围：[1，500]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量，具体配额相关限制详见[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)。", "example": "1" }, { "name": "MinCount", "type": "integer", "required": false, "description": "指定创建实例的最小数量，取值范围为不大于InstanceCount的正整数。 指定最小数量时，承诺最少创建MinCount台实例，并尽量创建InstanceCount台实例。 库存不足以满足最小数量时，API 会返回库存不足最小数量的错误信息。 仅对支持部分发货的账号、区域和计费模式（包年包月、按量计费、竞价实例、按量包销）生效。", "example": "1" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例显示名称。不指定实例显示名称则默认显示‘未命名’。最多支持128个字符（含模式串）。购买多台实例时： - 指定模式串 {R:x}：表示生成数字序列 [x, x+n-1]，其中 n为购买实例的数量。例如：输入 server_{R:3}，购买1台时，实例显示名称为 server_3；购买2台时，实例显示名称分别为 server_3、server_4。 - 指定模式串 {R:x,F:y}：y表示固定位数（可选），取值范围为 [0,8]，默认值 0表\ufffd...", "example": "server_{R:3}、server_{R:3,F:3}" }, { "name": "LoginSettings", "type": "object", "required": false, "description": "实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。", "example": "无", "children": [ { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) \\` ~ ! @ # $ % ^ \u0026 * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到\ufffd...", "example": "123456@ABC" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"skey-3glfot13\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围：true：表示保持镜像的登录设置false：表示不保持镜像的登录设置默认取值：false。", "example": "true" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的 `SecurityGroupId` 字段来获取。若不指定该参数，则绑定指定项目下的默认安全组，如默认安全组不存在则将自动创建。", "example": "[\"sg-ajhn9qtq\"]", "item_type": "string" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认公共镜像开启云监控、云安全服务；自定义镜像与镜像市场镜像默认不开启云监控，云安全服务，而使用镜像里保留的服务。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "开启云安全服务。若不指定该参数，则默认开启云安全服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云安全](/document/product/296)服务。取值范围：true：表示开启云安全服务false：表示不开启云安全服务默认取值：true。", "example": "false" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "开启云监控服务。若不指定该参数，则默认开启云监控服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启[云监控](/document/product/248)服务。取值范围：true：表示开启云监控服务false：表示不开启云监控服务默认取值：true。", "example": "true" } ] }, { "name": "AutomationService", "type": "object", "required": false, "description": "开启云自动化助手服务（TencentCloud Automation Tools，TAT）。若不指定该参数，则公共镜像默认开启云自动化助手服务，其他镜像默认不开启云自动化助手服务。", "example": "true", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启云自动化助手。取值范围：true：表示开启云自动化助手服务false：表示不开启云自动化助手服务默认取值：false。", "example": "true" } ] } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "system-f3827db9-c58a-49cc-bf10-33fc1923a34a" }, { "name": "HostName", "type": "string", "required": false, "description": "实例主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。Windows 实例：主机名名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。购买多台实例\ufffd...", "example": "MyHostName" }, { "name": "ActionTimer", "type": "object", "required": false, "description": "定时任务。通过该参数可以为实例指定定时任务，目前仅支持定时销毁。", "example": "无", "children": [ { "name": "TimerAction", "type": "string", "required": false, "description": "定时器动作，目前仅支持销毁一个值：TerminateInstances。", "example": "TerminateInstances" }, { "name": "ActionTime", "type": "string", "required": false, "description": "执行时间，按照ISO8601标准表示，并且使用UTC时间。格式为 YYYY-MM-DDThh:mm:ssZ。例如 2018-05-29T11:26:40Z，执行时间必须大于当前时间5分钟。", "example": "2024-05-29T11:26:40Z" }, { "name": "Externals", "type": "object", "required": false, "description": "扩展数据。仅做出参使用。", "example": "无", "children": [ { "name": "ReleaseAddress", "type": "boolean", "required": false, "description": "释放地址", "example": "true" }, { "name": "UnsupportNetworks", "type": "array", "required": false, "description": "不支持的网络类型，取值范围：BASIC：基础网络VPC1.0：私有网络VPC1.0", "example": "VPC1.0", "item_type": "string" }, { "name": "StorageBlockAttr", "type": "object", "required": false, "description": "HDD本地存储属性", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "HDD本地存储类型，值为：LOCAL_PRO.", "example": "LOCAL_PRO" }, { "name": "MinSize", "type": "integer", "required": false, "description": "HDD本地存储的最小容量。单位：GiB。", "example": "100" }, { "name": "MaxSize", "type": "integer", "required": false, "description": "HDD本地存储的最大容量。单位：GiB。", "example": "200" } ] } ] }, { "name": "ActionTimerId", "type": "string", "required": false, "description": "定时器ID。仅做出参使用。", "example": "57z0f8ef-8112-460f-8203-fab753580f68" }, { "name": "Status", "type": "string", "required": false, "description": "定时器状态，仅做出参使用。取值范围：UNDO：未执行 DOING：正在执行DONE：执行完成。", "example": "UNDO" }, { "name": "InstanceId", "type": "string", "required": false, "description": "定时器对应的实例ID。仅做出参使用。", "example": "ins-dpa3e3at" } ] }, { "name": "DisasterRecoverGroupIds", "type": "array", "required": false, "description": "置放群组id，仅支持指定一个。", "example": "[\"sg-efil73jd\"]", "item_type": "string" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签描述列表。通过指定该参数可以同时绑定标签到相应的云服务器、云硬盘实例。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "标签绑定的资源类型，云服务器为“instance”，专用宿主机为“host”，镜像为“image”，密钥为“keypair”，置放群组为“ps”，高性能计算集群为“hpc”。", "example": "instance" }, { "name": "Tags", "type": "array", "required": true, "description": "标签对列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "myKey" }, { "name": "Value", "type": "string", "required": true, "description": "标签值", "example": "myValue" } ] } ] }, { "name": "InstanceMarketOptions", "type": "object", "required": false, "description": "实例的市场相关选项，如竞价实例相关参数，若指定实例的付费模式为竞价付费但没有传递该参数时，默认按当前固定折扣价格出价。", "example": "无", "children": [ { "name": "SpotOptions", "type": "object", "required": true, "description": "竞价相关选项", "example": "0.12", "children": [ { "name": "MaxPrice", "type": "string", "required": true, "description": "竞价出价", "example": "0.01" }, { "name": "SpotInstanceType", "type": "string", "required": false, "description": "竞价请求类型，当前仅支持类型：one-time", "example": "one-time" } ] }, { "name": "MarketType", "type": "string", "required": false, "description": "市场选项类型，当前只支持取值：spot", "example": "spot" } ] }, { "name": "UserData", "type": "string", "required": false, "description": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB。关于获取此参数的详细介绍，请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。", "example": "TXlVc2VyRGF0YQo=" }, { "name": "Metadata", "type": "object", "required": false, "description": "自定义metadata，支持创建 CVM 时添加自定义元数据键值对。 **注：内测中**。", "example": "无", "children": [ { "name": "Items", "type": "array", "required": true, "description": "自定义metadata键值对列表。", "example": "[{\"Key\": \"key\", \"Value\": \"value\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "自定义metadata键，由大写字母（A-Z）、小写字母（a-z）、数字（0-9）、下划线（_）或连字符（-）组成，大小上限为128 字节。", "example": "\"key\"" }, { "name": "Value", "type": "string", "required": true, "description": "自定义metadata值，大小上限为256 KB。", "example": "\"value\"" } ] } ] }, { "name": "DryRun", "type": "boolean", "required": false, "description": "是否只预检此次请求。 true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。 如果检查不通过，则返回对应错误码； 如果检查通过，则返回RequestId. false（默认）：发送正常请求，通过检查后直接创建实例", "example": "false" }, { "name": "CpuTopology", "type": "object", "required": false, "description": "描述了实例CPU拓扑结构的相关信息。若不指定该参数，则按系统资源情况决定。", "example": "无", "children": [ { "name": "CoreCount", "type": "integer", "required": false, "description": "决定启用的CPU物理核心数。", "example": "4" }, { "name": "ThreadPerCore", "type": "integer", "required": false, "description": "每核心线程数。该参数决定是否开启或关闭超线程。1 表示关闭超线程 2 表示开启超线程 不设置时，实例使用默认的超线程策略。开关超线程请参考文档：[开启与关闭超线程](https://cloud.tencent.com/document/product/213/103798)。", "example": "2" } ] }, { "name": "CamRoleName", "type": "string", "required": false, "description": "CAM角色名称。可通过[ DescribeRoleList ](https://cloud.tencent.com/document/product/598/36223)接口返回值中的`RoleName `获取。", "example": "testroleName001" }, { "name": "HpcClusterId", "type": "string", "required": false, "description": "高性能计算集群ID。若创建的实例为高性能计算实例，需指定实例放置的集群，否则不可指定。", "example": "hpc-a5n666lo" }, { "name": "LaunchTemplate", "type": "object", "required": false, "description": "实例启动模板。", "example": "无", "children": [ { "name": "LaunchTemplateId", "type": "string", "required": false, "description": "实例启动模板ID，通过该参数可使用实例模板中的预设参数创建实例。", "example": "lt-rf6ogz48" }, { "name": "LaunchTemplateVersion", "type": "integer", "required": false, "description": "实例启动模板版本号，若给定，新实例启动模板将基于给定的版本号创建", "example": "1" } ] }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "指定专用集群创建。", "example": "cluster-gbo27yc4" }, { "name": "ChcIds", "type": "array", "required": false, "description": "指定CHC物理服务器来创建CHC云主机。", "example": "[\"chc-kwf9mhzf\"]", "item_type": "string" }, { "name": "DisableApiTermination", "type": "boolean", "required": false, "description": "实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：true：表示开启实例保护，不允许通过api接口删除实例false：表示关闭实例保护，允许通过api接口删除实例默认取值：false。", "example": "false" }, { "name": "EnableJumboFrame", "type": "boolean", "required": false, "description": "实例是否开启巨型帧，取值范围： true：表示实例开启巨型帧，只有支持巨型帧的机型可设置为true。false：表示实例关闭巨型帧，只有支持巨型帧的机型可设置为false。 支持巨型帧的实例规格： [实例规格](https://cloud.tencent.com/document/product/213/11518)", "example": "false" } ], "required": [] }, { "name": "StartInstances", "description": "本接口 (StartInstances) 用于启动一个或多个实例。 * 只有状态为`STOPPED`的实例才可以进行此操作。 * 接口调用成功时，实例会进入`STARTING`状态；启动实例成功时，实例会进入`RUNNING`状态。 * 支持批量操作。每次请求批量实例的上限为100。 * 本接口为异步接口，启动实例请求发送成功后会返回一个RequestId，此时操作并未立即完成。实例操作结果可以通过调用 [DescribeInstances](https://cl...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "StopInstances", "description": "本接口 (StopInstances) 用于关闭一个或多个实例。 * 只有状态为`RUNNING`的实例才可以进行此操作。 * 接口调用成功时，实例会进入`STOPPING`状态；关闭实例成功时，实例会进入`STOPPED`状态。 * 支持强制关闭。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。 * 支持批量操作。每次请求批量实例的\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", "example": "[\"ins-r8hr2upy\",\"ins-5d8a23rs\"]", "item_type": "string" }, { "name": "StopType", "type": "string", "required": false, "description": "实例的关闭模式。取值范围：SOFT_FIRST：表示在正常关闭失败后进行强制关闭HARD：直接强制关闭SOFT：仅软关机默认取值：SOFT。", "example": "SOFT" }, { "name": "StoppedMode", "type": "string", "required": false, "description": "按量计费实例关机收费模式。 取值范围：KEEP_CHARGING：关机继续收费STOP_CHARGING：关机停止收费默认取值：KEEP_CHARGING。 该参数只针对部分按量计费实例生效，详情参考[按量计费实例关机不收费说明](https://cloud.tencent.com/document/product/213/19918)", "example": "KEEP_CHARGING" } ], "required": [ "InstanceIds" ] }, { "name": "SyncImages", "description": "本接口（SyncImages）用于将自定义镜像同步到其它地区。 * 该接口每次调用只支持同步一个镜像。 * 该接口支持自定义镜像向多个地域同步。 * 共享镜像仅支持同步为源地域（单个）的自定义镜像。 * 自定义镜像仅支持同步为源地域（单个）的加密自定义镜像。 * 单个账号在每个地域最多支持存在500个自定义镜像。", "status": "online", "parameters": [ { "name": "ImageIds", "type": "array", "required": true, "description": "镜像ID列表 ，镜像ID可以通过如下方式获取：通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取，镜像ID对应的镜像状态必须为`NORMAL`。通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。", "example": "[\"img-o3ycss2p\"]", "item_type": "string" }, { "name": "DestinationRegions", "type": "array", "required": true, "description": "目的同步地域列表，必须满足如下限制：必须是一个合法的Region。如果是自定义镜像，则目标同步地域不能为源地域。如果是共享镜像，则目的同步地域仅支持源地域，表示将共享镜像复制为源地域的自定义镜像。如果是自定义镜像复制为加密自定义镜像，则目的同步地域仅支持源地域，表示将自定义镜像复制为源地域的加密自定义镜像。暂不支持部分地域同步，请参考[复制\ufffd...", "example": "[\"ap-guangzhou\"]", "item_type": "string" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "检测是否支持发起同步镜像。 默认值: false", "example": "false" }, { "name": "ImageName", "type": "string", "required": false, "description": "目标镜像名称。默认使用源镜像名称。 最多支持 60 个字符。", "example": "“test_image”" }, { "name": "ImageSetRequired", "type": "boolean", "required": false, "description": "是否需要返回目的地域的镜像ID。 默认值: false", "example": "false" }, { "name": "Encrypt", "type": "boolean", "required": false, "description": "是否复制为加密自定义镜像。 默认值为 false。 复制加密自定义镜像仅支持同地域， 即 DestinationRegions 仅支持填写指定镜像所在地域。", "example": "false" }, { "name": "KmsKeyId", "type": "string", "required": false, "description": "加密自定义镜像使用的 KMS 密钥 ID。 仅当复制加密镜像时，即 Encrypt 为 true 时，此参数有效； 不指定 KmsKeyId，默认使用 CBS 云产品 KMS 密钥。 KMS 密钥 ID 通过[KMS 控制台](https://console.cloud.tencent.com/kms2)获取。", "example": "2bb53791-c2e9-4c42-8772-ecf135a1d92x" } ], "required": [ "ImageIds", "DestinationRegions" ] }, { "name": "TerminateInstances", "description": "本接口 (TerminateInstances) 用于主动退还实例。 * 不再使用的实例，可通过本接口主动退还。 * 按量计费的实例通过本接口可直接退还；包年包月实例如符合[退还规则](https://cloud.tencent.com/document/product/213/9711)，也可通过本接口主动退还。 * 包年包月实例首次调用本接口，实例将被移至回收站，再次调用本接口，实例将被销毁，且不可恢复。按量计费实例调用本接口将被直接销毁。...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。", "example": "['ins-2pajzo4q']", "item_type": "string" }, { "name": "ReleaseAddress", "type": "boolean", "required": false, "description": "释放弹性IP。EIP2.0下，仅提供主网卡下首个EIP，EIP类型限定在HighQualityEIP、AntiDDoSEIP、EIPv6、HighQualityEIPv6这几种类型。默认行为不释放。 示例值：true 默认值：false", "example": "true" }, { "name": "ReleasePrepaidDataDisks", "type": "boolean", "required": false, "description": "释放实例挂载的包年包月数据盘。true表示销毁实例同时释放包年包月数据盘，false表示只销毁实例。 默认值：false", "example": "true" } ], "required": [ "InstanceIds" ] } ] }