API docs by Redocly

Semantic Understanding Task (0.1.0)

Download OpenAPI specification:

Vega Backend 语义理解异步任务 API。任务可针对单个 Resource 或整个 Catalog 创建； worker 将任务提交给 bkn-agent，并异步写回结果与应用状态。

获取语义理解任务列表

Authorizations:
OAuth2
query Parameters
scope
string
Enum: "resource" "catalog"
catalog_id
string
resource_id
string
status
Array of strings
Items Enum: "pending" "running" "completed" "failed" "cancelled"

按状态过滤；多个状态重复传递该参数，状态之间为 OR 关系。

apply_mode
string
Enum: "dry_run" "fill_empty" "force"

应用方式。

applied
boolean

是否已应用。

offset
integer >= 0
Default: 0
limit
integer
Default: 20
sort
string
Default: "create_time"
Enum: "create_time" "start_time" "finish_time"

排序字段。start_time、finish_time 为 0 的未开始或未结束任务按普通数值排序。

direction
string
Default: "desc"
Enum: "asc" "desc"

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total_count": 0
}

创建语义理解任务

Authorizations:
OAuth2
Request Body schema: application/json
required
One of
scope
required
string
Enum: "resource" "catalog"
Value: "catalog"
catalog_id
required
string
resource_id
string
apply_mode
string
Default: "fill_empty"
Enum: "dry_run" "fill_empty" "force"
confidence_threshold
number <double>
Default: 0.75
include_sample_rows
boolean

是否尝试读取并发送原始样例行；仅资源语义理解任务支持。样例查询不可用时，任务仍会创建并以空样例行继续执行。

object (SamplePolicy)

Responses

Request samples

Content type
application/json
Example
{
  • "scope": "catalog",
  • "catalog_id": "string",
  • "resource_id": "string",
  • "apply_mode": "dry_run",
  • "confidence_threshold": 0.75,
  • "include_sample_rows": true,
  • "sample_policy": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "scope": "resource",
  • "catalog_id": "string",
  • "catalog_name": "string",
  • "resource_id": "string",
  • "resource_name": "string",
  • "agent_task_id": "string",
  • "agent_id": "string",
  • "input": "string",
  • "input_hash": "string",
  • "status": "pending",
  • "apply_mode": "dry_run",
  • "result_json": "string",
  • "confidence_threshold": 0.1,
  • "confidence": 0.1,
  • "confidence_detail_json": "string",
  • "apply_detail_json": "string",
  • "applied": true,
  • "failure_detail": "string",
  • "creator": {
    },
  • "create_time": 0,
  • "start_time": 0,
  • "finish_time": 0
}

获取语义理解任务详情

Authorizations:
OAuth2
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "scope": "resource",
  • "catalog_id": "string",
  • "catalog_name": "string",
  • "resource_id": "string",
  • "resource_name": "string",
  • "agent_task_id": "string",
  • "agent_id": "string",
  • "input": "string",
  • "input_hash": "string",
  • "status": "pending",
  • "apply_mode": "dry_run",
  • "result_json": "string",
  • "confidence_threshold": 0.1,
  • "confidence": 0.1,
  • "confidence_detail_json": "string",
  • "apply_detail_json": "string",
  • "applied": true,
  • "failure_detail": "string",
  • "creator": {
    },
  • "create_time": 0,
  • "start_time": 0,
  • "finish_time": 0
}

删除语义理解任务

路径参数可为逗号分隔的任务 ID；运行中的任务不可删除。

Authorizations:
OAuth2
path Parameters
id
required
string
query Parameters
ignore_missing
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "error_code": "string",
  • "description": "string",
  • "solution": "string",
  • "error_link": "string",
  • "error_details": null
}