すべてのプロダクト
Search

このプロダクト

    :GetClusterRunTimeInfo

    ドキュメントセンター

    :GetClusterRunTimeInfo

    最終更新日:Dec 24, 2025

    指定されたクラスターのランタイム情報を照会します。

    操作説明

    メソッド

    GET

    URI

    /openapi/ha3/instances/{instanceId}/cluster-run-time-info

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    searchengine:GetClusterRunTimeInfo

    get

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエスト構文

    GET /openapi/ha3/instances/{instanceId}/cluster-run-time-info HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-pl32rf0****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    リクエストの例

    GET /openapi/ha3/instances/ose-test1/cluster-run-time-info

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返される結果。

    requestId

    string

    リクエスト ID。

    E45380E8-994A-5402-9806-F114B3295FCF
    result

    array<object>

    結果。

    array<object>

    クラスターのランタイム情報。

    clusterName

    string

    クラスター名。

    vpc_hz_domain_1
    queryNode

    object

    Query Result Searcher (QRS) ワーカーに関する情報。

    serviceStatus

    object

    QRS ワーカーのサービスステータス。

    name

    string

    クラスター名。

    vpc_hz_domain_1

    totalSize

    integer

    クラスター内の QRS ワーカーの総数。

    100
    doneSize

    integer

    クラスター内の処理済み QRS ワーカーの数。

    100
    donePercent

    integer

    クラスター内の QRS ワーカーの処理の進捗。単位：パーセント。

    100
    configStatusList

    array<object>

    設定ステータス。

    object

    configUpdateTime

    string

    設定が最後に更新された時刻。

    2024-05-21 16:05:26
    name

    string

    クラスター名。

    vpc_hz_domain_1

    totalSize

    integer

    クラスター内の QRS ワーカーの総数。

    6
    doneSize

    integer

    クラスター内の処理済み QRS ワーカーの数。

    100
    donePercent

    integer

    クラスター内の QRS ワーカーの処理の進捗。単位：パーセント。

    100
    dataNodes

    array<object>

    Searcher ワーカーに関する情報。

    array<object>

    クラスターノードに関する情報。

    dataStatusList

    array<object>

    Searcher ワーカーのデータ。

    array<object>

    docSize

    integer

    ストレージ容量。単位：GB。

    2
    fullVersion

    integer

    完全なインデックスバージョンが生成された時刻。

    1718846192
    incVersion

    integer

    増分インデックスバージョンが生成された時刻。

    1718846192
    incUpdateTime

    string

    インデックス内の増分データが最後に更新された時刻。

    2024-05-21 16:05:26
    fullUpdateTime

    string

    インデックス内の完全データが最後に更新された時刻。

    2024-05-21 16:05:26
    indexConfigInfo

    object

    インデックス設定に関する情報。

    configMetaName

    string

    インデックス設定の名前。

    index_meta_name
    version

    integer

    インデックステンプレートのバージョン。

    1.0.0
    advanceConfigInfo

    object

    詳細設定に関する情報。

    configMetaName

    string

    インデックス設定の名前。

    index_meta_name
    version

    integer

    バージョン番号。

    1.0
    lackMemWorker

    array

    メモリ不足が原因で失敗したワーカーの名前。

    string

    失敗したワーカーの名前。

    test-fail-worker

    deployFailedWorker

    array

    デプロイの失敗が原因で失敗したワーカーの名前。

    string

    失敗したワーカーの名前。

    test-fail-worker

    lackDiskWorker

    array

    ディスク不足が原因で失敗したワーカーの名前。

    string

    失敗したワーカーの名前。

    test-fail-worker
    errorMsg

    string

    エラーメッセージ。

    0A3B1C48006A6C0905F6375F4821EB50
    indexSize

    integer

    インデックスサイズ。

    100
    name

    string

    QRS ワーカーの名前。

    ha-cn-pl32rf0****_qrs
    totalSize

    integer

    クラスター内の QRS ワーカーの総数。

    1
    doneSize

    integer

    クラスター内の処理済み QRS ワーカーの数。

    100
    donePercent

    integer

    設定の進捗。単位：パーセント。

    100
    serviceStatus

    object

    QRS ワーカーのサービスステータス。

    name

    string

    QRS ワーカーの名前。

    ha-cn-pl32rf0****_qrs
    totalSize

    integer

    クラスター内の QRS ワーカーの総数。

    100
    doneSize

    integer

    クラスター内の処理済み QRS ワーカーの数。

    100
    donePercent

    integer

    クラスター内の QRS ワーカーの処理の進捗。単位：パーセント。

    100
    configStatusList

    array<object>

    設定ステータス。

    object

    レスポンスボディ。

    configUpdateTime

    string

    設定が最後に更新された時刻。

    2024-05-21 16:05:26
    name

    string

    クラスター名。

    test_0704
    totalSize

    integer

    クラスター内の Searcher ワーカーの総数。

    0
    doneSize

    integer

    クラスター内の処理済み Searcher ワーカーの数。

    1
    donePercent

    integer

    設定の進捗。単位：パーセント。

    100

    レスポンスの例

    成功レスポンス

    {
  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
  "result": [
    {
      "clusterName": "",
      "queryNode": {
        "serviceStatus": {
          "name": "service_name",
          "totalSize": 1,
          "doneSize": 1,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "name": "default",
            "totalSize": 1,
            "doneSize": 1,
            "donePercent": 100,
            "configUpdateTime": ""
          }
        ]
      },
      "dataNodes": [
        {
          "serviceStatus": {
            "name": "service_name",
            "totalSize": 1,
            "doneSize": 1,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "name": "default",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "configUpdateTime": ""
            }
          ],
          "dataStatusList": [
            {
              "name": "index1",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "docSize": 123423,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "",
              "fullUpdateTime": "",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 13241234
              },
              "advanceConfigInfo": {
                "configMetaName": "advance_meta_name",
                "version": 13241234
              },
              "lackMemWorker": [
                "worker1",
                "worker2"
              ],
              "deployFailedWorker": [
                "worker3",
                "worker4"
              ],
              "lackDiskWorker": [
                "worker5",
                "worker6"
              ],
              "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
            },
            {
              "name": "index1",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "docSize": 123423,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "",
              "fullUpdateTime": "",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 13241234
              },
              "advanceConfigInfo": {
                "configMetaName": "advance_meta_name",
                "version": 13241234
              },
              "lackMemWorker": [
                "worker1",
                "worker2"
              ],
              "deployFailedWorker": [
                "worker3",
                "worker4"
              ],
              "lackDiskWorker": [
                "worker5",
                "worker6"
              ],
              "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
            }
          ]
        }
      ]
    }
  ]
}

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": [
    {
      "clusterName": "vpc_hz_domain_1",
      "queryNode": {
        "serviceStatus": {
          "name": "vpc_hz_domain_1\n",
          "totalSize": 100,
          "doneSize": 100,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "configUpdateTime": "2024-05-21 16:05:26",
            "name": "vpc_hz_domain_1\n",
            "totalSize": 6,
            "doneSize": 100,
            "donePercent": 100
          }
        ]
      },
      "dataNodes": [
        {
          "dataStatusList": [
            {
              "docSize": 2,
              "fullVersion": 1718846192,
              "incVersion": 1718846192,
              "incUpdateTime": "2024-05-21 16:05:26",
              "fullUpdateTime": "2024-05-21 16:05:26",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 0
              },
              "advanceConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 1
              },
              "lackMemWorker": [
                "test-fail-worker\n"
              ],
              "deployFailedWorker": [
                "test-fail-worker\n"
              ],
              "lackDiskWorker": [
                "test-fail-worker"
              ],
              "errorMsg": "0A3B1C48006A6C0905F6375F4821EB50",
              "indexSize": 100,
              "name": "ha-cn-pl32rf0****_qrs",
              "totalSize": 1,
              "doneSize": 100,
              "donePercent": 100
            }
          ],
          "serviceStatus": {
            "name": "ha-cn-pl32rf0****_qrs",
            "totalSize": 100,
            "doneSize": 100,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "configUpdateTime": "2024-05-21 16:05:26",
              "name": "test_0704",
              "totalSize": 0,
              "doneSize": 1,
              "donePercent": 100
            }
          ]
        }
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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