GetClusterDataInformation - Elasticsearch - Alibaba Cloud ドキュメントセンター

GetClusterDataInformation を呼び出して、クラスタに関するデータ情報を取得します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエストパラメータのみを使用します。詳細については、「共通パラメータ」をご参照ください。

リクエスト構文

POST /openapi/cluster/data-information HTTPS|HTTP

リクエストパラメータ

リクエストパラメータは空ですが、RequestBody パラメータは必須です。

RequestBody で以下のパラメータを設定して、クラスタ情報を指定する必要があります。

パラメータ	タイプ	必須	例	説明
dataSourceType	String	はい	elasticsearch	クラスタのタイプ。デフォルト値：elasticsearch。
endpoint	String	いいえ	http://10.01.xx.xx	クラスタのパブリックドメイン名。ソースクラスタのネットワーク環境がパブリックネットワークの場合は、このパラメータを指定する必要があります。
instanceId	String	いいえ	es-cn-09k1rnu3g0002****	Elasticsearch インスタンスの ID。ソースクラスタのネットワーク環境が Alibaba Cloud Elasticsearch クラスタの場合は、このパラメータが必要です。
vpcInstancePort	Integer	いいえ	9200	クラスタのアクセスポート番号。ソースクラスタネットワーク環境は、Alibaba Cloud Elasticsearch クラスタまたは Alibaba Cloud ECS サービスユーザー作成クラスタを使用する場合に必要です。
vpcId	String	いいえ	vpc-2ze59tt67m3nzkko9****	クラスタが属する VPC の ID。ソースクラスタネットワーク環境は、Alibaba Cloud Elasticsearch クラスタまたは Alibaba Cloud ECS サービスユーザー作成クラスタを使用する場合に必要です。
vpcInstanceId	String	いいえ	es-09k1rnu3g0002****-worker	現在のクラスタのインスタンス ID または Server Load Balancer (SLB) ID。ソースクラスタのネットワーク環境が Alibaba Cloud Elasticsearch クラスタの場合は、このパラメータが必要です。
username	String	いいえ	elastic	クラスタへの接続に使用するユーザー名。
password	String	いいえ	xxxxxx	クラスタへの接続に使用するパスワード。
index	String	いいえ	product	宛先インデックスの名前。
type	String	いいえ	default	宛先インデックスのタイプ。

説明

インデックスが空の場合、Elasticsearch クラスタに接続できるかどうかを確認できます。接続性が利用可能な場合、返された結果の indices フィールドは null ではありません。
インデックスが空でない場合、現在のインデックスの下にある設定とマッピングに関する情報を取得できます。
タイプが空でない場合、現在のタイプのルートフィールドを取得できます。

パラメータは、ソースクラスタのネットワーク環境によって異なります。

パブリックネットワーククラスタ：endpoint を含む 1 つ以上のパラメータを入力します。例：

        {
         "dataSourceType": "elasticsearch",
         "endpoint": "http://es-cn-npk1shyiq000d****.public.elasticsearch.aliyuncs.com:9200",
         "username": "elastic",
         "password": "xxxxxx",
         "index": "default",
         "type": "default"
         }

Alibaba Cloud ECS サービスセルフビルドクラスタ：次のパラメータを入力します。vpcInstancePort、vpcId、および vpcIp。例：

       {
            "dataSourceType": "elasticsearch",
            "vpcId":"vpc-2ze55voww95g82gak****",
            "vpcInstancePort": "9200",
            "vpcIp": "10.12.xx.xx",
            "username" : "elastic",
            "password" : "xxxxxx",
            "index":  "product",
            "type" : "default"
       }

Alibaba Cloud Elasticsearch クラスタ：パラメータを指定します。vpcInstancePort、vpcId、vpcInstanceId、および instanceId。サンプルコードは次のとおりです。

    {
        "dataSourceType" : "elasticsearch",
        "vpcId":"vpc-2ze55voww95g82gak****",
        "vpcInstancePort" : "9200",
        "vpcInstanceId" : "es-cn-09k1rnu3g0002****-worker",
        "instanceId" : "es-cn-oew1oxiro000f****",
        "username" : "elastic",
        "password" : "xxxxxx",
        "index":  "product",
        "type" : "default"
     }

レスポンスパラメータ

パラメータ	タイプ	例	説明
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	リクエストの ID。
Result	Struct		戻り結果。
connectable	Boolean	true	接続可能かどうか。
metaInfo	Struct		クラスタのメタデータ。
fields	List	["id","name"]	インデックスのマッピングのフィールド。
indices	List	["index1","index2","index3"]	クラスタのインデックスリスト。
mapping	String	{\"_doc\":{\"properties\":{\"user\":{\"properties\":{\"last\":{\"type\":\"text\",...}}}}}}	クラスタのマッピング構成。
settings	String	{\n \"index\": {\n \"replication\": {\n}.....}}	クラスタの設定。
typeName	List	["index1-type"]	インデックスのタイプを指定します。

例

サンプルリクエスト

POST /openapi/cluster/data-information HTTP/1.1
共通リクエストパラメータ
 {
     "dataSourceType": "elasticsearch",
     "endpoint": "http://es-cn-npk1shyiq000d****.public.elasticsearch.aliyuncs.com:9200",
     "username": "elastic",
     "password": "xxxxxx",
     "index": "default",
     "type": "default"
}

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

JSON 形式

{
  "Result": {
    "connectable": true,
    "metaInfo": {
      "indices":  ["index1","index2","index3"],
      "typeName": ["index1-type"], 
      "settings": "{\n  \"index\": {\n    \"replication\": {\n}.....}}",  
      "mapping": "{\"_doc\":{\"properties\":{\"user\":{\"properties\":{\"last\":{\"type\":\"text\",...}}}}}}", 
      "fields": ["id","name","_id"]
    }
  },
  "RequestId" : "29AEFBA7-DD86-4B05-87A2-43F22C85****"
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。