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-realtimetask-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

openapi: 3.2.0
info:
  title: ClickZetta Open Platform Realtime Task 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: RealtimeTask
  description: 实时任务管理
paths:
  /openapi/v2/realtime/startRealtimeTask:
    post:
      summary: 启动实时任务
      deprecated: false
      description: 启动指定的实时同步任务
      operationId: startRealtimeTask
      tags:
      - RealtimeTask
      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/RealtimeTaskStartRequest'
      responses:
        '200':
          description: 接口响应。请结合业务结果字段判断是否成功。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BooleanDataResponse'
          headers: {}
  /openapi/v2/realtime/stopRealtimeTask:
    post:
      summary: 停止实时任务
      deprecated: false
      description: 停止正在运行的实时同步任务
      operationId: stopRealtimeTask
      tags:
      - RealtimeTask
      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/RealtimeTaskIdRequest'
      responses:
        '200':
          description: 接口响应。请结合业务结果字段判断是否成功。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BooleanDataResponse'
          headers: {}
  /openapi/v2/realtime/offlineRealtimeTask:
    post:
      summary: 下线实时任务
      deprecated: false
      description: 将实时任务下线，停止调度
      operationId: offlineRealtimeTask
      tags:
      - RealtimeTask
      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/RealtimeTaskIdRequest'
      responses:
        '200':
          description: 接口响应。请结合业务结果字段判断是否成功。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BooleanDataResponse'
          headers: {}
  /openapi/v2/realtime/getRealtimeTaskDetail:
    post:
      summary: 查询实时任务详情
      deprecated: false
      description: 获取实时任务的完整配置与状态
      operationId: getRealtimeTaskDetail
      tags:
      - RealtimeTask
      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/RealtimeTaskIdRequest'
      responses:
        '200':
          description: 接口响应。请结合业务结果字段判断是否成功。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealtimeTaskGetDetailResponse'
          headers: {}
  /openapi/v2/realtime/listRealtimeTask:
    post:
      summary: 查询实时任务列表
      deprecated: false
      description: 分页查询工作空间下的实时任务列表
      operationId: listRealtimeTask
      tags:
      - RealtimeTask
      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/RealtimeTaskListRequest'
      responses:
        '200':
          description: 接口响应。请结合业务结果字段判断是否成功。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealtimeTaskListResponse'
          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
    AuthQuerySignatureVersion:
      name: SignatureVersion
      in: query
      required: false
      description: SDK 查询参数签名版本。 官方 SDK 自动注入；这里记录 SDK 发送的参数，不额外推断服务端是否逐项强制要求。
      schema:
        type: string
        enum:
        - '1.0'
      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
  schemas:
    RealtimeTaskListRequest:
      type: object
      properties:
        pageIndex:
          type: integer
          default: 1
        pageSize:
          type: integer
          default: 10
        orderBy:
          type: string
          title: DESC/ASC
        sortBy:
          type: string
          title: 排序字段
        workspace:
          type: string
        instance:
          type: string
        taskNameLike:
          type: string
        taskTypes:
          type: array
          items:
            $ref: '#/components/schemas/RtTaskType'
      required:
      - pageIndex
      - pageSize
      - workspace
      - instance
    RealtimeTaskStartRequest:
      type: object
      properties:
        id:
          type: integer
          format: int64
        startupMode:
          type: string
          enum:
          - INITIAL
          - SAVEPOINT
          - TIMESTAMP
          - OFFSET
        taskType:
          type: string
          title: 流批实时任务类型
          enum:
          - CDC
          - CDC_REALTIME
          - STREAMING_INTEGRATION
          - SNAPSHOT_SYNCHRONIZATION
          - INCREMENTAL_SYNCHRONIZATION
          - DYNAMIC_TABLE
          - CONTINUOUS_JOB
        startupParams:
          type: object
          properties: {}
          additionalProperties:
            type: string
        workspace:
          type: string
        instance:
          type: string
      required:
      - id
      - taskType
      - workspace
      - instance
    RealtimeTaskListResponse:
      type: object
      properties:
        requestId:
          type: string
        success:
          type: boolean
        code:
          type: string
        message:
          type: string
        data:
          type: object
          properties:
            pageNum:
              type: integer
            pageSize:
              type: integer
            pageCount:
              type: integer
            total:
              type: integer
              format: int64
            list:
              type: array
              items:
                $ref: '#/components/schemas/RealtimeTaskDetailResult'
          required:
          - pageNum
          - pageSize
          - pageCount
          - total
      required:
      - requestId
      - success
      - code
      - message
    RealtimeTaskGetDetailResponse:
      type: object
      properties:
        requestId:
          type: string
        success:
          type: boolean
        code:
          type: string
        message:
          type: string
        data:
          $ref: '#/components/schemas/RealtimeTaskDetailResult'
      required:
      - requestId
      - success
      - code
      - message
    RealtimeTaskDetailResult:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
          title: 任务名
        tenantId:
          type: integer
          format: int64
        userId:
          type: integer
          format: int64
        projectId:
          type: integer
          format: int64
        projectName:
          type: string
        taskOwner:
          type: string
        createdBy:
          type: string
        vcName:
          type: string
        createTime:
          type: string
          format: date
        updateTime:
          type: string
          format: date
        taskStatus:
          type: string
          enum:
          - UN_EXECUTE
          - STARTING
          - EXECUTING
          - STOPPING
          - STOPPED
          - FAILURE
        taskType:
          type: string
          title: 流批实时任务类型
          enum:
          - CDC
          - CDC_REALTIME
          - STREAMING_INTEGRATION
          - SNAPSHOT_SYNCHRONIZATION
          - INCREMENTAL_SYNCHRONIZATION
          - DYNAMIC_TABLE
          - CONTINUOUS_JOB
      required:
      - id
      - tenantId
      - userId
      - projectId
      - projectName
      - name
      - taskStatus
      - taskType
    BooleanDataResponse:
      type: object
      properties:
        requestId:
          type: string
        success:
          type: boolean
        code:
          type: string
        message:
          type: string
        data:
          type:
          - boolean
          - 'null'
          default: false
      required:
      - requestId
      - success
      - code
      - message
    RtTaskType:
      type: object
      properties:
        taskType:
          type: string
          title: 流批实时任务类型
          enum:
          - CDC
          - CDC_REALTIME
          - STREAMING_INTEGRATION
          - SNAPSHOT_SYNCHRONIZATION
          - INCREMENTAL_SYNCHRONIZATION
          - DYNAMIC_TABLE
          - CONTINUOUS_JOB
      required:
      - taskType
    RealtimeTaskIdRequest:
      type: object
      properties:
        id:
          type: integer
          format: int64
        workspace:
          type: string
        instance:
          type: string
      required:
      - id
      - workspace
      - instance
  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