AccountQuota
配额详情
被如下接口引用:DescribeAccountQuota。
| 名称 | 类型 | 描述 |
|---|---|---|
| PostPaidQuotaSet | Array of PostPaidQuota | 后付费配额列表 |
| PrePaidQuotaSet | Array of PrePaidQuota | 预付费配额列表 |
| SpotPaidQuotaSet | Array of SpotPaidQuota | spot配额列表 |
| ImageQuotaSet | Array of ImageQuota | 镜像配额列表 |
| DisasterRecoverGroupQuotaSet | Array of DisasterRecoverGroupQuota | 置放群组配额列表 |
AccountQuotaOverview
配额详情概览
被如下接口引用:DescribeAccountQuota。
| 名称 | 类型 | 描述 |
|---|---|---|
| Region | String | 地域 示例值:ap-guangzhou |
| AccountQuota | AccountQuota | 配额数据 |
ActionTimer
定时任务
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstancesActionTimer, DescribeLaunchTemplateVersions, ImportInstancesActionTimer, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TimerAction | String | 否 | 定时器动作,目前仅支持销毁一个值:TerminateInstances。 示例值:TerminateInstances |
| ActionTime | String | 否 | 执行时间,按照ISO8601标准表示,并且使用UTC时间。格式为 YYYY-MM-DDThh:mm:ssZ。例如 2018-05-29T11:26:40Z,执行时间必须大于当前时间5分钟。 示例值:2024-05-29T11:26:40Z |
| Externals | Externals | 否 | 扩展数据。仅做出参使用。 |
| ActionTimerId | String | 否 | 定时器ID。仅做出参使用。 示例值:57z0f8ef-8112-460f-8203-fab753580f68 |
| Status | String | 否 | 定时器状态,仅做出参使用。取值范围: 示例值:UNDO |
| InstanceId | String | 否 | 定时器对应的实例ID。仅做出参使用。 示例值:ins-dpa3e3at |
Attribute
属性信息
被如下接口引用:DescribeInstancesAttributes。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserData | String | 否 | 实例的自定义数据。 示例值:TXlVc2VyRGF0YQo= |
ChargePrepaid
描述预付费模式,即包年包月相关参数。包括购买时长和自动续费逻辑等。
被如下接口引用:AllocateHosts, InquiryPriceRenewHosts, RenewHosts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Period | Integer | 是 | 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。 示例值:1 |
| RenewFlag | String | 否 | 自动续费标识。取值范围: 默认取值:NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 示例值:NOTIFY_AND_AUTO_RENEW |
ChcDeployExtraConfig
chc部署网络minos引导配置。
被如下接口引用:ConfigureChcAssistVpc, ConfigureChcDeployVpc, DescribeChcHosts。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MiniOsType | String | 是 | minos类型。是使用腾讯云的minios,还是客户自己的minios。 示例值:public |
| BootType | String | 是 | 服务器的架构和启动方式。取值为x86_legacy, arm_uefi。 示例值:x86_legacy |
| BootFile | String | 否 | PXE使用的引导文件。默认为pxelinux.0。 示例值:pxelinux.0 |
| NextServerAddress | String | 否 | tftp服务器的ip地址。 示例值:169.254.68.10 |
ChcHost
CHC物理服务器信息
被如下接口引用:DescribeChcHosts。
| 名称 | 类型 | 描述 |
|---|---|---|
| ChcId | String | CHC物理服务器ID。 示例值:chc-1a2b3c4d |
| InstanceName | String | 实例名称。 示例值:托管服务器1 |
| SerialNumber | String | 服务器序列号。 示例值:sn34asdfabd |
| InstanceState | String | CHC的状态
示例值:ONLINE |
| DeviceType | String | 设备类型。 示例值:CHC_HS1 |
| Placement | Placement | 所属可用区 |
| BmcVirtualPrivateCloud | VirtualPrivateCloud | 带外网络。 |
| BmcIp | String | 带外网络Ip。 示例值:10.12.10.34 |
| BmcSecurityGroupIds | Array of String | 带外网络安全组Id。 示例值:["sg-1a2b34af"] |
| DeployVirtualPrivateCloud | VirtualPrivateCloud | 部署网络。 |
| DeployIp | String | 部署网络Ip。 示例值:10.12.10.34 |
| DeploySecurityGroupIds | Array of String | 部署网络安全组Id。 示例值:["sg-1a2b34af"] |
| CvmInstanceId | String | 关联的云主机Id。 示例值:ins-34as43at |
| CreatedTime | String | 服务器导入的时间。 示例值:2020-03-10T02:43:51Z |
| HardwareDescription | String | 机型的硬件描述,分别为CPU核数,内存容量和磁盘容量 示例值:128C 22GB 2424GB |
| CPU | Integer | CHC物理服务器的CPU核数 示例值:128 |
| Memory | Integer | CHC物理服务器的内存大小,单位为GB 示例值:22 |
| Disk | String | CHC物理服务器的磁盘信息 示例值:10T |
| BmcMAC | String | 带外网络下分配的MAC地址 示例值:51:94:20:9C:B1:CB |
| DeployMAC | String | 部署网络下分配的MAC地址 示例值:51:94:20:9C:B1:CB |
| TenantType | String | 设备托管类型。 HOSTING: 托管 TENANT: 租赁 示例值:HOSTING |
| DeployExtraConfig | ChcDeployExtraConfig | chc dhcp选项,用于minios调试。 |
| Gpu | String | GPU型号。 示例值:2 * NVIDIA P40 |
| NetworkCard | String | 网卡型号。主要指RDMA网卡。 示例值:ConnectX-5 |
| IsPredefinedType | Boolean | 是否是预定义机型。 示例值:true |
| ChcInstanceType | String | CHC云主机机型。 示例值:CHCS5.128C256M |
| ChcInstanceFamily | String | CHC云主机机型簇。 示例值:CHCS5 |
| ChcInstanceFamilyName | String | CHC云主机机型簇名称。 示例值:标准型CHCS5 |
| ResaleAppId | String | 转售客户的AppId。 示例值:12510001001 |
| ResaleAccountId | String | 转售客户的账号ID。 示例值:100002300442 |
| SaleStatus | String | 售卖状态。
示例值:SOLD |
| Tags | Array of Tag | CHC物理服务器关联的标签列表。 |
| LatestOperation | String | 最近操作 示例值:ChcPrepare |
| LatestOperationErrorCode | String | 最近操作错误码 示例值:IpmiFailed |
| LatestOperationErrorMsg | String | 最近操作错误详情和建议项 示例值:执行IPMI命令失败:1、账号能够拥有远程执行IPMI命令权限;2、在BIOS中设置允许LAN执行IPMI命令。 |
| LatestOperationName | String | 最近操作名称 示例值:带外检查失败 |
| LatestOperationState | String | 最近操作状态 示例值:FAILED |
ChcHostDeniedActions
CHC物理服务器实例禁止操作的返回结构体
被如下接口引用:DescribeChcDeniedActions。
| 名称 | 类型 | 描述 |
|---|---|---|
| ChcId | String | CHC物理服务器的实例id 示例值:“chc-123456fd” |
| State | String | CHC物理服务器的状态 示例值:"ONLINE" |
| DenyActions | Array of String | 当前CHC物理服务器禁止做的操作 示例值:["ConfigureChcAssistVpc'] |
CpuTopology
描述了实例CPU拓扑结构的相关信息。
被如下接口引用:InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CoreCount | Integer | 否 | 决定启用的CPU物理核心数。 示例值:4 |
| ThreadPerCore | Integer | 否 | 每核心线程数。该参数决定是否开启或关闭超线程。 不设置时,实例使用默认的超线程策略。开关超线程请参考文档:开启与关闭超线程。 示例值:2 |
DataDisk
描述了数据盘的信息
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances, ModifyInstanceDiskType, ResizeInstanceDisks, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DiskSize | Integer | 是 | 数据盘大小,单位:GiB。最小调整步长为10GiB,不同数据盘类型取值范围不同,具体限制详见:存储概述。默认值为0,表示不购买数据盘。更多限制详见产品文档。 示例值:50 |
| DiskType | String | 否 | 数据盘类型。数据盘类型限制详见存储概述。取值范围: 默认取值:LOCAL_BASIC 该参数对 ResizeInstanceDisk接口无效。示例值:CLOUD_SSD |
| DiskId | String | 否 | 数据盘ID。 该参数目前仅用于 DescribeInstances等查询类接口的返回参数,不可用于RunInstances等写接口的入参。示例值:disk-ciezoimt |
| DeleteWithInstance | Boolean | 否 | 数据盘是否随子机销毁。取值范围: 默认取值:true 该参数目前仅用于 RunInstances 接口。示例值:true |
| SnapshotId | String | 否 | 数据盘快照ID。选择的数据盘快照大小需小于数据盘大小。 示例值:snap-6yczrj8x |
| Encrypt | Boolean | 否 | 数据盘是否加密。取值范围: 默认取值:false 该参数目前仅用于 RunInstances 接口。示例值:false |
| KmsKeyId | String | 否 | 自定义CMK对应的ID,取值为UUID或者类似kms-abcd1234。用于加密云盘。 该参数目前仅用于 RunInstances 接口。注意:此字段可能返回 null,表示取不到有效值。 示例值:kms-abcd1234 |
| ThroughputPerformance | Integer | 否 | 云硬盘性能,单位:MiB/s。使用此参数可给云硬盘购买额外的性能。 当前仅支持极速型云盘(CLOUD_TSSD)和增强型SSD云硬盘(CLOUD_HSSD) 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
| CdcId | String | 否 | 所属的独享集群ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:cdc-1648zauv |
| BurstPerformance | Boolean | 否 | 突发性能 注:内测中。 示例值:false |
| DiskName | String | 否 | 磁盘名称,长度不超过128 个字符。 示例值:MyDiskName |
DisasterRecoverGroup
容灾组信息
被如下接口引用:DescribeDisasterRecoverGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| DisasterRecoverGroupId | String | 分散置放群组id。 示例值:ps-n4becvb9 |
| Name | String | 分散置放群组名称,长度1-60个字符。 示例值:myGroup |
| Type | String | 分散置放群组类型,取值范围: 示例值:"HOST" |
| CvmQuotaTotal | Integer | 分散置放群组内最大容纳云服务器数量。 示例值:50 |
| CurrentNum | Integer | 分散置放群组内云服务器当前数量。 示例值:2 |
| InstanceIds | Array of String | 分散置放群组内,云服务器id列表。 示例值:["ins-19029pru"] |
| CreateTime | Timestamp ISO8601 | 分散置放群组创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。示例值:"2021-04-27T08:49:34Z" |
| Affinity | Integer | 置放群组亲和度 示例值:1 |
| Tags | Array of Tag | 置放群组关联的标签列表。 |
DisasterRecoverGroupQuota
置放群组配置数据
被如下接口引用:DescribeAccountQuota。
| 名称 | 类型 | 描述 |
|---|---|---|
| GroupQuota | Integer | 可创建置放群组数量的上限。 示例值:0 |
| CurrentNum | Integer | 当前用户已经创建的置放群组数量。 示例值:10 |
| CvmInHostGroupQuota | Integer | 物理机类型容灾组内实例的配额数。 示例值:10 |
| CvmInSwitchGroupQuota | Integer | 交换机类型容灾组内实例的配额数。 示例值:10 |
| CvmInRackGroupQuota | Integer | 机架类型容灾组内实例的配额数。 示例值:20 |
EnhancedService
描述了实例的增强服务启用情况与其设置,如云安全,云监控等实例 Agent
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SecurityService | RunSecurityServiceEnabled | 否 | 开启云安全服务。若不指定该参数,则默认开启云安全服务。 示例值:true |
| MonitorService | RunMonitorServiceEnabled | 否 | 开启云监控服务。若不指定该参数,则默认开启云监控服务。 示例值:true |
| AutomationService | RunAutomationServiceEnabled | 否 | 开启云自动化助手服务(TencentCloud Automation Tools,TAT)。若不指定该参数,则公共镜像默认开启云自动化助手服务,其他镜像默认不开启云自动化助手服务。 示例值:true |
Externals
扩展数据
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstancesActionTimer, DescribeZoneInstanceConfigInfos, ImportInstancesActionTimer, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ReleaseAddress | Boolean | 否 | 释放地址 示例值:true |
| UnsupportNetworks | Array of String | 否 | 不支持的网络类型,取值范围: 示例值:VPC1.0 |
| StorageBlockAttr | StorageBlock | 否 | HDD本地存储属性 |
Filter
描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等
- 若存在多个
Filter时,Filter间的关系为逻辑与(AND)关系。- 若同一个
Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。以DescribeInstances接口的
Filter为例。若我们需要查询可用区(zone)为广州六区 并且 实例计费模式(instance-charge-type)为包年包月 或者 按量计费的实例时,可如下实现:Filters.0.Name=zone &Filters.0.Values.0=ap-guangzhou-6 &Filters.1.Name=instance-charge-type &Filters.1.Values.0=PREPAID &Filters.1.Values.1=POSTPAID_BY_HOUR
被如下接口引用:DescribeAccountQuota, DescribeChcHosts, DescribeDisasterRecoverGroups, DescribeHosts, DescribeHpcClusters, DescribeImages, DescribeInstanceTypeConfigs, DescribeInstances, DescribeInstancesModification, DescribeKeyPairs, DescribeLaunchTemplates, DescribeZoneInstanceConfigInfos。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 需要过滤的字段。 示例值:zone |
| Values | Array of String | 是 | 字段的过滤值。 示例值:["ap-guangzhou-6"] |
GPUInfo
实例GPU信息
被如下接口引用:DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| GPUCount | Float | 实例GPU个数。值小于1代表VGPU类型,大于1代表GPU直通类型。 示例值:1 |
| GPUId | Array of String | 实例GPU地址。 示例值:['0000:18:00.0','0000:18:00.1'] |
| GPUType | String | 实例GPU类型。 示例值:NVIDIA T4 |
HostItem
专用宿主机实例详细信息
被如下接口引用:DescribeHosts。
| 名称 | 类型 | 描述 |
|---|---|---|
| Placement | Placement | 专用宿主机实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。 示例值:{ "Zone": "ap-guangzhou-4", "ProjectId": 0 } |
| HostId | String | 专用宿主机实例ID 示例值:host-6154dm9w |
| HostType | String | 专用宿主机实例类型 示例值:HS50 |
| HostName | String | 专用宿主机实例名称 示例值:myHost |
| HostChargeType | String | 专用宿主机实例付费模式 示例值:PREPAID |
| RenewFlag | String | 专用宿主机实例自动续费标记 示例值:NOTIFY_AND_AUTO_RENEW |
| CreatedTime | Timestamp ISO8601 | 专用宿主机实例创建时间 示例值:2024-11-03T09:47:00Z |
| ExpiredTime | Timestamp ISO8601 | 专用宿主机实例过期时间 示例值:2024-12-03T09:47:00Z |
| InstanceIds | Array of String | 专用宿主机实例上已创建云子机的实例id列表 示例值:ins-bv6i4xxx |
| HostState | String | 专用宿主机实例状态 示例值:RUNNING |
| HostIp | String | 专用宿主机实例IP 示例值:10.0.0.6 |
| HostResource | HostResource | 专用宿主机实例资源信息 示例值:{ "CpuTotal": 126, "CpuAvailable": 24, "MemTotal": 320, "MemAvailable": 77, "DiskTotal": 0, "DiskAvailable": 0, "DiskType": "", "GpuTotal": 0, "GpuAvailable": 0 } |
| CageId | String | 专用宿主机所属的围笼ID。该字段仅对金融专区围笼内的专用宿主机有效。 示例值:cage-gz-1-2 |
| Tags | Array of Tag | 专用宿主机关联的标签列表。 示例值:[ { "ResourceType": "cdh", "Tags": [ { "Key": "myTag", "Value": "cloud" } ] } ] |
HostPriceInfo
cdh相关价格信息
被如下接口引用:InquiryPriceRenewHosts。
| 名称 | 类型 | 描述 |
|---|---|---|
| HostPrice | ItemPrice | 描述了cdh实例相关的价格信息 |
HostResource
专用宿主机实例的资源信息
被如下接口引用:DescribeHosts。
| 名称 | 类型 | 描述 |
|---|---|---|
| CpuTotal | Integer | 专用宿主机实例总CPU核数 示例值:32 |
| CpuAvailable | Integer | 专用宿主机实例可用CPU核数 示例值:32 |
| MemTotal | Float | 专用宿主机实例总内存大小(单位为:GiB) 示例值:96 |
| MemAvailable | Float | 专用宿主机实例可用内存大小(单位为:GiB) 示例值:96 |
| DiskTotal | Integer | 专用宿主机实例总磁盘大小(单位为:GiB) 示例值:1000 |
| DiskAvailable | Integer | 专用宿主机实例可用磁盘大小(单位为:GiB) 示例值:1000 |
| DiskType | String | 专用宿主机实例磁盘类型 示例值:"LOCAL_SSD" |
| GpuTotal | Integer | 专用宿主机实例总GPU卡数 示例值:0 |
| GpuAvailable | Integer | 专用宿主机实例可用GPU卡数 示例值:0 |
| ExclusiveOwner | String | CDH owner 示例值:12300021 |
HpcClusterInfo
高性能计算集群
被如下接口引用:CreateHpcCluster, DescribeHpcClusters。
| 名称 | 类型 | 描述 |
|---|---|---|
| HpcClusterId | String | 高性能计算集群ID 示例值:hpc-07b1c |
| Name | String | 高性能计算集群名 示例值:myCluster |
| Remark | String | 高性能计算集群备注 示例值:HCCPNV6 |
| CvmQuotaTotal | Integer | 集群下设备容量 示例值:1600 |
| Zone | String | 集群所在可用区 示例值:ap-guangzhou-6 |
| CurrentNum | Integer | 集群当前已有设备量 示例值:1 |
| CreateTime | Timestamp ISO8601 | 集群创建时间 示例值:2023-10-05T14:30:00Z |
| InstanceIds | Array of String | 集群内实例ID列表 示例值:["ins-xxxxx"] |
| HpcClusterType | String | 高性能计算集群类型。 示例值:STANDARD |
| HpcClusterBusinessId | String | 高性能计算集群对应的业务场景标识,当前只支持CDC。 示例值:cluster-1f6vxxx |
| HpcClusterNetMode | Integer | 高性能计算集群网络模式 示例值:30 |
| Tags | Array of Tag | 高性能计算集群关联的标签列表 |
Image
一个关于镜像详细信息的结构体,主要包括镜像的主要状态与属性。
被如下接口引用:DescribeImageFromFamily, DescribeImages。
| 名称 | 类型 | 描述 |
|---|---|---|
| ImageId | String | 镜像ID 示例值:img-19mu3fy3 |
| OsName | String | 镜像操作系统 示例值:CentOS 8.0 64位 |
| ImageType | String | 镜像类型。镜像类型返回值包括: * PUBLIC_IMAGE 公共镜像* PRIVATE_IMAGE 自定义镜像* SHARED_IMAGE 共享镜像示例值:PRIVATE_IMAGE |
| CreatedTime | Timestamp ISO8601 | 镜像创建时间。 按照 ISO8601 标准表示,并且使用 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。 示例值:2022-03-21T08:41:45Z |
| ImageName | String | 镜像名称 示例值:myImg |
| ImageDescription | String | 镜像描述 示例值:tencentcloud |
| ImageSize | Integer | 镜像大小,单位 GiB。 示例值:50 |
| Architecture | String | 镜像架构。镜像架构返回值包括: * x86_64* arm* i386示例值:x86_64 |
| ImageState | String | 镜像状态: CREATING-创建中 NORMAL-正常 CREATEFAILED-创建失败 SYNCING-复制中 IMPORTING-导入中 IMPORTFAILED-导入失败 示例值:NORMAL |
| Platform | String | 镜像来源平台,包括如TencentOS、 CentOS、 Windows、 Ubuntu、 Debian、Fedora等。 示例值:CentOS |
| ImageCreator | String | 镜像创建者 示例值:tencentcloud |
| ImageSource | String | 镜像来源。镜像来源返回值包括: * OFFICIAL 官方镜像* CREATE_IMAGE 用户自建镜像* EXTERNAL_IMPORT 用户外部导入镜像示例值:CREATE_IMAGE |
| SyncPercent | Integer | 同步百分比 注意:此字段可能返回 null,表示取不到有效值。 示例值:60 |
| IsSupportCloudinit | Boolean | 镜像是否支持cloud-init 示例值:true |
| SnapshotSet | Array of Snapshot | 镜像关联的快照信息 |
| Tags | Array of Tag | 镜像关联的标签列表。 |
| LicenseType | String | 镜像许可类型。镜像许可类型返回值包括: * TencentCloud 腾讯云官方许可* BYOL 用户自带许可示例值:TencentCloud |
| ImageFamily | String | 镜像族 示例值:business-daily-update |
| ImageDeprecated | Boolean | 镜像是否废弃 示例值:false |
| CdcCacheStatus | String | CDC镜像缓存状态 示例值:CACHED |
ImageOsList
支持的操作系统类型,根据Windows和Linux分类。
被如下接口引用:DescribeImportImageOs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Windows | Array of String | 支持的Windows操作系统。 示例值:Windows Server 2019 |
| Linux | Array of String | 支持的Linux操作系统 示例值:CentOS |
ImageQuota
镜像配额
被如下接口引用:DescribeAccountQuota。
| 名称 | 类型 | 描述 |
|---|---|---|
| UsedQuota | Integer | 已使用配额 示例值:10 |
| TotalQuota | Integer | 总配额 示例值:20 |
ImportImageDataDisk
导入镜像的数据盘信息
被如下接口引用:ImportImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImageUrl | String | 是 | 数据盘镜像 COS 链接 示例值:https://import-img.cos.ap-guangzhou.myqcloud.com/import-img.vpc |
Instance
描述实例的信息
被如下接口引用:DescribeInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| Placement | Placement | 实例所在的位置。 |
| InstanceId | String | 实例ID。示例值:ins-9bxebleo |
| InstanceType | String | 实例机型。 示例值:S1.SMALL1 |
| CPU | Integer | 实例的CPU核数,单位:核。 示例值:1 |
| Memory | Integer | 实例内存容量,单位:GiB。示例值:1 |
| RestrictState | String | 实例业务状态。取值范围: 示例值:NORMAL |
| InstanceName | String | 实例名称。 示例值:测试实例 |
| InstanceChargeType | String | 实例计费类型。取值范围: 示例值:PREPAID |
| SystemDisk | SystemDisk | 实例系统盘信息。 |
| DataDisks | Array of DataDisk | 实例数据盘信息。 |
| PrivateIpAddresses | Array of String | 实例主网卡的内网IP列表。示例值:["172.16.32.78"] |
| PublicIpAddresses | Array of String | 实例主网卡的公网IP列表。注意:此字段可能返回 null,表示取不到有效值。 示例值:["110.207.11.190"] |
| InternetAccessible | InternetAccessible | 实例带宽信息。 |
| VirtualPrivateCloud | VirtualPrivateCloud | 实例所属虚拟私有网络信息。 |
| ImageId | String | 生产实例所使用的镜像ID。示例值:img-9qabwvbn |
| RenewFlag | String | 自动续费标识。取值范围:NOTIFY_AND_MANUAL_RENEW:表示通知即将过期,但不自动续费NOTIFY_AND_AUTO_RENEW:表示通知即将过期,而且自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW:表示不通知即将过期,也不自动续费。示例值:NOTIFY_AND_MANUAL_RENEW |
| CreatedTime | Timestamp ISO8601 | 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。示例值:2020-03-10T02:43:51Z |
| ExpiredTime | Timestamp ISO8601 | 到期时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。注意:后付费模式本项为null示例值:2020-04-10T02:47:36Z |
| OsName | String | 操作系统名称。 示例值:CentOS 7.6 64bit |
| SecurityGroupIds | Array of String | 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。 示例值:["sg-p1ezv4wz"] |
| LoginSettings | LoginSettings | 实例登录设置。目前只返回实例所关联的密钥。 |
| InstanceState | String | 实例状态。状态类型详见实例状态表 示例值:RUNNING |
| Tags | Array of Tag | 实例关联的标签列表。 |
| StopChargingMode | String | 实例的关机计费模式。 取值范围: 示例值:NOT_APPLICABLE |
| Uuid | String | 实例全局唯一ID 示例值:68b510db-b4c1-4630-a62b-73d0c7c970f9 |
| LatestOperation | String | 实例的最新操作。例:StopInstances、ResetInstance。 注意:此字段可能返回 null,表示取不到有效值。 示例值:RenewInstances |
| LatestOperationState | String | 实例的最新操作状态。取值范围: 注意:此字段可能返回 null,表示取不到有效值。 示例值:SUCCESS |
| LatestOperationRequestId | String | 实例最新操作的唯一请求 ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:3554eb5b-1cfa-471a-ae76-dc436c9d43e8 |
| DisasterRecoverGroupId | String | 分散置放群组ID。 示例值:ps-l7sdunxx |
| IPv6Addresses | Array of String | 实例的IPv6地址。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["xx.xxxxx.xxx"] |
| CamRoleName | String | CAM角色名。 注意:此字段可能返回 null,表示取不到有效值。 示例值:admin |
| HpcClusterId | String | 高性能计算集群ID。示例值:hpc-4dxxetpt |
| RdmaIpAddresses | Array of String | 高性能计算集群IP列表。注意:此字段可能返回 null,表示取不到有效值。 示例值:["xx.xxxxx.xxx"] |
| DedicatedClusterId | String | 实例所在的专用集群ID。示例值:cluster-du3jken |
| IsolatedSource | String | 实例隔离类型。取值范围: 示例值:NOTISOLATED |
| GPUInfo | GPUInfo | GPU信息。如果是gpu类型子机,该值会返回GPU信息,如果是其他类型子机则不返回。 |
| LicenseType | String | 实例的操作系统许可类型,默认为TencentCloud 示例值:TencentCloud |
| DisableApiTermination | Boolean | 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围: 默认取值:false。 示例值:false |
| DefaultLoginUser | String | 默认登录用户。 示例值:root |
| DefaultLoginPort | Integer | 默认登录端口。 示例值:22 |
| LatestOperationErrorMsg | String | 实例的最新操作错误信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:None |
| Metadata | Metadata | 自定义metadata,本参数对应创建 CVM时指定的Metadata 信息。注:内测中。 |
| PublicIPv6Addresses | Array of String | 实例绑定的公网IPv6地址。 示例值:["240d:c000:f000:ac00:5460:6340:16aa:6"] |
InstanceAttribute
实例属性
被如下接口引用:DescribeInstancesAttributes。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例 ID。 示例值:ins-lyxxskp2 |
| Attributes | Attribute | 实例属性信息。 |
InstanceChargePrepaid
描述了实例的计费模式
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceRunInstances, ModifyInstancesChargeType, RenewInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Period | Integer | 是 | 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 示例值:1 |
| RenewFlag | String | 否 | 自动续费标识。取值范围: 默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 示例值:DISABLE_NOTIFY_AND_MANUAL_RENEW |
InstanceFamilyConfig
描述实例的机型族配置信息
形如:{'InstanceFamilyName': '标准型S1', 'InstanceFamily': 'S1'}、{'InstanceFamilyName': '网络优化型N1', 'InstanceFamily': 'N1'}、{'InstanceFamilyName': '高IO型I1', 'InstanceFamily': 'I1'}等。
被如下接口引用:DescribeInstanceFamilyConfigs。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceFamilyName | String | 机型族名称的中文全称。 示例值:高IO型I1 |
| InstanceFamily | String | 机型族名称的英文简称。 示例值:I1 |
InstanceMarketOptionsRequest
竞价请求相关选项
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SpotOptions | SpotMarketOptions | 是 | 竞价相关选项 示例值:0.12 |
| MarketType | String | 否 | 市场选项类型,当前只支持取值:spot 示例值:spot |
InstanceRefund
描述退款详情。
被如下接口引用:InquiryPriceTerminateInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例Id。 示例值:"ins-fxqy3xmq" |
| Refunds | Float | 退款数额。 示例值:"7.36元" |
| PriceDetail | String | 退款详情。 示例值:"退款:7.36元,代金券不退(订单号20210406606002706051431:部件cvm:现金支付17.9元-已使用第一 |
InstanceStatus
描述实例的状态。状态类型详见实例状态表
被如下接口引用:DescribeInstancesStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID。示例值:ins-g4c6xxxx |
| InstanceState | String | 实例状态。取值范围: 示例值:RUNNING |
InstanceTypeConfig
描述实例机型配置信息
被如下接口引用:DescribeInstanceTypeConfigs, DescribeInstancesModification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Zone | String | 可用区。 示例值:ap-guangzhou-6 |
| InstanceType | String | 实例机型。 示例值:S5.LARGE4 |
| InstanceFamily | String | 实例机型系列。 示例值:S5 |
| GPU | Integer | GPU核数,单位:核。 示例值:1 |
| CPU | Integer | CPU核数,单位:核。 示例值:4 |
| Memory | Integer | 内存容量,单位:GiB。示例值:4 |
| FPGA | Integer | FPGA核数,单位:核。 示例值:1 |
| GpuCount | Float | 实例机型映射的物理GPU卡数,单位:卡。vGPU卡型小于1,直通卡型大于等于1。vGPU是通过分片虚拟化技术,将物理GPU卡重新划分,同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。 示例值:1.0 |
InstanceTypeConfigStatus
描述实例机型配置信息及状态信息
被如下接口引用:DescribeInstancesModification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 状态描述 示例值:"UNAVAILABLE" |
| Message | String | 状态描述信息 示例值:"The instance does not support tuning to SA3 instance family." |
| InstanceTypeConfig | InstanceTypeConfig | 配置信息 |
InstanceTypeQuotaItem
描述实例机型配额信息。
被如下接口引用:DescribeZoneInstanceConfigInfos。
| 名称 | 类型 | 描述 |
|---|---|---|
| Zone | String | 可用区。 示例值:ap-guangzhou-6 |
| InstanceType | String | 实例机型。 示例值:S5.LARGE4 |
| InstanceChargeType | String | 实例计费模式。取值范围: 专用宿主机计费,不对专用宿主机上的实例计费。示例值:PREPAID |
| NetworkCard | Integer | 网卡类型,例如:25代表25G网卡 示例值:25 |
| Externals | Externals | 扩展属性。 |
| Cpu | Integer | 实例的CPU核数,单位:核。 示例值:4 |
| Memory | Integer | 实例内存容量,单位:GB。示例值:4 |
| InstanceFamily | String | 实例机型系列。 示例值:S5 |
| TypeName | String | 机型名称。 示例值:标准型S5 |
| LocalDiskTypeList | Array of LocalDiskType | 本地磁盘规格列表。当该参数返回为空值时,表示当前情况下无法创建本地盘。 |
| Status | String | 实例是否售卖。取值范围: 示例值:SELL |
| Price | ItemPrice | 实例的售卖价格。 |
| SoldOutReason | String | 售罄原因。 示例值:ResourcesSoldOut.SpecifiedInstanceType |
| InstanceBandwidth | Float | 内网带宽,单位Gbps。 示例值:10.0 |
| InstancePps | Integer | 网络收发包能力,单位万PPS。 示例值:80 |
| StorageBlockAmount | Integer | 本地存储块数量。 示例值:10 |
| CpuType | String | 处理器型号。 示例值:Intel Xeon Cascade Lake 8255C |
| Gpu | Integer | 实例的GPU数量。 示例值:1 |
| Fpga | Integer | 实例的FPGA数量。 示例值:1 |
| Remark | String | 实例备注信息。 示例值:搭载1 块 11176 GB SATA HDD 本地硬盘 |
| GpuCount | Float | 实例机型映射的物理GPU卡数,单位:卡。vGPU卡型小于1,直通卡型大于等于1。vGPU是通过分片虚拟化技术,将物理GPU卡重新划分,同一块GPU卡经虚拟化分割后可分配至不同的实例使用。直通卡型会将GPU设备直接挂载给实例使用。 示例值:1.0 |
| Frequency | String | 实例的CPU主频信息 示例值:-/3.1GHz |
| StatusCategory | String | 描述库存情况。取值范围: 示例值:EnoughStock |
InternetAccessible
描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstanceInternetBandwidthConfigs, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceRunInstances, ResetInstancesInternetMaxBandwidth, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InternetChargeType | String | 否 | 网络计费类型。取值范围: 示例值:BANDWIDTH_PREPAID |
| InternetMaxBandwidthOut | Integer | 否 | 公网出带宽上限,单位:Mbps。默认值:0Mbps。不同机型带宽上限范围不一致,具体限制详见购买网络带宽。 示例值:10 |
| PublicIpAssigned | Boolean | 否 | 是否分配公网IP。取值范围: 当公网带宽大于0Mbps时,可自由选择开通与否,默认开通公网IP;当公网带宽为0,则不允许分配公网IP。该参数仅在RunInstances接口中作为入参使用。 示例值:false |
| BandwidthPackageId | String | 否 | 带宽包ID。可通过 DescribeBandwidthPackages 接口返回值中的BandwidthPackageId获取。该参数仅在RunInstances接口中作为入参使用。示例值:bwp-h1ro |
| InternetServiceProvider | String | 否 | 线路类型。各种线路类型及支持地区详情可参考:EIP 的 IP 地址类型。默认值:BGP。 已开通静态单线IP白名单的用户,可选值: 注意:仅部分地域支持静态单线IP。 示例值:BGP |
| IPv4AddressType | String | 否 | 公网 IP 类型。 如需为资源分配公网IPv4地址,请指定公网IPv4地址类型。 此功能仅部分地区灰度开放,如需使用请提交工单咨询 示例值:WanIP |
| IPv6AddressType | String | 否 | 弹性公网 IPv6 类型。 如需为资源分配IPv6地址,请指定弹性公网IPv6类型。 此功能仅部分地区灰度开放,如需使用请提交工单咨询 示例值:EIPv6 |
| AntiDDoSPackageId | String | 否 | 高防包唯一ID,申请高防IP时,该字段必传。 示例值:bgp-00000000 |
InternetBandwidthConfig
描述了按带宽计费的相关信息
被如下接口引用:DescribeInstanceInternetBandwidthConfigs。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTime | Timestamp ISO8601 | 开始时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。示例值:2023-10-05T14:30:00Z |
| EndTime | Timestamp ISO8601 | 结束时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。示例值:2023-11-05T14:30:00Z |
| InternetAccessible | InternetAccessible | 实例带宽信息。 |
InternetChargeTypeConfig
描述了网络计费
被如下接口引用:DescribeInternetChargeTypeConfigs。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InternetChargeType | String | 否 | 网络计费类型。取值范围: 示例值:TRAFFIC_POSTPAID_BY_HOUR |
| Description | String | 否 | 网络计费模式描述信息。 示例值:postpaid monthly |
ItemPrice
描述了单项的价格信息
被如下接口引用:DescribeZoneInstanceConfigInfos, InquiryPriceModifyInstancesChargeType, InquiryPriceRenewHosts, InquiryPriceRenewInstances, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| UnitPrice | Float | 后续合计费用的原价,后付费模式使用,单位:元。 示例值:35.5 |
| ChargeUnit | String | 后续计价单元,后付费模式使用,可取值范围: 示例值:HOUR |
| OriginalPrice | Float | 预支合计费用的原价,预付费模式使用,单位:元。 示例值:35.5 |
| DiscountPrice | Float | 预支合计费用的折扣价,预付费模式使用,单位:元。 示例值:35.5 |
| Discount | Float | 折扣,如20.0代表2折。 示例值:20.0 |
| UnitPriceDiscount | Float | 后续合计费用的折扣价,后付费模式使用,单位:元 示例值:35.5 |
| UnitPriceSecondStep | Float | 使用时间区间在(96, 360)小时的后续合计费用的原价,后付费模式使用,单位:元。 示例值:35.5 |
| UnitPriceDiscountSecondStep | Float | 使用时间区间在(96, 360)小时的后续合计费用的折扣价,后付费模式使用,单位:元 示例值:35.5 |
| UnitPriceThirdStep | Float | 使用时间区间在(360, ∞)小时的后续合计费用的原价,后付费模式使用,单位:元。 示例值:35.5 |
| UnitPriceDiscountThirdStep | Float | 使用时间区间在(360, ∞)小时的后续合计费用的折扣价,后付费模式使用,单位:元 示例值:35.5 |
| OriginalPriceThreeYear | Float | 预支三年合计费用的原价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
| DiscountPriceThreeYear | Float | 预支三年合计费用的折扣价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
| DiscountThreeYear | Float | 预支三年应用的折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
| OriginalPriceFiveYear | Float | 预支五年合计费用的原价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
| DiscountPriceFiveYear | Float | 预支五年合计费用的折扣价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
| DiscountFiveYear | Float | 预支五年应用的折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
| OriginalPriceOneYear | Float | 预支一年合计费用的原价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
| DiscountPriceOneYear | Float | 预支一年合计费用的折扣价,预付费模式使用,单位:元。 注意:此字段可能返回 null,表示取不到有效值。 示例值:35.5 |
| DiscountOneYear | Float | 预支一年应用的折扣,如20.0代表2折。 注意:此字段可能返回 null,表示取不到有效值。 示例值:20.0 |
KeyPair
描述密钥对信息
被如下接口引用:CreateKeyPair, DescribeKeyPairs。
| 名称 | 类型 | 描述 |
|---|---|---|
| KeyId | String | 密钥对的ID,是密钥对的唯一标识。示例值:skey-q29u65hu |
| KeyName | String | 密钥对名称。 示例值:mySkey |
| ProjectId | Integer | 密钥对所属的项目 ID,ProjectId 为 0 时表示默认项目。示例值:0 |
| Description | String | 密钥对描述信息。 示例值:mySkey |
| PublicKey | String | 密钥对的纯文本公钥。 示例值:ssh-rsa AAAAB3N......59LPzXah+r+d skey-0mjpcb19 |
| PrivateKey | String | 密钥对的纯文本私钥。腾讯云不会保管私钥,请用户自行妥善保存。 示例值:-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAzDC......WCvOBGeKHg==\n-----END RSA PRIVATE KEY----- |
| AssociatedInstanceIds | Array of String | 密钥关联的实例ID列表。示例值:["ins-syht65r4"] |
| CreatedTime | Timestamp ISO8601 | 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。示例值:2022-03-21T08:41:45Z |
| Tags | Array of Tag | 密钥关联的标签列表。 |
LaunchTemplate
实例启动模板,通过该参数可使用实例模板中的预设参数创建实例。
被如下接口引用:InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LaunchTemplateId | String | 否 | 实例启动模板ID,通过该参数可使用实例模板中的预设参数创建实例。 示例值:lt-rf6ogz48 |
| LaunchTemplateVersion | Integer | 否 | 实例启动模板版本号,若给定,新实例启动模板将基于给定的版本号创建 示例值:1 |
LaunchTemplateInfo
实例启动模板简要信息。
被如下接口引用:DescribeLaunchTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| LatestVersionNumber | Integer | 实例启动模版本号。 示例值:10 |
| LaunchTemplateId | String | 实例启动模板ID。 示例值:lt-rf6ogz49 |
| LaunchTemplateName | String | 实例启动模板名。 示例值:foobar |
| DefaultVersionNumber | Integer | 实例启动模板默认版本号。 示例值:5 |
| LaunchTemplateVersionCount | Integer | 实例启动模板包含的版本总数量。 示例值:8 |
| CreatedBy | String | 创建该模板的用户UIN。 示例值:1230000 |
| CreationTime | Timestamp ISO8601 | 创建该模板的时间。 示例值:2020-12-17T01:54:31Z |
LaunchTemplateVersionData
实例启动模板版本信息
被如下接口引用:DescribeLaunchTemplateVersions。
| 名称 | 类型 | 描述 |
|---|---|---|
| Placement | Placement | 实例所在的位置。 |
| InstanceType | String | 实例机型。 示例值:S1.SMALL2 |
| InstanceName | String | 实例名称。 示例值:MyInstance |
| InstanceChargeType | String | 实例计费模式。取值范围:PREPAID:表示预付费,即包年包月POSTPAID_BY_HOUR:表示后付费,即按量计费CDHPAID:专用宿主机付费,即只对专用宿主机计费,不对专用宿主机上的实例计费。SPOTPAID:表示竞价实例付费。示例值:PREPAID |
| SystemDisk | SystemDisk | 实例系统盘信息。 |
| DataDisks | Array of DataDisk | 实例数据盘信息。只包含随实例购买的数据盘。 |
| InternetAccessible | InternetAccessible | 实例带宽信息。 |
| VirtualPrivateCloud | VirtualPrivateCloud | 实例所属虚拟私有网络信息。 |
| ImageId | String | 生产实例所使用的镜像ID。示例值:img-pi0aa46r |
| SecurityGroupIds | Array of String | 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。 示例值:["sg-rf6ogz49"] |
| LoginSettings | LoginSettings | 实例登录设置。目前只返回实例所关联的密钥。 |
| CamRoleName | String | CAM角色名。 示例值:testroleName001 |
| HpcClusterId | String | 高性能计算集群ID。示例值:hpc-a5n666lo |
| InstanceCount | Integer | 购买实例数量。 示例值:1 |
| EnhancedService | EnhancedService | 增强服务。 |
| UserData | String | 提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16KB。 示例值:TXlVc2VyRGF0YQo= |
| DisasterRecoverGroupIds | Array of String | 置放群组ID,仅支持指定一个。 示例值:["ps-3p88qhfo"] |
| ActionTimer | ActionTimer | 定时任务。通过该参数可以为实例指定定时任务,目前仅支持定时销毁。 |
| InstanceMarketOptions | InstanceMarketOptionsRequest | 实例的市场相关选项,如竞价实例相关参数,若指定实例的付费模式为竞价付费则该参数必传。 |
| HostName | String | 云服务器的主机名。 示例值:MyHostName |
| ClientToken | String | 用于保证请求幂等性的字符串。 示例值:system-f3827db9-c58a-49cc-bf10-33fc1923a34a |
| InstanceChargePrepaid | InstanceChargePrepaid | 预付费模式,即包年包月相关参数设置。 |
| TagSpecification | Array of TagSpecification | 标签描述列表。通过指定该参数可以同时绑定标签到相应的云服务器、云硬盘实例。 |
| DisableApiTermination | Boolean | 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围: true:表示开启实例保护,不允许通过api接口删除实例 false:表示关闭实例保护,允许通过api接口删除实例 默认取值:false。 示例值:false |
LaunchTemplateVersionInfo
实例启动模板版本集合
被如下接口引用:DescribeLaunchTemplateVersions。
| 名称 | 类型 | 描述 |
|---|---|---|
| LaunchTemplateVersion | Integer | 实例启动模板版本号。 示例值:1 |
| LaunchTemplateVersionData | LaunchTemplateVersionData | 实例启动模板版本数据详情。 |
| CreationTime | Timestamp ISO8601 | 实例启动模板版本创建时间。 示例值:2020-12-17T01:54:31Z |
| LaunchTemplateId | String | 实例启动模板ID。 示例值:lt-b8v1kcyq |
| IsDefaultVersion | Boolean | 是否为默认启动模板版本。 示例值:true |
| LaunchTemplateVersionDescription | String | 实例启动模板版本描述信息。 示例值:MyVersion |
| CreatedBy | String | 创建者的AppId。 示例值:251001234 |
LocalDiskType
本地磁盘规格
被如下接口引用:DescribeZoneInstanceConfigInfos。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 本地磁盘类型。 示例值:LOCAL_BASIC |
| PartitionType | String | 本地磁盘属性。 示例值:ROOT |
| MinSize | Integer | 本地磁盘最小值。 示例值:10 |
| MaxSize | Integer | 本地磁盘最大值。 示例值:20 |
| Required | String | 购买时本地盘是否为必选。取值范围: 示例值:REQUIRED |
LoginSettings
描述了实例登录相关配置与信息。
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Password | String | 否 | 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下: 示例值:123456@ABC |
| KeyIds | Array of String | 否 | 密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["skey-3glfot13"] |
| KeepImageLogin | String | 否 | 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为true。取值范围: 示例值:true |
Metadata
自定义metadata
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Items | Array of MetadataItem | 是 | 自定义metadata键值对列表。 示例值:[{"Key": "key", "Value": "value"}] |
MetadataItem
自定义metadata key和value
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 自定义metadata键,由大写字母(A-Z)、小写字母(a-z)、数字(0-9)、下划线(_)或连字符(-)组成,大小上限为128 字节。 示例值:"key" |
| Value | String | 是 | 自定义metadata值,大小上限为256 KB。 示例值:"value" |
OperationCountLimit
描述了单台实例操作次数限制
被如下接口引用:DescribeInstancesOperationLimit。
| 名称 | 类型 | 描述 |
|---|---|---|
| Operation | String | 实例操作。取值范围:INSTANCE_DEGRADE:降配操作INTERNET_CHARGE_TYPE_CHANGE:修改网络带宽计费模式示例值:INSTANCE_DEGRADE |
| InstanceId | String | 实例ID。 示例值:ins-xxxxx |
| CurrentCount | Integer | 当前已使用次数,如果返回值为-1表示该操作无次数限制。 示例值:1 |
| LimitCount | Integer | 操作次数最高额度,如果返回值为-1表示该操作无次数限制,如果返回值为0表示不支持调整配置。 示例值:5 |
OsVersion
操作系统支持的类型。
被如下接口引用:DescribeImportImageOs。
| 名称 | 类型 | 描述 |
|---|---|---|
| OsName | String | 操作系统类型 示例值:CentOS |
| OsVersions | Array of String | 支持的操作系统版本 示例值:["9"] |
| Architecture | Array of String | 支持的操作系统架构 示例值:x86_64 |
Placement
描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机(仅专用宿主机产品可用),母机IP等
被如下接口引用:AllocateHosts, CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeChcHosts, DescribeHosts, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Zone | String | 是 | 实例所属的可用区名称。该参数可以通过调用 DescribeZones 的返回值中的Zone字段来获取。 示例值:ap-guangzhou-4 |
| ProjectId | Integer | 否 | 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 ProjectId 字段来获取。默认取值0,表示默认项目。示例值:0 |
| HostIds | Array of String | 否 | 实例所属的专用宿主机ID列表,仅用于入参。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。该参数可以通过调用 DescribeHosts 的返回值中的 HostId 字段来获取。示例值:["host-o5i742go"] |
| HostId | String | 否 | 实例所属的专用宿主机ID,仅用于出参。 示例值:host-o5i742go |
PostPaidQuota
后付费实例配额
被如下接口引用:DescribeAccountQuota。
| 名称 | 类型 | 描述 |
|---|---|---|
| UsedQuota | Integer | 累计已使用配额 示例值:10 |
| RemainingQuota | Integer | 剩余配额 示例值:90 |
| TotalQuota | Integer | 总配额 示例值:100 |
| Zone | String | 可用区 示例值:ap-guangzhou-1 |
PrePaidQuota
预付费实例配额
被如下接口引用:DescribeAccountQuota。
| 名称 | 类型 | 描述 |
|---|---|---|
| UsedQuota | Integer | 当月已使用配额 示例值:10 |
| OnceQuota | Integer | 单次购买最大数量 示例值:100 |
| RemainingQuota | Integer | 剩余配额 示例值:90 |
| TotalQuota | Integer | 总配额 示例值:100 |
| Zone | String | 可用区 示例值:ap-nanjing-1 |
Price
价格
被如下接口引用:InquiryPriceModifyInstancesChargeType, InquiryPriceRenewInstances, InquiryPriceResetInstance, InquiryPriceResetInstancesInternetMaxBandwidth, InquiryPriceResetInstancesType, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstancePrice | ItemPrice | 描述了实例价格。 |
| BandwidthPrice | ItemPrice | 描述了网络价格。 |
RegionInfo
地域信息
被如下接口引用:DescribeRegions。
| 名称 | 类型 | 描述 |
|---|---|---|
| Region | String | 地域名称,例如,ap-guangzhou 示例值:ap-guangzhou |
| RegionName | String | 地域描述,例如,华南地区(广州) 示例值:华南地区(广州) |
| RegionState | String | 地域是否可用状态 示例值:AVAILABLE |
RepairTaskInfo
描述维修任务的相关信息
被如下接口引用:DescribeTaskInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 维修任务ID 示例值:rep-xxxxxxxx |
| InstanceId | String | 实例ID 示例值:ins-xxxxxxxx |
| Alias | String | 实例名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:myTask |
| TaskTypeId | Integer | 任务类型ID,与任务类型中文名的对应关系如下: - 101:实例运行隐患- 102:实例运行异常- 103:实例硬盘异常- 104:实例网络连接异常- 105:实例运行预警- 106:实例硬盘预警- 107:实例维护升级各任务类型的具体含义,可参考 维修任务分类。 示例值:101 |
| TaskTypeName | String | 任务类型中文名 示例值:实例运行隐患 |
| TaskStatus | Integer | 任务状态ID,与任务状态中文名的对应关系如下: - 1:待授权- 2:处理中- 3:已结束- 4:已预约- 5:已取消- 6:已避免各任务状态的具体含义,可参考 任务状态。 示例值:1 |
| DeviceStatus | Integer | 设备状态ID,与设备状态中文名的对应关系如下: - 1:故障中- 2:处理中- 3:正常- 4:已预约- 5:已取消- 6:已避免示例值:1 |
| OperateStatus | Integer | 操作状态ID,与操作状态中文名的对应关系如下: - 1:未授权- 2:已授权- 3:已处理- 4:已预约- 5:已取消- 6:已避免示例值:1 |
| CreateTime | Timestamp | 任务创建时间 示例值:2017-01-01 12:00:00 |
| AuthTime | Timestamp | 任务授权时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2017-01-03 12:00:00 |
| EndTime | Timestamp | 任务结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2017-01-03 14:00:00 |
| TaskDetail | String | 任务详情 注意:此字段可能返回 null,表示取不到有效值。 示例值:监控到您的云服务器存在隐患,可能导致云服务器高负载或宕机。为尽快修复隐患,需要您授权我们在线迁移。感谢您的支持与理解。 |
| Zone | String | 可用区 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou-7 |
| Region | String | 地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou |
| VpcId | String | 所在私有网络ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-xxxxxxxx |
| VpcName | String | 所在私有网络名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default-VPC |
| SubnetId | String | 所在子网ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:subnet-xxxxxxxx |
| SubnetName | String | 所在子网名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:Default-Subnet |
| WanIp | String | 实例公网IP 注意:此字段可能返回 null,表示取不到有效值。 示例值:11.22.33.44 |
| LanIp | String | 实例内网IP 注意:此字段可能返回 null,表示取不到有效值。 示例值:10.10.1.9 |
| Product | String | 产品类型,支持取值: - CVM:云服务器- CDH:专用宿主机- CPM2.0:裸金属云服务器注意:此字段可能返回 null,表示取不到有效值。 示例值:CVM |
| TaskSubType | String | 任务子类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:unconfirmed |
| AuthType | Integer | 任务授权类型,当前AuthType和维修任务提供的授权选项的对应关系如下:- "1":仅提供【在线迁移授权】- "2":仅提供【停机授权】- "3":仅提供【在线换盘授权】- "4":提供【停机换盘授权】(默认)、【弃盘迁移授权】(可选)- "5":提供【停机授权】(默认)、【弃盘迁移授权】(可选)- "6":仅提供【在线维护授权】- "7":提供【在线维护授权】(默认)、【停机授权】(可选)- "8":仅提供【弃盘迁移授权】示例值:1 |
| AuthSource | String | 授权渠道,支持取值: - Waiting_auth:待授权- Customer_auth:客户操作授权- System_mandatory_auth:系统默认授权- Pre_policy_auth:预置策略授权示例值:Customer_auth |
RunAutomationServiceEnabled
描述了 “云自动化助手” 服务相关的信息
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Enabled | Boolean | 否 | 是否开启云自动化助手。取值范围: 默认取值:false。 示例值:true |
RunMonitorServiceEnabled
描述了 “云监控” 服务相关的信息
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Enabled | Boolean | 否 | 是否开启云监控服务。取值范围: 默认取值:true。 示例值:true |
RunSecurityServiceEnabled
描述了 “云安全” 服务相关的信息
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, InquiryPriceResetInstance, InquiryPriceRunInstances, ResetInstance, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Enabled | Boolean | 否 | 是否开启云安全服务。取值范围: 默认取值:true。 示例值:false |
SharePermission
镜像分享信息结构
被如下接口引用:DescribeImageSharePermission。
| 名称 | 类型 | 描述 |
|---|---|---|
| CreatedTime | Timestamp ISO8601 | 镜像分享时间。 按照 ISO8601 标准表示,并且使用 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。 示例值:2023-10-05T14:30:00Z |
| AccountId | String | 镜像分享的账户ID 示例值:2700036 |
Snapshot
描述镜像关联的快照信息
被如下接口引用:DescribeImageFromFamily, DescribeImages。
| 名称 | 类型 | 描述 |
|---|---|---|
| SnapshotId | String | 快照Id。 示例值:snap-2y1v |
| DiskUsage | String | 创建此快照的云硬盘类型。取值范围: SYSTEM_DISK:系统盘 DATA_DISK:数据盘。 示例值:SYSTEM_DISK |
| DiskSize | Integer | 创建此快照的云硬盘大小,单位 GiB。 示例值:50 |
SpotMarketOptions
竞价相关选项
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| MaxPrice | String | 是 | 竞价出价 示例值:0.01 |
| SpotInstanceType | String | 否 | 竞价请求类型,当前仅支持类型:one-time 示例值:one-time |
SpotPaidQuota
竞价实例配额
被如下接口引用:DescribeAccountQuota。
| 名称 | 类型 | 描述 |
|---|---|---|
| UsedQuota | Integer | 已使用配额,单位:vCPU核心数 示例值:10 |
| RemainingQuota | Integer | 剩余配额,单位:vCPU核心数 示例值:90 |
| TotalQuota | Integer | 总配额,单位:vCPU核心数 示例值:100 |
| Zone | String | 可用区 示例值:ap-nanjing-1 |
StorageBlock
HDD的本地存储信息
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstancesActionTimer, DescribeZoneInstanceConfigInfos, ImportInstancesActionTimer, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | HDD本地存储类型,值为:LOCAL_PRO. 示例值:LOCAL_PRO |
| MinSize | Integer | 否 | HDD本地存储的最小容量。单位:GiB。 示例值:100 |
| MaxSize | Integer | 否 | HDD本地存储的最大容量。单位:GiB。 示例值:200 |
SyncImage
同步镜像信息
被如下接口引用:SyncImages。
| 名称 | 类型 | 描述 |
|---|---|---|
| ImageId | String | 镜像ID 示例值:img-xxxxxxxx |
| Region | String | 地域 示例值:ap-guangzhou |
SystemDisk
描述了操作系统所在块设备即系统盘的信息
被如下接口引用:CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceResetInstance, InquiryPriceResizeInstanceDisks, InquiryPriceRunInstances, ModifyInstanceDiskType, ResetInstance, ResizeInstanceDisks, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| DiskType | String | 否 | 系统盘类型。系统盘类型限制详见存储概述。取值范围: 默认取值:当前有库存的硬盘类型。 示例值:CLOUD_HSSD |
| DiskId | String | 否 | 系统盘ID。 该参数目前仅用于 DescribeInstances 等查询类接口的返回参数,不可用于 RunInstances 等写接口的入参。 示例值:disk-xyzw1a3x |
| DiskSize | Integer | 否 | 系统盘大小,单位:GiB。默认值为 50 示例值:50 |
| CdcId | String | 否 | 所属的独享集群ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:cdc-xxxxxx |
| DiskName | String | 否 | 磁盘名称,长度不超过128 个字符。 示例值:name |
Tag
标签键值对,可以通过调用 DescribeTags 返回值中的 Tags 字段来获取。
被如下接口引用:AllocateHosts, CreateDisasterRecoverGroup, CreateHpcCluster, CreateImage, CreateKeyPair, CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeChcHosts, DescribeDisasterRecoverGroups, DescribeHosts, DescribeHpcClusters, DescribeImageFromFamily, DescribeImages, DescribeInstances, DescribeKeyPairs, ImportImage, ImportKeyPair, InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | 标签键 示例值:myKey |
| Value | String | 是 | 标签值 示例值:myValue |
TagSpecification
创建资源实例时同时绑定的标签对说明
被如下接口引用:AllocateHosts, CreateDisasterRecoverGroup, CreateHpcCluster, CreateImage, CreateKeyPair, CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeLaunchTemplateVersions, ImportImage, ImportKeyPair, InquiryPriceRunInstances, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ResourceType | String | 是 | 标签绑定的资源类型,云服务器为“instance”,专用宿主机为“host”,镜像为“image”,密钥为“keypair”,置放群组为“ps”,高性能计算集群为“hpc”。 示例值:instance |
| Tags | Array of Tag | 是 | 标签对列表 |
TargetOS
操作系统转换的目标操作系统信息
被如下接口引用:ConvertOperatingSystems。
| 名称 | 类型 | 描述 |
|---|---|---|
| TargetOSType | String | 目标操作系统类型 示例值:TencentOS |
| TargetOSVersion | String | 目标操作系统版本 示例值:2.4 |
VirtualPrivateCloud
描述了VPC相关信息,包括子网,IP信息等
被如下接口引用:ConfigureChcAssistVpc, ConfigureChcDeployVpc, CreateLaunchTemplate, CreateLaunchTemplateVersion, DescribeChcHosts, DescribeInstances, DescribeLaunchTemplateVersions, InquiryPriceRunInstances, ModifyInstancesVpcAttribute, RunInstances。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | 私有网络ID,形如vpc-xxx。有效的VpcId可通过登录控制台查询;也可以调用接口 DescribeVpcs ,从接口返回中的VpcId字段获取。若在创建子机时VpcId与SubnetId同时传入DEFAULT,则强制使用默认vpc网络。示例值:vpc-2ij |
| SubnetId | String | 是 | 私有网络子网ID,形如subnet-xxx。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 DescribeSubnets ,从接口返回中的SubnetId字段获取。若在创建子机时SubnetId与VpcId同时传入DEFAULT,则强制使用默认vpc网络。示例值:subnet-2ks |
| AsVpcGateway | Boolean | 否 | 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围: 示例值:false |
| PrivateIpAddresses | Array of String | 否 | 私有网络子网 IP 数组,在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。 示例值:["10.0.0.1"] |
| Ipv6AddressCount | Integer | 否 | 为弹性网卡指定随机生成的 IPv6 地址数量。 示例值:1 |
ZoneInfo
可用区信息
被如下接口引用:DescribeZones。
| 名称 | 类型 | 描述 |
|---|---|---|
| Zone | String | 可用区名称,例如,ap-guangzhou-3 全网可用区名称如下: 示例值:ap-guangzhou-3 |
| ZoneName | String | 可用区描述,例如,广州三区 示例值:广州三区 |
| ZoneId | String | 可用区ID 示例值:100003 |
| ZoneState | String | 可用区状态,包含AVAILABLE和UNAVAILABLE。AVAILABLE代表可用,UNAVAILABLE代表不可用。 示例值:AVAILABLE |