tencentcloud-sdk-nodejs
Version:
2,689 lines (2,686 loc) • 241 kB
TypeScript
/**
* AddNodeResourceConfig请求参数结构体
*/
export interface AddNodeResourceConfigRequest {
/**
* 集群实例Id
*/
InstanceId: string;
/**
* 节点类型 CORE TASK ROUTER
*/
ResourceType: string;
/**
* 资源详情
*/
ResourceConfig: Resource;
/**
* 付费模式
*/
PayMode: number;
/**
* 是否默认配置,DEFAULT,BACKUP,不填默认不是默认配置
*/
IsDefault?: string;
/**
* 地域ID
*/
ZoneId?: number;
/**
* 添加多个规格时,第1个规格详情在ResourceConfig参数,第2-n个在MultipleResourceConfig参数
*/
MultipleResourceConfig?: Array<Resource>;
/**
* 类型为ComputeResource和EMR以及默认,默认为EMR
*/
ResourceBaseType?: string;
/**
* 计算资源id
*/
ComputeResourceId?: string;
/**
* 硬件类型
*/
HardwareResourceType?: string;
}
/**
* 定时伸缩每月重复任务策略
*/
export interface MonthRepeatStrategy {
/**
* 重复任务执行的具体时刻,例如"01:02:00"
*/
ExecuteAtTimeOfDay: string;
/**
* 每月中的天数时间段描述,长度只能为2,例如[2,10]表示每月2-10号。
注意:此字段可能返回 null,表示取不到有效值。
*/
DaysOfMonthRange: Array<number | bigint>;
}
/**
* 集群配置。
*/
export interface ClusterSetting {
/**
* 付费方式。
PREPAID 包年包月。
POSTPAID_BY_HOUR 按量计费,默认方式。
*/
InstanceChargeType: string;
/**
* 是否为HA集群。
*/
SupportHA: boolean;
/**
* 集群所使用的安全组,目前仅支持一个。
*/
SecurityGroupIds: Array<string>;
/**
* 实例位置。
*/
Placement: Placement;
/**
* 实例所在VPC。
*/
VPCSettings: VPCSettings;
/**
* 实例登录配置。
*/
LoginSettings: LoginSettings;
/**
* 实例标签,示例:["{\"TagKey\":\"test-tag1\",\"TagValue\":\"001\"}","{\"TagKey\":\"test-tag2\",\"TagValue\":\"002\"}"]。
*/
TagSpecification: Array<string>;
/**
* 元数据库配置。
*/
MetaDB: MetaDbInfo;
/**
* 实例硬件配置。
*/
ResourceSpec: JobFlowResourceSpec;
/**
* 是否申请公网IP,默认为false。
*/
PublicIpAssigned?: boolean;
/**
* 包年包月配置,只对包年包月集群生效。
*/
InstanceChargePrepaid?: InstanceChargePrepaid;
/**
* 集群置放群组。
*/
DisasterRecoverGroupIds?: string;
/**
* 是否使用cbs加密。
*/
CbsEncryptFlag?: boolean;
/**
* 是否使用远程登录,默认为false。
*/
RemoteTcpDefaultPort?: boolean;
}
/**
* ModifyResource返回参数结构体
*/
export interface ModifyResourceResponse {
/**
* 流程traceId
*/
TraceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 可用区配置描述。
*/
export interface ZoneSetting {
/**
* 可用区名称
*/
Zone: string;
/**
* 可用区VPC和子网
*/
VPCSettings: VPCSettings;
/**
* 可用区节点数量
*/
NodeNum: number;
}
/**
* Pod相关信息
*/
export interface PodSpecInfo {
/**
* 使用Pod资源扩容时,指定的Pod规格以及来源等信息
*/
PodSpec?: PodNewSpec;
/**
* POD自定义权限和自定义参数
*/
PodParameter?: PodNewParameter;
}
/**
* ScaleOutInstance请求参数结构体
*/
export interface ScaleOutInstanceRequest {
/**
* 扩容的时间单位。取值范围:
<li>s:表示秒。PayMode取值为0时,TimeUnit只能取值为s。</li>
<li>m:表示月份。PayMode取值为1时,TimeUnit只能取值为m。</li>
*/
TimeUnit: string;
/**
* 扩容的时长。结合TimeUnit一起使用。
<li>TimeUnit为s时,该参数只能填写3600,表示按量计费实例。</li>
<li>TimeUnit为m时,该参数填写的数字表示包年包月实例的购买时长,如1表示购买一个月</li>
*/
TimeSpan: number;
/**
* 实例ID。
*/
InstanceId: string;
/**
* 实例计费模式。取值范围:
<li>0:表示按量计费。</li>
<li>1:表示包年包月。</li>
*/
PayMode: number;
/**
* 唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-****-****-****-fae36063280
*/
ClientToken?: string;
/**
* 引导操作脚本设置。
*/
PreExecutedFileSettings?: Array<PreExecuteFileSettings>;
/**
* 扩容的Task节点数量。
*/
TaskCount?: number;
/**
* 扩容的Core节点数量。
*/
CoreCount?: number;
/**
* 扩容时不需要安装的进程。
*/
UnNecessaryNodeList?: Array<number | bigint>;
/**
* 扩容的Router节点数量。
*/
RouterCount?: number;
/**
* 部署的服务。
<li>SoftDeployInfo和ServiceNodeInfo是同组参数,和UnNecessaryNodeList参数互斥。</li>
<li>建议使用SoftDeployInfo和ServiceNodeInfo组合。</li>
*/
SoftDeployInfo?: Array<number | bigint>;
/**
* 启动的进程。
*/
ServiceNodeInfo?: Array<number | bigint>;
/**
* 分散置放群组ID列表,当前仅支持指定一个。
*/
DisasterRecoverGroupIds?: Array<string>;
/**
* 扩容节点绑定标签列表。
*/
Tags?: Array<Tag>;
/**
* 扩容所选资源类型,可选范围为"HOST","POD","MNode",HOST为普通的CVM资源,POD为TKE集群或EKS集群提供的资源,MNode为全托管资源类型
*/
HardwareResourceType?: string;
/**
* 使用Pod资源扩容时,指定的Pod规格以及来源等信息
*/
PodSpec?: PodSpec;
/**
* 使用clickhouse集群扩容时,选择的机器分组名称
*/
ClickHouseClusterName?: string;
/**
* 使用clickhouse集群扩容时,选择的机器分组类型。new为新增,old为选择旧分组
*/
ClickHouseClusterType?: string;
/**
* 规则扩容指定 yarn node label
*/
YarnNodeLabel?: string;
/**
* POD自定义权限和自定义参数
*/
PodParameter?: PodParameter;
/**
* 扩容的Master节点的数量。
使用clickhouse集群扩容时,该参数不生效。
使用kafka集群扩容时,该参数不生效。
当HardwareResourceType=POD时,该参数不生效。
*/
MasterCount?: number;
/**
* 扩容后是否启动服务,true:启动,false:不启动
*/
StartServiceAfterScaleOut?: string;
/**
* 可用区,默认是集群的主可用区
*/
ZoneId?: number;
/**
* 子网,默认是集群创建时的子网
*/
SubnetId?: string;
/**
* 预设配置组
*/
ScaleOutServiceConfAssign?: string;
/**
* 0表示关闭自动续费,1表示开启自动续费
*/
AutoRenew?: number;
/**
* 类型为ComputeResource和EMR以及默认,默认为EMR,类型为EMR时,InstanceId生效,类型为ComputeResource时,使用ComputeResourceId标识
*/
ResourceBaseType?: string;
/**
* 计算资源id
*/
ComputeResourceId?: string;
}
/**
* Pod资源售卖规格
*/
export interface PodSaleSpec {
/**
* 可售卖的资源规格,仅为以下值:"TASK","CORE","MASTER","ROUTER"。
*/
NodeType: string;
/**
* Cpu核数。
*/
Cpu: number;
/**
* 内存数量,单位为GB。
*/
Memory: number;
/**
* 该规格资源可申请的最大数量。
*/
Number: number;
}
/**
* DescribeHBaseTableOverview请求参数结构体
*/
export interface DescribeHBaseTableOverviewRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 分页查询编号偏移量,从0开始
*/
Offset: number;
/**
* 分页查询时的分页大小,最小1,最大100
*/
Limit: number;
/**
* 表名称,模糊匹配
*/
Table?: string;
/**
* 排序的字段,有默认值
*/
OrderField?: string;
/**
* 默认为降序,asc代表升序,desc代表降序
*/
OrderType?: string;
}
/**
* Pod强制调度节点选择条件
*/
export interface NodeSelector {
/**
* Pod强制调度节点选择条件
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeSelectorTerms?: Array<NodeSelectorTerm>;
}
/**
* DescribeClusterFlowStatusDetail返回参数结构体
*/
export interface DescribeClusterFlowStatusDetailResponse {
/**
* 任务步骤详情
注意:此字段可能返回 null,表示取不到有效值。
*/
StageDetails?: Array<StageInfoDetail>;
/**
* 任务参数
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowDesc?: Array<FlowParamsDesc>;
/**
* 任务名称
*/
FlowName?: string;
/**
* 总任务流程进度:
例如:0.8
*/
FlowTotalProgress?: number;
/**
* 定义流程总状态:
0:初始化,
1:运行中,
2:完成,
3:完成(存在跳过步骤),
-1:失败,
-3:阻塞,
*/
FlowTotalStatus?: number;
/**
* 流程额外信息
NeedExtraDetail为true时返回
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowExtraDetail?: Array<FlowExtraDetail>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RunJobFlow返回参数结构体
*/
export interface RunJobFlowResponse {
/**
* 作业流程ID。
*/
JobFlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* POD浮动规格
*/
export interface DynamicPodSpec {
/**
* 需求最小cpu核数
*/
RequestCpu?: number;
/**
* 需求最大cpu核数
*/
LimitCpu?: number;
/**
* 需求最小memory,单位MB
*/
RequestMemory?: number;
/**
* 需求最大memory,单位MB
*/
LimitMemory?: number;
}
/**
* DescribeHDFSStorageInfo返回参数结构体
*/
export interface DescribeHDFSStorageInfoResponse {
/**
* 采样时间
*/
SampleTime?: number;
/**
* hdfs存储详情
注意:此字段可能返回 null,表示取不到有效值。
*/
StorageSummaryDistribution?: Array<StorageSummaryDistribution>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyUserManagerPwd返回参数结构体
*/
export interface ModifyUserManagerPwdResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Impala查询详情
*/
export 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;
}
/**
* DescribeHiveQueries请求参数结构体
*/
export interface DescribeHiveQueriesRequest {
/**
* 集群ID
*/
InstanceId: string;
/**
* 起始时间秒
*/
StartTime: number;
/**
* 结束时间秒,EndTime-StartTime不得超过1天秒数86400
*/
EndTime: number;
/**
* 分页起始偏移,从0开始
*/
Offset: number;
/**
* 分页大小,合法范围[1,100]
*/
Limit: number;
/**
* 执行状态,ERROR等
*/
State?: Array<string>;
/**
* 结束时间大于的时间点
*/
EndTimeGte?: number;
/**
* 结束时间小于时间点
*/
EndTimeLte?: number;
}
/**
* ModifyPodNum返回参数结构体
*/
export interface ModifyPodNumResponse {
/**
* 集群Id
*/
InstanceId?: string;
/**
* 流程Id
*/
FlowId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateInstance返回参数结构体
*/
export interface CreateInstanceResponse {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Pod PVC存储方式描述
*/
export interface PersistentVolumeContext {
/**
* 磁盘大小,单位为GB。
*/
DiskSize?: number;
/**
* 磁盘类型。CLOUD_PREMIUM;CLOUD_SSD
*/
DiskType?: string;
/**
* 磁盘数量
*/
DiskNum?: number;
/**
* 云盘额外性能
*/
ExtraPerformance?: number;
}
/**
* TerminateTasks返回参数结构体
*/
export interface TerminateTasksResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TerminateTasks请求参数结构体
*/
export interface TerminateTasksRequest {
/**
* 实例ID。
*/
InstanceId: string;
/**
* 待销毁节点的资源ID列表。资源ID形如:emr-vm-xxxxxxxx。有效的资源ID可通过登录[控制台](https://console.cloud.tencent.com/emr)查询。
*/
ResourceIds: Array<string>;
}
/**
* Pod HostPath挂载方式描述
*/
export interface HostVolumeContext {
/**
* Pod挂载宿主机的目录。资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用
*/
VolumePath: string;
}
/**
* DescribeServiceNodeInfos请求参数结构体
*/
export interface DescribeServiceNodeInfosRequest {
/**
* 实例ID
*/
InstanceId: string;
/**
* 页码
*/
Offset?: number;
/**
* 页大小
*/
Limit?: number;
/**
* 搜索字段
*/
SearchText?: string;
/**
* '配置状态,-2:配置失败,-1:配置过期,1:已同步', -99 '全部'
*/
ConfStatus?: number;
/**
* 过滤条件:维护状态
0代表所有状态
1代表正常模式
2代表维护模式
*/
MaintainStateId?: number;
/**
* 过滤条件:操作状态
0代表所有状态
1代表已启动
2代表已停止
*/
OperatorStateId?: number;
/**
* 过滤条件:健康状态
"0"代表不可用
"1"代表良好
"-2"代表未知
"-99"代表所有
"-3"代表存在隐患
"-4"代表未探测
*/
HealthStateId?: string;
/**
* 服务组件名称,都是大写例如YARN
*/
ServiceName?: string;
/**
* 节点名称master,core,task,common,router
*/
NodeTypeName?: string;
/**
* 过滤条件:dn是否处于维护状态
0代表所有状态
1代表处于维护状态
*/
DataNodeMaintenanceId?: number;
/**
* 支持搜索的字段,目前支持 SearchType :ipv4
*/
SearchFields?: Array<SearchItem>;
}
/**
* 节点磁盘信息
*/
export interface DiskSpecInfo {
/**
* 磁盘数量
*/
Count: number;
/**
* 系统盘类型 取值范围:
<li>CLOUD_SSD:表示云SSD。</li>
<li>CLOUD_PREMIUM:表示高效云盘。</li>
<li>CLOUD_BASIC:表示云硬盘。</li>
<li>LOCAL_BASIC:表示本地盘。</li>
<li>LOCAL_SSD:表示本地SSD。</li>
数据盘类型 取值范围:
<li>CLOUD_SSD:表示云SSD。</li>
<li>CLOUD_PREMIUM:表示高效云盘。</li>
<li>CLOUD_BASIC:表示云硬盘。</li>
<li>LOCAL_BASIC:表示本地盘。</li>
<li>LOCAL_SSD:表示本地SSD。</li>
<li>CLOUD_HSSD:表示增强型SSD云硬盘。</li>
<li>CLOUD_THROUGHPUT:表示吞吐型云硬盘。</li>
<li>CLOUD_TSSD:表示极速型SSD云硬盘。</li>
*/
DiskType: string;
/**
* 数据容量,单位为GB
*/
DiskSize: number;
/**
* 额外性能
*/
ExtraPerformance?: number;
}
/**
* Hive查询详情
*/
export interface HiveQuery {
/**
* 查询语句
*/
Statement?: string;
/**
* 执行时长
*/
Duration?: string;
/**
* 开始时间毫秒
*/
StartTime?: number;
/**
* 结束时间毫秒
*/
EndTime?: number;
/**
* 状态
*/
State?: string;
/**
* 用户
*/
User?: string;
/**
* appId列表
注意:此字段可能返回 null,表示取不到有效值。
*/
JobIds?: Array<string>;
/**
* 执行引擎
*/
ExecutionEngine?: string;
/**
* 查询ID
*/
Id?: string;
}
/**
* 资源调度-公平调度器的全局配置
*/
export interface FairGlobalConfig {
/**
* 对应与页面的<p>程序上限</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
UserMaxAppsDefault?: number;
}
/**
* 执行步骤
*/
export interface Step {
/**
* 执行步骤名称。
*/
Name: string;
/**
* 执行动作。
*/
ExecutionStep: Execution;
/**
* 执行失败策略。
1. TERMINATE_CLUSTER 执行失败时退出并销毁集群。
2. CONTINUE 执行失败时跳过并执行后续步骤。
*/
ActionOnFailure: string;
/**
* 指定执行Step时的用户名,非必须,默认为hadoop。
*/
User?: string;
}
/**
* 预执行脚本配置
*/
export interface PreExecuteFileSettings {
/**
* 脚本在COS上路径,已废弃
*/
Path?: string;
/**
* 执行脚本参数
*/
Args?: Array<string>;
/**
* COS的Bucket名称,已废弃
*/
Bucket?: string;
/**
* COS的Region名称,已废弃
*/
Region?: string;
/**
* COS的Domain数据,已废弃
*/
Domain?: string;
/**
* 执行顺序
*/
RunOrder?: number;
/**
* resourceAfter 或 clusterAfter
*/
WhenRun?: string;
/**
* 脚本文件名,已废弃
*/
CosFileName?: string;
/**
* 脚本的cos地址
*/
CosFileURI?: string;
/**
* cos的SecretId
*/
CosSecretId?: string;
/**
* Cos的SecretKey
*/
CosSecretKey?: string;
/**
* cos的appid,已废弃
*/
AppId?: string;
/**
* 备注
*/
Remark?: string;
}
/**
* 键值对,主要用来做Filter
*/
export interface KeyValue {
/**
* 键
*/
Key: string;
/**
* 值
*/
Value: string;
}
/**
* DescribeServiceNodeInfos返回参数结构体
*/
export interface DescribeServiceNodeInfosResponse {
/**
* 总数量
*/
TotalCnt?: number;
/**
* 进程信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceNodeList?: Array<ServiceNodeDetailInfo>;
/**
* 集群所有节点的别名序列化
*/
AliasInfo?: string;
/**
* 支持的FlagNode列表
注意:此字段可能返回 null,表示取不到有效值。
*/
SupportNodeFlagFilterList?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EMR产品配置
*/
export interface EmrProductConfigDetail {
/**
* 软件信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SoftInfo?: Array<string>;
/**
* Master节点个数
*/
MasterNodeSize?: number;
/**
* Core节点个数
*/
CoreNodeSize?: number;
/**
* Task节点个数
*/
TaskNodeSize?: number;
/**
* Common节点个数
*/
ComNodeSize?: number;
/**
* Master节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
MasterResource?: ResourceDetail;
/**
* Core节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
CoreResource?: ResourceDetail;
/**
* Task节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskResource?: ResourceDetail;
/**
* Common节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
ComResource?: ResourceDetail;
/**
* 是否使用COS
*/
OnCos?: boolean;
/**
* 收费类型
*/
ChargeType?: number;
/**
* Router节点个数
*/
RouterNodeSize?: number;
/**
* 是否支持HA
*/
SupportHA?: boolean;
/**
* 是否支持安全模式
*/
SecurityOn?: boolean;
/**
* 安全组名称
*/
SecurityGroup?: string;
/**
* 是否开启Cbs加密
*/
CbsEncrypt?: number;
/**
* 自定义应用角色。
*/
ApplicationRole?: string;
/**
* 安全组
注意:此字段可能返回 null,表示取不到有效值。
*/
SecurityGroups?: Array<string>;
/**
* SSH密钥Id
*/
PublicKeyId?: string;
}
/**
* 节点子项续费询价明细
*/
export interface RenewPriceDetail {
/**
* 计费项名称
*/
BillingName?: string;
/**
* 折扣
*/
Policy?: number;
/**
* 数量
*/
Quantity?: number;
/**
* 原价
*/
OriginalCost?: number;
/**
* 折扣价
*/
DiscountCost?: number;
}
/**
* ResetYarnConfig请求参数结构体
*/
export interface ResetYarnConfigRequest {
/**
* emr集群的英文id
*/
InstanceId: string;
/**
* 要重置的配置别名,可选值:
- capacityLabel:重置标签管理的配置
- fair:重置公平调度的配置
- capacity:重置容量调度的配置
*/
Key?: string;
}
/**
* 弹性扩缩容按天重复任务描述
*/
export interface DayRepeatStrategy {
/**
* 重复任务执行的具体时刻,例如"01:02:00"
*/
ExecuteAtTimeOfDay: string;
/**
* 每隔Step天执行一次
*/
Step: number;
}
/**
* DescribeTrinoQueryInfo返回参数结构体
*/
export interface DescribeTrinoQueryInfoResponse {
/**
* 总数,分页查询时使用
*/
TotalCount?: number;
/**
* 查询结果数组
注意:此字段可能返回 null,表示取不到有效值。
*/
QueryInfoList?: Array<TrinoQueryInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 询价结果
*/
export interface PriceResult {
/**
* 原价
*/
OriginalCost?: number;
/**
* 折扣价
*/
DiscountCost?: number;
}
/**
* trino 查询信息
*/
export interface TrinoQueryInfo {
/**
* catalog
*/
Catalog?: string;
/**
* 提交IP
*/
ClientIpAddr?: string;
/**
* 切片数
*/
CompletedSplits?: string;
/**
* CPU时间
*/
CpuTime?: number;
/**
* 累计内存
*/
CumulativeMemory?: number;
/**
* 执行时长
*/
DurationMillis?: number;
/**
* 结束时间 (s)
*/
EndTime?: number;
/**
* 查询ID
*/
Id?: string;
/**
* 内部传输量
*/
InternalNetworkBytes?: number;
/**
* 输出字节数
*/
OutputBytes?: number;
/**
* 峰值内存量
*/
PeakUserMemoryBytes?: number;
/**
* 物理输入量
*/
PhysicalInputBytes?: number;
/**
* 处理输入量
*/
ProcessedInputBytes?: number;
/**
* 编译时长
*/
SqlCompileTime?: number;
/**
* 开始时间 (s)
*/
StartTime?: number;
/**
* 执行状态
*/
State?: string;
/**
* 执行语句
*/
Statement?: string;
/**
* 提交用户
*/
User?: string;
/**
* 写入字节数
*/
WrittenBytes?: number;
}
/**
* Pod容忍调度节点选择项
*/
export interface PreferredSchedulingTerm {
/**
* 权重,范围1-100
*/
Weight?: number;
/**
* 节点选择表达式
注意:此字段可能返回 null,表示取不到有效值。
*/
Preference?: NodeSelectorTerm;
}
/**
* spark查询详情
*/
export interface SparkQuery {
/**
* 执行语句
*/
Statement?: string;
/**
* 执行时长(单位毫秒)
*/
Duration?: number;
/**
* 执行状态
*/
Status?: string;
/**
* 查询ID
*/
Id?: string;
/**
* 扫描分区数
*/
ScanPartitionNum?: number;
/**
* 扫描总行数
*/
ScanRowNum?: number;
/**
* 扫描总文件数
*/
ScanFileNum?: number;
/**
* 查询扫描总数据量(单位B)
*/
ScanTotalData?: number;
/**
* 应用ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationId?: Array<string>;
/**
* 输出总行数
*/
OutputRowNum?: number;
/**
* 输出总文件数
*/
OutputFileNum?: number;
/**
* 输出分区数
*/
OutputPartitionNum?: number;
/**
* 输出总数据量(单位B)
*/
OutputTotalData?: number;
/**
* 开始时间
*/
BeginTime?: number;
/**
* 结束时间
*/
EndTime?: number;
}
/**
* 采样序列
*/
export interface Dps {
/**
* 时间戳
*/
Timestamp?: string;
/**
* 采样值
*/
Value?: string;
}
/**
* DescribeSparkQueries请求参数结构体
*/
export interface DescribeSparkQueriesRequest {
/**
* 集群ID
*/
InstanceId: string;
/**
* 开始时间
*/
StartTime: number;
/**
* 结束时间
*/
EndTime: number;
/**
* 分页起始偏移,从0开始
*/
Offset: number;
/**
* 分页大小,合法范围[1,100]
*/
Limit: number;
/**
* 执行状态:RUNNING,COMPLETED,FAILED
*/
Status?: Array<string>;
}
/**
* DeleteAutoScaleStrategy返回参数结构体
*/
export interface DeleteAutoScaleStrategyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Hbase的TableMetric Overview返回
*/
export interface OverviewRow {
/**
* 表名字
*/
Table?: string;
/**
* 读请求次数
*/
ReadRequestCount?: number;
/**
* 写请求次数
*/
WriteRequestCount?: number;
/**
* 当前memstore的size
*/
MemstoreSize?: number;
/**
* 当前region中StroreFile的size
*/
StoreFileSize?: number;
/**
* regions,点击可跳转
*/
Operation?: string;
}
/**
* 磁盘描述。
*/
export interface DiskSpec {
/**
* 磁盘类型。
LOCAL_BASIC 本地盘。
CLOUD_BASIC 云硬盘。
LOCAL_SSD 本地SSD。
CLOUD_SSD 云SSD。
CLOUD_PREMIUM 高效云盘。
CLOUD_HSSD 增强型云SSD。
*/
DiskType: string;
/**
* 磁盘大小,单位GB。
*/
DiskSize: number;
}
/**
* 自动扩缩容基于负载指标的规则
*/
export 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;
/**
* 绑定标签列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 预设配置组
*/
ConfigGroupAssigned?: string;
/**
* 扩容资源计算方法,"DEFAULT","INSTANCE", "CPU", "MEMORYGB"。
"DEFAULT"表示默认方式,与"INSTANCE"意义相同。
"INSTANCE"表示按照节点计算,默认方式。
"CPU"表示按照机器的核数计算。
"MEMORYGB"表示按照机器内存数计算。
*/
MeasureMethod?: string;
/**
* 节点部署服务列表,例如["HDFS-3.1.2","YARN-3.1.2"]。
注意:此字段可能返回 null,表示取不到有效值。
*/
SoftDeployDesc?: Array<string>;
/**
* 启动进程列表,例如["NodeManager"]。
*/
ServiceNodeDesc?: string;
/**
* 启动进程列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceNodeInfo?: Array<number | bigint>;
/**
* 节点部署服务列表。部署服务仅填写HDFS、YARN。[组件名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760)
注意:此字段可能返回 null,表示取不到有效值。
*/
SoftDeployInfo?: Array<number | bigint>;
/**
* 多指标触发条件
注意:此字段可能返回 null,表示取不到有效值。
*/
LoadMetricsConditions?: LoadMetricsConditions;
/**
* 伸缩组Id
*/
GroupId?: number;
/**
* soft例如yarn
*/
Soft?: string;
}
/**
* ModifyPodNum请求参数结构体
*/
export interface ModifyPodNumRequest {
/**
* 集群Id
*/
InstanceId: string;
/**
* 服务编号
*/
ServiceGroup: number;
/**
* 角色编号
*/
ServiceType: number;
/**
* 期望Pod数量
*/
PodNum: number;
}
/**
* Serverless HBase实例信息
*/
export interface SLInstanceInfo {
/**
* 集群实例字符串ID
*/
ClusterId?: string;
/**
* 集群实例数字ID
*/
Id?: number;
/**
* 状态描述
*/
StatusDesc?: string;
/**
* 健康状态
*/
HealthStatus?: string;
/**
* 实例名称
*/
ClusterName?: string;
/**
* 地域ID
*/
RegionId?: number;
/**
* 主可用区ID
*/
ZoneId?: number;
/**
* 主可用区
*/
Zone?: string;
/**
* 用户APPID
*/
AppId?: number;
/**
* 主可用区私有网络ID
*/
VpcId?: number;
/**
* 主可用区子网ID
*/
SubnetId?: number;
/**
* 状态码
*/
Status?: number;
/**
* 创建时间
*/
AddTime?: string;
/**
* 集群计费类型。0表示按量计费,1表示包年包月
*/
PayMode?: number;
/**
* 多可用区信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneSettings?: Array<ZoneSetting>;
/**
* 实例标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 自动续费标记, 0:表示通知即将过期,但不自动续费 1:表示通知即将过期,而且自动续费 2:表示不通知即将过期,也不自动续费,若业务无续费概念,设置为0
*/
AutoRenewFlag?: number;
/**
* 隔离时间,未隔离返回0000-00-00 00:00:00。
*/
IsolateTime?: string;
/**
* 过期时间,后付费返回0000-00-00 00:00:00
*/
ExpireTime?: string;
}
/**
* 资源调度的默认设置
*/
export interface DefaultSetting {
/**
* 名称,作为入参的key
*/
Name?: string;
/**
* 描述
*/
Desc?: string;
/**
* 提示
*/
Prompt?: string;
/**
* key,用于展示,该配置对应与配置文件中的配置项
*/
Key?: string;
/**
* Name对应的值
*/
Value?: string;
}
/**
* COS 相关配置
*/
export interface COSSettings {
/**
* COS SecretId
*/
CosSecretId: string;
/**
* COS SecrectKey
*/
CosSecretKey: string;
/**
* 日志存储在COS上的路径
*/
LogOnCosPath?: string;
}
/**
* 集群实例信息
*/
export interface ClusterInstancesInfo {
/**
* ID号
*/
Id?: number;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 标题
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Ftitle?: string;
/**
* 集群名
*/
ClusterName?: string;
/**
* 地域ID
*/
RegionId?: number;
/**
* 地区ID
*/
ZoneId?: number;
/**
* 用户APPID
*/
AppId?: number;
/**
* 用户UIN
*/
Uin?: string;
/**
* 项目Id
*/
ProjectId?: number;
/**
* 集群VPCID
*/
VpcId?: number;
/**
* 子网ID
*/
SubnetId?: number;
/**
* 实例的状态码。取值范围:
<li>2:表示集群运行中。</li>
<li>3:表示集群创建中。</li>
<li>4:表示集群扩容中。</li>
<li>5:表示集群增加router节点中。</li>
<li>6:表示集群安装组件中。</li>
<li>7:表示集群执行命令中。</li>
<li>8:表示重启服务中。</li>
<li>9:表示进入维护中。</li>
<li>10:表示服务暂停中。</li>
<li>11:表示退出维护中。</li>
<li>12:表示退出暂停中。</li>
<li>13:表示配置下发中。</li>
<li>14:表示销毁集群中。</li>
<li>15:表示销毁core节点中。</li>
<li>16:销毁task节点中。</li>
<li>17:表示销毁router节点中。</li>
<li>18:表示更改webproxy密码中。</li>
<li>19:表示集群隔离中。</li>
<li>20:表示集群冲正中。</li>
<li>21:表示集群回收中。</li>
<li>22:表示变配等待中。</li>
<li>23:表示集群已隔离。</li>
<li>24:表示缩容节点中。</li>
<li>33:表示集群等待退费中。</li>
<li>34:表示集群已退费。</li>
<li>301:表示创建失败。</li>
<li>302:表示扩容失败。</li>
*/
Status?: number;
/**
* 添加时间
*/
AddTime?: string;
/**
* 已经运行时间
*/
RunTime?: string;
/**
* 集群产品配置信息
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
Config?: EmrProductConfigOutter;
/**
* 主节点外网IP
*/
MasterIp?: string;
/**
* EMR版本
*/
EmrVersion?: string;
/**
* 收费类型
*/
ChargeType?: number;
/**
* 交易版本
*/
TradeVersion?: number;
/**
* 资源订单ID
*/
ResourceOrderId?: number;
/**
* 是否计费集群
*/
IsTradeCluster?: number;
/**
* 集群错误状态告警信息
*/
AlarmInfo?: string;
/**
* 是否采用新架构
*/
IsWoodpeckerCluster?: number;
/**
* 元数据库信息
*/
MetaDb?: string;
/**
* 标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 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;
/**
* 集群依赖关系
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterExternalServiceInfo?: Array<ClusterExternalServiceInfo>;
/**
* 集群vpcid 字符串类型
*/
UniqVpcId?: string;
/**
* 子网id 字符串类型
*/
UniqSubnetId?: string;
/**
* 节点信息
注意:此字段可能返回 null,表示取不到有效值。
*/
TopologyInfoList?: Array<TopologyInfo>;
/**
* 是否是跨AZ集群
*/
IsMultiZoneCluster?: boolean;
/**
* 是否开通异常节点自动补偿
*/
IsCvmReplace?: boolean;
/**
* 标题
*/
ClusterTitle?: string;
/**
* 集群产品配置信息
注意:此字段可能返回 null,表示取不到有效值。
*/
ConfigDetail?: EmrProductConfigDetail;
/**
* 集群绑定的文件系统数
*/
BindFileSystemNum?: number;
/**
* rss集群的绑定列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterRelationInfoList?: Array<ClusterRelationMeta>;
}
/**
* ModifyResourcesTags返回参数结构体
*/
export interface ModifyResourcesTagsResponse {
/**
* 成功的资源id列表
注意:此字段可能返回 null,表示取不到有效值。
*/
SuccessList?: Array<string>;
/**
* 失败的资源id列表
注意:此字段可能返回 null,表示取不到有效值。
*/
FailList?: Array<string>;
/**
* 部分成功的资源id列表
注意:此字段可能返回 null,表示取不到有效值。
*/
PartSuccessList?: Array<string>;
/**
* 集群id与流程id的映射列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterToFlowIdList?: Array<ClusterIDToFlowID>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateCloudInstance返回参数结构体
*/
export interface CreateCloudInstanceResponse {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RunJobFlow请求参数结构体
*/
export interface RunJobFlowRequest {
/**
* 作业名称。
*/
Name: string;
/**
* 是否新创建集群。
true,新创建集群,则使用Instance中的参数进行集群创建。
false,使用已有集群,则通过InstanceId传入。
*/
CreateCluster: boolean;
/**
* 作业流程执行步骤。
*/
Steps: Array<Step>;
/**
* 作业流程正常完成时,集群的处理方式,可选择:
Terminate 销毁集群。
Reserve 保留集群。
*/
InstancePolicy: string;
/**
* 只有CreateCluster为true时生效,目前只支持EMR版本,例如EMR-2.2.0,不支持ClickHouse和Druid版本。
*/
ProductVersion?: string;
/**
* 只在CreateCluster为true时生效。
true 表示安装kerberos,false表示不安装kerberos。
*/
SecurityClusterFlag?: boolean;
/**
* 只在CreateCluster为true时生效。
新建集群时,要安装的软件列表。
*/
Software?: Array<string>;
/**
* 引导脚本。
*/
BootstrapActions?: Array<BootstrapAction>;
/**
* 指定配置创建集群。
*/
Configurations?: Array<Configuration>;
/**
* 作业日志保存地址。
*/
LogUri?: string;
/**
* 只在CreateCluster为false时生效。
*/
InstanceId?: string;
/**
* 自定义应用角色,大数据应用访问外部服务时使用的角色,默认为"EME_QCSRole"。
*/
ApplicationRole?: string;
/**
* 重入标签,用来可重入检查,防止在一段时间内,创建相同的流程作业。
*/
ClientToken?: string;
/**
* 只在CreateCluster为true时生效,使用该配置创建集群。
*/
Instance?: ClusterSetting;
}
/**
* DescribeInstanceRenewNodes返回参数结构体
*/
export interface DescribeInstanceRenewNodesResponse {
/**
* 查询到的节点总数
*/
TotalCnt?: number;
/**
* 节点详细信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeList?: Array<RenewInstancesInfo>;
/**
* 用户所有的标签键列表
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaInfo?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Kyuubi查询信息
*/
export 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;
}
/**
* DescribeHBaseTableOverview返回参数结构体
*/
export interface DescribeHBaseTableOverviewResponse {
/**
* 概览数据数组
*/
TableMonitorList?: Array<OverviewRow>;
/**
* 概览数据数组长度
*/
TotalCount?: number;
/**
* 表schema信息
*/
SchemaList?: Array<TableSchemaItem>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAutoScaleGroupGlobalConf请求参数结构体
*/
export interface DescribeAutoScaleGroupGlobalConfRequest {
/**
* 实例ID。
*/
InstanceId: string;
}
/**
* ModifyAutoScaleStrategy请求参数结构体
*/
export interface ModifyAutoScaleStrategyRequest {
/**
* 实例ID。
*/
InstanceId: string;
/**
* 自动扩缩容规则类型,1表示按负载指标扩缩容,2表示按时间扩缩容。
*/
StrategyType: number;
/**
* 按负载扩缩容的指标。
*/
LoadAutoScaleStrategies?: Array<LoadAutoScaleStrategy>;
/**
* 按时间扩缩容的规则。
*/
TimeAutoScaleStrategies?: Array<TimeAutoScaleStrategy>;
/**
* 伸缩组Id
*/
GroupId?: number;
}
/**
* 任务参数描述
*/
export interface FlowParamsDesc {
/**
* 参数key
*/
PKey?: string;
/**
* 参数value
*/
PValue?: string;
}
/**
* AttachDisks请求参数结构体
*/
export interface AttachDisksRequest {
/**
* EMR集群实例ID
*/
InstanceId: string;
/**
* 需要挂载的云盘ID
*/
DiskIds?: Array<string>;
/**
* 挂载模式,取值范围:
AUTO_RENEW:自动续费
ALIGN_DEADLINE:自动对其到期时间
*/
AlignType?: string;
/**
* 需要挂载的cvm节点id列表
*/
CvmInstanceIds?: Array<string>;
/**
* 是否是新购云盘进行挂载
*/
CreateDisk?: boolean;
/**
* 新购云盘规格
*/
DiskSpec?: NodeSpecDiskV2;
/**
* 可选参数,不传该参数则仅执行挂载操作。传入True时,会在挂载成功后将云硬盘设置为随云主机销毁模式,仅对按量计费云硬盘有效。
*/
DeleteWithInstance?: boolean;
/**
* 新挂磁盘时可支持配置的服务名称列表
*/
SelectiveConfServices?: Array<string>;
}
/**
* DescribeInstances返回参数结构体
*/
export interface DescribeInstancesResponse {
/**
* 符合条件的实例总数。
*/
TotalCnt?: number;
/**
* EMR实例详细信息列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterList?: Array<ClusterInstancesInfo>;
/**
* 实例关联的标签键列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
TagKeys?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyYarnDeploy返回参数结构体
*/
export interface ModifyYarnDeployResponse {
/**
* 为false不点亮部署生效、重置
*/
IsDraft?: boolean;
/**
* 错误信息,预留
*/
ErrorMsg?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyResourceScheduleConfig返回参数结构体
*/
export interface ModifyResourceScheduleConfigResponse {
/**
* true为草稿,表示还没有刷新资源池
*/
IsDraft?: boolean;
/**
* 校验错误信息,如果不为空,则说明校验失败,配置没有成功
*/
ErrorMsg?: string;
/**
* 返回数据
*/
Data?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 洞察结果项
*/
export interface InsightResult {
/**
* 当Type为HIVE时,是Hive查询ID,当Type为MAPREDUCE,SPARK,TEZ时则是YarnAppID
*/
ID?: string;
/**
* 洞察应用的类型,HIVE,SPARK,MAPREDUCE,TEZ
*/
Type?: string;
/**
* 洞察规则ID
HIVE-ScanManyMeta:元数据扫描过多
HIVE-ScanManyPartition:大表扫描
HIVE-SlowCompile:编译耗时过长
HIVE-UnSuitableConfig:不合理参数
MAPREDUCE-MapperDataSkew:Map数据倾斜
MAPREDUCE-MapperMemWaste:MapMemory资源浪费
MAPREDUCE-MapperSlowTask:Map慢Task
MAPREDUCE-MapperTaskGC:MapperTaskGC
MAPREDUCE-MemExceeded:峰值内存超限
MAPREDUCE-ReducerDataSkew:Reduce数据倾斜
MAPREDUCE-ReducerMemWaste:ReduceMemory资源浪费
MAPREDUCE-ReducerSlowTask:Reduce慢Task
MAPREDUCE-ReducerTaskGC:ReducerTaskGC
MAPREDUCE-SchedulingDelay:调度延迟
SPARK-CpuWaste:CPU资源浪费
SPARK-DataSkew:数据倾斜
SPARK-ExecutorGC:ExecutorGC
SPARK-MemExceeded:峰值内存超限
SPARK-MemWaste:Memory资源浪费
SPARK-ScheduleOverhead:ScheduleOverhead
SPARK-ScheduleSkew:调度倾斜
SPARK-SlowTask:慢Task
TEZ-DataSkew:数据倾斜
TEZ-MapperDataSkew:Map数据倾斜
TEZ-ReducerDataSkew:Reduce数据倾斜
TEZ-TezMemWaste:Memory资源浪费
TEZ-TezSlowTask:慢Task
TEZ-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;
/**
* 洞察结构化信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Context?: string;
}
/**
* 用于创建集群价格清单 节点价格详情
*/
export interface NodeDetailPriceResult {
/**
* 节点类型 master core task common router mysql
*/
NodeType?: string;
/**
* 节点组成部分价格详情
*/
PartDetailPrice?: Array<PartDetailPriceItem>;
}
/**
* 容器集群用户组信息
*/
export interface UserAndGroup {
/**
* 用户名
*/
UserName: string;
/**
* 用户组
*/
UserGroup: string;
}
/**
* 数据卷目录设置
*/
export interface VolumeSetting {
/**
* 数据卷类型
<li>HOST_PATH表示支持本机路径</li>
<li>NEW_PVC表示新建PVC</li>
组件角色支持的数据卷类型可参考 EMR on TKE 集群部署说明:[部署说明](https://cloud.tencent.com/document/product/589/94254)
*/
VolumeType?: string;
/**
* 主机路径信息
注意:此字段可能返回 null,表示取不到有效值。
*/
HostPath?: HostPathVolumeSource;
}
/**
* 标签
*/
export interface Tag {
/**
* 标签键
*/
TagKey?: string;
/**
* 标签值
*/
TagValue?: string;
}
/**
* DescribeKyuubiQueryInfo返回参数结构体
*/
export interface DescribeKyuubiQueryInfoResponse {
/**
* 总数,分页查询时使用
*/
TotalCount?: number;
/**
* Kyuubi查询信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
KyuubiQueryInfoList?: Array<KyuubiQueryInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TerminateSLInstance请求参数结构体
*/
export interface TerminateSLInstanceRequest {
/**
* 实例唯一标识符(字符串表示)
*/
InstanceId: string;
}
/**
* 通用的参数
*/
export interface Arg {
/**
* key
*/
Key?: string;
/**
* 值列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Values?: Array<string>;
}
/**
* 集群id与流程id的mapping
*/
export interface ClusterIDToFlowID {
/**
* 集群id
*/
ClusterId?: string;
/**
* 流程id
*/
FlowId?: number;
}
/**
* 集群列表返回示例
*/
export 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;
/**
* 实例标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 告警信息
*/
AlarmInfo?: string;
/**
* 是否是woodpecker集群
*/
IsWoodpeckerCluster?: number;
/**
* Vpc中文
*/
VpcName?: string;
/**
* 子网中文
*/
SubnetName?: string;
/**
* 字符串VpcId
*/
UniqVpcId?: string;
/**
* 字符串子网
*/
UniqSubnetId?: string;
/**
* 集群类型
*/
ClusterClass?: string;
/**
* 是否为跨AZ集群
*/
IsMultiZoneCluster?: boolean;
/**
* 是否手戳集群
*/
IsHandsCluster?: boolean;
/**
* 体外客户端组件信息
注意:此字段可能返回 null,表示取不到有效值。
*/
OutSideSoftInfo?: Array<SoftDependInfo>;
/**
* 当前集群的应用场景是否支持体外客户端
*/
IsSupportOutsideCluster?: boolean;
/**
* 是否专有集群场景集群
*/
IsDedicatedCluster?: boolean;
/**
* 集群支持克隆
*/
IsSupportClone?: boolean;
}
/**
* 磁盘信息
*/
export interface Disk {
/**
* 数据盘类型,创建EMR容器集群实例可选
<li> SSD云盘: CLOUD_SSD</li>
<li>高效云盘: CLOUD_PREMIUM</li>
*/
DiskType?: string;
/**
* 单块大小GB
*/
DiskCapacity?: number;
/**
* 数据盘数量
*/
DiskNumber?: number;
}
/**
* 用于创建集群价格清单 不同可用区下价格详情
*/
export interface ZoneDetailPriceResult {
/**
* 可用区Id
*/
ZoneId?: string;
/**
* 不同节点的价格详情
*/
NodeDetailPrice?: Array<NodeDetailPriceResult>;
}
/**
* AddUsersForUserManager返回参数结构体
*/
export interface AddUsersForUserManagerResponse {
/**
* 添加成功的用户列表
注意:此字段可能返回 null,表示取不到有效值。
*/
SuccessUserList?: Array<string>;
/**
* 添加失败的用户列表
注意:此字段可能返回 null,表示取不到有效值。
*/
FailedUserList?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 搜索字段
*/
export interface SearchItem {
/**
* 支持搜索的类型
*/
SearchType: string;
/**
* 支持搜索的值
*/
SearchValue: string;
}
/**
* DescribeResourceScheduleDiffDetail返回参数结构体
*/
export interface DescribeResourceScheduleDiffDetailResponse {
/**
* 变化项的明细
注意:此字段可能返回 null,表示取不到有效值。
*/
Details?: Array<DiffDetail>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeYarnQueue返回参数结构体
*/
export interface DescribeYarnQueueResponse {
/**
* 队列信息。是一个对象转成的json字符串,对应的golang结构体如下所示,例如`QueueWithConfigSetForFairScheduler`的第一个字段`Name`:```Name string `json:"name"` //队列名称```- `Name`:字段名- `string`:字段类型- `json:"name"`:表示在序列化和反序列化`json`时,对应的`json key`,下面以`json key`来指代- `//`:后面的注释内容对应页面上看到的名称字段类型以`*`开头的表示取值可能为json规范下的null,不同的语言需要使用能表达null的类型来接收,例如java的包装类型;字段类型以`[]`开头的表示是数组类型;`json key`在调用`ModifyYarnQueueV2 `接口也会使用。- 公平调度器```type QueueWithConfigSetForFairScheduler struct { Name string `json:"name"` //队列名称 MyId string `json:"myId"` // 队列id,用于编辑、删除、克隆时使用 ParentId string `json:"parentId"` // 父队列Id Type *string `json:"type"` // 队列归属。parent或空,当确定某个队列是父队列,且没有子队列时,才可以设置,通常用来支持放置策略nestedUserQueue AclSubmitApps *AclForYarnQueue `json:"aclSubmitApps"` // 提交访问控制 AclAdministerApps *AclForYarnQueue `json:"aclAdministerApps"` // 管理访问控制 MinSharePreemptionTimeout *int `json:"minSharePreemptionTimeout"` // 最小共享优先权超时时间 FairSharePreemptionTimeout *int `json:"fairSharePreemptionTimeout"` // 公平份额抢占超时时间 FairSharePreemptionThreshold *float32 `json:"fairSharePreemptionThreshold"` // 公平份额抢占阈值。取值 (0,1] AllowPreemptionFrom *bool `json:"allowPreemptionFrom"` // 抢占模式 SchedulingPolicy *string `json:"schedulingPolicy"` // 调度策略,取值有drf、fair、fifo IsDefault *bool `json:"isDefault"` // 是否是root.default队列 IsRoot *bool `json:"isRoot"` // 是否是root队列 ConfigSets []ConfigSetForFairScheduler `json:"configSets"` // 配置集设置 Children []QueueWithConfigSetForFairScheduler `json:"queues"` // 子队列信息。递归}type AclForYarnQueue struct { User *string `json:"user"` //用户名 Group *string `json:"group"`//组名}type ConfigSetForFairScheduler struct { Name string `json:"name"` // 配置集名称 MinResources *YarnResource `json:"minResources"` // 最小资源量 MaxResources *YarnResource `json:"maxResources"` // 最大资源量 MaxChildResources *YarnResource `json:"maxChildResources"` // 能够分配给为未声明子队列的最大资源量 MaxRunningApps *int `json:"maxRunningApps"` // 最高可同时处于运行的App数量 Weight *float32 `json:"weight"` // 权重 MaxAMShare *float32 `json:"maxAMShare"` // App Master最大份额}type YarnResource struct { Vcores *int `json:"vcores"` Memory *int `json:"memory"` Type *string `json:"type"` // 当值为`percent`时,表示使用的百分比,否则就是使用的绝对数值}```- 容量调度器```type QueueForCapacitySchedulerV3 struct { Name string `json:"name"` // 队列名称 MyId string `json:"myId"` // 队列id,用于编辑、删除、克隆时使用 ParentId string `json:"parentId"` // 父队列Id Configs []ConfigForCapacityV3 `json:"configs"` //配置集设置 State *string `json:"state"` // 资源池状态 DefaultNodeLabelExpression *string `json:"default-node-label-expression"` // 默认标签表达式 AclSubmitApps *AclForYarnQueue `json:"acl_submit_applications"` // 提交访问控制 AclAdminQueue *AclForYarnQueue `json:"acl_administer_queue"` //管理访问控制 MaxAllocationMB *int32 `json:"maximum-allocation-mb"` // 分配Container最大内存数量 MaxAllocationVcores *int32 `json:"maximum-allocation-vcores"` // Container最大vCore数量 IsDefault *bool `json:"isDefault"`// 是否是root.default队列 IsRoot *bool `json:"isRoot"` // 是否是root队列 Queues []*QueueForCapacitySchedulerV3 `json:"queues"`//子队列信息。递归}type ConfigForCapacityV3 struct { Name string `json:"configName"` // 配置集名称 Labels []CapacityLabel `json:"labels"` // 标签信息 MinUserLimitPercent *int32 `json:"minimum-user-limit-percent"` // 用户最小容量 UserLimitFactor *float32 `json:"user-limit-factor" valid:"rangeExcludeLeft(0|)"` // 用户资源因子 MaxApps *int32 `json:"maximum-applications" valid:"rangeExcludeLeft(0|)"` // 最大应用数Max-Applications MaxAmPercent *float32 `json:"maximum-am-resource-percent"` // 最大AM比例 DefaultApplicationPriority *int32 `json:"default-application-priority"` // 资源池优先级}type CapacityLabel struct { Name string `json:"labelName"` Capacity *float32 `json:"capacity"` // 容量 MaxCapacity *float32 `json:"maximum-capacity"` //最大容量}type AclForYarnQueue struct { User *string `json:"user"` //用户名 Group *string `json:"group"`//组名}```
*/
Queue?: string;
/**
* 版本
*/
Version?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群节点拓扑信息
*/
export interface TopologyInfo {
/**
* 可用区ID
*/
ZoneId?: number;
/**
* 可用区信息
*/
Zone?: string;
/**
* 子网信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetInfoList?: Array<SubnetInfo>;
/**
* 节点信息
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeInfoList?: Array<ShortNodeInfo>;
}
/**
* 调度任务详情
*/
export interface SchedulerTaskDetail {
/**
* 步骤
*/
Step?: string;
/**
* 进度
*/
Progress?: string;
/**
* 失败信息
*