GetClusterDataInformation - Elasticsearch: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Cabeçalho da requisição

Esta operação utiliza apenas parâmetros de requisição comuns. Para mais detalhes, consulte Parâmetros comuns.

Sintaxe da requisição

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

Parâmetros da requisição

Os parâmetros da requisição estão vazios, mas o parâmetro RequestBody é obrigatório.

Especifique as informações do cluster definindo os seguintes parâmetros no RequestBody:

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
dataSourceType	String	Sim	elasticsearch	Tipo do cluster. Valor padrão: elasticsearch.
endpoint	String	Não	http://10.01.xx.xx	Nome de domínio público do cluster. Especifique este parâmetro quando o ambiente de rede do cluster de source for uma rede pública.
instanceId	String	Não	es-cn-09k1rnu3g0002****	ID da instância Elasticsearch. Este parâmetro é necessário quando o ambiente de rede do cluster de source for um cluster Elasticsearch da Alibaba Cloud.
vpcInstancePort	Integer	Não	9200	Número da porta de acesso do cluster. O ambiente de rede do cluster de source é necessário ao utilizar um cluster Elasticsearch da Alibaba Cloud ou um cluster criado pelo usuário no Alibaba Cloud ECS Service.
vpcId	String	Não	vpc-2ze59tt67m3nzkko9****	ID da VPC à qual o cluster pertence. O ambiente de rede do cluster de source é necessário ao utilizar um cluster Elasticsearch da Alibaba Cloud ou um cluster criado pelo usuário no Alibaba Cloud ECS Service.
vpcInstanceId	String	Não	es-09k1rnu3g0002****-worker	ID da instância ou ID do Server Load Balancer (SLB) do cluster atual. Este parâmetro é necessário quando o ambiente de rede do cluster de source for um cluster Elasticsearch da Alibaba Cloud.
username	String	Não	elastic	Nome de usuário para conexão ao cluster.
password	String	Não	xxxxxx	Senha para conexão ao cluster.
index	String	Não	product	Nome do índice de destino.
type	String	Não	default	Tipo do índice de destino.

Nota

Se o índice estiver vazio, verifique se o cluster Elasticsearch está acessível. Caso a conectividade esteja disponível, o campo indices nos resultados retornados não será nulo.
Quando o índice não estiver vazio, obtenha as informações sobre configurações e mapeamentos do índice atual.
Caso o tipo não esteja vazio, recupere o campo de roteamento do tipo atual.

Os parâmetros variam conforme o ambiente de rede do cluster de source.

Cluster de rede pública: insira um ou mais parâmetros, incluindo endpoint. Exemplo:


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

Cluster autoconstruído no Alibaba Cloud ECS Service: insira os seguintes parâmetros: vpcInstancePort, vpcId e vpcIp. Exemplo:


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

Cluster Elasticsearch da Alibaba Cloud: especifique os parâmetros vpcInstancePort, vpcId, vpcInstanceId e instanceId. Exemplo:


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

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	ID da requisição.
Result	Struct		Resultados retornados.
connectable	Boolean	true	Indica se a conexão é possível.
metaInfo	Struct		Metadados do cluster.
fields	List	["id","name"]	Campos no Mapping do índice.
indices	List	["index1","index2","index3"]	Lista de índices do cluster.
mapping	String	{\"_doc\":{\"properties\":{\"user\":{\"properties\":{\"last\":{\"type\":\"text\",...}}}}}}	Configuração de Mapping do cluster.
settings	String	{\n \"index\": {\n \"replication\": {\n}.....}}	Settings do cluster.
typeName	List	["index1-type"]	Tipo do índice.

Exemplos

Exemplos de requisições

POST /openapi/cluster/data-information HTTP/1.1
Common request parameters
 {
     "dataSourceType": "elasticsearch",
     "endpoint": "http://es-cn-npk1shyiq000d****.public.elasticsearch.aliyuncs.com:9200",
     "username": "elastic",
     "password": "xxxxxx",
     "index": "default",
     "type": "default"
}

Exemplos de respostas de sucesso

Formato 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****"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.