すべてのプロダクト
Search

このプロダクト

    :GetIndexJobStatus

    ドキュメントセンター

    :GetIndexJobStatus

    最終更新日:Aug 13, 2025

    ナレッジベースを作成するジョブ、またはナレッジベースにドキュメントを追加するジョブの、指定されたジョブのステータスを取得します。

    操作説明

    • この操作を呼び出すには、RAM ユーザーは Alibaba Cloud Model Studio の API 権限を持ち、ワークスペースに参加している必要があります。AliyunBailianDataFullAccess 権限または AliyunBailianDataReadOnlyAccess 権限のいずれかを RAM ユーザーに付与する必要があります。どちらの権限にも sfm:GetIndexJobStatus 権限が含まれています。Alibaba Cloud アカウントは、承認なしでこの操作を直接呼び出すことができます。この操作を呼び出すには、Alibaba Cloud Model Studio ソフトウェア開発キット（SDK）の最新バージョンを使用してください。

    • 処理中のナレッジベースジョブと、それに対応する JobId が必要です。ナレッジベースを作成するには、[SubmitIndexJob] 操作を呼び出します。ナレッジベースにドキュメントを追加するには、[SubmitIndexAddDocumentsJob] 操作を呼び出します。

    • この操作の呼び出し間隔は、5 秒以上あけてください。

    • この操作はべき等です。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sfm:GetIndexJobStatus

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    リクエストパラメーター

    パラメーター

    タイプ

    必須 / 任意

    説明

    例
    WorkspaceId

    string

    必須

    ワークスペース ID。管理するナレッジベースがこのワークスペースにあることを確認してください。詳細については、「ワークスペースを使用する」をご参照ください。

    llm-3z7uw7fwz0vexxxx
    JobId

    string

    必須

    ナレッジベースジョブの ID。[SubmitIndexJob] 操作または [SubmitIndexAddDocumentsJob] 操作によって返される Data.Id の値です。

    20230718xxxx-146c93bf
    IndexId

    string

    必須

    ナレッジベースの ID。[CreateIndex] 操作によって返される Data.Id の値です。

    79c0alxxxx
    PageNumber

    integer

    任意

    [SubmitIndexJob] 操作と [SubmitIndexAddDocumentsJob] 操作では、ドキュメントのバッチインポートがサポートされています。この操作は、ジョブ全体のステータスを Status フィールドに返し、各ドキュメントのインポートステータスを Document.Status フィールドに返します。インポートするドキュメントが多い場合は、PageNumber パラメーターを使用してページングクエリを実行します。値は 1 以上である必要があります。デフォルト値は 1 です。

    1
    pageSize

    integer

    任意

    各ページで返すドキュメントインポートタスクの数。デフォルト値は 10 です。最大値に制限はありません。

    10

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    object

    レスポンススキーマ

    Code

    string

    エラーコード。

    Index.Forbidden
    Data

    object

    返されたデータ。

    Documents

    array<object>

    インポートされたドキュメントのリスト。

    object

    ドキュメントオブジェクト。

    Code

    string

    エラーコード。

    Index.Document.ChunkError
    DocId

    string

    ドキュメント ID。

    file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
    DocName

    string

    ドキュメント名。

    XXX产品介绍
    Message

    string

    エラーメッセージ。

    document parse error
    Status

    string

    ドキュメントのインポートステータス。有効な値：

    • INSERT_ERROR：ドキュメントのインポートに失敗しました。

    • RUNNING：ドキュメントをインポート中です。

    • DELETED：ドキュメントは削除されました。

    • FINISH：ドキュメントは正常にインポートされました。

    RUNNING
    GmtModified

    integer

    JobId

    string

    ジョブ ID。

    66122af12a4e45ddae6bd6c84555xxxx
    Status

    string

    ナレッジベースジョブのステータス。有効な値：

    • COMPLETED：ジョブは成功です。

    • FAILED：ジョブは失敗しました。

    • RUNNING：ジョブは進行中です。

    • PENDING：ジョブは保留中です。

    PENDING
    Message

    string

    エラーメッセージ。

    User not authorized to operate on the specified resource.
    RequestId

    string

    リクエスト ID。

    17204B98-xxxx-4F9A-8464-2446A84821CA
    Status

    string

    リクエストに対して返された状態コード。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "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
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。