Submits a specified CreateIndex job to complete knowledge base creation.
Operation description
- Before you call this operation, you must call the CreateIndex operation and obtain the
IndexId. - Execution takes a period of time after this operation is called. Do not make new request before the request is returned.
- If you want to query the execution status of the job after you call this operation, call the GetIndexJobStatus operation.
- This interface is not idempotent.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| sfm:SubmitIndexJob | create | *All Resources * |
| none |
Request syntax
POST /{WorkspaceId}/index/submit_index_job HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | The ID of the workspace to which the knowledge base belongs. To view the workspace ID, you can click the Workspace Details icon in the upper-left corner on the homepage of the console. | ws_3Nt27MYcoK191ISp |
| IndexId | string | Yes | The primary key ID of the knowledge base, which is the | 79c0aly8zw |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": "InvalidParameter",
"Data": {
"Id": "eFDr2fGRzP9gdDZWAdo3YQ==",
"IndexId": "khdyak1uuj"
},
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "Success",
"Success": "True"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | RagIndex.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. | This request uses the same client token as the previous but different request. Do not reuse client tokens with different requests unless the request is the same. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|