@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,745 lines (2,743 loc) • 142 kB
TypeScript
/**
* 集群配置。
*/
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;
}
/**
* Pod相关信息
*/
export interface PodSpecInfo {
/**
* 使用Pod资源扩容时,指定的Pod规格以及来源等信息
*/
PodSpec?: PodNewSpec;
/**
* POD自定义权限和自定义参数
*/
PodParameter?: PodNewParameter;
}
/**
* Pod资源售卖规格
*/
export interface PodSaleSpec {
/**
* 可售卖的资源规格,仅为以下值:"TASK","CORE","MASTER","ROUTER"。
*/
NodeType: string;
/**
* Cpu核数。
*/
Cpu: number;
/**
* 内存数量,单位为GB。
*/
Memory: number;
/**
* 该规格资源可申请的最大数量。
*/
Number: number;
}
/**
* ScaleOutInstance返回参数结构体
*/
export interface ScaleOutInstanceResponse {
/**
* 实例ID。
*/
InstanceId: string;
/**
* 订单号。
注意:此字段可能返回 null,表示取不到有效值。
*/
DealNames: Array<string>;
/**
* 客户端Token。
注意:此字段可能返回 null,表示取不到有效值。
*/
ClientToken: string;
/**
* 扩容流程ID。
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowId: number;
/**
* 大订单号。
注意:此字段可能返回 null,表示取不到有效值。
*/
BillId: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyUserManagerPwd返回参数结构体
*/
export interface ModifyUserManagerPwdResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Impala查询详情
*/
export interface ImpalaQuery {
/**
* 执行语句
注意:此字段可能返回 null,表示取不到有效值。
*/
Statement?: string;
/**
* 查询ID
注意:此字段可能返回 null,表示取不到有效值。
*/
Id?: string;
/**
* 开始时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: number;
/**
* 运行时间
注意:此字段可能返回 null,表示取不到有效值。
*/
Duration?: string;
/**
* 结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: number;
/**
* 执行状态
注意:此字段可能返回 null,表示取不到有效值。
*/
State?: string;
/**
* 获取行数
注意:此字段可能返回 null,表示取不到有效值。
*/
RowsFetched?: number;
/**
* 用户
注意:此字段可能返回 null,表示取不到有效值。
*/
User?: string;
/**
* 默认DB
注意:此字段可能返回 null,表示取不到有效值。
*/
DefaultDB?: string;
/**
* 执行的Coordinator节点
注意:此字段可能返回 null,表示取不到有效值。
*/
Coordinator?: string;
/**
* 单节点内存峰值
注意:此字段可能返回 null,表示取不到有效值。
*/
MaxNodePeakMemoryUsage?: string;
/**
* 查询类型
注意:此字段可能返回 null,表示取不到有效值。
*/
QueryType?: string;
/**
* 扫描的HDFS行数
注意:此字段可能返回 null,表示取不到有效值。
*/
ScanHDFSRows?: number;
/**
* 扫描的Kudu行数
注意:此字段可能返回 null,表示取不到有效值。
*/
ScanKUDURows?: number;
/**
* 扫描的总行数
注意:此字段可能返回 null,表示取不到有效值。
*/
ScanRowsTotal?: number;
/**
* 读取的总字节数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalBytesRead?: number;
/**
* 发送的总字节数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalBytesSent?: number;
/**
* CPU总时间
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalCpuTime?: number;
/**
* 内部数据发送总量(Bytes)
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalInnerBytesSent?: number;
/**
* 内部扫描数据发送总量(Bytes)
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalScanBytesSent?: number;
/**
* 预估单节点内存
注意:此字段可能返回 null,表示取不到有效值。
*/
EstimatedPerHostMemBytes?: number;
/**
* 从缓存中获取的数据行数
注意:此字段可能返回 null,表示取不到有效值。
*/
NumRowsFetchedFromCache?: number;
}
/**
* Pod的存储设备描述信息。
*/
export interface PodVolume {
/**
* 存储类型,可为"pvc","hostpath"。
注意:此字段可能返回 null,表示取不到有效值。
*/
VolumeType: string;
/**
* 当VolumeType为"pvc"时,该字段生效。
注意:此字段可能返回 null,表示取不到有效值。
*/
PVCVolume?: PersistentVolumeContext;
/**
* 当VolumeType为"hostpath"时,该字段生效。
注意:此字段可能返回 null,表示取不到有效值。
*/
HostVolume?: HostVolumeContext;
}
/**
* SyncPodState返回参数结构体
*/
export interface SyncPodStateResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateInstance返回参数结构体
*/
export interface CreateInstanceResponse {
/**
* 实例ID
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceId?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Pod PVC存储方式描述
*/
export interface PersistentVolumeContext {
/**
* 磁盘大小,单位为GB。
注意:此字段可能返回 null,表示取不到有效值。
*/
DiskSize?: number;
/**
* 磁盘类型。CLOUD_PREMIUM;CLOUD_SSD
注意:此字段可能返回 null,表示取不到有效值。
*/
DiskType?: string;
/**
* 磁盘数量
注意:此字段可能返回 null,表示取不到有效值。
*/
DiskNum?: number;
}
/**
* 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中作为数据存储目录使用
注意:此字段可能返回 null,表示取不到有效值。
*/
VolumePath: string;
}
/**
* ScaleOutCluster请求参数结构体
*/
export interface ScaleOutClusterRequest {
/**
* 节点计费模式。取值范围:
<li>PREPAID:预付费,即包年包月。</li>
<li>POSTPAID_BY_HOUR:按小时后付费。</li>
<li>SPOTPAID:竞价付费(仅支持TASK节点)。</li>
*/
InstanceChargeType: string;
/**
* 集群实例ID。
*/
InstanceId: string;
/**
* 扩容节点类型以及数量
*/
ScaleOutNodeConfig: ScaleOutNodeConfig;
/**
* 唯一随机标识,时效5分钟,需要调用者指定 防止客户端重新创建资源,例如 a9a90aa6-751a-41b6-aad6-fae36063280
*/
ClientToken?: string;
/**
* 即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
*/
InstanceChargePrepaid?: InstanceChargePrepaid;
/**
* [引导操作](https://cloud.tencent.com/document/product/589/35656)脚本设置。
*/
ScriptBootstrapActionConfig?: Array<ScriptBootstrapActionConfig>;
/**
* 扩容部署服务,新增节点将默认继承当前节点类型中所部署服务,部署服务含默认可选服务,该参数仅支持可选服务填写,如:存量task节点已部署HDFS、YARN、impala;使用api扩容task节不部署impala时,部署服务仅填写HDFS、YARN。[组件名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760)。
*/
SoftDeployInfo?: Array<number | bigint>;
/**
* 部署进程,默认部署扩容服务的全部进程,支持修改部署进程,如:当前task节点部署服务为:HDFS、YARN、impala,默认部署服务为:DataNode,NodeManager,ImpalaServer,若用户需修改部署进程信息,部署进程: DataNode,NodeManager,ImpalaServerCoordinator或DataNode,NodeManager,ImpalaServerExecutor。[进程名对应的映射关系表](https://cloud.tencent.com/document/product/589/98760)。
*/
ServiceNodeInfo?: Array<number | bigint>;
/**
* 分散置放群组ID列表,当前只支持指定一个。
该参数可以通过调用 [DescribeDisasterRecoverGroups](https://cloud.tencent.com/document/product/213/17810)的返回值中的DisasterRecoverGroupId字段来获取。
*/
DisasterRecoverGroupIds?: Array<string>;
/**
* 扩容节点绑定标签列表。
*/
Tags?: Array<Tag>;
/**
* 扩容所选资源类型,可选范围为"host","pod",host为普通的CVM资源,Pod为TKE集群或EKS集群提供的资源
*/
HardwareSourceType?: string;
/**
* Pod相关资源信息
*/
PodSpecInfo?: PodSpecInfo;
/**
* 使用clickhouse集群扩容时,选择的机器分组名称
*/
ClickHouseClusterName?: string;
/**
* 使用clickhouse集群扩容时,选择的机器分组类型。new为新增,old为选择旧分组
*/
ClickHouseClusterType?: string;
/**
* 扩容指定 Yarn Node Label
*/
YarnNodeLabel?: string;
/**
* 扩容后是否启动服务,默认取值否
<li>true:是</li>
<li>false:否</li>
*/
EnableStartServiceFlag?: boolean;
/**
* 规格设置
*/
ResourceSpec?: NodeResourceSpec;
/**
* 实例所属的可用区,例如ap-guangzhou-1。该参数也可以通过调用[DescribeZones](https://cloud.tencent.com/document/product/213/15707) 的返回值中的Zone字段来获取。
*/
Zone?: string;
/**
* 子网,默认是集群创建时的子网
*/
SubnetId?: string;
}
/**
* 节点磁盘信息
*/
export interface DiskSpecInfo {
/**
* 磁盘数量
注意:此字段可能返回 null,表示取不到有效值。
*/
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>
注意:此字段可能返回 null,表示取不到有效值。
*/
DiskType: string;
/**
* 数据容量,单位为GB
注意:此字段可能返回 null,表示取不到有效值。
*/
DiskSize: number;
}
/**
* Hive查询详情
*/
export interface HiveQuery {
/**
* 查询语句
注意:此字段可能返回 null,表示取不到有效值。
*/
Statement?: string;
/**
* 执行时长
注意:此字段可能返回 null,表示取不到有效值。
*/
Duration?: string;
/**
* 开始时间毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: number;
/**
* 结束时间毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
EndTime?: number;
/**
* 状态
注意:此字段可能返回 null,表示取不到有效值。
*/
State?: string;
/**
* 用户
注意:此字段可能返回 null,表示取不到有效值。
*/
User?: string;
/**
* appId列表
注意:此字段可能返回 null,表示取不到有效值。
*/
JobIds?: Array<string>;
/**
* 执行引擎
注意:此字段可能返回 null,表示取不到有效值。
*/
ExecutionEngine?: string;
/**
* 查询ID
注意:此字段可能返回 null,表示取不到有效值。
*/
Id?: string;
}
/**
* 执行步骤
*/
export interface Step {
/**
* 执行步骤名称。
*/
Name: string;
/**
* 执行动作。
*/
ExecutionStep: Execution;
/**
* 执行失败策略。
1. TERMINATE_CLUSTER 执行失败时退出并销毁集群。
2. CONTINUE 执行失败时跳过并执行后续步骤。
*/
ActionOnFailure: string;
/**
* 指定执行Step时的用户名,非必须,默认为hadoop。
*/
User?: string;
}
/**
* 键值对,主要用来做Filter
*/
export interface KeyValue {
/**
* 键
注意:此字段可能返回 null,表示取不到有效值。
*/
Key: string;
/**
* 值
注意:此字段可能返回 null,表示取不到有效值。
*/
Value: string;
}
/**
* DescribeEmrApplicationStatics请求参数结构体
*/
export interface DescribeEmrApplicationStaticsRequest {
/**
* 集群id
*/
InstanceId: string;
/**
* 起始时间,时间戳(秒)
*/
StartTime?: number;
/**
* 结束时间,时间戳(秒)
*/
EndTime?: number;
/**
* 过滤的队列名
*/
Queues?: Array<string>;
/**
* 过滤的用户名
*/
Users?: Array<string>;
/**
* 过滤的作业类型
*/
ApplicationTypes?: Array<string>;
/**
* 分组字段,可选:queue, user, applicationType
*/
GroupBy?: Array<string>;
/**
* 排序字段,可选:sumMemorySeconds, sumVCoreSeconds, sumHDFSBytesWritten, sumHDFSBytesRead
*/
OrderBy?: string;
/**
* 是否顺序排序,0-逆序,1-正序
*/
IsAsc?: number;
/**
* 页号
*/
Offset?: number;
/**
* 页容量
*/
Limit?: number;
}
/**
* 用户管理列表过滤器
*/
export interface UserManagerFilter {
/**
* 用户名
注意:此字段可能返回 null,表示取不到有效值。
*/
UserName?: string;
}
/**
* 元数据库信息
*/
export interface MetaDbInfo {
/**
* 元数据类型。
*/
MetaType: string;
/**
* 统一元数据库实例ID。
*/
UnifyMetaInstanceId: string;
/**
* 自建元数据库信息。
*/
MetaDBInfo: CustomMetaInfo;
}
/**
* 磁盘描述。
*/
export interface DiskSpec {
/**
* 磁盘类型。
LOCAL_BASIC 本地盘。
CLOUD_BASIC 云硬盘。
LOCAL_SSD 本地SSD。
CLOUD_SSD 云SSD。
CLOUD_PREMIUM 高效云盘。
CLOUD_HSSD 增强型云SSD。
*/
DiskType: string;
/**
* 磁盘大小,单位GB。
*/
DiskSize: number;
}
/**
* ModifyUserManagerPwd请求参数结构体
*/
export interface ModifyUserManagerPwdRequest {
/**
* 集群实例ID
*/
InstanceId: string;
/**
* 用户名
*/
UserName: string;
/**
* 密码
*/
PassWord: string;
}
/**
* COS 相关配置
*/
export interface COSSettings {
/**
* COS SecretId
*/
CosSecretId: string;
/**
* COS SecrectKey
*/
CosSecretKey: string;
/**
* 日志存储在COS上的路径
*/
LogOnCosPath?: string;
}
/**
* 集群实例信息
*/
export interface ClusterInstancesInfo {
/**
* ID号
注意:此字段可能返回 null,表示取不到有效值。
*/
Id: number;
/**
* 集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId: string;
/**
* 标题
注意:此字段可能返回 null,表示取不到有效值。
*/
Ftitle: string;
/**
* 集群名
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterName: string;
/**
* 地域ID
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionId: number;
/**
* 地区ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneId: number;
/**
* 用户APPID
注意:此字段可能返回 null,表示取不到有效值。
*/
AppId: number;
/**
* 用户UIN
注意:此字段可能返回 null,表示取不到有效值。
*/
Uin: string;
/**
* 项目Id
注意:此字段可能返回 null,表示取不到有效值。
*/
ProjectId: number;
/**
* 集群VPCID
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId: number;
/**
* 子网ID
注意:此字段可能返回 null,表示取不到有效值。
*/
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>
注意:此字段可能返回 null,表示取不到有效值。
*/
Status: number;
/**
* 添加时间
注意:此字段可能返回 null,表示取不到有效值。
*/
AddTime: string;
/**
* 已经运行时间
注意:此字段可能返回 null,表示取不到有效值。
*/
RunTime: string;
/**
* 集群产品配置信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Config: EmrProductConfigOutter;
/**
* 主节点外网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
MasterIp: string;
/**
* EMR版本
注意:此字段可能返回 null,表示取不到有效值。
*/
EmrVersion: string;
/**
* 收费类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ChargeType: number;
/**
* 交易版本
注意:此字段可能返回 null,表示取不到有效值。
*/
TradeVersion: number;
/**
* 资源订单ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ResourceOrderId: number;
/**
* 是否计费集群
注意:此字段可能返回 null,表示取不到有效值。
*/
IsTradeCluster: number;
/**
* 集群错误状态告警信息
注意:此字段可能返回 null,表示取不到有效值。
*/
AlarmInfo: string;
/**
* 是否采用新架构
注意:此字段可能返回 null,表示取不到有效值。
*/
IsWoodpeckerCluster: number;
/**
* 元数据库信息
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaDb: string;
/**
* 标签信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags: Array<Tag>;
/**
* Hive元数据信息
注意:此字段可能返回 null,表示取不到有效值。
*/
HiveMetaDb: string;
/**
* 集群类型:EMR,CLICKHOUSE,DRUID
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceClass: string;
/**
* 集群所有节点的别名序列化
注意:此字段可能返回 null,表示取不到有效值。
*/
AliasInfo: string;
/**
* 集群版本Id
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductId: number;
/**
* 地区ID
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone: string;
/**
* 场景名称
注意:此字段可能返回 null,表示取不到有效值。
*/
SceneName: string;
/**
* 场景化集群类型
注意:此字段可能返回 null,表示取不到有效值。
*/
SceneServiceClass: string;
/**
* 场景化EMR版本
注意:此字段可能返回 null,表示取不到有效值。
*/
SceneEmrVersion: string;
/**
* 场景化集群类型
注意:此字段可能返回 null,表示取不到有效值。
*/
DisplayName: string;
/**
* vpc name
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcName: string;
/**
* subnet name
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetName: string;
/**
* 集群依赖关系
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterExternalServiceInfo: Array<ClusterExternalServiceInfo>;
/**
* 集群vpcid 字符串类型
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqVpcId: string;
/**
* 子网id 字符串类型
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqSubnetId: string;
/**
* 节点信息
注意:此字段可能返回 null,表示取不到有效值。
*/
TopologyInfoList: Array<TopologyInfo>;
/**
* 是否是跨AZ集群
注意:此字段可能返回 null,表示取不到有效值。
*/
IsMultiZoneCluster: boolean;
/**
* 是否开通异常节点自动补偿
注意:此字段可能返回 null,表示取不到有效值。
*/
IsCvmReplace: boolean;
}
/**
* 子网信息
*/
export interface SubnetInfo {
/**
* 子网信息(名字)
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetName?: string;
/**
* 子网信息(ID)
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId?: string;
}
/**
* 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;
/**
* 客户端Token。
*/
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",host为普通的CVM资源,Pod为TKE集群或EKS集群提供的资源
*/
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;
}
/**
* 用于创建集群价格清单 不同可用区下价格详情
*/
export interface ZoneDetailPriceResult {
/**
* 可用区Id
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneId: string;
/**
* 不同节点的价格详情
*/
NodeDetailPrice: Array<NodeDetailPriceResult>;
}
/**
* 扩容容器资源时的资源描述
*/
export 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?: Array<PodVolume>;
/**
* 是否浮动规格,默认否
<li>true:代表是</li>
<li>false:代表否</li>
*/
EnableDynamicSpecFlag?: boolean;
/**
* 浮动规格
注意:此字段可能返回 null,表示取不到有效值。
*/
DynamicPodSpec?: DynamicPodSpec;
/**
* 代表vpc网络唯一id
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 代表vpc子网唯一id
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId?: string;
/**
* pod name
注意:此字段可能返回 null,表示取不到有效值。
*/
PodName?: string;
}
/**
* 资源详情
*/
export interface NodeResourceSpec {
/**
* 规格类型,如S2.MEDIUM8
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceType: string;
/**
* 系统盘,系统盘个数不超过1块
注意:此字段可能返回 null,表示取不到有效值。
*/
SystemDisk: Array<DiskSpecInfo>;
/**
* 需要绑定的标签列表
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 云数据盘,云数据盘总个数不超过15块
注意:此字段可能返回 null,表示取不到有效值。
*/
DataDisk?: Array<DiskSpecInfo>;
/**
* 本地数据盘
注意:此字段可能返回 null,表示取不到有效值。
*/
LocalDataDisk?: Array<DiskSpecInfo>;
}
/**
* ModifyResourceScheduleConfig返回参数结构体
*/
export interface ModifyResourceScheduleConfigResponse {
/**
* true为草稿,表示还没有刷新资源池
*/
IsDraft: boolean;
/**
* 校验错误信息,如果不为空,则说明校验失败,配置没有成功
注意:此字段可能返回 null,表示取不到有效值。
*/
ErrorMsg: string;
/**
* 返回数据
注意:此字段可能返回 null,表示取不到有效值。
*/
Data: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群节点拓扑信息
*/
export interface TopologyInfo {
/**
* 可用区ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ZoneId?: number;
/**
* 可用区信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone?: string;
/**
* 子网信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetInfoList?: Array<SubnetInfo>;
/**
* 节点信息
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeInfoList?: Array<ShortNodeInfo>;
}
/**
* 用于创建集群价格清单 节点价格详情
*/
export interface NodeDetailPriceResult {
/**
* 节点类型 master core task common router mysql
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeType: string;
/**
* 节点组成部分价格详情
*/
PartDetailPrice: Array<PartDetailPriceItem>;
}
/**
* 标签
*/
export interface Tag {
/**
* 标签键
*/
TagKey?: string;
/**
* 标签值
*/
TagValue?: string;
}
/**
* 集群id与流程id的mapping
*/
export interface ClusterIDToFlowID {
/**
* 集群id
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
/**
* 流程id
注意:此字段可能返回 null,表示取不到有效值。
*/
FlowId?: number;
}
/**
* 集群列表返回示例
*/
export interface EmrListInstance {
/**
* 集群ID
*/
ClusterId: string;
/**
* 状态描述
注意:此字段可能返回 null,表示取不到有效值。
*/
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
注意:此字段可能返回 null,表示取不到有效值。
*/
ProductId: number;
/**
* 项目ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ProjectId: number;
/**
* 区域
注意:此字段可能返回 null,表示取不到有效值。
*/
RegionId: number;
/**
* 子网ID
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId: number;
/**
* 网络ID
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId: number;
/**
* 地区
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone: string;
/**
* 状态码
注意:此字段可能返回 null,表示取不到有效值。
*/
Status: number;
/**
* 实例标签
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags: Array<Tag>;
/**
* 告警信息
注意:此字段可能返回 null,表示取不到有效值。
*/
AlarmInfo: string;
/**
* 是否是woodpecker集群
注意:此字段可能返回 null,表示取不到有效值。
*/
IsWoodpeckerCluster: number;
/**
* Vpc中文
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcName: string;
/**
* 子网中文
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetName: string;
/**
* 字符串VpcId
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqVpcId: string;
/**
* 字符串子网
注意:此字段可能返回 null,表示取不到有效值。
*/
UniqSubnetId: string;
/**
* 集群类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterClass: string;
/**
* 是否为跨AZ集群
注意:此字段可能返回 null,表示取不到有效值。
*/
IsMultiZoneCluster: boolean;
/**
* 是否手戳集群
注意:此字段可能返回 null,表示取不到有效值。
*/
IsHandsCluster: boolean;
/**
* 体外客户端组件信息
注意:此字段可能返回 null,表示取不到有效值。
*/
OutSideSoftInfo: Array<SoftDependInfo>;
/**
* 当前集群的应用场景是否支持体外客户端
注意:此字段可能返回 null,表示取不到有效值。
*/
IsSupportOutsideCluster?: boolean;
}
/**
* AddUsersForUserManager返回参数结构体
*/
export interface AddUsersForUserManagerResponse {
/**
* 添加成功的用户列表
注意:此字段可能返回 null,表示取不到有效值。
*/
SuccessUserList: Array<string>;
/**
* 添加失败的用户列表
注意:此字段可能返回 null,表示取不到有效值。
*/
FailedUserList: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EMR产品配置
*/
export interface EmrProductConfigOutter {
/**
* 软件信息
注意:此字段可能返回 null,表示取不到有效值。
*/
SoftInfo: Array<string>;
/**
* Master节点个数
注意:此字段可能返回 null,表示取不到有效值。
*/
MasterNodeSize: number;
/**
* Core节点个数
注意:此字段可能返回 null,表示取不到有效值。
*/
CoreNodeSize: number;
/**
* Task节点个数
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskNodeSize: number;
/**
* Common节点个数
注意:此字段可能返回 null,表示取不到有效值。
*/
ComNodeSize: number;
/**
* Master节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
MasterResource: OutterResource;
/**
* Core节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
CoreResource: OutterResource;
/**
* Task节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskResource: OutterResource;
/**
* Common节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
ComResource: OutterResource;
/**
* 是否使用COS
注意:此字段可能返回 null,表示取不到有效值。
*/
OnCos: boolean;
/**
* 收费类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ChargeType: number;
/**
* Router节点个数
注意:此字段可能返回 null,表示取不到有效值。
*/
RouterNodeSize: number;
/**
* 是否支持HA
注意:此字段可能返回 null,表示取不到有效值。
*/
SupportHA: boolean;
/**
* 是否支持安全模式
注意:此字段可能返回 null,表示取不到有效值。
*/
SecurityOn: boolean;
/**
* 安全组名称
注意:此字段可能返回 null,表示取不到有效值。
*/
SecurityGroup: string;
/**
* 是否开启Cbs加密
注意:此字段可能返回 null,表示取不到有效值。
*/
CbsEncrypt: number;
/**
* 自定义应用角色。
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationRole: string;
/**
* 安全组
注意:此字段可能返回 null,表示取不到有效值。
*/
SecurityGroups: Array<string>;
/**
* SSH密钥Id
注意:此字段可能返回 null,表示取不到有效值。
*/
PublicKeyId: string;
}
/**
* VPC 参数
*/
export interface VPCSettings {
/**
* VPC ID
*/
VpcId: string;
/**
* Subnet ID
*/
SubnetId: string;
}
/**
* 共用自建组件参数
*/
export interface CustomServiceDefine {
/**
* 自定义参数key
*/
Name?: string;
/**
* 自定义参数value
*/
Value?: string;
}
/**
* DescribeInstanceRenewNodes请求参数结构体
*/
export interface DescribeInstanceRenewNodesRequest {
/**
* 集群实例ID,实例ID形如: emr-xxxxxxxx
*/
InstanceId: string;
}
/**
* Yarn 运行的Application信息
*/
export interface YarnApplication {
/**
* 应用ID
注意:此字段可能返回 null,表示取不到有效值。
*/
Id?: string;
/**
* 用户
注意:此字段可能返回 null,表示取不到有效值。
*/
User?: string;
/**
* 应用名
注意:此字段可能返回 null,表示取不到有效值。
*/
Name?: string;
/**
* 队列
注意:此字段可能返回 null,表示取不到有效值。
*/
Queue?: string;
/**
* 应用类型
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationType?: string;
/**
* 运行时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ElapsedTime?: string;
/**
* 状态
注意:此字段可能返回 null,表示取不到有效值。
*/
State?: string;
/**
* 最终状态
注意:此字段可能返回 null,表示取不到有效值。
*/
FinalStatus?: string;
/**
* 进度
注意:此字段可能返回 null,表示取不到有效值。
*/
Progress?: number;
/**
* 开始时间毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
StartedTime?: number;
/**
* 结束时间毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
FinishedTime?: number;
/**
* 申请内存MB
注意:此字段可能返回 null,表示取不到有效值。
*/
AllocatedMB?: number;
/**
* 申请VCores
注意:此字段可能返回 null,表示取不到有效值。
*/
AllocatedVCores?: number;
/**
* 运行的Containers数
注意:此字段可能返回 null,表示取不到有效值。
*/
RunningContainers?: number;
/**
* 内存MB*时间秒
注意:此字段可能返回 null,表示取不到有效值。
*/
MemorySeconds?: number;
/**
* VCores*时间秒
注意:此字段可能返回 null,表示取不到有效值。
*/
VCoreSeconds?: number;
/**
* 队列资源占比
注意:此字段可能返回 null,表示取不到有效值。
*/
QueueUsagePercentage?: number;
/**
* 集群资源占比
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterUsagePercentage?: number;
/**
* 预占用的内存
注意:此字段可能返回 null,表示取不到有效值。
*/
PreemptedResourceMB?: number;
/**
* 预占用的VCore
注意:此字段可能返回 null,表示取不到有效值。
*/
PreemptedResourceVCores?: number;
/**
* 预占的非应用程序主节点容器数量
注意:此字段可能返回 null,表示取不到有效值。
*/
NumNonAMContainerPreempted?: number;
/**
* AM预占用的容器数量
注意:此字段可能返回 null,表示取不到有效值。
*/
NumAMContainerPreempted?: number;
/**
* Map总数
注意:此字段可能返回 null,表示取不到有效值。
*/
MapsTotal?: number;
/**
* 完成的Map数
注意:此字段可能返回 null,表示取不到有效值。
*/
MapsCompleted?: number;
/**
* Reduce总数
注意:此字段可能返回 null,表示取不到有效值。
*/
ReducesTotal?: number;
/**
* 完成的Reduce数
注意:此字段可能返回 null,表示取不到有效值。
*/
ReducesCompleted?: number;
/**
* 平均Map时间
注意:此字段可能返回 null,表示取不到有效值。
*/
AvgMapTime?: number;
/**
* 平均Reduce时间
注意:此字段可能返回 null,表示取不到有效值。
*/
AvgReduceTime?: number;
/**
* 平均Shuffle时间毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
AvgShuffleTime?: number;
/**
* 平均Merge时间毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
AvgMergeTime?: number;
/**
* 失败的Reduce执行次数
注意:此字段可能返回 null,表示取不到有效值。
*/
FailedReduceAttempts?: number;
/**
* Kill的Reduce执行次数
注意:此字段可能返回 null,表示取不到有效值。
*/
KilledReduceAttempts?: number;
/**
* 成功的Reduce执行次数
注意:此字段可能返回 null,表示取不到有效值。
*/
SuccessfulReduceAttempts?: number;
/**
* 失败的Map执行次数
注意:此字段可能返回 null,表示取不到有效值。
*/
FailedMapAttempts?: number;
/**
* Kill的Map执行次数
注意:此字段可能返回 null,表示取不到有效值。
*/
KilledMapAttempts?: number;
/**
* 成功的Map执行次数
注意:此字段可能返回 null,表示取不到有效值。
*/
SuccessfulMapAttempts?: number;
/**
* GC毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
GcTimeMillis?: number;
/**
* Map使用的VCore毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
VCoreMillisMaps?: number;
/**
* Map使用的内存毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
MbMillisMaps?: number;
/**
* Reduce使用的VCore毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
VCoreMillisReduces?: number;
/**
* Reduce使用的内存毫秒
注意:此字段可能返回 null,表示取不到有效值。
*/
MbMillisReduces?: number;
/**
* 启动Map的总数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalLaunchedMaps?: number;
/**
* 启动Reduce的总数
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalLaunchedReduces?: number;
/**
* Map输入记录数
注意:此字段可能返回 null,表示取不到有效值。
*/
MapInputRecords?: number;
/**
* Map输出记录数
注意:此字段可能返回 null,表示取不到有效值。
*/
MapOutputRecords?: number;
/**
* Reduce输入记录数
注意:此字段可能返回 null,表示取不到有效值。
*/
ReduceInputRecords?: number;
/**
* Reduce输出记录数
注意:此字段可能返回 null,表示取不到有效值。
*/
ReduceOutputRecords?: number;
/**
* HDFS写入字节数
注意:此字段可能返回 null,表示取不到有效值。
*/
HDFSBytesWritten?: number;
/**
* HDFS读取字节数
注意:此字段可能返回 null,表示取不到有效值。
*/
HDFSBytesRead?: number;
}
/**
* 任务步骤结果描述
*/
export interface JobResult {
/**
* 任务步骤名称。
注意:此字段可能返回 null,表示取不到有效值。
*/
Name: string;
/**
* 任务步骤失败时的处理策略,可以为以下值:
"CONTINUE",跳过当前失败步骤,继续后续步骤。
“TERMINATE_CLUSTER”,终止当前及后续步骤,并销毁集群。
“CANCEL_AND_WAIT”,取消当前步骤并阻塞等待处理。
注意:此字段可能返回 null,表示取不到有效值。
*/
ActionOnFailure: string;
/**
* 当前步骤的状态,可以为以下值:
“JobFlowStepStatusInit”,初始化状态,等待执行。
“JobFlowStepStatusRunning”,任务步骤正在执行。
“JobFlowStepStatusFailed”,任务步骤执行失败。
“JobFlowStepStatusSucceed”,任务步骤执行成功。
注意:此字段可能返回 null,表示取不到有效值。
*/
JobState: string;
/**
* YARN任务ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ApplicationId?: string;
}
/**
* 用于创建集群价格清单-节点组成部分价格
*/
export interface PartDetailPriceItem {
/**
* 类型包括:节点->node、系统盘->rootDisk、云数据盘->dataDisk、metaDB
注意:此字段可能返回 null,表示取不到有效值。
*/
InstanceType: string;
/**
* 单价(原价)
注意:此字段可能返回 null,表示取不到有效值。
*/
Price: number;
/**
* 单价(折扣价)
注意:此字段可能返回 null,表示取不到有效值。
*/
RealCost: number;
/**
* 总价(折扣价)
注意:此字段可能返回 null,表示取不到有效值。
*/
RealTotalCost: number;
/**
* 折扣
注意:此字段可能返回 null,表示取不到有效值。
*/
Policy: number;
/**
* 数量
注意:此字段可能返回 null,表示取不到有效值。
*/
GoodsNum: number;
}
/**
* 共用组件信息
*/
export interface DependService {
/**
* 共用组件名
*/
ServiceName: string;
/**
* 共用组件集群
*/
InstanceId: string;
}
/**
* 扩容容器资源时的资源描述
*/
export interface PodSpec {
/**
* 外部资源提供者的标识符,例如"cls-a1cd23fa"。
*/
ResourceProviderIdentifier: string;
/**
* 外部资源提供者类型,例如"tke",当前仅支持"tke"。
*/
ResourceProviderType: string;
/**
* 资源的用途,即节点类型,当前仅支持"TASK"。
*/
NodeType: string;
/**
* CPU核数。
*/
Cpu: number;
/**
* 内存大小,单位为GB。
*/
Memory: number;
/**
* 资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用。弃用
*/
DataVolumes?: Array<string>;
/**
* Eks集群-CPU类型,当前支持"intel"和"amd"
*/
CpuType?: string;
/**
* Pod节点数据目录挂载信息。
*/
PodVolumes?: Array<PodVolume>;
/**
* 是否浮动规格,1是,0否
*/
IsDynamicSpec?: number;
/**
* 浮动规格
注意:此字段可能返回 null,表示取不到有效值。
*/
DynamicPodSpec?: DynamicPodSpec;
/**
* 代表vpc网络唯一id
注意:此字段可能返回 null,表示取不到有效值。
*/
VpcId?: string;
/**
* 代表vpc子网唯一id
注意:此字段可能返回 null,表示取不到有效值。
*/
SubnetId?: string;
/**
* pod name
注意:此字段可能返回 null,表示取不到有效值。
*/
PodName?: string;
}
/**
* InquiryPriceRenewInstance返回参数结构体
*/
export interface InquiryPriceRenewInstanceResponse {
/**
* 原价,单位为元。
注意:此字段可能返回 null,表示取不到有效值。
*/
OriginalCost?: number;
/**
* 折扣价,单位为元。
注意:此字段可能返回 null,表示取不到有效值。
*/
DiscountCost?: number;
/**
* 实例续费的时间单位。取值范围:
<li>m:表示月份。</li>
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeUnit?: string;
/**
* 实例续费的时长。
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeSpan?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeJobFlow请求参数结构体
*/
export interface DescribeJobFlowRequest {
/**
* 流程任务Id,RunJobFlow接口返回的值。
*/
JobFlowId: number;
}
/**
* InquiryPriceCreateInstance返回参数结构体
*/
export interface InquiryPriceCreateInstanceResponse {
/**
* 原价,单位为元。
注意:此字段可能返回 null,表示取不到有效值。
*/
OriginalCost?: number;
/**
* 折扣价,单位为元。
注意:此字段可能返回 null,表示取不到有效值。
*/
DiscountCost?: number;
/**
* 购买实例的时间单位。取值范围:
<li>s:表示秒。</li>
<li>m:表示月份。</li>
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeUnit?: string;
/**
* 购买实例的时长。
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeSpan?: number;
/**
* 价格清单
注意:此字段可能返回 null,表示取不到有效值。
*/
PriceList?: Array<ZoneDetailPriceResult>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StartStopServiceOrMonitor请求参数结构体
*/
export interface StartStopServiceOrMonitorRequest {
/**
* 集群ID
*/
InstanceId: string;
/**
* 操作类型,当前支持
<li>StartService:启动服务</li>
<li>StopService:停止服务</li>
<li>StartMonitor:退出维护</li>
<li>StopMonitor:进入维护</li>
<li>RestartService:重启服务 如果操作类型选择重启服务 StrategyConfig操作策略则是必填项</li>
*/
OpType: string;
/**
* 操作范围
*/
OpScope: OpScope;
/**
* 操作策略
*/
StrategyConfig?: StrategyConfig;
}
/**
* TerminateInstance请求参数结构体
*/
export interface TerminateInstanceRequest {
/**
* 实例ID。
*/
InstanceId: string;
/**
* 销毁节点ID。该参数为预留参数,用户无需配置。
*/
ResourceIds?: Array<string>;
}
/**
* 弹性扩缩容记录
*/
export 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表示开启
注意:此字段可能返回 null,表示取不到有效值。
*/
CompensateFlag?: number;
/**
* 补偿次数
注意:此字段可能返回 null,表示取不到有效值。
*/
CompensateCount?: number;
}
/**
* 流程作业资源描述
*/
export interface JobFlowResourceSpec {
/**
* 主节点数量。
*/
MasterCount: number;
/**
* 主节点配置。
*/
MasterResourceSpec: JobFlowResource;
/**
* Core节点数量
*/
CoreCount: number;
/**
* Core节点配置。
*/
CoreResourceSpec: JobFlowResource;
/**
* Task节点数量。
*/
TaskCount?: number;
/**
* Common节点数量。
*/
CommonCount?: number;
/**
* Task节点配置。
*/
TaskResourceSpec?: JobFlowResource;
/**
* Common节点配置。
*/
CommonResourceSpec?: JobFlowResource;
}
/**
* 自定义配置参数
*/
export interface Configuration {
/**
* 配置文件名,支持SPARK、HIVE、HDFS、YARN的部分配置文件自定义。
*/
Classification: string;
/**
* 配置参数通过KV的形式传入,部分文件支持自定义,可以通过特殊的键"content"传入所有内容。
*/
Properties: string;
}
/**
* DescribeResourceSchedule请求参数结构体
*/
export interface DescribeResourceScheduleRequest {
/**
* emr集群的英文id
*/
InstanceId: string;
}
/**
* 描述集群实例位置信息
*/
export 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;
}
/**
* 获取CVM配额
*/
export interface QuotaEntity {
/**
* 已使用配额
注意:此字段可能返回 null,表示取不到有效值。
*/
UsedQuota: number;
/**
* 剩余配额
注意:此字段可能返回 null,表示取不到有效值。
*/
RemainingQuota: number;
/**
* 总配额
注意:此字段可能返回 null,表示取不到有效值。
*/
TotalQuota: number;
/**
* 可用区
注意:此字段可能返回 null,表示取不到有效值。
*/
Zone: string;
}
/**
* POD自定义权限和自定义参数
*/
export 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;
}
/**
* 资源描述
*/
export interface AllNodeResourceSpec {
/**
* 描述Master节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
MasterResourceSpec?: NodeResourceSpec;
/**
* 描述Core节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
CoreResourceSpec?: NodeResourceSpec;
/**
* 描述Taskr节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskResourceSpec?: NodeResourceSpec;
/**
* 描述Common节点资源
注意:此字段可能返回 null,表示取不到有效值。
*/
CommonResourceSpec?: NodeResourceSpec;
/**
* Master节点数量
注意:此字段可能返回 null,表示取不到有效值。
*/
MasterCount?: number;
/**
* Corer节点数量
注意:此字段可能返回 null,表示取不到有效值。
*/
CoreCount?: number;
/**
* Task节点数量
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskCount?: number;
/**
* Common节点数量
注意:此字段可能返回 null,表示取不到有效值。
*/
CommonCount?: number;
}
/**
* DescribeUsersForUserManager请求参数结构体
*/
export interface DescribeUsersForUserManagerRequest {
/**
* 集群实例ID
*/
InstanceId: string;
/**
* 页码
*/
PageNo: number;
/**
* 分页的大小
*/
PageSize: number;
/**
* 查询用户列表过滤器
*/
UserManagerFilter?: UserManagerFilter;
/**
* 是否需要keytab文件的信息,仅对开启kerberos的集群有效,默认为false
*/
NeedKeytabInfo?: boolean;
}
/**
* 集群续费实例信息
*/
export interface RenewInstancesInfo {
/**
* 节点资源ID
*/
EmrResourceId: string;
/**
* 节点类型。0:common节点;1:master节点
;2:core节点;3:task节点
*/
Flag: number;
/**
* 内网IP
*/
Ip: string;
/**
* 节点内存描述
*/
MemDesc: string;
/**
* 节点核数
*/
CpuNum: number;
/**
* 硬盘大小
*/
DiskSize: string;
/**
* 过期时间
*/
ExpireTime: string;
/**
* 节点规格
*/
Spec: string;
/**
* 磁盘类型
*/
StorageType: number;
}
/**
* RunJobFlow返回参数结构体
*/
export interface RunJobFlowResponse {
/**
* 作业流程ID。
*/
JobFlowId: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* StartStopServiceOrMonitor返回参数结构体
*/
export interface StartStopServiceOrMonitorResponse {
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeHiveQueries返回参数结构体
*/
export interface DescribeHiveQueriesResponse {
/**
* 总条数
*/
Total?: number;
/**
* 结果列表
*/
Results?: Array<HiveQuery>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* POD自定义权限和自定义参数
*/
export 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;
}
/**
* DescribeInstanceRenewNodes返回参数结构体
*/
export interface DescribeInstanceRenewNodesResponse {
/**
* 查询到的节点总数
*/
TotalCnt: number;
/**
* 节点详细信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeList: Array<RenewInstancesInfo>;
/**
* 用户所有的标签键列表
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaInfo: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 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?: string;
}
/**
* DescribeClusterNodes返回参数结构体
*/
export interface DescribeClusterNodesResponse {
/**
* 查询到的节点总数
*/
TotalCnt: number;
/**
* 节点详细信息列表
注意:此字段可能返回 null,表示取不到有效值。
*/
NodeList: Array<NodeHardwareInfo>;
/**
* 用户所有的标签键列表
注意:此字段可能返回 null,表示取不到有效值。
*/
TagKeys: Array<string>;
/**
* 资源类型列表
注意:此字段可能返回 null,表示取不到有效值。
*/
HardwareResourceTypeList: Array<string>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeYarnApplications请求参数结构体
*/
export interface DescribeYarnApplicationsRequest {
/**
* 集群ID
*/
InstanceId: string;
/**
* 起始时间秒
*/
StartTime: number;
/**
* 结束时间秒,EndTime-StartTime不得超过1天秒数86400
*/
EndTime: number;
/**
* 分页起始偏移,从0开始
*/
Offset: number;
/**
* 分页大小,合法范围[1,100]
*/
Limit: number;
}
/**
* InquiryPriceUpdateInstance返回参数结构体
*/
export interface InquiryPriceUpdateInstanceResponse {
/**
* 原价,单位为元。
注意:此字段可能返回 null,表示取不到有效值。
*/
OriginalCost: number;
/**
* 折扣价,单位为元。
注意:此字段可能返回 null,表示取不到有效值。
*/
DiscountCost: number;
/**
* 变配的时间单位。取值范围:
<li>s:表示秒。</li>
<li>m:表示月份。</li>
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeUnit: string;
/**
* 变配的时长。
注意:此字段可能返回 null,表示取不到有效值。
*/
TimeSpan: number;
/**
* 价格详情
注意:此字段可能返回 null,表示取不到有效值。
*/
PriceDetail: Array<PriceDetail>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**