@nocobase/plugin-verification

/** * RunDockerContainers请求参数结构体 */ export interface RunDockerContainersRequest { /** * 实例ID。 */ InstanceId: string; /** * 要创建的容器列表。 */ Containers: Array<DockerContainerConfiguration>; } /** * DescribeDockerContainers请求参数结构体 */ export interface DescribeDockerContainersRequest { /** * 实例ID。 */ InstanceId: string; /** * 容器ID列表。 */ 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?: 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列表。 */ DiskIds: Array<string>; } /** * Docker容器映射的端口 */ export interface DockerContainerPublishPort { /** * 主机端口 */ HostPort: number; /** * 容器端口 */ ContainerPort: number; /** * 对外绑定IP，默认0.0.0.0 注意：此字段可能返回 null，表示取不到有效值。 */ Ip?: string; /** * 协议，默认tcp，支持tcp/udp/sctp 注意：此字段可能返回 null，表示取不到有效值。 */ Protocol?: string; } /** * InquirePriceCreateBlueprint请求参数结构体 */ export interface InquirePriceCreateBlueprintRequest { /** * 自定义镜像的个数。默认值为1。 */ BlueprintCount?: number; } /** * DescribeDiskBackups请求参数结构体 */ export interface DescribeDiskBackupsRequest { /** * 要查询云硬盘备份点的ID列表。参数不支持同时指定 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?: number; /** * 返回数量，默认为 20，最大值为 100。 */ 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?: string; } /** * DescribeFirewallTemplateRules请求参数结构体 */ export interface DescribeFirewallTemplateRulesRequest { /** * 防火墙模板ID。 */ TemplateId: string; /** * 防火墙模板规则ID列表。 */ TemplateRuleIds?: Array<string>; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; } /** * AttachCcn请求参数结构体 */ export interface AttachCcnRequest { /** * 云联网实例ID。 */ CcnId: string; } /** * CreateInstances请求参数结构体 */ export interface CreateInstancesRequest { /** * 套餐ID。可以通过调用 [查询套餐](https://cloud.tencent.com/document/api/1207/47575) 接口获取。 */ BundleId: string; /** * 镜像ID。可以通过调用 [查询镜像信息](https://cloud.tencent.com/document/api/1207/47689) 接口获取。 */ BlueprintId: string; /** * 当前实例仅支持预付费模式，即包年包月相关参数设置，单位（月）。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。该参数必传。 */ InstanceChargePrepaid: InstanceChargePrepaid; /** * 实例显示名称。 */ InstanceName?: string; /** * 购买实例数量。包年包月实例取值范围：[1，30]。默认取值：1。指定购买实例的数量不能超过用户所能购买的剩余配额数量 */ InstanceCount?: number; /** * 可用区列表。不填此参数，表示为随机可用区。 */ 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>; } /** * DescribeZones请求参数结构体 */ export interface DescribeZonesRequest { /** * 可用区列表排序的依据字段。取值范围： <li>ZONE：依据可用区排序。 <li>INSTANCE_DISPLAY_LABEL：依据可用区展示标签排序，可用区展示标签包括：HIDDEN（隐藏）、NORMAL（普通）、SELECTED（默认选中），默认采用的升序排列为：['HIDDEN', 'NORMAL', 'SELECTED']。默认按可用区排序。 */ OrderField?: string; /** * 输出可用区列表的排列顺序。取值范围： <li>ASC：升序排列。 <li>DESC：降序排列。默认按升序排列。 */ Order?: string; } /** * RebootInstances返回参数结构体 */ export interface RebootInstancesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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?: string; } /** * 实例操作限制列表。 */ export interface InstanceDeniedActions { /** * 实例 ID。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId?: string; /** * 操作限制列表。 */ DeniedActions?: Array<DeniedAction>; } /** * InquirePriceCreateDisks请求参数结构体 */ export interface InquirePriceCreateDisksRequest { /** * 云硬盘大小, 单位: GB。 */ DiskSize: number; /** * 云硬盘介质类型。取值: "CLOUD_PREMIUM"(高性能云盘), "CLOUD_SSD"(SSD云硬盘)。 */ DiskType: string; /** * 新购云硬盘包年包月相关参数设置。 */ DiskChargePrepaid: DiskChargePrepaid; /** * 云硬盘个数, 默认值: 1。 */ DiskCount?: number; /** * 指定云硬盘备份点配额，不传时默认为不带备份点配额。目前只支持不带或设置1个云硬盘备份点配额。 */ DiskBackupQuota?: number; } /** * 描述了实例可变更的套餐。 */ export interface ModifyBundle { /** * 更改实例套餐后需要补的差价。 */ ModifyPrice: Price; /** * 变更套餐状态。取值： <li>SOLD_OUT：套餐售罄</li> <li>AVAILABLE：支持套餐变更</li> <li>UNAVAILABLE：暂不支持套餐变更</li> */ ModifyBundleState: string; /** * 套餐信息。 */ Bundle: Bundle; /** * 不支持套餐变更原因信息。变更套餐状态为"AVAILABLE"时, 该信息为空注意：此字段可能返回 null，表示取不到有效值。 */ NotSupportModifyMessage: string; } /** * DetachCcn返回参数结构体 */ export interface DetachCcnResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ShareBlueprintAcrossAccounts请求参数结构体 */ export interface ShareBlueprintAcrossAccountsRequest { /** * 镜像ID, 可以通过[DescribeBlueprints](https://cloud.tencent.com/document/product/1207/47689)接口返回的BlueprintId获取。 */ BlueprintId: string; /** * 接收共享镜像的账号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?: string; } /** * InquirePriceRenewInstances返回参数结构体 */ export interface InquirePriceRenewInstancesResponse { /** * 询价信息。默认为列表中第一个实例的价格信息。 */ Price?: Price; /** * 数据盘价格信息列表。注意：此字段可能返回 null，表示取不到有效值。 */ DataDiskPriceSet?: Array<DataDiskPrice>; /** * 待续费实例价格列表。注意：此字段可能返回 null，表示取不到有效值。 */ InstancePriceDetailSet?: Array<InstancePriceDetail>; /** * 总计价格。 */ TotalPrice?: TotalPrice; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteFirewallRules返回参数结构体 */ export interface DeleteFirewallRulesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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。 */ InstanceId: string; /** * 容器ID。 */ 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 数据盘 - FIREWALL_RULE 防火墙规则 */ ResourceNames: Array<string>; } /** * RestartDockerContainers请求参数结构体 */ export interface RestartDockerContainersRequest { /** * 实例ID。 */ InstanceId: string; /** * 容器ID列表。 */ ContainerIds: Array<string>; } /** * DeleteKeyPairs请求参数结构体 */ export interface DeleteKeyPairsRequest { /** * 密钥对 ID 列表，每次请求批量密钥对的上限为 10。 */ KeyIds: Array<string>; } /** * RerunDockerContainer返回参数结构体 */ export interface RerunDockerContainerResponse { /** * Docker活动ID。 */ DockerActivityId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了镜像重置信息 */ export interface ResetInstanceBlueprint { /** * 镜像详细信息 */ BlueprintInfo: Blueprint; /** * 实例镜像是否可重置为目标镜像 */ IsResettable: boolean; /** * 不可重置信息.当镜像可重置时为"" */ NonResettableMessage: string; } /** * DescribeBundles返回参数结构体 */ export interface DescribeBundlesResponse { /** * 套餐详细信息列表。 */ BundleSet?: Array<Bundle>; /** * 符合要求的套餐总数，用于分页展示。 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteFirewallTemplateRules返回参数结构体 */ export interface DeleteFirewallTemplateRulesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFirewallTemplates请求参数结构体 */ export interface DescribeFirewallTemplatesRequest { /** * 防火墙模板ID列表。 */ 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。可通过[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)接口查询。 */ 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; /** * 计费单元。 */ 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?: string; } /** * DescribeRegions返回参数结构体 */ export interface DescribeRegionsResponse { /** * 地域数量。 */ TotalCount: number; /** * 地域信息列表。 */ RegionSet: Array<RegionInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFirewallTemplateApplyRecords请求参数结构体 */ export interface DescribeFirewallTemplateApplyRecordsRequest { /** * 防火墙模板ID。 */ TemplateId: string; /** * 应用任务ID列表。 */ TaskIds?: Array<string>; } /** * DescribeDiskBackups返回参数结构体 */ export interface DescribeDiskBackupsResponse { /** * 云硬盘备份点的数量。 */ TotalCount?: number; /** * 云硬盘备份点信息列表。 */ DiskBackupSet?: Array<DiskBackup>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AttachDisks请求参数结构体 */ export interface AttachDisksRequest { /** * 云硬盘ID列表。 */ DiskIds: Array<string>; /** * 实例ID。 */ 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列表。 */ DiskBackupIds: Array<string>; /** * 云硬盘备份点名称，最大长度90。 */ DiskBackupName?: string; } /** * AttachCcn返回参数结构体 */ export interface AttachCcnResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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。 */ 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。 */ 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, or dead */ State: string; /** * 容器端口主机端口映射列表 */ PublishPortSet: Array<DockerContainerPublishPort>; /** * 容器挂载本地卷列表 */ VolumeSet: Array<DockerContainerVolume>; /** * 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 */ CreatedTime: string; } /** * CancelShareBlueprintAcrossAccounts返回参数结构体 */ export interface CancelShareBlueprintAcrossAccountsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSnapshots请求参数结构体 */ export interface DescribeSnapshotsRequest { /** * 要查询快照的 ID 列表。参数不支持同时指定 SnapshotIds 和 Filters。 */ SnapshotIds?: Array<string>; /** * 过滤器列表。 <li>snapshot-id</li>按照【快照 ID】进行过滤。类型：String 必选：否 <li>disk-id</li>按照【磁盘 ID】进行过滤。类型：String 必选：否 <li>snapshot-name</li>按照【快照名称】进行过滤。类型：String 必选：否 <li>instance-id</li>按照【实例 ID 】进行过滤。类型：String 必选：否每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。参数不支持同时指定 SnapshotIds 和 Filters。 */ Filters?: Array<Filter>; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; } /** * TerminateDisks返回参数结构体 */ export interface TerminateDisksResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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; /** * 上一次操作注意：此字段可能返回 null，表示取不到有效值。 */ LatestOperation?: string; /** * 上一次操作状态注意：此字段可能返回 null，表示取不到有效值。 */ LatestOperationState?: string; /** * 上一次请求ID 注意：此字段可能返回 null，表示取不到有效值。 */ LatestOperationRequestId?: string; /** * 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为： YYYY-MM-DDThh:mm:ssZ。 */ CreatedTime?: string; } /** * DescribeInstancesTrafficPackages返回参数结构体 */ export interface DescribeInstancesTrafficPackagesResponse { /** * 符合条件的实例流量包详情数量。 */ TotalCount?: number; /** * 实例流量包详情列表。 */ InstanceTrafficPackageSet?: Array<InstanceTrafficPackage>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDiskBackupsDeniedActions请求参数结构体 */ export interface DescribeDiskBackupsDeniedActionsRequest { /** * 云硬盘备份点 ID 列表, 可通过 DescribeDiskBackups 接口查询。 */ DiskBackupIds: Array<string>; } /** * 描述密钥对信息。 */ export interface KeyPair { /** * 密钥对 ID ，是密钥对的唯一标识。 */ KeyId?: string; /** * 密钥对名称。 */ KeyName?: string; /** * 密钥对的纯文本公钥。 */ PublicKey?: string; /** * 密钥对关联的实例 ID 列表。注意：此字段可能返回 null，表示取不到有效值。 */ 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。 */ InstanceId: string; /** * 容器ID。 */ 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列表。 */ DiskIds: Array<string>; /** * 续费云硬盘包年包月相关参数设置。 */ RenewDiskChargePrepaid: RenewDiskChargePrepaid; } /** * ShareBlueprintAcrossAccounts返回参数结构体 */ export interface ShareBlueprintAcrossAccountsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 防火墙模板规则信息 */ export interface FirewallTemplateRuleInfo { /** * 防火墙模板规则ID。 */ TemplateRuleId?: string; /** * 防火墙规则信息。 */ FirewallRuleInfo?: FirewallRuleInfo; } /** * 磁盘信息 */ export interface Disk { /** * 磁盘ID */ DiskId: string; /** * 实例ID */ InstanceId: string; /** * 可用区 */ Zone: string; /** * 磁盘名称 */ DiskName: string; /** * 磁盘类型 */ DiskUsage: string; /** * 磁盘介质类型 */ DiskType: string; /** * 磁盘付费类型 */ DiskChargeType: string; /** * 磁盘大小 */ 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?: string; } /** * 可用区详细信息 */ export interface ZoneInfo { /** * 可用区 */ Zone: string; /** * 可用区中文名称 */ ZoneName: string; /** * 实例购买页可用区展示标签 */ InstanceDisplayLabel: string; } /** * DescribeBlueprintInstances请求参数结构体 */ export interface DescribeBlueprintInstancesRequest { /** * 实例 ID 列表，当前最多支持 1 个。 */ InstanceIds: Array<string>; } /** * ApplyInstanceSnapshot返回参数结构体 */ export interface ApplyInstanceSnapshotResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DetachDisks请求参数结构体 */ export interface DetachDisksRequest { /** * 云硬盘ID列表。 */ DiskIds: Array<string>; } /** * ModifyFirewallRules请求参数结构体 */ export interface ModifyFirewallRulesRequest { /** * 实例 ID。 */ InstanceId: string; /** * 防火墙规则列表。 */ FirewallRules: Array<FirewallRule>; /** * 防火墙当前版本。用户每次更新防火墙规则时版本会自动加1，防止规则已过期，不填不考虑冲突。 */ FirewallVersion?: number; } /** * CreateBlueprint请求参数结构体 */ export interface CreateBlueprintRequest { /** * 镜像名称。最大长度60。 */ BlueprintName: string; /** * 镜像描述。最大长度60。 */ Description?: string; /** * 需要制作镜像的实例ID。 */ InstanceId?: string; /** * 是否执行强制关机以制作镜像。取值范围： True：表示关机之后制作镜像 False：表示开机状态制作镜像默认取值：True 开机状态制作镜像，可能导致部分数据未备份，影响数据安全。 */ ForcePowerOff?: boolean; } /** * DeleteFirewallRules请求参数结构体 */ export interface DeleteFirewallRulesRequest { /** * 实例 ID。 */ InstanceId: string; /** * 防火墙规则列表。 */ FirewallRules: Array<FirewallRule>; /** * 防火墙当前版本。用户每次更新防火墙规则时版本会自动加1，防止规则已过期，不填不考虑冲突。 */ FirewallVersion?: number; } /** * RerunDockerContainer请求参数结构体 */ export interface RerunDockerContainerRequest { /** * 实例ID。 */ InstanceId: string; /** * 重新创建的容器配置。 */ ContainerConfiguration: DockerContainerConfiguration; /** * 容器ID。 */ ContainerId: string; } /** * DescribeInstanceVncUrl请求参数结构体 */ export interface DescribeInstanceVncUrlRequest { /** * 实例 ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。 */ InstanceId: string; } /** * ModifyFirewallRuleDescription请求参数结构体 */ export interface ModifyFirewallRuleDescriptionRequest { /** * 实例 ID。 */ 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?: string; } /** * 防火墙模板应用记录详情。 */ export interface FirewallTemplateApplyRecordDetail { /** * 实例标识信息。 */ Instance?: InstanceIdentifier; /** * 防火墙模板应用状态。 */ ApplyState?: string; /** * 防火墙模板应用错误信息。 */ ErrorMessage?: string; } /** * DescribeInstancesDiskNum请求参数结构体 */ export interface DescribeInstancesDiskNumRequest { /** * 实例ID列表。 */ 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?: string; } /** * ApplyDiskBackup返回参数结构体 */ export interface ApplyDiskBackupResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBlueprints请求参数结构体 */ export interface DescribeBlueprintsRequest { /** * 镜像 ID 列表。 */ 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 必选：否 <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 必选：否每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 BlueprintIds 和 Filters 。 */ Filters?: Array<Filter>; } /** * 实例可退还信息。 */ export interface InstanceReturnable { /** * 实例 ID。 */ InstanceId: string; /** * 实例是否可退还。 */ IsReturnable: boolean; /** * 实例退还失败错误码。 */ ReturnFailCode: number; /** * 实例退还失败错误信息。 */ ReturnFailMessage: string; } /** * DescribeInstancesDeniedActions返回参数结构体 */ export interface DescribeInstancesDeniedActionsResponse { /** * 实例操作限制列表详细信息。 */ InstanceDeniedActionSet: Array<InstanceDeniedActions>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RestartDockerContainers返回参数结构体 */ export interface RestartDockerContainersResponse { /** * Docker活动ID。 */ DockerActivityId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateFirewallTemplate请求参数结构体 */ export interface CreateFirewallTemplateRequest { /** * 模板名称。 */ TemplateName: string; /** * 防火墙规则列表。 */ TemplateRules?: Array<FirewallRule>; } /** * RemoveDockerContainers请求参数结构体 */ export interface RemoveDockerContainersRequest { /** * 实例ID。 */ InstanceId: string; /** * 容器ID列表。 */ 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列表。 */ DiskIds: Array<string>; /** * 云硬盘名称。 */ DiskName: string; } /** * DescribeKeyPairs返回参数结构体 */ export interface DescribeKeyPairsResponse { /** * 符合条件的密钥对数量。 */ TotalCount: number; /** * 密钥对详细信息列表。 */ KeyPairSet: Array<KeyPair>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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?: string; } /** * DescribeScenes请求参数结构体 */ export interface DescribeScenesRequest { /** * 使用场景ID列表。 */ 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?: string; } /** * DeleteSnapshots请求参数结构体 */ export interface DeleteSnapshotsRequest { /** * 要删除的快照 ID 列表，可通过 DescribeSnapshots 查询。 */ SnapshotIds: Array<string>; } /** * ModifyDisksRenewFlag返回参数结构体 */ export interface ModifyDisksRenewFlagResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySnapshotAttribute请求参数结构体 */ export interface ModifySnapshotAttributeRequest { /** * 快照 ID, 可通过 DescribeSnapshots 查询。 */ SnapshotId: string; /** * 新的快照名称，最长为 60 个字符。 */ SnapshotName?: string; } /** * DeleteSnapshots返回参数结构体 */ export interface DeleteSnapshotsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReplaceFirewallTemplateRule返回参数结构体 */ export interface ReplaceFirewallTemplateRuleResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDisks返回参数结构体 */ export interface DescribeDisksResponse { /** * 云硬盘信息列表。 */ DiskSet?: Array<Disk>; /** * 符合条件的云硬盘信息数量。 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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?: string; } /** * DescribeAllScenes请求参数结构体 */ export interface DescribeAllScenesRequest { /** * 使用场景ID列表。 */ SceneIds?: Array<string>; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; } /** * ModifyDisksRenewFlag请求参数结构体 */ export interface ModifyDisksRenewFlagRequest { /** * 云硬盘ID列表。 */ DiskIds: Array<string>; /** * 自动续费标识。取值范围： <li>NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 <li>NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 <li>DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 */ RenewFlag: string; } /** * StartDockerContainers返回参数结构体 */ export interface StartDockerContainersResponse { /** * Docker活动ID。 */ DockerActivityId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisassociateInstancesKeyPairs请求参数结构体 */ export interface DisassociateInstancesKeyPairsRequest { /** * 密钥对 ID 列表。每次请求批量密钥对的上限为 100。 */ 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。注意：此字段可能返回 null，表示取不到有效值。 */ InstanceId: 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。 */ InstanceId: string; /** * Docker活动ID列表。 */ ActivityIds?: Array<string>; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 活动创建时间的起始值，时间戳秒数。 */ CreatedTimeBegin?: number; /** * 活动创建时间的结束值，时间戳秒数。 */ CreatedTimeEnd?: number; } /** * ImportKeyPair返回参数结构体 */ export interface ImportKeyPairResponse { /** * 密钥对 ID。 */ KeyId: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteBlueprints返回参数结构体 */ export interface DeleteBlueprintsResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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?: string; } /** * CreateInstances返回参数结构体 */ export interface CreateInstancesResponse { /** * 当通过本接口来创建实例时会返回该参数，表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功。可根据 DescribeInstances 接口查询返回的InstancesSet中对应实例的ID的状态来判断创建是否完成；如果实例状态由“启动中”变为“运行中”，则为创建成功。 */ InstanceIdSet?: Array<string>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyBlueprintAttribute返回参数结构体 */ export interface ModifyBlueprintAttributeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyFirewallTemplate请求参数结构体 */ export interface ModifyFirewallTemplateRequest { /** * 防火墙模板ID。 */ TemplateId: string; /** * 模板名称。 */ TemplateName?: string; } /** * StopDockerContainers请求参数结构体 */ export interface StopDockerContainersRequest { /** * 实例ID。 */ InstanceId: string; /** * 容器ID列表。 */ ContainerIds: Array<string>; } /** * DescribeModifyInstanceBundles请求参数结构体 */ export interface DescribeModifyInstanceBundlesRequest { /** * 实例 ID。 */ InstanceId: string; /** * 过滤器列表。 <li>bundle-id</li>按照【套餐 ID】进行过滤。类型：String 必选：否 <li>support-platform-type</li>按照【系统类型】进行过滤。取值： LINUX_UNIX（Linux/Unix系统）；WINDOWS（Windows 系统）类型：String 必选：否 <li>bundle-type</li>按照【套餐类型进行过滤】。取值：GENERAL_BUNDLE (通用型套餐); STORAGE_BUNDLE(存储型套餐);ENTERPRISE_BUNDLE( 企业型套餐);EXCLUSIVE_BUNDLE(专属型套餐);BEFAST_BUNDLE(蜂驰型套餐); 类型：String 必选：否 <li>bundle-state</li>按照【套餐状态】进行过滤。取值: ‘ONLINE’(在线); ‘OFFLINE’(下线); 类型：String 必选：否每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。 */ 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; } /** * DescribeRegions请求参数结构体 */ export declare type DescribeRegionsRequest = null; /** * 实例标识信息。 */ export interface InstanceIdentifier { /** * 实例ID。 */ InstanceId: string; /** * 实例地域。 */ Region: string; } /** * DescribeInstancesDiskNum返回参数结构体 */ export interface DescribeInstancesDiskNumResponse { /** * 挂载信息列表 */ AttachDetailSet: Array<AttachDetail>; /** * 挂载信息数量 */ TotalCount: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquirePriceCreateBlueprint返回参数结构体 */ export interface InquirePriceCreateBlueprintResponse { /** * 自定义镜像的价格参数。 */ BlueprintPrice: BlueprintPrice; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResetFirewallTemplateRules请求参数结构体 */ export interface ResetFirewallTemplateRulesRequest { /** * 模板ID。 */ TemplateId: string; /** * 重置后的防火墙模板规则列表。 */ TemplateRules: Array<FirewallRule>; } /** * ModifyFirewallTemplate返回参数结构体 */ export interface ModifyFirewallTemplateResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstancesReturnable请求参数结构体 */ export interface DescribeInstancesReturnableRequest { /** * 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。 */ InstanceIds?: Array<string>; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; } /** * 可退还云硬盘详细信息 */ export interface DiskReturnable { /** * 云硬盘ID。 */ DiskId?: string; /** * 云硬盘是否可退还。 */ IsReturnable?: boolean; /** * 云硬盘退还失败错误码。 */ ReturnFailCode?: number; /** * 云硬盘退还失败错误信息。 */ ReturnFailMessage?: string; } /** * DescribeBlueprints返回参数结构体 */ export interface DescribeBlueprintsResponse { /** * 符合条件的镜像数量。 */ TotalCount?: number; /** * 镜像详细信息列表。 */ BlueprintSet?: Array<Blueprint>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeKeyPairs请求参数结构体 */ export interface DescribeKeyPairsRequest { /** * 密钥对 ID 列表。 */ KeyIds?: Array<string>; /** * 偏移量，默认为 0。 */ Offset?: number; /** * 返回数量，默认为 20，最大值为 100。 */ Limit?: number; /** * 过滤器列表。 <li>key-id</li>按照【密钥对ID】进行过滤。类型：String 必选：否 <li>key-name</li>按照【密钥对名称】进行过滤（支持模糊匹配）。类型：String 必选：否每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。参数不支持同时指定 KeyIds 和 Filters。 */ Filters?: Array<Filter>; } /** * DescribeCcnAttachedInstances请求参数结构体 */ export declare type DescribeCcnAttachedInstancesRequest = null; /** * ApplyDiskBackup请求参数结构体 */ export interface ApplyDiskBackupRequest { /** * 云硬盘ID，可通过[DescribeDisks](https://cloud.tencent.com/document/api/1207/66093)接口查询。 */ DiskId: string; /** * 云硬盘备份点ID，可通过[DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379)接口查询。 */ DiskBackupId: string; } /** * ResetInstancesPassword返回参数结构体 */ export interface ResetInstancesPasswordResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StartInstances返回参数结构体 */ export interface StartInstancesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了实例登录相关配置与信息。 */ export interface LoginSettings { /** * 密钥 ID 列表。关联密钥后，就可以通过对应的私钥来访问实例。注意：此字段可能返回 []，表示取不到有效值。 */ KeyIds: Array<string>; } /** * DescribeDockerContainerConfiguration返回参数结构体 */ export interface DescribeDockerContainerConfigurationResponse { /** * Docker容器配置信息。 */ ContainerConfiguration?: DockerContainerConfiguration; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 描述了实例信息。 */ export interface Instance { /** * 实例 ID。 */ InstanceId?: string; /** * 套餐 ID。 */ BundleId?: string; /** * 镜像 ID。 */ BlueprintId?: string; /** * 实例的 CPU 核数，单位：核。 */ CPU?: number; /** * 实例内存容量，单位：GB 。 */ Memory?: number; /** * 实例名称。 */ InstanceName?: string; /** * 实例计费模式。取值范围： PREPAID：表示预付费，即包年包月。 */ InstanceChargeType?: string; /** * 实例系统盘信息。 */ SystemDisk?: SystemDisk; /** * 实例主网卡的内网 IP。注意：此字段可能返回空，表示取不到有效值。 */ PrivateAddresses?: Array<string>; /** * 实例主网卡的公网 IP。注意：此字段可能返回空，表示取不到有效值。 */ PublicAddresses?: Array<string>; /** * 实例带宽信息。 */ InternetAccessible?: InternetAccessible; /** * 自动续费标识。取值范围： NOTIFY_AND_MANUAL_RENEW：表示通知即将过期，但不自动续费 NOTIFY_AND_AUTO_RENEW：表示通知即将过期，而且自动续费。 */ RenewFlag?: string; /** * 实例登录设置。 */ LoginSettings?: LoginSettings; /** * 实例状态。取值范围： <li>PENDING：表示创建中</li><li>LAUNCH_FAILED：表示创建失败</li><li>RUNNING：表示运行中</li><li>STOPPED：表示关机</li><li>STARTING：表示开机中</li><li>STOPPING：表示关机中</li><li>REBOOTING：表示重启中</li><li>SHUTDOWN：表示停止待销毁</li><li>TERMINATING：表示销毁中</li><li>DELETING：表示删除中</li><li>FREEZING：表示冻结中</li><li>ENTER_RESCUE_MODE：表示进入救援模式中</li><li>RESCUE_MODE：表示救援模式</li><li>EXIT_RESCUE_MODE：表示退出救援模式中</li> */ InstanceState?: string; /** * 实例全局唯一 ID。 */ Uuid?: string; /** * 实例的最新操作。例：StopInstances、ResetInstance。注意：此字段可能返回空值，表示取不到有效值。 */ LatestOperation?: string; /** * 实例的最新操作状态。取值范围： SUCCESS：表示操作成功 OPERATING：表示操作执行中 FAILED：表示操作失败注意：此字段可能返回空值，表示取不到有效值。 */ LatestOperationState?: string; /** * 实例最新操作的唯一请求 ID。注意：此字段可能返回空值，表示取不到有效值。 */ LatestOperationRequestId?: string; /** * 隔离时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为： YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。 */ IsolatedTime?: string; /** * 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为： YYYY-MM-DDThh:mm:ssZ。注意：此字段可能返回 null，表示取不到有效值。 */ CreatedTime?: string; /** * 到期时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为： YYYY-MM-DDThh:mm:ssZ 。注意：此字段可能返回 null，表示取不到有效值。 */ ExpiredTime?: string; /** * 操作系统平台类型，如 LINUX_UNIX、WINDOWS。 */ PlatformType?: string; /** * 操作系统平台。 */ Platform?: string; /** * 操作系统名称。 */ OsName?: string; /** * 可用区。 */ Zone?: string; /** * 实例绑定的标签列表。 */ Tags?: Array<Tag>; /** * 实例封禁状态。取值范围： <li>NORMAL实例正常。</li><li>NETWORK_RESTRICT：网络封禁。</li> */ InstanceRestrictState?: string; } /** * Docker容器挂载卷 */ export interface DockerContainerVolume { /** * 容器路径 */ ContainerPath: string; /** * 主机路径 */ HostPath?: string; } /** * StopInstances请求参数结构体 */ export interface StopInstancesRequest { /** * 实例 ID 列表。每次请求批量实例的上限为 100。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。 */ InstanceIds: Array<string>; } /** * IsolateInstances返回参数结构体 */ export interface IsolateInstancesResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateKeyPair返回参数结构体 */ export interface CreateKeyPairResponse { /** * 密钥对信息。 */ KeyPair: KeyPair; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceVncUrl返回参数结构体 */ export interface DescribeInstanceVncUrlResponse { /** * 实例的管理终端地址。 */ InstanceVncUrl: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDockerActivities返回参数结构体 */