StopKnowledgeBaseBuildTaskInstance - 停止知识库构建任务实例-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

请求停止指定构建任务实例，并返回实例当前状态。

接口说明

停止知识库构建任务实例。租户及调用者身份由 POP 认证上下文确定。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
KnowledgeBaseId	string	是	所属知识库	12345678-1234-4234-8234-123456789abc
TaskInstanceId	string	是	执行 ID	20001

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次请求的唯一标识，可用于定位问题。	00000000-0000-4000-8000-000000000001
Success	boolean	请求是否成功
Data	object	成功时返回的业务数据。
TaskInstanceId	string	本次执行 ID	20001
TaskId	string	来源任务 ID	10001
KnowledgeBaseId	string	所属知识库，便于范围校验和查询	12345678-1234-4234-8234-123456789abc
TriggerType	string	本次由手动、周期或受支持的事件触发	MANUAL
Status	string	本次执行的整体状态	RUNNING
CurrentStage	string	当前业务阶段，有可靠记录时返回；普通构建阶段及语义模型导入阶段见领域模型，不替代整体 Status	INITIALIZE
InputSnapshot	object	本次选择及解析后的非敏感输入快照，不随任务更新改变。
SelectedInput	object	创建实例时任务定义中的选择条件快照；不会随任务更新改变
ProjectIds	array	工作空间范围构建选择的 DataWorks 工作空间 ID；非空、去重
	integer	工作空间范围构建选择的 DataWorks 工作空间 ID；非空、去重	12345
SourceIds	array	本库已登记来源的 ID，去重；是否必填及允许的来源类型由任务输入场景决定，见下表
	string	本库已登记来源的 ID，去重；是否必填及允许的来源类型由任务输入场景决定，见下表	src-document-001
Entities	array<object>	数据资产范围构建选择的数据库、Schema、表等数据地图实体；非空、去重
	object
EntityId	string	数据地图返回的元数据实体 ID；客户端原样传递，不自行拼接数据库、Schema 或表标识	maxcompute-table:::project_name:schema_name:table_name
EntityType	string	实体层级，如 DATABASE、SCHEMA、TABLE；服务端以数据地图身份校验，不因枚举存在就承诺所有引擎均支持	TABLE
YamlUploadId	string	SEMANTIC_MODEL 导入任务使用的本库 YAML 上传会话 ID；创建任务时绑定，不能混用其他输入范围。	upload-yaml-001
KnowledgeObjectIds	array	从本库文档对象构建时必填、非空且去重；每项为本库 Type=DOCUMENT 的 KnowledgeObjectId；与外部连接器同步范围 SourceIds 不混用
	string	从本库文档对象构建时必填、非空且去重；每项为本库 Type=DOCUMENT 的 KnowledgeObjectId；与外部连接器同步范围 SourceIds 不混用	obj-document-001
DocumentSourceCount	integer	本次选择的外部文档来源数量；不适用时不返回	1
ResolvedEntities	array<object>	从项目、数据库或 Schema 范围解析出的本次实际数据地图实体；不适用时不返回
	object
EntityId	string	数据地图返回的元数据实体 ID；客户端原样传递，不自行拼接数据库、Schema 或表标识	maxcompute-table:::project_name:schema_name:table_name
EntityType	string	实体层级，如 DATABASE、SCHEMA、TABLE；服务端以数据地图身份校验，不因枚举存在就承诺所有引擎均支持	TABLE
ResolvedEntityCount	integer	已解析实体总数；数组因规模未返回时仍可返回准确数量	42
ConfigSnapshot	object	本次模型、内容语言和运行资源快照，不随任务更新改变。
ProjectId	integer	本次运行使用的 DataWorks 工作空间 ID，从创建实例时的任务定义冻结	67890
LlmModel	string	本次实际使用并冻结的具体模型 ID，不返回 AUTO；纯同步等不调用模型的任务可为空	model-001
ContentLocale	string	本次使用的内容语言	zh-CN
RuntimeResource	object	本次实际使用的资源组与 Builder CU
ResourceGroupId	string	真实 Builder 节点使用的 DataWorks 资源组 ID；服务端校验其在任务顶层 ProjectId 对应工作空间内可用	rg-001
Cu	integer	Builder 计算规格，取值 4～16；创建省略时有效值为 4，读取返回有效值	4
Error	object	失败时的错误码与安全错误信息。
Code	string	业务错误码；请求失败时用于判断错误类型。	InvalidParameter
Message	string	请求失败时的安全错误信息。	请求参数不合法。
GeneratedModels	array<object>	仅模型导入：已确认的 ModelId、VersionNo，结构见实例 Get 文档
	object
ModelId	string	语义层生成的模型 ID，可作为 KnowledgeObjectId 读取对应语义模型。	01MODELULID
VersionNo	integer	SEMANTIC_MODEL 当前读取的版本；更新内容时传此值，版本可原地编辑	1
CreateTime	integer	实例创建时间	1790200400000
StartedTime	integer	开始执行时间，可选	1790200001000
FinishedTime	integer	执行结束时间，可选	1790200060000
Code	string	业务错误码；请求失败时用于判断错误类型。	InvalidParameter
Message	string	请求失败时的安全错误信息。	请求参数不合法。

示例

正常返回示例

JSON格式

{
  "RequestId": "00000000-0000-4000-8000-000000000001",
  "Success": true,
  "Data": {
    "TaskInstanceId": "20001",
    "TaskId": "10001",
    "KnowledgeBaseId": "12345678-1234-4234-8234-123456789abc",
    "TriggerType": "MANUAL",
    "Status": "RUNNING",
    "CurrentStage": "INITIALIZE",
    "InputSnapshot": {
      "SelectedInput": {
        "ProjectIds": [
          12345
        ],
        "SourceIds": [
          "src-document-001"
        ],
        "Entities": [
          {
            "EntityId": "maxcompute-table:::project_name:schema_name:table_name",
            "EntityType": "TABLE"
          }
        ],
        "YamlUploadId": "upload-yaml-001",
        "KnowledgeObjectIds": [
          "obj-document-001"
        ]
      },
      "DocumentSourceCount": 1,
      "ResolvedEntities": [
        {
          "EntityId": "maxcompute-table:::project_name:schema_name:table_name",
          "EntityType": "TABLE"
        }
      ],
      "ResolvedEntityCount": 42
    },
    "ConfigSnapshot": {
      "ProjectId": 67890,
      "LlmModel": "model-001",
      "ContentLocale": "zh-CN",
      "RuntimeResource": {
        "ResourceGroupId": "rg-001",
        "Cu": 4
      }
    },
    "Error": {
      "Code": "InvalidParameter",
      "Message": "请求参数不合法。"
    },
    "GeneratedModels": [
      {
        "ModelId": "01MODELULID",
        "VersionNo": 1
      }
    ],
    "CreateTime": 1790200400000,
    "StartedTime": 1790200001000,
    "FinishedTime": 1790200060000
  },
  "Code": "InvalidParameter",
  "Message": "请求参数不合法。"
}

错误码

HTTP status code	错误码	错误信息
400	InvalidParameter	The request parameters are invalid.
403	Forbidden	You are not authorized to perform this operation.
404	ResourceNotFound	The requested resource does not exist or is not visible.
503	ServiceUnavailable	The service is temporarily unavailable.
409	Conflict	The resource state conflicts with this operation.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。