Queries the current status of a specified knowledge base creation or add document job.
Operation description
- A knowledge base job is running. You can call the SubmitIndexJob operation to create a creation job or the SubmitIndexAddDocumentsJob operation to create a add document job. Then, obtain the
JobIdreturned by the operations. - We recommend that you call this operation at intervals of more than 5 seconds.
- This interface is 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:GetIndexJobStatus | get | *All Resources * |
| none |
Request syntax
GET /{WorkspaceId}/index/job/status 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 |
| JobId | string | Yes | The knowledge base job ID, which is the | 20230718xxxx-146c93bf |
| IndexId | string | Yes | The primary key ID of the knowledge base, which is the | 79c0aly8zw |
| PageNumber | integer | No | Both the SubmitIndexJob and SubmitIndexAddDocumentsJob operations support batch import of documents. This operation returns both the overall | 1 |
| pageSize | integer | No | The number of document import jobs that are displayed on each page. No maximum value. Default value: 10. | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": "Index.Forbidden",
"Data": {
"Documents": [
{
"Code": "Index.Document.ChunkError",
"DocId": "file_9a65732555b54d5ea10796ca5742ba22_XXXXXXXX",
"DocName": "",
"Message": "document parse error",
"Status": "RUNNING"
}
],
"JobId": "66122af12a4e45ddae6bd6c845556647",
"Status": "PENDING"
},
"Message": "User not authorized to operate on the specified resource.",
"RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
"Status": "200",
"Success": true
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|