SubmitIndexJob - 提交索引创建任务_大模型服务平台百炼(Model Studio)-阿里云帮助中心

提交指定的 CreateIndex 任务以完成知识库创建。

接口说明

调用本接口前，您必须预先调用 CreateIndex 接口，并且获取到对应的IndexId。
本接口调用成功后，将执行一段时间，请求返回前请勿重复发起请求。
本接口调用成功后，如果需要查询任务的执行状态，接下来可调用 GetIndexJobStatus 接口。
本接口不具备幂等性。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sfm:SubmitIndexJob	create	全部资源 *	无	无

请求语法

POST /{WorkspaceId}/index/submit_index_job HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	知识库所属的业务空间 ID。在百炼的控制台首页，单击页面左上角业务空间详情图标获取。	llm-3shx2gu255oqxxxx
IndexId	string	是	知识库 ID，即 CreateIndex 接口返回的`Data.Id`。	79c0alxxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	17204B98-xxxx-4F9A-8464-2446A84821CA
Success	boolean	接口调用是否成功，可能值： true：成功。 false：失败。	true
Message	string	错误信息。	Required parameter(%s) missing or invalid, please check the request parameters.
Code	string	错误状态码。	Index.InvalidParameter
Status	string	接口返回的状态码。	200
Data	object	接口返回的业务字段。
Id	string	任务 ID，即调用 GetIndexJobStatus 接口时需要用到的任务`JobId`。	eFDr2fGRzP9gdDZWAdo3xxxx
IndexId	string	知识库 ID。	79c0alxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Success": true,
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Code": "Index.InvalidParameter",
  "Status": "200",
  "Data": {
    "Id": "eFDr2fGRzP9gdDZWAdo3xxxx",
    "IndexId": "79c0alxxxx"
  }
}

错误码

HTTP status code	错误码	错误信息
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史