有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

CCN

云联网描述信息

被如下接口引用:DescribeClusters。

名称 类型 描述
VpcId String 私有网络 ID
SubnetId String 子网 ID
CcnId String 云联网 ID,如 ccn-rahigzjd

ClazzLevel

{
"Clazz": "c1", // java类全路径
"Level": "WARN" // 日志级别 TRACE,DEBUG、INFO、WARN、ERROR
}

被如下接口引用:CreateJobConfig, DescribeJobConfigs。

名称 类型 必选 描述
Clazz String java类全路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:org.x.x.x
Level String 日志级别 TRACE,DEBUG、INFO、WARN、ERROR
注意:此字段可能返回 null,表示取不到有效值。
示例值:INFO

Cluster

描述用户创建的集群信息

被如下接口引用:DescribeClusters。

名称 类型 描述
ClusterId String 集群 ID
示例值:cluster-xxxx
Name String 集群名称
示例值:-
Region String 地域
示例值:ap-guangzhou
AppId Integer 用户 AppID
示例值:12314214
OwnerUin String 主账号 UIN
示例值:12314214
CreatorUin String 创建者 UIN
示例值:12314214
Status Integer 集群状态, 1 未初始化,,3 初始化中,2 运行中
示例值:1
Remark String 描述
示例值:test
CreateTime String 集群创建时间
示例值:2020-01-21 00:00:10
UpdateTime String 最后一次操作集群的时间
示例值:2020-01-21 01:00:10
CuNum Integer CU 数量
示例值:12
CuMem Integer CU 内存规格
示例值:4
Zone String 可用区
示例值:ap-guangzhou-1
StatusDesc String 状态描述
示例值:1
CCNs Array of CCN 网络
示例值:[]
NetEnvironmentType Integer 网络
示例值:2
FreeCuNum Integer 空闲 CU
示例值:2
Tags Array of Tag 集群绑定的标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
IsolatedTime String 集群隔离时间; 没隔离时间,则为 -
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
ExpireTime String 集群过期时间; 没过期概念,则为 -
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
SecondsUntilExpiry String 距离过期还有多少秒; 没过期概念,则为 -
注意:此字段可能返回 null,表示取不到有效值。
示例值:-
AutoRenewFlag Integer 自动续费标记,0 表示默认状态 (用户未设置,即初始状态,用户开通了预付费不停服特权会进行自动续费), 1 表示自动续费,2表示明确不自动续费(用户设置)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DefaultCOSBucket String 集群的默认 COS 存储桶
注意:此字段可能返回 null,表示取不到有效值。
示例值:test-12314214
CLSLogSet String 集群的CLS 日志集 LogSet
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx-xx-xx-xxxx
CLSTopicId String 集群的CLS 日志主题 TopicId
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx-xx-xx-xxxx
CLSLogName String 集群的CLS 日志集 名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:日志集名字
CLSTopicName String 集群的CLS 日志主题 名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:日志主题名字
Version ClusterVersion 集群的版本信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
FreeCu Float 细粒度资源下的空闲CU
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.5
DefaultLogCollectConf String 集群的默认日志采集配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
CustomizedDNSEnabled Integer 取值:0-没有设置,1-已设置,2-不允许设置
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Correlations Array of WorkSpaceClusterItem 空间信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
RunningCu Float 运行CU
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.5
PayMode Integer 0 后付费,1 预付费
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IsNeedManageNode Integer 前端区分 集群是否需要2CU逻辑 因为历史集群 变配不需要, default 1 新集群都需要
注意:此字段可能返回 null,表示取不到有效值。
示例值:0 / 1
ClusterSessions Array of ClusterSession session集群信息
注意:此字段可能返回 null,表示取不到有效值。
ArchGeneration Integer V3版本 = 2
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterType Integer 0:TKE, 1:EKS
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Orders Array of Order 订单信息
注意:此字段可能返回 null,表示取不到有效值。
SqlGateways Array of SqlGatewayItem Gateway信息
注意:此字段可能返回 null,表示取不到有效值。
WebUIType Integer 0 公网访问 // 1 内网访问
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

ClusterGroupSetItem

工作空间集群组信息

被如下接口引用:DescribeWorkSpaces。

名称 类型 描述
ClusterId String clusterGroup 的 SerialId
示例值:cluster-sdhd0vtz
Name String 集群名称
示例值:MyClusterName
Region String 地域
示例值:ap-beijing
Zone String
示例值:ap-beijing-2
AppId Integer 账号 APPID
示例值:3435324
OwnerUin String 主账号 UIN
示例值:123456
CreatorUin String 创建账号 UIN
示例值:123456
CuNum Integer CU 数量
示例值:2
CuMem Integer CU 内存规格
示例值:2
Status Integer 集群状态, 1 未初始化,,3 初始化中,2 运行中
示例值:2
StatusDesc String 状态描述
示例值:description
CreateTime String 集群创建时间
示例值:xxxx-xx-xx-xxxx
UpdateTime String 最后一次操作集群的时间
示例值:xxxx-xx-xx-xxxx
Remark String 描述
示例值:remark
NetEnvironmentType Integer 网络
示例值:2
FreeCuNum Integer 空闲 CU
示例值:1
FreeCu Float 细粒度资源下的空闲CU
示例值:2.5
RunningCu Float 运行中CU
示例值:2.5
PayMode Integer 付费模式
示例值:0

ClusterSession

session集群信息

被如下接口引用:DescribeClusters。

名称 类型 描述
ClusterGroupSerialId String 集群SerialId
示例值:cluster-nbcjavkn
AppId Integer 创建者appId
示例值:1257058945
OwnerUin String 创建者主账号
示例值:100006386216
CreatorUin String 创建者账号
示例值:100006386216
Region String 区域
示例值:ap-guangzhou
Zone String zone
示例值:ap-guangzhou-3
Status Integer Session集群状态
示例值:1
CuNum Float Session集群消耗的cu数量
示例值:2
FlinkVersion String Session集群的Flink版本
示例值:Flink-1.13
WebUIUrl String session集群FlinkUi地址
Properties Array of Property session集群高级参数
注意:此字段可能返回 null,表示取不到有效值。
JobManagerCuSpec Float JobManager的规格
示例值:1
TaskManagerCuSpec Float TaskManager的规格
示例值:0.5
TaskManagerNum Integer TaskManager启动的数量
示例值:2
CreateTime String 创建时间
UpdateTime String 更新时间

ClusterVersion

集群的版本相关信息

被如下接口引用:DescribeClusters。

名称 类型 描述
Flink String 集群的Flink版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:Flink-1.11
SupportedFlink Array of String 集群支持的Flink版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:["Flink-1.13", ""Flink-1.11"]

CopyJobItem

复制作业单条明细

被如下接口引用:CopyJobs。

名称 类型 必选 描述
SourceId String 需要复制的作业serial id
示例值:cql-pqx9zh30
TargetClusterId String 目标集群的cluster serial id
示例值:cluster-l0elpxde
SourceName String 需要复制的作业名称
示例值:job1
TargetName String 新作业的名称
示例值:job2
TargetFolderId String 新作业的目录id
示例值:folder-2ue9i8ny
JobType Integer 源作业类型
示例值:1

CopyJobResult

复制作业单条明细结果

被如下接口引用:CopyJobs。

名称 类型 描述
JobId String 原作业id
注意:此字段可能返回 null,表示取不到有效值。
示例值:cql-pqx9zh30
JobName String 原作业名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:job1
TargetJobName String 新作业名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:job2
TargetJobId String 新作业id
注意:此字段可能返回 null,表示取不到有效值。
示例值:cql-pqx9zh30
Message String 失败时候的信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:失败
Result Integer 0 成功 -1 失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:结果
ClusterName String 目标集群名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:集群1
ClusterId String 目标集群id
注意:此字段可能返回 null,表示取不到有效值。
示例值:cluster-l0elpxde
JobType Integer 作业类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

DescribeTreeJobsRsp

自定义树结构遍历子节点

被如下接口引用:DescribeTreeJobs。

名称 类型 描述
ParentId String 父节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:root-xxx
Id String 当前文件夹ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:folder-xxx
Name String 当前文件夹名
注意:此字段可能返回 null,表示取不到有效值。
示例值:New Folder
JobSet Array of TreeJobSets 当前文件夹下的作业集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:JobSet
Children Array of DescribeTreeJobsRsp 迭代子目录
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 请求ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx

DescribeTreeResourcesRsp

树状结构资源列表对象

被如下接口引用:DescribeTreeResources。

名称 类型 描述
ParentId String 父节点ID
示例值:folder-xxxx
Id String 文件夹ID
示例值:folder-xxxx
Name String 文件夹名称
示例值:xxxx
Items Array of TreeResourceItem 文件夹下资源数字
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
Children Array of DescribeTreeResourcesRsp 子节点
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
TotalCount Integer 资源总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:200

ExpertModeConfiguration

作业配置 -- 专家模式的详细配置

被如下接口引用:CreateJobConfig, DescribeJobConfigs。

名称 类型 必选 描述
JobGraph JobGraph Job graph
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "Nodes": [ { "Id": 1, "Description": "This is node 1", "Name": "Node1", "Parallelism": 2 }, { "Id": 2, "Description": "This is node 2", "Name": "Node2", "Parallelism": 3 }, { "Id": 3, "Description": "This is node 3", "Name": "Node3", "Parallelism": 4 } ], "Edges": [ { "Source": 1, "Target": 2 }, { "Source": 2, "Target": 3 } ] }
NodeConfig Array of NodeConfig Node configuration
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
SlotSharingGroups Array of SlotSharingGroup Slot sharing groups
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

Filter

查询作业列表时的过滤器

被如下接口引用:DescribeClusters, DescribeJobConfigs, DescribeJobs, DescribeResources, DescribeSystemResources, DescribeTreeJobs, DescribeTreeResources, DescribeWorkSpaces。

名称 类型 必选 描述
Name String 要过滤的字段
Values Array of String 字段的过滤值

GatewayRefItem

Gateway引用资源信息

被如下接口引用:DescribeClusters。

名称 类型 必选 描述
WorkspaceId String 空间唯一标识
注意:此字段可能返回 null,表示取不到有效值。
ResourceId String 资源唯一标识
注意:此字段可能返回 null,表示取不到有效值。
Version Integer 版本号
注意:此字段可能返回 null,表示取不到有效值。
Type Integer 引用类型,0:用户资源
注意:此字段可能返回 null,表示取不到有效值。

JobConfig

作业配置详情

被如下接口引用:DescribeJobConfigs。

名称 类型 描述
JobId String 作业Id
示例值:cql-xxx
EntrypointClass String 主类
注意:此字段可能返回 null,表示取不到有效值。
示例值:hello
ProgramArgs String 主类入参
注意:此字段可能返回 null,表示取不到有效值。
示例值:--config key=value
Remark String 备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:hello
CreateTime String 作业配置创建时间
示例值:2021-01-22 20:06:19
Version Integer 作业配置的版本号
示例值:1
DefaultParallelism Integer 作业默认并行度
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Properties Array of Property 系统参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
ResourceRefDetails Array of ResourceRefDetail 引用资源
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
CreatorUin String 创建者uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:1132
UpdateTime String 作业配置上次启动时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-01-22 20:06:19
COSBucket String 作业绑定的存储桶
注意:此字段可能返回 null,表示取不到有效值。
示例值:oceanus-example
LogCollect Integer 是否启用日志收集,0-未启用,1-已启用,2-历史集群未设置日志集,3-历史集群已开启
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
MaxParallelism Integer 作业的最大并行度
注意:此字段可能返回 null,表示取不到有效值。
示例值:2048
JobManagerSpec Float JobManager规格
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.5
TaskManagerSpec Float TaskManager规格
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.5
ClsLogsetId String CLS日志集ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
ClsTopicId String CLS日志主题ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
PythonVersion String pyflink作业运行的python版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:Python-3.7
AutoRecover Integer Oceanus 平台恢复作业开关 1:开启 -1: 关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LogLevel String 日志级别
注意:此字段可能返回 null,表示取不到有效值。
示例值:INFO
ClazzLevels Array of ClazzLevel 类日志级别
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
ExpertModeOn Boolean 是否开启专家模式
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ExpertModeConfiguration ExpertModeConfiguration 专家模式的配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
TraceModeOn Boolean trace链路
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
TraceModeConfiguration TraceModeConfiguration trace链路配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
CheckpointRetainedNum Integer checkpoint保留个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
JobGraph JobGraph 算子拓扑图
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
EsServerlessIndex String es索引
注意:此字段可能返回 null,表示取不到有效值。
示例值:index-**
EsServerlessSpace String es空间
注意:此字段可能返回 null,表示取不到有效值。
示例值:space-**
IndexName String es索引中文
注意:此字段可能返回 null,表示取不到有效值。
示例值:index-**
WorkspaceName String es空间中文
注意:此字段可能返回 null,表示取不到有效值。
示例值:space-**

JobEvent

描述作业发生的一个事件

被如下接口引用:DescribeJobEvents。

名称 类型 描述
Type String 内部定义的事件类型
示例值:11
Description String 事件类型的说明文字
示例值:作业停止
Timestamp Integer 事件发生的 Unix 时间戳(秒)
示例值:1630932161
RunningOrderId Integer 事件发生时的运行 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Message String 事件的一些可选说明
注意:此字段可能返回 null,表示取不到有效值。
示例值:作业异常停止,原因是 TaskManager 重启次数达到阈值
SolutionLink String 异常事件的排查手册链接
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://www.example.org/link?id=12357

JobEventInfo

事件信息

被如下接口引用:DescribeJobs。

名称 类型 描述
ErrorEventTotal Integer 异常事件总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

JobGraph

作业运行图

被如下接口引用:CreateJobConfig, DescribeJobConfigs。

名称 类型 必选 描述
Nodes Array of JobGraphNode 运行图的点集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
Edges Array of JobGraphEdge 运行图的边集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

JobGraphEdge

Flink Job 运行图的边信息

被如下接口引用:CreateJobConfig。

名称 类型 必选 描述
Source Integer 边的起始节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Target Integer 边的目标节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

JobGraphNode

Flink Job 运行图的点信息

被如下接口引用:CreateJobConfig。

名称 类型 必选 描述
Id Integer 节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Description String 节点描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:This is a node description
Name String 节点名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:Node1
Parallelism Integer 节点并行度
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

JobInstanceForSubmissionLog

搜索启动日志时返回的作业实例

被如下接口引用:DescribeJobSubmissionLog。

名称 类型 描述
RunningOrderId Integer 实例的Id, 按照启动的时间顺序,从1开始
JobInstanceStartTime String 作业实例的启动时间
StartingMillis Integer 作业实例启动的时间(毫秒)

JobV1

Job详细信息

被如下接口引用:DescribeJobs。

名称 类型 描述
JobId String 作业ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cql-xxx
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou
Zone String 可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-1
AppId Integer 用户AppId
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
OwnerUin String 用户UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
CreatorUin String 创建者UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
Name String 作业名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
JobType Integer 作业类型,1:sql作业,2:Jar作业
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status Integer 作业状态,1:未初始化,2:未发布,3:操作中,4:运行中,5:停止,6:暂停,-1:故障
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
CreateTime String 作业创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-06-11 16:44:44
StartTime String 作业启动时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-06-11 16:44:44
StopTime String 作业停止时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-06-11 16:44:44
UpdateTime String 作业更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-06-11 16:44:44
TotalRunMillis Integer 作业累计运行时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:13864986
Remark String 备注信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
LastOpResult String 操作错误提示信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:success
ClusterName String 集群名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
LatestJobConfigVersion Integer 最新配置版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
PublishedJobConfigVersion Integer 已发布的配置版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
RunningCuNum Integer 运行的CU数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CuMem Integer 作业内存规格
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
StatusDesc String 作业状态描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:running
CurrentRunMillis Integer 运行状态时表示单次运行时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:124
ClusterId String 作业所在的集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cluster-xxx
WebUIUrl String 作业管理WEB UI 入口
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://175.24.255.193//cql-czvy480r-78/?defaultToken=0
SchedulerType Integer 作业所在集群类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
ClusterStatus Integer 作业所在集群状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
RunningCu Float 细粒度下的运行的CU数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.5
FlinkVersion String 作业运行的 Flink 版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:Flink-1.11
WorkSpaceId String 工作空间 SerialId
注意:此字段可能返回 null,表示取不到有效值。
示例值:space-xxx
WorkSpaceName String 工作空间名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:mysqItemSpace
Tags Array of Tag 作业标签
注意:此字段可能返回 null,表示取不到有效值。
EventInfo JobEventInfo 作业异常事件信息
注意:此字段可能返回 null,表示取不到有效值。
Description String 描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:desc

LogContent

日志查询的每行日志信息

被如下接口引用:DescribeJobSubmissionLog。

名称 类型 描述
Log String 日志内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:abc
Time Integer 毫秒级时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1611816200076
PkgId String 日志组Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2014BF16012637D-6
PkgLogId Integer 日志Id,在日志组范围里唯一
示例值:131072
ContainerName String 日志所属的容器名
注意:此字段可能返回 null,表示取不到有效值。
示例值:flink-job-manager

LogicalType

SqlGateway返回LogicalType类型

被如下接口引用:FetchSqlGatewayStatementResult。

名称 类型 描述
Type String 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:VARCHAR
NullAble Boolean 是否允许为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
Length Integer 长度
注意:此字段可能返回 null,表示取不到有效值。
示例值:2147483647

NodeConfig

专家模式 计算节点的配置信息

被如下接口引用:CreateJobConfig。

名称 类型 必选 描述
Id Integer Node ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Parallelism Integer Node parallelism
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
SlotSharingGroup String Slot sharing group
注意:此字段可能返回 null,表示取不到有效值。
示例值:group1
Configuration Array of Property Configuration properties
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
StateTTL String 节点的状态ttl配置, 多个用 ; 分割
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

Order

集群购买、扩缩容、续费订单信息

被如下接口引用:DescribeClusters。

名称 类型 描述
Type Integer 创建、续费、扩缩容 1 2 3
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AutoRenewFlag Integer 自动续费 1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
OperateUin String 操作人的UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:1201111
ComputeCu Integer 最终集群的CU数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
OrderTime String 订单的时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-12-08 14:12:40

Property

系统配置属性

被如下接口引用:CreateJobConfig, DescribeClusters, DescribeJobConfigs。

名称 类型 必选 描述
Key String 系统配置的Key
Value String 系统配置的Value

RefJobStatusCountItem

依赖作业分状态计数信息

被如下接口引用:DescribeResourceConfigs, DescribeResources, DescribeTreeResources。

名称 类型 描述
JobStatus Integer 作业状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Count Integer 作业数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

ResourceConfigItem

描述资源配置的返回参数

被如下接口引用:DescribeResourceConfigs。

名称 类型 描述
ResourceId String 资源ID
ResourceType Integer 资源类型
Region String 资源所属地域
AppId Integer 资源所属AppId
OwnerUin String 主账号Uin
CreatorUin String 子账号Uin
ResourceLoc ResourceLoc 资源位置描述
CreateTime String 资源创建时间
Version Integer 资源版本
Remark String 资源描述
Status Integer 资源状态:0: 资源同步中,1:资源已就绪
注意:此字段可能返回 null,表示取不到有效值。
RefJobCount Integer 关联作业个数
注意:此字段可能返回 null,表示取不到有效值。
RefJobStatusCountSet Array of RefJobStatusCountItem 分状态统计关联作业数
注意:此字段可能返回 null,表示取不到有效值。

ResourceItem

资源详细描述

被如下接口引用:DescribeResources。

名称 类型 描述
ResourceId String 资源ID
示例值:"test"
Name String 资源名称
示例值:"test"
ResourceType Integer 资源类型
示例值:0
ResourceLoc ResourceLoc 资源位置
示例值:0
Region String 资源地域
示例值:"test"
AppId Integer 应用ID
示例值:0
OwnerUin String 主账号Uin
示例值:"test"
CreatorUin String 子账号Uin
示例值:"test"
CreateTime String 资源创建时间
示例值:"test"
UpdateTime String 资源最后更新时间
示例值:"test"
LatestResourceConfigVersion Integer 资源的资源版本ID
示例值:0
Remark String 资源备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:"test"
VersionCount Integer 版本个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RefJobCount Integer 关联作业数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
IsJobRun Integer 作业运行状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
FileName String 文件名
注意:此字段可能返回 null,表示取不到有效值。
示例值:"test"
WorkSpaceId Integer 工作空间ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RefJobStatusCountSet Array of RefJobStatusCountItem 分状态统计关联作业数
注意:此字段可能返回 null,表示取不到有效值。

ResourceLoc

资源位置描述

被如下接口引用:CreateResource, CreateResourceConfig, DescribeResourceConfigs, DescribeResources。

名称 类型 必选 描述
StorageType Integer 资源位置的存储类型,目前只支持1:COS
示例值:1
Param ResourceLocParam 描述资源位置的json
示例值:{"Bucket":"bucket1","Path":"your/path","Region":"ap-guangzhou"}

ResourceLocParam

资源参数描述

被如下接口引用:CreateResource, CreateResourceConfig。

名称 类型 必选 描述
Bucket String 资源bucket
示例值:scs-online-1257058945
Path String 资源路径
示例值:251008563/100000006047/flink-cos-fs-hadoop-oceanus-1-20210304112
Region String 资源所在地域,如果不填,则使用Resource的Region
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-chengdu

ResourceRef

资源引用参数

被如下接口引用:CreateJobConfig。

名称 类型 必选 描述
ResourceId String 资源ID
Version Integer 资源版本ID,-1表示使用最新版本
Type Integer 引用资源类型,例如主资源设置为1,代表main class所在的jar包

ResourceRefDetail

JobConfig引用资源信息

被如下接口引用:DescribeJobConfigs。

名称 类型 描述
ResourceId String 资源id
Version Integer 资源版本,-1表示使用最新版本
Name String 资源名称
Type Integer 1: 主资源
SystemProvide Integer 1: 系统内置资源

ResourceRefJobInfo

资源被Job 引用信息

被如下接口引用:DescribeResourceRelatedJobs。

名称 类型 描述
JobId String Job id
JobConfigVersion Integer Job配置版本
ResourceVersion Integer 资源版本

ResultColumn

Sql Gateway返回Column类型

被如下接口引用:FetchSqlGatewayStatementResult。

名称 类型 描述
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:result
LogicalType LogicalType 本地类型描述
注意:此字段可能返回 null,表示取不到有效值。
Comment String 备注
注意:此字段可能返回 null,表示取不到有效值。

ResultData

Sql Gateway返回数据

被如下接口引用:FetchSqlGatewayStatementResult。

名称 类型 描述
Kind String 操作类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:INSERT
Fields Array of String 结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:[OK]

RoleAuth

角色授权信息

被如下接口引用:DescribeWorkSpaces。

名称 类型 描述
AppId Integer 用户 AppID
示例值:1234567
WorkSpaceSerialId String 工作空间 SerialId
示例值:1327
OwnerUin String 主账号 UIN
示例值:34553634
CreatorUin String 创建者 UIN
示例值:34553634
AuthSubAccountUin String 绑定授权的 UIN
示例值:34553634
Permission Integer 对应 role表的id
示例值:2
CreateTime String 创建时间
示例值:2020-01-21 01:00:10
UpdateTime String 最后一次操作时间
示例值:2020-01-21 01:00:10
Status Integer 2 启用 1 停用
示例值:2
Id Integer id
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
WorkSpaceId Integer 工作空间id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RoleName String 权限名称
注意:此字段可能返回 null,表示取不到有效值。

RunJobDescription

作业启动详情

被如下接口引用:RunJobs。

名称 类型 必选 描述
JobId String 作业Id
示例值:cql-6w8eab6f
RunType Integer 运行类型,1:启动,2:恢复
示例值:1
StartMode String 兼容旧版 SQL 类型作业启动参数:指定数据源消费起始时间点(建议传值)
保证参数为 LATEST、EARLIEST、T+Timestamp (例:T1557394288000)
示例值:LATEST
JobConfigVersion Integer 当前作业的某个版本
(不传默认为非草稿的作业版本)
示例值:1
SavepointPath String Savepoint路径
示例值:Savepoint
SavepointId String Savepoint的Id
示例值:cql-6w8eab6f
UseOldSystemConnector Boolean 使用历史版本系统依赖
示例值:false
CustomTimestamp Integer 自定义时间戳
示例值:1690531378626

Savepoint

描述Savepoint信息

被如下接口引用:DescribeJobSavepoint。

名称 类型 描述
Id Integer 主键
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
VersionId Integer 版本号
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status Integer 状态 1: Active; 2: Expired; 3: InProgress; 4: Failed; 5: Timeout
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1652962710
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1652962710
Path String 路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:cosn://kkingtest-123/123/123/cql-i7985eg9/27/flink-checkpoints/0
Size Integer 大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:89446
RecordType Integer 快照类型 1: savepoint;2: checkpoint;3: cancelWithSavepoint
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
JobRuntimeId Integer 运行作业实例的顺序 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:Description
Timeout Integer 固定超时时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SerialId String 快照 serialId
注意:此字段可能返回 null,表示取不到有效值。
示例值:cql-6w8eab6f
TimeConsuming Integer 耗时
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PathStatus Integer 快照路径状态 1:可用;2:不可用;
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

SlotSharingGroup

SlotSharingGroup 描述

被如下接口引用:CreateJobConfig。

名称 类型 必选 描述
Name String SlotSharingGroup的名字
注意:此字段可能返回 null,表示取不到有效值。
示例值:ssgA
Spec SlotSharingGroupSpec SlotSharingGroup的规格
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
Description String SlotSharingGroup的描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:ssgA

SlotSharingGroupSpec

SlotSharingGroup的规格描述

被如下接口引用:CreateJobConfig。

名称 类型 必选 描述
CPU Float 适用的cpu
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.0
HeapMemory String 默认为b, 支持单位有 b, kb, mb, gb
注意:此字段可能返回 null,表示取不到有效值。
示例值:1gb
OffHeapMemory String 默认为b, 支持单位有 b, kb, mb, gb
注意:此字段可能返回 null,表示取不到有效值。
示例值:1gb
ManagedMemory String 默认为b, 支持单位有 b, kb, mb, gb
注意:此字段可能返回 null,表示取不到有效值。
示例值:1gb

SqlGatewayItem

SqlGateway配置信息

被如下接口引用:DescribeClusters。

名称 类型 描述
SerialId String 唯一标识
注意:此字段可能返回 null,表示取不到有效值。
FlinkVersion String Flink内核版本
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 状态,1.停止 2. 开启中 3. 开启 4. 开启失败 5. 停止中
注意:此字段可能返回 null,表示取不到有效值。
CreatorUin String 创建人
注意:此字段可能返回 null,表示取不到有效值。
ResourceRefs Array of GatewayRefItem 引用资源
注意:此字段可能返回 null,表示取不到有效值。
CuSpec Float Cu规格
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
Properties Array of Property 配置参数
注意:此字段可能返回 null,表示取不到有效值。

StatementResult

Sql Gateway 返回Result结构类型

被如下接口引用:FetchSqlGatewayStatementResult。

名称 类型 描述
Columns Array of ResultColumn 返回结果列
注意:此字段可能返回 null,表示取不到有效值。
RowFormat String 格式
注意:此字段可能返回 null,表示取不到有效值。
示例值:JSON
Data Array of ResultData 结果值
注意:此字段可能返回 null,表示取不到有效值。

StopJobDescription

停止作业的描述信息

被如下接口引用:StopJobs。

名称 类型 必选 描述
JobId String 作业Id
示例值:1
StopType Integer 停止类型,1 停止 2 暂停
示例值:1

SubFolderInfo

子目录信息

被如下接口引用:DescribeFolder。

名称 类型 描述
FolderId String folder id
示例值:folder-lfqkt10s
FolderName String folder name
示例值:test

SystemResourceItem

系统资源返回值

被如下接口引用:DescribeSystemResources。

名称 类型 描述
ResourceId String 资源ID
示例值:resource-9ds0xim0
Name String 资源名称
示例值:SampleProgram
ResourceType Integer 资源类型。1 表示 JAR 包,目前只支持该值。
示例值:1
Remark String 资源备注
示例值:我的测试程序包
Region String 资源所属地域
示例值:ap-guangzhou
LatestResourceConfigVersion Integer 资源的最新版本
示例值:2

Tag

标签

被如下接口引用:CreateJob, DescribeClusters, DescribeJobs。

名称 类型 必选 描述
TagKey String 标签键
注意:此字段可能返回 null,表示取不到有效值。
TagValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。

TraceModeConfiguration

{
"Rate": "0.01", ///如1%转换为0.01
"Operator": "1:OUT,2:IN_AND_OUT,3:IN" ///如1%转换为0.01
}
Operator
算子ID顺序配置,可以对每个算子配置IN、OUT、IN_AND_OUT三个值,分别表示采集输入数据、采集输出数据、同时采集输入和输出数据,配置示例:

被如下接口引用:CreateJobConfig, DescribeJobConfigs。

名称 类型 必选 描述
Rate String 如1%转换为0.01
注意:此字段可能返回 null,表示取不到有效值。
示例值:0.01
Operator String 按照算子ID顺序配置,可以对每个算子配置IN、OUT、IN_AND_OUT三个值,分别表示采集输入数据、采集输出数据、同时采集输入和输出数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:1:OUT,2:IN_AND_OUT,3:IN

TreeJobSets

自定义树结构出参作业列表

被如下接口引用:DescribeTreeJobs。

名称 类型 描述
JobId String 作业Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:cql-xxx
Name String 作业名
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
JobType Integer 作业类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RunningCu Float 作业占用资源
注意:此字段可能返回 null,表示取不到有效值。
示例值:2.00
Status Integer 作业状态 启动或者停止或者暂停
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

TreeResourceItem

树状结构资源对象

被如下接口引用:DescribeTreeResources。

名称 类型 描述
ResourceId String 资源ID
示例值:resource-××
Name String 资源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:××
ResourceType Integer 资源类型
示例值:1
Remark String 备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:××
FileName String 文件名
注意:此字段可能返回 null,表示取不到有效值。
示例值:a.txt
FolderId String 目录ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:folder-xxxx
RefJobStatusCountSet Array of RefJobStatusCountItem 分状态统计关联作业数
注意:此字段可能返回 null,表示取不到有效值。

WorkSpaceClusterItem

空间和集群绑定关系

被如下接口引用:DescribeClusters。

名称 类型 描述
ClusterGroupId Integer 集群 ID
示例值:1234
ClusterGroupSerialId String 集群 SerialId
示例值:cluster-xxxx
ClusterName String 集群名称
示例值:MyCluster
WorkSpaceId String 工作空间 SerialId
示例值:spc-xxx
WorkSpaceName String 工作空间名称
示例值:Myspace
Status Integer 绑定状态 2 绑定 1 解除绑定
示例值:1
ProjectId Integer 项目ID
示例值:1
ProjectIdStr String 项目ID string类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

WorkSpaceSetItem

工作空间详情

被如下接口引用:DescribeWorkSpaces。

名称 类型 描述
SerialId String 工作空间 SerialId
示例值:spc-xxx
AppId Integer 用户 APPID
示例值:32442423
OwnerUin String 主账号 UIN
示例值:424244
CreatorUin String 创建者 UIN
示例值:5345343
WorkSpaceName String 工作空间名称
示例值:myspace
Region String 区域
示例值:ap-beijing
CreateTime String 创建时间
示例值:2020-01-21 00:00:10
UpdateTime String 更新时间
示例值:2020-01-21 00:00:10
Status Integer 1 未初始化 2 可用 -1 已删除
示例值:2
Description String 工作空间描述
示例值:description
ClusterGroupSetItem Array of ClusterGroupSetItem 工作空间包含集群信息
RoleAuth Array of RoleAuth 工作空间角色的信息
RoleAuthCount Integer 工作空间成员数量
示例值:12
WorkSpaceId String 工作空间 SerialId
示例值:spc_xxx
JobsCount Integer 1
注意:此字段可能返回 null,表示取不到有效值。
示例值:1