tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,014 lines (1,892 loc) • 214 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 资源描述 */
declare interface AllNodeResourceSpec {
/** 描述Master节点资源 */
MasterResourceSpec?: NodeResourceSpec | null;
/** 描述Core节点资源 */
CoreResourceSpec?: NodeResourceSpec | null;
/** 描述Taskr节点资源 */
TaskResourceSpec?: NodeResourceSpec | null;
/** 描述Common节点资源 */
CommonResourceSpec?: NodeResourceSpec | null;
/** Master节点数量 */
MasterCount?: number;
/** Corer节点数量 */
CoreCount?: number;
/** Task节点数量 */
TaskCount?: number;
/** Common节点数量 */
CommonCount?: number;
}
/** yarn application 统计信息 */
declare interface ApplicationStatics {
/** 队列名 */
Queue: string;
/** 用户名 */
User: string;
/** 作业类型 */
ApplicationType: string;
/** SumMemorySeconds含义 */
SumMemorySeconds: number;
/** SumVCoreSeconds含义 */
SumVCoreSeconds: number;
/** SumHDFSBytesWritten(带单位) */
SumHDFSBytesWritten: string;
/** SumHDFSBytesRead(待单位) */
SumHDFSBytesRead: string;
/** 作业数 */
CountApps: number;
}
/** 通用的参数 */
declare interface Arg {
/** key */
Key?: string;
/** 值列表 */
Values?: string[] | null;
}
/** 自动伸缩组高级设置 */
declare interface AutoScaleGroupAdvanceAttrs {
/** 计算资源高级设置 */
ComputeResourceAdvanceParams?: ComputeResourceAdvanceParams | null;
}
/** 弹性扩缩容记录 */
declare interface AutoScaleRecord {
/** 扩缩容规则名。 */
StrategyName?: string;
/** "SCALE_OUT"和"SCALE_IN",分别表示扩容和缩容。 */
ScaleAction?: string;
/** 取值为"SUCCESS","FAILED","PART_SUCCESS","IN_PROCESS",分别表示成功、失败、部分成功和流程中。 */
ActionStatus?: string;
/** 流程触发时间。 */
ActionTime?: string;
/** 扩缩容相关描述信息。 */
ScaleInfo?: string;
/** 只在ScaleAction为SCALE_OUT时有效。 */
ExpectScaleNum?: number;
/** 流程结束时间。 */
EndTime?: string;
/** 策略类型,按负载或者按时间,1表示负载伸缩,2表示时间伸缩 */
StrategyType?: number;
/** 扩容时所使用规格信息。 */
SpecInfo?: string;
/** 补偿扩容,0表示不开启,1表示开启 */
CompensateFlag?: number;
/** 补偿次数 */
CompensateCount?: number;
/** 重试次数 */
RetryCount?: number;
/** 重试信息 */
RetryInfo?: string;
/** 重试英文描述 */
RetryEnReason?: string;
/** 重试描述 */
RetryReason?: string;
}
/** 弹性扩缩容规格配置 */
declare interface AutoScaleResourceConf {
/** 配置ID。 */
Id?: number;
/** 集群实例ID。 */
ClusterId?: number;
/** 自动扩缩容保留最小实例数。 */
ScaleLowerBound?: number;
/** 自动扩缩容最大实例数。 */
ScaleUpperBound?: number;
/** 扩容规则类型,1为按负载指标扩容规则,2为按时间扩容规则 */
StrategyType?: number;
/** 下次可扩容时间。 */
NextTimeCanScale?: number;
/** 优雅缩容开关 */
GraceDownFlag?: boolean;
/** "CVM"表示规格全部使用CVM相关类型,"POD"表示规格使用容器相关类型,默认为"CVM"。 */
HardwareType?: string;
/** "POSTPAY"表示只使用按量计费,"SPOT_FIRST"表示竞价实例优先,只有HardwareType为"HOST"时支持竞价实例优先,"POD"只支持纯按量计费。 */
PayMode?: string;
/** 竞价实例优先的场景下,按量计费资源数量的最低百分比,整数 */
PostPayPercentMin?: number;
/** 预设资源类型为HOST时,支持勾选“资源不足时切换POD”;支持取消勾选;0表示默认不勾选(0),1表示勾选 */
ChangeToPod?: number;
/** 伸缩组名 */
GroupName?: string;
/** 标签 */
YarnNodeLabel?: string;
/** 对应的计算组 */
WarehouseName?: string;
/** 伸缩组状态 */
GroupStatus?: number;
/** 并行伸缩 0关闭;1开启 */
Parallel?: number;
/** 是否支持MNode */
EnableMNode?: number;
/** 伸缩组更多设置 */
ExtraAdvanceAttrs?: AutoScaleGroupAdvanceAttrs | null;
}
/** 引导脚本 */
declare interface BootstrapAction {
/** 脚本位置,支持cos上的文件,且只支持https协议。 */
Path: string;
/** 执行时间。resourceAfter 表示在机器资源申请成功后执行。clusterBefore 表示在集群初始化前执行。clusterAfter 表示在集群初始化后执行。 */
WhenRun: string;
/** 脚本参数 */
Args?: string[];
}
/** CBS实例信息 */
declare interface CBSInstance {
/** 云硬盘ID */
DiskId?: string;
/** 云硬盘类型 */
DiskUsage?: string;
/** 云硬盘名称 */
DiskName?: string;
/** 云硬盘大小 */
DiskSize?: number;
/** 云盘介质类型 */
DiskType?: string;
/** 是否跟随实例删除 */
DeleteWithInstance?: boolean;
/** 云硬盘收费类型 */
DiskChargeType?: string;
/** 云硬盘运行状态 */
DiskState?: string;
/** 是否自动续费 */
RenewFlag?: string;
/** 到期时间 */
DeadlineTime?: string;
/** 云盘是否挂载到云主机上 */
Attached?: boolean;
/** 当前时间距离盘到期的天数 */
DifferDaysOfDeadline?: number;
/** 该云盘当前被挂载到的CVM实例InstanceId */
InstanceIdList?: string[] | null;
/** 云硬盘挂载的云主机ID */
InstanceId?: string;
/** 云盘是否为共享型云盘。 */
Shareable?: boolean;
/** emr节点ID */
EmrResourceId?: string;
/** 包销到期时间 */
UnderwriteExpiredTime?: string;
/** 标签 */
Tags?: TagInfo[];
/** 云硬盘额外性能值,单位:MB/s */
ThroughputPerformance?: number;
}
/** 容器集群Pod服务CLB设置 */
declare interface CLBSetting {
/** CLB类型,PUBLIC_IP表示支持公网CLB和INTERNAL_IP表示支持内网CLB字段 */
CLBType?: string;
/** Vpc和子网信息设置 */
VPCSettings?: VPCSettings | null;
}
/** COS 相关配置 */
declare interface COSSettings {
/** COS SecretId */
CosSecretId: string;
/** COS SecrectKey */
CosSecretKey: string;
/** 日志存储在COS上的路径 */
LogOnCosPath?: string;
}
/** 资源调度-容量调度器的全局设置 */
declare interface CapacityGlobalConfig {
/** 是否开启了标签调度 */
EnableLabel?: boolean;
/** 如果开启了标签调度,标签信息存放的路径 */
LabelDir?: string | null;
/** 是否覆盖用户指定队列,为true表示覆盖。 */
QueueMappingOverride?: boolean | null;
/** 高级设置 */
DefaultSettings?: DefaultSetting[] | null;
}
/** 出参 */
declare interface CdbInfo {
/** 数据库实例 */
InstanceName?: string;
/** 数据库IP */
Ip?: string;
/** 数据库端口 */
Port?: number;
/** 数据库内存规格 */
MemSize?: number;
/** 数据库磁盘规格 */
Volume?: number;
/** 服务标识 */
Service?: string;
/** 过期时间 */
ExpireTime?: string;
/** 申请时间 */
ApplyTime?: string;
/** 付费类型 */
PayType?: number;
/** 过期标识 */
ExpireFlag?: boolean;
/** 数据库状态 */
Status?: number;
/** 续费标识 */
IsAutoRenew?: number;
/** 数据库字符串 */
SerialNo?: string;
/** ZoneId */
ZoneId?: number;
/** RegionId */
RegionId?: number;
}
/** 容器集群Pod请求资源信息 */
declare interface CloudResource {
/** 组件角色名 */
ComponentName: string;
/** pod请求数量 */
PodNumber: number;
/** Cpu请求数量最大值 */
LimitCpu: number;
/** 内存请求数量最大值 */
LimitMemory: number;
/** 服务名称,如HIVE */
Service?: string;
/** 数据卷目录设置 */
VolumeDir?: VolumeSetting | null;
/** 组件外部访问设置 */
ExternalAccess?: ExternalAccess | null;
/** 节点亲和性设置 */
Affinity?: NodeAffinity | null;
/** 所选数据盘信息 */
Disks?: Disk[] | null;
/** 容忍 */
Tolerations?: Toleration[] | null;
}
/** 当前集群共用组件与集群对应关系 */
declare interface ClusterExternalServiceInfo {
/** 依赖关系,0:被其他集群依赖,1:依赖其他集群 */
DependType?: number;
/** 共用组件 */
Service?: string;
/** 共用集群 */
ClusterId?: string;
/** 共用集群状态 */
ClusterStatus?: number;
}
/** 集群id与流程id的mapping */
declare interface ClusterIDToFlowID {
/** 集群id */
ClusterId?: string;
/** 流程id */
FlowId?: number;
}
/** 集群实例信息 */
declare interface ClusterInstancesInfo {
/** ID号 */
Id?: number;
/** 集群ID */
ClusterId?: string;
/** 标题 */
Ftitle?: string | null;
/** 集群名 */
ClusterName?: string;
/** 地域ID */
RegionId?: number;
/** 地区ID */
ZoneId?: number;
/** 用户APPID */
AppId?: number;
/** 用户UIN */
Uin?: string;
/** 项目Id */
ProjectId?: number;
/** 集群VPCID */
VpcId?: number;
/** 子网ID */
SubnetId?: number;
/** 实例的状态码。取值范围:2:表示集群运行中。3:表示集群创建中。4:表示集群扩容中。5:表示集群增加router节点中。6:表示集群安装组件中。7:表示集群执行命令中。8:表示重启服务中。9:表示进入维护中。10:表示服务暂停中。11:表示退出维护中。12:表示退出暂停中。13:表示配置下发中。14:表示销毁集群中。15:表示销毁core节点中。16:销毁task节点中。17:表示销毁router节点中。18:表示更改webproxy密码中。19:表示集群隔离中。20:表示集群冲正中。21:表示集群回收中。22:表示变配等待中。23:表示集群已隔离。24:表示缩容节点中。33:表示集群等待退费中。34:表示集群已退费。301:表示创建失败。302:表示扩容失败。 */
Status?: number;
/** 添加时间 */
AddTime?: string;
/** 已经运行时间 */
RunTime?: string;
/** 集群产品配置信息 */
Config?: EmrProductConfigOutter | null;
/** 主节点外网IP */
MasterIp?: string;
/** EMR版本 */
EmrVersion?: string;
/** 收费类型 */
ChargeType?: number;
/** 交易版本 */
TradeVersion?: number;
/** 资源订单ID */
ResourceOrderId?: number;
/** 是否计费集群 */
IsTradeCluster?: number;
/** 集群错误状态告警信息 */
AlarmInfo?: string;
/** 是否采用新架构 */
IsWoodpeckerCluster?: number;
/** 元数据库信息 */
MetaDb?: string;
/** 标签信息 */
Tags?: Tag[] | null;
/** Hive元数据信息 */
HiveMetaDb?: string;
/** 集群类型:EMR,CLICKHOUSE,DRUID */
ServiceClass?: string;
/** 集群所有节点的别名序列化 */
AliasInfo?: string;
/** 集群版本Id */
ProductId?: number;
/** 地区ID */
Zone?: string;
/** 场景名称 */
SceneName?: string;
/** 场景化集群类型 */
SceneServiceClass?: string;
/** 场景化EMR版本 */
SceneEmrVersion?: string;
/** 场景化集群类型 */
DisplayName?: string;
/** vpc name */
VpcName?: string;
/** subnet name */
SubnetName?: string;
/** 集群依赖关系 */
ClusterExternalServiceInfo?: ClusterExternalServiceInfo[] | null;
/** 集群vpcid 字符串类型 */
UniqVpcId?: string;
/** 子网id 字符串类型 */
UniqSubnetId?: string;
/** 节点信息 */
TopologyInfoList?: TopologyInfo[] | null;
/** 是否是跨AZ集群 */
IsMultiZoneCluster?: boolean;
/** 是否开通异常节点自动补偿 */
IsCvmReplace?: boolean;
/** 标题 */
ClusterTitle?: string;
/** 集群产品配置信息 */
ConfigDetail?: EmrProductConfigDetail | null;
/** 集群绑定的文件系统数 */
BindFileSystemNum?: number;
/** rss集群的绑定列表 */
ClusterRelationInfoList?: ClusterRelationMeta[] | null;
/** Redis信息 */
RedisId?: string;
}
/** 集群间绑定使用信息 */
declare interface ClusterRelationMeta {
/** 集群类型 */
ClusterType?: string;
/** 集群id列表 */
ClusterIdList?: string[] | null;
}
/** 集群配置。 */
declare interface ClusterSetting {
/** 付费方式。PREPAID 包年包月。POSTPAID_BY_HOUR 按量计费,默认方式。 */
InstanceChargeType: string;
/** 是否为HA集群。 */
SupportHA: boolean;
/** 集群所使用的安全组,目前仅支持一个。 */
SecurityGroupIds: string[];
/** 实例位置。 */
Placement: Placement;
/** 实例所在VPC。 */
VPCSettings: VPCSettings;
/** 实例登录配置。 */
LoginSettings: LoginSettings;
/** 实例标签,示例:["{\"TagKey\":\"test-tag1\",\"TagValue\":\"001\"}","{\"TagKey\":\"test-tag2\",\"TagValue\":\"002\"}"]。 */
TagSpecification: string[];
/** 元数据库配置。 */
MetaDB: MetaDbInfo;
/** 实例硬件配置。 */
ResourceSpec: JobFlowResourceSpec;
/** 是否申请公网IP,默认为false。 */
PublicIpAssigned?: boolean;
/** 包年包月配置,只对包年包月集群生效。 */
InstanceChargePrepaid?: InstanceChargePrepaid;
/** 集群置放群组。 */
DisasterRecoverGroupIds?: string;
/** 是否使用cbs加密。 */
CbsEncryptFlag?: boolean;
/** 是否使用远程登录,默认为false。 */
RemoteTcpDefaultPort?: boolean;
}
/** 操作的进程范围 */
declare interface ComponentBasicRestartInfo {
/** 进程名,必填,如NameNode */
ComponentName?: string;
/** 操作的IP列表 */
IpList?: string[] | null;
}
/** 计算资源高级设置 */
declare interface ComputeResourceAdvanceParams {
/** 节点Label数组 */
Labels?: TkeLabel[];
/** 节点污点 */
Taints?: Taint[];
/** base64 编码的用户脚本,在初始化节点之前执行 */
PreStartUserScript?: string;
/** base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看 */
UserScript?: string;
}
/** 资源调度 - 队列修改信息 */
declare interface ConfigModifyInfoV2 {
/** 操作类型,可选值:- 0:新建队列- 1:编辑-全量覆盖- 2:新建子队列- 3:删除- 4:克隆,与新建子队列的行为一样,特别的对于`fair`,可以复制子队列到新建队列- 6:编辑-增量更新 */
OpType: number;
/** 队列名称,不支持修改。 */
Name?: string;
/** 新建队列 传root的MyId;新建子队列 传 选中队列的 myId;克隆 要传 选中队列 parentId */
ParentId?: string;
/** 编辑、删除 传选中队列的 myId。克隆只有在调度器是`fair`时才需要传,用来复制子队列到新队列。 */
MyId?: string;
/** 基础配置信息。key的取值与**DescribeYarnQueue**返回的字段一致。###### 公平调度器key的取值信息如下:- type,父队列,取值为 **parent** 或 **null**- aclSubmitApps,提交访问控制,取值为**AclForYarnQueue类型的json串**或**null**- aclAdministerApps,管理访问控制,取值为**AclForYarnQueue类型的json串**或**null**- minSharePreemptionTimeout,最小共享优先权超时时间,取值为**数字字符串**或**null**- fairSharePreemptionTimeout,公平份额抢占超时时间,取值为**数字字符串**或**null**- fairSharePreemptionThreshold,公平份额抢占阈值,取值为**数字字符串**或**null**,其中数字的范围是(0,1]- allowPreemptionFrom,抢占模式,取值为**布尔字符串**或**null**- schedulingPolicy,调度策略,取值为**drf**、**fair**、**fifo**或**null**```type AclForYarnQueue struct { User *string `json:"user"` //用户名 Group *string `json:"group"`//组名}```###### 容量调度器key的取值信息如下:- state,队列状态,取值为**STOPPED**或**RUNNING**- default-node-label-expression,默认标签表达式,取值为**标签**或**null**- acl_submit_applications,提交访问控制,取值为**AclForYarnQueue类型的json串**或**null**- acl_administer_queue,管理访问控制,取值为**AclForYarnQueue类型的json串**或**null**- maximum-allocation-mb,分配Container最大内存数量,取值为**数字字符串**或**null**- maximum-allocation-vcores,Container最大vCore数量,取值为**数字字符串**或**null**```type AclForYarnQueue struct { User *string `json:"user"` //用户名 Group *string `json:"group"`//组名}``` */
BasicParams?: ItemSeq | null;
/** 配置集信息,取值见该复杂类型的参数说明。配置集是计划模式在队列中表现,表示的是不同时间段不同的配置值,所有队列的配置集名称都一样,对于单个队列,每个配置集中的标签与参数都一样,只是参数值不同。 */
ConfigSetParams?: ConfigSetInfo[] | null;
/** 容量调度专用,`OpType`为`6`时才生效,表示要删除这个队列中的哪些标签。优先级高于ConfigSetParams中的LabelParams。 */
DeleteLables?: string[] | null;
}
/** 资源调度-配置集信息 */
declare interface ConfigSetInfo {
/** 配置集名称 */
ConfigSet: string;
/** 容量调度器会使用,里面设置了标签相关的配置。key的取值与**DescribeYarnQueue**返回的字段一致。key的取值信息如下:- labelName,标签名称,标签管理里的标签。- capacity,容量,取值为**数字字符串**- maximum-capacity,最大容量,取值为**数字字符串** */
LabelParams?: ItemSeq[] | null;
/** 设置配置集相关的参数。key的取值与**DescribeYarnQueue**返回的字段一致。###### 公平调度器key的取值信息如下:- minResources,最大资源量,取值为**YarnResource类型的json串**或**null**- maxResources,最大资源量,取值为**YarnResource类型的json串**或**null**- maxChildResources,能够分配给为未声明子队列的最大资源量,取值为**数字字符串**或**null**- maxRunningApps,最高可同时处于运行的App数量,取值为**数字字符串**或**null**- weight,权重,取值为**数字字符串**或**null**- maxAMShare,App Master最大份额,取值为**数字字符串**或**null**,其中数字的范围是[0,1]或-1```type YarnResource struct { Vcores *int `json:"vcores"` Memory *int `json:"memory"` Type *string `json:"type"` // 取值为`percent`或`null`当值为`percent`时,表示使用的百分比,否则就是使用的绝对数值。只有maxResources、maxChildResources才可以取值为`percent`}```###### 容量调度器key的取值信息如下:- minimum-user-limit-percent,用户最小容量,取值为**YarnResource类型的json串**或**null**,其中数字的范围是[0,100]- user-limit-factor,用户资源因子,取值为**YarnResource类型的json串**或**null**- maximum-applications,最大应用数Max-Applications,取值为**数字字符串**或**null**,其中数字为正整数- maximum-am-resource-percent,最大AM比例,取值为**数字字符串**或**null**,其中数字的范围是[0,1]或-1- default-application-priority,资源池优先级,取值为**数字字符串**或**null**,其中数字为正整数 */
BasicParams?: Item[] | null;
}
/** 自定义配置参数 */
declare interface Configuration {
/** 配置文件名,支持SPARK、HIVE、HDFS、YARN的部分配置文件自定义。 */
Classification: string;
/** 配置参数通过KV的形式传入,部分文件支持自定义,可以通过特殊的键"content"传入所有内容。 */
Properties: string;
}
/** 配置项(配置管理页) */
declare interface ConfigurationItem {
/** 配置项名称 */
Name: string;
/** 配置项值 */
Value: string;
/** 所在的配置文件名 */
InFile?: string;
}
/** 用户Hive-MetaDB信息 */
declare interface CustomMetaDBInfo {
/** 自定义MetaDB的JDBC连接,示例: jdbc:mysql://10.10.10.10:3306/dbname */
MetaDataJdbcUrl?: string;
/** 自定义MetaDB用户名 */
MetaDataUser?: string;
/** 自定义MetaDB密码 */
MetaDataPass?: string;
/** hive共享元数据库类型。取值范围:EMR_DEFAULT_META:表示集群默认创建EMR_EXIST_META:表示集群使用指定EMR-MetaDB。USER_CUSTOM_META:表示集群使用自定义MetaDB。 */
MetaType?: string;
/** EMR-MetaDB实例 */
UnifyMetaInstanceId?: string;
}
/** 用户自建Hive-MetaDB信息 */
declare interface CustomMetaInfo {
/** 自定义MetaDB的JDBC连接,请以 jdbc:mysql:// 开头 */
MetaDataJdbcUrl?: string;
/** 自定义MetaDB用户名 */
MetaDataUser?: string;
/** 自定义MetaDB密码 */
MetaDataPass?: string;
}
/** 共用自建组件参数 */
declare interface CustomServiceDefine {
/** 自定义参数key */
Name?: string;
/** 自定义参数value */
Value?: string;
}
/** DAG信息 */
declare interface DAGInfo {
/** 查询ID */
ID?: string;
/** DAG类型,目前只支持starrocks */
Type?: string;
/** 返回的DAG的JSON字符串 */
Content?: string;
}
/** 弹性扩缩容按天重复任务描述 */
declare interface DayRepeatStrategy {
/** 重复任务执行的具体时刻,例如"01:02:00" */
ExecuteAtTimeOfDay: string;
/** 每隔Step天执行一次 */
Step: number;
}
/** 资源调度的默认设置 */
declare interface DefaultSetting {
/** 名称,作为入参的key */
Name?: string;
/** 描述 */
Desc?: string;
/** 提示 */
Prompt?: string;
/** key,用于展示,该配置对应与配置文件中的配置项 */
Key?: string;
/** Name对应的值 */
Value?: string;
}
/** 共用组件信息 */
declare interface DependService {
/** 共用组件名 */
ServiceName: string;
/** 共用组件集群 */
InstanceId: string;
}
/** 节点规格 */
declare interface DescribeNodeSpec {
/** 节点类型 */
NodeType: string;
/** 节点类型名称 */
NodeName: string;
/** Types数组 */
Types?: NodeSpecType[] | null;
/** 云托管节点机型规格列表 */
CmnTypes?: NodeSpecType[] | null;
}
/** DescribeResourceConfig接口出参 */
declare interface DescribeResourceConfig {
/** 规格管理类型 */
ResourceType?: string;
/** 规格管理数据 */
ResourceData?: NodeResource[];
}
/** 动态生成的变更详情 */
declare interface DiffDetail {
/** tab页的头 */
Name?: string;
/** 变化项的个数 */
Count?: number;
/** 要渲染的明细数据 */
Rows?: DiffDetailItem[] | null;
/** 要渲染的头部信息 */
Header?: DiffHeader[] | null;
}
/** 动态生成的变更详情条目 */
declare interface DiffDetailItem {
/** 属性 */
Attribute?: string;
/** 当前生效 */
InEffect?: string;
/** 待生效 */
PendingEffectiveness?: string;
/** 操作 */
Operation?: string;
/** 队列 */
Queue?: string;
/** 配置集 */
ConfigSet?: string;
/** 标签 */
LabelName?: string;
/** 当前所在位置 */
InEffectIndex?: string;
/** 待生效的位置 */
PendingEffectIndex?: string;
/** 计划模式名称 */
PlanName?: string;
/** 标签 */
Label?: string;
/** 放置规则 */
RuleName?: string;
/** 用户名 */
UserName?: string;
}
/** 动态生成的变更详情 */
declare interface DiffHeader {
/** 名称 */
Name?: string;
/** ID,前端会使用 */
Id?: string;
}
/** 磁盘信息 */
declare interface Disk {
/** 数据盘类型,创建EMR容器集群实例可选 SSD云盘: CLOUD_SSD高效云盘: CLOUD_PREMIUM */
DiskType?: string;
/** 单块大小GB */
DiskCapacity?: number;
/** 数据盘数量 */
DiskNumber?: number;
}
/** 磁盘组。 */
declare interface DiskGroup {
/** 磁盘规格。 */
Spec: DiskSpec;
/** 同类型磁盘数量。 */
Count: number;
}
/** 磁盘描述。 */
declare interface DiskSpec {
/** 磁盘类型。LOCAL_BASIC 本地盘。CLOUD_BASIC 云硬盘。LOCAL_SSD 本地SSD。CLOUD_SSD 云SSD。CLOUD_PREMIUM 高效云盘。CLOUD_HSSD 增强型云SSD。 */
DiskType: string;
/** 磁盘大小,单位GB。 */
DiskSize: number;
}
/** 节点磁盘信息 */
declare interface DiskSpecInfo {
/** 磁盘数量 */
Count: number;
/** 系统盘类型 取值范围:CLOUD_SSD:表示云SSD。CLOUD_PREMIUM:表示高效云盘。CLOUD_BASIC:表示云硬盘。LOCAL_BASIC:表示本地盘。LOCAL_SSD:表示本地SSD。数据盘类型 取值范围:CLOUD_SSD:表示云SSD。CLOUD_PREMIUM:表示高效云盘。CLOUD_BASIC:表示云硬盘。LOCAL_BASIC:表示本地盘。LOCAL_SSD:表示本地SSD。CLOUD_HSSD:表示增强型SSD云硬盘。CLOUD_THROUGHPUT:表示吞吐型云硬盘。CLOUD_TSSD:表示极速型SSD云硬盘。CLOUD_BIGDATA:表示大数据型云硬盘。CLOUD_HIGHIO:表示高IO型云硬盘。CLOUD_BSSD:表示通用型SSD云硬盘。REMOTE_SSD:表示远端SSD盘。 */
DiskType: string;
/** 数据容量,单位为GB */
DiskSize: number;
/** 额外性能 */
ExtraPerformance?: number;
}
/** 采样序列 */
declare interface Dps {
/** 时间戳 */
Timestamp?: string;
/** 采样值 */
Value?: string;
}
/** POD浮动规格 */
declare interface DynamicPodSpec {
/** 需求最小cpu核数 */
RequestCpu?: number;
/** 需求最大cpu核数 */
LimitCpu?: number;
/** 需求最小memory,单位MB */
RequestMemory?: number;
/** 需求最大memory,单位MB */
LimitMemory?: number;
}
/** 集群列表返回示例 */
declare interface EmrListInstance {
/** 集群ID */
ClusterId?: string;
/** 常见状态描述:集群生产中,集群运行中,集群创建中,集群已关闭,集群已删除 */
StatusDesc?: string;
/** 集群名字 */
ClusterName?: string;
/** 集群地域 */
ZoneId?: number;
/** 用户APPID */
AppId?: number;
/** 创建时间 */
AddTime?: string;
/** 运行时间 */
RunTime?: string;
/** 集群IP */
MasterIp?: string;
/** 集群版本 */
EmrVersion?: string;
/** 集群计费类型 */
ChargeType?: number;
/** emr ID */
Id?: number;
/** 产品ID */
ProductId?: number;
/** 项目ID */
ProjectId?: number;
/** 区域 */
RegionId?: number;
/** 子网ID */
SubnetId?: number;
/** 网络ID */
VpcId?: number;
/** 地区 */
Zone?: string;
/** 状态码, 取值为-2(集群已删除), -1(集群已关闭), 0(集群生产中), 2(集群运行中), 3(集群创建中) */
Status?: number;
/** 实例标签 */
Tags?: Tag[] | null;
/** 告警信息 */
AlarmInfo?: string;
/** 是否是woodpecker集群 */
IsWoodpeckerCluster?: number;
/** Vpc中文 */
VpcName?: string;
/** 子网中文 */
SubnetName?: string;
/** 字符串VpcId */
UniqVpcId?: string;
/** 字符串子网 */
UniqSubnetId?: string;
/** 集群类型 */
ClusterClass?: string;
/** 是否为跨AZ集群 */
IsMultiZoneCluster?: boolean;
/** 是否手戳集群 */
IsHandsCluster?: boolean;
/** 体外客户端组件信息 */
OutSideSoftInfo?: SoftDependInfo[] | null;
/** 当前集群的应用场景是否支持体外客户端 */
IsSupportOutsideCluster?: boolean;
/** 是否专有集群场景集群 */
IsDedicatedCluster?: boolean;
/** 集群支持克隆 */
IsSupportClone?: boolean;
}
/** Emr询价描述 */
declare interface EmrPrice {
/** 刊例价格 */
OriginalCost?: string;
/** 折扣价格 */
DiscountCost?: string;
/** 单位 */
Unit?: string;
/** 询价配置 */
PriceSpec?: PriceResource | null;
/** 是否支持竞价实例 */
SupportSpotPaid?: boolean;
}
/** EMR产品配置 */
declare interface EmrProductConfigDetail {
/** 软件信息 */
SoftInfo?: string[] | null;
/** Master节点个数 */
MasterNodeSize?: number;
/** Core节点个数 */
CoreNodeSize?: number;
/** Task节点个数 */
TaskNodeSize?: number;
/** Common节点个数 */
ComNodeSize?: number;
/** Master节点资源 */
MasterResource?: ResourceDetail | null;
/** Core节点资源 */
CoreResource?: ResourceDetail | null;
/** Task节点资源 */
TaskResource?: ResourceDetail | null;
/** Common节点资源 */
ComResource?: ResourceDetail | null;
/** 是否使用COS */
OnCos?: boolean;
/** 收费类型 */
ChargeType?: number;
/** Router节点个数 */
RouterNodeSize?: number;
/** 是否支持HA */
SupportHA?: boolean;
/** 是否支持安全模式 */
SecurityOn?: boolean;
/** 安全组名称 */
SecurityGroup?: string;
/** 是否开启Cbs加密 */
CbsEncrypt?: number;
/** 自定义应用角色。 */
ApplicationRole?: string;
/** 安全组 */
SecurityGroups?: string[] | null;
/** SSH密钥Id */
PublicKeyId?: string;
}
/** EMR产品配置 */
declare interface EmrProductConfigOutter {
/** 软件信息 */
SoftInfo?: string[] | null;
/** Master节点个数 */
MasterNodeSize?: number | null;
/** Core节点个数 */
CoreNodeSize?: number | null;
/** Task节点个数 */
TaskNodeSize?: number | null;
/** Common节点个数 */
ComNodeSize?: number | null;
/** Master节点资源 */
MasterResource?: OutterResource | null;
/** Core节点资源 */
CoreResource?: OutterResource | null;
/** Task节点资源 */
TaskResource?: OutterResource | null;
/** Common节点资源 */
ComResource?: OutterResource | null;
/** 是否使用COS */
OnCos?: boolean | null;
/** 收费类型 */
ChargeType?: number | null;
/** Router节点个数 */
RouterNodeSize?: number | null;
/** 是否支持HA */
SupportHA?: boolean | null;
/** 是否支持安全模式 */
SecurityOn?: boolean | null;
/** 集群初始安全组id */
SecurityGroup?: string | null;
/** 是否开启Cbs加密 */
CbsEncrypt?: number | null;
/** 自定义应用角色。 */
ApplicationRole?: string | null;
/** 安全组id */
SecurityGroups?: string[] | null;
/** SSH密钥Id */
PublicKeyId?: string | null;
}
/** 执行动作。 */
declare interface Execution {
/** 任务类型,目前支持以下类型。1. “MR”,将通过hadoop jar的方式提交。2. "HIVE",将通过hive -f的方式提交。3. "SPARK",将通过spark-submit的方式提交。 */
JobType: string;
/** 任务参数,提供除提交指令以外的参数。 */
Args: string[];
}
/** 容器集群外部访问设置 */
declare interface ExternalAccess {
/** 外部访问类型,当前仅支持CLB字段 */
Type?: string;
/** CLB设置信息 */
CLBServer?: CLBSetting | null;
}
/** 共用组件信息 */
declare interface ExternalService {
/** 共用组件类型,EMR/CUSTOM */
ShareType: string;
/** 共用组件名 */
Service: string;
/** 共用组件集群 */
InstanceId: string;
/** 自定义参数集合 */
CustomServiceDefineList: CustomServiceDefine[];
}
/** 资源调度-公平调度器的全局配置 */
declare interface FairGlobalConfig {
/** 对应与页面的程序上限 */
UserMaxAppsDefault?: number | null;
}
/** 键值对过滤器,用于条件过滤查询. */
declare interface Filter {
/** 需要过滤的字段。 */
Name?: string;
/** 字段的过滤值。 */
Values?: string[];
}
/** Emr集群列表实例自定义查询过滤 */
declare interface Filters {
/** 字段名称 */
Name: string;
/** 过滤字段值 */
Values: string[];
}
/** 流程额外信息 */
declare interface FlowExtraDetail {
/** 额外信息Title */
Title?: string;
/** 额外信息 */
Detail?: FlowParamsDesc[] | null;
}
/** FlowParam流程参数 */
declare interface FlowParam {
/** 流程参数keyTraceId:通过TraceId查询FlowId: 通过FlowId查询 */
FKey: string;
/** 参数value */
FValue: string;
}
/** 任务参数描述 */
declare interface FlowParamsDesc {
/** 参数key */
PKey?: string;
/** 参数value */
PValue?: string;
}
/** 集群所有伸缩组全局参数信息 */
declare interface GroupGlobalConfs {
/** 伸缩组信息 */
GroupGlobalConf?: AutoScaleResourceConf | null;
/** 当前伸缩组扩容出来的节点数量。 */
CurrentNodes?: number;
/** 当前伸缩组扩容出来的后付费节点数量。 */
CurrentPostPaidNodes?: number;
/** 当前伸缩组扩容出来的竞价实例节点数量。 */
CurrentSpotPaidNodes?: number;
}
/** 用户组信息 */
declare interface GroupInfo {
/** 组名 */
GroupName?: string;
/** 备注 */
Description?: string;
/** 用户列表 */
Users?: string[];
}
/** 用户组信息 */
declare interface GroupInfos {
/** 用户组名称 */
GroupName?: string;
/** 用户名称列表 */
Users?: string[];
/** 备注 */
Description?: string;
/** 创建时间 */
CreateTime?: string;
/** 用户组类型 */
GroupType?: number;
/** 用户组类型描述 */
GroupTypeDesc?: string;
}
/** HBase监控数据结构 */
declare interface HBaseMetricData {
/** 指标名称,如 read_request_rate */
MetricName?: string;
/** 指标描述,如 read request rate */
MetricDesc?: string;
/** 时间戳数组 */
Timestamps?: number[];
/** 数值数组 */
Values?: number[];
}
/** 进程健康状态 */
declare interface HealthStatus {
/** 运行正常 */
Code: number;
/** 运行正常 */
Text: string;
/** 运行正常 */
Desc: string;
}
/** Hive查询详情 */
declare interface HiveQuery {
/** 查询语句 */
Statement?: string;
/** 执行时长 */
Duration?: string;
/** 开始时间毫秒 */
StartTime?: number;
/** 结束时间毫秒 */
EndTime?: number;
/** 状态 */
State?: string;
/** 用户 */
User?: string;
/** appId列表 */
JobIds?: string[] | null;
/** 执行引擎 */
ExecutionEngine?: string;
/** 查询ID */
Id?: string;
}
/** 主机路径 */
declare interface HostPathVolumeSource {
/** 主机路径 */
Path?: string;
/** 主机路径类型,当前默认DirectoryOrCreate */
Type?: string;
}
/** Pod HostPath挂载方式描述 */
declare interface HostVolumeContext {
/** Pod挂载宿主机的目录。资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用 */
VolumePath: string;
}
/** Impala查询详情 */
declare interface ImpalaQuery {
/** 执行语句 */
Statement?: string;
/** 查询ID */
Id?: string;
/** 开始时间 */
StartTime?: number;
/** 运行时间 */
Duration?: string;
/** 结束时间 */
EndTime?: number;
/** 执行状态 */
State?: string;
/** 获取行数 */
RowsFetched?: number;
/** 用户 */
User?: string;
/** 默认DB */
DefaultDB?: string;
/** 执行的Coordinator节点 */
Coordinator?: string;
/** 单节点内存峰值 */
MaxNodePeakMemoryUsage?: string;
/** 查询类型 */
QueryType?: string;
/** 扫描的HDFS行数 */
ScanHDFSRows?: number;
/** 扫描的Kudu行数 */
ScanKUDURows?: number;
/** 扫描的总行数 */
ScanRowsTotal?: number;
/** 读取的总字节数 */
TotalBytesRead?: number;
/** 发送的总字节数 */
TotalBytesSent?: number;
/** CPU总时间 */
TotalCpuTime?: number;
/** 内部数据发送总量(Bytes) */
TotalInnerBytesSent?: number;
/** 内部扫描数据发送总量(Bytes) */
TotalScanBytesSent?: number;
/** 预估单节点内存 */
EstimatedPerHostMemBytes?: number;
/** 从缓存中获取的数据行数 */
NumRowsFetchedFromCache?: number;
/** 会话ID */
SessionId?: string;
/** 单节点内存峰值和(Bytes) */
PerNodePeakMemoryBytesSum?: number;
/** 后端个数 */
BackendsCount?: number;
/** fragment数 */
FragmentInstancesCount?: number;
/** 剩余未完成Fragment数 */
RemainingFragmentCount?: number;
}
/** 洞察结果项 */
declare interface InsightResult {
/** 当Type为HIVE时,是Hive查询ID,当Type为MAPREDUCE,SPARK,TEZ时则是YarnAppID */
ID?: string;
/** 洞察应用的类型,HIVE,SPARK,MAPREDUCE,TEZ */
Type?: string;
/** 洞察规则IDHIVE-ScanManyMeta:元数据扫描过多HIVE-ScanManyPartition:大表扫描HIVE-SlowCompile:编译耗时过长HIVE-UnSuitableConfig:不合理参数MAPREDUCE-MapperDataSkew:Map数据倾斜MAPREDUCE-MapperMemWaste:MapMemory资源浪费MAPREDUCE-MapperSlowTask:Map慢TaskMAPREDUCE-MapperTaskGC:MapperTaskGCMAPREDUCE-MemExceeded:峰值内存超限MAPREDUCE-ReducerDataSkew:Reduce数据倾斜MAPREDUCE-ReducerMemWaste:ReduceMemory资源浪费MAPREDUCE-ReducerSlowTask:Reduce慢TaskMAPREDUCE-ReducerTaskGC:ReducerTaskGCMAPREDUCE-SchedulingDelay:调度延迟SPARK-CpuWaste:CPU资源浪费SPARK-DataSkew:数据倾斜SPARK-ExecutorGC:ExecutorGCSPARK-MemExceeded:峰值内存超限SPARK-MemWaste:Memory资源浪费SPARK-ScheduleOverhead:ScheduleOverheadSPARK-ScheduleSkew:调度倾斜SPARK-SlowTask:慢TaskTEZ-DataSkew:数据倾斜TEZ-MapperDataSkew:Map数据倾斜TEZ-ReducerDataSkew:Reduce数据倾斜TEZ-TezMemWaste:Memory资源浪费TEZ-TezSlowTask:慢TaskTEZ-TezTaskGC:TasksGC */
RuleID?: string;
/** 洞察规则名字,可参考RuleID的说明 */
RuleName?: string;
/** 洞察规则解释 */
RuleExplain?: string;
/** 详情 */
Detail?: string;
/** 建议信息 */
Suggestion?: string;
/** 洞察异常衡量值,同类型的洞察项越大越严重,不同类型的洞察项无对比意义 */
Value?: number;
/** 调度任务执行ID */
ScheduleTaskExecID?: string;
/** 调度流,DAG */
ScheduleFlowName?: string;
/** 调度flow中的某个task节点 */
ScheduleTaskName?: string;
/** Yarn任务的部分核心配置 */
JobConf?: string;
/** 洞察结构化信息 */
Context?: string | null;
}
/** 设置巡检任务配置 */
declare interface InspectionTaskSettings {
/** 巡检任务的唯一标记 */
TaskType: string;
/** 巡检任务组名称 */
Group?: string;
/** 巡检任务名称 */
Name?: string;
/** 巡检任务参数设置 */
TaskSettings?: TaskSettings[];
/** 是否选中,”true“ ”false“ */
Selected?: string;
/** 是否开启监控 */
Enable?: string;
/** 事件Json模板 */
SettingsJson?: string;
}
/** 实例预付费参数,只有在付费类型为PREPAID时生效。 */
declare interface InstanceChargePrepaid {
/** 包年包月时间,默认为1,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10,11, 12, 24, 36, 48, 60。 */
Period: number;
/** 是否自动续费,默认为否。true:是false:否 */
RenewFlag: boolean;
}
/** 代表一个kv结构 */
declare interface Item {
/** 健值 */
Key: string;
/** 值 */
Value: string;
}
/** 键值对组成的列表 */
declare interface ItemSeq {
/** 标签名称 */
Items: Item[] | null;
}
/** 机器资源描述。 */
declare interface JobFlowResource {
/** 机器类型描述。 */
Spec: string;
/** 机器类型描述,可参考CVM的该含义。 */
InstanceType: string;
/** 标签KV对。 */
Tags: Tag[];
/** 磁盘描述列表。 */
DiskGroups: DiskGroup[];
}
/** 流程作业资源描述 */
declare interface JobFlowResourceSpec {
/** 主节点数量。 */
MasterCount: number;
/** 主节点配置。 */
MasterResourceSpec: JobFlowResource;
/** Core节点数量 */
CoreCount: number;
/** Core节点配置。 */
CoreResourceSpec: JobFlowResource;
/** Task节点数量。 */
TaskCount?: number;
/** Common节点数量。 */
CommonCount?: number;
/** Task节点配置。 */
TaskResourceSpec?: JobFlowResource;
/** Common节点配置。 */
CommonResourceSpec?: JobFlowResource;
}
/** 任务步骤结果描述 */
declare interface JobResult {
/** 任务步骤名称。 */
Name: string;
/** 任务步骤失败时的处理策略,可以为以下值:"CONTINUE",跳过当前失败步骤,继续后续步骤。“TERMINATE_CLUSTER”,终止当前及后续步骤,并销毁集群。“CANCEL_AND_WAIT”,取消当前步骤并阻塞等待处理。 */
ActionOnFailure: string;
/** 当前步骤的状态,可以为以下值:“JobFlowStepStatusInit”,初始化状态,等待执行。“JobFlowStepStatusRunning”,任务步骤正在执行。“JobFlowStepStatusFailed”,任务步骤执行失败。“JobFlowStepStatusSucceed”,任务步骤执行成功。 */
JobState: string;
/** YARN任务ID */
ApplicationId?: string;
}
/** 键值对,主要用来做Filter */
declare interface KeyValue {
/** 键 */
Key: string;
/** 值 */
Value: string;
}
/** Kyuubi查询信息 */
declare interface KyuubiQueryInfo {
/** 提交IP */
ClientIP?: string;
/** 执行时长 */
Duration?: number;
/** 结束时间 */
EndTime?: number;
/** Engine Id */
EngineID?: string;
/** 计算引擎 */
EngineType?: string;
/** ID */
Id?: string;
/** Session Id */
SessionID?: string;
/** 开始时间 */
BeginTime?: number;
/** 执行状态 */
ExecutionState?: string;
/** 执行语句 */
ExecutionStatement?: string;
/** Statement Id */
StatementID?: string;
/** 提交用户 */
User?: string;
}
/** 自动扩缩容基于负载指标的规则 */
declare interface LoadAutoScaleStrategy {
/** 规则ID。 */
StrategyId?: number;
/** 规则名称。 */
StrategyName?: string;
/** 规则生效冷却时间。 */
CalmDownTime?: number;
/** 扩缩容动作,1表示扩容,2表示缩容。 */
ScaleAction?: number;
/** 每次规则生效时的扩缩容数量。 */
ScaleNum?: number;
/** 指标处理方法,1表示MAX,2表示MIN,3表示AVG。 */
ProcessMethod?: number;
/** 规则优先级,添加时无效,默认为自增。 */
Priority?: number;
/** 规则状态,1表示启动,3表示禁用。 */
StrategyStatus?: number;
/** 规则扩容指定 yarn node label */
YarnNodeLabel?: string;
/** 规则生效的有效时间 */
PeriodValid?: string;
/** 优雅缩容开关 */
GraceDownFlag?: boolean;
/** 优雅缩容等待时间 */
GraceDownTime?: number;
/** 是否开启任务保护 */
GraceDownProtectFlag?: boolean;
/** 绑定标签列表 */
Tags?: Tag[] | null;
/** 预设配置组 */
ConfigGroupAssigned?: string;
/** 扩容资源计算方法,"DEFAULT","INSTANCE", "CPU", "MEMORYGB"。"DEFAULT"表示默认方式,与"INSTANCE"意义相同。"INSTANCE"表示按照节点计算,默认方式。"CPU"表示按照机器的核数计算。"MEMORYGB"表示按照机器内存数计算。 */
MeasureMethod?: string;
/** 节点部署服务列表,例如["HDFS-3.1.2","YARN-3.1.2"]。 */
SoftDeployDesc?: string[] | null;
/** 启动进程列表,例如["NodeManager"]。 */
ServiceNodeDesc?: string;
/** 启动进程列表。 */
ServiceNodeInfo?: number[] | null;
/** 节点部署服务列表。部署服务仅填写HDFS、YARN。[组件名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760) */
SoftDeployInfo?: number[] | null;
/** 多指标触发条件 */
LoadMetricsConditions?: LoadMetricsConditions | null;
/** 伸缩组Id */
GroupId?: number;
/** soft例如yarn */
Soft?: string;
}
/** 负载指标条件 */
declare interface LoadMetricsCondition {
/** 规则统计周期,提供1min,3min,5min。 */
StatisticPeriod?: number;
/** 触发次数,当连续触发超过TriggerThreshold次后才开始扩缩容。 */
TriggerThreshold?: number;
/** 扩缩容负载指标。 */
LoadMetrics?: string;
/** 规则元数据记录ID。 */
MetricId?: number;
/** 触发条件 */
Conditions?: TriggerCondition[] | null;
}
/** 负载指标 */
declare interface LoadMetricsConditions {
/** 触发规则条件 */
LoadMetrics?: LoadMetricsCondition[] | null;
/** 0:所有条件满足1:满足任意一个 */
Match?: number;
}
/** 登录设置 */
declare interface LoginSettings {
/** 实例登录密码,8-16个字符,包含大写字母、小写字母、数字和特殊字符四种,特殊符号仅支持!@%^*,密码第一位不能为特殊字符 */
Password?: string;
/** 密钥ID。关联密钥后,就可以通过对应的私钥来访问实例;PublicKeyId可通过接口[DescribeKeyPairs](https://cloud.tencent.com/document/api/213/15699)获取 */
PublicKeyId?: string;
}
/** 元数据库信息 */
declare interface MetaDbInfo {
/** 元数据类型。 */
MetaType: string;
/** 统一元数据库实例ID。 */
UnifyMetaInstanceId: string;
/** 自建元数据库信息。 */
MetaDBInfo: CustomMetaInfo;
}
/** 指标tag */
declare interface MetricTags {
/** 指标单位 */
Unit?: string;
/** 指标Type */
Type?: string;
}
/** 强制修改标签 */
declare interface ModifyResourceTags {
/** 集群id 或者 cvm id */
ResourceId: string;
/** 资源6段式表达式 */
Resource: string;
/** 资源前缀 */
ResourcePrefix: string;
/** ap-beijing */
ResourceRegion: string;
/** emr */
ServiceType: string;
/** 删除的标签列表 */
DeleteTags?: Tag[];
/** 添加的标签列表 */
AddTags?: Tag[];
/** 修改的标签列表 */
ModifyTags?: Tag[];
}
/** 定时伸缩每月重复任务策略 */
declare interface MonthRepeatStrategy {
/** 重复任务执行的具体时刻,例如"01:02:00" */
ExecuteAtTimeOfDay: string;
/** 每月中的天数时间段描述,长度只能为2,例如[2,10]表示每月2-10号。 */
DaysOfMonthRange: number[] | null;
}
/** 多云盘参数 */
declare interface MultiDisk {
/** 云盘类型CLOUD_SSD:表示云SSD。CLOUD_PREMIUM:表示高效云盘。CLOUD_HSSD:表示增强型SSD云硬盘。 */
DiskType?: string;
/** 云盘大小 */
Volume?: number;
/** 该类型云盘个数 */
Count?: number;
}
/** 多云盘参数 */
declare interface MultiDiskMC {
/** 该类型云盘个数 */
Count: number;
/** 磁盘类型1 :本地盘2 :云硬盘3 : 本地SSD4 : 云SSD5 : 高效云盘6 : 增强型SSD云硬盘11 : 吞吐型云硬盘12 : 极速型SSD云硬盘13 : 通用型SSD云硬盘14 : 大数据型云硬盘15 : 高IO型云硬盘16 : 远端SSD盘 */
Type?: number;
/** 磁盘大小 */
Size?: string;
/** 云盘大小,单位b */
Volume?: number;
}
/** 各个可用区的参数信息 */
declare interface MultiZoneSetting {
/** "master"、"standby"、"third-party" */
ZoneTag?: string;
/** 无 */
VPCSettings?: VPCSettings;
/** 无 */
Placement?: Placement;
/** 无 */
ResourceSpec?: NewResourceSpec;
}
/** 资源描述 */
declare interface NewResourceSpec {
/** 描述Master节点资源 */
MasterResourceSpec?: Resource;
/** 描述Core节点资源 */
CoreResourceSpec?: Resource;
/** 描述Task节点资源 */
TaskResourceSpec?: Resource;
/** Master节点数量 */
MasterCount?: number;
/** Core节点数量 */
CoreCount?: number;
/** Task节点数量 */
TaskCount?: number;
/** 描述Common节点资源 */
CommonResourceSpec?: Resource;
/** Common节点数量 */
CommonCount?: number;
}
/** 节点亲和性设置 */
declare interface NodeAffinity {
/** 节点亲和性-强制调度设置 */
RequiredDuringSchedulingIgnoredDuringExecution?: NodeSelector | null;
/** 节点亲和性-容忍调度 */
PreferredDuringSchedulingIgnoredDuringExecution?: PreferredSchedulingTerm[] | null;
}
/** 用于创建集群价格清单 节点价格详情 */
declare interface NodeDetailPriceResult {
/** 节点类型 master core task common router mysql */
NodeType?: string;
/** 节点组成部分价格详情 */
PartDetailPrice?: PartDetailPriceItem[];
}
/** 节点硬件信息 */
declare interface NodeHardwareInfo {
/** 用户APPID */
AppId?: number;
/** 序列号 */
SerialNo?: string;
/** 机器实例ID */
OrderNo?: string;
/** master节点绑定外网IP */
WanIp?: string;
/** 节点类型。0:common节点;1:master节点;2:core节点;3:task节点 */
Flag?: number;
/** 节点规格 */
Spec?: string;
/** 节点核数 */
CpuNum?: number;
/** 节点内存,单位b */
MemSize?: number;
/** 节点内存描述,单位GB */
MemDesc?: string;
/** 节点所在region */
RegionId?: number;
/** 节点所在Zone */
ZoneId?: number;
/** 申请时间 */
ApplyTime?: string;
/** 释放时间 */
FreeTime?: string;
/** 硬盘大小 */
DiskSize?: string;
/** 节点描述 */
NameTag?: string;
/** 节点部署服务 */
Services?: string;
/** 磁盘类型,1 :本地盘 2 :云硬盘 3 : 本地SSD 4 : 云SSD 5 : 高效云盘 6 : 增强型SSD云硬盘 11 : 吞吐型云硬盘 12 : 极速型SSD云硬盘 13 : 通用型SSD云硬盘 14 : 大数据型云硬盘 15 : 高IO型云硬盘 16 : 远端SSD盘 */
StorageType?: number;
/** 系统盘大小,单位GB */
RootSize?: number;
/** 付费类型,0:按量计费;1:包年包月 */
ChargeType?: number;
/** 数据库IP */
CdbIp?: string;
/** 数据库端口 */
CdbPort?: number;
/** 硬盘容量,单位b */
HwDiskSize?: number;
/** 硬盘容量描述 */
HwDiskSizeDesc?: string;
/** 内存容量,单位b */
HwMemSize?: number;
/** 内存容量描述 */
HwMemSizeDesc?: string;
/** 过期时间 */
ExpireTime?: string;
/** 节点资源ID */
EmrResourceId?: string;
/** 续费标志 */
IsAutoRenew?: number;
/** 设备标识 */
DeviceClass?: string;
/** 支持变配 */
Mutable?: number;
/** 多云盘 */
MCMultiDisk?: MultiDiskMC[] | null;
/** 数据库信息 */
CdbNodeInfo?: CdbInfo | null;
/** 内网IP */
Ip?: string;
/** 此节点是否可销毁,1可销毁,0不可销毁 */
Destroyable?: number;
/** 节点绑定的标签 */
Tags?: Tag[] | null;
/** 是否是自动扩缩容节点,0为普通节点,1为自动扩缩容节点。 */
AutoFlag?: number;
/** 资源类型, host/pod */
HardwareResourceType?: string;
/** 是否浮动规格,1是,0否 */
IsDynamicSpec?: number;
/** 浮动规格值json字符串 */
DynamicPodSpec?: string;
/** 是否支持变更计费类型 1是,0否 */
SupportModifyPayMode?: number;
/** 系统盘类型,1 :本地盘 2 :云硬盘 3 : 本地SSD 4 : 云SSD 5 : 高效云盘 6 : 增强型SSD云硬盘 11 : 吞吐型云硬盘 12 : 极速型SSD云硬盘 13 : 通用型SSD云硬盘 14 : 大数据型云硬盘 15 : 高IO型云硬盘 16 : 远端SSD盘 */
RootStorageType?: number;
/** 可用区信息 */
Zone?: string;
/** 子网 */
SubnetInfo?: SubnetInfo | null;
/** 客户端 */
Clients?: string;
/** 系统当前时间 */
CurrentTime?: string;
/** 是否用于联邦 ,1是,0否 */
IsFederation?: number;
/** 设备名称 */
DeviceName?: string;
/** 服务 */
ServiceClient?: string;
/** 该实例是否开启实例保护,true为开启 false为关闭 */
DisableApiTermination?: boolean;
/** 0表示老计费,1表示新计费 */
TradeVersion?: number;
/** 各组件状态,Zookeeper:STARTED,ResourceManager:STARTED,STARTED已启动,STOPED已停止 */
ServicesStatus?: string;
/** 备注 */
Remark?: string;
/** 共享集群id */
SharedClusterId?: string;
/** 共享集群id描述 */
SharedClusterIdDesc?: string;
/** 是否是定时销毁资源 */
TimingResource?: boolean;
/** 资源类型(HardwareResourceType)为pod时,对应的TKE集群id */
TkeClusterId?: string;
/** 新挂磁盘时可支持配置的服务名称列表 */
ConfigurableServices?: string[];
/** 节点标注信息,目前只提供给tf平台使用 */
NodeMark?: string;
/** 包销资源是否支持设置自动续费 */
UnderwriteSetAutoRenew?: boolean;
/** Gpu信息 */
GpuDesc?: string;
}
/** 节点标记信息 */
declare interface NodeMark {
/** 节点类型:master,core,task,router */
NodeType?: string;
/** 节点标记信息,目前只提供给tf平台使用,作为入参区分同类型节点信息 */
NodeNames?: string[];
/** 可用区名称 */
Zone?: string;
}
/** 节点续费询价明细 */
declare interface NodeRenewPriceDetail {
/** 计费类型,包月为1、包销为3 */
ChargeType?: number;
/** emr资源id */
EmrResourceId?: string;
/** 节点类型 */
NodeType?: string;
/** 节点内网ip */
Ip?: string;
/** 当前到期时间 */
ExpireTime?: string;
/** 原价 */
OriginalCost?: number;
/** 折扣价 */
DiscountCost?: number;
/** 节点子项续费询价明细列表 */
RenewPriceDetails?: RenewPriceDetail[];
}
/** 规格管理,规格类型描述 */
declare interface NodeResource {
/** 配置Id */
ResourceConfigId?: number;
/** Resource */
Resource?: Resource | null;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 是否默认配置,DEFAULT,BACKUP */
IsDefault?: string;
/** 该类型剩余 */
MaxResourceNum?: number;
/** 支持的包销时长 */
PrepaidUnderwritePeriods?: number[] | null;
}
/** 资源详情 */
declare interface NodeResourceSpec {
/** 规格类型,如S2.MEDIUM8 */
InstanceType: string;
/** 系统盘,系统盘个数不超过1块 */
SystemDisk: DiskSpecInfo[] | null;
/** 需要绑定的标签列表 */
Tags?: Tag[] | null;
/** 云数据盘,云数据盘总个数不超过15块 */
DataDisk?: DiskSpecInfo[] | null;
/** 本地数据盘 */
LocalDataDisk?: DiskSpecInfo[] | null;
}
/** Pod强制调度节点选择条件 */
declare interface NodeSelector {
/** Pod强制调度节点选择条件 */
NodeSelectorTerms?: NodeSelectorTerm[] | null;
}
/** Pod节点选择项 */
declare interface NodeSelectorRequirement {
/** 节点选择项Key值 */
Key?: string;
/** 节点选择项Operator值,支持In, NotIn, Exists, DoesNotExist. Gt, and Lt. */
Operator?: string;
/** 节点选择项Values值 */
Values?: string[] | null;
}
/** Pod节点选择项集合 */
declare interface NodeSelectorTerm {
/** 节点选择项表达式集合 */
MatchExpressions?: NodeSelectorRequirement[] | null;
}
/** 节点磁盘类型 */
declare interface NodeSpecDisk {
/** 数量 */
Count?: number;
/** 名字 */
Name?: string;
/** 磁盘类型 */
DiskType?: string;
/** 指定磁盘大小 */
DefaultDiskSize?: number;
/** 是否为特殊的数据盘,如:单副本盘 */
IsSpecialDisk?: boolean;
}
/** 节点磁盘类型 */
declare interface NodeSpecDiskV2 {
/** 数量 */
Count?: number;
/** 名字 */
Name?: string;
/** 磁盘类型 */
DiskType?: string;
/** 指定磁盘大小 */
DefaultDiskSize?: number;
}
/** 节点机型列族 */
declare interface NodeSpecFamily {
/** 机型 */
InstanceFamily: string;
/** 机型名称 */
FamilyName: string;
/** 排序 */
Order?: number;
/** InstanceType的列表 */
InstanceTypes?: NodeSpecInstanceType[] | null;
}
/** 节点规格类型 */
declare interface NodeSpecInstanceType {
/** 规格 */
InstanceType: string;
/** 4 */
Cpu: number;
/** 8,单位G */
Memory: number;
/** 排序,越小排的越前 */
Order?: number;
/** 数量 */
Num?: number;
/** 售罄原因 */
SellOutReason?: string;
/** 系统盘 */
SystemDisk?: NodeSpecDisk[] | null;
/** 数据盘 */
DataDisk?: NodeSpecDisk[] | null;
/** 本地数据盘 */
LocalDataDisk?: NodeSpecDisk[] | null;
/** 售罄原因 */
SoldOutReason?: string;
/** 机型类别 */
InstanceFamily?: string;
/** 节点名称 */
NodeName?: string;
/** 节点类型 */
NodeType?: string;
/** 类别 */
Type?: string;
/** 类别名称 */
TypeName?: string;
/** 类别分类 */
FamilyName?: string;
/** cpu类型 */
CpuType?: string;
/** 售罄 RunOut、库存少 Less、充足 Enough */
Remark?: string;
/** 原价 */
OriginPrice?: number;
/** 包销计费机型支持的购买时长 */
PrepaidUnderwritePeriods?: number[] | null;
/** GPU信息 */
GpuDesc?: string;
}
/** 节点机型类型 */
declare interface NodeSpecType {
/** 机型序列 */
Type: string;
/** 机型序列名字 */
TypeName: string;
/** 排序 */
Order?: number;
/** InstanceFamily数组 */
InstanceFamilies?: NodeSpecFamily[] | null;
}
/** 弹性扩缩容执行一次规则上下文 */
declare interface NotRepeatStrategy {
/** 该次任务执行的具体完整时间,格式为"2020-07-13 00:00:00" */
ExecuteAt: string;
}
/** 操作范围 */
declare interface OpScope {
/** 操作范围,要操作的服务信息 */
ServiceInfoList?: ServiceBasicRestartInfo[] | null;
}
/** 操作日志描述 */
declare interface OperationLog {
/** EMR实例ID */
InstanceId?: number;
/** 操作名称 */
Operation?: string;
/** 操作类型 */
OperationType?: number;
/** 用户类型 */
UserType?: number;
/** 操作者 */
Operator?: string;
/** 操作时间 */
CreateTime?: string;
/** 操作对象 */
Operand?: string;
/** 操作详情 */
OperationDesc?: string;
/** 安全级别 */
SecurityLevel?: string;
}
/** 描述排序,用于排序. */
declare interface Order {
/** 排序字段。 */
Name?: string;
/** Desc or Asc。 */
Direction?: string;
}
/** 其他账号信息 */
declare interface OtherAccountInfo {
/** 其他账号UIN */
OtherUin?: string | null;
/** 其他账号授权角色名称 */
RoleName?: string | null;
}
/** 资源详情 */
declare interface OutterResource {
/** 规格 */
Spec: string | null;
/** 规格名 */
SpecName: string | null;
/** 硬盘类型 */
StorageType: number | null;
/** 硬盘类型 */
DiskType: string | null;
/** 系统盘大小 */
RootSize: number | null;
/** 内存大小 */
MemSize: number | null;
/** CPU个数 */
Cpu: number | null;
/** 硬盘大小 */
DiskSize: number | null;
/** 规格 */
InstanceType: string | null;
}
/** 概览数据 */
declare interface OverviewMetricData {
/** 指标名 */
Metric?: string;
/** 第一个数据时间戳 */
First?: number;
/** 最后一个数据时间戳 */
Last?: number;
/** 采样点时间间隔 */
Interval?: number;
/** 采样点数据 */
DataPoints?: string[] | null;
/** 指标tags */
Tags?: MetricTags | null;
}
/** Hbase的TableMetric Overview返回 */
declare interface OverviewRow {
/** 表名字 */
Table?: string;
/** 读请求次数 */
ReadRequestCount?: number;
/** 写请求次数 */
WriteRequestCount?: number;
/** 当前memstore的size */
MemstoreSize?: number;
/** 当前region中StroreFile的size */
StoreFileSize?: number;
/** regions,点击可跳转 */
Operation?: string;
/** StoreFile数量 */
StoreFileNum?: number;
}
/** 用于创建集群价格清单-节点组成部分价格 */
declare interface PartDetailPriceItem {
/** 类型包括:节点->node、系统盘->rootDisk、云数据盘->dataDisk、metaDB */
InstanceType?: string;
/** 单价(原价) */
Price?: number;
/** 单价(折扣价) */
RealCost?: number;
/** 总价(折扣价) */
RealTotalCost?: number;
/** 折扣 */
Policy?: number;
/** 数量 */
GoodsNum?: number;
}
/** Serverless HBase包年包月时间 */
declare interface Period {
/** 时间跨度 */
TimeSpan: number;
/** 时间单位,"m"代表月。 */
TimeUnit?: string;
}
/** Pod PVC存储方式描述 */
declare interface PersistentVolumeContext {
/** 磁盘大小,单位为GB。 */
DiskSize?: number;
/** 磁盘类型。CLOUD_PREMIUM;CLOUD_SSD */
DiskType?: string;
/** 磁盘数量 */
DiskNum?: number;
/** 云盘额外性能 */
ExtraPerformance?: number;
}
/** 描述集群实例位置信息 */
declare interface Placement {
/** 实例所属的可用区,例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。 */
Zone: string;
/** 实例所属项目ID。该参数可以通过调用[DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。 */
ProjectId?: number;
}
/** POD自定义权限和自定义参数 */
declare interface PodNewParameter {
/** TKE或EKS集群ID */
InstanceId: string;
/** 自定义权限如:{ "apiVersion": "v1", "clusters": [ { "cluster": { "certificate-authority-data": "xxxxxx==", "server": "https://xxxxx.com" }, "name": "cls-xxxxx" } ], "contexts": [ { "context": { "cluster": "cls-xxxxx", "user": "100014xxxxx" }, "name": "cls-a44yhcxxxxxxxxxx" } ], "current-context": "cls-a4xxxx-context-default", "kind": "Config", "preferences": {}, "users": [ { "name": "100014xxxxx", "user": { "client-certificate-data": "xxxxxx", "client-key-data": "xxxxxx" } } ]} */
Config: string;
/** 自定义参数如:{ "apiVersion": "apps/v1", "kind": "Deployment", "metadata": { "name": "test-deployment", "labels": { "app": "test" } }, "spec": { "replicas": 3, "selector": { "matchLabels": { "app": "test-app" } }, "template": { "metadata": { "annotations": { "your-organization.com/department-v1": "test-example-v1", "your-organization.com/department-v2": "test-example-v2" }, "labels": { "app": "test-app", "environment": "production" } }, "spec": { "nodeSelector": { "your-organization/node-test": "test-node" }, "containers": [ { "name": "nginx", "image": "nginx:1.14.2", "ports": [ { "containerPort": 80 } ] } ], "affinity": { "nodeAffinity": { "requiredDuringSchedulingIgnoredDuringExecution": { "nodeSelectorTerms": [ { "matchExpressions": [ { "key": "disk-type", "operator": "In", "values": [ "ssd", "sas" ] }, { "key": "cpu-num", "operator": "Gt", "values": [ "6" ] } ] } ] } } } } } } } */
Parameter: string;
}
/** 扩容容器资源时的资源描述 */
declare interface PodNewSpec {
/** 外部资源提供者的标识符,例如"cls-a1cd23fa"。 */
ResourceProviderIdentifier: string;
/** 外部资源提供者类型,例如"tke",当前仅支持"tke"。 */
ResourceProviderType: string;
/** 资源的用途,即节点类型,当前仅支持"TASK"。 */
NodeFlag: string;
/** CPU核数。 */
Cpu: number;
/** 内存大小,单位为GB。 */
Memory: number;
/** Eks集群-CPU类型,当前支持"intel"和"amd" */
CpuType?: string;
/** Pod节点数据目录挂载信息。 */
PodVolumes?: PodVolume[];
/** 是否浮动规格,默认否true:代表是false:代表否 */
EnableDynamicSpecFlag?: boolean;
/** 浮动规格 */
DynamicPodSpec?: DynamicPodSpec | null;
/** 代表vpc网络唯一id */
VpcId?: string;
/** 代表vpc子网唯一id */
SubnetId?: string;
/** pod name */
PodName?: string;
/** 其他账号授权信息 */
OtherAccountInfo?: OtherAccountInfo;
}
/** POD自定义权限和自定义参数 */
declare interface PodParameter {
/** TKE或EKS集群ID */
ClusterId: string;
/** 自定义权限如:{ "apiVersion": "v1", "clusters": [ { "cluster": { "certificate-authority-data": "xxxxxx==", "server": "https://xxxxx.com" }, "name": "cls-xxxxx" } ], "contexts": [ { "context": { "cluster": "cls-xxxxx", "user": "100014xxxxx" }, "name": "cls-a44yhcxxxxxxxxxx" } ], "current-context": "cls-a4xxxx-context-default", "kind": "Config", "preferences": {}, "users": [ { "name": "100014xxxxx", "user": { "client-certificate-data": "xxxxxx", "client-key-data": "xxxxxx" } } ]} */
Config: string;
/** 自定义参数如:{ "apiVersion": "apps/v1", "kind": "Deployment", "metadata": { "name": "test-deployment", "labels": { "app": "test" } }, "spec": { "replicas": 3, "selector": { "matchLabels": { "app": "test-app" } }, "template": { "metadata": { "annotations": { "your-organization.com/department-v1": "test-example-v1", "your-organization.com/department-v2": "test-example-v2" }, "labels": { "app": "test-app", "environment": "production" } }, "spec": { "nodeSelector": { "your-organization/node-test": "test-node" }, "containers": [ { "name": "nginx", "image": "nginx:1.14.2", "ports": [ { "containerPort": 80 } ] } ], "affinity": { "nodeAffinity": { "requiredDuringSchedulingIgnoredDuringExecution": { "nodeSelectorTerms": [ { "matchExpressions": [ { "key": "disk-type", "operator": "In", "values": [ "ssd", "sas" ] }, { "key": "cpu-num", "operator": "Gt", "values": [ "6" ] } ] } ] } } } } } } } */
Parameter: string;
}
/** Pod资源售卖规格 */
declare interface PodSaleSpec {
/** 可售卖的资源规格,仅为以下值:"TASK","CORE","MASTER","ROUTER"。 */
NodeType: string;
/** Cpu核数。 */
Cpu: number;
/** 内存数量,单位为GB。 */
Memory: number;
/** 该规格资源可申请的最大数量。 */
Number: number;
}
/** 扩容容器资源时的资源描述 */
declare interface PodSpec {
/** 外部资源提供者的标识符,例如"cls-a1cd23fa"。 */
ResourceProviderIdentifier: string;
/** 外部资源提供者类型,例如"tke",当前仅支持"tke"。 */
ResourceProviderType: string;
/** 资源的用途,即节点类型,当前仅支持"TASK"。 */
NodeType: string;
/** CPU核数。 */
Cpu: number;
/** 内存大小,单位为GB。 */
Memory: number;
/** 资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用。弃用 */
DataVolumes?: string[];
/** Eks集群-CPU类型,当前支持"intel"和"amd" */
CpuType?: string;
/** Pod节点数据目录挂载信息。 */
PodVolumes?: PodVolume[];
/** 是否浮动规格,1是,0否 */
IsDynamicSpec?: number;
/** 浮动规格 */
DynamicPodSpec?: DynamicPodSpec | null;
/** 代表vpc网络唯一id */
VpcId?: string;
/** 代表vpc子网唯一id */
SubnetId?: string;
/** pod name */
PodName?: string;
}
/** Pod相关信息 */
declare interface PodSpecInfo {
/** 使用Pod资源扩容时,指定的Pod规格以及来源等信息 */
PodSpec?: PodNewSpec;
/** POD自定义权限和自定义参数 */
PodParameter?: PodNewParameter;
}
/** 单个pod状态 */
declare interface PodState {
/** pod的名称 */
Name: string;
/** pod uuid */
Uuid: string;
/** pod的状态 */
State: string;
/** pod处于该状态原因 */
Reason: string;
/** pod所属集群 */
OwnerCluster: string;
/** pod内存大小 */
Memory: number;
}
/** Pod的存储设备描述信息。 */
declare interface PodVolume {
/** 存储类型,可为"pvc","hostpath"。 */
VolumeType: string;
/** 当VolumeType为"pvc"时,该字段生效。 */
PVCVolume?: PersistentVolumeContext | null;
/** 当VolumeType为"hostpath"时,该字段生效。 */
HostVolume?: HostVol