RetryKnowledgeBaseFailedSources - 批量重试指定目录下所有失败状态的数据源

更新时间:
复制 MD 格式

批量重试指定目录下所有失败状态的数据源

接口说明

请求说明

该 API 用于获取并重试指定企业知识库目录(包括其子目录)下的所有处于 FAILED 状态的数据源。请求将立即返回,实际的重试操作将在后台异步执行。

  • 鉴权:除了基础鉴权外,还需具备DEVELOPMENT_KB_MANAGE权限。

  • 安全约束:仅允许具有相应租户和用户身份的调用者访问,并且需要 KB 管理权限;管理员可以对任何用户的失败资源发起重试。

  • 参数:
    • directoryId (必填):指定要检查和重试失败数据源的企业知识库目录 ID。

    • tenantId (可选):指定租户 ID,默认使用调用方的默认租户。

  • 响应:成功时返回已入队等待重试的数据源数量及详情等信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

winnexo:RetryKnowledgeBaseFailedSources

create

*全部资源

*

无 无

请求语法

POST /openapi/retryKnowledgeBaseFailedSources HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

tenantId

string

否

租户 ID,公共参数;winnexo-cli 通过 --tenant-id 显式传入。

10000

directoryId

string

是

企业知识库目录 ID(递归包含子目录下的失败资源)。

exampleDirectoryId

返回参数

名称

类型

描述

示例值

object

重试企业知识库目录下所有失败数据源。

code

string

业务状态码:成功为 200,失败为后端错误码(ERR.* / InvalidParameter.*)

200

directoryId

string

企业知识库目录 ID。

exampleDirectoryId

enqueuedCount

integer

成功入队重试的数量。

1

enqueuedIds

array

已重新入队的知识库来源 ID 列表。

string_value

string

已重新入队的知识库来源 ID。

ID

failedCount

integer

目录下失败资源总数。

1

failedSources

array<object>

失败的数据源列表。

object

失败的数据源 ID

name

string

文件名。

示例名称.pdf

sourceId

string

数据源 ID。

exampleSourceId

sourceType

string

数据源类型。

string_value

message

string

错误描述,成功时为空

ok

requestId

string

请求追踪 ID。

019FF406-1B10-0065-A97D-2D1920C2A03D

skippedCount

integer

跳过(非 FAILED 状态)的数量。

1

示例

正常返回示例

JSON格式

{
  "code": "200",
  "directoryId": "exampleDirectoryId",
  "enqueuedCount": 1,
  "enqueuedIds": [
    "ID"
  ],
  "failedCount": 1,
  "failedSources": [
    {
      "name": "示例名称.pdf",
      "sourceId": "exampleSourceId",
      "sourceType": "string_value"
    }
  ],
  "message": "ok",
  "requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
  "skippedCount": 1
}

错误码

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

变更历史

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