すべてのプロダクト
Search

このプロダクト

    Intelligent Media Services:QuerySearchIndex

    ドキュメントセンター

    Intelligent Media Services:QuerySearchIndex

    最終更新日:Mar 21, 2026

    検索インデックスの詳細を照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ice:QuerySearchIndex

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SearchLibName

    string

    任意

    検索ライブラリの名前。

    • このパラメーターを空のままにした場合、検索インデックスは Intelligent Media Service (IMS) のデフォルト検索ライブラリに作成されます。デフォルト値: ims-default-search-lib。

    • 既存の検索ライブラリに関する情報を照会するには、「QuerySearchLib」API オペレーションを呼び出します。

    test1
    IndexType

    string

    必須

    インデックスのカテゴリ。有効な値:

    • mm: 大規模ビジュアルモデル。

    • face: 顔認識。

    • aiLabel: スマートタグ付け。

    列挙値:

    • mm :

      mm

    mm

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ

    RequestId

    string

    リクエストの ID。

    4E84BE44-58A7-****-****-FBEBEA16EF94
    Success

    string

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

    • true

    • false

    true
    Code

    string

    返された状態コード。

    200
    SearchLibName

    string

    検索ライブラリの名前。

    test1
    IndexType

    string

    インデックスのカテゴリ。有効な値:

    • mm: 大規模ビジュアルモデル。

    • face: 顔認識。

    • aiLabel: スマートタグ付け。

    列挙値:

    • mm :

      mm

    • face :

      face

    • aiLabel :

      aiLabel

    mm
    IndexStatus

    string

    インデックスの状態。有効な値:

    • active: インデックスは有効です。

    • Deactive: インデックスは無効です。

    列挙値:

    • Active :

      Active

    • Deactive :

      Deactive

    Active
    MediaTotal

    string

    メディアアセットの合計数。

    12

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "4E84BE44-58A7-****-****-FBEBEA16EF94",
  "Success": "true",
  "Code": "200",
  "SearchLibName": "test1",
  "IndexType": "mm",
  "IndexStatus": "Active",
  "MediaTotal": "12"
}

    エラーコード

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

    変更履歴

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