tencentcloud-sdk-nodejs
Version:
2,432 lines (2,431 loc) • 227 kB
TypeScript
/**
* 用户安全组配额限制
*/
export interface SecurityGroupLimitSet {
/**
* 可创建安全组总数
*/
SecurityGroupLimit?: number;
/**
* 安全组下的最大规则数
*/
SecurityGroupPolicyLimit?: number;
/**
* 安全组下嵌套安全组规则数
*/
ReferedSecurityGroupLimit?: number;
/**
* 单安全组关联实例数
*/
SecurityGroupInstanceLimit?: number;
/**
* 实例关联安全组数
*/
InstanceSecurityGroupLimit?: number;
/**
* 单安全组关联的模块数
*/
SecurityGroupModuleLimit?: number;
/**
* 模块关联的安全组数
*/
ModuleSecurityGroupLimit?: number;
}
/**
* CreateRoutes请求参数结构体
*/
export interface CreateRoutesRequest {
/**
* 路由表实例ID。
*/
RouteTableId: string;
/**
* 要创建的路由策略对象。
*/
Routes: Array<Route>;
}
/**
* DescribeHaVips返回参数结构体
*/
export interface DescribeHaVipsResponse {
/**
* 符合条件的对象数。
*/
TotalCount?: number;
/**
* HAVIP对象数组。
*/
HaVipSet?: Array<HaVip>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyModuleSecurityGroups请求参数结构体
*/
export interface ModifyModuleSecurityGroupsRequest {
/**
* 安全组列表。不超过5个。
*/
SecurityGroupIdSet: Array<string>;
/**
* 模块id。
*/
ModuleId: string;
}
/**
* TerminateInstances返回参数结构体
*/
export interface TerminateInstancesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssignIpv6CidrBlocks请求参数结构体
*/
export interface AssignIpv6CidrBlocksRequest {
/**
* `VPC`实例`ID`,形如:`vpc-f49l6u0z`。
*/
VpcId: string;
/**
* 网络运营商类型 取值范围:'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调
*/
ISPTypes: Array<ISPTypeItem>;
/**
* ECM地域。
*/
EcmRegion?: string;
}
/**
* DescribeMonthPeakNetwork返回参数结构体
*/
export interface DescribeMonthPeakNetworkResponse {
/**
* 无
注意:此字段可能返回 null,表示取不到有效值。
*/
MonthNetWorkData: Array<MonthNetwork>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeNetworkInterfaces请求参数结构体
*/
export interface DescribeNetworkInterfacesRequest {
/**
* 弹性网卡实例ID查询。形如:eni-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定NetworkInterfaceIds和Filters。
*/
NetworkInterfaceIds?: Array<string>;
/**
* 过滤条件,参数不支持同时指定NetworkInterfaceIds和Filters。
vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。
subnet-id - String - (过滤条件)所属子网实例ID,形如:subnet-f49l6u0z。
network-interface-id - String - (过滤条件)弹性网卡实例ID,形如:eni-5k56k7k7。
attachment.instance-id - String - (过滤条件)绑定的云服务器实例ID,形如:ein-3nqpdn3i。
groups.security-group-id - String - (过滤条件)绑定的安全组实例ID,例如:sg-f9ekbxeq。
network-interface-name - String - (过滤条件)网卡实例名称。
network-interface-description - String - (过滤条件)网卡实例描述。
address-ip - String - (过滤条件)内网IPv4地址。
tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。
tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
is-primary - Boolean - 是否必填:否 - (过滤条件)按照是否主网卡进行过滤。值为true时,仅过滤主网卡;值为false时,仅过滤辅助网卡;次过滤参数为提供时,同时过滤主网卡和辅助网卡。
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* ECM 地域,形如ap-xian-ecm。
*/
EcmRegion?: string;
}
/**
* CreateSecurityGroupPolicies返回参数结构体
*/
export interface CreateSecurityGroupPoliciesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述实例的价格相关
*/
export interface InstancePricesPartDetail {
/**
* cpu的价格信息
*/
CpuPrice: PriceDetail;
/**
* 内存价格信息
*/
MemPrice: PriceDetail;
/**
* 磁盘价格信息
*/
DisksPrice: PriceDetail;
}
/**
* DescribeMonthPeakNetwork请求参数结构体
*/
export interface DescribeMonthPeakNetworkRequest {
/**
* 月份时间(xxxx-xx) 如2021-03,默认取当前时间的上一个月份
*/
Month: string;
/**
* 过滤条件
*/
Filters?: Array<Filter>;
}
/**
* 用于描述系统盘。
*/
export interface SystemDisk {
/**
* 硬盘类型。取值范围:
- LOCAL_BASIC:本地硬盘;
- CLOUD_PREMIUM:高性能云硬盘;
默认取值:CLOUD_BASIC。
*/
DiskType?: string;
/**
* 硬盘ID。此参数暂不可用。
*/
DiskId?: string;
/**
* 硬盘容量大小。单位GB。
*/
DiskSize?: number;
}
/**
* DescribeNode返回参数结构体
*/
export interface DescribeNodeResponse {
/**
* 节点详细信息的列表
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeSet: Array<Node>;
/**
* 所有的节点数量。
*/
TotalCount: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeModule请求参数结构体
*/
export interface DescribeModuleRequest {
/**
* 过滤条件。
module-name - string - 是否必填:否 - (过滤条件)按照模块名称过滤。
module-id - string - 是否必填:否 - (过滤条件)按照模块ID过滤。
image-id String 是否必填:否 (过滤条件)按照镜像ID过滤。
instance-family String 是否必填:否 (过滤条件)按照机型family过滤。
security-group-id - string 是否必填:否 - (过滤条件)按照模块绑定的安全组id过滤。
每次请求的Filters的上限为10,Filter.Values的上限为5。
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
*/
Limit?: number;
/**
* 指定排序字段。目前支持的可选值如下
instance-num 按实例数量排序。
node-num 按节点数量排序。
timestamp 按实例创建时间排序。
如果不传,默认按实例创建时间排序
*/
OrderByField?: string;
/**
* 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
*/
OrderDirection?: number;
}
/**
* DeleteSecurityGroup返回参数结构体
*/
export interface DeleteSecurityGroupResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RebootInstances请求参数结构体
*/
export interface RebootInstancesRequest {
/**
* 待重启的实例ID列表。在单次请求的过程中,单个region下的请求实例数上限为100。
*/
InstanceIdSet: Array<string>;
/**
* 是否在正常重启失败后选择强制重启实例。取值范围:
TRUE:表示在正常重启失败后进行强制重启;
FALSE:表示在正常重启失败后不进行强制重启;
默认取值:FALSE。
*/
ForceReboot?: boolean;
/**
* 关机类型。取值范围:
SOFT:表示软关机
HARD:表示硬关机
SOFT_FIRST:表示优先软关机,失败再执行硬关机
默认取值:SOFT。
*/
StopType?: string;
}
/**
* CreateDisks请求参数结构体
*/
export interface CreateDisksRequest {
/**
* 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目。若不指定项目,将在默认项目下进行创建。
*/
Placement: Placement;
/**
* 云硬盘计费类型。<br><li>PREPAID:预付费,即包年包月<br><li>POSTPAID_BY_HOUR:按小时后付费<br><li>CDCPAID:独享集群付费<br>各类型价格请参考云硬盘[价格总览](/document/product/362/2413)。
*/
DiskChargeType: string;
/**
* 硬盘介质类型。取值范围:<br><li>CLOUD_BASIC:表示普通云硬盘<br><li>CLOUD_PREMIUM:表示高性能云硬盘<br><li>CLOUD_SSD:表示SSD云硬盘<br><li>CLOUD_HSSD:表示增强型SSD云硬盘<br><li>CLOUD_TSSD:表示极速型SSD云硬盘。
*/
DiskType: string;
/**
* 云盘显示名称。不传则默认为“未命名”。最大长度不能超60个字节。
*/
DiskName?: string;
/**
* 云盘绑定的标签。
*/
Tags?: Array<Tag>;
/**
* 预付费模式,即包年包月相关参数设置。通过该参数指定包年包月云盘的购买时长、是否设置自动续费等属性。<br>创建预付费云盘该参数必传,创建按小时后付费云盘无需传该参数。
*/
DiskChargePrepaid?: DiskChargePrepaid;
/**
* 创建云硬盘数量,不传则默认为1。单次请求最多可创建的云盘数有限制,具体参见[云硬盘使用限制](https://cloud.tencent.com/doc/product/362/5145)。
*/
DiskCount?: number;
/**
* 可选参数。使用此参数可给云硬盘购买额外的性能。<br>当前仅支持极速型云盘(CLOUD_TSSD)和增强型SSD云硬盘(CLOUD_HSSD)
*/
ThroughputPerformance?: number;
/**
* 云硬盘大小,单位为GB。<br><li>如果传入`SnapshotId`则可不传`DiskSize`,此时新建云盘的大小为快照大小<br><li>如果传入`SnapshotId`同时传入`DiskSize`,则云盘大小必须大于或等于快照大小<br><li>云盘大小取值范围参见云硬盘[产品分类](/document/product/362/2353)的说明。
*/
DiskSize?: number;
/**
* 可选参数,默认为False。传入True时,云盘将创建为共享型云盘。
*/
Shareable?: boolean;
/**
* 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
*/
ClientToken?: string;
/**
* 传入该参数用于创建加密云盘,取值固定为ENCRYPT。
*/
Encrypt?: string;
/**
* 快照ID,如果传入则根据此快照创建云硬盘,快照类型必须为数据盘快照,可通过[DescribeSnapshots](/document/product/362/15647)接口查询快照,见输出参数DiskUsage解释。
*/
SnapshotId?: string;
}
/**
* AttachDisks请求参数结构体
*/
export interface AttachDisksRequest {
/**
* 云服务器实例ID。云盘将被挂载到此云服务器上,通过[DescribeInstances](/document/product/213/15728)接口查询。
*/
InstanceId: string;
/**
* 将要被挂载的弹性云盘ID。通过[DescribeDisks](/document/product/362/16315)接口查询。单次最多可挂载10块弹性云盘。
*/
DiskIds: Array<string>;
/**
* 可选参数,不传该参数则仅执行挂载操作。传入`True`时,会在挂载成功后将云硬盘设置为随云主机销毁模式,仅对按量计费云硬盘有效。
*/
DeleteWithInstance?: boolean;
/**
* 可选参数,用于控制云盘挂载时使用的挂载模式,目前仅对黑石裸金属机型有效。取值范围:<br><li>PF<br><li>VF
*/
AttachMode?: string;
}
/**
* DescribeSnapshots请求参数结构体
*/
export interface DescribeSnapshotsRequest {
/**
* 要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。
*/
SnapshotIds?: Array<string>;
/**
* 过滤条件。参数不支持同时指定`SnapshotIds`和`Filters`。<br><li>snapshot-id - Array of String - 是否必填:否 -(过滤条件)按照快照的ID过滤。快照ID形如:`snap-11112222`。<br><li>snapshot-name - Array of String - 是否必填:否 -(过滤条件)按照快照名称过滤。<br><li>snapshot-state - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤。 (NORMAL:正常 | CREATING:创建中 | ROLLBACKING:回滚中。)<br><li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按创建快照的云盘类型过滤。 (SYSTEM_DISK:代表系统盘 | DATA_DISK:代表数据盘。)<br><li>project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。<br><li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照创建快照的云硬盘ID过滤。<br><li>zone - Array of String - 是否必填:否 -(过滤条件)按照[可用区](/document/product/213/15753#ZoneInfo)过滤。<br><li>encrypt - Array of String - 是否必填:否 -(过滤条件)按是否加密盘快照过滤。 (TRUE:表示加密盘快照 | FALSE:表示非加密盘快照。)
<li>snapshot-type- Array of String - 是否必填:否 -(过滤条件)根据snapshot-type指定的快照类型查询对应的快照。
(SHARED_SNAPSHOT:表示共享过来的快照 | PRIVATE_SNAPSHOT:表示自己私有快照。)
*/
Filters?: Array<Filter>;
/**
* 返回数量,默认为20,最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。
*/
Limit?: number;
/**
* 快照列表排序的依据字段。取值范围:<br><li>CREATE_TIME:依据快照的创建时间排序<br>默认按创建时间排序。
*/
OrderField?: string;
/**
* 偏移量,默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。
*/
Offset?: number;
/**
* 输出云盘列表的排列顺序。取值范围:<br><li>ASC:升序排列<br><li>DESC:降序排列。
*/
Order?: string;
}
/**
* RemovePrivateIpAddresses请求参数结构体
*/
export interface RemovePrivateIpAddressesRequest {
/**
* ECM 地域,形如ap-xian-ecm。
*/
EcmRegion: string;
/**
* 弹性网卡实例ID,例如:eni-11112222。
*/
NetworkInterfaceId: string;
/**
* 指定的内网IP信息,单次最多指定10个。
*/
PrivateIpAddresses: Array<PrivateIpAddressSpecification>;
}
/**
* 实例系列类型配置
*/
export interface InstanceFamilyTypeConfig {
/**
* 实例机型系列类型Id
*/
InstanceFamilyType: string;
/**
* 实例机型系列类型名称
*/
InstanceFamilyTypeName: string;
}
/**
* DescribeImage请求参数结构体
*/
export interface DescribeImageRequest {
/**
* 过滤条件,每次请求的Filters的上限为10,详细的过滤条件如下:
image-id - String - 是否必填: 否 - (过滤条件)按照镜像ID进行过滤
image-type - String - 是否必填: 否 - (过滤条件)按照镜像类型进行过滤。取值范围:
PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像)
PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像)
instance-type -String - 是否必填: 否 - (过滤条件) 按机型过滤支持的镜像
image-name - String - 是否必填:否 - (过滤条件) 按镜像的名称模糊匹配,只能提供一个值
image-os - String - 是否必填:否 - (过滤条件) 按镜像系统的名称模糊匹配,只能提供一个值
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
*/
Limit?: number;
}
/**
* 操作系统支持的类型。
*/
export interface OsVersion {
/**
* 操作系统类型
*/
OsName: string;
/**
* 支持的操作系统版本
注意:此字段可能返回 null,表示取不到有效值。
*/
OsVersions: Array<string>;
/**
* 支持的操作系统架构
注意:此字段可能返回 null,表示取不到有效值。
*/
Architecture: Array<string>;
}
/**
* DescribeListeners返回参数结构体
*/
export interface DescribeListenersResponse {
/**
* 监听器列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Listeners?: Array<Listener>;
/**
* 总的监听器个数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssignIpv6SubnetCidrBlock请求参数结构体
*/
export interface AssignIpv6SubnetCidrBlockRequest {
/**
* 子网所在私有网络`ID`。形如:`vpc-f49l6u0z`。
*/
VpcId: string;
/**
* 分配 `IPv6` 子网段列表。
*/
Ipv6SubnetCidrBlocks: Array<Ipv6SubnetCidrBlock>;
/**
* ECM地域。
*/
EcmRegion?: string;
}
/**
* StartInstances返回参数结构体
*/
export interface StartInstancesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateVpc返回参数结构体
*/
export interface CreateVpcResponse {
/**
* Vpc对象。
*/
Vpc?: VpcInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* VPC辅助CIDR信息。
*/
export interface AssistantCidr {
/**
* VPC实例ID。形如:vpc-6v2ht8q5
*/
VpcId?: string;
/**
* 辅助CIDR。形如:172.16.0.0/16
*/
CidrBlock?: string;
/**
* 辅助CIDR类型(0:普通辅助CIDR,1:容器辅助CIDR),默认都是0。
*/
AssistantType?: number;
/**
* 辅助CIDR拆分的子网。
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetSet?: Array<Subnet>;
}
/**
* ModifyModuleIpDirect请求参数结构体
*/
export interface ModifyModuleIpDirectRequest {
/**
* 模块ID。
*/
ModuleId: string;
/**
* 是否关闭IP直通。取值范围:
true:表示关闭IP直通
false:表示开通IP直通
*/
CloseIpDirect: boolean;
}
/**
* 实例网卡ip网络信息数组
*/
export interface InstanceNetworkInfo {
/**
* 实例内外网ip相关信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
AddressInfoSet: Array<AddressInfo>;
/**
* 网卡ID。
*/
NetworkInterfaceId: string;
/**
* 网卡名称。
注意:此字段可能返回 null,表示取不到有效值。
*/
NetworkInterfaceName: string;
/**
* 主网卡属性。true为主网卡,false为辅助网卡。
*/
Primary: boolean;
}
/**
* ResetInstancesMaxBandwidth返回参数结构体
*/
export interface ResetInstancesMaxBandwidthResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 节点实例数量信息
*/
export interface NodeInstanceNum {
/**
* 节点数量
*/
NodeNum: number;
/**
* 实例数量
*/
InstanceNum: number;
}
/**
* DeleteListener请求参数结构体
*/
export interface DeleteListenerRequest {
/**
* 负载均衡实例 ID
*/
LoadBalancerId: string;
/**
* 要删除的监听器 ID
*/
ListenerId: string;
}
/**
* ResetInstancesMaxBandwidth请求参数结构体
*/
export interface ResetInstancesMaxBandwidthRequest {
/**
* 待重置带宽上限的实例ID列表。在单次请求的过程中,单个region下的请求实例数上限为100。
*/
InstanceIdSet: Array<string>;
/**
* 修改后的最大出带宽上限。
*/
MaxBandwidthOut: number;
/**
* 修改后的最大入带宽上限。
*/
MaxBandwidthIn?: number;
}
/**
* 负载均衡的带宽限制等信息。
*/
export interface LoadBalancerInternetAccessible {
/**
* 最大出带宽,单位Mbps。默认值10
*/
InternetMaxBandwidthOut?: number;
}
/**
* ResetRoutes请求参数结构体
*/
export interface ResetRoutesRequest {
/**
* 路由表实例ID,例如:rtb-azd4dt1c。
*/
RouteTableId: string;
/**
* 路由表名称,最大长度不能超过60个字节。
*/
RouteTableName: string;
/**
* 路由策略。
*/
Routes: Array<Route>;
}
/**
* TerminateDisks请求参数结构体
*/
export interface TerminateDisksRequest {
/**
* 需退还的云盘ID列表。
*/
DiskIds: Array<string>;
}
/**
* 安全组关联的资源统计
*/
export interface SecurityGroupAssociationStatistics {
/**
* 安全组实例ID。
*/
SecurityGroupId?: string;
/**
* ECM实例数。
*/
ECM?: number;
/**
* ECM模块数。
*/
Module?: number;
/**
* 弹性网卡实例数。
*/
ENI?: number;
/**
* 被安全组引用数。
*/
SG?: number;
/**
* 负载均衡实例数。
*/
CLB?: number;
/**
* 全量实例的绑定统计。
*/
InstanceStatistics?: Array<InstanceStatistic>;
/**
* 所有资源的总计数(不包含被安全组引用数)。
*/
TotalCount?: number;
}
/**
* ModifyDefaultSubnet返回参数结构体
*/
export interface ModifyDefaultSubnetResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRouteTables返回参数结构体
*/
export interface DescribeRouteTablesResponse {
/**
* 符合条件的实例数量
*/
TotalCount?: number;
/**
* 路由表列表
*/
RouteTableSet?: Array<RouteTable>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StopInstances请求参数结构体
*/
export interface StopInstancesRequest {
/**
* 需要关机的实例ID列表。在单次请求的过程中,单个region下的请求实例数上限为100。
*/
InstanceIdSet: Array<string>;
/**
* 是否在正常关闭失败后选择强制关闭实例,默认为false,即否。
*/
ForceStop?: boolean;
/**
* 实例的关闭模式。取值范围:
SOFT_FIRST:表示在正常关闭失败后进行强制关闭;
HARD:直接强制关闭;
SOFT:仅软关机;
默认为SOFT。
*/
StopType?: string;
}
/**
* DetachNetworkInterface返回参数结构体
*/
export interface DetachNetworkInterfaceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 镜像任务
*/
export interface ImageTask {
/**
* 镜像导入状态, PENDING, PROCESSING, SUCCESS, FAILED
*/
State: string;
/**
* 导入失败(FAILED)时, 说明失败原因
注意:此字段可能返回 null,表示取不到有效值。
*/
Message: string;
/**
* 镜像名称
*/
ImageName: string;
/**
* 创建时间
*/
CreateTime: string;
}
/**
* AllocateIpv6AddressesBandwidth请求参数结构体
*/
export interface AllocateIpv6AddressesBandwidthRequest {
/**
* ECM 地域。
*/
EcmRegion: string;
/**
* 需要开通公网访问能力的IPV6地址。
*/
Ipv6Addresses: Array<string>;
/**
* 带宽,单位Mbps,默认是1Mbps。
*/
InternetMaxBandwidthOut?: number;
/**
* 网络计费模式,当前支持 BANDWIDTH_PACKAGE。
*/
InternetChargeType?: string;
}
/**
* 云镜服务;
*/
export interface RunSecurityServiceEnabled {
/**
* 是否开启。
*/
Enabled?: boolean;
/**
* 云镜版本:0 基础版,1 专业版。目前仅支持基础版
*/
Version?: number;
}
/**
* CreateImage请求参数结构体
*/
export interface CreateImageRequest {
/**
* 镜像名称。
*/
ImageName: string;
/**
* 需要制作镜像的实例ID。
*/
InstanceId: string;
/**
* 镜像描述。
*/
ImageDescription?: string;
/**
* 是否执行强制关机以制作镜像。取值范围:
TRUE:表示自动关机后制作镜像
FALSE:表示开机状态制作,目前不支持,需要先手动关机
默认取值:FALSE。
*/
ForcePoweroff?: string;
}
/**
* 用于描述实例相关的信息。
*/
export interface Instance {
/**
* 实例ID。
*/
InstanceId?: string;
/**
* 实例名称,如ens-34241f3s。
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceName?: string;
/**
* 实例状态。取值范围:
PENDING:表示创建中
LAUNCH_FAILED:表示创建失败
RUNNING:表示运行中
STOPPED:表示关机
STARTING:表示开机中
STOPPING:表示关机中
REBOOTING:表示重启中
SHUTDOWN:表示停止待销毁
TERMINATING:表示销毁中。
*/
InstanceState?: string;
/**
* 实例当前使用的镜像的信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Image?: Image;
/**
* 实例当前所属的模块简要信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
SimpleModule?: SimpleModule;
/**
* 实例所在的位置相关信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Position?: Position;
/**
* 实例的网络相关信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Internet?: Internet;
/**
* 实例的配置相关信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceTypeConfig?: InstanceTypeConfig;
/**
* 实例的创建时间。
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime?: string;
/**
* 实例的标签信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
TagSet?: Array<Tag>;
/**
* 实例最后一次操作。
注意:此字段可能返回 null,表示取不到有效值。
*/
LatestOperation?: string;
/**
* 实例最后一次操作结果。
注意:此字段可能返回 null,表示取不到有效值。
*/
LatestOperationState?: string;
/**
* 实例业务状态。取值范围:
NORMAL:表示正常状态的实例
EXPIRED:表示过期的实例
PROTECTIVELY_ISOLATED:表示被安全隔离的实例。
注意:此字段可能返回 null,表示取不到有效值。
*/
RestrictState?: string;
/**
* 系统盘大小,单位GB。
注意:此字段可能返回 null,表示取不到有效值。
*/
SystemDiskSize?: number;
/**
* 数据盘大小,单位GB。
注意:此字段可能返回 null,表示取不到有效值。
*/
DataDiskSize?: number;
/**
* 实例UUID
注意:此字段可能返回 null,表示取不到有效值。
*/
UUID?: string;
/**
* 付费方式。
0为后付费。
1为预付费。
注意:此字段可能返回 null,表示取不到有效值。
*/
PayMode?: number;
/**
* 过期时间。格式为yyyy-mm-dd HH:mm:ss。
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpireTime?: string;
/**
* 隔离时间。格式为yyyy-mm-dd HH:mm:ss。
注意:此字段可能返回 null,表示取不到有效值。
*/
IsolatedTime?: string;
/**
* 是否自动续费。
0为不自动续费。
1为自动续费。
注意:此字段可能返回 null,表示取不到有效值。
*/
RenewFlag?: number;
/**
* 过期状态。
NORMAL 表示机器运行正常。
WILL_EXPIRE 表示即将过期。
EXPIRED 表示已过期。
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpireState?: string;
/**
* 系统盘信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SystemDisk?: DiskInfo;
/**
* 数据盘信息
注意:此字段可能返回 null,表示取不到有效值。
*/
DataDisks?: Array<DiskInfo>;
/**
* 新实例标志
注意:此字段可能返回 null,表示取不到有效值。
*/
NewFlag?: number;
/**
* 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。
注意:此字段可能返回 null,表示取不到有效值。
*/
SecurityGroupIds?: Array<string>;
/**
* VPC属性
注意:此字段可能返回 null,表示取不到有效值。
*/
VirtualPrivateCloud?: VirtualPrivateCloud;
/**
* 实例运营商字段。
注意:此字段可能返回 null,表示取不到有效值。
*/
ISP?: string;
/**
* 物理位置信息。注意该字段目前为保留字段,均为空值。
注意:此字段可能返回 null,表示取不到有效值。
*/
PhysicalPosition?: PhysicalPosition;
}
/**
* DescribeRegionIpv6Addresses返回参数结构体
*/
export interface DescribeRegionIpv6AddressesResponse {
/**
* 符合条件的 IPV6 数量。
*/
TotalCount?: number;
/**
* IPV6 详细信息列表。
*/
AddressSet?: Array<Address>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 节点信息
*/
export interface Node {
/**
* zone信息。
*/
ZoneInfo?: ZoneInfo;
/**
* 国家信息。
*/
Country?: Country;
/**
* 区域信息。
*/
Area?: Area;
/**
* 省份信息。
*/
Province?: Province;
/**
* 城市信息。
*/
City?: City;
/**
* Region信息。
*/
RegionInfo?: RegionInfo;
/**
* 运营商列表。
*/
ISPSet?: Array<ISP>;
/**
* 运营商数量。
*/
ISPNum?: number;
/**
* 节点是否支持LB
*/
LBSupported?: boolean;
}
/**
* 峰值信息
*/
export interface PeakBase {
/**
* CPU峰值
*/
PeakCpuNum: number;
/**
* 内存峰值
*/
PeakMemoryNum: number;
/**
* 硬盘峰值
*/
PeakStorageNum: number;
/**
* 记录时间
*/
RecordTime: string;
}
/**
* DeleteLoadBalancer请求参数结构体
*/
export interface DeleteLoadBalancerRequest {
/**
* 要删除的负载均衡实例 ID数组,数组大小最大支持20
*/
LoadBalancerIds?: Array<string>;
}
/**
* DescribeVpcs请求参数结构体
*/
export interface DescribeVpcsRequest {
/**
* VPC实例ID。形如:vpc-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpcIds和Filters。
*/
VpcIds?: Array<string>;
/**
* 过滤条件,参数不支持同时指定VpcIds和Filters。
vpc-name - String - VPC实例名称,只支持单值的模糊查询。
vpc-id - String - VPC实例ID形如:vpc-f49l6u0z。
cidr-block - String - vpc的cidr,只支持单值的模糊查询。
region - String - vpc的region。
tag-key - String -是否必填:否- 按照标签键进行过滤。
tag:tag-key - String - 是否必填:否 - 按照标签键值对进行过滤。
ipv6-cidr-block - String - 是否必填:否 - 按照IPv6 CIDR block进行过滤。
isp-type - String - 是否必填:否 - 按照运营商(如CMCC, CUCC, CTCC)进行过滤。
*/
Filters?: Array<Filter>;
/**
* 偏移量
*/
Offset?: number;
/**
* 返回数量
*/
Limit?: number;
/**
* 地域
*/
EcmRegion?: string;
/**
* 排序方式:time时间倒序, default按照网络规划排序
*/
Sort?: string;
}
/**
* DescribeRouteConflicts返回参数结构体
*/
export interface DescribeRouteConflictsResponse {
/**
* 路由策略冲突列表
*/
RouteConflictSet?: Array<RouteConflict>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssociateSecurityGroups返回参数结构体
*/
export interface AssociateSecurityGroupsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BatchDeregisterTargets请求参数结构体
*/
export interface BatchDeregisterTargetsRequest {
/**
* 负载均衡ID
*/
LoadBalancerId: string;
/**
* 解绑目标
*/
Targets: Array<BatchTarget>;
}
/**
* ModifyListener返回参数结构体
*/
export interface ModifyListenerResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTargetHealth返回参数结构体
*/
export interface DescribeTargetHealthResponse {
/**
* 负载均衡实例列表
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancers?: Array<LoadBalancerHealth>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* QueryVpcTaskResult请求参数结构体
*/
export interface QueryVpcTaskResultRequest {
/**
* 无
*/
TaskId: string;
}
/**
* ModifyDefaultSubnet请求参数结构体
*/
export interface ModifyDefaultSubnetRequest {
/**
* ECM地域
*/
EcmRegion: string;
/**
* ECM可用区
*/
Zone: string;
/**
* 私有网络ID
*/
VpcId: string;
/**
* 子网ID
*/
SubnetId: string;
}
/**
* DescribeTaskResult请求参数结构体
*/
export interface DescribeTaskResultRequest {
/**
* ECM 地域
*/
EcmRegion: string;
/**
* 异步任务ID。
*/
TaskId: string;
}
/**
* 申请ipv6 cidr block的信息
*/
export interface ISPTypeItem {
/**
* IPv6 Cidr所属运营商类型,支持的类型有 'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调。作为入参数时为必选。
*/
ISPType?: string;
/**
* 申请IPv6 Cidr Block的个数。作为入参数时为必选。
*/
Count?: number;
}
/**
* 描述了快照的详细信息
*/
export interface Snapshot {
/**
* 快照所在的位置。
*/
Placement?: Placement;
/**
* 是否为跨地域复制的快照。取值范围:<br><li>true:表示为跨地域复制的快照。<br><li>false:本地域的快照。
*/
CopyFromRemote: boolean;
/**
* 是否为永久快照。取值范围:<br><li>true:永久快照<br><li>false:非永久快照。
*/
IsPermanent?: boolean;
/**
* 快照名称,用户自定义的快照别名。调用[ModifySnapshotAttribute](/document/product/362/15650)可修改此字段。
*/
SnapshotName?: string;
/**
* 快照创建进度百分比,快照创建成功后此字段恒为100。
*/
Percent?: number;
/**
* 快照关联的镜像列表。
*/
Images: Array<Image>;
/**
* 快照当前被共享数。
*/
ShareReference: number;
/**
* 快照类型,目前该项取值可以为PRIVATE_SNAPSHOT或者SHARED_SNAPSHOT
*/
SnapshotType: string;
/**
* 创建此快照的云硬盘大小,单位GB。
*/
DiskSize?: number;
/**
* 创建此快照的云硬盘ID。
*/
DiskId?: string;
/**
* 快照正在跨地域复制的目的地域,默认取值为[]。
*/
CopyingToRegions: Array<string>;
/**
* 快照ID。
*/
SnapshotId?: string;
/**
* 创建此快照的云硬盘类型。取值范围:<br><li>SYSTEM_DISK:系统盘<br><li>DATA_DISK:数据盘。
*/
DiskUsage?: string;
/**
* 是否为加密盘创建的快照。取值范围:<br><li>true:该快照为加密盘创建的<br><li>false:非加密盘创建的快照。
*/
Encrypt?: boolean;
/**
* 快照的创建时间。
*/
CreateTime?: string;
/**
* 快照关联的镜像个数。
*/
ImageCount: number;
/**
* 快照的状态。取值范围:<br><li>NORMAL:正常<br><li>CREATING:创建中<br><li>ROLLBACKING:回滚中<br><li>COPYING_FROM_REMOTE:跨地域复制中<br><li>CHECKING_COPIED:复制校验中<br><li>TORECYCLE:待回收。
*/
SnapshotState?: string;
/**
* 快照的到期时间。
*/
DeadlineTime: string;
/**
* 快照开始共享的时间。
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeStartShare: string;
}
/**
* AttachDisks返回参数结构体
*/
export interface AttachDisksResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssignIpv6CidrBlock请求参数结构体
*/
export interface AssignIpv6CidrBlockRequest {
/**
* `VPC`实例`ID`,形如:`vpc-f49l6u0z`。
*/
VpcId: string;
/**
* 网络运营商类型 'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调
*/
ISPType: string;
/**
* ECM地域。
*/
EcmRegion?: string;
}
/**
* DescribeLoadBalancers请求参数结构体
*/
export interface DescribeLoadBalancersRequest {
/**
* 区域。如果不传则默认查询所有区域。
*/
EcmRegion?: string;
/**
* 负载均衡实例 ID。
*/
LoadBalancerIds?: Array<string>;
/**
* 负载均衡实例的名称。
*/
LoadBalancerName?: string;
/**
* 负载均衡实例的 VIP 地址,支持多个。
*/
LoadBalancerVips?: Array<string>;
/**
* 负载均衡绑定的后端服务的内网 IP。
*/
BackendPrivateIps?: Array<string>;
/**
* 数据偏移量,默认为 0。
*/
Offset?: number;
/**
* 返回负载均衡实例的数量,默认为20,最大值为100。
*/
Limit?: number;
/**
* 负载均衡是否绑定后端服务,0:没有绑定后端服务,1:绑定后端服务,-1:查询全部。
如果不传则默认查询全部。
*/
WithBackend?: number;
/**
* 负载均衡实例所属私有网络唯一ID,如 vpc-bhqkbhdx。
*/
VpcId?: string;
/**
* 每次请求的`Filters`的上限为10,`Filter.Values`的上限为100。详细的过滤条件如下:
tag-key - String - 是否必填:否 - (过滤条件)按照标签的键过滤。
*/
Filters?: Array<Filter>;
/**
* 安全组。
*/
SecurityGroup?: string;
}
/**
* DeleteRoutes返回参数结构体
*/
export interface DeleteRoutesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCustomImageTask请求参数结构体
*/
export interface DescribeCustomImageTaskRequest {
/**
* 支持key,value查询
task-id: 异步任务ID
image-id: 镜像ID
image-name: 镜像名称
*/
Filters: Array<Filter>;
}
/**
* DescribeSecurityGroupAssociationStatistics返回参数结构体
*/
export interface DescribeSecurityGroupAssociationStatisticsResponse {
/**
* 安全组关联实例统计。
*/
SecurityGroupAssociationStatisticsSet?: Array<SecurityGroupAssociationStatistics>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssignPrivateIpAddresses返回参数结构体
*/
export interface AssignPrivateIpAddressesResponse {
/**
* 内网IP详细信息。
*/
PrivateIpAddressSet?: Array<PrivateIpAddressSpecification>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 描述cpu,内存等维度的价格
*/
export interface PriceDetail {
/**
* 表示折扣,20 表示20%,打2折
*/
Discount: number;
/**
* 打折后价格,单位分
*/
DiscountPrice: number;
/**
* 折扣前价格,单位分
*/
OriginalPrice: number;
}
/**
* ImportImage返回参数结构体
*/
export interface ImportImageResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSecurityGroups请求参数结构体
*/
export interface DescribeSecurityGroupsRequest {
/**
* 安全组实例ID,例如:esg-33ocnj9n,可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/1108/47697)获取。每次请求的实例的上限为100。参数不支持同时指定SecurityGroupIds和Filters。
*/
SecurityGroupIds?: Array<string>;
/**
* 过滤条件,参数不支持同时指定SecurityGroupIds和Filters。
security-group-id - String - (过滤条件)安全组ID。
security-group-name - String - (过滤条件)安全组名称。
tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。
tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
*/
Filters?: Array<Filter>;
/**
* 偏移量,默认为0。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。
*/
Limit?: number;
}
/**
* ReleaseIpv6AddressesBandwidth请求参数结构体
*/
export interface ReleaseIpv6AddressesBandwidthRequest {
/**
* ECM 地域。
*/
EcmRegion: string;
/**
* IPV6地址。Ipv6Addresses和Ipv6AddressIds必须且只能传一个。
*/
Ipv6Addresses?: Array<string>;
/**
* IPV6地址对应的唯一ID,形如eip-xxxxxxxx。Ipv6Addresses和Ipv6AddressIds必须且只能传一个。
*/
Ipv6AddressIds?: Array<string>;
}
/**
* DescribePriceRunInstance返回参数结构体
*/
export interface DescribePriceRunInstanceResponse {
/**
* 实例价格信息
*/
InstancePrice?: InstancesPrice;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteImage返回参数结构体
*/
export interface DeleteImageResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySubnetAttribute返回参数结构体
*/
export interface ModifySubnetAttributeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisassociateSecurityGroups请求参数结构体
*/
export interface DisassociateSecurityGroupsRequest {
/**
* 要解绑的安全组ID,类似esg-efil73jd,只支持解绑单个安全组。
*/
SecurityGroupIds: Array<string>;
/**
* 被解绑的实例ID,类似ein-lesecurk,支持指定多个实例 。
*/
InstanceIds: Array<string>;
}
/**
* 弹性网卡
*/
export interface NetworkInterface {
/**
* 弹性网卡实例ID,例如:eni-f1xjkw1b。
*/
NetworkInterfaceId?: string;
/**
* 弹性网卡名称。
*/
NetworkInterfaceName?: string;
/**
* 弹性网卡描述。
*/
NetworkInterfaceDescription?: string;
/**
* 子网实例ID。
*/
SubnetId?: string;
/**
* VPC实例ID。
*/
VpcId?: string;
/**
* 绑定的安全组。
注意:此字段可能返回 null,表示取不到有效值。
*/
GroupSet?: Array<string>;
/**
* 是否是主网卡。
*/
Primary?: boolean;
/**
* MAC地址。
*/
MacAddress?: string;
/**
* 弹性网卡状态:
PENDING:创建中
AVAILABLE:可用的
ATTACHING:绑定中
DETACHING:解绑中
DELETING:删除中
*/
State?: string;
/**
* 内网IP信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivateIpAddressSet?: Array<PrivateIpAddressSpecification>;
/**
* 绑定的云服务器对象。
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
*/
Attachment?: NetworkInterfaceAttachment;
/**
* 可用区。
*/
Zone?: string;
/**
* 创建时间。
*/
CreatedTime?: string;
/**
* IPv6地址列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
Ipv6AddressSet?: Array<Ipv6Address>;
/**
* 标签键值对。
注意:此字段可能返回 null,表示取不到有效值。
*/
TagSet?: Array<Tag>;
/**
* 网卡类型。0 - 弹性网卡;1 - evm弹性网卡。
*/
EniType?: number;
/**
* EcmRegion ecm区域
*/
EcmRegion?: string;
/**
* 网卡绑定的子机类型:cvm,eks。
注意:此字段可能返回 null,表示取不到有效值。
*/
Business?: string;
}
/**
* 描述密钥对信息
*/
export interface KeyPair {
/**
* 密钥对的ID,是密钥对的唯一标识。
注意:此字段可能返回 null,表示取不到有效值。
*/
KeyId?: string;
/**
* 密钥对名称。
注意:此字段可能返回 null,表示取不到有效值。
*/
KeyName?: string;
/**
* 密钥对所属的项目ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
ProjectId?: number;
/**
* 密钥对描述信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Description?: string;
/**
* 密钥对的纯文本公钥。
注意:此字段可能返回 null,表示取不到有效值。
*/
PublicKey?: string;
/**
* 钥对的纯文本私钥。腾讯云不会保管私钥,请用户自行妥善保存。
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivateKey?: string;
/**
* 钥关联的实例ID列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
AssociatedInstanceIds?: Array<string>;
/**
* 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
注意:此字段可能返回 null,表示取不到有效值。
*/
CreatedTime?: string;
}
/**
* DescribeVpcs返回参数结构体
*/
export interface DescribeVpcsResponse {
/**
* 符合条件的对象数。
*/
TotalCount?: number;
/**
* 私有网络对象。
*/
VpcSet?: Array<VpcInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySecurityGroupAttribute请求参数结构体
*/
export interface ModifySecurityGroupAttributeRequest {
/**
* 安全组实例ID,例如esg-33ocnj9n,可通过DescribeSecurityGroups获取。
*/
SecurityGroupId: string;
/**
* 安全组名称,可任意命名,但不得超过60个字符。
*/
GroupName?: string;
/**
* 安全组备注,最多100个字符。
*/
GroupDescription?: string;
}
/**
* DescribePackingQuotaGroup返回参数结构体
*/
export interface DescribePackingQuotaGroupResponse {
/**
* 装箱配额组
*/
PackingQuotaSet?: Array<PackingQuotaGroup>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssignIpv6CidrBlocks返回参数结构体
*/
export interface AssignIpv6CidrBlocksResponse {
/**
* IPv6网段和所属运营商。
*/
IPv6CidrBlockSet?: Array<ISPIPv6CidrBlock>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 负载均衡实例信息
*/
export interface LoadBalancer {
/**
* 区域。
注意:此字段可能返回 null,表示取不到有效值。
*/
Region: string;
/**
* 位置信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Position: Position;
/**
* 负载均衡实例 ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerId: string;
/**
* 负载均衡实例的名称。
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerName: string;
/**
* 负载均衡实例的网络类型:OPEN:公网属性
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerType: string;
/**
* 负载均衡实例的 VIP 列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerVips: Array<string>;
/**
* 负载均衡实例的状态,包括
0:创建中,1:正常运行。
注意:此字段可能返回 null,表示取不到有效值。
*/
Status: number;
/**
* 负载均衡实例的创建时间。
注意:此字段可能返回 null,表示取不到有效值。
*/
CreateTime: string;
/**
* 负载均衡实例的上次状态转换时间。
注意:此字段可能返回 null,表示取不到有效值。
*/
StatusTime: string;
/**
* 私有网络的 ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId: string;
/**
* 负载均衡实例的标签信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags: Array<TagInfo>;
/**
* 负载均衡IP地址所属的ISP。
注意:此字段可能返回 null,表示取不到有效值。
*/
VipIsp: string;
/**
* 负载均衡实例的网络属性。
注意:此字段可能返回 null,表示取不到有效值。
*/
NetworkAttributes: LoadBalancerInternetAccessible;
/**
* 安全组。
注意:此字段可能返回 null,表示取不到有效值。
*/
SecureGroups: Array<string>;
/**
* 后端机器是否放通来自ELB的流量。
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerPassToTarget: boolean;
/**
* 负载均衡实例的IPv6地址
注意:此字段可能返回 null,表示取不到有效值。
*/
AddressIPv6: string;
}
/**
* ModifyModuleName返回参数结构体
*/
export interface ModifyModuleNameResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePeakBaseOverview请求参数结构体
*/
export interface DescribePeakBaseOverviewRequest {
/**
* 开始时间(xxxx-xx-xx)如2019-08-14,默认为一周之前的日期,不应与当前日期间隔超过90天。
*/
StartTime?: string;
/**
* 结束时间(xxxx-xx-xx)如2019-08-14,默认为昨天,不应与当前日期间隔超过90天。当开始与结束间隔不超过30天时返回1小时粒度的数据,否则返回3小时粒度的数据。
*/
EndTime?: string;
}
/**
* BatchModifyTargetWeight返回参数结构体
*/
export interface BatchModifyTargetWeightResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用于描述实例的统计信息
*/
export interface InstanceStatistic {
/**
* 实例的类型
*/
InstanceType?: string;
/**
* 实例的个数
*/
InstanceCount?: number;
}
/**
* DeleteSecurityGroupPolicies请求参数结构体
*/
export interface DeleteSecurityGroupPoliciesRequest {
/**
* 安全组实例ID,例如esg-33ocnj9n,可通过DescribeSecurityGroups获取。
*/
SecurityGroupId: string;
/**
* 安全组规则集合。一个请求中只能删除单个方向的一条或多条规则。支持指定索引(PolicyIndex) 匹配删除和安全组规则匹配删除两种方式,一个请求中只能使用一种匹配方式。
*/
SecurityGroupPolicySet: SecurityGroupPolicySet;
}
/**
* ImportCustomImage返回参数结构体
*/
export interface ImportCustomImageResponse {
/**
* 镜像ID
*/
ImageId?: string;
/**
* 异步任务ID,可根据DescribeCustomImageTask查询任务信息
*/
TaskId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AssociateSecurityGroups请求参数结构体
*/
export interface AssociateSecurityGroupsRequest {
/**
* 要绑定的安全组ID,类似esg-efil73jd,只支持绑定单个安全组。
*/
SecurityGroupIds: Array<string>;
/**
* 被绑定的实例ID,类似ein-lesecurk,支持指定多个实例,每次请求批量实例的上限为100。
*/
InstanceIds: Array<string>;
}
/**
* 路由冲突对象
*/
export interface RouteConflict {
/**
* 路由表实例ID
*/
RouteTableId?: string;
/**
* 要检查的与之冲突的目的端
*/
DestinationCidrBlock?: string;
/**
* 冲突的路由策略列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ConflictSet?: Array<Route>;
}
/**
* DeleteSubnet返回参数结构体
*/
export interface DeleteSubnetResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 运营商信息
*/
export interface ISP {
/**
* 运营商ID
*/
ISPId: string;
/**
* 运营商名称
*/
ISPName: string;
}
/**
* 描述 EIP 信息
*/
export interface Address {
/**
* EIP的ID,是EIP的唯一标识。
*/
AddressId: string;
/**
* EIP名称。
*/
AddressName: string;
/**
* EIP状态,包含'CREATING'(创建中),'BINDING'(绑定中),'BIND'(已绑定),'UNBINDING'(解绑中),'UNBIND'(已解绑),'OFFLINING'(释放中),'BIND_ENI'(绑定悬空弹性网卡)
*/
AddressStatus: string;
/**
* 外网IP地址
*/
AddressIp: string;
/**
* 绑定的资源实例ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId: string;
/**
* 创建时间。ISO 8601 格式:YYYY-MM-DDTHH:mm:ss.sssZ
*/
CreatedTime: string;
/**
* 绑定的弹性网卡ID
注意:此字段可能返回 null,表示取不到有效值。
*/
NetworkInterfaceId: string;
/**
* 绑定的资源内网ip
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivateAddressIp: string;
/**
* 资源隔离状态。true表示eip处于隔离状态,false表示资源处于未隔离状态
*/
IsArrears: boolean;
/**
* 资源封堵状态。true表示eip处于封堵状态,false表示eip处于未封堵状态
*/
IsBlocked: boolean;
/**
* eip是否支持直通模式。true表示eip支持直通模式,false表示资源不支持直通模式
*/
IsEipDirectConnection: boolean;
/**
* eip资源类型,包括"CalcIP","WanIP","EIP","AnycastEIP"。其中"CalcIP"表示设备ip,“WanIP”表示普通公网ip,“EIP”表示弹性公网ip,“AnycastEip”表示加速EIP
*/
AddressType: string;
/**
* eip是否在解绑后自动释放。true表示eip将会在解绑后自动释放,false表示eip在解绑后不会自动释放
*/
CascadeRelease: boolean;
/**
* 运营商,CTCC电信,CUCC联通,CMCC移动
注意:此字段可能返回 null,表示取不到有效值。
*/
InternetServiceProvider: string;
/**
* 带宽上限
注意:此字段可能返回 null,表示取不到有效值。
*/
Bandwidth: number;
/**
* 计费模式
注意:此字段可能返回 null,表示取不到有效值。
*/
PayMode: string;
}
/**
* ModifyModuleImage返回参数结构体
*/
export interface ModifyModuleImageResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ReplaceRouteTableAssociation请求参数结构体
*/
export interface ReplaceRouteTableAssociationRequest {
/**
* 子网实例ID,例如:subnet-3x5lf5q0。可通过DescribeSubnets接口查询。
*/
SubnetId: string;
/**
* 路由表实例ID,例如:rtb-azd4dt1c。
*/
RouteTableId: string;
/**
* ECM 地域
*/
EcmRegion: string;
}
/**
* ModifyTargetWeight返回参数结构体
*/
export interface ModifyTargetWeightResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCustomImageTask返回参数结构体
*/
export interface DescribeCustomImageTaskResponse {
/**
* 导入任务详情
注意:此字段可能返回 null,表示取不到有效值。
*/
ImageTaskSet?: Array<ImageTask>;
/**
* 总数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 安全组对象
*/
export interface SecurityGroup {
/**
* 安全组实例ID,例如:esg-ohuuioma。
*/
SecurityGroupId: string;
/**
* 安全组名称,可任意命名,但不得超过60个字符。
*/
SecurityGroupName: string;
/**
* 安全组备注,最多100个字符。
*/
SecurityGroupDesc: string;
/**
* 是否是默认安全组,默认安全组不支持删除。
*/
IsDefault?: boolean;
/**
* 安全组创建时间。
*/
CreatedTime?: string;
/**
* 标签键值对。
*/
TagSet?: Array<Tag>;
}
/**
* CreateModule返回参数结构体
*/
export interface CreateModuleResponse {
/**
* 模块ID,创建模块成功后分配给该模块的ID。
*/
ModuleId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePackingQuotaGroup请求参数结构体
*/
export interface DescribePackingQuotaGroupRequest {
/**
* 过滤条件,name取值为:Zone-可用区, InstanceType-实例类型,DataDiskSize - 数据盘大小
*/
Filters?: Array<Filter>;
}
/**
* 安全组规则对象
*/
export interface SecurityGroupPolicy {
/**
* 安全组规则索引号
*/
PolicyIndex?: number;
/**
* 协议, 取值: TCP,UDP, ICMP。
*/
Protocol?: string;
/**
* 端口(all, 离散port, range)。
*/
Port?: string;
/**
* 协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。
*/
ServiceTemplate?: ServiceTemplateSpecification;
/**
* 网段或IP(互斥)。
*/
CidrBlock?: string;
/**
* 安全组实例ID,例如:esg-ohuuioma。
*/
SecurityGroupId?: string;
/**
* IP地址ID或者ID地址组ID。
*/
AddressTemplate?: AddressTemplateSpecification;
/**
* ACCEPT 或 DROP。
*/
Action?: string;
/**
* 安全组规则描述。
*/
PolicyDescription?: string;
/**
* 修改时间,例如 2020-07-22 19:27:23
*/
ModifyTime?: string;
/**
* 网段或IPv6(互斥)。
注意:此字段可能返回 null,表示取不到有效值。
*/
Ipv6CidrBlock?: string;
}
/**
* TerminateDisks返回参数结构体
*/
export interface TerminateDisksResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 负载均衡器健康状态
*/
export interface LoadBalancerHealth {
/**
* 负载均衡实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerId: string;
/**
* 负载均衡实例名称
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadBalancerName: string;
/**
* 监听器列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Listeners: Array<ListenerHealth>;
}
/**
* CreateListener返回参数结构体
*/
export interface CreateListenerResponse {
/**
* 创建的监听器的唯一标识数组
注意:此字段可能返回 null,表示取不到有效值。
*/
ListenerIds: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteVpc请求参数结构体
*/
export interface DeleteVpcRequest {
/**
* VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。
*/
VpcId: string;
/**
* ECM 地域
*/
EcmRegion: string;
}
/**
* 描述了云硬盘的详细信息
*/
export interface Disk {
/**
* 云盘是否与挂载的实例一起销毁。<br><li>true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。<br><li>false:销毁实例时不销毁云盘。
注意:此字段可能返回 null,表示取不到有效值。
*/
DeleteWithInstance: boolean;
/**
* 自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费<br><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费。
注意:此字段可能返回 null,表示取不到有效值。
*/
RenewFlag?: string;
/**
* 硬盘介质类型。取值范围:<br><li>CLOUD_BASIC:表示普通云硬盘<br><li>CLOUD_PREMIUM:表示高性能云硬盘<br><li>CLOUD_SSD:表示SSD云硬盘<br><li>CLOUD_HSSD:表示增强型SSD云硬盘<br><li>CLOUD_TSSD:表示极速型SSD云硬盘。
*/
DiskType?: string;
/**
* 云盘状态。取值范围:<br><li>UNATTACHED:未挂载<br><li>ATTACHING:挂载中<br><li>ATTACHED:已挂载<br><li>DETACHING:解挂中<br><li>EXPANDING:扩容中<br><li>ROLLBACKING:回滚中<br><li>TORECYCLE:待回收<br><li>DUMPING:拷贝硬盘中。
*/
DiskState?: string;
/**
* 云盘拥有的快照总数。
*/
SnapshotCount: number;
/**
* 云盘已挂载到子机,且子机与云盘都是包年包月。<br><li>true:子机设置了自动续费标识,但云盘未设置<br><li>false:云盘自动续费标识正常。
注意:此字段可能返回 null,表示取不到有效值。
*/
AutoRenewFlagError?: boolean;
/**
* 云盘是否处于快照回滚状态。取值范围:<br><li>false:表示不处于快照回滚状态<br><li>true:表示处于快照回滚状态。
*/
Rollbacking?: boolean;
/**
* 对于非共享型云盘,该参数为空数组。对于共享型云盘,则表示该云盘当前被挂载到的CVM实例InstanceId
*/
InstanceIdList: Array<string>;
/**
* 云盘是否为加密盘。取值范围:<br><li>false:表示非加密盘<br><li>true:表示加密盘。
*/
Encrypt?: boolean;
/**
* 云硬盘名称。
*/
DiskName?: string;
/**
* 云硬盘因欠费销毁或者到期销毁时, 是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁,不进行数据备份。
*/
BackupDisk: boolean;
/**
* 与云盘绑定的标签,云盘未绑定标签则取值为空。
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags: Array<Tag>;
/**
* 云硬盘挂载的云主机ID。
*/
InstanceId?: string;
/**
* 云盘关联的定期快照ID。只有在调用DescribeDisks接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
AutoSnapshotPolicyIds?: Array<string>;
/**
* 云硬盘额外性能值,单位MB/s。
注意:此字段可能返回 null,表示取不到有效值。
*/
ThroughputPerformance: number;
/**
* 云盘是否处于类型变更中。取值范围:<br><li>false:表示云盘不处于类型变更中<br><li>true:表示云盘已发起类型变更,正处于迁移中。
注意:此字段可能返回 null,表示取不到有效值。
*/
Migrating: boolean;
/**
* 云硬盘ID。
*/
DiskId?: string;
/**
* 云盘拥有的快照总容量,单位为MB。
*/
SnapshotSize: number;
/**
* 云硬盘所在的位置。
*/
Placement?: Placement;
/**
* 判断预付费的云盘是否支持主动退还。<br><li>true:支持主动退还<br><li>false:不支持主动退还。
注意:此字段可能返回 null,表示取不到有效值。
*/
IsReturnable?: boolean;
/**
* 云盘是否挂载到云主机上。取值范围:<br><li>false:表示未挂载<br><li>true:表示已挂载。
*/
Attached?: boolean;
/**
* 云硬盘大小,单位GB。
*/
DiskSize?: number;
/**
* 云盘类型变更的迁移进度,取值0到100。
注意:此字段可能返回 null,表示取不到有效值。
*/
MigratePercent: number;
/**
* 云硬盘类型。取值范围:<br><li>SYSTEM_DISK:系统盘<br><li>DATA_DISK:数据盘。
*/
DiskUsage?: string;
/**
* 付费模式。取值范围:<br><li>PREPAID:预付费,即包年包月<br><li>POSTPAID_BY_HOUR:后付费,即按量计费。
*/
DiskChargeType?: string;
/**
* 是否为弹性云盘,false表示非弹性云盘,true表示弹性云盘。
*/
Portable?: boolean;
/**
* 云盘是否具备创建快照的能力。取值范围:<br><li>false表示不具备<br><li>true表示具备。
*/
SnapshotAbility?: boolean;
/**
* 在云盘已挂载到实例,且实例与云盘都是包年包月的条件下,此字段才有意义。<br><li>true:云盘到期时间早于实例。<br><li>false:云盘到期时间晚于实例。
注意:此字段可能返回 null,表示取不到有效值。
*/
DeadlineError?: boolean;
/**
* 云盘快照回滚的进度。
*/
RollbackPercent?: number;
/**
* 当前时间距离盘到期的天数(仅对预付费盘有意义)。
注意:此字段可能返回 null,表示取不到有效值。
*/
DifferDaysOfDeadline: number;
/**
* 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围:<br><li>1:云硬盘已经退还<br><li>2:云硬盘已过期<br><li>3:云盘不支持退还<br><li>8:超过可退还数量的限制。
注意:此字段可能返回 null,表示取不到有效值。
*/
ReturnFailCode?: number;
/**
* 云盘是否为共享型云盘。
*/
Shareable: boolean;
/**
* 云硬盘的创建时间。
*/
CreateTime?: string;
/**
* 云硬盘的到期时间。
*/
DeadlineTime: string;
/**
* 云盘的挂载类型。取值范围:<br><li>PF: PF挂载<br><li>VF: VF挂载
注意:此字段可能返回 null,表示取不到有效值。
*/
AttachMode: string;
}
/**
* CreateSubnet返回参数结构体
*/
ex