tencentcloud-sdk-nodejs
Version:
2,216 lines (2,203 loc) • 165 kB
TypeScript
/**
* RunDockerContainers请求参数结构体
*/
export interface RunDockerContainersRequest {
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 要创建的容器列表。
*/
Containers: Array<DockerContainerConfiguration>;
}
/**
* DescribeDockerContainers请求参数结构体
*/
export interface DescribeDockerContainersRequest {
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 容器ID列表。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。参数不支持同时指定 ContainerIds 和 Filters。
*/
ContainerIds?: Array<string>;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 过滤器列表。
<li>container-id</li>按照【容器ID】进行过滤。
类型:String
必选:否
<li>container-name</li>按照【容器名称】进行过滤。
类型:String
必选:否
每次请求的 Filters 的上限为 10,Filter.Values 的上限为 5。参数不支持同时指定 ContainerIds 和 Filters。
*/
Filters?: Array<Filter>;
}
/**
* AssociateInstancesKeyPairs返回参数结构体
*/
export interface AssociateInstancesKeyPairsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeInstancesTrafficPackages请求参数结构体
*/
export interface DescribeInstancesTrafficPackagesRequest {
/**
* 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceIds?: Array<string>;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
}
/**
* DescribeDisksDeniedActions请求参数结构体
*/
export interface DescribeDisksDeniedActionsRequest {
/**
* 云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。
*/
DiskIds: Array<string>;
}
/**
* Docker容器映射的端口
*/
export interface DockerContainerPublishPort {
/**
* 主机端口
*/
HostPort: number;
/**
* 容器端口
*/
ContainerPort: number;
/**
* 对外绑定IP,默认0.0.0.0
*/
Ip?: string;
/**
* 协议,默认tcp,支持tcp/udp/sctp
*/
Protocol?: string;
}
/**
* InquirePriceCreateBlueprint请求参数结构体
*/
export interface InquirePriceCreateBlueprintRequest {
/**
* 自定义镜像的个数。默认值为1。
*/
BlueprintCount?: number;
}
/**
* DescribeDiskBackups请求参数结构体
*/
export interface DescribeDiskBackupsRequest {
/**
* 查询的云硬盘备份点ID列表。可通过[DescribeDiskBackups](https://cloud.tencent.com/document/product/1207/84379)接口返回值字段DiskBackupSet获取。列表长度最大值为100。参数不支持同时指定 DiskBackupIds 和 Filters。
*/
DiskBackupIds?: Array<string>;
/**
* 过滤器列表。
<li>disk-backup-id</li>按照【云硬盘备份点 ID】进行过滤。
类型:String
必选:否
<li>disk-id</li>按照【云硬盘 ID】进行过滤。
类型:String
必选:否
<li>disk-backup-state</li>按照【云硬盘备份点状态】进行过滤。
类型:String
必选:否
取值:参考数据结构 [DiskBackup](https://cloud.tencent.com/document/product/1207/47576#DiskBackup) 下的DiskBackupState取值。
<li>disk-usage</li>按照【云硬盘类型】进行过滤。
类型:String
必选:否
取值:
- SYSTEM_DISK - 系统盘
- DATA_DISK - 数据盘
每次请求的 Filters 的上限为 10,Filter.Values 的上限为5。参数不支持同时指定DiskBackupIds 和 Filters。
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
*/
Limit?: number;
}
/**
* DescribeInstancesDeniedActions请求参数结构体
*/
export interface DescribeInstancesDeniedActionsRequest {
/**
* 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceIds: Array<string>;
}
/**
* DeleteKeyPairs返回参数结构体
*/
export interface DeleteKeyPairsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirewallTemplateRules请求参数结构体
*/
export interface DescribeFirewallTemplateRulesRequest {
/**
* 防火墙模板ID列表。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。列表长度最大值为100。
*/
TemplateId: string;
/**
* 防火墙模板规则ID列表。可通过[DescribeFirewallTemplateRules](https://cloud.tencent.com/document/product/1207/96875)接口返回值字段TemplateRuleSet获取。列表长度最大值为100。
*/
TemplateRuleIds?: Array<string>;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
}
/**
* AttachCcn请求参数结构体
*/
export interface AttachCcnRequest {
/**
* 云联网实例ID。可通过[DescribeCcns](https://cloud.tencent.com/document/product/215/19199)接口返回值中的CcnId获取。
*/
CcnId: string;
}
/**
* CreateInstances请求参数结构体
*/
export interface CreateInstancesRequest {
/**
* 套餐ID。可以通过调用 [DescribeBundles](https://cloud.tencent.com/document/api/1207/47575) 接口获取。
*/
BundleId: string;
/**
* 镜像ID。可以通过调用 [DescribeBlueprints](https://cloud.tencent.com/document/api/1207/47689) 接口获取。
*/
BlueprintId: string;
/**
* 当前实例仅支持预付费模式,即包年包月相关参数设置,单位(月)。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。
*/
InstanceChargePrepaid: InstanceChargePrepaid;
/**
* 实例显示名称。
*/
InstanceName?: string;
/**
* 购买实例数量。包年包月实例取值范围:[1,30]。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量
*/
InstanceCount?: number;
/**
* 可用区列表。
不填此参数,表示为随机可用区。
可通过 <a href="https://cloud.tencent.com/document/product/1207/57513" target="_blank">DescribeZones</a>接口获取指定地域下的可用区列表信息
*/
Zones?: Array<string>;
/**
* 是否只预检此次请求。
true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数,请求格式,业务限制和库存。
如果检查不通过,则返回对应错误码;
如果检查通过,则返回RequestId.
false(默认):发送正常请求,通过检查后直接创建实例
*/
DryRun?: boolean;
/**
* 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/
ClientToken?: string;
/**
* 实例登录密码信息配置。默认缺失情况下代表用户选择实例创建后设置登录密码。
*/
LoginConfiguration?: LoginConfiguration;
/**
* 要创建的容器配置列表。
*/
Containers?: Array<DockerContainerConfiguration>;
/**
* 是否自动使用代金券。默认不使用。
*/
AutoVoucher?: boolean;
/**
* 防火墙模板ID。若不指定该参数,则使用默认防火墙策略。
*/
FirewallTemplateId?: string;
/**
* 标签键和标签值。
如果指定多个标签,则会为指定资源同时创建并绑定该多个标签。
同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键,则对应的标签值会更新为新值。
如果标签不存在会为您自动创建标签。
数组最多支持10个元素。
*/
Tags?: Array<Tag>;
/**
* 创建实例后自动执行的命令。
*/
InitCommand?: Command;
/**
* 主域名。
注意:域名指定后,仅支持购买一台实例(参数InstanceCount=1)。
*/
DomainName?: string;
/**
* 子域名。
注意:域名指定后,仅支持购买一台实例(参数InstanceCount=1)。
*/
Subdomain?: string;
}
/**
* DescribeZones请求参数结构体
*/
export interface DescribeZonesRequest {
/**
* 可用区列表排序的依据字段。取值范围:
<li>ZONE:依据可用区排序。</li>
<li>INSTANCE_DISPLAY_LABEL:依据可用区展示标签排序,可用区展示标签包括:HIDDEN(隐藏)、NORMAL(普通)、SELECTED(默认选中),默认采用的升序排列为:['HIDDEN', 'NORMAL', 'SELECTED']。
默认按可用区排序。</li>
*/
OrderField?: string;
/**
* 输出可用区列表的排列顺序。取值范围:
<li>ASC:升序排列。 </li>
<li>DESC:降序排列。</li>
默认按升序排列。
*/
Order?: string;
}
/**
* RebootInstances返回参数结构体
*/
export interface RebootInstancesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述地域信息。
*/
export interface RegionInfo {
/**
* 地域名称,例如,ap-guangzhou。
*/
Region?: string;
/**
* 地域描述,例如,华南地区(广州)。
*/
RegionName?: string;
/**
* 地域是否可用状态,取值仅为AVAILABLE(表示可用状态)。
*/
RegionState?: string;
/**
* 是否中国大陆地域
*/
IsChinaMainland?: boolean;
}
/**
* DescribeBlueprintInstances返回参数结构体
*/
export interface DescribeBlueprintInstancesResponse {
/**
* 符合条件的镜像实例数量。
*/
TotalCount?: number;
/**
* 镜像实例列表信息。
*/
BlueprintInstanceSet?: Array<BlueprintInstance>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 实例操作限制列表。
*/
export interface InstanceDeniedActions {
/**
* 实例 ID。
*/
InstanceId?: string;
/**
* 操作限制列表。
*/
DeniedActions?: Array<DeniedAction>;
}
/**
* InquirePriceCreateDisks请求参数结构体
*/
export interface InquirePriceCreateDisksRequest {
/**
* 云硬盘大小, 单位: GB。
*/
DiskSize: number;
/**
* 云硬盘介质类型。取值: "CLOUD_PREMIUM"(高性能云盘), "CLOUD_SSD"(SSD云硬盘)。
*/
DiskType: string;
/**
* 新购云硬盘包年包月相关参数设置。
*/
DiskChargePrepaid: DiskChargePrepaid;
/**
* 云硬盘个数, 默认值: 1。
*/
DiskCount?: number;
/**
* 指定云硬盘备份点配额,不传时默认为不带备份点配额。
取值范围:0 到 500
*/
DiskBackupQuota?: number;
}
/**
* 描述了实例可变更的套餐。
*/
export interface ModifyBundle {
/**
* 更改实例套餐后需要补的差价。
*/
ModifyPrice?: Price;
/**
* 变更套餐状态。取值:
<li>SOLD_OUT:套餐售罄</li>
<li>AVAILABLE:支持套餐变更</li>
<li>UNAVAILABLE:暂不支持套餐变更</li>
*/
ModifyBundleState?: string;
/**
* 套餐信息。
*/
Bundle?: Bundle;
/**
* 不支持套餐变更原因信息。变更套餐状态为"AVAILABLE"时, 该信息为空
*/
NotSupportModifyMessage?: string;
}
/**
* DetachCcn返回参数结构体
*/
export interface DetachCcnResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ShareBlueprintAcrossAccounts请求参数结构体
*/
export interface ShareBlueprintAcrossAccountsRequest {
/**
* 镜像ID, 可以通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回的BlueprintId获取。
*/
BlueprintId: string;
/**
* 接收共享镜像的[账号ID](https://cloud.tencent.com/document/product/213/4944#.E8.8E.B7.E5.8F.96.E4.B8.BB.E8.B4.A6.E5.8F.B7.E7.9A.84.E8.B4.A6.E5.8F.B7-id)列表。账号ID不同于QQ号,查询用户账号ID请查看账号信息中的账号ID栏。账号个数取值最大为10。
*/
AccountIds: Array<string>;
}
/**
* BlueprintPrice 自定义镜像的价格参数。
*/
export interface BlueprintPrice {
/**
* 镜像单价,原价。单位元。
*/
OriginalBlueprintPrice: number;
/**
* 镜像总价,原价。单位元。
*/
OriginalPrice: number;
/**
* 折扣。
*/
Discount: number;
/**
* 镜像折扣后总价。单位元。
*/
DiscountPrice: number;
}
/**
* DescribeScenes返回参数结构体
*/
export interface DescribeScenesResponse {
/**
* 使用场景列表。
*/
SceneSet?: Array<Scene>;
/**
* 使用场景总数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InquirePriceRenewInstances返回参数结构体
*/
export interface InquirePriceRenewInstancesResponse {
/**
* 询价信息。默认为列表中第一个实例的价格信息。
*/
Price?: Price;
/**
* 数据盘价格信息列表。
*/
DataDiskPriceSet?: Array<DataDiskPrice>;
/**
* 待续费实例价格列表。
*/
InstancePriceDetailSet?: Array<InstancePriceDetail>;
/**
* 总计价格。
*/
TotalPrice?: TotalPrice;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteFirewallRules返回参数结构体
*/
export interface DeleteFirewallRulesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstancesAttribute请求参数结构体
*/
export interface ModifyInstancesAttributeRequest {
/**
* 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceIds: Array<string>;
/**
* 实例名称。可任意命名,但不得超过 60 个字符。
*/
InstanceName?: string;
}
/**
* DescribeDockerContainerDetail请求参数结构体
*/
export interface DescribeDockerContainerDetailRequest {
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 容器ID。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。
*/
ContainerId: string;
}
/**
* DescribeGeneralResourceQuotas请求参数结构体
*/
export interface DescribeGeneralResourceQuotasRequest {
/**
* 资源名列表,可取值:
- GENERAL_BUNDLE_INSTANCE 通用型套餐实例
- STORAGE_BUNDLE_INSTANCE 存储型套餐实例
- ENTERPRISE_BUNDLE_INSTANCE 企业型套餐实例
- EXCLUSIVE_BUNDLE_INSTANCE 专属型套餐实例
- BEFAST_BUNDLE_INSTANCE 蜂驰型套餐实例
- STARTER_BUNDLE_INSTANCE 入门型套餐实例
- HK_EXCLUSIVE_BUNDLE_INSTANCE 中国香港专属型套餐实例
- CAREFREE_BUNDLE_INSTANCE 无忧型套餐实例
- USER_KEY_PAIR 密钥对
- SNAPSHOT 快照
- BLUEPRINT 自定义镜像
- FREE_BLUEPRINT 免费自定义镜像
- DATA_DISK 数据盘
*/
ResourceNames: Array<string>;
}
/**
* RestartDockerContainers请求参数结构体
*/
export interface RestartDockerContainersRequest {
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 容器ID列表。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。
*/
ContainerIds: Array<string>;
}
/**
* DeleteKeyPairs请求参数结构体
*/
export interface DeleteKeyPairsRequest {
/**
* 密钥对 ID 列表,每次请求批量密钥对的上限为 10。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。
*/
KeyIds: Array<string>;
}
/**
* RerunDockerContainer返回参数结构体
*/
export interface RerunDockerContainerResponse {
/**
* Docker活动ID。
*/
DockerActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述了镜像重置信息
*/
export interface ResetInstanceBlueprint {
/**
* 镜像详细信息
*/
BlueprintInfo?: Blueprint;
/**
* 实例镜像是否可重置为目标镜像。
取值:
true(允许)
false(不允许)
*/
IsResettable?: boolean;
/**
* 不可重置信息.当镜像可重置时为""
*/
NonResettableMessage?: string;
}
/**
* DescribeBundles返回参数结构体
*/
export interface DescribeBundlesResponse {
/**
* 套餐详细信息列表。
*/
BundleSet?: Array<Bundle>;
/**
* 符合要求的套餐总数,用于分页展示。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteFirewallTemplateRules返回参数结构体
*/
export interface DeleteFirewallTemplateRulesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirewallTemplates请求参数结构体
*/
export interface DescribeFirewallTemplatesRequest {
/**
* 防火墙模板ID列表。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。列表长度最大值为100。
*/
TemplateIds?: Array<string>;
/**
* 过滤器列表。
<li>template-id</li>按照【防火墙模板所属的ID】进行过滤。
类型:String
必选:否
<li>template-name</li>按照【防火墙模板所属的名称】进行过滤。
类型:String
必选:否
<li>template-type</li>按照【防火墙模板的类型】进行过滤。
类型:String
必选:否
每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 TemplateIds 和 Filters。
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
}
/**
* ModifyInstancesBundle请求参数结构体
*/
export interface ModifyInstancesBundleRequest {
/**
* 实例ID列表。一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。每次请求批量实例的上限为15。
*/
InstanceIds: Array<string>;
/**
* 待变更的套餐Id。注意不可和当前要升配的实例套餐ID相同。可通过[DescribeBundles](https://cloud.tencent.com/document/api/1207/47575)接口返回值中的BundleId获取。
*/
BundleId: string;
/**
* 是否自动抵扣代金券。取值范围:
true:表示自动抵扣代金券
false:表示不自动抵扣代金券
默认取值:false。
*/
AutoVoucher?: boolean;
}
/**
* DeleteDiskBackups请求参数结构体
*/
export interface DeleteDiskBackupsRequest {
/**
* 云硬盘备份点ID列表,可通过 [DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379)接口查询。列表长度最大值为100。
*/
DiskBackupIds: Array<string>;
}
/**
* InquirePriceRenewInstances请求参数结构体
*/
export interface InquirePriceRenewInstancesRequest {
/**
* 待续费的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573 )接口返回值中的InstanceId获取。每次请求批量实例的上限为50。
*/
InstanceIds: Array<string>;
/**
* 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。
*/
InstanceChargePrepaid: InstanceChargePrepaid;
/**
* 是否续费数据盘。默认值: false, 即不续费。
*/
RenewDataDisk?: boolean;
/**
* 数据盘是否对齐实例到期时间。默认值: false, 即不对齐。
*/
AlignInstanceExpiredTime?: boolean;
}
/**
* 套餐折扣详情(仅用于控制台调用询价相关接口返回)。
*/
export interface DiscountDetail {
/**
* 计费时长。
*/
TimeSpan?: number;
/**
* 时间单位。
取值为:
- m - 月
- d - 日
*/
TimeUnit?: string;
/**
* 总价。
*/
TotalCost?: number;
/**
* 折后总价。
*/
RealTotalCost?: number;
/**
* 折扣。
*/
Discount?: number;
/**
* 具体折扣详情。
*/
PolicyDetail?: PolicyDetail;
}
/**
* DescribeDiskConfigs请求参数结构体
*/
export interface DescribeDiskConfigsRequest {
/**
* 过滤器列表。
<li>zone</li>按照【可用区】进行过滤。
类型:String
必选:否
*/
Filters?: Array<Filter>;
}
/**
* DescribeFirewallTemplateQuota返回参数结构体
*/
export interface DescribeFirewallTemplateQuotaResponse {
/**
* 当前可用配额。
*/
Available?: number;
/**
* 总配额。
*/
Total?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRegions返回参数结构体
*/
export interface DescribeRegionsResponse {
/**
* 地域数量。
*/
TotalCount?: number;
/**
* 地域信息列表。
*/
RegionSet?: Array<RegionInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeFirewallTemplateApplyRecords请求参数结构体
*/
export interface DescribeFirewallTemplateApplyRecordsRequest {
/**
* 防火墙模板ID。可通过[DescribeFirewallTemplates](https://cloud.tencent.com/document/product/1207/96874)接口返回值字段TemplateSet获取。
*/
TemplateId: string;
/**
* 应用防火墙模板任务ID列表。可通过[ApplyFirewallTemplate](https://cloud.tencent.com/document/product/1207/96883)接口返回值TaskId字段获取。
*/
TaskIds?: Array<string>;
}
/**
* DescribeDiskBackups返回参数结构体
*/
export interface DescribeDiskBackupsResponse {
/**
* 云硬盘备份点的数量。
*/
TotalCount?: number;
/**
* 云硬盘备份点信息列表。
*/
DiskBackupSet?: Array<DiskBackup>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AttachDisks请求参数结构体
*/
export interface AttachDisksRequest {
/**
* 云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。
*/
DiskIds: Array<string>;
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 自动续费标识。取值范围:
NOTIFY_AND_AUTO_RENEW:通知过期且自动续费。 NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费,用户需要手动续费。 DISABLE_NOTIFY_AND_MANUAL_RENEW:不自动续费,且不通知。
默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,云盘到期后将按月自动续费。
*/
RenewFlag?: string;
}
/**
* ModifyDiskBackupsAttribute请求参数结构体
*/
export interface ModifyDiskBackupsAttributeRequest {
/**
* 云硬盘备份点ID,可通过 [DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379) 接口返回值中的 DiskBackupId 获取。列表长度最大值为100。
*/
DiskBackupIds: Array<string>;
/**
* 云硬盘备份点名称,最大长度 90 。
*/
DiskBackupName?: string;
}
/**
* AttachCcn返回参数结构体
*/
export interface AttachCcnResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RebootInstances请求参数结构体
*/
export interface RebootInstancesRequest {
/**
* 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceIds: Array<string>;
}
/**
* ResetAttachCcn请求参数结构体
*/
export interface ResetAttachCcnRequest {
/**
* 云联网实例ID。可通过[DescribeCcns](https://cloud.tencent.com/document/product/215/19199)接口返回值中的CcnId获取。
*/
CcnId: string;
}
/**
* CreateDisks请求参数结构体
*/
export interface CreateDisksRequest {
/**
* 可用区。可通过[DescribeZones](https://cloud.tencent.com/document/product/1207/57513)返回值中的Zone获取。
*/
Zone: string;
/**
* 云硬盘大小, 单位: GB。
*/
DiskSize: number;
/**
* 云硬盘介质类型。取值: "CLOUD_PREMIUM"(高性能云盘), "CLOUD_SSD"(SSD云硬盘)。
*/
DiskType: string;
/**
* 云硬盘包年包月相关参数设置。
*/
DiskChargePrepaid: DiskChargePrepaid;
/**
* 云硬盘名称。最大长度60。
*/
DiskName?: string;
/**
* 云硬盘个数。取值范围: [1, 30]。默认值: 1。
*/
DiskCount?: number;
/**
* 指定云硬盘备份点配额,取值范围: [0, 500]。不传时默认为不带备份点配额。
*/
DiskBackupQuota?: number;
/**
* 是否自动使用代金券。默认不使用。
*/
AutoVoucher?: boolean;
/**
* 自动挂载并初始化数据盘。
*/
AutoMountConfiguration?: AutoMountConfiguration;
}
/**
* AssociateInstancesKeyPairs请求参数结构体
*/
export interface AssociateInstancesKeyPairsRequest {
/**
* 密钥对 ID 列表,每次请求批量密钥对的上限为 100。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。
*/
KeyIds: Array<string>;
/**
* 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceIds: Array<string>;
}
/**
* Docker容器信息
*/
export interface DockerContainer {
/**
* 容器ID
*/
ContainerId?: string;
/**
* 容器名称
*/
ContainerName?: string;
/**
* 容器镜像地址
*/
ContainerImage?: string;
/**
* 容器Command
*/
Command?: string;
/**
* 容器状态描述
*/
Status?: string;
/**
* 容器状态,和docker的容器状态保持一致,当前取值有:created(已创建)、restarting(重启中)、running(运行中)、removing(迁移中)、paused(暂停)、exited(停止)和dead(死亡)
*/
State?: string;
/**
* 容器端口主机端口映射列表
*/
PublishPortSet?: Array<DockerContainerPublishPort>;
/**
* 容器挂载本地卷列表
*/
VolumeSet?: Array<DockerContainerVolume>;
/**
* 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。
*/
CreatedTime?: string;
}
/**
* CancelShareBlueprintAcrossAccounts返回参数结构体
*/
export interface CancelShareBlueprintAcrossAccountsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSnapshots请求参数结构体
*/
export interface DescribeSnapshotsRequest {
/**
* 要查询快照的 ID 列表。每次请求批量快照的上限为 100。
可通过 [DescribeSnapshots](https://cloud.tencent.com/document/product/1207/54388) 接口返回值中的 SnapshotId 获取。
参数不支持同时指定 SnapshotIds 和 Filters。
*/
SnapshotIds?: Array<string>;
/**
* 过滤器列表。
<li>snapshot-id</li>按照【快照 ID】进行过滤。
类型:String
必选:否
可通过 <a href="https://cloud.tencent.com/document/product/1207/54388">DescribeSnapshots</a> 接口返回值中的 SnapshotId 获取。
<li>disk-id</li>按照【磁盘 ID】进行过滤。
类型:String
必选:否
可通过 <a href="https://cloud.tencent.com/document/product/1207/66093">DescribeDisks</a> 接口返回值中的 DiskId 获取。
<li>snapshot-name</li>按照【快照名称】进行过滤。
类型:String
必选:否
可通过 <a href="https://cloud.tencent.com/document/product/1207/54388">DescribeSnapshots</a> 接口返回值中的 SnapshotName 获取。
<li>instance-id</li>按照【实例 ID 】进行过滤。
类型:String
必选:否
可通过 <a href="https://cloud.tencent.com/document/product/1207/47573">DescribeInstances</a> 接口返回值中的 InstanceId 获取。
每次请求的 Filters 的上限为 10,Filter.Values 的上限为 5。参数不支持同时指定 SnapshotIds 和 Filters。
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
}
/**
* TerminateDisks返回参数结构体
*/
export interface TerminateDisksResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述了云硬盘备份点相关信息。
*/
export interface DiskBackup {
/**
* 云硬盘备份点ID。
*/
DiskBackupId?: string;
/**
* 创建此云硬盘备份点的云硬盘类型。取值:<li>DATA_DISK:数据盘</li>
*/
DiskUsage?: string;
/**
* 创建此云硬盘备份点的云硬盘 ID。
*/
DiskId?: string;
/**
* 创建此云硬盘备份点的云硬盘大小,单位 GB。
*/
DiskSize?: number;
/**
* 云硬盘备份点名称,用户自定义的云硬盘备份点别名。
*/
DiskBackupName?: string;
/**
* 云硬盘备份点的状态。取值范围:
<li>NORMAL:正常。 </li>
<li>CREATING:创建中。</li>
<li>ROLLBACKING:回滚中。</li>
<li>DELETING:删除中。</li>
*/
DiskBackupState?: string;
/**
* 创建或回滚云硬盘备份点进度百分比,成功后此字段取值为 100。
*/
Percent?: number;
/**
* 上一次操作
*/
LatestOperation?: string;
/**
* 上一次操作状态
*/
LatestOperationState?: string;
/**
* 上一次请求ID
*/
LatestOperationRequestId?: string;
/**
* 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。
格式为: YYYY-MM-DDThh:mm:ssZ。
*/
CreatedTime?: string;
}
/**
* DescribeInstancesTrafficPackages返回参数结构体
*/
export interface DescribeInstancesTrafficPackagesResponse {
/**
* 符合条件的实例流量包详情数量。
*/
TotalCount?: number;
/**
* 实例流量包详情列表。
*/
InstanceTrafficPackageSet?: Array<InstanceTrafficPackage>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDiskBackupsDeniedActions请求参数结构体
*/
export interface DescribeDiskBackupsDeniedActionsRequest {
/**
* 云硬盘备份点 ID 列表, 可通过<a href="https://cloud.tencent.com/document/product/1207/84379" target="_blank">DescribeDiskBackups</a>接口查询。列表长度最大值为100。
*/
DiskBackupIds: Array<string>;
}
/**
* 描述密钥对信息。
*/
export interface KeyPair {
/**
* 密钥对 ID ,是密钥对的唯一标识。
*/
KeyId?: string;
/**
* 密钥对名称。
*/
KeyName?: string;
/**
* 密钥对的纯文本公钥。
*/
PublicKey?: string;
/**
* 密钥对关联的实例 ID 列表。
*/
AssociatedInstanceIds?: Array<string>;
/**
* 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedTime?: string;
/**
* 密钥对私钥。
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivateKey?: string;
}
/**
* DescribeFirewallRulesTemplate请求参数结构体
*/
export declare type DescribeFirewallRulesTemplateRequest = null;
/**
* DescribeDockerContainerConfiguration请求参数结构体
*/
export interface DescribeDockerContainerConfigurationRequest {
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 容器ID。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。
*/
ContainerId: string;
}
/**
* ModifyBlueprintAttribute请求参数结构体
*/
export interface ModifyBlueprintAttributeRequest {
/**
* 镜像 ID。可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值中的BlueprintId获取。
*/
BlueprintId: string;
/**
* 设置新的镜像名称。最大长度60。
*/
BlueprintName?: string;
/**
* 设置新的镜像描述。最大长度60。
*/
Description?: string;
}
/**
* InquirePriceRenewDisks请求参数结构体
*/
export interface InquirePriceRenewDisksRequest {
/**
* 云硬盘ID列表。每次批量请求云硬盘的上限为 1。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。
*/
DiskIds: Array<string>;
/**
* 续费云硬盘包年包月相关参数设置。
*/
RenewDiskChargePrepaid: RenewDiskChargePrepaid;
}
/**
* ShareBlueprintAcrossAccounts返回参数结构体
*/
export interface ShareBlueprintAcrossAccountsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 防火墙模板规则信息
*/
export interface FirewallTemplateRuleInfo {
/**
* 防火墙模板规则ID。
*/
TemplateRuleId?: string;
/**
* 防火墙规则信息。
*/
FirewallRuleInfo?: FirewallRuleInfo;
}
/**
* 磁盘信息
*/
export interface Disk {
/**
* 磁盘ID
*/
DiskId?: string;
/**
* 实例ID
*/
InstanceId?: string;
/**
* 可用区
*/
Zone?: string;
/**
* 磁盘名称
*/
DiskName?: string;
/**
* 磁盘类型
枚举值:
<li> SYSTEM_DISK: 系统盘 </li>
<li> DATA_DISK: 数据盘 </li>
*/
DiskUsage?: string;
/**
* 磁盘介质类型
枚举值:
<li> CLOUD_BASIC: 普通云硬盘 </li>
<li> CLOUD_PREMIUM: 高性能云硬盘 </li>
<li> CLOUD_SSD: SSD云硬盘 </li>
*/
DiskType?: string;
/**
* 磁盘付费类型
<li> PREPAID: 预付费 </li>
<li> POSTPAID_BY_HOUR: 按小时后付费 </li>
*/
DiskChargeType?: string;
/**
* 磁盘大小, 单位GB
*/
DiskSize?: number;
/**
* 续费标识
*/
RenewFlag?: string;
/**
* 磁盘状态,取值范围:
<li>PENDING:创建中。 </li>
<li>UNATTACHED:待挂载。</li>
<li>ATTACHING:挂载中。</li>
<li>ATTACHED:已挂载。</li>
<li>DETACHING:卸载中。 </li>
<li> SHUTDOWN:已隔离。</li>
<li> CREATED_FAILED:创建失败。</li>
<li>TERMINATING:销毁中。</li>
<li> DELETING:删除中。</li>
<li> FREEZING:冻结中。</li>
*/
DiskState?: string;
/**
* 磁盘挂载状态
*/
Attached?: boolean;
/**
* 是否随实例释放
*/
DeleteWithInstance?: boolean;
/**
* 上一次操作
*/
LatestOperation?: string;
/**
* 上一次操作状态
*/
LatestOperationState?: string;
/**
* 上一次请求ID
*/
LatestOperationRequestId?: string;
/**
* 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。
格式为: YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedTime?: string;
/**
* 到期时间。按照 ISO8601 标准表示,并且使用 UTC 时间。
格式为: YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpiredTime?: string;
/**
* 隔离时间。按照 ISO8601 标准表示,并且使用 UTC 时间。
格式为: YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
*/
IsolatedTime?: string;
/**
* 云硬盘的已有备份点数量。
*/
DiskBackupCount?: number;
/**
* 云硬盘的备份点配额数量。
*/
DiskBackupQuota?: number;
}
/**
* ModifyFirewallRules返回参数结构体
*/
export interface ModifyFirewallRulesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 可用区详细信息
*/
export interface ZoneInfo {
/**
* 可用区
*/
Zone: string;
/**
* 可用区中文名称
*/
ZoneName: string;
/**
* 实例购买页可用区展示标签
*/
InstanceDisplayLabel: string;
}
/**
* DescribeBlueprintInstances请求参数结构体
*/
export interface DescribeBlueprintInstancesRequest {
/**
* 实例 ID 列表。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。 当前最多支持1个。
*/
InstanceIds: Array<string>;
}
/**
* ApplyInstanceSnapshot返回参数结构体
*/
export interface ApplyInstanceSnapshotResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DetachDisks请求参数结构体
*/
export interface DetachDisksRequest {
/**
* 云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。
*/
DiskIds: Array<string>;
}
/**
* ModifyFirewallRules请求参数结构体
*/
export interface ModifyFirewallRulesRequest {
/**
* 实例 ID。实例的ID可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 防火墙规则列表。列表长度最大值是100。
*/
FirewallRules: Array<FirewallRule>;
/**
* 防火墙当前版本。用户每次更新防火墙规则时版本会自动加1,防止规则已过期,不填不考虑冲突。
*/
FirewallVersion?: number;
}
/**
* CreateBlueprint请求参数结构体
*/
export interface CreateBlueprintRequest {
/**
* 镜像名称。最大长度60。
*/
BlueprintName: string;
/**
* 镜像描述。最大长度60。
*/
Description?: string;
/**
* 需要制作镜像的实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/1207/47573) 接口返回值中的 InstanceId 获取。
*/
InstanceId?: string;
/**
* 是否执行强制关机以制作镜像。
取值范围:
True:表示关机之后制作镜像
False:表示开机状态制作镜像
默认取值:True
开机状态制作镜像,可能导致部分数据未备份,影响数据安全。
*/
ForcePowerOff?: boolean;
}
/**
* DeleteFirewallRules请求参数结构体
*/
export interface DeleteFirewallRulesRequest {
/**
* 实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/1207/47573) 接口返回值中的 InstanceId 获取。
*/
InstanceId: string;
/**
* 防火墙规则列表。
*/
FirewallRules: Array<FirewallRule>;
/**
* 防火墙当前版本。用户每次更新防火墙规则时版本会自动加1,防止规则已过期,不填不考虑冲突。
*/
FirewallVersion?: number;
}
/**
* RerunDockerContainer请求参数结构体
*/
export interface RerunDockerContainerRequest {
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 重新创建的容器配置。
*/
ContainerConfiguration: DockerContainerConfiguration;
/**
* 容器ID。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。
*/
ContainerId: string;
}
/**
* DescribeInstanceVncUrl请求参数结构体
*/
export interface DescribeInstanceVncUrlRequest {
/**
* 实例 ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
}
/**
* ModifyFirewallRuleDescription请求参数结构体
*/
export interface ModifyFirewallRuleDescriptionRequest {
/**
* 实例ID。可通过 [DescribeInstances](https://cloud.tencent.com/document/api/1207/47573) 接口返回值中的 InstanceId 获取。
*/
InstanceId: string;
/**
* 防火墙规则。
*/
FirewallRule: FirewallRule;
/**
* 防火墙当前版本。用户每次更新防火墙规则时版本会自动加1,防止规则已过期,不填不考虑冲突。
*/
FirewallVersion?: number;
}
/**
* 实例流量包详情
*/
export interface InstanceTrafficPackage {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 流量包详情列表。
*/
TrafficPackageSet?: Array<TrafficPackage>;
}
/**
* 快照操作限制列表。
*/
export interface SnapshotDeniedActions {
/**
* 快照 ID。
*/
SnapshotId?: string;
/**
* 操作限制列表。
*/
DeniedActions?: Array<DeniedAction>;
}
/**
* TerminateInstances返回参数结构体
*/
export interface TerminateInstancesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 防火墙模板应用记录详情。
*/
export interface FirewallTemplateApplyRecordDetail {
/**
* 实例标识信息。
*/
Instance?: InstanceIdentifier;
/**
* 防火墙模板应用状态。
- SUCCESS:成功
- FAILED:失败
*/
ApplyState?: string;
/**
* 防火墙模板应用错误信息。
*/
ErrorMessage?: string;
}
/**
* DescribeInstancesDiskNum请求参数结构体
*/
export interface DescribeInstancesDiskNumRequest {
/**
* 实例ID列表。每次请求批量实例的上限为 100。
可通过 <a href="https://cloud.tencent.com/document/product/1207/47573">DescribeInstances</a> 接口返回值中的 InstanceId 获取。
*/
InstanceIds: Array<string>;
}
/**
* 计费项目明细。
*/
export interface DetailPrice {
/**
* 描述计费项目名称,目前取值
<li>"DiskSpace"代表云硬盘空间收费项。</li>
<li>"DiskBackupQuota"代表云硬盘备份点配额收费项。</li>
*/
PriceName: string;
/**
* 云硬盘计费项维度单价。
*/
OriginUnitPrice: number;
/**
* 云硬盘计费项维度总价。
*/
OriginalPrice: number;
/**
* 云硬盘在计费项维度折扣。
*/
Discount: number;
/**
* 云硬盘在计费项维度折后总价。
*/
DiscountPrice: number;
}
/**
* StopDockerContainers返回参数结构体
*/
export interface StopDockerContainersResponse {
/**
* Docker活动ID。
*/
DockerActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ApplyDiskBackup返回参数结构体
*/
export interface ApplyDiskBackupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBlueprints请求参数结构体
*/
export interface DescribeBlueprintsRequest {
/**
* 镜像 ID 列表。可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值字段BlueprintSet获取。列表长度最大值为100。
*/
BlueprintIds?: Array<string>;
/**
* 偏移量,默认为 0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/product/1207/47578)中的相关小节。
*/
Limit?: number;
/**
* 过滤器列表。
<li>blueprint-id</li>按照【镜像 ID】进行过滤。
类型:String
必选:否
镜像 ID ,可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值字段BlueprintSet获取。
<li>blueprint-type</li>按照【镜像类型】进行过滤。
取值:APP_OS(应用镜像 );PURE_OS(系统镜像);DOCKER(Docker容器镜像);PRIVATE(自定义镜像);SHARED(共享镜像)。
类型:String
必选:否
<li>platform-type</li>按照【镜像平台类型】进行过滤。
取值: LINUX_UNIX(Linux/Unix系统);WINDOWS(Windows 系统)。
类型:String
必选:否
<li>blueprint-name</li>按照【镜像名称】进行过滤。
类型:String
必选:否
<li>blueprint-state</li>按照【镜像状态】进行过滤。
类型:String
必选:否
<li>scene-id</li>按照【使用场景Id】进行过滤。
类型:String
必选:否
场景Id,可通过[查看使用场景列表](https://cloud.tencent.com/document/product/1207/83512)接口获取。
每次请求的 Filters 的上限为 10,Filter.Values 的上限为 100。参数不支持同时指定 BlueprintIds (可通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回值字段BlueprintSet获取BlueprintId)和 Filters 。
*/
Filters?: Array<Filter>;
}
/**
* 实例可退还信息。
*/
export interface InstanceReturnable {
/**
* 实例 ID。
*/
InstanceId?: string;
/**
* 实例是否可退还。
*/
IsReturnable?: boolean;
/**
* 实例退还失败错误码。取值:
0: 可以退还
1: 资源已退货。如为退货后续费资源,请于购买6小时后操作
2: 资源已到期
3: 资源购买超过5天不支持退款
4: 非预付费资源不支持退款
8: 退货数量超出限额
9: 涉及活动订单不支持退款
10: 资源不支持自助退,请走工单退款
11: 涉及推广奖励渠道订单,请提工单咨询
12: 根据业务侧产品规定,该资源不允许退款
*/
ReturnFailCode?: number;
/**
* 实例退还失败错误信息。
*/
ReturnFailMessage?: string;
}
/**
* DescribeInstancesDeniedActions返回参数结构体
*/
export interface DescribeInstancesDeniedActionsResponse {
/**
* 实例操作限制列表详细信息。
*/
InstanceDeniedActionSet?: Array<InstanceDeniedActions>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestartDockerContainers返回参数结构体
*/
export interface RestartDockerContainersResponse {
/**
* Docker活动ID。
*/
DockerActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateFirewallTemplate请求参数结构体
*/
export interface CreateFirewallTemplateRequest {
/**
* 模板名称。
*/
TemplateName: string;
/**
* 防火墙规则列表。
*/
TemplateRules?: Array<FirewallRule>;
}
/**
* RemoveDockerContainers请求参数结构体
*/
export interface RemoveDockerContainersRequest {
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* 容器ID列表。可通过[DescribeDockerContainers](https://cloud.tencent.com/document/product/1207/95473)接口返回值中的ContainerId获取。
*/
ContainerIds: Array<string>;
}
/**
* RenewDisks请求参数结构体
*/
export interface RenewDisksRequest {
/**
* 云硬盘ID列表。一个或多个待操作的云硬盘ID。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。每次请求续费数据盘数量总计上限为50。
*/
DiskIds: Array<string>;
/**
* 续费云硬盘包年包月相关参数设置。
*/
RenewDiskChargePrepaid: RenewDiskChargePrepaid;
/**
* 是否自动使用代金券。默认不使用。
*/
AutoVoucher?: boolean;
}
/**
* ModifyDisksAttribute请求参数结构体
*/
export interface ModifyDisksAttributeRequest {
/**
* 云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。
*/
DiskIds: Array<string>;
/**
* 云硬盘名称。
*/
DiskName: string;
}
/**
* ModifyDisksBackupQuota请求参数结构体
*/
export interface ModifyDisksBackupQuotaRequest {
/**
* 云硬盘ID列表,可通过[DescribeDisks](https://cloud.tencent.com/document/api/1207/66093)接口查询。列表最大长度为15。
*/
DiskIds: Array<string>;
/**
* 云硬盘备份点配额。取值范围: [0, 500]。调整后的配额必须不小于已存在的备份点数量。
*/
DiskBackupQuota: number;
}
/**
* DescribeKeyPairs返回参数结构体
*/
export interface DescribeKeyPairsResponse {
/**
* 符合条件的密钥对数量。
*/
TotalCount?: number;
/**
* 密钥对详细信息列表。
*/
KeyPairSet?: Array<KeyPair>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 防火墙模板信息。
*/
export interface FirewallTemplate {
/**
* 模板Id。
*/
TemplateId?: string;
/**
* 模板名称。
*/
TemplateName?: string;
/**
* 模板类型。
*/
TemplateType?: string;
/**
* 模板状态。
*/
TemplateState?: string;
/**
* 模板创建时间。
*/
CreatedTime?: string;
}
/**
* DescribeSnapshotsDeniedActions返回参数结构体
*/
export interface DescribeSnapshotsDeniedActionsResponse {
/**
* 快照操作限制列表详细信息。
*/
SnapshotDeniedActionSet?: Array<SnapshotDeniedActions>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeScenes请求参数结构体
*/
export interface DescribeScenesRequest {
/**
* 使用场景ID列表。可通过[DescribeScenes](https://cloud.tencent.com/document/product/1207/83512)接口返回值中的SceneId获取。
*/
SceneIds?: Array<string>;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
}
/**
* 描述镜像软件详细信息。
*/
export interface SoftwareDetail {
/**
* 软件的属性标识
*/
Key?: string;
/**
* 软件的属性标识描述
*/
Title?: string;
/**
* 软件的属性值
*/
Value?: string;
}
/**
* DeleteDiskBackups返回参数结构体
*/
export interface DeleteDiskBackupsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSnapshots请求参数结构体
*/
export interface DeleteSnapshotsRequest {
/**
* 要删除的快照 ID 列表,每次请求批量快照的上限为10个,可通过 <a href="https://cloud.tencent.com/document/product/1207/54388" target="_blank">DescribeSnapshots</a>查询。
*/
SnapshotIds: Array<string>;
}
/**
* ModifyDisksRenewFlag返回参数结构体
*/
export interface ModifyDisksRenewFlagResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySnapshotAttribute请求参数结构体
*/
export interface ModifySnapshotAttributeRequest {
/**
* 快照 ID, 可通过 <a href="https://cloud.tencent.com/document/product/1207/54388">DescribeSnapshots</a> 查询。
*/
SnapshotId: string;
/**
* 新的快照名称,最长为 60 个字符。
*/
SnapshotName?: string;
}
/**
* DeleteSnapshots返回参数结构体
*/
export interface DeleteSnapshotsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReplaceFirewallTemplateRule返回参数结构体
*/
export interface ReplaceFirewallTemplateRuleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDisks返回参数结构体
*/
export interface DescribeDisksResponse {
/**
* 云硬盘信息列表。
*/
DiskSet?: Array<Disk>;
/**
* 符合条件的云硬盘信息数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StartInstances请求参数结构体
*/
export interface StartInstancesRequest {
/**
* 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceIds: Array<string>;
}
/**
* DescribeBundleDiscount返回参数结构体
*/
export interface DescribeBundleDiscountResponse {
/**
* 币种:CNY人民币,USD 美元。
*/
Currency?: string;
/**
* 折扣梯度详情,每个梯度包含的信息有:时长,折扣数,总价,折扣价,折扣详情(用户折扣、官网折扣、最终折扣)。
*/
DiscountDetail?: Array<DiscountDetail>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAllScenes请求参数结构体
*/
export interface DescribeAllScenesRequest {
/**
* 使用场景ID列表。可通过[DescribeAllScenes](https://cloud.tencent.com/document/product/1207/83513)接口返回值中的SceneId获取。
*/
SceneIds?: Array<string>;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
}
/**
* ModifyDisksRenewFlag请求参数结构体
*/
export interface ModifyDisksRenewFlagRequest {
/**
* 云硬盘ID列表。每次批量请求云硬盘的上限为 100。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值中的DiskId获取。
*/
DiskIds: Array<string>;
/**
* 自动续费标识。取值范围:
- NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
- NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
- DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费
若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
*/
RenewFlag: string;
}
/**
* StartDockerContainers返回参数结构体
*/
export interface StartDockerContainersResponse {
/**
* Docker活动ID。
*/
DockerActivityId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisassociateInstancesKeyPairs请求参数结构体
*/
export interface DisassociateInstancesKeyPairsRequest {
/**
* 密钥对 ID 列表,每次请求批量密钥对的上限为 100。可通过[DescribeKeyPairs](https://cloud.tencent.com/document/api/1207/55540)接口返回值中的KeyId获取。
*/
KeyIds: Array<string>;
/**
* 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceIds: Array<string>;
}
/**
* DescribeFirewallTemplateQuota请求参数结构体
*/
export declare type DescribeFirewallTemplateQuotaRequest = null;
/**
* 数据盘价格
*/
export interface DataDiskPrice {
/**
* 云硬盘ID。
*/
DiskId?: string;
/**
* 云硬盘单价。
*/
OriginalDiskPrice?: number;
/**
* 云硬盘总价。
*/
OriginalPrice?: number;
/**
* 折扣。
*/
Discount?: number;
/**
* 折后总价。
*/
DiscountPrice?: number;
/**
* 数据盘挂载的实例ID。
*/
InstanceId?: string;
}
/**
* 用户执行TAT命令的数据结构。
*/
export interface Command {
/**
* Base64编码后的命令内容,长度不可超过64KB。
*/
Content: string;
/**
* 命令超时时间,默认60秒。取值范围[1, 86400]。
*/
Timeout?: number;
/**
* 命令执行路径,对于 SHELL 命令默认为 /root,对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
*/
WorkingDirectory?: string;
/**
* 在 Lighthouse 实例中执行命令的用户名称。
默认情况下,在 Linux 实例中以 root 用户执行命令;在Windows 实例中以 System 用户执行命令。
*/
Username?: string;
}
/**
* 使用场景详细信息
*/
export interface SceneInfo {
/**
* 使用场景Id。
*/
SceneId?: string;
/**
* 使用场景展示名称。
*/
DisplayName?: string;
/**
* 使用场景描述信息。
*/
Description?: string;
}
/**
* ImportKeyPair请求参数结构体
*/
export interface ImportKeyPairRequest {
/**
* 密钥对名称,可由数字,字母和下划线组成,长度不超过 25 个字符。
*/
KeyName: string;
/**
* 密钥对的公钥内容, OpenSSH RSA 格式。
*/
PublicKey: string;
}
/**
* DescribeDockerActivities请求参数结构体
*/
export interface DescribeDockerActivitiesRequest {
/**
* 实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/1207/47573)接口返回值中的InstanceId获取。
*/
InstanceId: string;
/**
* Docker活动ID列表。可通过[DescribeDockerActivities](https://cloud.tencent.com/document/product/1207/95476)接口返回值中的ActivityId获取。
*/
ActivityIds?: Array<string>;
/**
* 偏移量,默认为 0。
*/
Offset?: number;
/**
* 返回数量,默认为 20,最大值为 100。
*/
Limit?: number;
/**
* 活动创建时间的起始值,时间戳秒数。
*/
CreatedTimeBegin?: number;
/**
* 活动创建时间的结束值,时间戳秒数。
*/
CreatedTimeEnd?: number;
}
/**
* ImportKeyPair返回参数结构体
*/
export interface ImportKeyPairResponse {
/**
* 密钥对 ID。
*/
KeyId: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteBlueprints返回参数结构体
*/
export interface DeleteBlueprintsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyInstancesLoginKeyPairAttribute请求参数结构体
*/
export interface ModifyInstancesLoginKeyPairAttributeRequest {
/**
* 实例 ID 列表。每次请求批量实例的上限为 100。
*/
InstanceIds: Array<string>;
/**
* 是否允许使用默认密钥对登录,YES:允许登录;NO:禁止登录
*/
PermitLogin?: string;
}
/**
* IsolateInstances请求参数结构体
*/
export interface IsolateInstancesRequest {
/**
* 实例ID列表。一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。每次请求退还实例和数据盘数量总计上限为20。
*/
InstanceIds: Array<string>;
/**
* 是否退还挂载的数据盘。取值范围:
TRUE:表示退还实例同时退还其挂载的数据盘。
FALSE:表示退还实例同时不再退还其挂载的数据盘。
默认取值:TRUE。
*/
IsolateDataDisk?: boolean;
}
/**
* DeleteFirewallTemplate返回参数结构体
*/
export interface DeleteFirewallTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateInstances返回参数结构体
*/
export interface CreateInstancesResponse {
/**
* 当通过本接口来创建实例时会返回该参数,表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功。
可根据<a href="https://cloud.tencent.com/document/product/1207/47573" target="_blank">DescribeInstances</a> 接口查询返回的InstancesSet中对应实例的ID的状态来判断创建是否完成;如果实例状态由“启动中”变为“运行中”,则为创建成功。
*/
InstanceIdSet?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBlueprintAttribute返回参数结构体
*/
export interface ModifyBlueprintAttributeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会