GetIndexJobStatus

​

Operation description

• Resource Access Management (RAM) users must first obtain API permissions for Alibaba Cloud Model Studio (AliyunBailianDataFullAccess or AliyunBailianDataReadOnlyAccess, both of which include the sfm:GetIndexJobStatus permission), and join a workspace before invoking this operation. Alibaba Cloud accounts can invoke this operation directly without authorization. Use the latest Alibaba Cloud Model Studio SDK to invoke this operation.
• You must have a knowledge base job that is in progress. You can create a knowledge base creation task by invoking the SubmitIndexJob operation, or create a knowledge base document append task by invoking the SubmitIndexAddDocumentsJob operation. Obtain the corresponding JobId.
• Invoke this operation at intervals of 5 seconds or more.
• This operation supports idempotence.

​

Try it now

​

RAM authorization

• Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
• API: The API that you can call to perform the action.
• Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
• Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
  • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
  • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
• Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
• Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

​

Request syntax

GET /{WorkspaceId}/index/job/status HTTP/1.1

​

Path Parameters

​

Request parameters

​

Response elements

​

Examples

{
  "Code": "Index.Forbidden",
  "Data": {
    "Documents": [
      {
        "Code": "Index.Document.ChunkError",
        "DocId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
        "DocName": "XXX产品介绍",
        "Message": "document parse error",
        "Status": "RUNNING",
        "GmtModified": 0
      }
    ],
    "JobId": "66122af12a4e45ddae6bd6c84555xxxx",
    "Status": "PENDING"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

​

Error codes

​

Release notes