{
  "name": "oceanus",
  "display_name": "流计算 Oceanus",
  "description": "用户可以使用云 API 来实现作业、资源的管理。",
  "domain": "database",
  "api_version": "2019-04-22",
  "endpoint": "oceanus.tencentcloudapi.com",
  "actions": [
    {
      "name": "CheckConnectorName",
      "description": "查询资源名是否重复",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "资源名",
          "example": "mj-test"
        }
      ],
      "required": [
        "Name"
      ]
    },
    {
      "name": "CheckSavepoint",
      "description": "检查快照是否可用",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业 id",
          "example": "cql-52xkpymp"
        },
        {
          "name": "SerialId",
          "type": "string",
          "required": true,
          "description": "快照资源 id",
          "example": "svp-52xkpymp"
        },
        {
          "name": "RecordType",
          "type": "integer",
          "required": true,
          "description": "快照类型 1: savepoint；2: checkpoint；3: cancelWithSavepoint",
          "example": "1"
        },
        {
          "name": "SavepointPath",
          "type": "string",
          "required": true,
          "description": "快照路径，目前只支持 cos 路径",
          "example": "cosn://xxx/xxx"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": true,
          "description": "工作空间 id",
          "example": "space-1327"
        }
      ],
      "required": [
        "JobId",
        "SerialId",
        "RecordType",
        "SavepointPath",
        "WorkSpaceId"
      ]
    },
    {
      "name": "CopyJobs",
      "description": "单条和批量复制作业",
      "status": "online",
      "parameters": [
        {
          "name": "JobItems",
          "type": "array",
          "required": true,
          "description": "复制明细列表",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "SourceId",
              "type": "string",
              "required": true,
              "description": "需要复制的作业serial id",
              "example": "cql-pqx9zh30"
            },
            {
              "name": "TargetClusterId",
              "type": "string",
              "required": true,
              "description": "目标集群的cluster serial id",
              "example": "cluster-l0elpxde"
            },
            {
              "name": "SourceName",
              "type": "string",
              "required": false,
              "description": "需要复制的作业名称",
              "example": "job1"
            },
            {
              "name": "TargetName",
              "type": "string",
              "required": false,
              "description": "新作业的名称",
              "example": "job2"
            },
            {
              "name": "TargetFolderId",
              "type": "string",
              "required": false,
              "description": "新作业的目录id",
              "example": "folder-2ue9i8ny"
            },
            {
              "name": "JobType",
              "type": "integer",
              "required": false,
              "description": "源作业类型",
              "example": "1"
            }
          ]
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "无"
        },
        {
          "name": "TargetWorkspaceId",
          "type": "string",
          "required": false,
          "description": "目标工作空间 SerialId",
          "example": "无"
        }
      ],
      "required": [
        "JobItems"
      ]
    },
    {
      "name": "CreateConnector",
      "description": "创建Connector",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源id",
          "example": "resource-123qwe"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": true,
          "description": "空间",
          "example": "space-qwe123"
        },
        {
          "name": "VersionId",
          "type": "integer",
          "required": true,
          "description": "资源版本",
          "example": "1"
        },
        {
          "name": "Connector",
          "type": "string",
          "required": true,
          "description": "连接器名称",
          "example": "kafka"
        },
        {
          "name": "ConnectionMethod",
          "type": "string",
          "required": true,
          "description": "连接方式",
          "example": "1"
        }
      ],
      "required": [
        "ResourceId",
        "WorkSpaceId",
        "VersionId",
        "Connector",
        "ConnectionMethod"
      ]
    },
    {
      "name": "CreateFolder",
      "description": "作业列表页面新建文件夹请求",
      "status": "online",
      "parameters": [
        {
          "name": "FolderName",
          "type": "string",
          "required": true,
          "description": "新建文件夹名",
          "example": "joylyu-test"
        },
        {
          "name": "ParentId",
          "type": "string",
          "required": true,
          "description": "新建文件夹的父目录ID（根目录为\"root\"）",
          "example": "folder-xxxxxxxx"
        },
        {
          "name": "FolderType",
          "type": "integer",
          "required": false,
          "description": "文件夹类型，0是任务文件夹，1是依赖文件夹",
          "example": "0"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "FolderName",
        "ParentId"
      ]
    },
    {
      "name": "CreateJob",
      "description": "新建作业接口，一个 AppId 最多允许创建1000个作业",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "作业名称，允许输入长度小于50个字符的中文、英文、数字、-（横线）、_（下划线）、.（点），且符号必须半角字符。注意作业名不能和现有作业同名",
          "example": "job_new"
        },
        {
          "name": "JobType",
          "type": "integer",
          "required": true,
          "description": "作业的类型，1 表示 SQL 作业，2 表示 JAR 作业",
          "example": "2"
        },
        {
          "name": "ClusterType",
          "type": "integer",
          "required": true,
          "description": "集群的类型，1 表示共享集群，2 表示独享集群",
          "example": "2"
        },
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "当 ClusterType=2 时，必选，用来指定该作业提交的独享集群 ID",
          "example": "cluster-xxxxxxxx"
        },
        {
          "name": "CuMem",
          "type": "integer",
          "required": false,
          "description": "设置每 CU 的内存规格，单位为 GB，支持 2、4、8、16（需申请开通白名单后使用）。默认为 4，即 1 CU 对应 4 GB 的运行内存",
          "example": "4"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "作业的备注信息，可以随意设置",
          "example": "测试作业"
        },
        {
          "name": "FolderId",
          "type": "string",
          "required": false,
          "description": "作业名所属文件夹ID，根目录为\"root\"",
          "example": "folder-xxxxxxxx"
        },
        {
          "name": "FlinkVersion",
          "type": "string",
          "required": false,
          "description": "作业运行的Flink版本",
          "example": "Flink-1.11"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "作业标签",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": false,
              "description": "标签键 注意：此字段可能返回 null，表示取不到有效值。"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": false,
              "description": "标签值 注意：此字段可能返回 null，表示取不到有效值。"
            }
          ]
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "作业描述",
          "example": "description of job"
        },
        {
          "name": "OpenJobDefaultAlarm",
          "type": "integer",
          "required": false,
          "description": "开启默认告警",
          "example": "1"
        },
        {
          "name": "Uid",
          "type": "integer",
          "required": false,
          "description": "用户Uid",
          "example": "123345"
        },
        {
          "name": "JdkVersion",
          "type": "string",
          "required": false,
          "description": "jdk版本",
          "example": "8"
        }
      ],
      "required": [
        "Name",
        "JobType",
        "ClusterType"
      ]
    },
    {
      "name": "CreateJobConfig",
      "description": "创建作业配置，一个作业最多有100个配置版本",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业Id",
          "example": "cql-abcdefg"
        },
        {
          "name": "EntrypointClass",
          "type": "string",
          "required": false,
          "description": "主类",
          "example": "com.tencent.cloud.test.WordCount"
        },
        {
          "name": "ProgramArgs",
          "type": "string",
          "required": false,
          "description": "主类入参，需要区分下Sql作业配置，Jar作业配置，Python作业配置，具体参考下面的示例值",
          "example": "--conf Key=Value"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "备注",
          "example": "example"
        },
        {
          "name": "ResourceRefs",
          "type": "array",
          "required": false,
          "description": "资源引用数组",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "ResourceId",
              "type": "string",
              "required": true,
              "description": "资源ID",
              "example": "resource-ayglrn06"
            },
            {
              "name": "Version",
              "type": "integer",
              "required": true,
              "description": "资源版本",
              "example": "1"
            },
            {
              "name": "Type",
              "type": "integer",
              "required": true,
              "description": "0-引用 JAR 程序包，1-主程序包，2-引用配置文件，3-Python程序包，4-Python数据文件",
              "example": "1"
            }
          ]
        },
        {
          "name": "DefaultParallelism",
          "type": "integer",
          "required": false,
          "description": "作业默认并行度",
          "example": "2"
        },
        {
          "name": "Properties",
          "type": "array",
          "required": false,
          "description": "系统参数",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Key",
              "type": "string",
              "required": true,
              "description": "系统配置的Key",
              "example": "无"
            },
            {
              "name": "Value",
              "type": "string",
              "required": true,
              "description": "系统配置的Value",
              "example": "无"
            }
          ]
        },
        {
          "name": "AutoDelete",
          "type": "integer",
          "required": false,
          "description": "1: 作业配置达到上限之后，自动删除可删除的最早版本",
          "example": "1"
        },
        {
          "name": "COSBucket",
          "type": "string",
          "required": false,
          "description": "作业使用的 COS 存储桶名",
          "example": "example-oceanus-1257058918"
        },
        {
          "name": "LogCollect",
          "type": "boolean",
          "required": false,
          "description": "是否采集作业日志",
          "example": "true"
        },
        {
          "name": "JobManagerSpec",
          "type": "float",
          "required": false,
          "description": "JobManager规格",
          "example": "0.5"
        },
        {
          "name": "TaskManagerSpec",
          "type": "float",
          "required": false,
          "description": "TaskManager规格",
          "example": "0.5"
        },
        {
          "name": "ClsLogsetId",
          "type": "string",
          "required": false,
          "description": "CLS日志集ID",
          "example": "544002e3-299b-41d2-b18f-19194fb0660b"
        },
        {
          "name": "ClsTopicId",
          "type": "string",
          "required": false,
          "description": "CLS日志主题ID",
          "example": "544002e3-299b-41d2-b18f-19194fb0660b"
        },
        {
          "name": "LogCollectType",
          "type": "integer",
          "required": false,
          "description": "日志采集类型 2：CLS；3：COS",
          "example": "2"
        },
        {
          "name": "PythonVersion",
          "type": "string",
          "required": false,
          "description": "pyflink作业运行时使用的python版本",
          "example": "Python-3.7"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        },
        {
          "name": "LogLevel",
          "type": "string",
          "required": false,
          "description": "日志级别",
          "example": "INFO"
        },
        {
          "name": "AutoRecover",
          "type": "integer",
          "required": false,
          "description": "Oceanus 平台恢复作业开关 1:开启 -1: 关闭",
          "example": "1"
        },
        {
          "name": "ClazzLevels",
          "type": "array",
          "required": false,
          "description": "类日志级别",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Clazz",
              "type": "string",
              "required": true,
              "description": "java类全路径 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "org.x.x.x"
            },
            {
              "name": "Level",
              "type": "string",
              "required": true,
              "description": "日志级别 TRACE，DEBUG、INFO、WARN、ERROR 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "INFO"
            }
          ]
        },
        {
          "name": "ExpertModeOn",
          "type": "boolean",
          "required": false,
          "description": "是否打开专家模式",
          "example": "false"
        },
        {
          "name": "ExpertModeConfiguration",
          "type": "object",
          "required": false,
          "description": "专家模式的配置",
          "example": "无",
          "children": [
            {
              "name": "JobGraph",
              "type": "object",
              "required": false,
              "description": "Job graph 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "{   \"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     }   ] }",
              "children": [
                {
                  "name": "Nodes",
                  "type": "array",
                  "required": false,
                  "description": "运行图的点集合 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "[]",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Id",
                      "type": "integer",
                      "required": true,
                      "description": "节点ID 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "1"
                    },
                    {
                      "name": "Description",
                      "type": "string",
                      "required": true,
                      "description": "节点描述 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "This is a node description"
                    },
                    {
                      "name": "Name",
                      "type": "string",
                      "required": true,
                      "description": "节点名称 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "Node1"
                    },
                    {
                      "name": "Parallelism",
                      "type": "integer",
                      "required": true,
                      "description": "节点并行度 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "2"
                    }
                  ]
                },
                {
                  "name": "Edges",
                  "type": "array",
                  "required": false,
                  "description": "运行图的边集合 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "[]",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Source",
                      "type": "integer",
                      "required": true,
                      "description": "边的起始节点ID 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "1"
                    },
                    {
                      "name": "Target",
                      "type": "integer",
                      "required": true,
                      "description": "边的目标节点ID 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "2"
                    }
                  ]
                }
              ]
            },
            {
              "name": "NodeConfig",
              "type": "array",
              "required": false,
              "description": "Node configuration 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "[]",
              "item_type": "object",
              "children": [
                {
                  "name": "Id",
                  "type": "integer",
                  "required": true,
                  "description": "Node ID 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "1"
                },
                {
                  "name": "Parallelism",
                  "type": "integer",
                  "required": false,
                  "description": "Node parallelism 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "2"
                },
                {
                  "name": "SlotSharingGroup",
                  "type": "string",
                  "required": false,
                  "description": "Slot sharing group 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "group1"
                },
                {
                  "name": "Configuration",
                  "type": "array",
                  "required": false,
                  "description": "Configuration properties 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "[]",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Key",
                      "type": "string",
                      "required": true,
                      "description": "系统配置的Key",
                      "example": "无"
                    },
                    {
                      "name": "Value",
                      "type": "string",
                      "required": true,
                      "description": "系统配置的Value",
                      "example": "无"
                    }
                  ]
                },
                {
                  "name": "StateTTL",
                  "type": "string",
                  "required": false,
                  "description": "节点的状态ttl配置, 多个用 ; 分割 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "\"\""
                }
              ]
            },
            {
              "name": "SlotSharingGroups",
              "type": "array",
              "required": false,
              "description": "Slot sharing groups 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "[]",
              "item_type": "object",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "SlotSharingGroup的名字 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "ssgA"
                },
                {
                  "name": "Spec",
                  "type": "object",
                  "required": true,
                  "description": "SlotSharingGroup的规格 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "[]",
                  "children": [
                    {
                      "name": "CPU",
                      "type": "float",
                      "required": true,
                      "description": "适用的cpu 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "1.0"
                    },
                    {
                      "name": "HeapMemory",
                      "type": "string",
                      "required": true,
                      "description": "默认为b, 支持单位有 b, kb, mb, gb 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "1gb"
                    },
                    {
                      "name": "OffHeapMemory",
                      "type": "string",
                      "required": false,
                      "description": "默认为b, 支持单位有 b, kb, mb, gb 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "1gb"
                    },
                    {
                      "name": "ManagedMemory",
                      "type": "string",
                      "required": false,
                      "description": "默认为b, 支持单位有 b, kb, mb, gb 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "1gb"
                    }
                  ]
                },
                {
                  "name": "Description",
                  "type": "string",
                  "required": false,
                  "description": "SlotSharingGroup的描述 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "ssgA"
                },
                {
                  "name": "Configuration",
                  "type": "array",
                  "required": false,
                  "description": "SlotSharingGroup的配置 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "[]",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "Key",
                      "type": "string",
                      "required": true,
                      "description": "系统配置的Key",
                      "example": "无"
                    },
                    {
                      "name": "Value",
                      "type": "string",
                      "required": true,
                      "description": "系统配置的Value",
                      "example": "无"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "TraceModeOn",
          "type": "boolean",
          "required": false,
          "description": "trace链路",
          "example": "false"
        },
        {
          "name": "TraceModeConfiguration",
          "type": "object",
          "required": false,
          "description": "trace链路配置",
          "example": "无",
          "children": [
            {
              "name": "Rate",
              "type": "string",
              "required": false,
              "description": "如1%转换为0.01 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "0.01"
            },
            {
              "name": "Operator",
              "type": "string",
              "required": false,
              "description": "按照算子ID顺序配置，可以对每个算子配置IN、OUT、IN_AND_OUT三个值，分别表示采集输入数据、采集输出数据、同时采集输入和输出数据 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "1:OUT,2:IN_AND_OUT,3:IN"
            }
          ]
        },
        {
          "name": "CheckpointRetainedNum",
          "type": "integer",
          "required": false,
          "description": "checkpoint保留个数",
          "example": "1"
        },
        {
          "name": "JobGraph",
          "type": "object",
          "required": false,
          "description": "算子拓扑图",
          "example": "无",
          "children": [
            {
              "name": "Nodes",
              "type": "array",
              "required": false,
              "description": "运行图的点集合 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "[]",
              "item_type": "object",
              "children": [
                {
                  "name": "Id",
                  "type": "integer",
                  "required": true,
                  "description": "节点ID 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "1"
                },
                {
                  "name": "Description",
                  "type": "string",
                  "required": true,
                  "description": "节点描述 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "This is a node description"
                },
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "节点名称 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "Node1"
                },
                {
                  "name": "Parallelism",
                  "type": "integer",
                  "required": true,
                  "description": "节点并行度 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "2"
                }
              ]
            },
            {
              "name": "Edges",
              "type": "array",
              "required": false,
              "description": "运行图的边集合 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "[]",
              "item_type": "object",
              "children": [
                {
                  "name": "Source",
                  "type": "integer",
                  "required": true,
                  "description": "边的起始节点ID 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "1"
                },
                {
                  "name": "Target",
                  "type": "integer",
                  "required": true,
                  "description": "边的目标节点ID 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "2"
                }
              ]
            }
          ]
        },
        {
          "name": "EsServerlessIndex",
          "type": "string",
          "required": false,
          "description": "es索引名称",
          "example": "\"index-xxxxx\""
        },
        {
          "name": "EsServerlessSpace",
          "type": "string",
          "required": false,
          "description": "es索引空间",
          "example": "\"space-xxxxx\""
        },
        {
          "name": "FlinkVersion",
          "type": "string",
          "required": false,
          "description": "flink版本",
          "example": "Flink-1.13"
        },
        {
          "name": "JobManagerCpu",
          "type": "float",
          "required": false,
          "description": "JobManager cpu",
          "example": "1.0"
        },
        {
          "name": "JobManagerMem",
          "type": "float",
          "required": false,
          "description": "JobManager 内存",
          "example": "1.0"
        },
        {
          "name": "JdkVersion",
          "type": "string",
          "required": false,
          "description": "jdk版本",
          "example": "8"
        },
        {
          "name": "TaskManagerCpu",
          "type": "float",
          "required": false,
          "description": "TaskManager cpu",
          "example": "1.0"
        },
        {
          "name": "TaskManagerMem",
          "type": "float",
          "required": false,
          "description": "TaskManager 内存",
          "example": "1.0"
        },
        {
          "name": "UseOldSystemConnector",
          "type": "integer",
          "required": false,
          "description": "0=默认使用老的 1=使用新的",
          "example": "0"
        },
        {
          "name": "ProgramArgsAfterGzip",
          "type": "string",
          "required": false,
          "description": "压缩参数",
          "example": "压缩参数"
        },
        {
          "name": "CheckpointTimeoutSecond",
          "type": "integer",
          "required": false,
          "description": "checkpoint 超时时间",
          "example": "36000"
        },
        {
          "name": "CheckpointIntervalSecond",
          "type": "integer",
          "required": false,
          "description": "checkpoint 间隔时间",
          "example": "600"
        }
      ],
      "required": [
        "JobId"
      ]
    },
    {
      "name": "CreateResource",
      "description": "创建资源接口",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceLoc",
          "type": "object",
          "required": true,
          "description": "资源位置",
          "example": "无",
          "children": [
            {
              "name": "StorageType",
              "type": "integer",
              "required": true,
              "description": "资源位置的存储类型，目前只支持1:COS",
              "example": "1"
            },
            {
              "name": "Param",
              "type": "object",
              "required": true,
              "description": "描述资源位置的json",
              "example": "{\"Bucket\":\"bucket1\",\"Path\":\"your/path\",\"Region\":\"ap-guangzhou\"}",
              "children": [
                {
                  "name": "Bucket",
                  "type": "string",
                  "required": true,
                  "description": "资源bucket",
                  "example": "scs-online-1257058945"
                },
                {
                  "name": "Path",
                  "type": "string",
                  "required": true,
                  "description": "资源路径",
                  "example": "251008563/100000006047/flink-cos-fs-hadoop-oceanus-1-20210304112"
                },
                {
                  "name": "Region",
                  "type": "string",
                  "required": false,
                  "description": "资源所在地域，如果不填，则使用Resource的Region 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "ap-chengdu"
                }
              ]
            }
          ]
        },
        {
          "name": "ResourceType",
          "type": "integer",
          "required": true,
          "description": "资源类型。目前只支持 JAR，取值为 1",
          "example": "1"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "资源描述",
          "example": "v1"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "资源名称",
          "example": "1"
        },
        {
          "name": "ResourceConfigRemark",
          "type": "string",
          "required": false,
          "description": "资源版本描述",
          "example": "1"
        },
        {
          "name": "FolderId",
          "type": "string",
          "required": false,
          "description": "目录ID",
          "example": "folder-xxxx"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-12"
        }
      ],
      "required": [
        "ResourceLoc",
        "ResourceType"
      ]
    },
    {
      "name": "CreateResourceConfig",
      "description": "创建资源配置接口",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源ID",
          "example": "resource-xxx"
        },
        {
          "name": "ResourceLoc",
          "type": "object",
          "required": true,
          "description": "位置信息",
          "example": "[]",
          "children": [
            {
              "name": "StorageType",
              "type": "integer",
              "required": true,
              "description": "资源位置的存储类型，目前只支持1:COS",
              "example": "1"
            },
            {
              "name": "Param",
              "type": "object",
              "required": true,
              "description": "描述资源位置的json",
              "example": "{\"Bucket\":\"bucket1\",\"Path\":\"your/path\",\"Region\":\"ap-guangzhou\"}",
              "children": [
                {
                  "name": "Bucket",
                  "type": "string",
                  "required": true,
                  "description": "资源bucket",
                  "example": "scs-online-1257058945"
                },
                {
                  "name": "Path",
                  "type": "string",
                  "required": true,
                  "description": "资源路径",
                  "example": "251008563/100000006047/flink-cos-fs-hadoop-oceanus-1-20210304112"
                },
                {
                  "name": "Region",
                  "type": "string",
                  "required": false,
                  "description": "资源所在地域，如果不填，则使用Resource的Region 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "ap-chengdu"
                }
              ]
            }
          ]
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "资源描述信息",
          "example": "xxx"
        },
        {
          "name": "AutoDelete",
          "type": "integer",
          "required": false,
          "description": "1： 资源版本达到上限，自动删除最早可删除的版本",
          "example": "0"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "ResourceId",
        "ResourceLoc"
      ]
    },
    {
      "name": "CreateVariable",
      "description": "创建变量",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "变量名",
          "example": "Key"
        },
        {
          "name": "Value",
          "type": "string",
          "required": true,
          "description": "变量值",
          "example": "Value"
        },
        {
          "name": "Type",
          "type": "integer",
          "required": true,
          "description": "变量类型 1：显式 2：隐藏",
          "example": "2"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "描述信息",
          "example": "无"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        }
      ],
      "required": [
        "Name",
        "Value",
        "Type"
      ]
    },
    {
      "name": "CreateWorkSpace",
      "description": "创建工作空间",
      "status": "online",
      "parameters": [
        {
          "name": "WorkSpaceName",
          "type": "string",
          "required": true,
          "description": "工作空间名称",
          "example": "MySpace"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "项目空间备注",
          "example": "default0"
        }
      ],
      "required": [
        "WorkSpaceName"
      ]
    },
    {
      "name": "DeleteFolders",
      "description": "作业列表删除文件夹",
      "status": "online",
      "parameters": [
        {
          "name": "FolderIds",
          "type": "array",
          "required": true,
          "description": "需删除的文件夹唯一ID",
          "example": "[\"folder-xxxxxxxx\"]",
          "item_type": "string"
        },
        {
          "name": "FolderType",
          "type": "integer",
          "required": false,
          "description": "文件夹类型，0是任务文件夹，1是依赖文件夹",
          "example": "0"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "FolderIds"
      ]
    },
    {
      "name": "DeleteJobConfigs",
      "description": "删除作业配置",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业ID",
          "example": "cql-ses24dtd"
        },
        {
          "name": "JobConfigVersions",
          "type": "array",
          "required": true,
          "description": "作业配置版本数组",
          "example": "[\"1\\n\",\"2\\n\"]",
          "item_type": "integer"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "JobId",
        "JobConfigVersions"
      ]
    },
    {
      "name": "DeleteJobs",
      "description": "批量删除作业接口，批量操作数量上限20",
      "status": "online",
      "parameters": [
        {
          "name": "JobIds",
          "type": "array",
          "required": true,
          "description": "作业Id列表",
          "example": "[]",
          "item_type": "string"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间Id",
          "example": "space-1327"
        },
        {
          "name": "JobNames",
          "type": "array",
          "required": false,
          "description": "作业名称列表",
          "example": "[\"name1\",\"name2\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "JobIds"
      ]
    },
    {
      "name": "DeleteResourceConfigs",
      "description": "删除资源版本",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源ID",
          "example": "resource-xxx"
        },
        {
          "name": "ResourceConfigVersions",
          "type": "array",
          "required": true,
          "description": "资源版本数组",
          "example": "1",
          "item_type": "integer"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "ResourceId",
        "ResourceConfigVersions"
      ]
    },
    {
      "name": "DeleteResources",
      "description": "删除资源接口",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceIds",
          "type": "array",
          "required": true,
          "description": "待删除资源ID列表",
          "example": "resource-xxx",
          "item_type": "string"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "ResourceIds"
      ]
    },
    {
      "name": "DeleteTableConfig",
      "description": "删除作业表配置",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业ID",
          "example": "cql-xxx"
        },
        {
          "name": "DebugId",
          "type": "integer",
          "required": true,
          "description": "调试作业ID",
          "example": "123"
        },
        {
          "name": "TableName",
          "type": "string",
          "required": true,
          "description": "表名",
          "example": "a"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "JobId",
        "DebugId",
        "TableName"
      ]
    },
    {
      "name": "DeleteWorkSpace",
      "description": "删除工作空间",
      "status": "online",
      "parameters": [
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": true,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        }
      ],
      "required": [
        "WorkSpaceId"
      ]
    },
    {
      "name": "DescribeClusters",
      "description": "查询集群",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterIds",
          "type": "array",
          "required": false,
          "description": "按照一个或者多个集群 ID 查询，每次请求的集群上限为 100",
          "example": "cluster-xxxx",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认 0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "请求的集群数量，默认 20，最大值 100",
          "example": "20"
        },
        {
          "name": "OrderType",
          "type": "integer",
          "required": false,
          "description": "集群信息结果排序规则，1 按时间降序，2 按照时间升序，3 按照状态排序",
          "example": "1"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤规则 - Name 按照集群的名字进行模糊查询。例如：测试 类型： String 必选： 否",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "要过滤的字段"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeFolder",
      "description": "查询指定文件夹及其相应的子文件夹信息",
      "status": "online",
      "parameters": [
        {
          "name": "FolderId",
          "type": "string",
          "required": true,
          "description": "folder id",
          "example": "folder-lfqkt10s"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": true,
          "description": "workspace id",
          "example": "space-53rqk422"
        },
        {
          "name": "FolderType",
          "type": "integer",
          "required": true,
          "description": "1:资源文件夹 其他:作业文件夹",
          "example": "1"
        }
      ],
      "required": [
        "FolderId",
        "WorkSpaceId",
        "FolderType"
      ]
    },
    {
      "name": "DescribeJobConfigs",
      "description": "查询作业配置列表，一次最多查询100个",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业Id",
          "example": "cql-xxxx"
        },
        {
          "name": "JobConfigVersions",
          "type": "array",
          "required": false,
          "description": "作业配置版本",
          "example": "[]",
          "item_type": "integer"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页大小，默认20，最大100",
          "example": "20"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件",
          "example": "[]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "要过滤的字段"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "OnlyDraft",
          "type": "boolean",
          "required": false,
          "description": "true 表示只展示草稿",
          "example": "false"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "JobId"
      ]
    },
    {
      "name": "DescribeJobEvents",
      "description": "请求参数不包含 \"RunningOrderIds\"时，接口获取指定作业的事件，包括作业启动停止、运行失败、快照失败、作业异常等各种事件类型;请求参数不包含 \"RunningOrderIds\"时，接口为查询作业实例ID接口,获取作业实例",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业的 ID",
          "example": "cql-6w8eab6f"
        },
        {
          "name": "StartTimestamp",
          "type": "integer",
          "required": true,
          "description": "筛选条件：起始 Unix 时间戳（秒）",
          "example": "1630932161"
        },
        {
          "name": "EndTimestamp",
          "type": "integer",
          "required": true,
          "description": "筛选条件：结束 Unix 时间戳（秒）",
          "example": "1631232466"
        },
        {
          "name": "Types",
          "type": "array",
          "required": false,
          "description": "事件类型。如果不传则返回所有类型的数据",
          "example": "[1,2]",
          "item_type": "string"
        },
        {
          "name": "RunningOrderIds",
          "type": "array",
          "required": false,
          "description": "运行实例 ID 数组",
          "example": "[1,2,3]",
          "item_type": "integer"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "JobId",
        "StartTimestamp",
        "EndTimestamp"
      ]
    },
    {
      "name": "DescribeJobRuntimeInfo",
      "description": "获取作业运行时的信息",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业ID",
          "example": "cql-xxx"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": true,
          "description": "工作空间ID",
          "example": "space-xxx"
        },
        {
          "name": "IncludeInfo",
          "type": "array",
          "required": true,
          "description": "作业运行信息 key",
          "example": "[\"TaskManagers\",\"StreamGraph\",\"SubTasks\",\"JobManagers\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "JobId",
        "WorkSpaceId",
        "IncludeInfo"
      ]
    },
    {
      "name": "DescribeJobSavepoint",
      "description": "查找Savepoint列表",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业 SerialId",
          "example": "cql-asdf5678"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页参数，单页总数",
          "example": "1"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页参数，偏移量",
          "example": "1"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        },
        {
          "name": "RecordTypes",
          "type": "array",
          "required": false,
          "description": "2 是checkpoint 1 是触发savepoint 3 停止触发的savepoint",
          "example": "[]",
          "item_type": "integer"
        }
      ],
      "required": [
        "JobId",
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DescribeJobSubmissionLog",
      "description": "查询作业实例启动日志",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业ID，例如：cql-6v1jkxrn",
          "example": "cql-ebgioapf"
        },
        {
          "name": "StartTime",
          "type": "integer",
          "required": true,
          "description": "起始时间，unix时间戳，毫秒级，例如：1611754219108",
          "example": "1585749042"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": true,
          "description": "结束时间，unix时间戳，毫秒级，例如：1611754219108",
          "example": "1585749042"
        },
        {
          "name": "RunningOrderId",
          "type": "integer",
          "required": false,
          "description": "作业运行的实例ID, 例如：1,2,3。默认为0，表示未选中任何实例，搜索该时间段内最近的一个实例的日志",
          "example": "0"
        },
        {
          "name": "Keyword",
          "type": "string",
          "required": false,
          "description": "日志搜索的关键词，默认为空",
          "example": "key"
        },
        {
          "name": "Cursor",
          "type": "string",
          "required": false,
          "description": "日志搜索的游标，可透传上次返回的值，默认为空",
          "example": "1"
        },
        {
          "name": "OrderType",
          "type": "string",
          "required": false,
          "description": "时间戳排序规则，asc - 升序，desc - 降序。默认为升序",
          "example": "asc"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "搜索的日志条数上限值，最大为100",
          "example": "100"
        }
      ],
      "required": [
        "JobId",
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "DescribeJobs",
      "description": "查询作业",
      "status": "online",
      "parameters": [
        {
          "name": "JobIds",
          "type": "array",
          "required": false,
          "description": "按照一个或者多个作业ID查询。作业ID形如：cql-11112222，每次请求的作业上限为100。参数不支持同时指定JobIds和Filters。",
          "example": "[\"cql-123\"]",
          "item_type": "string"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤条件，支持的 Filter.Name 为：作业名 Name、作业状态 Status、所属集群 ClusterId、作业id JobId、集群名称 ClusterName。 每次请求的 Filters 个数的上限为 5，Filter.Values 的个数上限为 5。参数不支持同时指定 JobIds 和 Filters。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "要过滤的字段"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页大小，默认为20，最大值为100",
          "example": "20"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        },
        {
          "name": "ExtraResult",
          "type": "array",
          "required": false,
          "description": "查询额外的作业信息,例如 JobEventInfo",
          "example": "[\"JobEventInfo\"]",
          "item_type": "string"
        },
        {
          "name": "ConnectorOptions",
          "type": "string",
          "required": false,
          "description": "查询引用connector",
          "example": "setats"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeResourceConfigs",
      "description": "描述资源配置接口",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": false,
          "description": "资源ID",
          "example": "resource-xxx"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，仅当设置 Limit 时该参数有效",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回值大小，不填则返回全量数据",
          "example": "20"
        },
        {
          "name": "ResourceConfigVersions",
          "type": "array",
          "required": false,
          "description": "资源配置Versions集合",
          "example": "1",
          "item_type": "integer"
        },
        {
          "name": "JobConfigVersion",
          "type": "integer",
          "required": false,
          "description": "作业配置版本",
          "example": "无"
        },
        {
          "name": "JobId",
          "type": "string",
          "required": false,
          "description": "作业ID",
          "example": "无"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeResourceRelatedJobs",
      "description": "获取资源关联作业信息",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源ID",
          "example": "resource-xxx"
        },
        {
          "name": "DESCByJobConfigCreateTime",
          "type": "integer",
          "required": false,
          "description": "默认0; 1： 按照作业版本创建时间降序",
          "example": "0"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认为0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页大小，默认为20，最大值为100",
          "example": "20"
        },
        {
          "name": "ResourceConfigVersion",
          "type": "integer",
          "required": false,
          "description": "资源版本号",
          "example": "1"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        }
      ],
      "required": [
        "ResourceId"
      ]
    },
    {
      "name": "DescribeResources",
      "description": "描述资源接口",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceIds",
          "type": "array",
          "required": false,
          "description": "需要查询的资源ID数组，数量不超过100个。如果填写了该参数则忽略Filters参数。",
          "example": "[\"resource-8udfak5k\",\"resource-8udfak5j\"]",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，仅当设置 Limit 参数时有效",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "条数限制。如果不填，默认返回 20 条",
          "example": "20"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "ResourceName 按照资源名字过滤，支持模糊过滤。传入的过滤名字不超过5个类型: String必选: 否",
          "example": "[]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "要过滤的字段"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        },
        {
          "name": "SystemResource",
          "type": "integer",
          "required": false,
          "description": "资源类型，0=用户，1系统connector，2=用户自定义connector",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeSystemResources",
      "description": "描述系统资源接口",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceIds",
          "type": "array",
          "required": false,
          "description": "需要查询的资源ID数组",
          "example": "[]",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，仅当设置 Limit 参数时有效",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "条数限制，默认返回 20 条",
          "example": "20"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "查询资源配置列表， 如果不填写，返回该 ResourceIds.N 下所有作业配置列表",
          "example": "[]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "要过滤的字段"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "ClusterId",
          "type": "string",
          "required": false,
          "description": "集群ID",
          "example": "cluster-xxxx"
        },
        {
          "name": "FlinkVersion",
          "type": "string",
          "required": false,
          "description": "查询对应Flink版本的内置connector",
          "example": "Flink-1.11"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "空间",
          "example": "space-123qew"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeTreeJobs",
      "description": "生成树状作业显示结构",
      "status": "online",
      "parameters": [
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "筛选条件字段，使用了筛选字段后不支持分页，最多返回2000条记录",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "要过滤的字段"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 Serialid",
          "example": "space-1327"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeTreeResources",
      "description": "查询树状结构资源列表",
      "status": "online",
      "parameters": [
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "筛选条件字段",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "要过滤的字段"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-xxx"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页游标",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "单页显示数",
          "example": "200"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeVariables",
      "description": "变量列表展示",
      "status": "online",
      "parameters": [
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeWorkSpaces",
      "description": "授权工作空间列表",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量，默认 0",
          "example": "0"
        },
        {
          "name": "OrderType",
          "type": "integer",
          "required": false,
          "description": "1 按照创建时间降序排序(默认) 2.按照创建时间升序排序，3. 按照状态降序排序 4. 按照状态升序排序 默认为0",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "请求的集群数量，默认 20",
          "example": "20"
        },
        {
          "name": "Filters",
          "type": "array",
          "required": false,
          "description": "过滤规则",
          "example": "[]",
          "item_type": "object",
          "children": [
            {
              "name": "Name",
              "type": "string",
              "required": true,
              "description": "要过滤的字段"
            },
            {
              "name": "Values",
              "type": "array",
              "required": true,
              "description": "字段的过滤值",
              "item_type": "string"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "FetchSqlGatewayStatementResult",
      "description": "查询Sql Gateway的Statement执行结果",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群ID",
          "example": "cluster-lq6dtnk5"
        },
        {
          "name": "SessionId",
          "type": "string",
          "required": false,
          "description": "Sql Gateway会话ID",
          "example": "b523f113-aa32-40cc-9665-5884a1dd480d"
        },
        {
          "name": "OperationHandleId",
          "type": "string",
          "required": false,
          "description": "sql的查询id",
          "example": "f613c399-e1c7-4ab9-a07f-ee08a782b546"
        },
        {
          "name": "ResultUri",
          "type": "string",
          "required": false,
          "description": "下一条结果的获取url，首次获取执行结果时可以为空，当获取下一批查询结果时需要传递",
          "example": "/v1/sessions/b523f113-aa32-40cc-9665-5884a1dd480d/operations/f613c399-e1c7-4ab9-a07f-ee08a782b546/result/1"
        }
      ],
      "required": [
        "ClusterId"
      ]
    },
    {
      "name": "GetMetaTable",
      "description": "查询元数据表",
      "status": "online",
      "parameters": [
        {
          "name": "Catalog",
          "type": "string",
          "required": true,
          "description": "目录名",
          "example": "_dc"
        },
        {
          "name": "Database",
          "type": "string",
          "required": true,
          "description": "库名",
          "example": "_db"
        },
        {
          "name": "Table",
          "type": "string",
          "required": true,
          "description": "表名",
          "example": "my_table1"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": true,
          "description": "空间唯一标识",
          "example": "space-xxx"
        }
      ],
      "required": [
        "Catalog",
        "Database",
        "Table",
        "WorkSpaceId"
      ]
    },
    {
      "name": "ModifyConnector",
      "description": "修改Connector",
      "status": "online",
      "parameters": [
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": true,
          "description": "空间",
          "example": "space-qwe123"
        },
        {
          "name": "ConnectorResourceId",
          "type": "string",
          "required": true,
          "description": "connector ID",
          "example": "resource-123qwe"
        },
        {
          "name": "ResourceId",
          "type": "string",
          "required": false,
          "description": "资源id",
          "example": "resource-123qwe"
        },
        {
          "name": "VersionId",
          "type": "integer",
          "required": false,
          "description": "资源版本",
          "example": "1"
        },
        {
          "name": "Connector",
          "type": "string",
          "required": false,
          "description": "连接器名称",
          "example": "kafka"
        },
        {
          "name": "ConnectionMethod",
          "type": "string",
          "required": false,
          "description": "连接方式",
          "example": "1"
        }
      ],
      "required": [
        "WorkSpaceId",
        "ConnectorResourceId"
      ]
    },
    {
      "name": "ModifyFolder",
      "description": "自定义树状结构页面拖拽文件夹",
      "status": "online",
      "parameters": [
        {
          "name": "SourceFolderId",
          "type": "string",
          "required": false,
          "description": "只有移动文件夹的场景必填，如果是批量移动作业的场景，非必填。",
          "example": "folder-aaaaaaaa"
        },
        {
          "name": "TargetFolderId",
          "type": "string",
          "required": false,
          "description": "如需拖拽文件夹，需传入目标文件夹ID",
          "example": "folder-bbbbbbbb"
        },
        {
          "name": "FolderName",
          "type": "string",
          "required": false,
          "description": "如需修改文件夹名，需传入FolderName字段",
          "example": "xxxxxxx"
        },
        {
          "name": "FolderType",
          "type": "integer",
          "required": false,
          "description": "文件夹类型，0是任务文件夹，1是依赖文件夹",
          "example": "0"
        },
        {
          "name": "SourceJobIds",
          "type": "array",
          "required": false,
          "description": "批量移动的作业serial id 列表",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        }
      ],
      "required": []
    },
    {
      "name": "ModifyJob",
      "description": "更新作业属性，仅允许以下3种操作，不支持组合操作： (1) 更新作业名称 (2) 更新作业备注 (3) 更新作业最大并行度 变更前提：WorkerCuNum\u003c=MaxParallelism 如果MaxParallelism变小，不重启作业，待下一次重启生效 如果MaxParallelism变大，则要求入参RestartAllowed必须为True 假设作业运行状态，则先停止作业，再启动作业，中间状态丢失 假设作业暂停状态，则将作业更改为停止状态，中间状态\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业Id",
          "example": "cql-6iaginqp"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "作业名称，支持长度小于50的中文/英文/数字/”-”/”_”/”.”，不能重名",
          "example": "test"
        },
        {
          "name": "Remark",
          "type": "string",
          "required": false,
          "description": "描述",
          "example": "测试"
        },
        {
          "name": "TargetFolderId",
          "type": "string",
          "required": false,
          "description": "拖拽文件需传入此参数",
          "example": "folder-xxxxxxxx"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1237"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "作业描述",
          "example": "description"
        },
        {
          "name": "ContinueAlarm",
          "type": "integer",
          "required": false,
          "description": "停止持续告警",
          "example": "1"
        }
      ],
      "required": [
        "JobId"
      ]
    },
    {
      "name": "ModifyWorkSpace",
      "description": "修改工作空间",
      "status": "online",
      "parameters": [
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": true,
          "description": "工作空间 SerialId",
          "example": "1327"
        },
        {
          "name": "WorkSpaceName",
          "type": "string",
          "required": false,
          "description": "待修改的工作空间名称",
          "example": "MySpace"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "待修改的工作空间备注",
          "example": "default0"
        }
      ],
      "required": [
        "WorkSpaceId"
      ]
    },
    {
      "name": "ParseConnector",
      "description": "解析用户上传connector",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源id",
          "example": "resource-6zoqt0tz"
        },
        {
          "name": "VersionId",
          "type": "integer",
          "required": true,
          "description": "资源版本",
          "example": "2"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "空间",
          "example": "space-sd12ad1"
        }
      ],
      "required": [
        "ResourceId",
        "VersionId"
      ]
    },
    {
      "name": "RunJobs",
      "description": "批量启动或者恢复作业，批量操作数量上限20",
      "status": "online",
      "parameters": [
        {
          "name": "RunJobDescriptions",
          "type": "array",
          "required": true,
          "description": "批量启动作业的描述信息",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "JobId",
              "type": "string",
              "required": true,
              "description": "作业Id",
              "example": "cql-6w8eab6f"
            },
            {
              "name": "RunType",
              "type": "integer",
              "required": true,
              "description": "运行类型，1：启动，2：恢复",
              "example": "1"
            },
            {
              "name": "StartMode",
              "type": "string",
              "required": false,
              "description": "兼容旧版 SQL 类型作业启动参数：指定数据源消费起始时间点（建议传值） 保证参数为 LATEST、EARLIEST、T+Timestamp （例:T1557394288000）",
              "example": "LATEST"
            },
            {
              "name": "JobConfigVersion",
              "type": "integer",
              "required": false,
              "description": "当前作业的某个版本 （不传默认为非草稿的作业版本）",
              "example": "1"
            },
            {
              "name": "SavepointPath",
              "type": "string",
              "required": false,
              "description": "Savepoint路径",
              "example": "Savepoint"
            },
            {
              "name": "SavepointId",
              "type": "string",
              "required": false,
              "description": "Savepoint的Id",
              "example": "cql-6w8eab6f"
            },
            {
              "name": "UseOldSystemConnector",
              "type": "boolean",
              "required": false,
              "description": "使用历史版本系统依赖",
              "example": "false"
            },
            {
              "name": "CustomTimestamp",
              "type": "integer",
              "required": false,
              "description": "自定义时间戳",
              "example": "1690531378626"
            },
            {
              "name": "KafkaScanMode",
              "type": "string",
              "required": false,
              "description": "timestamp; latest-offset; earliest-offset; 任选一种",
              "example": "earliest-offset"
            }
          ]
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1237"
        }
      ],
      "required": [
        "RunJobDescriptions"
      ]
    },
    {
      "name": "RunSqlGatewayStatement",
      "description": "通过Sql gateway执行satement",
      "status": "online",
      "parameters": [
        {
          "name": "ClusterId",
          "type": "string",
          "required": true,
          "description": "集群ID",
          "example": "cluster-lq6dtnk5"
        },
        {
          "name": "Sql",
          "type": "string",
          "required": true,
          "description": "需要执行的sql，该sql会被Sql Gateway执行，当前支持的是paimon修改需求，因此主要是DDL语句",
          "example": "select 1"
        },
        {
          "name": "SessionId",
          "type": "string",
          "required": false,
          "description": "Sql Gateway会话ID，可不填，如果不填则会自动创建一个会话ID，每个会话ID都有一个存活时间，测试环境为10分钟，线上默认是30分钟",
          "example": "b523f113-aa32-40cc-9665-5884a1dd480d"
        }
      ],
      "required": [
        "ClusterId",
        "Sql"
      ]
    },
    {
      "name": "StopJobs",
      "description": "批量停止作业，批量操作数量上限为20",
      "status": "online",
      "parameters": [
        {
          "name": "StopJobDescriptions",
          "type": "array",
          "required": true,
          "description": "批量停止作业的描述信息",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "JobId",
              "type": "string",
              "required": true,
              "description": "作业Id",
              "example": "1"
            },
            {
              "name": "StopType",
              "type": "integer",
              "required": true,
              "description": "停止类型，1 停止 2 暂停",
              "example": "1"
            }
          ]
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1237"
        }
      ],
      "required": [
        "StopJobDescriptions"
      ]
    },
    {
      "name": "TriggerJobSavepoint",
      "description": "触发Savepoint",
      "status": "online",
      "parameters": [
        {
          "name": "JobId",
          "type": "string",
          "required": true,
          "description": "作业 SerialId",
          "example": "cql-12345"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "描述",
          "example": "Description"
        },
        {
          "name": "WorkSpaceId",
          "type": "string",
          "required": false,
          "description": "工作空间 SerialId",
          "example": "space-1327"
        }
      ],
      "required": [
        "JobId"
      ]
    }
  ]
}