tencentcloud-sdk-nodejs

/** * ParseConnector请求参数结构体 */ export interface ParseConnectorRequest { /** * 资源id */ ResourceId: string; /** * 资源版本 */ VersionId: number; /** * 空间 */ WorkSpaceId?: string; } /** * 复制作业单条明细结果 */ export interface CopyJobResult { /** * 原作业id 注意：此字段可能返回 null，表示取不到有效值。 */ JobId: string; /** * 原作业名称注意：此字段可能返回 null，表示取不到有效值。 */ JobName: string; /** * 新作业名称注意：此字段可能返回 null，表示取不到有效值。 */ TargetJobName: string; /** * 新作业id 注意：此字段可能返回 null，表示取不到有效值。 */ TargetJobId: string; /** * 失败时候的信息注意：此字段可能返回 null，表示取不到有效值。 */ Message: string; /** * 0 成功 -1 失败注意：此字段可能返回 null，表示取不到有效值。 */ Result: number; /** * 目标集群名称注意：此字段可能返回 null，表示取不到有效值。 */ ClusterName: string; /** * 目标集群id 注意：此字段可能返回 null，表示取不到有效值。 */ ClusterId: string; /** * 作业类型注意：此字段可能返回 null，表示取不到有效值。 */ JobType: number; } /** * CreateResource请求参数结构体 */ export interface CreateResourceRequest { /** * 资源位置 */ ResourceLoc: ResourceLoc; /** * 资源类型。目前只支持 JAR，取值为 1 */ ResourceType: number; /** * 资源描述 */ Remark?: string; /** * 资源名称 */ Name?: string; /** * 资源版本描述 */ ResourceConfigRemark?: string; /** * 目录ID */ FolderId?: string; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * ModifyFolder请求参数结构体 */ export interface ModifyFolderRequest { /** * 只有移动文件夹的场景必填，如果是批量移动作业的场景，非必填。 */ SourceFolderId?: string; /** * 如需拖拽文件夹，需传入目标文件夹ID */ TargetFolderId?: string; /** * 如需修改文件夹名，需传入FolderName字段 */ FolderName?: string; /** * 文件夹类型，0是任务文件夹，1是依赖文件夹 */ FolderType?: number; /** * 批量移动的作业serial id 列表 */ SourceJobIds?: Array<string>; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * DescribeJobSubmissionLog返回参数结构体 */ export interface DescribeJobSubmissionLogResponse { /** * 日志搜索的游标，需要搜索更多时透传这个值 */ Cursor?: string; /** * 是否返回了所有的日志记录 */ ListOver?: boolean; /** * 作业启动的requestId 注意：此字段可能返回 null，表示取不到有效值。 */ JobRequestId?: string; /** * 该时间段内符合关键字的所有的作业实例列表注意：此字段可能返回 null，表示取不到有效值。 */ JobInstanceList?: Array<JobInstanceForSubmissionLog>; /** * 废弃，请使用LogContentList 注意：此字段可能返回 null，表示取不到有效值。 */ LogList?: Array<string>; /** * 日志列表注意：此字段可能返回 null，表示取不到有效值。 */ LogContentList?: Array<LogContent>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteJobs请求参数结构体 */ export interface DeleteJobsRequest { /** * 作业Id列表 */ JobIds: Array<string>; /** * 工作空间Id */ WorkSpaceId?: string; /** * 作业名称列表 */ JobNames?: Array<string>; } /** * ModifyWorkSpace请求参数结构体 */ export interface ModifyWorkSpaceRequest { /** * 工作空间 SerialId */ WorkSpaceId: string; /** * 待修改的工作空间名称 */ WorkSpaceName?: string; /** * 待修改的工作空间备注 */ Description?: string; } /** * ModifyJob返回参数结构体 */ export interface ModifyJobResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateJobConfig返回参数结构体 */ export interface CreateJobConfigResponse { /** * 作业配置版本号 */ Version?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateResourceConfig返回参数结构体 */ export interface CreateResourceConfigResponse { /** * 资源版本ID */ Version?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateJobConfig请求参数结构体 */ export interface CreateJobConfigRequest { /** * 作业Id */ JobId: string; /** * 主类 */ EntrypointClass?: string; /** * 主类入参，需要区分下Sql作业配置，Jar作业配置，Python作业配置，具体参考下面的示例值 */ ProgramArgs?: string; /** * 备注 */ Remark?: string; /** * 资源引用数组 */ ResourceRefs?: Array<ResourceRef>; /** * 作业默认并行度 */ DefaultParallelism?: number; /** * 系统参数 */ Properties?: Array<Property>; /** * 1: 作业配置达到上限之后，自动删除可删除的最早版本 */ AutoDelete?: number; /** * 作业使用的 COS 存储桶名 */ COSBucket?: string; /** * 是否采集作业日志 */ LogCollect?: boolean; /** * JobManager规格 */ JobManagerSpec?: number; /** * TaskManager规格 */ TaskManagerSpec?: number; /** * CLS日志集ID */ ClsLogsetId?: string; /** * CLS日志主题ID */ ClsTopicId?: string; /** * 日志采集类型 2：CLS；3：COS */ LogCollectType?: number; /** * pyflink作业运行时使用的python版本 */ PythonVersion?: string; /** * 工作空间 SerialId */ WorkSpaceId?: string; /** * 日志级别 */ LogLevel?: string; /** * Oceanus 平台恢复作业开关 1:开启 -1: 关闭 */ AutoRecover?: number; /** * 类日志级别 */ ClazzLevels?: Array<ClazzLevel>; /** * 是否打开专家模式 */ ExpertModeOn?: boolean; /** * 专家模式的配置 */ ExpertModeConfiguration?: ExpertModeConfiguration; /** * trace链路 */ TraceModeOn?: boolean; /** * trace链路配置 */ TraceModeConfiguration?: TraceModeConfiguration; /** * checkpoint保留个数 */ CheckpointRetainedNum?: number; /** * 算子拓扑图 */ JobGraph?: JobGraph; /** * es索引名称 */ EsServerlessIndex?: string; /** * es索引空间 */ EsServerlessSpace?: string; /** * flink版本 */ FlinkVersion?: string; /** * JobManager cpu */ JobManagerCpu?: number; /** * JobManager 内存 */ JobManagerMem?: number; /** * jdk版本 */ JdkVersion?: string; /** * TaskManager cpu */ TaskManagerCpu?: number; /** * TaskManager 内存 */ TaskManagerMem?: number; /** * 0=默认使用老的 1=使用新的 */ UseOldSystemConnector?: number; /** * 压缩参数 */ ProgramArgsAfterGzip?: string; /** * checkpoint 超时时间单位：秒 */ CheckpointTimeoutSecond?: number; /** * checkpoint 间隔时间单位：秒 */ CheckpointIntervalSecond?: number; /** * 变量替换模式枚举值：<ul><li>0：表变量替换</li><li>1： SQL全局变量替换</li></ul>默认值：1 */ VariableReplaceMode?: number; /** * user */ OperatorName?: string; /** * 配置更新范围 0=全量(默认) 1=仅开发 2=仅运维 */ ConfigScope?: number; /** * 状态桶名字 */ StateCOSBucket?: string; } /** * 集群的版本相关信息 */ export interface ClusterVersion { /** * 集群的Flink版本注意：此字段可能返回 null，表示取不到有效值。 */ Flink?: string; /** * 集群支持的Flink版本注意：此字段可能返回 null，表示取不到有效值。 */ SupportedFlink?: Array<string>; /** * jdk支持版本 */ JdkSupportVersion?: Array<FlinkJdkVersion>; } /** * DescribeTreeJobs返回参数结构体 */ export interface DescribeTreeJobsResponse { /** * 父节点ID 注意：此字段可能返回 null，表示取不到有效值。 */ ParentId?: string; /** * 当前文件夹ID 注意：此字段可能返回 null，表示取不到有效值。 */ Id?: string; /** * 当前文件夹名 注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 当前文件夹下的作业列表 注意：此字段可能返回 null，表示取不到有效值。 */ JobSet?: Array<TreeJobSets>; /** * 迭代子目录 注意：此字段可能返回 null，表示取不到有效值。 */ Children?: Array<DescribeTreeJobsRsp>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CopyJobs请求参数结构体 */ export interface CopyJobsRequest { /** * 复制明细列表 */ JobItems: Array<CopyJobItem>; /** * 工作空间 SerialId */ WorkSpaceId?: string; /** * 目标工作空间 SerialId */ TargetWorkspaceId?: string; } /** * CopyJobs返回参数结构体 */ export interface CopyJobsResponse { /** * 成功条数注意：此字段可能返回 null，表示取不到有效值。 */ SuccessCount?: number; /** * 失败条数注意：此字段可能返回 null，表示取不到有效值。 */ FailCount?: number; /** * 结果列表注意：此字段可能返回 null，表示取不到有效值。 */ CopyJobsResults?: Array<CopyJobResult>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateConnector返回参数结构体 */ export interface CreateConnectorResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TriggerJobSavepoint请求参数结构体 */ export interface TriggerJobSavepointRequest { /** * 作业 SerialId */ JobId: string; /** * 描述 */ Description?: string; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * 日志查询的每行日志信息 */ export interface LogContent { /** * 日志内容注意：此字段可能返回 null，表示取不到有效值。 */ Log: string; /** * 毫秒级时间戳注意：此字段可能返回 null，表示取不到有效值。 */ Time: number; /** * 日志组Id 注意：此字段可能返回 null，表示取不到有效值。 */ PkgId: string; /** * 日志Id，在日志组范围里唯一 */ PkgLogId: number; /** * 日志所属的容器名注意：此字段可能返回 null，表示取不到有效值。 */ ContainerName: string; } /** * 作业运行时信息 */ export interface JobRuntimeInfo { /** * 运行信息的key，目前支持：TaskManagers：taskmanager pod 列表； StreamGraph：作业对应的 StreamGraph；SubTasks：作业的 subtask 列表注意：此字段可能返回 null，表示取不到有效值。 */ Key?: string; /** * 运行信息注意：此字段可能返回 null，表示取不到有效值。 */ Value?: string; } /** * ClusterBucketInfo 结构 */ export interface ClusterBucketInfo { /** * 桶唯一id 注意：此字段可能返回 null，表示取不到有效值。 */ SerialId?: string; /** * 集群id 注意：此字段可能返回 null，表示取不到有效值。 */ ClusterId?: number; /** * 桶名字 */ Bucket?: string; /** * 桶类型枚举值：<ul><li>0：普通桶</li><li>1：加速桶</li></ul> 注意：此字段可能返回 null，表示取不到有效值。 */ BucketType?: number; /** * 鉴权类型枚举值：<ul><li>0：不鉴权</li><li>1：鉴权</li></ul> 注意：此字段可能返回 null，表示取不到有效值。 */ AuthMode?: number; /** * 是否默认属性 注意：此字段可能返回 null，表示取不到有效值。 */ IsDefault?: number; /** * 桶状态枚举值：<ul><li>1：正常</li><li>0：禁用</li></ul> 注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 作业数量 注意：此字段可能返回 null，表示取不到有效值。 */ JobCount?: number; /** * 地域 注意：此字段可能返回 null，表示取不到有效值。 */ Region?: string; /** * 创建时间参数格式：yyyy-MM-dd HH:mm:ss 注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 更新时间参数格式：yyyy-MM-dd HH:mm:ss 注意：此字段可能返回 null，表示取不到有效值。 */ UpdateTime?: string; } /** * ScaleOceanusCluster请求参数结构体 */ export interface ScaleOceanusClusterRequest { /** * 集群ID */ ClusterId: string; /** * 集群的目标CU，需大于12CU，并且集群CU需要满足 12 + 7*n (n>=0) */ NewCU: number; /** * 扩容集群或者缩容集群枚举值：<ul><li>ScaleDown：缩容集群</li><li>ScaleUp：扩容集群</li></ul>默认值：ScaleUp */ ScaleMode?: string; } /** * 事件信息 */ export interface JobEventInfo { /** * 异常事件总数注意：此字段可能返回 null，表示取不到有效值。 */ ErrorEventTotal?: number; } /** * DescribeWorkSpaceUsers返回参数结构体 */ export interface DescribeWorkSpaceUsersResponse { /** * 空间用户列表 */ RoleAuths?: Array<RoleAuth>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 专家模式计算节点的配置信息 */ export interface NodeConfig { /** * Node ID 注意：此字段可能返回 null，表示取不到有效值。 */ Id: number; /** * Node parallelism 注意：此字段可能返回 null，表示取不到有效值。 */ Parallelism?: number; /** * Slot sharing group 注意：此字段可能返回 null，表示取不到有效值。 */ SlotSharingGroup?: string; /** * Configuration properties 注意：此字段可能返回 null，表示取不到有效值。 */ Configuration?: Array<Property>; /** * 节点的状态ttl配置, 多个用 ; 分割注意：此字段可能返回 null，表示取不到有效值。 */ StateTTL?: string; } /** * 工作空间详情 */ export interface WorkSpaceSetItem { /** * 工作空间 SerialId */ SerialId: string; /** * 用户 APPID */ AppId: number; /** * 主账号 UIN */ OwnerUin: string; /** * 创建者 UIN */ CreatorUin: string; /** * 工作空间名称 */ WorkSpaceName: string; /** * 区域 */ Region: string; /** * 创建时间 */ CreateTime: string; /** * 更新时间 */ UpdateTime: string; /** * 1 未初始化 2 可用 -1 已删除 */ Status: number; /** * 工作空间描述 */ Description: string; /** * 工作空间包含集群信息 */ ClusterGroupSetItem: Array<ClusterGroupSetItem>; /** * 工作空间角色的信息 */ RoleAuth: Array<RoleAuth>; /** * 工作空间成员数量 */ RoleAuthCount: number; /** * 工作空间 SerialId */ WorkSpaceId: string; /** * 1 注意：此字段可能返回 null，表示取不到有效值。 */ JobsCount: number; } /** * DescribeJobConfigs请求参数结构体 */ export interface DescribeJobConfigsRequest { /** * 作业Id */ JobId: string; /** * 作业配置版本 */ JobConfigVersions?: Array<number | bigint>; /** * 偏移量，默认0 */ Offset?: number; /** * 分页大小，默认20，最大100 */ Limit?: number; /** * 过滤条件 */ Filters?: Array<Filter>; /** * true 表示只展示草稿 */ OnlyDraft?: boolean; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * StopJobs请求参数结构体 */ export interface StopJobsRequest { /** * 批量停止作业的描述信息 */ StopJobDescriptions: Array<StopJobDescription>; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * Sql Gateway返回Column类型 */ export interface ResultColumn { /** * 名称注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 本地类型描述注意：此字段可能返回 null，表示取不到有效值。 */ LogicalType?: LogicalType; /** * 备注注意：此字段可能返回 null，表示取不到有效值。 */ Comment?: string; } /** * setats类型 */ export interface Setats { /** * setats serialId 注意：此字段可能返回 null，表示取不到有效值。 */ SetatsSerialId?: string; /** * 1 // 停止 2 // 运行中 3 // 初始化中 4 // 扩容中 5 // Warehoouse未配置 6 // Warehoouse配置中 7 // 重启中 -2 // 已删除(集群被销毁时更新为此状态) 注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * setats warehouse 注意：此字段可能返回 null，表示取不到有效值。 */ Warehouse?: Warehouse; /** * setats master 机器规格 注意：此字段可能返回 null，表示取不到有效值。 */ MasterInfo?: SetatsCvmInfo; /** * setats worker规格 注意：此字段可能返回 null，表示取不到有效值。 */ WorkerInfo?: SetatsCvmInfo; /** * 标签 注意：此字段可能返回 null，表示取不到有效值。 */ Tags?: Array<Tag>; /** * 自动续费 注意：此字段可能返回 null，表示取不到有效值。 */ AutoRenewFlag?: number; /** * 过期时间 注意：此字段可能返回 null，表示取不到有效值。 */ ExpireTime?: string; /** * 过期时间秒 注意：此字段可能返回 null，表示取不到有效值。 */ SecondsUntilExpiry?: string; /** * 创建时间 注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * manager url 注意：此字段可能返回 null，表示取不到有效值。 */ ManagerUrl?: string; /** * 隔离时间 注意：此字段可能返回 null，表示取不到有效值。 */ IsolatedTime?: string; /** * Setats集群自己的id */ OwnerClusterGroupSerialId?: string; /** * setats 集群类型 */ Type?: number; /** * Setats UI url */ SetatsUiUrl?: string; /** * setats镜像版本 */ ImageVersion?: string; /** * 类型：0 公网，1 内网枚举值：<ul><li>0：公网</li><li>1：内网</li></ul>默认值：0 */ WebUIType?: number; /** * Setats集群名字 */ Name?: string; /** * Setats集群描述 */ Remark?: string; /** * 集群隔离时间，0为7天，1为15天 */ IsolationPolicyVersion?: number; } /** * 自定义树结构出参作业列表 */ export interface TreeJobSets { /** * 作业Id 注意：此字段可能返回 null，表示取不到有效值。 */ JobId?: string; /** * 作业名 注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 作业类型 注意：此字段可能返回 null，表示取不到有效值。 */ JobType?: number; /** * 作业占用资源 注意：此字段可能返回 null，表示取不到有效值。 */ RunningCu?: number; /** * 作业状态启动或者停止或者暂停 注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 0:代表没开启调优任务，1:开启智能调优，2:代表定时调优 注意：此字段可能返回 null，表示取不到有效值。 */ ScalingType?: number; /** * RunningCpu 注意：此字段可能返回 null，表示取不到有效值。 */ RunningCpu?: number; /** * RunningMem 注意：此字段可能返回 null，表示取不到有效值。 */ RunningMem?: number; /** * sql 注意：此字段可能返回 null，表示取不到有效值。 */ DecodeSqlCode?: string; /** * 发布版本配置id */ PublishedJobConfigId?: number; /** * 完整的文件夹路径，仅在平铺模式下返回 */ FolderPath?: string; } /** * 资源详细描述 */ export interface ResourceItem { /** * 资源ID */ ResourceId?: string; /** * 资源名称 */ Name?: string; /** * 资源类型 */ ResourceType?: number; /** * 资源位置 */ ResourceLoc?: ResourceLoc; /** * 资源地域 */ Region?: string; /** * 应用ID */ AppId?: number; /** * 主账号Uin */ OwnerUin?: string; /** * 子账号Uin */ CreatorUin?: string; /** * 资源创建时间 */ CreateTime?: string; /** * 资源最后更新时间 */ UpdateTime?: string; /** * 资源的资源版本ID */ LatestResourceConfigVersion?: number; /** * 资源备注注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; /** * 版本个数注意：此字段可能返回 null，表示取不到有效值。 */ VersionCount?: number; /** * 关联作业数注意：此字段可能返回 null，表示取不到有效值。 */ RefJobCount?: number; /** * 作业运行状态 */ IsJobRun?: number; /** * 文件名注意：此字段可能返回 null，表示取不到有效值。 */ FileName?: string; /** * 工作空间ID 注意：此字段可能返回 null，表示取不到有效值。 */ WorkSpaceId?: number; /** * 分状态统计关联作业数注意：此字段可能返回 null，表示取不到有效值。 */ RefJobStatusCountSet?: Array<RefJobStatusCountItem>; /** * 连接器名称 */ Connector?: string; /** * 连接器版本 */ ConnectorVersion?: string; /** * 连接方式 */ ConnectionMethod?: string; /** * connector关联的资源id */ RelatedResourceId?: string; /** * 图标 */ Icon?: string; /** * 连接器中文名 */ ConnectorName?: string; /** * 连接器官网链接 */ ConnectorUrl?: string; } /** * 依赖作业分状态计数信息 */ export interface RefJobStatusCountItem { /** * 作业状态注意：此字段可能返回 null，表示取不到有效值。 */ JobStatus?: number; /** * 作业数量注意：此字段可能返回 null，表示取不到有效值。 */ Count?: number; } /** * RunSqlGatewayStatement请求参数结构体 */ export interface RunSqlGatewayStatementRequest { /** * 集群ID */ ClusterId: string; /** * 需要执行的sql，该sql会被Sql Gateway执行，当前支持的是paimon修改需求，因此主要是DDL语句 */ Sql: string; /** * Sql Gateway会话ID，可不填，如果不填则会自动创建一个会话ID，每个会话ID都有一个存活时间，测试环境为10分钟，线上默认是30分钟 */ SessionId?: string; } /** * DescribeFolder返回参数结构体 */ export interface DescribeFolderResponse { /** * folder id */ FolderId?: string; /** * folder name */ FolderName?: string; /** * 父文件夹id */ ParentId?: string; /** * 文件夹类型 */ FolderType?: number; /** * workspace id */ WorkSpaceId?: string; /** * 子文件夹信息注意：此字段可能返回 null，表示取不到有效值。 */ SubFolderInfo?: Array<SubFolderInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyConnector请求参数结构体 */ export interface ModifyConnectorRequest { /** * 空间 */ WorkSpaceId: string; /** * connector ID */ ConnectorResourceId: string; /** * 资源id */ ResourceId?: string; /** * 资源版本 */ VersionId?: number; /** * 连接器名称 */ Connector?: string; /** * 连接方式 */ ConnectionMethod?: string; } /** * setats disk */ export interface SetatsDisk { /** * 磁盘类型 CLOUD_BSSD CLOUD_SSD CLOUD_HSSD CLOUD_PREMIUM 注意：此字段可能返回 null，表示取不到有效值。 */ DiskType?: string; /** * 磁盘大小单位：GB 注意：此字段可能返回 null，表示取不到有效值。 */ DiskSize?: number; } /** * 资源位置描述 */ export interface ResourceLoc { /** * 资源位置的存储类型，目前只支持1:COS */ StorageType: number; /** * 描述资源位置的json */ Param: ResourceLocParam; } /** * RenewOceanusCluster返回参数结构体 */ export interface RenewOceanusClusterResponse { /** * 参数值success代表操作执行成功 */ TaskExecResult?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 云联网描述信息 */ export interface CCN { /** * 私有网络 ID */ VpcId: string; /** * 子网 ID */ SubnetId: string; /** * 云联网 ID，如 ccn-rahigzjd */ CcnId: string; } /** * DescribeWorkSpaces请求参数结构体 */ export interface DescribeWorkSpacesRequest { /** * 偏移量，默认 0 */ Offset?: number; /** * 1 按照创建时间降序排序(默认) 2.按照创建时间升序排序，3. 按照状态降序排序 4. 按照状态升序排序默认为0 */ OrderType?: number; /** * 请求的集群数量，默认 20 */ Limit?: number; /** * 过滤规则 */ Filters?: Array<Filter>; } /** * 资源被Job 引用信息 */ export interface ResourceRefJobInfo { /** * Job id */ JobId?: string; /** * Job配置版本 */ JobConfigVersion?: number; /** * 资源版本 */ ResourceVersion?: number; } /** * CreateOceanusCluster返回参数结构体 */ export interface CreateOceanusClusterResponse { /** * 创建的集群ID参数格式：cluster-xxx */ ClusterId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTreeResources请求参数结构体 */ export interface DescribeTreeResourcesRequest { /** * 筛选条件字段 */ Filters?: Array<Filter>; /** * 工作空间 SerialId */ WorkSpaceId?: string; /** * 分页游标 */ Offset?: number; /** * 单页显示数 */ Limit?: number; } /** * DescribeResourceConfigs返回参数结构体 */ export interface DescribeResourceConfigsResponse { /** * 资源配置描述数组 */ ResourceConfigSet?: Array<ResourceConfigItem>; /** * 资源配置数量 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 变量信息列表 */ export interface VariableItem { /** * 变量id 注意：此字段可能返回 null，表示取不到有效值。 */ SerialId?: string; /** * 变量名 注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 变量值 注意：此字段可能返回 null，表示取不到有效值。 */ Value?: string; /** * 变量值类型枚举值：<ul><li>0：自定义变量</li><li>1：凭据值</li></ul> */ ValueType?: number; /** * 凭据所在地域 */ SecretRegion?: string; /** * 凭据名称 */ SecretName?: string; /** * 凭据版本 */ SecretVersionId?: string; /** * 变量值是否隐藏 注意：此字段可能返回 null，表示取不到有效值。 */ Type?: number; /** * 变量描述 注意：此字段可能返回 null，表示取不到有效值。 */ Remark?: string; /** * 变量创建时间 注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 变量创建人 注意：此字段可能返回 null，表示取不到有效值。 */ CreatorUin?: string; } /** * DescribeClusters请求参数结构体 */ export interface DescribeClustersRequest { /** * 按照一个或者多个集群 ID 查询，每次请求的集群上限为 100 */ ClusterIds?: Array<string>; /** * 偏移量，默认 0 */ Offset?: number; /** * 请求的集群数量，默认 20，最大值 100 */ Limit?: number; /** * 集群信息结果排序规则，1 按时间降序，2 按照时间升序，3 按照状态排序 */ OrderType?: number; /** * 过滤规则 - Name 按照集群的名字进行模糊查询。例如：测试类型： String 必选：否 */ Filters?: Array<Filter>; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * CreateWorkSpace返回参数结构体 */ export interface CreateWorkSpaceResponse { /** * 工作空间 SerialId */ WorkSpaceId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 多可用区支持备区域 */ export interface SlaveZone { /** * vpc 注意：此字段可能返回 null，表示取不到有效值。 */ VpcId?: string; /** * 子网注意：此字段可能返回 null，表示取不到有效值。 */ SubnetId?: string; /** * 区注意：此字段可能返回 null，表示取不到有效值。 */ Zone?: string; } /** * CreateJob返回参数结构体 */ export interface CreateJobResponse { /** * 作业Id */ JobId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SqlGateway配置信息 */ export interface SqlGatewayItem { /** * 唯一标识 注意：此字段可能返回 null，表示取不到有效值。 */ SerialId?: string; /** * Flink内核版本 注意：此字段可能返回 null，表示取不到有效值。 */ FlinkVersion?: string; /** * 状态，1.停止 2. 开启中 3. 开启 4. 开启失败 5. 停止中 注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 创建人 注意：此字段可能返回 null，表示取不到有效值。 */ CreatorUin?: string; /** * 引用资源 注意：此字段可能返回 null，表示取不到有效值。 */ ResourceRefs?: Array<GatewayRefItem>; /** * Cu规格 注意：此字段可能返回 null，表示取不到有效值。 */ CuSpec?: number; /** * 创建时间 注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 更新时间 注意：此字段可能返回 null，表示取不到有效值。 */ UpdateTime?: string; /** * 配置参数 注意：此字段可能返回 null，表示取不到有效值。 */ Properties?: Array<Property>; /** * Cpu */ Cpu?: number; /** * Mem */ Mem?: number; /** * jdk版本 */ JdkVersion?: string; /** * session id 注意：此字段可能返回 null，表示取不到有效值。 */ SessionClusterId?: string; /** * pg用户名 注意：此字段可能返回 null，表示取不到有效值。 */ PgUser?: string; /** * 协议 注意：此字段可能返回 null，表示取不到有效值。 */ Endpoints?: Array<SqlGatewayEndpoint>; } /** * DescribeVariables请求参数结构体 */ export interface DescribeVariablesRequest { /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * DescribeJobRuntimeInfo返回参数结构体 */ export interface DescribeJobRuntimeInfoResponse { /** * 作业运行时信息 */ JobRuntimeInfo?: Array<JobRuntimeInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 停止作业的描述信息 */ export interface StopJobDescription { /** * 作业Id */ JobId: string; /** * 停止类型，1 停止 2 暂停 */ StopType: number; } /** * CreateFolder请求参数结构体 */ export interface CreateFolderRequest { /** * 新建文件夹名 */ FolderName: string; /** * 新建文件夹的父目录ID（根目录为"root"） */ ParentId: string; /** * 文件夹类型，0是任务文件夹，1是依赖文件夹 */ FolderType?: number; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * DeleteJobConfigs返回参数结构体 */ export interface DeleteJobConfigsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteTableConfig请求参数结构体 */ export interface DeleteTableConfigRequest { /** * 作业ID */ JobId: string; /** * 调试作业ID */ DebugId: number; /** * 表名 */ TableName: string; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * Sql Gateway 返回Result结构类型 */ export interface StatementResult { /** * 返回结果列注意：此字段可能返回 null，表示取不到有效值。 */ Columns?: Array<ResultColumn>; /** * 格式注意：此字段可能返回 null，表示取不到有效值。 */ RowFormat?: string; /** * 结果值注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array<ResultData>; } /** * 自定义树结构遍历子节点 */ export interface DescribeTreeJobsRsp { /** * 父节点ID 注意：此字段可能返回 null，表示取不到有效值。 */ ParentId?: string; /** * 当前文件夹ID 注意：此字段可能返回 null，表示取不到有效值。 */ Id?: string; /** * 当前文件夹名注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 当前文件夹下的作业集合注意：此字段可能返回 null，表示取不到有效值。 */ JobSet?: Array<TreeJobSets>; /** * 迭代子目录注意：此字段可能返回 null，表示取不到有效值。 */ Children?: Array<DescribeTreeJobsRsp>; /** * 请求ID 注意：此字段可能返回 null，表示取不到有效值。 */ RequestId?: string; /** * attach-000 注意：此字段可能返回 null，表示取不到有效值。 */ PageAttach?: string; /** * bool 注意：此字段可能返回 null，表示取不到有效值。 */ HasMore?: boolean; } /** * DeleteResources返回参数结构体 */ export interface DeleteResourcesResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteTableConfig返回参数结构体 */ export interface DeleteTableConfigResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SlotSharingGroup的规格描述 */ export interface SlotSharingGroupSpec { /** * 适用的cpu 注意：此字段可能返回 null，表示取不到有效值。 */ CPU: number; /** * 默认为b, 支持单位有 b, kb, mb, gb 注意：此字段可能返回 null，表示取不到有效值。 */ HeapMemory: string; /** * 默认为b, 支持单位有 b, kb, mb, gb 注意：此字段可能返回 null，表示取不到有效值。 */ OffHeapMemory?: string; /** * 默认为b, 支持单位有 b, kb, mb, gb 注意：此字段可能返回 null，表示取不到有效值。 */ ManagedMemory?: string; } /** * 标签 */ export interface Tag { /** * 标签键注意：此字段可能返回 null，表示取不到有效值。 */ TagKey?: string; /** * 标签值注意：此字段可能返回 null，表示取不到有效值。 */ TagValue?: string; } /** * GetMetaTable返回参数结构体 */ export interface GetMetaTableResponse { /** * 元数据表唯一标识 */ SerialId?: string; /** * 目录名 */ Catalog?: string; /** * 库名 */ Database?: string; /** * 表名 */ Table?: string; /** * 建表语句,使用 Base64 编码。例如 Q1JFQVRFIFRBQkxFIGRhdGFnZW5fc291cmNlX3RhYmxlICggCiAgICBpZCBJTlQsIAogICAgbmFtZSBTVFJJTkcgCikgV0lUSCAoCidjb25uZWN0b3InPSdkYXRhZ2VuJywKJ3Jvd3MtcGVyLXNlY29uZCcgPSAnMScKKTs= */ DDL?: string; /** * 创建时间 */ CreateTime?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * FetchSqlGatewayStatementResult返回参数结构体 */ export interface FetchSqlGatewayStatementResultResponse { /** * 错误信息注意：此字段可能返回 null，表示取不到有效值。 */ ErrorMessage?: Array<string>; /** * 返回类型注意：此字段可能返回 null，表示取不到有效值。 */ ResultType?: string; /** * 是否DQL结果注意：此字段可能返回 null，表示取不到有效值。 */ IsQueryResult?: boolean; /** * 结果类型注意：此字段可能返回 null，表示取不到有效值。 */ ResultKind?: string; /** * 结果注意：此字段可能返回 null，表示取不到有效值。 */ Results?: StatementResult; /** * 下一次请求的uri 注意：此字段可能返回 null，表示取不到有效值。 */ NextResultUri?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeJobSavepoint返回参数结构体 */ export interface DescribeJobSavepointResponse { /** * 快照列表总数注意：此字段可能返回 null，表示取不到有效值。 */ TotalNumber?: number; /** * 快照列表注意：此字段可能返回 null，表示取不到有效值。 */ Savepoint?: Array<Savepoint>; /** * 进行中的快照列表注意：此字段可能返回 null，表示取不到有效值。 */ RunningSavepoint?: Array<Savepoint>; /** * 进行中的快照列表总数注意：此字段可能返回 null，表示取不到有效值。 */ RunningTotalNumber?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Flink Job 运行图的点信息 */ export interface JobGraphNode { /** * 节点ID 注意：此字段可能返回 null，表示取不到有效值。 */ Id: number; /** * 节点描述注意：此字段可能返回 null，表示取不到有效值。 */ Description: string; /** * 节点名称注意：此字段可能返回 null，表示取不到有效值。 */ Name: string; /** * 节点并行度注意：此字段可能返回 null，表示取不到有效值。 */ Parallelism: number; } /** * CreateWorkSpace请求参数结构体 */ export interface CreateWorkSpaceRequest { /** * 工作空间名称 */ WorkSpaceName: string; /** * 项目空间备注 */ Description?: string; } /** * DeleteResourceConfigs请求参数结构体 */ export interface DeleteResourceConfigsRequest { /** * 资源ID */ ResourceId: string; /** * 资源版本数组 */ ResourceConfigVersions: Array<number | bigint>; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * DescribeVariables返回参数结构体 */ export interface DescribeVariablesResponse { /** * ["x","y"] */ VariableSet?: Array<VariableItem>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteFolders请求参数结构体 */ export interface DeleteFoldersRequest { /** * 需删除的文件夹唯一ID */ FolderIds: Array<string>; /** * 文件夹类型，0是任务文件夹，1是依赖文件夹 */ FolderType?: number; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * DeleteWorkSpace请求参数结构体 */ export interface DeleteWorkSpaceRequest { /** * 工作空间 SerialId */ WorkSpaceId: string; } /** * DescribeJobRuntimeInfo请求参数结构体 */ export interface DescribeJobRuntimeInfoRequest { /** * 作业ID */ JobId: string; /** * 工作空间ID */ WorkSpaceId: string; /** * 作业运行信息 key */ IncludeInfo: Array<string>; } /** * DescribeWorkSpaces返回参数结构体 */ export interface DescribeWorkSpacesResponse { /** * 空间详情列表注意：此字段可能返回 null，表示取不到有效值。 */ WorkSpaceSetItem?: Array<WorkSpaceSetItem>; /** * 空间总数 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Gateway引用资源信息 */ export interface GatewayRefItem { /** * 空间唯一标识注意：此字段可能返回 null，表示取不到有效值。 */ WorkspaceId: string; /** * 资源唯一标识注意：此字段可能返回 null，表示取不到有效值。 */ ResourceId: string; /** * 版本号注意：此字段可能返回 null，表示取不到有效值。 */ Version: number; /** * 引用类型，0:用户资源注意：此字段可能返回 null，表示取不到有效值。 */ Type: number; } /** * CreateOceanusCluster请求参数结构体 */ export interface CreateOceanusClusterRequest { /** * 集群名称入参限制：支持1-50个英文、汉字、数字、连接线-或下划线_ */ ClusterName: string; /** * 地域Id，可通过地域管理系统<a href="https://cloud.tencent.com/document/api/1596/77930"> DescribeRegions</a>查询Product参数设置 oceanus */ RegionId: number; /** * 可用区Id，可通过地域管理系统<a href="https://cloud.tencent.com/document/api/1596/77929"> DescribeZones</a>查询 Product参数设置 oceanus */ ZoneId: number; /** * FlinkUI访问密码用户名与密码将用于登录查看作业的 Flink UI 界面，集群用户名:admin */ LoginPassword: string; /** * 流计算通过 VPC 和弹性网卡来访问同地域中的其他云产品资源，并需要占用一定的子网 IP 数量，请确保所选子网的可用 IP 数量充足如现有网络不符合您的要求，请前往 VPC 控制台<a href="https://console.cloud.tencent.com/vpc/vpc?rid=undefined">新建私有网络</a> 或 <a href="https://console.cloud.tencent.com/vpc/subnet?rid=undefined">新建子网</a> */ VpcDescriptions: Array<VPCDescription>; /** * 流计算使用对象存储 COS 来保存作业的 checkpoint、jar 包、或投递日志等，如本地域无可用存储桶，请前往<a href="https://console.cloud.tencent.com/cos5">对象存储控制台</a>新建为了保证您的正常使用，对应COS的生命周期配置请参考<a href="https://cloud.tencent.com/document/product/436/33417?from=console_document_search">文档</a> */ DefaultCOSBucket: string; /** * 集群CU数， 12 CU 是流计算的最小计算资源和计费单位，1CU 包含1个 CPU 和 4GB 内存。当CU数大于等于 48 时，减免管理节点费用。 */ CU?: number; /** * 集群描述入参限制：支持1-50个英文、汉字、数字、连接线-或下划线_ */ Remark?: string; /** * 购买时长，以月为单位取值范围：[1, 48] */ Period?: number; /** * 集群计费类型枚举值：<ul><li>PREPAID：包年包月</li><li>POSTPAID_BY_SECOND：按量计费</li></ul>默认值：POSTPAID_BY_SECOND */ InstanceChargeType?: string; /** * 集群类型枚举值：<ul><li>MULTI_AZ_CLUSTER：多可用区集群</li></ul> */ ClusterType?: string; /** * 自动续费标识枚举值：<ul><li>NOTIFY_AND_MANUAL_RENEW：通知并手动续费</li><li>NOTIFY_AND_AUTO_RENEW：通知并自动续费</li><li>DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知并不自动续费</li></ul>默认值：NOTIFY_AND_MANUAL_RENEWInstanceChargeType设置PREPAID时，对应包年包月集群，需要设置自动续费标识，按量计费集群不需要设置 */ RenewFlag?: string; /** * Flink UI访问类型设置枚举值：<ul><li>NetworkAccess_INTERNAL：内网访问</li><li>NetworkAccess_EXTERNAL：公网访问</li></ul>默认值：NetworkAccess_EXTERNAL */ FlinkWebUINetworkAccessType?: string; /** * 多可用区VPC */ SlaveVpcDescriptions?: Array<SlaveVpcDescriptions>; /** * 核心内存比值，只支持 [0，2，4，8] */ CUMemory?: number; } /** * CreateResource返回参数结构体 */ export interface CreateResourceResponse { /** * 资源ID */ ResourceId?: string; /** * 资源版本 */ Version?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 资源引用 */ export interface ResourceRefLatest { /** * 资源id 注意：此字段可能返回 null，表示取不到有效值。 */ ResourceId?: string; /** * 版本号 注意：此字段可能返回 null，表示取不到有效值。 */ Version?: number; /** * 资源类型枚举值：<ul><li>1： Main资源</li><li>2：依赖资源</li><li>3： python文件</li><li>4：数据文件</li></ul> 注意：此字段可能返回 null，表示取不到有效值。 */ Type?: number; /** * 状态枚举值：<ul><li>1：活跃</li><li>-2：删除</li></ul> 注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 空间id 注意：此字段可能返回 null，表示取不到有效值。 */ WorkspaceId?: string; /** * 资源名称 注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; } /** * DescribeSystemResources请求参数结构体 */ export interface DescribeSystemResourcesRequest { /** * 需要查询的资源ID数组 */ ResourceIds?: Array<string>; /** * 偏移量，仅当设置 Limit 参数时有效 */ Offset?: number; /** * 条数限制，默认返回 20 条 */ Limit?: number; /** * 查询资源配置列表，如果不填写，返回该 ResourceIds.N 下所有作业配置列表 */ Filters?: Array<Filter>; /** * 集群ID */ ClusterId?: string; /** * 查询对应Flink版本的内置connector */ FlinkVersion?: string; /** * 空间 */ WorkSpaceId?: string; } /** * CreateFolder返回参数结构体 */ export interface CreateFolderResponse { /** * 新建文件夹的唯一ID */ FolderId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeResources返回参数结构体 */ export interface DescribeResourcesResponse { /** * 资源详细信息集合 */ ResourceSet?: Array<ResourceItem>; /** * 总数量 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 作业启动详情 */ export interface RunJobDescription { /** * 作业Id */ JobId: string; /** * 运行类型，1：启动，2：恢复 */ RunType: number; /** * 兼容旧版 SQL 类型作业启动参数：指定数据源消费起始时间点（建议传值）保证参数为 LATEST、EARLIEST、T+Timestamp （例:T1557394288000） */ StartMode?: string; /** * 当前作业的某个版本（不传默认为非草稿的作业版本） */ JobConfigVersion?: number; /** * Savepoint路径 */ SavepointPath?: string; /** * Savepoint的Id */ SavepointId?: string; /** * 使用历史版本系统依赖 */ UseOldSystemConnector?: boolean; /** * 自定义时间戳 */ CustomTimestamp?: number; /** * timestamp; latest-offset; earliest-offset; 任选一种 */ KafkaScanMode?: string; } /** * 多可用区VPC */ export interface SlaveVpcDescriptions { /** * 私有网络ID */ VpcId: string; /** * 子网ID */ SubnetId: string; /** * 用户AppId */ AppId?: number; /** * 用户UIN */ OwnerUin?: string; } /** * DescribeResourceRelatedJobs返回参数结构体 */ export interface DescribeResourceRelatedJobsResponse { /** * 总数 */ TotalCount?: number; /** * 关联作业信息 */ RefJobInfos?: Array<ResourceRefJobInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SqlGateway返回LogicalType类型 */ export interface LogicalType { /** * 类型 注意：此字段可能返回 null，表示取不到有效值。 */ Type?: string; /** * 是否允许为空 注意：此字段可能返回 null，表示取不到有效值。 */ NullAble?: boolean; /** * 长度单位：字符数 注意：此字段可能返回 null，表示取不到有效值。 */ Length?: number; } /** * 解析Connector */ export interface Connectors { /** * 连接方式 */ ConnectionMethod?: string; /** * 连接器名称 */ Connector?: string; /** * 是否已经被使用 */ Existed?: boolean; } /** * DescribeClusters返回参数结构体 */ export interface DescribeClustersResponse { /** * 集群总数 */ TotalCount?: number; /** * 集群列表 */ ClusterSet?: Array<Cluster>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckConnectorName返回参数结构体 */ export interface CheckConnectorNameResponse { /** * 是否存在 */ Exists?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 资源引用参数 */ export interface ResourceRef { /** * 资源ID */ ResourceId: string; /** * 资源版本 */ Version: number; /** * 0-引用 JAR 程序包，1-主程序包，2-引用配置文件，3-Python程序包，4-Python数据文件 */ Type: number; } /** * DescribeSystemResources返回参数结构体 */ export interface DescribeSystemResourcesResponse { /** * 资源详细信息集合 */ ResourceSet?: Array<SystemResourceItem>; /** * 总数量 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * { "Clazz": "c1", // java类全路径 "Level": "WARN" // 日志级别 TRACE，DEBUG、INFO、WARN、ERROR } */ export interface ClazzLevel { /** * java类全路径注意：此字段可能返回 null，表示取不到有效值。 */ Clazz: string; /** * 日志级别 TRACE，DEBUG、INFO、WARN、ERROR 注意：此字段可能返回 null，表示取不到有效值。 */ Level: string; } /** * 混合计费 */ export interface SubEks { /** * 集群id 注意：此字段可能返回 null，表示取不到有效值。 */ SerialId?: string; /** * cu数注意：此字段可能返回 null，表示取不到有效值。 */ CuNum?: number; /** * 状态注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 状态描述注意：此字段可能返回 null，表示取不到有效值。 */ StatusDesc?: string; /** * 运行cu 注意：此字段可能返回 null，表示取不到有效值。 */ RunningCu?: number; /** * 总的CPU */ TotalCpu?: number; /** * 总的内存 */ TotalMem?: number; /** * 运行的CPU */ RunningCpu?: number; /** * 运行的内存 */ RunningMem?: number; } /** * 空间和集群绑定关系 */ export interface WorkSpaceClusterItem { /** * 集群 ID */ ClusterGroupId: number; /** * 集群 SerialId */ ClusterGroupSerialId: string; /** * 集群名称 */ ClusterName: string; /** * 工作空间 SerialId */ WorkSpaceId: string; /** * 工作空间名称 */ WorkSpaceName: string; /** * 绑定状态 2 绑定 1 解除绑定 */ Status: number; /** * 项目ID */ ProjectId: number; /** * 项目ID string类型注意：此字段可能返回 null，表示取不到有效值。 */ ProjectIdStr: string; } /** * CheckSavepoint请求参数结构体 */ export interface CheckSavepointRequest { /** * 作业 id */ JobId: string; /** * 快照资源 id */ SerialId: string; /** * 快照类型 1: savepoint；2: checkpoint；3: cancelWithSavepoint */ RecordType: number; /** * 快照路径，目前只支持 cos 路径 */ SavepointPath: string; /** * 工作空间 id */ WorkSpaceId: string; } /** * DeleteJobConfigs请求参数结构体 */ export interface DeleteJobConfigsRequest { /** * 作业ID */ JobId: string; /** * 作业配置版本数组 */ JobConfigVersions: Array<number | bigint>; /** * 工作空间 SerialId */ WorkSpaceId?: string; /** * 配置更新范围 0=全量(默认) 1=仅开发 2=仅运维取值范围：[0, 2] */ ConfigScope?: number; } /** * RenewOceanusCluster请求参数结构体 */ export interface RenewOceanusClusterRequest { /** * 集群ID参数格式：cluster-xxx */ ClusterId: string; /** * 续费的时长，单位为月，只支持包年包月集群取值范围：[1, 36] */ Period: number; } /** * { "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三个值，分别表示采集输入数据、采集输出数据、同时采集输入和输出数据，配置示例: */ export interface TraceModeConfiguration { /** * 如1%转换为0.01 注意：此字段可能返回 null，表示取不到有效值。 */ Rate?: string; /** * 按照算子ID顺序配置，可以对每个算子配置IN、OUT、IN_AND_OUT三个值，分别表示采集输入数据、采集输出数据、同时采集输入和输出数据注意：此字段可能返回 null，表示取不到有效值。 */ Operator?: string; } /** * RunJobs请求参数结构体 */ export interface RunJobsRequest { /** * 批量启动作业的描述信息 */ RunJobDescriptions: Array<RunJobDescription>; /** * 工作空间 SerialId */ WorkSpaceId?: string; } /** * DeleteWorkSpace返回参数结构体 */ export interface DeleteWorkSpaceResponse { /** * 是否删除 */ Delete?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * hadoopYarn资源信息 */ export interface HadoopYarnItem { /** * ClusterGroupSerialId */ ClusterGroupSerialId: string; /** * 状态枚举值：<ul><li>1：停止</li><li>2：开启中</li><li>3：启动</li><li>4：开启失败</li><li>5：停止中</li></ul> 注意：此字段可能返回 null，表示取不到有效值。 */ Status: number; /** * cpu 注意：此字段可能返回 null，表示取不到有效值。 */ Cpu: number; /** * mem */ Mem?: number; /** * 创建时间 */ CreateTime?: string; /** * 更新时间 */ UpdateTime?: string; /** * 配置文件内容 */ Config?: string; /** * CreatorUin */ CreatorUin?: string; } /** * TriggerJobSavepoint返回参数结构体 */ export interface TriggerJobSavepointResponse { /** * 是否成功 */ SavepointTrigger?: boolean; /** * 错误消息注意：此字段可能返回 null，表示取不到有效值。 */ ErrorMsg?: string; /** * 快照路径注意：此字段可能返回 null，表示取不到有效值。 */ FinalSavepointPath?: string; /** * 快照 ID 注意：此字段可能返回 null，表示取不到有效值。 */ SavepointId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * HiveMetastoreInfo */ export interface HiveMetastoreInfo { /** * hms serialId */ HiveMetastoreSerialId?: string; /** * 集群SerialId */ ClusterGroupSerialId?: string; /** * 状态枚举枚举值：<ul><li>3：运行中</li><li>1：初始化中</li><li>2：部署中</li><li>-2：已删除</li></ul> */ Status?: number; /** * 使用核数单位：cu */ Cpu?: number; /** * 使用内存资源单位：GB */ MemGB?: number; /** * 副本数 */ Replica?: number; /** * hms 访问uri 注意：此字段可能返回 null，表示取不到有效值。 */ HiveUri?: string; /** * 命名空间 注意：此字段可能返回 null，表示取不到有效值。 */ HiveNamespace?: string; /** * 创建时间 注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 更新时间 注意：此字段可能返回 null，表示取不到有效值。 */ UpdateTime?: string; /** * Warehouse地址 注意：此字段可能返回 null，表示取不到有效值。 */ HiveMetastoreWarehouseDir?: string; /** * 高级参数 注意：此字段可能返回 null，表示取不到有效值。 */ Config?: Array<Property>; } /** * DeleteJobs返回参数结构体 */ export interface DeleteJobsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 系统配置属性 */ export interface Property { /** * 系统配置的Key */ Key: string; /** * 系统配置的Value */ Value: string; } /** * Flink Job 运行图的边信息 */ export interface JobGraphEdge { /** * 边的起始节点ID 注意：此字段可能返回 null，表示取不到有效值。 */ Source: number; /** * 边的目标节点ID 注意：此字段可能返回 null，表示取不到有效值。 */ Target: number; } /** * 描述Savepoint信息 */ export interface Savepoint { /** * 主键 注意：此字段可能返回 null，表示取不到有效值。 */ Id?: number; /** * 版本号 注意：此字段可能返回 null，表示取不到有效值。 */ VersionId?: number; /** * 状态 1: Active; 2: Expired; 3: InProgress; 4: Failed; 5: Timeout 注