Yunqi (ClickZetta / Singdata Lakehouse)

Yunqi (ClickZetta / Singdata Lakehouse) Dqc API

数据质量规则管理

GitHub OpenAPI

Operations 3

POST /openapi/v2/dqc/rule/add 添加数据质量规则 #
POST /openapi/v2/dqc/rule/entity/list 查询对象的数据质量规则 #
POST /openapi/v2/dqc/rule/task/list 查询任务的数据质量规则 #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/yunqi/openapi/yunqi-dqc-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/yunqi:yunqi-dqc-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yunqi-dqc-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ClickZetta Open Platform Dqc API
  description: 'ClickZetta 开放平台管理接口，覆盖调度任务、数据源、库表同步、虚拟集群、工作空间、实时任务、实例、数据质量及用户管理。接口路径使用 /openapi/v2；info.version 保留仓库原有的契约版本标记。


    使用 AK/SK 自定义请求签名认证。accessKey 是 Access Key ID，sign 是每次请求动态生成的签名；Access Key Secret 只在客户端参与签名，不随请求发送。请求头与查询参数由官方 SDK 生成。SDK 使用 HMAC-SHA1 计算签名，查询参数 SignatureMethod 为 HMAC-SHA1，请求头 signMethod 为 HMAC-SHA256；请按 SDK 的现有协议传值，不要自行统一这两个标记。普通 OpenAPI 客户端不会自动生成此签名，建议使用官方 SDK。


    HTTP 200 只表示 HTTP 请求已返回；调用方还应检查响应中的业务结果字段。不同接口的成功及错误响应以各自模型和示例为准。'
  version: 1.0.0
servers:
- url: https://api.clickzetta.com
  description: 国内生产环境（在线文档示例）
- url: https://api.singdata.com
  description: 新加坡节点（在线文档示例）
security:
- AccessKeyID: []
  RequestSignature: []
tags:
- name: Dqc
  description: 数据质量规则管理
paths:
  /openapi/v2/dqc/rule/add:
    post:
      summary: 添加数据质量规则
      deprecated: false
      description: 创建数据质量检查规则，参数见 DqcRuleRequest。
      operationId: addRule
      tags:
      - Dqc
      parameters:
      - $ref: '#/components/parameters/AuthHeaderMethod'
      - $ref: '#/components/parameters/AuthHeaderT'
      - $ref: '#/components/parameters/AuthHeaderSignMethod'
      - $ref: '#/components/parameters/AuthHeaderSignVersion'
      - $ref: '#/components/parameters/AuthHeaderNonce'
      - $ref: '#/components/parameters/AuthQueryFormat'
      - $ref: '#/components/parameters/AuthQueryTimestamp'
      - $ref: '#/components/parameters/AuthQuerySignatureMethod'
      - $ref: '#/components/parameters/AuthQuerySignatureVersion'
      - $ref: '#/components/parameters/AuthQuerySignatureNonce'
      - $ref: '#/components/parameters/AuthQuerySignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DqcRuleRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddRuleResponse'
          headers: {}
  /openapi/v2/dqc/rule/entity/list:
    post:
      summary: 查询对象的数据质量规则
      deprecated: false
      description: 查询指定对象关联的数据质量规则。
      operationId: queryEntityRule
      tags:
      - Dqc
      parameters:
      - $ref: '#/components/parameters/AuthHeaderMethod'
      - $ref: '#/components/parameters/AuthHeaderT'
      - $ref: '#/components/parameters/AuthHeaderSignMethod'
      - $ref: '#/components/parameters/AuthHeaderSignVersion'
      - $ref: '#/components/parameters/AuthHeaderNonce'
      - $ref: '#/components/parameters/AuthQueryFormat'
      - $ref: '#/components/parameters/AuthQueryTimestamp'
      - $ref: '#/components/parameters/AuthQuerySignatureMethod'
      - $ref: '#/components/parameters/AuthQuerySignatureVersion'
      - $ref: '#/components/parameters/AuthQuerySignatureNonce'
      - $ref: '#/components/parameters/AuthQuerySignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleQueryRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryEntityRuleResponse'
          headers: {}
  /openapi/v2/dqc/rule/task/list:
    post:
      summary: 查询任务的数据质量规则
      deprecated: false
      description: 查询指定任务关联的数据质量规则。
      operationId: queryRuleTask
      tags:
      - Dqc
      parameters:
      - $ref: '#/components/parameters/AuthHeaderMethod'
      - $ref: '#/components/parameters/AuthHeaderT'
      - $ref: '#/components/parameters/AuthHeaderSignMethod'
      - $ref: '#/components/parameters/AuthHeaderSignVersion'
      - $ref: '#/components/parameters/AuthHeaderNonce'
      - $ref: '#/components/parameters/AuthQueryFormat'
      - $ref: '#/components/parameters/AuthQueryTimestamp'
      - $ref: '#/components/parameters/AuthQuerySignatureMethod'
      - $ref: '#/components/parameters/AuthQuerySignatureVersion'
      - $ref: '#/components/parameters/AuthQuerySignatureNonce'
      - $ref: '#/components/parameters/AuthQuerySignature'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleTaskQueryRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryRuleTaskResponse'
          headers: {}
components:
  parameters:
    AuthQuerySignature:
      name: Signature
      in: query
      required: false
      description: SDK 计算的 Base64 签名，同请求头 sign。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthHeaderSignMethod:
      name: signMethod
      in: header
      required: false
      description: SDK 请求头协议标记，固定为 HMAC-SHA256；实际签名计算及查询参数按 SDK 使用 HMAC-SHA1。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - HMAC-SHA256
      x-sdk-injected: true
    AuthHeaderSignVersion:
      name: signVersion
      in: header
      required: false
      description: SDK 写入签名版本。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - v1.0
      x-sdk-injected: true
    AuthQueryTimestamp:
      name: Timestamp
      in: query
      required: false
      description: SDK 生成 UTC 时间戳；签名和 URL 序列化包含百分号编码，具体规则以附件 SDK 为准。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthHeaderNonce:
      name: nonce
      in: header
      required: false
      description: SDK 生成的随机数字串，与 SignatureNonce 一致。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthQuerySignatureNonce:
      name: SignatureNonce
      in: query
      required: false
      description: SDK 生成的随机数字串。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthQueryFormat:
      name: Format
      in: query
      required: false
      description: SDK 固定输出 JSON。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - JSON
      x-sdk-injected: true
    AuthQuerySignatureMethod:
      name: SignatureMethod
      in: query
      required: false
      description: SDK 查询参数声明使用 HMAC-SHA1。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - HMAC-SHA1
      x-sdk-injected: true
    AuthHeaderT:
      name: t
      in: header
      required: false
      description: SDK 写入当前 Unix 毫秒时间戳的十进制字符串。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
      x-sdk-injected: true
    AuthHeaderMethod:
      name: method
      in: header
      required: false
      description: SDK 写入 HTTP 方法。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - POST
      x-sdk-injected: true
    AuthQuerySignatureVersion:
      name: SignatureVersion
      in: query
      required: false
      description: SDK 查询参数签名版本。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - '1.0'
      x-sdk-injected: true
  schemas:
    DqcRuleTaskResult:
      type: object
      description: Rule Task Detail
      properties:
        id:
          type: integer
          format: int64
        tenantId:
          type: integer
          format: int64
        accountId:
          type: integer
          format: int32
        instanceId:
          type: integer
          format: int32
        createTime:
          type: string
          format: date-time
        updateTime:
          type: string
          format: date-time
        ruleId:
          type: integer
          format: int64
        owner:
          type: integer
          format: int64
        datasourceType:
          type: string
        workspaceId:
          type: integer
          format: int64
        workspace:
          type: string
        objectName:
          type: string
        objectType:
          type: string
        tagCode:
          type: string
        checkerInfo:
          type: string
        scheduleInstanceId:
          type: integer
          format: int64
        flowParentInstanceId:
          type: integer
          format: int64
        scheduleInstanceExecuteId:
          type: integer
          format: int64
        scheduleTaskId:
          type: integer
          format: int64
        mainSchedulerTaskId:
          type: integer
          format: int64
        subSchedulerTaskId:
          type: integer
          format: int64
        qualityInstanceId:
          type: integer
          format: int64
        collectorInfo:
          type: string
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
        runTime:
          type: integer
          format: int64
          description: Run time (ms)
        timeout:
          type: integer
          format: int32
          description: Timeout (hours)
        tagValue:
          type: number
          format: double
        status:
          type: string
          description: RUNNING, FAILED, TIMEOUT, CANCEL, SUCCESS
        processStatus:
          type: integer
          format: int32
        triggerType:
          type: string
        msg:
          type: string
        level:
          type: integer
          format: int32
          description: 0=weak, 1=strong
        reRun:
          type: integer
          format: int32
          description: 0=no, 1=yes
        modifyInfo:
          type: string
        env:
          type: string
    RuleTaskQueryRequest:
      type: object
      properties:
        ruleId:
          type: integer
          format: int64
        level:
          type: integer
          format: int32
          description: 0=non-blocking, 1=blocking
        triggerType:
          type:
          - string
          - 'null'
          title: TriggerEnum
          description: '规则触发方式


            枚举说明：

            - `TEST`: 手动触发，仅测试，不发送告警

            - `TEST_ALERT`: 手动触发，测试并发送告警

            - `REST`: 通过 REST 接口手动触发

            - `SCHEDULE_TASK`: 由调度器定时触发

            - `PLAN`: 由执行计划触发'
          enum:
          - TEST
          - TEST_ALERT
          - REST
          - SCHEDULE_TASK
          - PLAN
          - null
        datasourceType:
          type: string
          title: DatasourceEnum
          description: '数据源类型


            枚举说明：

            - `LakeHouse`: Clickzetta Lakehouse

            - `Databricks`: Databricks'
          enum:
          - LakeHouse
          - Databricks
        objectName:
          type: string
        objectType:
          type: string
          title: ObjectTypeEnum
          description: 'DQC 规则作用的对象类型


            枚举说明：

            - `TABLE`: 表

            - `PIPE`: pipe

            - `VIEW`: view

            - `VOLUME`: Volume

            - `DYNAMIC_TABLE`: Dynamic Table

            - `TABLE_STREAM`: Table Stream

            - `MATERIALIZED_VIEW`: materialized View'
          enum:
          - TABLE
          - PIPE
          - VIEW
          - VOLUME
          - DYNAMIC_TABLE
          - TABLE_STREAM
          - MATERIALIZED_VIEW
        fuzzyObjectName:
          type: string
        tagCode:
          type: string
          title: TagEnum
          description: 'DQC 规则标签类型（type=0 表级，type=1 字段级）


            枚举说明：

            - `defined_sql`: 表级 (type=0)

            - `table_count`: 表级 (type=0)

            - `avg`: 字段级 (type=1)

            - `count`: 字段级 (type=1)

            - `null_count`: 字段级 (type=1)

            - `max`: 字段级 (type=1)

            - `min`: 字段级 (type=1)

            - `sum`: 字段级 (type=1)

            - `count_distinct`: 字段级 (type=1)

            - `count_repetition`: 字段级 (type=1)

            - `pipe_kafka_latency`: 表级 (type=0)

            - `table_stream_kafka_latency`: 表级 (type=0)

            - `volume_file_count`: 表级 (type=0)'
          enum:
          - defined_sql
          - table_count
          - avg
          - count
          - null_count
          - max
          - min
          - sum
          - count_distinct
          - count_repetition
          - pipe_kafka_latency
          - table_stream_kafka_latency
          - volume_file_count
        owner:
          type: integer
          format: int64
        status:
          type: string
          description: RUNNING, FAILED, TIMEOUT, CANCEL, SUCCESS
        env:
          type: string
        pageNum:
          type: integer
        pageSize:
          type: integer
        instanceName:
          type: string
        workspaceName:
          type: string
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
      required:
      - pageNum
      - pageSize
    DqcEntityResult:
      type: object
      properties:
        objectId:
          type: string
        objectName:
          type: string
        objectType:
          type: string
        workspaceName:
          type: string
        workspaceId:
          type: integer
          format: int64
        ownerName:
          type: string
        owner:
          type: integer
          format: int64
        datasourceType:
          type: string
        datasourceId:
          type: integer
          format: int64
        ruleCount:
          type: integer
          format: int32
        activeRuleCount:
          type: integer
          format: int32
        passingResult:
          type: integer
          format: int32
        failingResult:
          type: integer
          format: int32
        exceptionResult:
          type: integer
          format: int32
        latestStartTime:
          type: string
          format: date-time
        latestEndTime:
          type: string
          format: date-time
        latestStatus:
          type: string
        env:
          type: string
    QueryRuleTaskResponse:
      type: object
      properties:
        requestId:
          type: string
        success:
          type: boolean
        code:
          type: string
        message:
          type: string
        data:
          type: object
          properties:
            list:
              type: array
              items:
                $ref: '#/components/schemas/DqcRuleTaskResult'
            pageNum:
              type: integer
              format: int32
            pageSize:
              type: integer
              format: int32
            total:
              type: integer
              format: int64
    CheckerInfo:
      type: object
      title: CheckerInfo
      description: 规则检查条件配置
      properties:
        checker:
          title: CheckerEnum
          description: '检查类型：固定值或波动值


            枚举说明：

            - `FIXED`: 与固定阈值比较

            - `FLUX`: 与历史基准值的波动比较'
          type: string
          enum:
          - FIXED
          - FLUX
        operator:
          title: OperatorEnum
          description: '比较运算符


            枚举说明：

            - `EQUAL`: ==

            - `NOT_EQUAL`: !=

            - `LESS_THAN`: <

            - `LESS_EQUAL`: <=

            - `GREATER_THAN`: >

            - `GREATER_EQUAL`: >='
          type: string
          enum:
          - EQUAL
          - NOT_EQUAL
          - LESS_THAN
          - LESS_EQUAL
          - GREATER_THAN
          - GREATER_EQUAL
        value:
          description: 阈值（固定值模式下为具体数值，波动值模式下为波动比例或绝对量）
        baseInfo:
          type: string
          description: 基准信息（波动值模式下的基准描述）
        fluxType:
          title: FluxTypeEnum
          description: '波动类型，checker=FLUX 时有效


            枚举说明：

            - `ABS`: 与基准的绝对差值

            - `UP`: 仅检测上涨方向的波动

            - `DOWN`: 仅检测下跌方向的波动'
          type: string
          enum:
          - ABS
          - UP
          - DOWN
    QueryEntityRuleResponse:
      type: object
      properties:
        requestId:
          type: string
        success:
          type: boolean
        code:
          type: string
        message:
          type: string
        data:
          type: object
          properties:
            list:
              type: array
              items:
                $ref: '#/components/schemas/DqcEntityResult'
            pageNum:
              type: integer
              format: int32
            pageSize:
              type: integer
              format: int32
            total:
              type: integer
              format: int64
    AddRuleResponse:
      type: object
      properties:
        requestId:
          type: string
        success:
          type: boolean
        code:
          type: string
        message:
          type: string
        data:
          type: integer
          format: int64
    RuleQueryRequest:
      type: object
      properties:
        datasourceType:
          type: string
          title: DatasourceEnum
          description: '数据源类型


            枚举说明：

            - `LakeHouse`: Clickzetta Lakehouse

            - `Databricks`: Databricks'
          enum:
          - LakeHouse
          - Databricks
        datasourceId:
          type: string
        objectType:
          type: string
          title: ObjectTypeEnum
          description: 'DQC 规则作用的对象类型


            枚举说明：

            - `TABLE`: 表

            - `PIPE`: pipe

            - `VIEW`: view

            - `VOLUME`: Volume

            - `DYNAMIC_TABLE`: Dynamic Table

            - `TABLE_STREAM`: Table Stream

            - `MATERIALIZED_VIEW`: materialized View'
          enum:
          - TABLE
          - PIPE
          - VIEW
          - VOLUME
          - DYNAMIC_TABLE
          - TABLE_STREAM
          - MATERIALIZED_VIEW
        objectName:
          type: string
        fuzzyObjectName:
          type: string
        tagCode:
          type: string
          title: TagEnum
          description: 'DQC 规则标签类型（type=0 表级，type=1 字段级）


            枚举说明：

            - `defined_sql`: 表级 (type=0)

            - `table_count`: 表级 (type=0)

            - `avg`: 字段级 (type=1)

            - `count`: 字段级 (type=1)

            - `null_count`: 字段级 (type=1)

            - `max`: 字段级 (type=1)

            - `min`: 字段级 (type=1)

            - `sum`: 字段级 (type=1)

            - `count_distinct`: 字段级 (type=1)

            - `count_repetition`: 字段级 (type=1)

            - `pipe_kafka_latency`: 表级 (type=0)

            - `table_stream_kafka_latency`: 表级 (type=0)

            - `volume_file_count`: 表级 (type=0)'
          enum:
          - defined_sql
          - table_count
          - avg
          - count
          - null_count
          - max
          - min
          - sum
          - count_distinct
          - count_repetition
          - pipe_kafka_latency
          - table_stream_kafka_latency
          - volume_file_count
        triggerType:
          type:
          - string
          - 'null'
          title: TriggerEnum
          description: '规则触发方式


            枚举说明：

            - `TEST`: 手动触发，仅测试，不发送告警

            - `TEST_ALERT`: 手动触发，测试并发送告警

            - `REST`: 通过 REST 接口手动触发

            - `SCHEDULE_TASK`: 由调度器定时触发

            - `PLAN`: 由执行计划触发'
          enum:
          - TEST
          - TEST_ALERT
          - REST
          - SCHEDULE_TASK
          - PLAN
          - null
        level:
          type: integer
          format: int32
          description: 0=non-blocking, 1=blocking, 2=non-scheduled
        owner:
          type: integer
          format: int64
        status:
          type: integer
          format: int32
          description: 0=enabled, 1=disabled
        env:
          type: string
        instanceName:
          type: string
        workspaceName:
          type: string
        pageSize:
          type: integer
        pageNum:
          type: integer
      required:
      - pageSize
      - pageNum
    DqcRuleRequest:
      type: object
      description: Add Rule Request
      properties:
        name:
          type: string
          description: Rule name
        owner:
          type: integer
          format: int64
          description: Owner user ID
        datasourceType:
          type: string
          title: DatasourceEnum
          description: '数据源类型


            枚举说明：

            - `LakeHouse`: Clickzetta Lakehouse

            - `Databricks`: Databricks'
          enum:
          - LakeHouse
          - Databricks
        instanceName:
          type: string
        workspaceName:
          type: string
          description: Workspace name
        objectName:
          type: string
          description: Object name
        objectType:
          type: string
          title: ObjectTypeEnum
          description: 'DQC 规则作用的对象类型


            枚举说明：

            - `TABLE`: 表

            - `PIPE`: pipe

            - `VIEW`: view

            - `VOLUME`: Volume

            - `DYNAMIC_TABLE`: Dynamic Table

            - `TABLE_STREAM`: Table Stream

            - `MATERIALIZED_VIEW`: materialized View'
          enum:
          - TABLE
          - PIPE
          - VIEW
          - VOLUME
          - DYNAMIC_TABLE
          - TABLE_STREAM
          - MATERIALIZED_VIEW
        properties:
          type: string
          description: Check properties, comma-separated
        checkerInfo:
          $ref: '#/components/schemas/CheckerInfo'
        tagType:
          type: integer
          format: int32
          description: 'Tag type: 1=built-in, 2=custom SQL'
        tagCode:
          type: string
          title: TagEnum
          description: 'DQC 规则标签类型（type=0 表级，type=1 字段级）


            枚举说明：

            - `defined_sql`: 表级 (type=0)

            - `table_count`: 表级 (type=0)

            - `avg`: 字段级 (type=1)

            - `count`: 字段级 (type=1)

            - `null_count`: 字段级 (type=1)

            - `max`: 字段级 (type=1)

            - `min`: 字段级 (type=1)

            - `sum`: 字段级 (type=1)

            - `count_distinct`: 字段级 (type=1)

            - `count_repetition`: 字段级 (type=1)

            - `pipe_kafka_latency`: 表级 (type=0)

            - `table_stream_kafka_latency`: 表级 (type=0)

            - `volume_file_count`: 表级 (type=0)'
          enum:
          - defined_sql
          - table_count
          - avg
          - count
          - null_count
          - max
          - min
          - sum
          - count_distinct
          - count_repetition
          - pipe_kafka_latency
          - table_stream_kafka_latency
          - volume_file_count
        paramValues:
          type: string
          description: Parameter config
        definedSql:
          type: string
          description: Custom SQL
        condition:
          type: string
          description: Check condition
        triggerType:
          type:
          - string
          - 'null'
          title: TriggerEnum
          description: '规则触发方式


            枚举说明：

            - `TEST`: 手动触发，仅测试，不发送告警

            - `TEST_ALERT`: 手动触发，测试并发送告警

            - `REST`: 通过 REST 接口手动触发

            - `SCHEDULE_TASK`: 由调度器定时触发

            - `PLAN`: 由执行计划触发'
          enum:
          - TEST
          - TEST_ALERT
          - REST
          - SCHEDULE_TASK
          - PLAN
          - null
        triggerCron:
          type: string
          description: Cron expression for scheduled trigger
        mainSchedulerTaskId:
          type:
          - integer
          - 'null'
          description: 调度任务触发：组合节点或者独立节点任务
          format: int64
        subSchedulerTaskId:
          type:
          - integer
          - 'null'
          description: 调度任务触发：组合节点的子任务
          format: int64
        vcluster:
          type: string
          description: Execution cluster
        timeout:
          type: integer
          format: int32
          description: Timeout (hours)
        desc:
          type: string
          description: Description
      required:
      - instanceName
      - workspaceName
      - objectName
      - name
      - vcluster
      - timeout
      - checkerInfo
  securitySchemes:
    AccessKeyID:
      type: apiKey
      in: header
      name: accessKey
      description: Access Key ID。与 RequestSignature 同时使用；不要填写 Access Key Secret。
    RequestSignature:
      type: apiKey
      in: header
      name: sign
      description: 使用 AK/SK 自定义请求签名认证。accessKey 是 Access Key ID，sign 是每次请求动态生成的签名；Access Key Secret 只在客户端参与签名，不随请求发送。请求头与查询参数由官方 SDK 生成。SDK 使用 HMAC-SHA1 计算签名，查询参数 SignatureMethod 为 HMAC-SHA1，请求头 signMethod 为 HMAC-SHA256；请按 SDK 的现有协议传值，不要自行统一这两个标记。普通 OpenAPI 客户端不会自动生成此签名，建议使用官方 SDK。
externalDocs:
  description: ClickZetta 官方文档
  url: https://yunqi.tech/documents