すべてのプロダクト
Search

このプロダクト

    :GetNodeConfig

    ドキュメントセンター

    :GetNodeConfig

    最終更新日:Jun 17, 2026

    ノードの構成情報を取得します。

    操作説明

    メソッド

    GET

    URI

    /openapi/ha3/instances/{instanceId}/node-config
```。

    今すぐお試しください

    この 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:GetNodeConfig

    get

    *Instance

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

    		 なし なし

    リクエスト構文

    GET /openapi/ha3/instances/{instanceId}/node-config HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-pl32rf0****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    type

    string

    任意

    ノードタイプ。有効な値:

    • qrs: クエリノード

    • search: データノード

    • index: インデックスノード

    • cluster: クラスター。

    index
    name

    string

    任意

    ノード名。

    ha-cn-30174dhoz53_qrs
    clusterName

    string

    任意

    クラスター名。

    vpc_sh_domain_2

    リクエスト例

    GET /openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test&
```。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    requestId

    string

    リクエスト ID。

    2AE63638-5420-56DC-BF59-37D8174039A0
    result

    object

    返された結果。

    dataFragmentNumber

    integer

    データシャードの数。

    1
    dataDuplicateNumber

    integer

    データレプリカの数。

    1
    minServicePercent

    integer

    最小サービスの割合。

    50
    published

    boolean

    クラスターがマウントされているかどうかを示します。

    true
    active

    boolean

    インデックスがオンラインでアクティブかどうかを示します。

    true
    flowRatio

    integer

    トラフィック比率。

    100

    レスポンス例

    成功レスポンス

    {

  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",

  "result": {

    "dataFragmentNumber":1,

    "dataDuplicateNumber":1,

    "minServicePercent":20,

    "published":true,

    "active": true  // インデックスがオンラインでアクティブかどうかを示します。

  }

}
```。

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "dataFragmentNumber": 1,
    "dataDuplicateNumber": 1,
    "minServicePercent": 50,
    "published": true,
    "active": true,
    "flowRatio": 100
  }
}

    エラーコード

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

    変更履歴

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