tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
1,503 lines (1,406 loc) • 226 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 配额详情 */
declare interface AccountQuota {
/** 后付费配额列表 */
PostPaidQuotaSet?: PostPaidQuota[];
/** 预付费配额列表 */
PrePaidQuotaSet?: PrePaidQuota[];
/** spot配额列表 */
SpotPaidQuotaSet?: SpotPaidQuota[];
/** 镜像配额列表 */
ImageQuotaSet?: ImageQuota[];
/** 置放群组配额列表 */
DisasterRecoverGroupQuotaSet?: DisasterRecoverGroupQuota[];
}
/** 配额详情概览 */
declare interface AccountQuotaOverview {
/** 地域 */
Region?: string;
/** 配额数据 */
AccountQuota?: AccountQuota;
}
/** 定时任务 */
declare interface ActionTimer {
/** 定时器动作,目前仅支持销毁一个值:TerminateInstances。 */
TimerAction?: string;
/** 执行时间,按照ISO8601标准表示,并且使用UTC时间。格式为 YYYY-MM-DDThh:mm:ssZ。例如 2018-05-29T11:26:40Z,执行时间必须大于当前时间5分钟。 */
ActionTime?: string;
/** 扩展数据。仅做出参使用。 */
Externals?: Externals;
/** 定时器ID。仅做出参使用。 */
ActionTimerId?: string;
/** 定时器状态,仅做出参使用。取值范围:UNDO:未执行 DOING:正在执行DONE:执行完成。 */
Status?: string;
/** 定时器对应的实例ID。仅做出参使用。 */
InstanceId?: string;
}
/** 属性信息 */
declare interface Attribute {
/** 实例的自定义数据。 */
UserData?: string;
}
/** 描述预付费模式,即包年包月相关参数。包括购买时长和自动续费逻辑等。 */
declare interface ChargePrepaid {
/** 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。 */
Period: number;
/** 自动续费标识。取值范围:NOTIFY_AND_AUTO_RENEW:通知过期且自动续费NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费默认取值:NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 */
RenewFlag?: string;
}
/** chc部署网络minos引导配置。 */
declare interface ChcDeployExtraConfig {
/** minos类型。是使用腾讯云的minios,还是客户自己的minios。 */
MiniOsType: string;
/** 服务器的架构和启动方式。取值为x86_legacy, arm_uefi。 */
BootType: string;
/** PXE使用的引导文件。默认为pxelinux.0。 */
BootFile?: string;
/** tftp服务器的ip地址。 */
NextServerAddress?: string;
}
/** CHC物理服务器信息 */
declare interface ChcHost {
/** CHC物理服务器ID。 */
ChcId?: string;
/** 实例名称。 */
InstanceName?: string;
/** 服务器序列号。 */
SerialNumber?: string;
/** CHC的状态INIT: 设备已录入。还未配置带外和部署网络READY: 已配置带外和部署网络PREPARED: 可分配云主机ONLINE: 已分配云主机OPERATING: 设备操作中,如正在配置带外网络等。CLEAR_NETWORK_FAILED: 清理带外和部署网络失败 */
InstanceState?: string;
/** 设备类型。 */
DeviceType?: string;
/** 所属可用区 */
Placement?: Placement;
/** 带外网络。 */
BmcVirtualPrivateCloud?: VirtualPrivateCloud;
/** 带外网络Ip。 */
BmcIp?: string;
/** 带外网络安全组Id。 */
BmcSecurityGroupIds?: string[];
/** 部署网络。 */
DeployVirtualPrivateCloud?: VirtualPrivateCloud;
/** 部署网络Ip。 */
DeployIp?: string;
/** 部署网络安全组Id。 */
DeploySecurityGroupIds?: 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;
/** 售卖状态。NOT_FOR_SALE:不可售卖AVAILABLE: 可售卖SOLD: 已售卖 */
SaleStatus?: string;
/** CHC物理服务器关联的标签列表。 */
Tags?: Tag[];
/** 最近操作 */
LatestOperation?: string;
/** 最近操作错误码 */
LatestOperationErrorCode?: string;
/** 最近操作错误详情和建议项 */
LatestOperationErrorMsg?: string;
/** 最近操作名称 */
LatestOperationName?: string;
/** 最近操作状态 */
LatestOperationState?: string;
}
/** CHC物理服务器实例禁止操作的返回结构体 */
declare interface ChcHostDeniedActions {
/** CHC物理服务器的实例id */
ChcId: string;
/** CHC物理服务器的状态 */
State: string;
/** 当前CHC物理服务器禁止做的操作 */
DenyActions: string[];
}
/** 描述了实例CPU拓扑结构的相关信息。 */
declare interface CpuTopology {
/** 决定启用的CPU物理核心数。 */
CoreCount?: number;
/** 每核心线程数。该参数决定是否开启或关闭超线程。1 表示关闭超线程 2 表示开启超线程 不设置时,实例使用默认的超线程策略。开关超线程请参考文档:[开启与关闭超线程](https://cloud.tencent.com/document/product/213/103798)。 */
ThreadPerCore?: number;
}
/** 描述了数据盘的信息 */
declare interface DataDisk {
/** 数据盘大小,单位:GiB。最小调整步长为10GiB,不同数据盘类型取值范围不同,具体限制详见:[存储概述](https://cloud.tencent.com/document/product/213/4952)。默认值为0,表示不购买数据盘。更多限制详见产品文档。 */
DiskSize: number;
/** 数据盘类型。数据盘类型限制详见[存储概述](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:通用型SSD云硬盘默认取值:LOCAL_BASIC该参数对`ResizeInstanceDisk`接口无效。 */
DiskType?: string;
/** 数据盘ID。该参数目前仅用于`DescribeInstances`等查询类接口的返回参数,不可用于`RunInstances`等写接口的入参。 */
DiskId?: string;
/** 数据盘是否随子机销毁。取值范围:true:子机销毁时,销毁数据盘,只支持按小时后付费云盘false:子机销毁时,保留数据盘默认取值:true 该参数目前仅用于 `RunInstances` 接口。 */
DeleteWithInstance?: boolean;
/** 数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。 */
SnapshotId?: string;
/** 数据盘是否加密。取值范围:true:加密false:不加密默认取值:false该参数目前仅用于 `RunInstances` 接口。 */
Encrypt?: boolean;
/** 自定义CMK对应的ID,取值为UUID或者类似kms-abcd1234。用于加密云盘。该参数目前仅用于 `RunInstances` 接口。 */
KmsKeyId?: string | null;
/** 云硬盘性能,单位:MiB/s。使用此参数可给云硬盘购买额外的性能。当前仅支持极速型云盘(CLOUD_TSSD)和增强型SSD云硬盘(CLOUD_HSSD) */
ThroughputPerformance?: number | null;
/** 所属的独享集群ID。 */
CdcId?: string | null;
/** 突发性能 注:内测中。 */
BurstPerformance?: boolean;
/** 磁盘名称,长度不超过128 个字符。 */
DiskName?: string;
}
/** 容灾组信息 */
declare interface DisasterRecoverGroup {
/** 分散置放群组id。 */
DisasterRecoverGroupId?: string;
/** 分散置放群组名称,长度1-60个字符。 */
Name?: string;
/** 分散置放群组类型,取值范围:HOST:物理机SW:交换机RACK:机架 */
Type?: string;
/** 分散置放群组内最大容纳云服务器数量。 */
CvmQuotaTotal?: number;
/** 分散置放群组内云服务器当前数量。 */
CurrentNum?: number;
/** 分散置放群组内,云服务器id列表。 */
InstanceIds?: string[];
/** 分散置放群组创建时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。 */
CreateTime?: string;
/** 置放群组亲和度 */
Affinity?: number;
/** 置放群组关联的标签列表。 */
Tags?: Tag[];
}
/** 置放群组配置数据 */
declare interface DisasterRecoverGroupQuota {
/** 可创建置放群组数量的上限。 */
GroupQuota: number;
/** 当前用户已经创建的置放群组数量。 */
CurrentNum: number;
/** 物理机类型容灾组内实例的配额数。 */
CvmInHostGroupQuota: number;
/** 交换机类型容灾组内实例的配额数。 */
CvmInSwitchGroupQuota: number;
/** 机架类型容灾组内实例的配额数。 */
CvmInRackGroupQuota: number;
}
/** 描述了实例的增强服务启用情况与其设置,如云安全,云监控等实例 Agent */
declare interface EnhancedService {
/** 开启云安全服务。若不指定该参数,则默认开启云安全服务。 */
SecurityService?: RunSecurityServiceEnabled;
/** 开启云监控服务。若不指定该参数,则默认开启云监控服务。 */
MonitorService?: RunMonitorServiceEnabled;
/** 开启云自动化助手服务(TencentCloud Automation Tools,TAT)。若不指定该参数,则公共镜像默认开启云自动化助手服务,其他镜像默认不开启云自动化助手服务。 */
AutomationService?: RunAutomationServiceEnabled;
}
/** 扩展数据 */
declare interface Externals {
/** 释放地址 */
ReleaseAddress?: boolean;
/** 不支持的网络类型,取值范围:BASIC:基础网络VPC1.0:私有网络VPC1.0 */
UnsupportNetworks?: string[];
/** HDD本地存储属性 */
StorageBlockAttr?: StorageBlock;
}
/** >描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等> * 若存在多个`Filter`时,`Filter`间的关系为逻辑与(`AND`)关系。> * 若同一个`Filter`存在多个`Values`,同一`Filter`下`Values`间的关系为逻辑或(`OR`)关系。>> 以[DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口的`Filter`为例。若我们需要查询可用区(`zone`)为广州一区 ***并且*** 实例计费模式(`instance-charge-type`)为包年包月 ***或者*** 按量计费的实例时,可如下实现:```Filters.0.Name=zone&Filters.0.Values.0=ap-guangzhou-1&Filters.1.Name=instance-charge-type&Filters.1.Values.0=PREPAID&Filters.1.Values.1=POSTPAID_BY_HOUR``` */
declare interface Filter {
/** 需要过滤的字段。 */
Name: string;
/** 字段的过滤值。 */
Values: string[];
}
/** 实例GPU信息 */
declare interface GPUInfo {
/** 实例GPU个数。值小于1代表VGPU类型,大于1代表GPU直通类型。 */
GPUCount?: number;
/** 实例GPU地址。 */
GPUId?: string[];
/** 实例GPU类型。 */
GPUType?: string;
}
/** 专用宿主机实例详细信息 */
declare interface HostItem {
/** 专用宿主机实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。 */
Placement?: Placement;
/** 专用宿主机实例ID */
HostId?: string;
/** 专用宿主机实例类型 */
HostType?: string;
/** 专用宿主机实例名称 */
HostName?: string;
/** 专用宿主机实例付费模式 */
HostChargeType?: string;
/** 专用宿主机实例自动续费标记 */
RenewFlag?: string;
/** 专用宿主机实例创建时间 */
CreatedTime?: string;
/** 专用宿主机实例过期时间 */
ExpiredTime?: string;
/** 专用宿主机实例上已创建云子机的实例id列表 */
InstanceIds?: string[];
/** 专用宿主机实例状态 */
HostState?: string;
/** 专用宿主机实例IP */
HostIp?: string;
/** 专用宿主机实例资源信息 */
HostResource?: HostResource;
/** 专用宿主机所属的围笼ID。该字段仅对金融专区围笼内的专用宿主机有效。 */
CageId?: string;
/** 专用宿主机关联的标签列表。 */
Tags?: Tag[];
}
/** cdh相关价格信息 */
declare interface HostPriceInfo {
/** 描述了cdh实例相关的价格信息 */
HostPrice: ItemPrice;
}
/** 专用宿主机实例的资源信息 */
declare 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;
}
/** 高性能计算集群 */
declare interface HpcClusterInfo {
/** 高性能计算集群ID */
HpcClusterId?: string;
/** 高性能计算集群名 */
Name?: string;
/** 高性能计算集群备注 */
Remark?: string;
/** 集群下设备容量 */
CvmQuotaTotal?: number;
/** 集群所在可用区 */
Zone?: string;
/** 集群当前已有设备量 */
CurrentNum?: number;
/** 集群创建时间 */
CreateTime?: string;
/** 集群内实例ID列表 */
InstanceIds?: string[];
/** 高性能计算集群类型。 */
HpcClusterType?: string;
/** 高性能计算集群对应的业务场景标识,当前只支持CDC。 */
HpcClusterBusinessId?: string;
/** 高性能计算集群网络模式 */
HpcClusterNetMode?: number;
/** 高性能计算集群关联的标签列表 */
Tags?: Tag[];
}
/** 一个关于镜像详细信息的结构体,主要包括镜像的主要状态与属性。 */
declare interface Image {
/** 镜像ID */
ImageId?: string;
/** 镜像操作系统 */
OsName?: string;
/** 镜像类型。镜像类型返回值包括:* `PUBLIC_IMAGE` 公共镜像* `PRIVATE_IMAGE` 自定义镜像* `SHARED_IMAGE` 共享镜像 */
ImageType?: string;
/** 镜像创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。 */
CreatedTime?: string;
/** 镜像名称 */
ImageName?: string;
/** 镜像描述 */
ImageDescription?: string;
/** 镜像大小,单位 GiB。 */
ImageSize?: number;
/** 镜像架构。镜像架构返回值包括:* `x86_64`* `arm`* `i386` */
Architecture?: string;
/** 镜像状态:CREATING-创建中NORMAL-正常CREATEFAILED-创建失败SYNCING-复制中IMPORTING-导入中IMPORTFAILED-导入失败 */
ImageState?: string;
/** 镜像来源平台,包括如TencentOS、 CentOS、 Windows、 Ubuntu、 Debian、Fedora等。 */
Platform?: string;
/** 镜像创建者 */
ImageCreator?: string;
/** 镜像来源。镜像来源返回值包括:* `OFFICIAL` 官方镜像* `CREATE_IMAGE` 用户自建镜像* `EXTERNAL_IMPORT` 用户外部导入镜像 */
ImageSource?: string;
/** 同步百分比 */
SyncPercent?: number | null;
/** 镜像是否支持cloud-init */
IsSupportCloudinit?: boolean;
/** 镜像关联的快照信息 */
SnapshotSet?: Snapshot[];
/** 镜像关联的标签列表。 */
Tags?: Tag[];
/** 镜像许可类型。镜像许可类型返回值包括:* `TencentCloud` 腾讯云官方许可* `BYOL` 用户自带许可 */
LicenseType?: string;
/** 镜像族 */
ImageFamily?: string;
/** 镜像是否废弃 */
ImageDeprecated?: boolean;
/** CDC镜像缓存状态 */
CdcCacheStatus?: string;
}
/** 支持的操作系统类型,根据Windows和Linux分类。 */
declare interface ImageOsList {
/** 支持的Windows操作系统。 */
Windows?: string[];
/** 支持的Linux操作系统 */
Linux?: string[];
}
/** 镜像配额 */
declare interface ImageQuota {
/** 已使用配额 */
UsedQuota?: number;
/** 总配额 */
TotalQuota?: number;
}
/** 导入镜像的数据盘信息 */
declare interface ImportImageDataDisk {
/** 数据盘镜像 COS 链接 */
ImageUrl: string;
}
/** 描述实例的信息 */
declare interface Instance {
/** 实例所在的位置。 */
Placement?: Placement;
/** 实例`ID`。 */
InstanceId?: string;
/** 实例机型。 */
InstanceType?: string;
/** 实例的CPU核数,单位:核。 */
CPU?: number;
/** 实例内存容量,单位:`GiB`。 */
Memory?: number;
/** 实例业务状态。取值范围:NORMAL:表示正常状态的实例EXPIRED:表示过期的实例PROTECTIVELY_ISOLATED:表示被安全隔离的实例。 */
RestrictState?: string;
/** 实例名称。 */
InstanceName?: string;
/** 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。取值范围:PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费CDHPAID:独享子机(基于专用宿主机创建,宿主机部分的资源不收费)SPOTPAID:竞价付费CDCPAID:专用集群付费 */
InstanceChargeType?: string;
/** 实例系统盘信息。 */
SystemDisk?: SystemDisk;
/** 实例数据盘信息。 */
DataDisks?: DataDisk[];
/** 实例主网卡的内网`IP`列表。 */
PrivateIpAddresses?: string[];
/** 实例主网卡的公网`IP`列表。 */
PublicIpAddresses?: string[] | null;
/** 实例带宽信息。 */
InternetAccessible?: InternetAccessible;
/** 实例所属虚拟私有网络信息。 */
VirtualPrivateCloud?: VirtualPrivateCloud;
/** 生产实例所使用的镜像`ID`。 */
ImageId?: string;
/** 自动续费标识。取值范围:`NOTIFY_AND_MANUAL_RENEW`:表示通知即将过期,但不自动续费`NOTIFY_AND_AUTO_RENEW`:表示通知即将过期,而且自动续费`DISABLE_NOTIFY_AND_MANUAL_RENEW`:表示不通知即将过期,也不自动续费。注意:后付费模式本项为null */
RenewFlag?: string;
/** 创建时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。 */
CreatedTime?: string;
/** 到期时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。注意:后付费模式本项为null */
ExpiredTime?: string;
/** 操作系统名称。 */
OsName?: string;
/** 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。 */
SecurityGroupIds?: string[];
/** 实例登录设置。目前只返回实例所关联的密钥。 */
LoginSettings?: LoginSettings;
/** 实例状态。状态类型详见[实例状态表](https://cloud.tencent.com/document/api/213/15753) */
InstanceState?: string;
/** 实例关联的标签列表。 */
Tags?: Tag[];
/** 实例的关机计费模式。取值范围:KEEP_CHARGING:关机继续收费STOP_CHARGING:关机停止收费NOT_APPLICABLE:实例处于非关机状态或者不适用关机停止计费的条件 */
StopChargingMode?: string;
/** 实例全局唯一ID */
Uuid?: string;
/** 实例的最新操作。例:StopInstances、ResetInstance。 */
LatestOperation?: string | null;
/** 实例的最新操作状态。取值范围:SUCCESS:表示操作成功OPERATING:表示操作执行中FAILED:表示操作失败 */
LatestOperationState?: string | null;
/** 实例最新操作的唯一请求 ID。 */
LatestOperationRequestId?: string | null;
/** 分散置放群组ID。 */
DisasterRecoverGroupId?: string;
/** 实例的IPv6地址。 */
IPv6Addresses?: string[] | null;
/** CAM角色名。 */
CamRoleName?: string | null;
/** 高性能计算集群`ID`。 */
HpcClusterId?: string;
/** 高性能计算集群`IP`列表。 */
RdmaIpAddresses?: string[] | null;
/** 实例所在的专用集群`ID`。 */
DedicatedClusterId?: string;
/** 实例隔离类型。取值范围:ARREAR:表示欠费隔离EXPIRE:表示到期隔离MANMADE:表示主动退还隔离NOTISOLATED:表示未隔离 */
IsolatedSource?: string;
/** GPU信息。如果是gpu类型子机,该值会返回GPU信息,如果是其他类型子机则不返回。 */
GPUInfo?: GPUInfo;
/** 实例的操作系统许可类型,默认为TencentCloud */
LicenseType?: string;
/** 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:true:表示开启实例保护,不允许通过api接口删除实例false:表示关闭实例保护,允许通过api接口删除实例默认取值:false。 */
DisableApiTermination?: boolean;
/** 默认登录用户。 */
DefaultLoginUser?: string;
/** 默认登录端口。 */
DefaultLoginPort?: number;
/** 实例的最新操作错误信息。 */
LatestOperationErrorMsg?: string | null;
/** 实例绑定的公网IPv6地址。 */
PublicIPv6Addresses?: string[];
}
/** 实例属性 */
declare interface InstanceAttribute {
/** 实例 ID。 */
InstanceId?: string;
/** 实例属性信息。 */
Attributes?: Attribute;
}
/** 描述了实例的计费模式 */
declare interface InstanceChargePrepaid {
/** 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 */
Period: number;
/** 自动续费标识。取值范围:NOTIFY_AND_AUTO_RENEW:通知过期且自动续费NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 */
RenewFlag?: string;
}
/** 描述实例的机型族配置信息形如:{'InstanceFamilyName': '标准型S1', 'InstanceFamily': 'S1'}、{'InstanceFamilyName': '网络优化型N1', 'InstanceFamily': 'N1'}、{'InstanceFamilyName': '高IO型I1', 'InstanceFamily': 'I1'}等。 */
declare interface InstanceFamilyConfig {
/** 机型族名称的中文全称。 */
InstanceFamilyName?: string;
/** 机型族名称的英文简称。 */
InstanceFamily?: string;
}
/** 描述退款详情。 */
declare interface InstanceRefund {
/** 实例Id。 */
InstanceId?: string;
/** 退款数额。 */
Refunds?: number;
/** 退款详情。 */
PriceDetail?: string;
}
/** 描述实例的状态。状态类型详见[实例状态表](/document/api/213/15753) */
declare interface InstanceStatus {
/** 实例`ID`。 */
InstanceId?: string;
/** 实例状态。取值范围:PENDING:表示创建中LAUNCH_FAILED:表示创建失败RUNNING:表示运行中STOPPED:表示关机STARTING:表示开机中STOPPING:表示关机中REBOOTING:表示重启中SHUTDOWN:表示停止待销毁TERMINATING:表示销毁中ENTER_RESCUE_MODE:表示进入救援模式RESCUE_MODE:表示在救援模式中EXIT_RESCUE_MODE:表示退出救援模式ENTER_SERVICE_LIVE_MIGRATE:表示进入在线服务迁移SERVICE_LIVE_MIGRATE:表示在线服务迁移中EXIT_SERVICE_LIVE_MIGRATE:表示退出在线服务迁移。 */
InstanceState?: string;
}
/** 描述实例机型配置信息 */
declare 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;
}
/** 描述实例机型配置信息及状态信息 */
declare interface InstanceTypeConfigStatus {
/** 状态描述 */
Status?: string;
/** 状态描述信息 */
Message?: string;
/** 配置信息 */
InstanceTypeConfig?: InstanceTypeConfig;
}
/** 描述实例机型配额信息。 */
declare interface InstanceTypeQuotaItem {
/** 可用区。 */
Zone?: string;
/** 实例机型。 */
InstanceType?: string;
/** 实例计费模式。取值范围: PREPAID:表示预付费,即包年包月POSTPAID_BY_HOUR:表示后付费,即按量计费CDHPAID:表示[专用宿主机](https://cloud.tencent.com/document/product/416)付费,即只对`专用宿主机`计费,不对`专用宿主机`上的实例计费。SPOTPAID:表示竞价实例付费。 */
InstanceChargeType?: string;
/** 网卡类型,例如:25代表25G网卡 */
NetworkCard?: number;
/** 扩展属性。 */
Externals?: Externals;
/** 实例的CPU核数,单位:核。 */
Cpu?: number;
/** 实例内存容量,单位:`GB`。 */
Memory?: number;
/** 实例机型系列。 */
InstanceFamily?: string;
/** 机型名称。 */
TypeName?: string;
/** 本地磁盘规格列表。当该参数返回为空值时,表示当前情况下无法创建本地盘。 */
LocalDiskTypeList?: LocalDiskType[];
/** 实例是否售卖。取值范围: SELL:表示实例可购买SOLD_OUT:表示实例已售罄。 */
Status?: string;
/** 实例的售卖价格。 */
Price?: ItemPrice;
/** 售罄原因。 */
SoldOutReason?: string;
/** 内网带宽,单位Gbps。 */
InstanceBandwidth?: number;
/** 网络收发包能力,单位万PPS。 */
InstancePps?: number;
/** 本地存储块数量。 */
StorageBlockAmount?: number;
/** 处理器型号。 */
CpuType?: string;
/** 实例的GPU数量。 */
Gpu?: number;
/** 实例的FPGA数量。 */
Fpga?: number;
/** 实例备注信息。 */
Remark?: string;
/** 实例机型映射的物理GPU卡数,单位:卡。vGPU卡型小于1,直通卡型大于等于1。vGPU是通过分片虚拟化技术,将物理GPU卡重新划分,同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。 */
GpuCount?: number;
/** 实例的CPU主频信息 */
Frequency?: string;
/** 描述库存情况。取值范围: EnoughStock:表示对应库存非常充足 NormalStock:表示对应库存供应有保障 UnderStock:表示对应库存即将售罄 WithoutStock:表示对应库存已经售罄 */
StatusCategory?: string;
}
/** 描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等 */
declare interface InternetAccessible {
/** 网络计费类型。取值范围:BANDWIDTH_PREPAID:预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费BANDWIDTH_PACKAGE:带宽包用户默认取值:非带宽包用户默认与子机付费类型保持一致,比如子机付费类型为预付费,网络计费类型默认为预付费;子机付费类型为后付费,网络计费类型默认为后付费。 */
InternetChargeType?: string;
/** 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/12523)。 */
InternetMaxBandwidthOut?: number;
/** 是否分配公网IP。取值范围:true:表示分配公网IPfalse:表示不分配公网IP当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。 */
PublicIpAssigned?: boolean;
/** 带宽包ID。可通过[ DescribeBandwidthPackages ](https://cloud.tencent.com/document/api/215/19209)接口返回值中的`BandwidthPackageId`获取。该参数仅在RunInstances接口中作为入参使用。 */
BandwidthPackageId?: string;
/** 线路类型。各种线路类型详情可参考:[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值:BGP。- BGP:常规 BGP 线路已开通静态单线IP白名单的用户,可选值: - CMCC:中国移动 - CTCC:中国电信 - CUCC:中国联通注意:仅部分地域支持静态单线IP。示例值:BGP */
InternetServiceProvider?: string;
/** 公网 IP 类型。- WanIP:普通公网IP。- HighQualityEIP:精品 IP。仅新加坡和中国香港支持精品IP。- AntiDDoSEIP:高防 IP。仅部分地域支持高防IP,详情可见[弹性公网IP产品概述](https://cloud.tencent.com/document/product/1199/41646)。如需为资源分配公网IPv4地址,请指定公网IPv4地址类型。示例值:WanIP此功能仅部分地区灰度开放,如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category) */
IPv4AddressType?: string;
/** 弹性公网 IPv6 类型。- EIPv6:弹性公网 IPv6。- HighQualityEIPv6:精品 IPv6。仅中国香港支持精品IPv6。如需为资源分配IPv6地址,请指定弹性公网IPv6类型。示例值:EIPv6此功能仅部分地区灰度开放,如需使用[请提交工单咨询](https://console.cloud.tencent.com/workorder/category) */
IPv6AddressType?: string;
/** 高防包唯一ID,申请高防IP时,该字段必传。示例值:bgp-12345678 */
AntiDDoSPackageId?: string;
}
/** 描述了按带宽计费的相关信息 */
declare interface InternetBandwidthConfig {
/** 开始时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。 */
StartTime?: string;
/** 结束时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。 */
EndTime?: string;
/** 实例带宽信息。 */
InternetAccessible?: InternetAccessible;
}
/** 描述了网络计费 */
declare interface InternetChargeTypeConfig {
/** 网络计费类型。取值范围:BANDWIDTH_PREPAID:预付费按带宽结算TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费BANDWIDTH_PACKAGE:带宽包用户默认取值:非带宽包用户默认与子机付费类型保持一致,比如子机付费类型为预付费,网络计费类型默认为预付费;子机付费类型为后付费,网络计费类型默认为后付费。 */
InternetChargeType?: string;
/** 网络计费模式描述信息。 */
Description?: string;
}
/** 描述了单项的价格信息 */
declare interface ItemPrice {
/** 后续合计费用的原价,后付费模式使用,单位:元。如返回了其他时间区间项,如UnitPriceSecondStep,则本项代表时间区间在(0, 96)小时;若未返回其他时间区间项,则本项代表全时段,即(0, ∞)小时 */
UnitPrice?: number;
/** 后续计价单元,后付费模式使用,可取值范围: HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:实例按小时后付费(POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR):GB:表示计价单元是按每GB来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)。 */
ChargeUnit?: string;
/** 预支合计费用的原价,预付费模式使用,单位:元。 */
OriginalPrice?: number;
/** 预支合计费用的折扣价,预付费模式使用,单位:元。 */
DiscountPrice?: number;
/** 折扣,如20.0代表2折。 */
Discount?: number;
/** 后续合计费用的折扣价,后付费模式使用,单位:元如返回了其他时间区间项,如UnitPriceDiscountSecondStep,则本项代表时间区间在(0, 96)小时;若未返回其他时间区间项,则本项代表全时段,即(0, ∞)小时 */
UnitPriceDiscount?: number;
/** 使用时间区间在(96, 360)小时的后续合计费用的原价,后付费模式使用,单位:元。 */
UnitPriceSecondStep?: number;
/** 使用时间区间在(96, 360)小时的后续合计费用的折扣价,后付费模式使用,单位:元 */
UnitPriceDiscountSecondStep?: number;
/** 使用时间区间在(360, ∞)小时的后续合计费用的原价,后付费模式使用,单位:元。 */
UnitPriceThirdStep?: number;
/** 使用时间区间在(360, ∞)小时的后续合计费用的折扣价,后付费模式使用,单位:元 */
UnitPriceDiscountThirdStep?: number;
/** 预支三年合计费用的原价,预付费模式使用,单位:元。 */
OriginalPriceThreeYear?: number;
/** 预支三年合计费用的折扣价,预付费模式使用,单位:元。 */
DiscountPriceThreeYear?: number;
/** 预支三年应用的折扣,如20.0代表2折。 */
DiscountThreeYear?: number;
/** 预支五年合计费用的原价,预付费模式使用,单位:元。 */
OriginalPriceFiveYear?: number;
/** 预支五年合计费用的折扣价,预付费模式使用,单位:元。 */
DiscountPriceFiveYear?: number;
/** 预支五年应用的折扣,如20.0代表2折。 */
DiscountFiveYear?: number;
/** 预支一年合计费用的原价,预付费模式使用,单位:元。 */
OriginalPriceOneYear?: number;
/** 预支一年合计费用的折扣价,预付费模式使用,单位:元。 */
DiscountPriceOneYear?: number;
/** 预支一年应用的折扣,如20.0代表2折。 */
DiscountOneYear?: number;
}
/** 描述密钥对信息 */
declare interface KeyPair {
/** 密钥对的`ID`,是密钥对的唯一标识。 */
KeyId?: string;
/** 密钥对名称。 */
KeyName?: string;
/** 密钥对所属的项目 `ID`,ProjectId 为 0 时表示默认项目。 */
ProjectId?: number;
/** 密钥对描述信息。 */
Description?: string;
/** 密钥对的纯文本公钥。 */
PublicKey?: string;
/** 密钥对的纯文本私钥。腾讯云不会保管私钥,请用户自行妥善保存。 */
PrivateKey?: string;
/** 密钥关联的实例`ID`列表。 */
AssociatedInstanceIds?: string[];
/** 创建时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为:`YYYY-MM-DDThh:mm:ssZ`。 */
CreatedTime?: string;
/** 密钥关联的标签列表。 */
Tags?: Tag[];
}
/** 实例启动模板,通过该参数可使用实例模板中的预设参数创建实例。 */
declare interface LaunchTemplate {
/** 实例启动模板ID,通过该参数可使用实例模板中的预设参数创建实例。 */
LaunchTemplateId?: string;
/** 实例启动模板版本号,若给定,新实例启动模板将基于给定的版本号创建 */
LaunchTemplateVersion?: number;
}
/** 实例启动模板简要信息。 */
declare interface LaunchTemplateInfo {
/** 实例启动模版本号。 */
LatestVersionNumber?: number;
/** 实例启动模板ID。 */
LaunchTemplateId?: string;
/** 实例启动模板名。 */
LaunchTemplateName?: string;
/** 实例启动模板默认版本号。 */
DefaultVersionNumber?: number;
/** 实例启动模板包含的版本总数量。 */
LaunchTemplateVersionCount?: number;
/** 创建该模板的用户UIN。 */
CreatedBy?: string;
/** 创建该模板的时间。 */
CreationTime?: string;
}
/** 实例启动模板版本信息 */
declare interface LaunchTemplateVersionData {
/** 实例所在的位置。 */
Placement?: Placement;
/** 实例机型。 */
InstanceType?: string;
/** 实例名称。 */
InstanceName?: string;
/** 实例计费模式。取值范围:`PREPAID`:表示预付费,即包年包月`POSTPAID_BY_HOUR`:表示后付费,即按量计费`CDHPAID`:`专用宿主机`付费,即只对`专用宿主机`计费,不对`专用宿主机`上的实例计费。`SPOTPAID`:表示竞价实例付费。 */
InstanceChargeType?: string;
/** 实例系统盘信息。 */
SystemDisk?: SystemDisk;
/** 实例数据盘信息。只包含随实例购买的数据盘。 */
DataDisks?: DataDisk[];
/** 实例带宽信息。 */
InternetAccessible?: InternetAccessible;
/** 实例所属虚拟私有网络信息。 */
VirtualPrivateCloud?: VirtualPrivateCloud;
/** 生产实例所使用的镜像`ID`。 */
ImageId?: string;
/** 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。 */
SecurityGroupIds?: string[];
/** 实例登录设置。目前只返回实例所关联的密钥。 */
LoginSettings?: LoginSettings;
/** CAM角色名。 */
CamRoleName?: string;
/** 高性能计算集群`ID`。 */
HpcClusterId?: string;
/** 购买实例数量。 */
InstanceCount?: number;
/** 增强服务。 */
EnhancedService?: EnhancedService;
/** 提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。 */
UserData?: string;
/** 置放群组ID,仅支持指定一个。 */
DisasterRecoverGroupIds?: string[];
/** 定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。 */
ActionTimer?: ActionTimer;
/** 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。 */
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/** 云服务器的主机名。 */
HostName?: string;
/** 用于保证请求幂等性的字符串。 */
ClientToken?: string;
/** 预付费模式,即包年包月相关参数设置。 */
InstanceChargePrepaid?: InstanceChargePrepaid;
/** 标签描述列表。通过指定该参数可以同时绑定标签到相应的云服务器、云硬盘实例。 */
TagSpecification?: TagSpecification[];
/** 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:true:表示开启实例保护,不允许通过api接口删除实例false:表示关闭实例保护,允许通过api接口删除实例默认取值:false。 */
DisableApiTermination?: boolean;
}
/** 实例启动模板版本集合 */
declare interface LaunchTemplateVersionInfo {
/** 实例启动模板版本号。 */
LaunchTemplateVersion?: number;
/** 实例启动模板版本数据详情。 */
LaunchTemplateVersionData?: LaunchTemplateVersionData;
/** 实例启动模板版本创建时间。 */
CreationTime?: string;
/** 实例启动模板ID。 */
LaunchTemplateId?: string;
/** 是否为默认启动模板版本。 */
IsDefaultVersion?: boolean;
/** 实例启动模板版本描述信息。 */
LaunchTemplateVersionDescription?: string;
/** 创建者的AppId。 */
CreatedBy?: string;
}
/** 本地磁盘规格 */
declare interface LocalDiskType {
/** 本地磁盘类型。 */
Type?: string;
/** 本地磁盘属性。 */
PartitionType?: string;
/** 本地磁盘最小值。 */
MinSize?: number;
/** 本地磁盘最大值。 */
MaxSize?: number;
/** 购买时本地盘是否为必选。取值范围:REQUIRED:表示必选OPTIONAL:表示可选。 */
Required?: string;
}
/** 描述了实例登录相关配置与信息。 */
declare interface LoginSettings {
/** 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:Linux实例密码必须8到30位,至少包括两项[a-z],[A-Z]、[0-9] 和 [( ) \` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。Windows实例密码必须12到30位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) \` ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。 */
Password?: string;
/** 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。 */
KeyIds?: string[] | null;
/** 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围:true:表示保持镜像的登录设置false:表示不保持镜像的登录设置默认取值:false。 */
KeepImageLogin?: string;
}
/** 自定义metadata */
declare interface Metadata {
/** 自定义metadata键值对列表。 */
Items: MetadataItem[];
}
/** 自定义metadata key和value */
declare interface MetadataItem {
/** 自定义metadata键,需符合正则 ^[a-zA-Z0-9_-]+$,长度 ≤128 字节(大小写敏感); */
Key: string;
/** 自定义metadata值,支持任意数据(含二进制),大小 ≤256 KB(大小写敏感); */
Value: string;
}
/** 描述了单台实例操作次数限制 */
declare interface OperationCountLimit {
/** 实例操作。取值范围:`INSTANCE_DEGRADE`:降配操作`INTERNET_CHARGE_TYPE_CHANGE`:修改网络带宽计费模式 */
Operation?: string;
/** 实例ID。 */
InstanceId?: string;
/** 当前已使用次数,如果返回值为-1表示该操作无次数限制。 */
CurrentCount?: number;
/** 操作次数最高额度,如果返回值为-1表示该操作无次数限制,如果返回值为0表示不支持调整配置。 */
LimitCount?: number;
}
/** 操作系统支持的类型。 */
declare interface OsVersion {
/** 操作系统类型 */
OsName?: string;
/** 支持的操作系统版本 */
OsVersions?: string[];
/** 支持的操作系统架构 */
Architecture?: string[];
}
/** 描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机(仅专用宿主机产品可用),母机IP等 */
declare 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` 字段来获取。默认取值0,表示默认项目。 */
ProjectId?: number;
/** 实例所属的专用宿主机ID列表,仅用于入参。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 [DescribeHosts](https://cloud.tencent.com/document/api/213/16474) 的返回值中的 `HostId` 字段来获取。 */
HostIds?: string[];
/** 实例所属的专用宿主机ID,仅用于出参。 */
HostId?: string;
}
/** 后付费实例配额 */
declare interface PostPaidQuota {
/** 累计已使用配额 */
UsedQuota?: number;
/** 剩余配额 */
RemainingQuota?: number;
/** 总配额 */
TotalQuota?: number;
/** 可用区 */
Zone?: string;
}
/** 预付费实例配额 */
declare interface PrePaidQuota {
/** 当月已使用配额 */
UsedQuota?: number;
/** 单次购买最大数量 */
OnceQuota?: number;
/** 剩余配额 */
RemainingQuota?: number;
/** 总配额 */
TotalQuota?: number;
/** 可用区 */
Zone?: string;
}
/** 价格 */
declare interface Price {
/** 描述了实例价格。 */
InstancePrice?: ItemPrice;
/** 描述了网络价格。 */
BandwidthPrice?: ItemPrice;
}
/** 地域信息 */
declare interface RegionInfo {
/** 地域名称,例如,ap-guangzhou */
Region?: string;
/** 地域描述,例如,华南地区(广州) */
RegionName?: string;
/** 地域是否可用状态 */
RegionState?: string;
}
/** 描述维修任务的相关信息 */
declare interface RepairTaskInfo {
/** 维修任务ID */
TaskId?: string;
/** 实例ID */
InstanceId?: string;
/** 实例名称 */
Alias?: string | null;
/** 任务类型ID,与任务类型中文名的对应关系如下:- `101`:实例运行隐患- `102`:实例运行异常- `103`:实例硬盘异常- `104`:实例网络连接异常- `105`:实例运行预警- `106`:实例硬盘预警- `107`:实例维护升级各任务类型的具体含义,可参考 [维修任务分类](https://cloud.tencent.com/document/product/213/67789)。 */
TaskTypeId?: number;
/** 任务类型中文名 */
TaskTypeName?: string;
/** 任务状态ID,与任务状态中文名的对应关系如下:- `1`:待授权- `2`:处理中- `3`:已结束- `4`:已预约- `5`:已取消- `6`:已避免各任务状态的具体含义,可参考 [任务状态](https://cloud.tencent.com/document/product/213/67789)。 */
TaskStatus?: number;
/** 设备状态ID,与设备状态中文名的对应关系如下:- `1`:故障中- `2`:处理中- `3`:正常- `4`:已预约- `5`:已取消- `6`:已避免 */
DeviceStatus?: number;
/** 操作状态ID,与操作状态中文名的对应关系如下:- `1`:未授权- `2`:已授权- `3`:已处理- `4`:已预约- `5`:已取消- `6`:已避免 */
OperateStatus?: number;
/** 任务创建时间 */
CreateTime?: string;
/** 任务授权时间 */
AuthTime?: string | null;
/** 任务结束时间 */
EndTime?: string | null;
/** 任务详情 */
TaskDetail?: string | null;
/** 可用区 */
Zone?: string | null;
/** 地域 */
Region?: string | null;
/** 所在私有网络ID */
VpcId?: string | null;
/** 所在私有网络名称 */
VpcName?: string | null;
/** 所在子网ID */
SubnetId?: string | null;
/** 所在子网名称 */
SubnetName?: string | null;
/** 实例公网IP */
WanIp?: string | null;
/** 实例内网IP */
LanIp?: string | null;
/** 产品类型,支持取值:- `CVM`:云服务器- `CDH`:专用宿主机- `CPM2.0`:裸金属云服务器 */
Product?: string | null;
/** 任务子类型 */
TaskSubType?: string | null;
/** 任务授权类型,当前`AuthType`和维修任务提供的授权选项的对应关系如下:- `"1"`:仅提供【在线迁移授权】- `"2"`:仅提供【停机授权】- `"3"`:仅提供【在线换盘授权】- `"4"`:提供【停机换盘授权】(默认)、【弃盘迁移授权】(可选)- `"5"`:提供【停机授权】(默认)、【弃盘迁移授权】(可选)- `"6"`:仅提供【在线维护授权】- `"7"`:提供【在线维护授权】(默认)、【停机授权】(可选)- `"8"`:仅提供【弃盘迁移授权】 */
AuthType?: number;
/** 授权渠道,支持取值:- `Waiting_auth`:待授权- `Customer_auth`:客户操作授权- `System_mandatory_auth`:系统默认授权- `Pre_policy_auth`:预置策略授权 */
AuthSource?: string;
}
/** 预留实例静态配置信息。预留实例当前只针对国际站白名单用户开放。 */
declare interface ReservedInstanceConfigInfoItem {
/** 实例规格。 */
Type?: string;
/** 实例规格名称。 */
TypeName?: string;
/** 优先级。 */
Order?: number;
/** 实例族信息列表。 */
InstanceFamilies?: ReservedInstanceFamilyItem[];
}
/** 预留实例相关实例族信息。预留实例当前只针对国际站白名单用户开放。 */
declare interface ReservedInstanceFamilyItem {
/** 实例族。 */
InstanceFamily?: string;
/** 优先级。 */
Order?: number;
/** 实例类型信息列表。 */
InstanceTypes?: ReservedInstanceTypeItem[];
}
/** 预留实例相关价格信息。预留实例当前只针对国际站白名单用户开放。 */
declare interface ReservedInstancePrice {
/** 预支合计费用的原价,单位:元。 */
OriginalFixedPrice?: number;
/** 预支合计费用的折扣价,单位:元。 */
DiscountFixedPrice?: number;
/** 后续合计费用的原价,单位:元/小时 */
OriginalUsagePrice?: number;
/** 后续合计费用的折扣价,单位:元/小时 */
DiscountUsagePrice?: number;
/** 预支费用的折扣,如20.0代表2折。 */
FixedPriceDiscount?: number;
/** 后续费用的折扣,如20.0代表2折。 */
UsagePriceDiscount?: number;
}
/** 基于付费类型的预留实例相关价格信息。预留实例当前只针对国际站白名单用户开放。 */
declare interface ReservedInstancePriceItem {
/** 付费类型,如:"All Upfront","Partial Upfront","No Upfront" */
OfferingType?: string;
/** 预支合计费用,单位:元。 */
FixedPrice?: number;
/** 后续合计费用,单位:元/小时 */
UsagePrice?: number;
/** 预留实例配置ID */
ReservedInstancesOfferingId?: string;
/** 预留实例计费可购买的可用区。 */
Zone?: string;
/** 预留实例计费【有效期】即预留实例计费购买时长。形如:31536000。计量单位:秒 */
Duration?: number;
/** 预留实例计费的平台描述(即操作系统)。形如:Linux。返回项: Linux 。 */
ProductDescription?: string;
/** 预支合计费用,单位:元。 */
DiscountUsagePrice?: number;
/** 后续合计费用的折扣价,单位:元/小时 */
DiscountFixedPrice?: number;
}
/** 预留实例类型信息。预留实例当前只针对国际站白名单用户开放。 */
declare interface ReservedInstanceTypeItem {
/** 实例类型。 */
InstanceType?: string;
/** CPU核数。 */
Cpu?: number;
/** 内存大小。 */
Memory?: number;
/** GPU数量。 */
Gpu?: number;
/** FPGA数量。 */
Fpga?: number;
/** 本地存储块数量。 */
StorageBlock?: number;
/** 网卡数。 */
NetworkCard?: number;
/** 最大带宽。 */
MaxBandwidth?: number;
/** 主频。 */
Frequency?: string;
/** CPU型号名称。 */
CpuModelName?: string;
/** 包转发率。 */
Pps?: number;
/** 外部信息。 */
Externals?: Externals;
/** 备注信息。 */
Remark?: string;
/** 预留实例配置价格信息。 */
Prices?: ReservedInstancePriceItem[];
}
/** 描述可购买预留实例计费信息 */
declare interface ReservedInstancesOffering {
/** 预留实例计费可购买的可用区。形如:ap-guangzhou-1。返回项:可用区列表 */
Zone?: string;
/** 可购买的预留实例计费类型的结算货币,使用ISO 4217标准货币代码。返回项:USD(美元)。 */
CurrencyCode?: string;
/** 预留实例计费【有效期】即预留实例计费购买时长。形如:31536000。计量单位:秒 */
Duration?: number;
/** 预留实例计费的购买价格。形如:4000.0。计量单位:与 currencyCode 一致,目前支持 USD(美元) */
FixedPrice?: number;
/** 预留实例计费的实例类型。形如:S3.MEDIUM4。返回项:预留实例计费类型列表 */
InstanceType?: string;
/** 预留实例计费的付款类型。形如:All Upfront。返回项: All Upfront (预付全部费用)。 */
OfferingType?: string;
/** 可购买的预留实例计费配置ID。形如:650c138f-ae7e-4750-952a-96841d6e9fc1。 */
ReservedInstancesOfferingId?: string;
/** 预留实例计费的平台描述(即操作系统)。形如:linux。返回项: linux 。 */
ProductDescription?: string;
/** 扣除预付费之后的使用价格 (按小时计费)。形如:0.0。目前,因为只支持 All Upfront 付款类型,所以默认为 0元/小时。计量单位:元/小时,货币单位与 currencyCode 一致,目前支持 USD(美元) */
UsagePrice?: number;
}
/** 描述了 “云自动化助手” 服务相关的信息 */
declare interface RunAutomationServiceEnabled {
/** 是否开启云自动化助手。取值范围:true:表示开启云自动化助手服务false:表示不开启云自动化助手服务默认取值:false。 */
Enabled?: boolean;
}
/** 描述了 “云监控” 服务相关的信息 */
declare interface RunMonitorServiceEnabled {
/** 是否开启[云监控](/document/product/248)服务。取值范围:true:表示开启云监控服务false:表示不开启云监控服务默认取值:true。 */
Enabled?: boolean;
}
/** 描述了 “云安全” 服务相关的信息 */
declare interface RunSecurityServiceEnabled {
/** 是否开启[云安全](/document/product/296)服务。取值范围:true:表示开启云安全服务false:表示不开启云安全服务默认取值:true。 */
Enabled?: boolean;
}
/** 镜像分享信息结构 */
declare interface SharePermission {
/** 镜像分享时间。按照 ISO8601 标准表示,并且使用 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。 */
CreatedTime?: string;
/** 镜像分享的账户ID */
AccountId?: string;
}
/** 描述镜像关联的快照信息 */
declare interface Snapshot {
/** 快照Id。 */
SnapshotId?: string;
/** 创建此快照的云硬盘类型。取值范围:SYSTEM_DISK:系统盘DATA_DISK:数据盘。 */
DiskUsage?: string;
/** 创建此快照的云硬盘大小,单位 GiB。 */
DiskSize?: number;
}
/** 竞价相关选项 */
declare interface SpotMarketOptions {
/** 竞价出价 */
MaxPrice: string;
/** 竞价请求类型,当前仅支持类型:one-time */
SpotInstanceType?: string;
}
/** 竞价实例配额 */
declare interface SpotPaidQuota {
/** 已使用配额,单位:vCPU核心数 */
UsedQuota?: number;
/** 剩余配额,单位:vCPU核心数 */
RemainingQuota?: number;
/** 总配额,单位:vCPU核心数 */
TotalQuota?: number;
/** 可用区 */
Zone?: string;
}
/** HDD的本地存储信息 */
declare interface StorageBlock {
/** HDD本地存储类型,值为:LOCAL_PRO. */
Type?: string;
/** HDD本地存储的最小容量。单位:GiB。 */
MinSize?: number;
/** HDD本地存储的最大容量。单位:GiB。 */
MaxSize?: number;
}
/** 同步镜像信息 */
declare interface SyncImage {
/** 镜像ID */
ImageId: string;
/** 地域 */
Region: string;
}
/** 描述了操作系统所在块设备即系统盘的信息 */
declare interface SystemDisk {
/** 系统盘类型。系统盘类型限制详见[存储概述](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云硬盘默认取值:当前有库存的硬盘类型。 */
DiskType?: string;
/** 系统盘ID。该参数目前仅用于`DescribeInstances`等查询类接口的返回参数,不可用于`RunInstances`等写接口的入参。 */
DiskId?: string;
/** 系统盘大小,单位:GiB。默认值为 50 */
DiskSize?: number;
/** 所属的独享集群ID。 */
CdcId?: string | null;
/** 磁盘名称,长度不超过128 个字符。 */
DiskName?: string;
}
/** 标签键值对,可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。 */
declare interface Tag {
/** 标签键 */
Key: string;
/** 标签值 */
Value: string;
}
/** 创建资源实例时同时绑定的标签对说明 */
declare interface TagSpecification {
/** 标签绑定的资源类型,云服务器为“instance”,专用宿主机为“host”,镜像为“image”,密钥为“keypair”,置放群组为“ps”,高性能计算集群为“hpc”。 */
ResourceType: string;
/** 标签对列表 */
Tags: Tag[];
}
/** 操作系统转换的目标操作系统信息 */
declare interface TargetOS {
/** 目标操作系统类型 */
TargetOSType?: string;
/** 目标操作系统版本 */
TargetOSVersion?: string;
}
/** 描述了VPC相关信息,包括子网,IP信息等 */
declare interface VirtualPrivateCloud {
/** 私有网络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网络。 */
VpcId: string;
/** 私有网络子网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网络。 */
SubnetId: string;
/** 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围:true:表示用作公网网关false:表示不作为公网网关默认取值:false。 */
AsVpcGateway?: boolean;
/** 私有网络子网 IP 数组,在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。 */
PrivateIpAddresses?: string[];
/** 为弹性网卡指定随机生成的 IPv6 地址数量。 */
Ipv6AddressCount?: number;
}
/** 可用区信息 */
declare interface ZoneInfo {
/** 可用区名称,例如,ap-guangzhou-3全网可用区名称如下: ap-chongqing-1 ap-seoul-1 ap-seoul-2 ap-chengdu-1 ap-chengdu-2 ap-hongkong-1(售罄) ap-hongkong-2 ap-hongkong-3 ap-shenzhen-fsi-1 ap-shenzhen-fsi-2 ap-shenzhen-fsi-3(售罄) ap-guangzhou-1(售罄) ap-guangzhou-2(售罄) ap-guangzhou-3 ap-guangzhou-4 ap-guangzhou-6 ap-guangzhou-7 ap-tokyo-1 ap-tokyo-2 ap-singapore-1 ap-singapore-2 ap-singapore-3 ap-singapore-4 ap-shanghai-fsi-1 ap-shanghai-fsi-2 ap-shanghai-fsi-3 ap-bangkok-1 ap-bangkok-2 ap-shanghai-1(售罄) ap-shanghai-2 ap-shanghai-3 ap-shanghai-4 ap-shanghai-5 ap-shanghai-8 ap-mumbai-1 ap-mumbai-2 ap-beijing-1(售罄) ap-beijing-2 ap-beijing-3 ap-beijing-4 ap-beijing-5 ap-beijing-6 ap-beijing-7 na-siliconvalley-1 na-siliconvalley-2 eu-frankfurt-1 eu-frankfurt-2 na-ashburn-1 na-ashburn-2 ap-nanjing-1 ap-nanjing-2 ap-nanjing-3 sa-saopaulo-1 ap-jakarta-1 ap-jakarta-2 */
Zone?: string;
/** 可用区描述,例如,广州三区 */
ZoneName?: string;
/** 可用区ID */
ZoneId?: string;
/** 可用区状态,包含AVAILABLE和UNAVAILABLE。AVAILABLE代表可用,UNAVAILABLE代表不可用。 */
ZoneState?: string;
}
declare interface AllocateHostsRequest {
/** 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。 */
Placement: Placement;
/** 用于保证请求幂等性的字符串。 */
ClientToken?: string;
/** 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。 */
HostChargePrepaid?: ChargePrepaid;
/** 实例计费类型。目前仅支持:PREPAID(预付费,即包年包月模式),默认为:'PREPAID'。 */
HostChargeType?: string;
/** CDH实例机型,默认为:'HS1'。 */
HostType?: string;
/** 购买CDH实例数量,默认为:1。 */
HostCount?: number;
/** 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例。 */
TagSpecification?: TagSpecification[];
}
declare interface AllocateHostsResponse {
/** 新创建云子机的实例ID列表。 */
HostIdSet?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AssociateInstancesKeyPairsRequest {
/** 一个或多个待操作的实例ID,每次请求批量实例的上限为100。可以通过以下方式获取可用的实例ID:通过登录[控制台](https://console.cloud.tencent.com/cvm/index)查询实例ID。通过调用接口 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) ,取返回信息中的`InstanceId`获取实例ID。 */
InstanceIds: string[];
/** 一个或多个待操作的密钥对ID,每次请求批量密钥对的上限为100。可以通过以下方式获取可用的密钥ID:通过登录[控制台](https://console.cloud.tencent.com/cvm/sshkey)查询密钥ID。通过调用接口 [DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699) ,取返回信息中的`KeyId`获取密钥对ID。 */
KeyIds: string[];
/** 是否强制关机,默认值为 false。常规场景下,建议手动关机后绑定密钥。取值范围:true:先执行强制关机,再绑定密钥。false:不执行强制关机,仅支持对已关机状态实例进行绑定操作。 */
ForceStop?: boolean;
}
declare interface AssociateInstancesKeyPairsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AssociateSecurityGroupsRequest {
/** 要绑定的`安全组ID`,类似sg-efil73jd,只支持绑定单个安全组。可通过 [DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808) 接口返回值中的`SecurityGroupId`获取。 */
SecurityGroupIds: string[];
/** 被绑定的`实例ID`,类似ins-lesecurk,支持指定多个实例,每次请求批量实例的上限为100。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。 */
InstanceIds: string[];
}
declare interface AssociateSecurityGroupsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ConfigureChcAssistVpcRequest {
/** CHC物理服务器的实例Id。 */
ChcIds: string[];
/** 带外网络信息。 */
BmcVirtualPrivateCloud: VirtualPrivateCloud;
/** 带外网络的安全组列表 */
BmcSecurityGroupIds?: string[];
/** 部署网络信息。 */
DeployVirtualPrivateCloud?: VirtualPrivateCloud;
/** 部署网络的安全组列表 */
DeploySecurityGroupIds?: string[];
/** 部署网络的附加参数,用于指定minios类型、bios引导模式等 */
ChcDeployExtraConfig?: ChcDeployExtraConfig;
}
declare interface ConfigureChcAssistVpcResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ConfigureChcDeployVpcRequest {
/** CHC物理服务器的实例Id。 */
ChcIds: string[];
/** 部署网络信息。 */
DeployVirtualPrivateCloud: VirtualPrivateCloud;
/** 部署网络的安全组列表。 */
DeploySecurityGroupIds?: string[];
/** 部署所需要的dhcp选项参数 */
ChcDeployExtraConfig?: ChcDeployExtraConfig;
}
declare interface ConfigureChcDeployVpcResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ConvertOperatingSystemsRequest {
/** 执行操作系统转换的实例 ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。仅支持操作系统为 CentOS 7、CentOS 8 的实例执行转换。 */
InstanceIds: string[];
/** 是否最小规模转换。默认值:false */
MinimalConversion?: boolean;
/** 是否只预检。默认值:false */
DryRun?: boolean;
/** 转换的目标操作系统类型。仅支持 TencentOS。默认值:TencentOS */
TargetOSType?: string;
}
declare interface ConvertOperatingSystemsResponse {
/** 转换的目标操系统信息,仅在入参 DryRun 为 true 时返回。 */
SupportTargetOSList?: TargetOS[];
/** 操作系统转换的任务 ID */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDisasterRecoverGroupRequest {
/** 分散置放群组名称,长度1-60个字符,支持中、英文。 */
Name: string;
/** 分散置放群组类型,取值范围:HOST:物理机SW:交换机RACK:机架 */
Type: string;
/** 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。更多详细信息请参阅:如何保证幂等性。 */
ClientToken?: string;
/** 置放群组的亲和度,在置放群组的实例会按该亲和度分布,亲和度的取值范围是:1-10,默认为1 */
Affinity?: number;
/** 标签描述列表。通过指定该参数可以绑定标签到置放群组。 */
TagSpecification?: TagSpecification[];
}
declare interface CreateDisasterRecoverGroupResponse {
/** 分散置放群组ID列表。 */
DisasterRecoverGroupId?: string;
/** 分散置放群组类型,取值范围:HOST:物理机SW:交换机RACK:机架 */
Type?: string;
/** 分散置放群组名称,长度1-60个字符,支持中、英文。 */
Name?: string;
/** 置放群组内可容纳的云服务器数量。 */
CvmQuotaTotal?: number;
/** 置放群组内已有的云服务器数量。 */
CurrentNum?: number;
/** 置放群组创建时间。 */
CreateTime?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateHpcClusterRequest {
/** 可用区。 */
Zone: string;
/** 高性能计算集群名称。 */
Name: string;
/** 高性能计算集群备注。 */
Remark?: string;
/** 高性能计算集群类型。 */
HpcClusterType?: string;
/** 高性能计算集群对应的业务场景标识,当前只支持CDC。 */
HpcClusterBusinessId?: string;
/** 标签描述列表。通过指定该参数可以同时绑定标签到相应的HPC高性能集群。 */
TagSpecification?: TagSpecification[];
}
declare interface CreateHpcClusterResponse {
/** 高性能计算集群信息。 */
HpcClusterSet?: HpcClusterInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateImageRequest {
/** 镜像名称。最多支持60个字符。 */
ImageName: string;
/** 需要制作镜像的实例ID。基于实例创建镜像时,为必填参数。InstanceId 和 SnapshotIds 为二选一必填参数。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。 */
InstanceId?: string;
/** 镜像描述。最多支持 256 个字符。 */
ImageDescription?: string;
/** 是否执行强制关机以制作镜像。取值范围:true:表示关机之后制作镜像false:表示开机状态制作镜像默认取值:false。开机状态制作镜像,可能导致部分数据未备份,影响数据安全。 */
ForcePoweroff?: string;
/** 创建Windows镜像时是否启用Sysprep。取值范围:true或false,传true表示启用Sysprep,传false表示不启用,默认取值为false。关于Sysprep的详情请参考[链接](https://cloud.tencent.com/document/product/213/43498)。 */
Sysprep?: string;
/** 基于实例创建整机镜像时,指定包含在镜像里的数据盘ID。DataDiskIds 只能在指定 InstanceId 实例所包含的数据盘范围内指定。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的 `DataDisks` 获取。 */
DataDiskIds?: string[];
/** 基于快照创建镜像,指定快照ID,必须包含一个系统盘快照。不可与 InstanceId 同时传入。InstanceId 和 SnapshotIds 为二选一必填参数。可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647) 接口返回值中的`SnapshotId`获取。 */
SnapshotIds?: string[];
/** 检测本次请求的是否成功,但不会对操作的资源产生任何影响。默认取值为false。 */
DryRun?: boolean;
/** 标签描述列表。通过指定该参数可以同时绑定标签到自定义镜像。可通过 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 接口返回值中的 `TagKey` 和 `TagValue` 获取。 */
TagSpecification?: TagSpecification[];
/** 镜像族 */
ImageFamily?: string;
}
declare interface CreateImageResponse {
/** 镜像ID */
ImageId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateKeyPairRequest {
/** 密钥对名称,可由数字、字母和下划线组成,长度不超过25个字符。密钥对名称不能和已经存在的密钥对名称重复。 */
KeyName: string;
/** 密钥对创建后所属的项目ID,ProjectId为0表示默认项目。可以通过以下方式获取项目ID:通过项目列表查询项目ID。通过调用接口 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725),取返回信息中的`projectId `获取项目ID。 */
ProjectId: number;
/** 标签描述列表。通过指定该参数可以同时绑定标签到密钥对。 */
TagSpecification?: TagSpecification[];
}
declare interface CreateKeyPairResponse {
/** 密钥对信息。 */
KeyPair?: KeyPair;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateLaunchTemplateRequest {
/** 实例启动模板名称。长度为2~128个英文或中文字符。 */
LaunchTemplateName: string;
/** 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目,所属宿主机(在专用宿主机上创建子机时指定)等属性。 */
Placement: Placement;
/** 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。镜像类型分为四种:公共镜像自定义镜像共享镜像服务市场镜像可通过以下方式获取可用的镜像ID:`公共镜像`、`自定义镜像`、`共享镜像`的镜像ID可通过登录[控制台](https://console.cloud.tencent.com/cvm/image?rid=1&imageType=PUBLIC_IMAGE)查询;`服务镜像市场`的镜像ID可通过[云市场](https://market.cloud.tencent.com/list)查询。通过调用接口 [DescribeImages](https://cloud.tencent.com/document/api/213/15715) ,传入InstanceType获取当前机型支持的镜像列表,取返回信息中的`ImageId`字段。 */
ImageId: string;
/** 实例启动模板版本描述。长度为2~256个英文或中文字符,默认为空字符。 */
LaunchTemplateVersionDescription?: string;
/** 实例机型。不同实例机型指定了不同的资源规格。对于付费模式为PREPAID或POSTPAID\_BY\_HOUR的实例创建,具体取值可通过调用接口[DescribeInstanceTypeConfigs](https://cloud.tencent.com/document/api/213/15749)来获得最新的规格表或参见[实例规格](https://cloud.tencent.com/document/product/213/11518)描述。若不指定该参数,则系统将根据当前地域的资源售卖情况动态指定默认机型。对于付费模式为CDHPAID的实例创建,该参数以"CDH_"为前缀,根据CPU和内存配置生成,具体形式为:CDH_XCXG,例如对于创建CPU为1核,内存为1G大小的专用宿主机的实例,该参数应该为CDH_1C1G。 */
InstanceType?: string;
/** 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。 */
SystemDisk?: SystemDisk;
/** 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘,详情请参考[ 云硬盘使用限制](https://cloud.tencent.com/document/product/362/5145)。 */
DataDisks?: DataDisk[];
/** 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络IP,即表示每个实例的主网卡IP;同时,InstanceCount参数必须与私有网络IP的个数一致且不能大于20。 */
VirtualPrivateCloud?: VirtualPrivateCloud;
/** 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。 */
InternetAccessible?: InternetAccessible;
/** 购买实例数量。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量,具体配额相关限制详见[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)。 */
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`。最多支持128个字符(包含模式串)。 */
InstanceName?: string;
/** 实例登录设置。通过该参数可以设置实例的登录方式为密钥或保持镜像的原始登录设置。 */
LoginSettings?: LoginSettings;
/** 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的 `SecurityGroupId` 字段来获取。若不指定该参数,则绑定指定项目下的默认安全组,如默认安全组不存在则将自动创建。 */
SecurityGroupIds?: string[];
/** 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认公共镜像开启云监控、云安全服务;自定义镜像与镜像市场镜像默认不开启云监控,云安全服务,而使用镜像里保留的服务。 */
EnhancedService?: EnhancedService;
/** 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。 */
ClientToken?: string;
/** 云服务器的主机名。点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。Windows 实例:名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。其他类型(Linux 等)实例:字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。 */
HostName?: string;
/** 定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。 */
ActionTimer?: ActionTimer;
/** 置放群组id,仅支持指定一个。该参数可以通过调用 [ DescribeDisasterRecoverGroups ](https://cloud.tencent.com/document/api/213/17810) 的返回值中的 `DisasterRecoverGroupId` 字段来获取。 */
DisasterRecoverGroupIds?: string[];
/** 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到云服务器实例。 */
TagSpecification?: TagSpecification[];
/** 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。 */
InstanceMarketOptions?: InstanceMarketOptionsRequest;
/** 提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。关于获取此参数的详细介绍,请参阅[Windows](https://cloud.tencent.com/document/product/213/17526)和[Linux](https://cloud.tencent.com/document/product/213/17525)启动时运行命令。 */
UserData?: string;
/** 是否只预检此次请求。true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和云服务器库存。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId.false(默认):发送正常请求,通过检查后直接创建实例。 */
DryRun?: boolean;
/** CAM角色名称。可通过[ DescribeRoleList ](https://cloud.tencent.com/document/product/598/36223)接口返回值中的`RoleName `获取。 */
CamRoleName?: string;
/** 高性能计算集群ID。若创建的实例为高性能计算实例,需指定实例放置的集群,否则不可指定。该参数可以通过调用 [DescribeHpcClusters](https://cloud.tencent.com/document/api/213/83220) 的返回值中的 `HpcClusterId` 字段来获取。 */
HpcClusterId?: string;
/** 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。PREPAID:预付费,即包年包月POSTPAID_BY_HOUR:按小时后付费CDHPAID:独享子机(基于专用宿主机创建,宿主机部分的资源不收费)SPOTPAID:竞价付费默认值:POSTPAID_BY_HOUR。 */
InstanceC