すべてのプロダクト
Search

このプロダクト

    :SubmitIndexJob

    ドキュメントセンター

    :SubmitIndexJob

    最終更新日:Aug 13, 2025

    指定された CreateIndex ジョブを送信して、ナレッジベースの作成を完了します。

    操作の説明

    1. この操作を呼び出す前に、 CreateIndex 操作を呼び出して、IndexId を取得する必要があります。
    2. この操作の呼び出し後、実行には一定の時間がかかります。リクエストが返される前に新しいリクエストを行わないでください。
    3. この操作を呼び出した後にジョブの実行ステータスを照会する場合は、 GetIndexJobStatus 操作を呼び出します。
    4. このインターフェイスは冪等ではありません。

    デバッグ

    このインターフェースは OpenAPI Explorer で直接実行できるため、署名の計算の手間が省けます。実行に成功すると、OpenAPI Explorer は SDK コードサンプルを自動的に生成できます。

    認証情報

    次の表に、API に対応する認証情報を示します。認証情報は、Action ポリシー要素で使用して、RAM ユーザーまたは RAM ロールにこの API 操作を呼び出す権限を付与できます。説明：

    • 操作：リソースに対する操作を指定するために Action 要素で使用できる値。
    • アクセスレベル：各操作のアクセスレベル。レベルは読み取り、書き込み、およびリストです。
    • リソースタイプ：RAM ユーザーまたは RAM ロールに操作の実行を承認できるリソースのタイプ。次の項目に注意してください。
      • 必須のリソースタイプの場合は、 * のプレフィックスで示します。
      • リソースレベルで権限を付与できない場合は、操作の「リソースタイプ」列に すべてのリソース が使用されます。
    • 条件キー：クラウドサービスによって定義される条件キー。
    • 関連操作：操作を完了するために RAM ユーザーまたは RAM ロールが実行する必要があるその他の操作。操作を完了するには、RAM ユーザーまたは RAM ロールに関連操作を実行する権限が必要です。
    操作アクセスレベルリソースタイプ条件キー関連操作
    sfm:SubmitIndexJob作成
    *すべてのリソース
    *
      なし
    		なし

    リクエスト構文

    リクエストパラメーター

    パラメータータイプ必須説明例
    WorkspaceIdstringはい

    ナレッジベースが属するワークスペースの ID。ワークスペース ID を表示するには、コンソールの ホームページ の左上隅にある [ワークスペースの詳細] アイコンをクリックします。

    		ws_3Nt27MYcoK191ISp
    IndexIdstringはい

    ナレッジベースのプライマリキー ID。これは、 CreateIndex 操作によって返される Data.Id パラメーターです。

    		79c0aly8zw

    レスポンスパラメーター

    パラメータータイプ説明例
    object

    レスポンスのスキーマ

    Codestring

    HTTP ステータスコード

    		InvalidParameter
    Dataobject

    返されるデータ。

    Idstring

    ジョブのプライマリキー ID。これは、 GetIndexJobStatus 操作の JobId パラメーターです。

    		eFDr2fGRzP9gdDZWAdo3YQ==
    IndexIdstring

    ナレッジベースのプライマリキー ID。

    		khdyak1uuj
    Messagestring

    エラーメッセージ。

    		必須パラメーター(%s) が見つからないか無効です。リクエストパラメーターを確認してください。
    RequestIdstring

    リクエスト ID。

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

    ステータスコード。

    		Success
    Successstring

    API 呼び出しが成功したかどうかを示します。有効な値：

    • true
    • false
    		True

    例

    成功レスポンスのサンプル

    JSON形式

    {
  "Code": "InvalidParameter",
  "Data": {
    "Id": "eFDr2fGRzP9gdDZWAdo3YQ==",
    "IndexId": "khdyak1uuj"
  },
  "Message": "必須パラメーター(%s) が見つからないか無効です。リクエストパラメーターを確認してください。",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "Success",
  "Success": "True"
}

    エラーコード

    HTTP ステータスコードエラーコードエラーメッセージ説明
    400RagIndex.IdempotentParameterMismatchリクエストは以前のリクエストと同じクライアントトークンを使用していますが、同一ではありません。リクエストが同一でない限り、異なるリクエストでクライアントトークンを再利用しないでください。このリクエストは、以前のリクエストと同じクライアントトークンを使用していますが、リクエストが異なります。リクエストが同じでない限り、異なるリクエストでクライアントトークンを再利用しないでください。

    エラーコードのリストについては、サービスエラーコード をご覧ください。

    変更履歴

    変更日時変更の概要操作
    変更履歴はありません