調(diào)用GetClusterDataInformation，獲取集群的數(shù)據(jù)信息。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數(shù)文檔。

請求語法

POST /openapi/cluster/data-information HTTP/1.1

請求參數(shù)

請求參數(shù)為空，但需填寫RequestBody。

RequestBody中需要填入以下參數(shù)，用來指定集群信息。

名稱

類型

是否必選

示例值

描述

dataSourceType

String

是

elasticsearch

集群類型，默認(rèn)為elasticsearch。

endpoint

String

否

http://10.01.xx.xx

集群公網(wǎng)域名。源集群的網(wǎng)絡(luò)環(huán)境為公網(wǎng)時必填。

instanceId

String

否

es-cn-09k1rnu3g0002****

Elasticsearch實例ID。源集群的網(wǎng)絡(luò)環(huán)境為阿里云Elasticsearch集群時必填。

vpcInstancePort

Integer

否

9200

集群的訪問端口號。源集群的網(wǎng)絡(luò)環(huán)境為阿里云Elasticsearch集群、阿里云ECS服務(wù)自建集群時必填。

vpcId

String

否

vpc-2ze59tt67m3nzkko9****

集群所在的專有網(wǎng)絡(luò)ID。源集群的網(wǎng)絡(luò)環(huán)境為阿里云Elasticsearch集群、阿里云ECS服務(wù)自建集群時必填。

vpcInstanceId

String

否

es-09k1rnu3g0002****-worker

當(dāng)前集群的實例ID或負(fù)載均衡SLB（Server Load Balancer）實例ID。源集群的網(wǎng)絡(luò)環(huán)境為阿里云Elasticsearch集群時必填。

username

String

否

elastic

集群的訪問用戶名。

password

String

否

xxxxxx

集群的訪問密碼。

index

String

否

product

索引名稱。

type

String

否

default

索引類型。
說明
  • index為空，可校驗Elasticsearch集群是否可連通。如果可連通，返回結(jié)果中indices不為空。
  • index不為空，可獲取當(dāng)前index下，settings和mapping的信息。
  • type不為空，可獲取當(dāng)前type對應(yīng)的routing字段信息。

源集群的網(wǎng)絡(luò)環(huán)境不同，需要填寫的參數(shù)不同：

  • 公網(wǎng)集群：需要填寫的參數(shù)包括endpoint，示例如下。
    
        {
         "dataSourceType": "elasticsearch",
         "endpoint": "http://es-cn-npk1shyiq000d****.public.elasticsearch.aliyuncs.com:9200",
         "username": "elastic",
         "password": "xxxxxx",
         "index": "default",
         "type": "default"
         }
  • 阿里云ECS服務(wù)自建集群：需要填寫的參數(shù)包括vpcInstancePort、vpcId和vpcIp，示例如下。
    
       {
            "dataSourceType": "elasticsearch",
            "vpcId":"vpc-2ze55voww95g82gak****",
            "vpcInstancePort": "9200",
            "vpcIp": "10.12.xx.xx",
            "username" : "elastic",
            "password" : "xxxxxx",
            "index":  "product",
            "type" : "default"
       }
  • 阿里云Elasticsearch集群：需要填寫的參數(shù)包括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"
     }

返回數(shù)據(jù)

名稱 類型 示例值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

請求ID。
Result Struct

返回結(jié)果。
connectable Boolean true

是否可連通。
metaInfo Struct

集群的元數(shù)據(jù)信息。
fields List ["id","name"]

索引Mapping對應(yīng)的字段。
indices List ["index1","index2","index3"]

集群的索引列表。
mapping String {\"_doc\":{\"properties\":{\"user\":{\"properties\":{\"last\":{\"type\":\"text\",...}}}}}}

集群的Mapping配置。
settings String {\n \"index\": {\n \"replication\": {\n}.....}}

集群的Settings配置。
typeName List ["index1-type"]

指定索引的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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。