すべてのプロダクト
Search

このプロダクト

    Alibaba Cloud Model Studio:GetIndexJobStatus

    ドキュメントセンター

    Alibaba Cloud Model Studio:GetIndexJobStatus

    最終更新日:Jun 13, 2026

    指定されたナレッジベース作成ジョブまたはナレッジベースドキュメント追加ジョブの現在のステータスを照会します。

    操作説明

    • Resource Access Management（RAM）ユーザーは、このオペレーションを呼び出す前に、Alibaba Cloud Model Studioの API 権限（AliyunBailianDataFullAccessまたはAliyunBailianDataReadOnlyAccess。いずれもsfm:GetIndexJobStatus 権限を含む）を取得し、ワークスペースに参加する必要があります。Alibaba Cloudアカウントは認可なしで直接このオペレーションを呼び出すことができます。このオペレーションを呼び出すには、最新のAlibaba Cloud Model Studio SDKを使用してください。

    • 進行中のナレッジベースジョブタスクが必要です。ナレッジベース作成タスクを作成するには、SubmitIndexJobオペレーションを呼び出してください。ナレッジベースドキュメント追加タスクを作成するには、SubmitIndexAddDocumentsJobオペレーションを呼び出してください。レスポンスから対応するJobIdを取得してください。

    • このオペレーションは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。操作するナレッジベースがこのワークスペース内にあることを確認してください。ワークスペース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

    任意

    ページングクエリで1ページあたりに表示するファイルインポートタスクの数。最大値の制限はありません。デフォルト値：10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    Code

    string

    エラーコード。

    Index.Forbidden
    Data

    object

    オペレーションによって返されるデータフィールド。

    Documents

    array<object>

    このジョブでインポートされたファイルのリスト。

    object

    ファイルオブジェクト。

    Code

    string

    HTTP ステータスコード

    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：ジョブは実行待ちです。

    列挙値:

    • 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

    オペレーションによって返されるHTTPステータスコード。

    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
}

    エラーコード

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

    変更履歴

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