tencentcloud-sdk-nodejs

/** * InquiryPriceTerminateInstances返回参数结构体 */ export interface InquiryPriceTerminateInstancesResponse { /** * 退款详情。 */ InstanceRefundsSet?: Array<InstanceRefund>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 本地磁盘规格 */ export interface LocalDiskType { /** * 本地磁盘类型。 */ Type?: string; /** * 本地磁盘属性。 */ PartitionType?: string; /** * 本地磁盘最小值。 */ MinSize?: number; /** * 本地磁盘最大值。 */ MaxSize?: number; /** * 购买时本地盘是否为必选。取值范围： <li>REQUIRED：表示必选</li><li>OPTIONAL：表示可选。</li> */ Required?: string; } /** * AssociateInstancesKeyPairs返回参数结构体 */ export interface AssociateInstancesKeyPairsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyChcAttribute返回参数结构体 */ export interface ModifyChcAttributeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeHpcClusters请求参数结构体 */ export interface DescribeHpcClustersRequest { /** * 高性能计算集群ID数组。 */ HpcClusterIds?: Array<string>; /** * 高性能计算集群名称。 */ Name?: string; /** * 可用区。 */ Zone?: string; /** * 偏移量, 默认值0。 */ Offset?: number; /** * 本次请求量, 默认值20。 */ Limit?: number; /** * 高性能计算集群类型。 */ HpcClusterType?: string; /** * 高性能计算集群对应的业务场景标识，当前只支持CDC。 */ HpcClusterBusinessId?: string; /** * 高性能计算集群实例类型 */ InstanceType?: string; /** * <li>tag-key</li> 按照【标签键】进行过滤。类型：String必选：否 <li>tag-value</li> 按照【标签值】进行过滤。类型：String必选：否 <li>tag:tag-key</li> 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。类型：String必选：否 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。 */ Filters?: Array<Filter>; } /** * DescribeImageQuota返回参数结构体 */ export interface DescribeImageQuotaResponse { /** * 账户的镜像配额 */ ImageNumQuota?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstancesProject请求参数结构体 */ export interface ModifyInstancesProjectRequest { /** * 一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。 */ InstanceIds: Array<string>; /** * 项目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可用于过滤结果。 */ ProjectId: number; } /** * ConfigureChcDeployVpc返回参数结构体 */ export interface ConfigureChcDeployVpcResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceRenewHosts请求参数结构体 */ export interface InquiryPriceRenewHostsRequest { /** * 一个或多个待操作的`CDH`实例`ID`。可通过[`DescribeHosts`](https://cloud.tencent.com/document/api/213/16474)接口返回值中的`HostId`获取。每次请求批量实例的上限为100。 */ HostIds: Array<string>; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。 */ HostChargePrepaid: ChargePrepaid; /** * 是否只预检此次请求。true：发送检查请求，不会创建实例。检查项包括是否填写了必需参数，请求格式，业务限制和云服务器库存。如果检查不通过，则返回对应错误码；如果检查通过，则返回RequestId.false（默认）：发送正常请求，通过检查后直接创建实例 */ DryRun?: boolean; } /** * 专用宿主机实例的资源信息 */ export interface HostResource { /** * 专用宿主机实例总CPU核数 */ CpuTotal?: number; /** * 专用宿主机实例可用CPU核数 */ CpuAvailable?: number; /** * 专用宿主机实例总内存大小（单位为:GiB） */ MemTotal?: number; /** * 专用宿主机实例可用内存大小（单位为:GiB） */ MemAvailable?: number; /** * 专用宿主机实例总磁盘大小（单位为:GiB） */ DiskTotal?: number; /** * 专用宿主机实例可用磁盘大小（单位为:GiB） */ DiskAvailable?: number; /** * 专用宿主机实例磁盘类型 */ DiskType?: string; /** * 专用宿主机实例总GPU卡数 */ GpuTotal?: number; /** * 专用宿主机实例可用GPU卡数 */ GpuAvailable?: number; /** * CDH owner */ ExclusiveOwner?: string; } /** * DeleteDisasterRecoverGroups请求参数结构体 */ export interface DeleteDisasterRecoverGroupsRequest { /** * 分散置放群组ID列表，可通过[DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/api/213/17810)接口获取。每次请求允许操作的分散置放群组数量上限是10。 */ DisasterRecoverGroupIds: Array<string>; } /** * DeleteKeyPairs返回参数结构体 */ export interface DeleteKeyPairsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TerminateInstances返回参数结构体 */ export interface TerminateInstancesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RepairTaskControl返回参数结构体 */ export interface RepairTaskControlResponse { /** * 已完成授权的维修任务ID。 */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstancesChargeType返回参数结构体 */ export interface ModifyInstancesChargeTypeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 配额详情 */ export interface AccountQuota { /** * 后付费配额列表 */ PostPaidQuotaSet?: Array<PostPaidQuota>; /** * 预付费配额列表 */ PrePaidQuotaSet?: Array<PrePaidQuota>; /** * spot配额列表 */ SpotPaidQuotaSet?: Array<SpotPaidQuota>; /** * 镜像配额列表 */ ImageQuotaSet?: Array<ImageQuota>; /** * 置放群组配额列表 */ DisasterRecoverGroupQuotaSet?: Array<DisasterRecoverGroupQuota>; } /** * InquiryPriceResetInstancesInternetMaxBandwidth返回参数结构体 */ export interface InquiryPriceResetInstancesInternetMaxBandwidthResponse { /** * 该参数表示带宽调整为对应大小之后的价格。 */ Price?: Price; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeZones请求参数结构体 */ export declare type DescribeZonesRequest = null; /** * ModifyKeyPairAttribute请求参数结构体 */ export interface ModifyKeyPairAttributeRequest { /** * 密钥对ID。可以通过以下方式获取可用的密钥 ID： <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/sshkey)查询密钥 ID。</li> <li>通过调用接口 [DescribeKeyPairs](https://cloud.tencent.com/document/api/213/9403) ，取返回信息中的 `KeyId` 获取密钥对 ID。</li> */ KeyId: string; /** * 修改后的密钥对名称，可由数字，字母和下划线组成，长度不超过25个字符。 */ KeyName?: string; /** * 修改后的密钥对描述信息。可任意命名，但不得超过60个字符。 */ Description?: string; } /** * AssociateSecurityGroups请求参数结构体 */ export interface AssociateSecurityGroupsRequest { /** * 要绑定的`安全组ID`，类似sg-efil73jd，只支持绑定单个安全组。可通过 [DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808) 接口返回值中的`SecurityGroupId`获取。 */ SecurityGroupIds: Array<string>; /** * 被绑定的`实例ID`，类似ins-lesecurk，支持指定多个实例，每次请求批量实例的上限为100。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。 */ InstanceIds: Array<string>; } /** * 后付费实例配额 */ export interface PostPaidQuota { /** * 累计已使用配额 */ UsedQuota?: number; /** * 剩余配额 */ RemainingQuota?: number; /** * 总配额 */ TotalQuota?: number; /** * 可用区 */ Zone?: string; } /** * ResetInstancesType请求参数结构体 */ export interface ResetInstancesTypeRequest { /** * 一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。本接口目前仅支持每次操作1个实例。 */ InstanceIds: Array<string>; /** * 调整后的实例机型。不同实例机型指定了不同的资源规格，具体取值可通过调用接口[ DescribeInstanceTypeConfigs ](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例类型](https://cloud.tencent.com/document/product/213/11518)描述。 */ InstanceType: string; /** * 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机。取值范围： <li>true：表示在正常关机失败后进行强制关机</li> <li>false：表示在正常关机失败后不进行强制关机</li> 默认取值：false。 强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。 */ ForceStop?: boolean; } /** * CHC物理服务器信息 */ export interface ChcHost { /** * CHC物理服务器ID。 */ ChcId?: string; /** * 实例名称。 */ InstanceName?: string; /** * 服务器序列号。 */ SerialNumber?: string; /** * CHC的状态 <ul> <li>INIT: 设备已录入。还未配置带外和部署网络</li> <li>READY: 已配置带外和部署网络</li> <li>PREPARED: 可分配云主机</li> <li>ONLINE: 已分配云主机</li> <li>OPERATING: 设备操作中，如正在配置带外网络等。</li> <li>CLEAR_NETWORK_FAILED: 清理带外和部署网络失败</li> </ul> */ InstanceState?: string; /** * 设备类型。 */ DeviceType?: string; /** * 所属可用区 */ Placement?: Placement; /** * 带外网络。 */ BmcVirtualPrivateCloud?: VirtualPrivateCloud; /** * 带外网络Ip。 */ BmcIp?: string; /** * 带外网络安全组Id。 */ BmcSecurityGroupIds?: Array<string>; /** * 部署网络。 */ DeployVirtualPrivateCloud?: VirtualPrivateCloud; /** * 部署网络Ip。 */ DeployIp?: string; /** * 部署网络安全组Id。 */ DeploySecurityGroupIds?: Array<string>; /** * 关联的云主机Id。 */ CvmInstanceId?: string; /** * 服务器导入的时间。 */ CreatedTime?: string; /** * 机型的硬件描述，分别为CPU核数，内存容量和磁盘容量 */ HardwareDescription?: string; /** * CHC物理服务器的CPU核数 */ CPU?: number; /** * CHC物理服务器的内存大小，单位为GB */ Memory?: number; /** * CHC物理服务器的磁盘信息 */ Disk?: string; /** * 带外网络下分配的MAC地址 */ BmcMAC?: string; /** * 部署网络下分配的MAC地址 */ DeployMAC?: string; /** * 设备托管类型。 HOSTING: 托管 TENANT: 租赁 */ TenantType?: string; /** * chc dhcp选项，用于minios调试。 */ DeployExtraConfig?: ChcDeployExtraConfig; /** * GPU型号。 */ Gpu?: string; /** * 网卡型号。主要指RDMA网卡。 */ NetworkCard?: string; /** * 是否是预定义机型。 */ IsPredefinedType?: boolean; /** * CHC云主机机型。 */ ChcInstanceType?: string; /** * CHC云主机机型簇。 */ ChcInstanceFamily?: string; /** * CHC云主机机型簇名称。 */ ChcInstanceFamilyName?: string; /** * 转售客户的AppId。 */ ResaleAppId?: string; /** * 转售客户的账号ID。 */ ResaleAccountId?: string; /** * 售卖状态。 <ul> <li>NOT_FOR_SALE:不可售卖</li> <li>AVAILABLE: 可售卖</li> <li>SOLD: 已售卖</li> </ul> */ SaleStatus?: string; /** * CHC物理服务器关联的标签列表。 */ Tags?: Array<Tag>; /** * 最近操作 */ LatestOperation?: string; /** * 最近操作错误码 */ LatestOperationErrorCode?: string; /** * 最近操作错误详情和建议项 */ LatestOperationErrorMsg?: string; /** * 最近操作名称 */ LatestOperationName?: string; /** * 最近操作状态 */ LatestOperationState?: string; } /** * 描述维修任务的相关信息 */ export interface RepairTaskInfo { /** * 维修任务ID */ TaskId?: string; /** * 实例ID */ InstanceId?: string; /** * 实例名称注意：此字段可能返回 null，表示取不到有效值。 */ Alias?: string; /** * 任务类型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.86.E7.B1.BB)。 */ TaskTypeId?: number; /** * 任务类型中文名 */ TaskTypeName?: string; /** * 任务状态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)。 */ TaskStatus?: number; /** * 设备状态ID，与设备状态中文名的对应关系如下： - `1`：故障中 - `2`：处理中 - `3`：正常 - `4`：已预约 - `5`：已取消 - `6`：已避免 */ DeviceStatus?: number; /** * 操作状态ID，与操作状态中文名的对应关系如下： - `1`：未授权 - `2`：已授权 - `3`：已处理 - `4`：已预约 - `5`：已取消 - `6`：已避免 */ OperateStatus?: number; /** * 任务创建时间 */ CreateTime?: string; /** * 任务授权时间注意：此字段可能返回 null，表示取不到有效值。 */ AuthTime?: string; /** * 任务结束时间注意：此字段可能返回 null，表示取不到有效值。 */ EndTime?: string; /** * 任务详情注意：此字段可能返回 null，表示取不到有效值。 */ TaskDetail?: string; /** * 可用区注意：此字段可能返回 null，表示取不到有效值。 */ Zone?: string; /** * 地域注意：此字段可能返回 null，表示取不到有效值。 */ Region?: string; /** * 所在私有网络ID 注意：此字段可能返回 null，表示取不到有效值。 */ VpcId?: string; /** * 所在私有网络名称注意：此字段可能返回 null，表示取不到有效值。 */ VpcName?: string; /** * 所在子网ID 注意：此字段可能返回 null，表示取不到有效值。 */ SubnetId?: string; /** * 所在子网名称注意：此字段可能返回 null，表示取不到有效值。 */ SubnetName?: string; /** * 实例公网IP 注意：此字段可能返回 null，表示取不到有效值。 */ WanIp?: string; /** * 实例内网IP 注意：此字段可能返回 null，表示取不到有效值。 */ LanIp?: string; /** * 产品类型，支持取值： - `CVM`：云服务器 - `CDH`：专用宿主机 - `CPM2.0`：裸金属云服务器注意：此字段可能返回 null，表示取不到有效值。 */ Product?: string; /** * 任务子类型注意：此字段可能返回 null，表示取不到有效值。 */ TaskSubType?: string; /** * 任务授权类型 */ AuthType?: number; /** * 授权渠道，支持取值： - `Waiting_auth`：待授权 - `Customer_auth`：客户操作授权 - `System_mandatory_auth`：系统默认授权 - `Pre_policy_auth`：预置策略授权 */ AuthSource?: string; } /** * DeleteLaunchTemplateVersions请求参数结构体 */ export interface DeleteLaunchTemplateVersionsRequest { /** * 启动模板ID。可通过 [DescribeLaunchTemplates](https://cloud.tencent.com/document/api/213/66322) 接口返回值中的`LaunchTemplateId`获取。 */ LaunchTemplateId: string; /** * 实例启动模板版本列表。可通过 [DescribeLaunchTemplateVersions](https://cloud.tencent.com/document/api/213/66323) 接口返回值中的`LaunchTemplateVersion`获取。 */ LaunchTemplateVersions: Array<number | bigint>; } /** * DeleteImages请求参数结构体 */ export interface DeleteImagesRequest { /** * 删除的镜像 ID 列表。可通过 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) 接口返回值中的`ImageId`获取。 */ ImageIds: Array<string>; /** * 是否删除镜像关联的快照。默认值：false */ DeleteBindedSnap?: boolean; /** * 检测是否支持删除镜像。默认值：false */ DryRun?: boolean; } /** * DeleteLaunchTemplate请求参数结构体 */ export interface DeleteLaunchTemplateRequest { /** * 启动模板ID。可通过 [DescribeLaunchTemplates](https://cloud.tencent.com/document/api/213/66322) 接口返回值中的`LaunchTemplateId`获取。 */ LaunchTemplateId: string; } /** * DescribeInstances返回参数结构体 */ export interface DescribeInstancesResponse { /** * 符合条件的实例数量。 */ TotalCount?: number; /** * 实例详细信息列表。 */ InstanceSet?: Array<Instance>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeHosts返回参数结构体 */ export interface DescribeHostsResponse { /** * 符合查询条件的cdh实例总数 */ TotalCount?: number; /** * cdh实例详细信息列表 */ HostSet?: Array<HostItem>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteKeyPairs请求参数结构体 */ export interface DeleteKeyPairsRequest { /** * 一个或多个待操作的密钥对ID。每次请求批量密钥对的上限为100。 可以通过以下方式获取可用的密钥ID： <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/sshkey)查询密钥ID。</li> <li>通过调用接口 [DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699) ，取返回信息中的 `KeyId` 获取密钥对ID。</li> */ KeyIds: Array<string>; } /** * 描述了操作系统所在块设备即系统盘的信息 */ export interface SystemDisk { /** * 系统盘类型。系统盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围： <li>LOCAL_BASIC：本地硬盘</li> <li>LOCAL_SSD：本地SSD硬盘</li> <li>CLOUD_BASIC：普通云硬盘</li> <li>CLOUD_SSD：SSD云硬盘</li> <li>CLOUD_PREMIUM：高性能云硬盘</li> <li>CLOUD_BSSD：通用型SSD云硬盘</li> <li>CLOUD_HSSD：增强型SSD云硬盘</li> <li>CLOUD_TSSD：极速型SSD云硬盘</li> 默认取值：当前有库存的硬盘类型。 */ DiskType?: string; /** * 系统盘ID。该参数目前仅用于`DescribeInstances`等查询类接口的返回参数，不可用于`RunInstances`等写接口的入参。 */ DiskId?: string; /** * 系统盘大小，单位：GiB。默认值为 50 */ DiskSize?: number; /** * 所属的独享集群ID。 */ CdcId?: string; /** * 磁盘名称，长度不超过128 个字符。 */ DiskName?: string; } /** * ModifyInstancesDisasterRecoverGroup请求参数结构体 */ export interface ModifyInstancesDisasterRecoverGroupRequest { /** * 一个或多个待操作的实例ID。可通过[`DescribeInstances`](https://cloud.tencent.com/document/api/213/15728)接口返回值中的`InstanceId`获取。每次请求批量实例的上限为1 */ InstanceIds: Array<string>; /** * 分散置放群组ID，可使用[DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/api/213/17810)接口获取 */ DisasterRecoverGroupId?: string; /** * 是否强制更换实例宿主机。取值范围： <li>true：表示允许实例更换宿主机，允许重启实例。本地盘子机不支持指定此参数。</li> <li>false：不允许实例更换宿主机，只在当前宿主机上加入置放群组。这可能导致更换置放群组失败。</li> 默认取值：false */ Force?: boolean; } /** * ModifyHpcClusterAttribute请求参数结构体 */ export interface ModifyHpcClusterAttributeRequest { /** * 高性能计算集群ID。 */ HpcClusterId: string; /** * 高性能计算集群新名称。 */ Name?: string; /** * 高性能计算集群新备注。 */ Remark?: string; } /** * ExitRescueMode返回参数结构体 */ export interface ExitRescueModeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeChcHosts返回参数结构体 */ export interface DescribeChcHostsResponse { /** * 符合条件的实例数量。 */ TotalCount?: number; /** * 返回的实例列表 */ ChcHostSet?: Array<ChcHost>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述实例机型配置信息 */ export interface InstanceTypeConfig { /** * 可用区。 */ Zone?: string; /** * 实例机型。 */ InstanceType?: string; /** * 实例机型系列。 */ InstanceFamily?: string; /** * GPU核数，单位：核。 */ GPU?: number; /** * CPU核数，单位：核。 */ CPU?: number; /** * 内存容量，单位：`GiB`。 */ Memory?: number; /** * FPGA核数，单位：核。 */ FPGA?: number; /** * 实例机型映射的物理GPU卡数，单位：卡。vGPU卡型小于1，直通卡型大于等于1。vGPU是通过分片虚拟化技术，将物理GPU卡重新划分，同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。 */ GpuCount?: number; } /** * RepairTaskControl请求参数结构体 */ export interface RepairTaskControlRequest { /** * 待授权任务实例对应的产品类型，支持取值： - `CVM`：云服务器 - `CDH`：专用宿主机 - `CPM2.0`：裸金属云服务器 */ Product: string; /** * 指定待操作的实例ID列表，仅允许对列表中的实例ID相关的维修任务发起授权。 */ InstanceIds: Array<string>; /** * 维修任务ID。 */ TaskId: string; /** * 操作类型，当前只支持传入`AuthorizeRepair`。 */ Operate: string; /** * 预约授权时间，形如`2023-01-01 12:00:00`。预约时间需晚于当前时间至少5分钟，且在48小时之内。 */ OrderAuthTime?: string; /** * 附加的授权处理策略。 */ TaskSubMethod?: string; } /** * AllocateHosts请求参数结构体 */ export interface AllocateHostsRequest { /** * 实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。 */ Placement: Placement; /** * 用于保证请求幂等性的字符串。 */ ClientToken?: string; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 */ HostChargePrepaid?: ChargePrepaid; /** * 实例计费类型。目前仅支持：PREPAID（预付费，即包年包月模式），默认为：'PREPAID'。 */ HostChargeType?: string; /** * CDH实例机型，默认为：'HS1'。 */ HostType?: string; /** * 购买CDH实例数量，默认为：1。 */ HostCount?: number; /** * 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例。 */ TagSpecification?: Array<TagSpecification>; } /** * DescribeImageFromFamily请求参数结构体 */ export interface DescribeImageFromFamilyRequest { /** * 镜像族 */ ImageFamily?: string; } /** * DescribeRegions返回参数结构体 */ export interface DescribeRegionsResponse { /** * 地域数量。 */ TotalCount?: number; /** * 地域列表信息。 */ RegionSet?: Array<RegionInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 导入镜像的数据盘信息 */ export interface ImportImageDataDisk { /** * 数据盘镜像 COS 链接 */ ImageUrl: string; } /** * PurchaseReservedInstancesOffering请求参数结构体 */ export interface PurchaseReservedInstancesOfferingRequest { /** * 购买预留实例计费数量 */ InstanceCount: number; /** * 预留实例计费配置ID */ ReservedInstancesOfferingId: string; /** * 试运行 */ DryRun?: boolean; /** * 用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。 更多详细信息请参阅：如何保证幂等性 */ ClientToken?: string; /** * 预留实例显示名称。 <li>不指定实例显示名称则默认显示‘未命名’。</li><li>最多支持60个字符（包含模式串）。</li> */ ReservedInstanceName?: string; } /** * RebootInstances请求参数结构体 */ export interface RebootInstancesRequest { /** * 一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。 */ InstanceIds: Array<string>; /** * 本参数已弃用，推荐使用StopType，不可以与参数StopType同时使用。表示是否在正常重启失败后选择强制重启实例。取值范围： <li>true：表示在正常重启失败后进行强制重启 <li>false：表示在正常重启失败后不进行强制重启 默认取值：false。 */ ForceReboot?: boolean; /** * 关机类型。取值范围： <li>SOFT：表示软关机 <li>HARD：表示硬关机 <li>SOFT_FIRST：表示优先软关机，失败再执行硬关机 默认取值：SOFT。 */ StopType?: string; } /** * 描述实例机型配置信息及状态信息 */ export interface InstanceTypeConfigStatus { /** * 状态描述 */ Status?: string; /** * 状态描述信息 */ Message?: string; /** * 配置信息 */ InstanceTypeConfig?: InstanceTypeConfig; } /** * cdh相关价格信息 */ export interface HostPriceInfo { /** * 描述了cdh实例相关的价格信息 */ HostPrice: ItemPrice; } /** * ResetInstancesType返回参数结构体 */ export interface ResetInstancesTypeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteInstancesActionTimer请求参数结构体 */ export interface DeleteInstancesActionTimerRequest { /** * 定时任务ID列表，可以通过[ DescribeInstancesActionTimer ](https://cloud.tencent.com/document/product/213/103950)接口查询。只能删除未执行的定时任务。 */ ActionTimerIds: Array<string>; } /** * AssociateInstancesKeyPairs请求参数结构体 */ export interface AssociateInstancesKeyPairsRequest { /** * 一个或多个待操作的实例ID，每次请求批量实例的上限为100。可以通过以下方式获取可用的实例ID： <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li> <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ，取返回信息中的`InstanceId`获取实例ID。</li> */ InstanceIds: Array<string>; /** * 一个或多个待操作的密钥对ID，每次请求批量密钥对的上限为100。可以通过以下方式获取可用的密钥ID： <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/sshkey)查询密钥ID。</li> <li>通过调用接口 [DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699) ，取返回信息中的`KeyId`获取密钥对ID。</li> */ KeyIds: Array<string>; /** * 是否强制关机，默认值为 false。常规场景下，建议手动关机后绑定密钥。取值范围： <li>true：先执行强制关机，再绑定密钥。</li> <li>false：不执行强制关机，仅支持对已关机状态实例进行绑定操作。</li> */ ForceStop?: boolean; } /** * DeleteLaunchTemplate返回参数结构体 */ export interface DeleteLaunchTemplateResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeChcDeniedActions返回参数结构体 */ export interface DescribeChcDeniedActionsResponse { /** * CHC实例禁止操作信息 */ ChcHostDeniedActionSet?: Array<ChcHostDeniedActions>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstancesStatus返回参数结构体 */ export interface DescribeInstancesStatusResponse { /** * 符合条件的实例状态数量。 */ TotalCount?: number; /** * [实例状态](https://cloud.tencent.com/document/api/213/15753#InstanceStatus) 列表。 */ InstanceStatusSet?: Array<InstanceStatus>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 可用区信息 */ export interface ZoneInfo { /** * 可用区名称，例如，ap-guangzhou-3 全网可用区名称如下： <li> ap-chongqing-1 </li> <li> ap-seoul-1 </li> <li> ap-seoul-2 </li> <li> ap-chengdu-1 </li> <li> ap-chengdu-2 </li> <li> ap-hongkong-1（售罄） </li> <li> ap-hongkong-2 </li> <li> ap-hongkong-3 </li> <li> ap-shenzhen-fsi-1 </li> <li> ap-shenzhen-fsi-2 </li> <li> ap-shenzhen-fsi-3（售罄） </li> <li> ap-guangzhou-1（售罄）</li> <li> ap-guangzhou-2（售罄）</li> <li> ap-guangzhou-3 </li> <li> ap-guangzhou-4 </li> <li> ap-guangzhou-6 </li> <li> ap-guangzhou-7 </li> <li> ap-tokyo-1 </li> <li> ap-tokyo-2 </li> <li> ap-singapore-1 </li> <li> ap-singapore-2 </li> <li> ap-singapore-3 </li> <li>ap-singapore-4 </li> <li> ap-shanghai-fsi-1 </li> <li> ap-shanghai-fsi-2 </li> <li> ap-shanghai-fsi-3 </li> <li> ap-bangkok-1 </li> <li> ap-bangkok-2 </li> <li> ap-shanghai-1（售罄） </li> <li> ap-shanghai-2 </li> <li> ap-shanghai-3 </li> <li> ap-shanghai-4 </li> <li> ap-shanghai-5 </li> <li> ap-shanghai-8 </li> <li> ap-mumbai-1 </li> <li> ap-mumbai-2 </li> <li> ap-beijing-1（售罄）</li> <li> ap-beijing-2 </li> <li> ap-beijing-3 </li> <li> ap-beijing-4 </li> <li> ap-beijing-5 </li> <li> ap-beijing-6 </li> <li> ap-beijing-7 </li> <li> na-siliconvalley-1 </li> <li> na-siliconvalley-2 </li> <li> eu-frankfurt-1 </li> <li> eu-frankfurt-2 </li> <li> na-ashburn-1 </li> <li> na-ashburn-2 </li> <li> ap-nanjing-1 </li> <li> ap-nanjing-2 </li> <li> ap-nanjing-3 </li> <li> sa-saopaulo-1</li> <li> ap-jakarta-1 </li> <li> ap-jakarta-2 </li> */ Zone?: string; /** * 可用区描述，例如，广州三区 */ ZoneName?: string; /** * 可用区ID */ ZoneId?: string; /** * 可用区状态，包含AVAILABLE和UNAVAILABLE。AVAILABLE代表可用，UNAVAILABLE代表不可用。 */ ZoneState?: string; } /** * ModifyHpcClusterAttribute返回参数结构体 */ export interface ModifyHpcClusterAttributeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例启动模板版本集合 */ export interface LaunchTemplateVersionInfo { /** * 实例启动模板版本号。 */ LaunchTemplateVersion?: number; /** * 实例启动模板版本数据详情。 */ LaunchTemplateVersionData?: LaunchTemplateVersionData; /** * 实例启动模板版本创建时间。 */ CreationTime?: string; /** * 实例启动模板ID。 */ LaunchTemplateId?: string; /** * 是否为默认启动模板版本。 */ IsDefaultVersion?: boolean; /** * 实例启动模板版本描述信息。 */ LaunchTemplateVersionDescription?: string; /** * 创建者的AppId。 */ CreatedBy?: string; } /** * InquiryPriceModifyInstancesChargeType返回参数结构体 */ export interface InquiryPriceModifyInstancesChargeTypeResponse { /** * 该参数表示对应配置实例转换计费模式的价格。 */ Price?: Price; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ImportInstancesActionTimer返回参数结构体 */ export interface ImportInstancesActionTimerResponse { /** * 定时器id列表 */ ActionTimerIds?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeKeyPairs返回参数结构体 */ export interface DescribeKeyPairsResponse { /** * 符合条件的密钥对数量。 */ TotalCount?: number; /** * 密钥对详细信息列表。 */ KeyPairSet?: Array<KeyPair>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResetInstancesPassword请求参数结构体 */ export interface ResetInstancesPasswordRequest { /** * 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。 */ InstanceIds: Array<string>; /** * 重置后的实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux 实例密码必须8-30位，推荐使用12位以上密码，不能以“/”开头，至少包含以下字符中的三种不同字符，字符种类： <li>小写字母：[a-z]</li><li>大写字母：[A-Z]</li><li>数字：0-9</li><li>特殊字符： ()\`\~!@#$%^&\*-+=\_|{}[]:;'<>,.?/Windows 实例密码必须12\~30位，不能以“/”开头且不包括用户名，至少包含以下字符中的三种不同字符</li><li>小写字母：[a-z]</li><li>大写字母：[A-Z]</li><li>数字： 0-9</li><li>特殊字符：()\`\~!@#$%^&\*-+=\_|{}[]:;' <>,.?/</li><li>如果实例即包含 `Linux` 实例又包含 `Windows` 实例，则密码复杂度限制按照 `Windows` 实例的限制。</li> */ Password: string; /** * 待重置密码的实例操作系统的用户名。不得超过64个字符。 */ UserName?: string; /** * 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再重置用户密码。取值范围： <li>true：表示在正常关机失败后进行强制关机</li><li>false：表示在正常关机失败后不进行强制关机</li>默认取值：false。 强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。 */ ForceStop?: boolean; } /** * DescribeInternetChargeTypeConfigs返回参数结构体 */ export interface DescribeInternetChargeTypeConfigsResponse { /** * 网络计费类型配置。 */ InternetChargeTypeConfigSet?: Array<InternetChargeTypeConfig>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了网络计费 */ export interface InternetChargeTypeConfig { /** * 网络计费类型。取值范围： <li>BANDWIDTH_PREPAID：预付费按带宽结算</li><li>TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费</li><li>BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费</li><li>BANDWIDTH_PACKAGE：带宽包用户</li>默认取值：非带宽包用户默认与子机付费类型保持一致，比如子机付费类型为预付费，网络计费类型默认为预付费；子机付费类型为后付费，网络计费类型默认为后付费。 */ InternetChargeType?: string; /** * 网络计费模式描述信息。 */ Description?: string; } /** * DescribeImages返回参数结构体 */ export interface DescribeImagesResponse { /** * 一个关于镜像详细信息的结构体，主要包括镜像的主要状态与属性。 */ ImageSet?: Array<Image>; /** * 符合要求的镜像数量。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstancesVpcAttribute返回参数结构体 */ export interface ModifyInstancesVpcAttributeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了实例CPU拓扑结构的相关信息。 */ export interface CpuTopology { /** * 决定启用的CPU物理核心数。 */ CoreCount?: number; /** * 每核心线程数。该参数决定是否开启或关闭超线程。 <li>1 表示关闭超线程 </li> <li>2 表示开启超线程</li> 不设置时，实例使用默认的超线程策略。开关超线程请参考文档：[开启与关闭超线程](https://cloud.tencent.com/document/product/213/103798)。 */ ThreadPerCore?: number; } /** * DescribeLaunchTemplates返回参数结构体 */ export interface DescribeLaunchTemplatesResponse { /** * 符合条件的实例模板数量。 */ TotalCount?: number; /** * 实例详细信息列表。 */ LaunchTemplateSet?: Array<LaunchTemplateInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteHpcClusters返回参数结构体 */ export interface DeleteHpcClustersResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstancesActionTimer返回参数结构体 */ export interface DescribeInstancesActionTimerResponse { /** * 定时任务信息列表。 */ ActionTimers?: Array<ActionTimer>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstancesOperationLimit请求参数结构体 */ export interface DescribeInstancesOperationLimitRequest { /** * 按照一个或者多个实例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。 */ InstanceIds: Array<string>; /** * 实例操作。 <li> INSTANCE_DEGRADE：实例降配操作</li><li> INTERNET_CHARGE_TYPE_CHANGE：实例调整带宽付费模式操作</li> */ Operation: string; } /** * ResetInstancesPassword返回参数结构体 */ export interface ResetInstancesPasswordResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyImageAttribute请求参数结构体 */ export interface ModifyImageAttributeRequest { /** * 镜像ID，形如`img-gvbnzy6f`。镜像ID可以通过如下方式获取：<li>通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。</li><li>通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。</li> */ ImageId: string; /** * 设置新的镜像名称；必须满足下列限制 <li> 不得超过60个字符。</li><li> 镜像名称不能与已有镜像重复。</li> */ ImageName?: string; /** * 设置新的镜像描述；必须满足下列限制： <li> 不得超过 256 个字符。</li> */ ImageDescription?: string; /** * 设置镜像族； */ ImageFamily?: string; /** * 设置镜像是否废弃； */ ImageDeprecated?: boolean; } /** * EnterRescueMode请求参数结构体 */ export interface EnterRescueModeRequest { /** * 需要进入救援模式的实例id */ InstanceId: string; /** * 救援模式下系统密码 */ Password: string; /** * 救援模式下系统用户名 */ Username?: string; /** * 是否强制关机。本参数已弃用，推荐使用StopType，不可以与参数StopType同时使用。 * @deprecated */ ForceStop?: boolean; /** * 实例的关闭模式。取值范围： <li>SOFT_FIRST：表示在正常关闭失败后进行强制关闭</li> <li>HARD：直接强制关闭</li> <li>SOFT：仅软关机</li> 默认取值：SOFT。 */ StopType?: string; } /** * DescribeInstanceVncUrl请求参数结构体 */ export interface DescribeInstanceVncUrlRequest { /** * 一个操作的实例ID。可通过[ DescribeInstances ](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。 */ InstanceId: string; } /** * StopInstances返回参数结构体 */ export interface StopInstancesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyImageSharePermission请求参数结构体 */ export interface ModifyImageSharePermissionRequest { /** * 镜像ID，形如`img-gvbnzy6f`。镜像Id可以通过如下方式获取： <li>通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取。</li> <li>通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。</li> 镜像ID必须指定为状态为`NORMAL`的镜像。镜像状态请参考[镜像数据表](https://cloud.tencent.com/document/product/213/15753#Image)。 */ ImageId: string; /** * 接收共享镜像的主账号ID列表，array型参数的格式可以参考[API简介](/document/api/213/568)。账号ID不同于QQ号，查询用户主账号ID请查看[账号信息](https://console.cloud.tencent.com/developer)中的账号ID栏。 */ AccountIds: Array<string>; /** * 操作，包括 `SHARE`，`CANCEL`。其中`SHARE`代表共享操作，`CANCEL`代表取消共享操作。 */ Permission: string; } /** * DisassociateInstancesKeyPairs返回参数结构体 */ export interface DisassociateInstancesKeyPairsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLaunchTemplateVersions请求参数结构体 */ export interface DescribeLaunchTemplateVersionsRequest { /** * 启动模板ID。 */ LaunchTemplateId: string; /** * 实例启动模板列表。 */ LaunchTemplateVersions?: Array<number | bigint>; /** * 通过范围指定版本时的最小版本号，默认为0。 */ MinVersion?: number; /** * 过范围指定版本时的最大版本号，默认为30。 */ MaxVersion?: number; /** * 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Offset?: number; /** * 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Limit?: number; /** * 是否查询默认版本。该参数不可与LaunchTemplateVersions同时指定。 */ DefaultVersion?: boolean; } /** * InquiryPriceResizeInstanceDisks请求参数结构体 */ export interface InquiryPriceResizeInstanceDisksRequest { /** * 待操作的实例ID。可通过[ DescribeInstances ](https://cloud.tencent.com/document/api/213/15728)接口返回值中的`InstanceId`获取。 */ InstanceId: string; /** * 待扩容的数据盘配置信息。只支持扩容非弹性数据盘[ DescribeDisks ](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性）。数据盘容量单位：GB。最小扩容步长：10G。关于数据盘类型的选择请参考硬盘产品简介。可选数据盘类型受到实例类型`InstanceType`限制。另外允许扩容的最大容量也因数据盘类型的不同而有所差异。 <dx-alert infotype="explain" title="">您必须指定参数DataDisks与SystemDisk的其中一个，但不能同时指定。</dx-alert> */ DataDisks?: Array<DataDisk>; /** * 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再重置用户密码。取值范围： <li>true：表示在正常关机失败后进行强制关机</li> <li>false：表示在正常关机失败后不进行强制关机</li> 默认取值：false。 强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。 */ ForceStop?: boolean; /** * 待扩容的系统盘配置信息。只支持扩容云盘。 <dx-alert infotype="explain" title="">您必须指定参数DataDisks与SystemDisk的其中一个，但不能同时指定。</dx-alert> */ SystemDisk?: SystemDisk; /** * 是否在线扩容 */ ResizeOnline?: boolean; } /** * RunInstances返回参数结构体 */ export interface RunInstancesResponse { /** * 当通过本接口来创建实例时会返回该参数，表示一个或多个实例`ID`。返回实例`ID`列表并不代表实例创建成功，可根据 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口查询返回的InstancesSet中对应实例的`ID`的状态来判断创建是否完成；如果实例状态由“PENDING(创建中)”变为“RUNNING(运行中)”，则为创建成功。 */ InstanceIdSet?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例属性 */ export interface InstanceAttribute { /** * 实例 ID。 */ InstanceId?: string; /** * 实例属性信息。 */ Attributes?: Attribute; } /** * 预留实例相关价格信息。预留实例当前只针对国际站白名单用户开放。 */ export interface ReservedInstancePrice { /** * 预支合计费用的原价，单位：元。 */ OriginalFixedPrice?: number; /** * 预支合计费用的折扣价，单位：元。 */ DiscountFixedPrice?: number; /** * 后续合计费用的原价，单位：元/小时 */ OriginalUsagePrice?: number; /** * 后续合计费用的折扣价，单位：元/小时 */ DiscountUsagePrice?: number; /** * 预支费用的折扣，如20.0代表2折。注意：此字段可能返回 null，表示取不到有效值。 */ FixedPriceDiscount?: number; /** * 后续费用的折扣，如20.0代表2折。注意：此字段可能返回 null，表示取不到有效值。 */ UsagePriceDiscount?: number; } /** * 置放群组配置数据 */ export interface DisasterRecoverGroupQuota { /** * 可创建置放群组数量的上限。 */ GroupQuota: number; /** * 当前用户已经创建的置放群组数量。 */ CurrentNum: number; /** * 物理机类型容灾组内实例的配额数。 */ CvmInHostGroupQuota: number; /** * 交换机类型容灾组内实例的配额数。 */ CvmInSwitchGroupQuota: number; /** * 机架类型容灾组内实例的配额数。 */ CvmInRackGroupQuota: number; } /** * DescribeHpcClusters返回参数结构体 */ export interface DescribeHpcClustersResponse { /** * 高性能计算集群信息。 */ HpcClusterSet?: Array<HpcClusterInfo>; /** * 高性能计算集群总数。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyImageSharePermission返回参数结构体 */ export interface ModifyImageSharePermissionResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstancesOperationLimit返回参数结构体 */ export interface DescribeInstancesOperationLimitResponse { /** * 该参数表示调整配置操作（降配）限制次数查询。 */ InstanceOperationLimitSet?: Array<OperationCountLimit>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SyncImages返回参数结构体 */ export interface SyncImagesResponse { /** * 目的地域的镜像ID信息。 */ ImageSet?: Array<SyncImage>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeZoneInstanceConfigInfos返回参数结构体 */ export interface DescribeZoneInstanceConfigInfosResponse { /** * 可用区机型配置列表。 */ InstanceTypeQuotaSet?: Array<InstanceTypeQuotaItem>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstancesAttribute请求参数结构体 */ export interface ModifyInstancesAttributeRequest { /** * 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。 */ InstanceIds: Array<string>; /** * 修改后实例名称。可任意命名，但不得超过60个字符。 */ InstanceName?: string; /** * 提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16 KB。关于获取此参数的详细介绍，请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526) 和 [Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。 */ UserData?: string; /** * 指定实例的修改后的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。 */ SecurityGroups?: Array<string>; /** * 给实例绑定用户角色，传空值为解绑操作 */ CamRoleName?: string; /** * 修改后实例的主机名。<li>点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。</li><li>Windows 实例：主机名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。</li><li>其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。</li>注意点：修改主机名后实例会立即重启，重启后新的主机名生效。 */ HostName?: string; /** * 实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：<li>true：表示开启实例保护，不允许通过api接口删除实例</li><li>false：表示关闭实例保护，允许通过api接口删除实例</li>默认取值：false。 */ DisableApiTermination?: boolean; /** * 角色类别，与CamRoleName搭配使用，该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取，当前只接受user、system和service_linked三种类别。举例：一般CamRoleName中包含“LinkedRoleIn”（如TKE_QCSLinkedRoleInPrometheusService）时，DescribeRoleList和GetRole返回的RoleType为service_linked，则本参数也需要传递service_linked。该参数默认值为user，若CameRoleName为非service_linked类型，本参数可不传递。 */ CamRoleType?: string; /** * 修改实例主机名是否自动重启实例，不传默认自动重启。 - true: 修改主机名，并自动重启实例； - false: 修改主机名，不自动重启实例，需要手动重启使新主机名生效。注意点：本参数仅对修改主机名生效。 */ AutoReboot?: boolean; } /** * RenewHosts请求参数结构体 */ export interface RenewHostsRequest { /** * 一个或多个待操作的CDH实例ID。每次请求的CDH实例的上限为100。 */ HostIds: Array<string>; /** * 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 */ HostChargePrepaid: ChargePrepaid; } /** * CreateDisasterRecoverGroup返回参数结构体 */ export interface CreateDisasterRecoverGroupResponse { /** * 分散置放群组ID列表。 */ DisasterRecoverGroupId?: string; /** * 分散置放群组类型，取值范围： <li>HOST：物理机</li><li>SW：交换机</li><li>RACK：机架</li> */ Type?: string; /** * 分散置放群组名称，长度1-60个字符，支持中、英文。 */ Name?: string; /** * 置放群组内可容纳的云服务器数量。 */ CvmQuotaTotal?: number; /** * 置放群组内已有的云服务器数量。 */ CurrentNum?: number; /** * 置放群组创建时间。 */ CreateTime?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RemoveChcAssistVpc请求参数结构体 */ export interface RemoveChcAssistVpcRequest { /** * CHC物理服务器Id。 */ ChcIds: Array<string>; } /** * ConvertOperatingSystems请求参数结构体 */ export interface ConvertOperatingSystemsRequest { /** * 执行操作系统转换的实例 ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。仅支持操作系统为 CentOS 7、CentOS 8 的实例执行转换。 */ InstanceIds: Array<string>; /** * 是否最小规模转换。默认值：false */ MinimalConversion?: boolean; /** * 是否只预检。默认值：false */ DryRun?: boolean; /** * 转换的目标操作系统类型。仅支持 TencentOS。默认值：TencentOS */ TargetOSType?: string; } /** * StartInstances请求参数结构体 */ export interface StartInstancesRequest { /** * 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。 */ InstanceIds: Array<string>; } /** * 标签键值对，可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。 */ export interface Tag { /** * 标签键 */ Key: string; /** * 标签值 */ Value: string; } /** * ProgramFpgaImage返回参数结构体 */ export interface ProgramFpgaImageResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceInternetBandwidthConfigs返回参数结构体 */ export interface DescribeInstanceInternetBandwidthConfigsResponse { /** * 带宽配置信息列表。 */ InternetBandwidthConfigSet?: Array<InternetBandwidthConfig>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了 “云安全” 服务相关的信息 */ export interface RunSecurityServiceEnabled { /** * 是否开启[云安全](/document/product/296)服务。取值范围： <li>true：表示开启云安全服务 <li>false：表示不开启云安全服务 默认取值：true。 */ Enabled?: boolean; } /** * CreateHpcCluster返回参数结构体 */ export interface CreateHpcClusterResponse { /** * 高性能计算集群信息。 */ HpcClusterSet?: Array<HpcClusterInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了实例的抽象位置，包括其所在的可用区，所属的项目，宿主机（仅专用宿主机产品可用），母机IP等 */ export interface Placement { /** * 实例所属的可用区名称。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。 */ Zone: string; /** * 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */ ProjectId?: number; /** * 实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。 */ HostIds?: Array<string>; /** * 实例所属的专用宿主机ID，仅用于出参。 */ HostId?: string; } /** * DescribeDisasterRecoverGroups请求参数结构体 */ export interface DescribeDisasterRecoverGroupsRequest { /** * 分散置放群组ID列表。每次请求允许操作的分散置放群组数量上限是10。 */ DisasterRecoverGroupIds?: Array<string>; /** * 分散置放群组名称，支持模糊匹配。 */ Name?: string; /** * 偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Offset?: number; /** * 返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。 */ Limit?: number; /** * <li>tag-key</li> 按照【标签键】进行过滤。类型：String必选：否 <li>tag-value</li> 按照【标签值】进行过滤。类型：String必选：否 <li>tag:tag-key</li> 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。类型：String必选：否 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。 */ Filters?: Array<Filter>; } /** * ModifyKeyPairAttribute返回参数结构体 */ export interface ModifyKeyPairAttributeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstancesRenewFlag请求参数结构体 */ export interface ModifyInstancesRenewFlagRequest { /** * 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。 */ InstanceIds: Array<string>; /** * 自动续费标识。取值范围： <li>NOTIFY_AND_AUTO_RENEW：通知过期且自动续费</li><li>NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费</li><li>DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费</li> 若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 */ RenewFlag: string; } /** * SyncImages请求参数结构体 */ export interface SyncImagesRequest { /** * 镜像ID列表，镜像ID可以通过如下方式获取： <li>通过[DescribeImages](https://cloud.tencent.com/document/api/213/15715)接口返回的`ImageId`获取，镜像ID对应的镜像状态必须为`NORMAL`。</li><li>通过[镜像控制台](https://console.cloud.tencent.com/cvm/image)获取。</li> */ ImageIds: Array<string>; /** * 目的同步地域列表，必须满足如下限制： <li>必须是一个合法的Region。</li><li>如果是自定义镜像，则目标同步地域不能为源地域。</li><li>如果是共享镜像，则目的同步地域仅支持源地域，表示将共享镜像复制为源地域的自定义镜像。</li><li>如果是自定义镜像复制为加密自定义镜像，则目的同步地域仅支持源地域，表示将自定义镜像复制为源地域的加密自定义镜像。</li><li>暂不支持部分地域同步，请参考[复制镜像](https://cloud.tencent.com/document/product/213/4943#.E5.A4.8D.E5.88.B6.E8.AF.B4.E6.98.8E)。</li>具体地域参数请参考[Region](https://cloud.tencent.com/document/product/213/6091)。 */ DestinationRegions: Array<string>; /** * 检测是否支持发起同步镜像。默认值: false */ DryRun?: boolean; /** * 目标镜像名称。默认使用源镜像名称。最多支持 60 个字符。 */ ImageName?: string; /** * 是否需要返回目的地域的镜像ID。默认值: false */ ImageSetRequired?: boolean; /** * 是否复制为加密自定义镜像。默认值为 false。复制加密自定义镜像仅支持同地域，即 DestinationRegions 仅支持填写指定镜像所在地域。 */ Encrypt?: boolean; /** * 加密自定义镜像使用的 KMS 密钥 ID。仅当复制加密镜像时，即 Encrypt 为 true 时，此参数有效；不指定 KmsKeyId，默认使用 CBS 云产品 KMS 密钥。 KMS 密钥 ID 通过[KMS 控制台](https://console.cloud.tencent.com/kms2)获取。 */ KmsKeyId?: string; } /** * DisassociateInstancesKeyPairs请求参数结构体 */ export interface DisassociateInstancesKeyPairsRequest { /** * 一个或多个待操作的实例ID，每次请求批量实例的上限为100。 可以通过以下方式获取可用的实例ID： <li>通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。</li> <li>通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/