/**
* InquiryPriceTerminateInstances返回参数结构体
*/
export interface InquiryPriceTerminateInstancesResponse {
/**
* 退款详情。
*/
InstanceRefundsSet?: Array 按照【标签键】进行过滤。 类型:String 必选:否 按照【标签值】进行过滤。 类型:String 必选:否 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。 类型:String 必选:否 CHC物理服务器ID。 实例名称。 服务器序列号。 CHC的状态 设备类型。 所属可用区。 带外网络。 带外网络IP。 带外网络安全组ID。 部署网络。 部署网络IP。 部署网络安全组ID。 关联的云主机ID。 服务器导入的时间。 机型的硬件描述,分别为CPU核数,内存容量和磁盘容量。 CHC物理服务器的CPU核数。 CHC物理服务器的内存大小,单位为GB。 CHC物理服务器的磁盘信息。 带外网络下分配的MAC地址。 部署网络下分配的MAC地址。 设备托管类型。 枚举值: CHC DHCP选项,用于客户自建PXE环境。 GPU型号。 网卡型号。主要指RDMA网卡。 是否是预定义机型。 CHC云主机机型。 CHC云主机机型簇。 CHC云主机机型簇名称。 转售客户的AppID。 转售客户的账号ID。 售卖状态。 CHC物理服务器关联的标签列表。 最近操作。 最近操作错误码。 最近操作错误详情和建议项。 最近操作名称。 最近操作状态。 枚举值: 所在的CHC网关的ID,只有专属网关才会返回。 所属的CDC集群ID。 业务网卡网络模式。 枚举值: 系统盘类型。系统盘类型限制详见存储概述。取值范围: 系统盘ID。 系统盘大小,单位:GiB。默认值为 50 所属的独享集群ID。 磁盘名称,长度不超过128 个字符。 系统盘是否加密。取值范围:true:加密false:不加密默认取值:false该参数目前仅用于 RunInstances 接口。当前参数灰度中。 自定义CMK对应的ID,取值为UUID或者类似kms-abcd1234。用于加密云盘。该参数目前仅用于 RunInstances 接口。当前参数灰度中。 一个或多个待操作的实例ID。可通过 DescribeInstances 接口返回值中的 分散置放群组ID,可使用DescribeDisasterRecoverGroups接口获取 是否强制更换实例宿主机。取值范围:
默认取值:false。
强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。
*/
ForceStop?: boolean;
}
/**
* CHC物理服务器信息
*/
export interface ChcHost {
/**
*
*/
InstanceState?: string;
/**
*
*/
TenantType?: string;
/**
*
*/
SaleStatus?: string;
/**
*
*/
LatestOperationState?: string;
/**
*
*/
NetworkMode?: 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`和维修任务提供的授权选项的对应关系如下:
- `"1"`:仅提供【在线迁移授权】
- `"2"`:仅提供【停机授权】
- `"3"`:仅提供【在线换盘授权】
- `"4"`:提供【停机换盘授权】(默认)、【弃盘迁移授权】(可选)
- `"5"`:提供【停机授权】(默认)、【弃盘迁移授权】(可选)
- `"6"`:仅提供【在线维护授权】
- `"7"`:提供【在线维护授权】(默认)、【停机授权】(可选)
- `"8"`:仅提供【弃盘迁移授权】
*/
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
可以通过以下方式获取可用的密钥ID:
默认取值:当前有库存的硬盘类型。
*/
DiskType?: string;
/**
*
该参数目前仅用于 DescribeInstances 等查询类接口的返回参数,不可用于 RunInstances 等写接口的入参。InstanceId获取。每次请求批量实例的上限为100
默认取值:false
置放群组id列表(目前仅支持指定一个)
*/ DisasterRecoverGroupIds?: Array分区置放群组的分区Id,取值范围:1-10,具体取决于所选置放群组的分区数量,如果选中的置放群组是分区置放群组,该值不传默认随机(该功能灰度中)
*/ PartitionNumber?: number; } /** * ModifyHpcClusterAttribute请求参数结构体 */ export interface ModifyHpcClusterAttributeRequest { /** * 高性能计算集群ID。集群ID可通过 [查询高性能集群信息](https://cloud.tencent.com/document/api/213/83220) 接口获取。 */ HpcClusterId: string; /** * 高性能计算集群新名称,长度限制[1-60]。 */ Name?: string; /** * 高性能计算集群新备注,长度[1-256]。 */ Remark?: string; } /** * ExitRescueMode返回参数结构体 */ export interface ExitRescueModeResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeChcHosts返回参数结构体 */ export interface DescribeChcHostsResponse { /** * 符合条件的实例数量。 */ TotalCount?: number; /** * 返回的实例列表 */ ChcHostSet?: Array可用区。
*/ Zone?: string; /** *实例机型。
*/ InstanceType?: string; /** *实例机型系列。
*/ InstanceFamily?: string; /** *GPU核数,单位:核。
*/ GPU?: number; /** *CPU核数,单位:核。
*/ CPU?: number; /** *内存容量,单位:GiB。
FPGA核数,单位:核。
*/ FPGA?: number; /** *实例机型映射的物理GPU卡数,单位:卡。vGPU卡型小于1,直通卡型大于等于1。vGPU是通过分片虚拟化技术,将物理GPU卡重新划分,同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。
*/ GpuCount?: number; /** *实例GPU类型
*/ GpuType?: string; /** *实例GPU单块显存,单位:GiB。
*/ GpuMemory?: number; } /** * RepairTaskControl请求参数结构体 */ export interface RepairTaskControlRequest { /** * 待授权任务实例对应的产品类型,支持取值: - `CVM`:云服务器 - `CDH`:专用宿主机 - `CPM2.0`:裸金属云服务器 */ Product: string; /** * 指定待操作的实例ID列表,仅允许对列表中的实例ID相关的维修任务发起授权,可通过 [DescribeTaskInfo](https://cloud.tencent.com/document/api/213/87933) 接口返回值中的`InstanceId`获取。 */ InstanceIds: Array可用区名称,例如,ap-guangzhou-3
全网可用区名称如下:
可用区描述,例如,广州三区
*/ 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; } /** * PurchaseResourcePoolPacks请求参数结构体 */ export interface PurchaseResourcePoolPacksRequest { /** * 实例资源池预扣包所在可用区。形如:ap-guangzhou-6。可通过[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口获取可用区列表。 */ Zone: string; /** * 实例资源池预扣包的规格,仅支持半整机/整机规格。形如:SA9.96XLARGE1152(SA9半整机)。 */ InstanceType: string; /** * 实例资源池预扣包的数量。1个数量代表1个半整机/整机资源池。取值范围:1-100。 */ InstanceCount: number; /** * 实例资源池预扣包的时长,单位:月。取值范围:1-60。 */ Period: number; /** * 实例资源池类型。取值范围:当通过本接口来创建实例时会返回该参数,表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功,可根据 DescribeInstances 接口查询返回的InstancesSet中对应实例的ID的状态来判断创建是否完成;如果实例状态由“PENDING(创建中)”变为“RUNNING(运行中)”,则为创建成功。
可用区机型配置列表。
*/ InstanceTypeQuotaSet?: Array一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。
修改后实例名称。可任意命名,但不得超过60个字符。
*/ InstanceName?: string; /** *提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16 KB。关于获取此参数的详细介绍,请参阅 Windows 和 Linux 启动时运行命令。
*/ UserData?: string; /** *指定实例的修改后的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。
*/ SecurityGroups?: Array给实例绑定用户角色,传空值为解绑操作
*/ CamRoleName?: string; /** *修改后实例的主机名。
实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:
角色类别,与CamRoleName搭配使用,该值可从CAM DescribeRoleList 或 GetRole 接口返回RoleType字段获取,当前只接受user、system和service_linked三种类别。
举例:一般CamRoleName中包含“LinkedRoleIn”(如TKE_QCSLinkedRoleInPrometheusService)时,DescribeRoleList和GetRole返回的RoleType为service_linked,则本参数也需要传递service_linked。
该参数默认值为user,若CameRoleName为非service_linked类型,本参数可不传递。
修改实例主机名是否自动重启实例,不传默认自动重启。
实例是否开启巨型帧,取值范围:
分散置放群组ID列表。
*/ DisasterRecoverGroupId?: string; /** *分散置放群组类型,取值范围:
分散置放群组名称,长度1-60个字符,支持中、英文。
*/ Name?: string; /** *置放群组内可容纳的云服务器数量。
*/ CvmQuotaTotal?: number; /** *置放群组内已有的云服务器数量。
*/ CurrentNum?: number; /** *分散置放群组创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
*/ CreateTime?: string; /** *置放群组类型,当前支持两种,分散置放群组和分区置放群组(功能灰度中),取值范围:PARTITION:分区置放群组,SPREAD:分散置放群组,默认是分散置放群组。
*/ Strategy?: string; /** *分区置放群组的分区数量,取值范围:2-30,当置放群组类型是分区置放群组时,才有该值(分区置放群组功能灰度中)。
*/ PartitionCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RemoveChcAssistVpc请求参数结构体 */ export interface RemoveChcAssistVpcRequest { /** * CHC物理服务器Id。 */ ChcIds: Array按照【可用区】进行过滤。形如:ap-guangzhou-6。
类型:String
必选:是
可选项:可用区列表
按照【实例族】进行过滤。形如:SA9。
类型:String
必选:否
按照【实例规格】进行过滤。形如:SA9.96XLARGE1152。
类型:String
必选:否
每次请求的`Filters`的上限为10。 */ Filters: Array按照【标签键】进行过滤。
类型:String
必选:否
按照【标签值】进行过滤。
类型:String
必选:否
按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。
类型:String
必选:否
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。 */ Filters?: Array一个或多个待操作的实例ID,每次请求批量实例的上限为100。
可以通过以下方式获取可用的实例ID:
InstanceId 获取实例ID。密钥对ID列表,列表长度上限为100。可以通过以下方式获取可用的密钥ID:
KeyId 获取密钥对ID。是否强制关机,默认值为 false。常规场景下,建议手动关机后解绑密钥。取值范围:
按照【配置规格状态】进行过滤。配置规格状态形如:SELL(表示实例可售卖)、UNAVAILABLE(表示实例不可用)。
类型:String
必选:否
每次请求的`Filters`的上限为10,`Filter.Values`的上限为2。 */ Filters?: Array实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
注:如果您不指定LaunchTemplate参数,则Placement为必选参数。若同时传递Placement和LaunchTemplate,则默认覆盖LaunchTemplate中对应的Placement的值。
指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。ImageId字段。实例计费类型。
预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/ InstanceChargePrepaid?: InstanceChargePrepaid; /** *实例机型。不同实例机型指定了不同的资源规格。
实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/ SystemDisk?: SystemDisk; /** *实例数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
*/ DataDisks?: Array私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络IP,那么InstanceCount参数只能为1。
*/ VirtualPrivateCloud?: VirtualPrivateCloud; /** *公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/ InternetAccessible?: InternetAccessible; /** *购买实例数量。取值范围:[1,100]。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量,具体配额相关限制详见CVM实例购买限制。
*/ InstanceCount?: number; /** *实例显示名称。
{R:x},表示生成数字[x, x+n-1],其中n表示购买实例的数量,例如server_{R:3},购买1台时,实例显示名称为server_3;购买2台时,实例显示名称分别为server_3,server_4。支持指定多个模式串{R:x}。1、2...n,其中n表示购买实例的数量,例如server_,购买2台时,实例显示名称分别为server_1,server_2。实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
*/ LoginSettings?: LoginSettings; /** *实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的 SecurityGroupId 字段来获取。若不指定该参数,则绑定指定项目下的默认安全组,如默认安全组不存在则将自动创建。
增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
*/ EnhancedService?: EnhancedService; /** *用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/ ClientToken?: string; /** *云服务器的主机名。
标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到云服务器实例。
*/ TagSpecification?: Array实例的市场相关选项,如竞价实例相关参数
*/ InstanceMarketOptions?: InstanceMarketOptionsRequest; /** *自定义metadata,支持创建 CVM 时添加自定义元数据键值对。
注:内测中。
*/ Metadata?: Metadata; /** *高性能计算集群ID。
*/ HpcClusterId?: string; /** *描述了实例CPU拓扑结构的相关信息。若不指定该参数,则按系统资源情况决定。
*/ CpuTopology?: CpuTopology; /** *实例启动模板。
*/ LaunchTemplate?: LaunchTemplate; /** *多网卡参数信息。 此功能仅部分地区灰度开放,如需使用请提交工单咨询
*/ NetworkInterfaces?: Array分散置放群组名称,长度1-60个字符,支持中、英文。
*/ Name: string; /** *分散置放群组类型,取值范围:
用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
更多详细信息请参阅:如何保证幂等性。
置放群组的亲和度,在置放群组的实例会按该亲和度分布,亲和度的取值范围是:1-10,默认为1
*/ Affinity?: number; /** *置放群组类型,当前支持两种,分散置放群组和分区置放群组(灰度中),取值范围:PARTITION:分区置放群组,SPREAD:分散置放群组,不传该值默认是分散置放群组。
*/ Strategy?: string; /** *分区置放群组的分区数量,取值范围:2-30,当置放群组类型是分区置放群组时传入(分区置放群组功能灰度中)。
*/ PartitionCount?: number; /** *标签描述列表。通过指定该参数可以绑定标签到置放群组。
*/ TagSpecification?: Array实例所在的位置。
*/ Placement?: Placement; /** *实例ID。
实例机型。
*/ InstanceType?: string; /** *实例的CPU核数,单位:核。
*/ CPU?: number; /** *实例内存容量,单位:GiB。
实例业务状态。取值范围:
实例名称。
*/ InstanceName?: string; /** *实例计费类型。取值范围:
实例系统盘信息。
*/ SystemDisk?: SystemDisk; /** *实例数据盘信息。
*/ DataDisks?: Array实例主网卡的内网IP列表。
实例主网卡的公网IP列表。
实例带宽信息。
*/ InternetAccessible?: InternetAccessible; /** *实例所属虚拟私有网络信息。
*/ VirtualPrivateCloud?: VirtualPrivateCloud; /** *生产实例所使用的镜像ID。
自动续费标识。取值范围:
NOTIFY_AND_MANUAL_RENEW:表示通知即将过期,但不自动续费NOTIFY_AND_AUTO_RENEW:表示通知即将过期,而且自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:表示不通知即将过期,也不自动续费。创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
到期时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。注意:后付费模式本项为null
操作系统名称。
*/ OsName?: string; /** *实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。
*/ SecurityGroupIds?: Array实例登录设置。目前只返回实例所关联的密钥。
*/ LoginSettings?: LoginSettings; /** *实例状态。状态类型详见实例状态表
*/ InstanceState?: string; /** *实例关联的标签列表。
*/ Tags?: Array实例的关机计费模式。
取值范围:
实例全局唯一ID
*/ Uuid?: string; /** *实例的最新操作。例:StopInstances、ResetInstance。
注意:此字段可能返回 null,表示取不到有效值。 */ LatestOperation?: string; /** *实例的最新操作状态。取值范围:
实例最新操作的唯一请求 ID。
注意:此字段可能返回 null,表示取不到有效值。 */ LatestOperationRequestId?: string; /** *分散置放群组ID。
* @deprecated */ DisasterRecoverGroupId?: string; /** *实例的IPv6地址。
注意:此字段可能返回 null,表示取不到有效值。 */ IPv6Addresses?: ArrayCAM角色名。
注意:此字段可能返回 null,表示取不到有效值。 */ CamRoleName?: string; /** *高性能计算集群ID。
高性能计算集群IP列表。
实例所在的专用集群ID。
实例隔离类型。取值范围:
置放群组列表(目前仅支持一个)
*/ DisasterRecoverGroupIds?: ArrayGPU信息。如果是gpu类型子机,该值会返回GPU信息,如果是其他类型子机则不返回。
*/ GPUInfo?: GPUInfo; /** *实例的操作系统许可类型,默认为TencentCloud
*/ LicenseType?: string; /** *实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:
实例主机名。
*/ HostName?: string; /** *默认登录用户。
*/ DefaultLoginUser?: string; /** *默认登录端口。
*/ DefaultLoginPort?: number; /** *实例的最新操作错误信息。
注意:此字段可能返回 null,表示取不到有效值。 */ LatestOperationErrorMsg?: string; /** *实例是否开启巨型帧
*/ EnableJumboFrame?: boolean; /** *自定义metadata,本参数对应创建 CVM时指定的Metadata 信息。注:内测中。
*/ Metadata?: Metadata; /** *实例绑定的公网IPv6地址。
*/ PublicIPv6Addresses?: Array描述了实例CPU拓扑结构的相关信息。
*/ CpuTopology?: CpuTopology; /** *分区置放群组的分区号,具体取决于所选置放群组的分区数量(功能灰度中)
*/ PartitionNumber?: number; } /** * CreateLaunchTemplateVersion请求参数结构体 */ export interface CreateLaunchTemplateVersionRequest { /** *实例所在的位置。通过该参数可以指定实例所属可用区,所属项目,所属宿主机(在专用宿主机上创建子机时指定)等属性。
*/ Placement: Placement; /** *启动模板ID,新版本将基于该实例启动模板ID创建。可通过 DescribeLaunchTemplates 接口返回值中的LaunchTemplateId获取。
若给定,新实例启动模板将基于给定的版本号创建。若未指定则使用默认版本,可以通过 DescribeLaunchTemplateVersions查询默认版本。
*/ LaunchTemplateVersion?: number; /** *实例启动模板版本描述。长度为2~256个英文或中文字符,不指定该参数时默认为空字符。
*/ LaunchTemplateVersionDescription?: string; /** *实例机型。不同实例机型指定了不同的资源规格。
指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询;云镜像市场的镜像ID可通过云市场查询。ImageId字段。实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/ SystemDisk?: SystemDisk; /** *实例数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
*/ DataDisks?: Array私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络IP,即表示每个实例的主网卡IP;同时,InstanceCount参数必须与私有网络IP的个数一致且不能大于20。
*/ VirtualPrivateCloud?: VirtualPrivateCloud; /** *公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/ InternetAccessible?: InternetAccessible; /** *购买实例数量。具体配额相关限制详见CVM实例购买限制。
*/ InstanceCount?: number; /** *实例显示名称。
{R:x},表示生成数字[x, x+n-1],其中n表示购买实例的数量,例如server_{R:3},购买1台时,实例显示名称为server_3;购买2台时,实例显示名称分别为server_3,server_4。支持指定多个模式串{R:x}。1、2...n,其中n表示购买实例的数量,例如server_,购买2台时,实例显示名称分别为server_1,server_2。实例登录设置。通过该参数可以设置实例的登录方式为密钥或保持镜像的原始登录设置。
*/ LoginSettings?: LoginSettings; /** *实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。
*/ SecurityGroupIds?: Array增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认公共镜像开启云监控、云安全服务;自定义镜像与云镜像市场镜像默认不开启云监控,云安全服务,而使用镜像里保留的服务。
*/ EnhancedService?: EnhancedService; /** *用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/ ClientToken?: string; /** *云服务器的主机名。
定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。
*/ ActionTimer?: ActionTimer; /** *置放群组id,仅支持指定一个。可使用DescribeDisasterRecoverGroups接口获取。
*/ DisasterRecoverGroupIds?: Array标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到云服务器实例。
*/ TagSpecification?: Array实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
*/ InstanceMarketOptions?: InstanceMarketOptionsRequest; /** *提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。关于获取此参数的详细介绍,请参阅Windows和Linux启动时运行命令。
*/ UserData?: string; /** *是否只预检此次请求。
true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。
如果检查不通过,则返回对应错误码;
如果检查通过,则返回RequestId.
false(默认):发送正常请求,通过检查后直接创建实例。
CAM角色名称。可通过 DescribeRoleList 接口返回值中的roleName获取。
高性能计算集群ID。若创建的实例为高性能计算实例,需指定实例放置的集群,否则不可指定。该参数可以通过调用 DescribeHpcClusters 的返回值中的 HpcClusterId 字段来获取。
实例计费类型。
预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/ InstanceChargePrepaid?: InstanceChargePrepaid; /** *实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:
实例是否开启巨型帧,取值范围:
<li/> true:表示实例开启巨型帧,只有支持巨型帧的机型可设置为true。
<li/>false:表示实例关闭巨型帧,只有支持巨型帧的机型可设置为false。
支持巨型帧的实例规格: 实例规格
自定义metadata,支持创建 CVM 时添加自定义元数据键值对。
注:内测中。
只允许传递 Update 和 Replace 参数,在模板使用自定义 Metadata 且在 RunInstances 也传递 Metadata 时生效。默认采用 Replace。
多网卡参数信息。 此功能仅部分地区灰度开放,如需使用请提交工单咨询
*/ NetworkInterfaces?: Array实例启动模板名称。长度为2~128个英文或中文字符。
*/ LaunchTemplateName: string; /** *实例所在的位置。通过该参数可以指定实例所属可用区,所属项目,所属宿主机(在专用宿主机上创建子机时指定)等属性。
*/ Placement: Placement; /** *指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。ImageId字段。实例启动模板版本描述。长度为2~256个英文或中文字符,默认为空字符。
*/ LaunchTemplateVersionDescription?: string; /** *实例机型。不同实例机型指定了不同的资源规格。
实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/ SystemDisk?: SystemDisk; /** *实例数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘,详情请参考 云硬盘使用限制。
*/ DataDisks?: Array私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络IP,即表示每个实例的主网卡IP;同时,InstanceCount参数必须与私有网络IP的个数一致且不能大于20。
*/ VirtualPrivateCloud?: VirtualPrivateCloud; /** *公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/ InternetAccessible?: InternetAccessible; /** *购买实例数量。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量,具体配额相关限制详见CVM实例购买限制。
*/ InstanceCount?: number; /** *实例显示名称。
{R:x},表示生成数字[x, x+n-1],其中n表示购买实例的数量,例如server_{R:3},购买1台时,实例显示名称为server_3;购买2台时,实例显示名称分别为server_3,server_4。支持指定多个模式串{R:x}。1、2...n,其中n表示购买实例的数量,例如server_,购买2台时,实例显示名称分别为server_1,server_2。实例登录设置。通过该参数可以设置实例的登录方式为密钥或保持镜像的原始登录设置。
*/ LoginSettings?: LoginSettings; /** *实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的 SecurityGroupId 字段来获取。若不指定该参数,则绑定指定项目下的默认安全组,如默认安全组不存在则将自动创建。
增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认公共镜像开启云监控、云安全服务;自定义镜像与镜像市场镜像默认不开启云监控,云安全服务,而使用镜像里保留的服务。
*/ EnhancedService?: EnhancedService; /** *用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/ ClientToken?: string; /** *云服务器的主机名。
定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。
*/ ActionTimer?: ActionTimer; /** *置放群组id,仅支持指定一个。该参数可以通过调用 DescribeDisasterRecoverGroups 的返回值中的 DisasterRecoverGroupId 字段来获取。
标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到云服务器实例。
*/ TagSpecification?: Array实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。
*/ InstanceMarketOptions?: InstanceMarketOptionsRequest; /** *提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。关于获取此参数的详细介绍,请参阅Windows和Linux启动时运行命令。
*/ UserData?: string; /** *是否只预检此次请求。
true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。
如果检查不通过,则返回对应错误码;
如果检查通过,则返回RequestId.
false(默认):发送正常请求,通过检查后直接创建实例。
CAM角色名称。可通过 DescribeRoleList 接口返回值中的RoleName获取。
高性能计算集群ID。若创建的实例为高性能计算实例,需指定实例放置的集群,否则不可指定。该参数可以通过调用 DescribeHpcClusters 的返回值中的 HpcClusterId 字段来获取。
实例计费类型。
预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/ InstanceChargePrepaid?: InstanceChargePrepaid; /** *实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:
实例是否开启巨型帧,取值范围:
<li/> true:表示实例开启巨型帧,只有支持巨型帧的机型可设置为true。
<li/>false:表示实例关闭巨型帧,只有支持巨型帧的机型可设置为false。
支持巨型帧的实例规格: 实例规格
标签描述列表。通过指定该参数可以绑定标签到实例启动模板。
*/ LaunchTemplateTagSpecification?: Array自定义metadata,支持创建 CVM 时添加自定义元数据键值对。
注:内测中。
只允许传递 Update 和 Replace 参数,在模板使用自定义 Metadata 且在 RunInstances 也传递 Metadata 时生效。默认采用 Replace。
多网卡参数信息。 此功能仅部分地区灰度开放,如需使用请提交工单咨询
*/ NetworkInterfaces?: Array按照【实例启动模板名称】进行过滤。
类型:String
必选:否
按照【标签键】进行过滤。
类型:String
必选:否
按照【标签值】进行过滤。
类型:String
必选:否
按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。
类型:String
必选:否
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`LaunchTemplateIds`和`Filters`。 */ Filters?: Array当通过本接口来创建实例启动模板时会返回该参数,表示创建成功的实例启动模板ID。
表示是主网卡还是辅助网卡。注意:枚举值要全部大写;NetworkInterfaces数组中必须要有PRIMARY,且PRIMARY只能存在一个,SECONDARY可以存在多个。
枚举值:
私有网络ID,形如vpc-xxx。有效的VpcId可通过登录控制台查询;也可以调用接口 DescribeVpcs ,从接口返回中的VpcId字段获取。若在创建子机时VpcId与SubnetId同时传入DEFAULT,则强制使用默认vpc网络。
私有网络子网ID,形如subnet-xxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 DescribeSubnets ,从接口返回中的SubnetId字段获取。若在创建子机时SubnetId与VpcId同时传入DEFAULT,则强制使用默认vpc网络。
此字段是必填字段,表示每张网卡自动分配私有网卡IP个数。注意:不允许客户同时指定ip且动态分配ip。
取值范围:[1, 50]
*/ PrivateIpv4AddressCount: number; /** *指定存量的网卡ID用于绑定。只对辅助网卡生效,主网卡的生成采用既有流程。注:客户手动指定已有弹性网卡时,相关接口InstanceCount必须为1。主网卡不支持指定。
*/ NetworkInterfaceId?: string; /** *实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的 SecurityGroupId 字段来获取。若不指定该参数,则绑定指定项目下的默认安全组,如默认安全组不存在则将自动创建。
每个用户在每个地域每个项目下最多可设置50个安全组。
*/ SecurityGroupIds?: Array是否随CVM删除绑定的弹性网卡,参数只对辅助网卡生效。默认保留辅助网卡兼容当前线上行为。该参数放置在主网卡上不生效,主网卡会随着CVM一同销毁。
默认值:false
按照【可用区】进行过滤。可用区形如:ap-guangzhou-6。
类型:String
必选:否
可选项:可用区列表
按照【实例机型系列】进行过滤。实例机型系列形如:S1、I1、M1等。具体取值参见[实例类型](https://cloud.tencent.com/document/product/213/11518)描述。
类型:String
必选:否
按照【实例类型】进行过滤。实例类型形如:S5.12XLARGE128、S5.12XLARGE96等。具体取值参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。
类型:String
必选:否
每次请求的`Filters`的上限为10,`Filter.Values`的上限为1。 */ Filters?: Array实例计费类型。
预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/ InstanceChargePrepaid?: InstanceChargePrepaid; /** *实例所在的位置。通过该参数可以指定实例所属可用区,所属项目,所属宿主机(在专用宿主机上创建子机时指定)等属性。
注:如果您不指定LaunchTemplate参数,则Placement为必选参数。若同时传递Placement和LaunchTemplate,则默认覆盖LaunchTemplate中对应的Placement的值。
实例机型。不同实例机型指定了不同的资源规格。
指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。ImageId字段。实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
*/ SystemDisk?: SystemDisk; /** *实例数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
*/ DataDisks?: Array私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若在此参数中指定了私有网络IP,即表示每个实例的主网卡IP;同时,InstanceCount参数必须与私有网络IP的个数一致且不能大于20。
*/ VirtualPrivateCloud?: VirtualPrivateCloud; /** *公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
*/ InternetAccessible?: InternetAccessible; /** *购买实例数量。包年包月实例取值范围:[1,500],按量计费实例取值范围:[1,500]。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量,具体配额相关限制详见CVM实例购买限制。
*/ InstanceCount?: number; /** *指定创建实例的最小数量,取值范围为不大于InstanceCount的正整数。
指定最小数量时,承诺最少创建MinCount台实例,并尽量创建InstanceCount台实例。
库存不足以满足最小数量时,API 会返回库存不足最小数量的错误信息。
仅对支持部分发货的账号、区域和计费模式(包年包月、按量计费、竞价实例、按量包销)生效。
实例显示名称。
实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
*/ LoginSettings?: LoginSettings; /** *实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的 SecurityGroupId 字段来获取。若不指定该参数,则绑定指定项目下的默认安全组,如默认安全组不存在则将自动创建。
增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认公共镜像开启云监控、云安全服务;自定义镜像与镜像市场镜像默认不开启云监控,云安全服务,而使用镜像里保留的服务。
*/ EnhancedService?: EnhancedService; /** *用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/ ClientToken?: string; /** *实例主机名。
定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。
*/ ActionTimer?: ActionTimer; /** *置放群组id,仅支持指定一个。
*/ DisasterRecoverGroupIds?: Array标签描述列表。通过指定该参数可以同时绑定标签到相应的云服务器、云硬盘实例。
*/ TagSpecification?: Array实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费但没有传递该参数时,默认按当前固定折扣价格出价。
*/ InstanceMarketOptions?: InstanceMarketOptionsRequest; /** *提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。关于获取此参数的详细介绍,请参阅Windows和Linux启动时运行命令。
*/ UserData?: string; /** *自定义metadata,支持创建 CVM 时添加自定义元数据键值对。
注:内测中。
是否只预检此次请求。
true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。
如果检查不通过,则返回对应错误码;
如果检查通过,则返回RequestId.
false(默认):发送正常请求,通过检查后直接创建实例
描述了实例CPU拓扑结构的相关信息。若不指定该参数,则按系统资源情况决定。
*/ CpuTopology?: CpuTopology; /** *CAM角色名称。可通过 DescribeRoleList 接口返回值中的RoleName获取。
高性能计算集群ID。若创建的实例为高性能计算实例,需指定实例放置的集群,否则不可指定。
*/ HpcClusterId?: string; /** *实例启动模板。
*/ LaunchTemplate?: LaunchTemplate; /** *指定专用集群创建。
*/ DedicatedClusterId?: string; /** *指定CHC物理服务器来创建CHC云主机。
*/ ChcIds?: Array分区置放群组的分区序号,具体取决于所选置放群组的分区数量,如果选中的置放群组是分区置放群组,该值不传默认随机。(功能灰度中)
*/ PartitionNumber?: number; /** *实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:
实例是否开启巨型帧,取值范围:
<li/> true:表示实例开启巨型帧,只有支持巨型帧的机型可设置为true。
<li/>false:表示实例关闭巨型帧,只有支持巨型帧的机型可设置为false。
支持巨型帧的实例规格: 实例规格
多网卡参数信息。 此功能仅部分地区灰度开放,如需使用请提交工单咨询
*/ NetworkInterfaces?: Array按照【实例资源池ID】进行过滤。形如:rpp-rn99mzt2。
类型:String
必选:否
按照【可用区】进行过滤。形如:ap-guangzhou-6。
类型:String
必选:否
可选项:可用区列表
按照【实例类型】进行过滤。形如:SA9。
类型:String
必选:否
按照【实例规格】进行过滤。形如:SA9.96XLARGE1152。
类型:String
必选:否
按照【实例资源池状态】进行过滤。
类型:String
必选:否
可选项:CREATING (创建中) | ACTIVE (运行中) | RETIRED (已过期)
每次请求的`Filters`的上限为10。 */ Filters?: Array待操作的实例ID数组。可通过 DescribeInstances 接口返回值中的InstanceId获取。
私有网络相关信息配置,通过该参数指定私有网络的ID,子网ID,私有网络ip等信息。
PrivateIpAddresses指定私有网络子网IP,若需指定则所有已指定的实例均需要指定子网IP,此时InstanceIds与PrivateIpAddresses一一对应。PrivateIpAddresses时随机分配私有网络子网IP。是否对运行中的实例选择强制关机。默认为true。
*/ ForceStop?: boolean; /** *是否保留主机名。
默认值:true
*/ ReserveHostName?: boolean; } /** * DeleteInstancesDisasterRecoverGroups返回参数结构体 */ export interface DeleteInstancesDisasterRecoverGroupsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述预付费模式,即包年包月相关参数。包括购买时长和自动续费逻辑等。 */ export interface ChargePrepaid { /** * 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。 */ Period: number; /** * 自动续费标识。取值范围:按照【可用区】进行过滤。可用区形如:ap-guangzhou-6。
类型:String
必选:否
可选项:可用区列表
按照【实例机型系列】进行过滤。实例机型系列形如:S1、I1、M1等。具体取值参见[实例类型](https://cloud.tencent.com/document/product/213/11518)描述。
类型:String
必选:否
按照【实例机型】进行过滤。不同实例机型指定了不同的资源规格,具体取值可通过调用接口 [DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/product/213/15749) 来获得最新的规格表或参见[实例类型](https://cloud.tencent.com/document/product/213/11518)描述。若不指定该参数,则默认查询筛选条件下所有机型。
类型:String
必选:否
按照【实例计费模式】进行过滤。
- PREPAID:预付费,即包年包月
- POSTPAID_BY_HOUR:后付费,即按量计费
- CDHPAID:独享子机
- SPOTPAID:竞价付费
- CDCPAID:专用集群付费
类型:String
必选:否
按关键字进行排序,格式为排序字段加排序方式,中间用冒号分隔。 例如: 按cpu数逆序排序 "cpu:desc", 按mem大小顺序排序 "mem:asc"
类型:String
必选:否
每次请求的Filters的上限为10,Filter.Values的上限为100。
*/
Filters?: Array该参数表示对应配置实例的价格。
*/ Price?: Price; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 创建资源实例时同时绑定的标签对说明 */ export interface TagSpecification { /** * 标签绑定的资源类型,云服务器为“instance”,专用宿主机为“host”,镜像为“image”,密钥为“keypair”,置放群组为“ps”,高性能计算集群为“hpc”。 */ ResourceType: string; /** * 标签对列表 */ Tags: Array按照【可用区】进行过滤。可用区形如:ap-guangzhou-6。
类型:String
必选:否
可选项:可用区列表
按照【项目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。
类型:Integer
必选:否
按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID形如:host-xxxxxxxx。
类型:String
必选:否
按照【CDH实例名称】进行过滤。
类型:String
必选:否
按照【CDH实例状态】进行过滤。(PENDING:创建中 | LAUNCH_FAILURE:创建失败 | RUNNING:运行中 | EXPIRED:已过期)
类型:String
必选:否
按照【CDH机型】进行过滤。
类型:String
必选:否
按照【标签键】进行过滤。
类型:String
必选:否
按照【标签值】进行过滤。
类型:String
必选:否
按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例。
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。 */ Filters?: Array按照【可用区】进行过滤。可用区形如:ap-guangzhou-6。
类型:String
必选:否
可选项:可用区列表
按照【配额类型】进行过滤。配额类型形如:PostPaidQuotaSet。
类型:String
必选:否
可选项:
PostPaidQuotaSet: 后付费配额
PrePaidQuotaSet: 预付费配额
SpotPaidQuotaSet: 竞价配额
ImageQuotaSet: 镜像配额
DisasterRecoverGroupQuotaSet: 置放群组配额
*/ Filters?: Array一个或多个待操作的实例ID。可通过 DescribeInstances 接口返回值中的InstanceId获取。每次请求批量实例的上限为100。
释放弹性IP。EIP2.0下,仅提供主网卡下首个EIP,EIP类型限定在HighQualityEIP、AntiDDoSEIP、EIPv6、HighQualityEIPv6这几种类型。默认行为不释放。
默认值:false
*/ ReleaseAddress?: boolean; /** *释放实例挂载的包年包月数据盘。true表示销毁实例同时释放包年包月数据盘,false表示只销毁实例。
默认值:false
CHC物理服务器id列表,如["chc-1a2b3c4d"]
*/ ChcIds: Array所要切换的网络模式
枚举值:
实例ID。可通过 DescribeInstances API返回值中的InstanceId获取。
指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。ImageId字段。实例系统盘配置信息。系统盘为云盘的实例可以通过该参数指定重装后的系统盘大小来实现对系统盘的扩容操作。系统盘大小只支持扩容不支持缩容;重装只支持修改系统盘的大小,不能修改系统盘的类型。
*/ SystemDisk?: SystemDisk; /** *实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
*/ LoginSettings?: LoginSettings; /** *增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认公共镜像开启云监控、云安全服务;自定义镜像与镜像市场镜像默认不开启云监控,云安全服务,而使用镜像里保留的服务。
*/ EnhancedService?: EnhancedService; /** *重装系统时,可以指定修改实例的主机名。
提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。关于获取此参数的详细介绍,请参阅Windows和Linux启动时运行命令。
*/ UserData?: string; } /** * ImportImage返回参数结构体 */ export interface ImportImageResponse { /** * 镜像 ID */ ImageId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDisasterRecoverGroupAttribute请求参数结构体 */ export interface ModifyDisasterRecoverGroupAttributeRequest { /** *分散置放群组ID,可使用DescribeDisasterRecoverGroups接口获取。
*/ DisasterRecoverGroupId: string; /** *分散置放群组名称,长度1-60个字符,支持中、英文。
*/ Name: string; /** *分散置放群组的亲和度,在置放群组的实例会按该亲和度分布,亲和度的取值范围是:1-10。
取值范围:[1, 10]
调整只能从小调到大,不能从大调到小
*/ Affinity?: number; } /** * ConfigureChcAssistVpc返回参数结构体 */ export interface ConfigureChcAssistVpcResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RebootInstances返回参数结构体 */ export interface RebootInstancesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeChcHosts请求参数结构体 */ export interface DescribeChcHostsRequest { /** * CHC物理服务器实例ID。每次请求的实例的上限为100。参数不支持同时指定`ChcIds`和`Filters`。 */ ChcIds?: Array按照【可用区】进行过滤。可用区形如:ap-guangzhou-6。
类型:String
必选:否
可选项:可用区列表
按照【实例名称】进行过滤。
类型:String
必选:否
按照【实例状态】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)
类型:String
必选:否
按照【设备类型】进行过滤。
类型:String
必选:否
按照【私有网络唯一ID】进行过滤。
类型:String
必选:否
按照【私有子网唯一ID】进行过滤。
类型:String
必选:否
按照【设备SN】进行过滤。
类型:String
必选:否
*/ Filters?: Array新创建的实例启动模板版本号。
*/ LaunchTemplateVersionNumber?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 镜像配额 */ export interface ImageQuota { /** * 已使用配额 */ UsedQuota?: number; /** * 总配额 */ TotalQuota?: number; } /** * ModifyImageAttribute返回参数结构体 */ export interface ModifyImageAttributeResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceRenewInstances请求参数结构体 */ export interface InquiryPriceRenewInstancesRequest { /** * 一个或多个待操作的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。每次请求批量实例的上限为100。 */ InstanceIds: Array按照【可用区】进行过滤。可用区例如:ap-guangzhou-6。
类型:String
必选:否
可选项:可用区列表
按照【项目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。
类型:Integer
必选:否
按照【[CDH](https://cloud.tencent.com/document/product/416) ID】进行过滤。[CDH](https://cloud.tencent.com/document/product/416) ID例如:host-xxxxxxxx。
类型:String
必选:否
按照【[CDC](https://cloud.tencent.com/document/product/1346) ID】进行过滤。[CDC](https://cloud.tencent.com/document/product/1346) ID例如:cluster-xxxxxxx。
类型:String
必选:否
按照【VPC ID】进行过滤。VPC ID例如:vpc-xxxxxxxx。
类型:String
必选:否
按照【子网ID】进行过滤。子网ID例如:subnet-xxxxxxxx。
类型:String
必选:否
按照【实例ID】进行过滤。实例ID例如:ins-xxxxxxxx。
类型:String
必选:否
按照【实例UUID】进行过滤。实例UUID例如:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。
类型:String
必选:否
按照【安全组ID】进行过滤。安全组ID例如: sg-8jlk3f3r。
类型:String
必选:否
按照【实例名称】进行过滤。
类型:String
必选:否
按照【实例计费模式】进行过滤。(PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费 | CDHPAID:表示[CDH](https://cloud.tencent.com/document/product/416)付费,即只对[CDH](https://cloud.tencent.com/document/product/416)计费,不对[CDH](https://cloud.tencent.com/document/product/416)上的实例计费。)
类型:String
必选:否
按照【实例状态】进行过滤。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753#InstanceStatus)
类型:String
必选:否
按照【实例主网卡的内网IP】进行过滤。
类型:String
必选:否
按照【实例主网卡的公网IP】进行过滤,包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。
类型:String
必选:否
按照【实例的IPv6地址】进行过滤。
类型:String
必选:否
按照【标签键】进行过滤。
类型:String
必选:否
按照【标签值】进行过滤。
类型:String
必选:否
按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。
类型:String
必选:否
按照【创建实例请求的起始时间】进行过滤。例如:2023-06-01 00:00:00。
类型:String
必选:否
按照【创建实例请求的截止时间】进行过滤。例如:2023-06-01 00:00:00。
类型:String
必选:否
每次请求的`Filters`的上限为10,`Filter.Values`的上限为5。参数不支持同时指定`InstanceIds`和`Filters`。 */ Filters?: Array按照【镜像ID】进行过滤。
类型:String
必选:否
按照【镜像类型】进行过滤。
类型:String
必选:否
可选项:
PRIVATE_IMAGE: 自定义镜像 (本账户创建的镜像)
PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)
SHARED_IMAGE: 共享镜像(其他账户共享给本账户的镜像)
按照【镜像名称】进行过滤。支持模糊查询。
类型:String
必选:否
按照【镜像平台】进行过滤,如 CentOS,支持模糊匹配。可通过 DescribeImages 接口返回的 Platform 获取。
类型:String
必选:否
按照【标签键】进行过滤。可通过 GetTags 接口返回的 TagKey 获取。
类型:String
必选:否
按照【标签值】进行过滤。可通过 GetTags 接口返回的 TagValue 获取。
类型:String
必选:否
按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。可通过 GetTags 接口返回的 TagKey 和 TagValue 获取。
类型:String
必选:否
按照【本地专用集群CDC ID】进行过滤。可通过 DescribeDedicatedClusters 接口返回的 DedicatedClusterSet 获取。
类型:String
必选:否
按照【CDC镜像缓存状态】进行过滤。
类型:String
必选:否
可选项:
CACHED_ALL: 全部缓存状态
CACHING: 缓存中
CACHED: 已缓存
CACHE_INVALID: 缓存失效
CACHE_FAILED: 缓存失败
*/ Filters?: Array分散置放群组id。
*/ DisasterRecoverGroupId?: string; /** *分散置放群组名称,长度1-60个字符。
*/ Name?: string; /** *分散置放群组类型,取值范围:
分散置放群组内最大容纳云服务器数量。
*/ CvmQuotaTotal?: number; /** *分散置放群组内云服务器当前数量。
*/ CurrentNum?: number; /** *分散置放群组内,云服务器id列表。
*/ InstanceIds?: Array分散置放群组创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
置放群组亲和度
*/ Affinity?: number; /** *置放群组类型,当前支持两种;分散置放群组和分区置放群组(功能灰度中),取值范围:PARTITION:分区置放群组,SPREAD:分散置放群组
*/ Strategy?: string; /** *分区置放群组的分区数量,如果是分区置放群组会返回(功能灰度中)
*/ PartitionCount?: number; /** *置放群组关联的标签列表。
*/ Tags?: Array私有网络ID,形如vpc-xxx。有效的VpcId可通过登录控制台查询;也可以调用接口 DescribeVpcs ,从接口返回中的VpcId字段获取。若在创建子机时VpcId与SubnetId同时传入DEFAULT,则强制使用默认vpc网络。
私有网络子网ID,形如subnet-xxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 DescribeSubnets ,从接口返回中的SubnetId字段获取。若在创建子机时SubnetId与VpcId同时传入DEFAULT,则强制使用默认vpc网络。
是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围:
私有网络子网 IP 数组,在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。
*/ PrivateIpAddresses?: Array为弹性网卡指定随机生成的 IPv6 地址数量。
*/ Ipv6AddressCount?: number; } /** * 描述了按带宽计费的相关信息 */ export interface InternetBandwidthConfig { /** * 开始时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。 */ StartTime?: string; /** * 结束时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。 */ EndTime?: string; /** * 实例带宽信息。 */ InternetAccessible?: InternetAccessible; } /** * ModifyDisasterRecoverGroupAttribute返回参数结构体 */ export interface ModifyDisasterRecoverGroupAttributeResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceTypeConfigs返回参数结构体 */ export interface DescribeInstanceTypeConfigsResponse { /** * 实例机型配置列表。 */ InstanceTypeConfigSet?: Array