Consulta da lista de clusters

Função

Essa API é usada para consultar e exibir a lista de clusters.

Depuração

Você pode depurar essa API no Explorador de API.

URI

• Formato URI

  GET /v1.0/{project_id}/clusters

• Descrição do parâmetro

  Tabela 1 Parâmetros URI

  Parâmetro	Obrigatório	Tipo	Descrição
  project_id	Sim	String	Project ID. Para obter detalhes sobre como obter o ID, consulte Obtenção de um ID do projeto.

Solicitação

Exemplo de solicitação

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters

Resposta

• Exemplo de resposta

  {
          "clusters": [
          {
          "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
          "name": "dws-1",
          "status": "AVAILABLE",
          "version": "1.2.0",
          "updated": "2016-02-10T14:28:14Z",
          "created": "2016-02-10T14:26:14Z", 
          "port": 8000,
          "endpoints": [{
                  "connect_info": "dws-1.ap-southeast-1.myhuaweicloud.com",
                  "jdbc_url": "jdbc:postgresql://dws-1.ap-southeast-1.myhuaweicloud.com/<YOUR_DATABASE_name>"
              }] , 
           "nodes" : [ {
             "id" : "acaf62a4-41b3-4106-bf6b-2f669d88291e",
             "status" : "200"
                }, {
             "id" : "d32de51e-4fcd-4e5a-a9dc-bb903abb494b",
             "status" : "200"
                }, {
              "id" : "d71a4a25-c9bc-4ffd-9f4a-e422aef327f9",
             "status" : "200"
              } ],
          "tags":[ {            
                    "key": "key1",              
                    "value": "value1"           
                   }, 
                  { 
                  "key": "key2",              
                  "value": "value2"            
                  }], 
          "user_name": "dbadmin",
          "number_of_node": 3,
          "recent_event": 6,
          "availability_zone": "ap-southeast-1",
          "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada", 
          "node_type":   "dws.d1.xlarge.ultrahigh",
          "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
          "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
          "public_ip": {
              "public_bind_type": "auto_assign",
              "eip_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
           },
         "public_endpoints": [{
                  "public_connect_info": "dws-1.ap-southeast-1.myhuaweicloud.com",
                  "jdbc_url": "jdbc:postgresql://dws-1.ap-southeast-1.myhuaweicloud.com/<YOUR_DATABASE_name>"
              }],
          "action_progress": {"SNAPSHOTTING": "20%"},
          "sub_status": "READONLY",
          "task_status": "SNAPSHOTTING",
          "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b"
          }],
         "count":"2"
  }

• Descrição do parâmetro

  Tabela 2 Descrição do parâmetro de resultados

  Parâmetro	Tipo	Descrição
  clusters	Array of ClusterInfo objects	Lista de objetos de cluster
  count	Integer	Número total de objetos de cluster

  Tabela 3 ClusterInfo

  Parâmetro	Tipo	Descrição
  id	String	ID do cluster
  name	String	Nome do cluster
  status	String	Status do cluster. O valor pode ser um dos seguintes: CREATING AVAILABLE UNAVAILABLE CREATION FAILED FROZEN
  version	String	Versão do data warehouse
  updated	String	Hora da última modificação de um cluster. Formato: ISO8601:YYYY-MM-DDThh:mm:ssZ
  created	String	Tempo de criação do cluster. Formato: ISO8601:YYYY-MM-DDThh:mm:ssZ
  port	Integer	Porta de serviço de um cluster. O valor varia de 8000 a 30000. O valor padrão é 8000.
  endpoints	Array of Endpoints objects	Informações de conexão de rede privada sobre o cluster.
  nodes	Array of Nodes objects	Instância do cluster
  tags	Array of Tags object	Tags em um cluster
  user_name	String	Nome de usuário do administrador
  number_of_node	Integer	Número de nós de cluster. Para um cluster, o valor varia de 3 a 256. Para um data warehouse híbrido (autônomo), o valor é 1.
  recent_event	Integer	Número de eventos
  availability_zone	String	AZ
  enterprise_project_id	String	ID do projeto empresarial. O valor 0 indica a ID do projeto corporativo padrão.
  node_type	String	Tipo de nó
  vpc_id	String	ID de VPC
  subnet_id	String	ID da sub-rede
  public_ip	PublicIp object	Endereço IP público. Se o parâmetro não for especificado, a conexão pública não será usada por padrão.
  public_endpoints	Array of PublicEndpoints objects	Informações de conexão de rede pública sobre o cluster. Se o parâmetro não for especificado, as informações de conexão de rede pública não serão usadas por padrão.
  action_progress	Map<String,String>	Informações da tarefa, consistindo em uma chave e um valor. A chave indica uma tarefa em andamento e o valor indica o andamento da tarefa em andamento. Os valores de chave válidos incluem: GROWING RESTORING SNAPSHOTTING REPAIRING CREATING O valor indica o andamento da tarefa. O seguinte é um exemplo: "action_progress": {"SNAPSHOTTING":"16%"}
  sub_status	String	Sub-status de clusters no estado AVAILABLE. O valor pode ser um dos seguintes: NORMAL READONLY REDISTRIBUTING REDISTRIBUTION-FAILURE UNBALANCED UNBALANCED | READONLY DEGRADED DEGRADED | READONLY DEGRADED | UNBALANCED UNBALANCED | REDISTRIBUTING UNBALANCED | REDISTRIBUTION-FAILURE READONLY | REDISTRIBUTION-FAILURE UNBALANCED | READONLY | REDISTRIBUTION-FAILURE DEGRADED | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | READONLY | REDISTRIBUTION-FAILURE DEGRADED | UNBALANCED | READONLY
  task_status	String	Tarefa de gerenciamento de cluster. O valor pode ser um dos seguintes: UNFREEZING FREEZING RESTORING SNAPSHOTTING GROWING REBOOTING SETTING_CONFIGURATION CONFIGURING_EXT_DATASOURCE DELETING_EXT_DATASOURCE REBOOT_FAILURE RESIZE_FAILURE
  security_group_id	String	ID do grupo de segurança
  failed_reasons	FailedReason object	Causa da falha. Se o parâmetro for deixado vazio, o cluster está no estado normal.

  Tabela 4 Endpoints

  Parâmetro	Obrigatório	Tipo	Descrição
  connect_info	Sim	String	Informações de conexão de rede privada
  jdbc_url	Sim	String	URL JDBC na rede privada. O seguinte é o formato padrão: jdbc:postgresql://< connect_info>/<YOUR_DATABASE_name>

  Tabela 5 Nós

  Parâmetro	Tipo	Descrição
  id	String	ID da instância do cluster
  status	String	Status da instância de cluster

  Tabela 6 Tags

  Parâmetro	Tipo	Descrição
  value	String	Valor. Um valor pode conter no máximo 43 caracteres Unicode, que podem ser nulos. O primeiro e o último caracter não podem ser espaços. Apenas letras, números, hifens (-) e sublinhados (_) são permitidos. Não pode conter os seguintes caracteres: =*<>\,|/
  key	String	Chave. Uma chave pode conter no máximo 36 caracteres Unicode, que não podem ser nulos. O primeiro e o último caracter não podem ser espaços. Apenas letras, números, hifens (-) e sublinhados (_) são permitidos. Pode conter apenas letras, dígitos, hífens (-) e sublinhados (_).

  Tabela 7 PublicIp

  Parâmetro	Obrigatório	Tipo	Descrição
  public_bind_type	Sim	String	Tipo de vinculação de um EIP. O valor pode ser um dos seguintes: auto_assign not_use bind_existing
  eip_id	Não	String	ID do EIP

  Tabela 8 PublicEndpoints

  Parâmetro	Tipo	Descrição
  public_connect_info	String	Informações de conexão de rede pública
  jdbc_url	String	URL JDBC da rede pública

  Tabela 9 FailedReason

  Parâmetro	Tipo	Descrição
  error_code	String	Código de erro
  error_msg	String	Mensagem de erro

Valor retornado

• Normal

  200

• Exceção

  Tabela 10 Valores retornados

  Valor retornado	Descrição
  400 Bad Request	Erro na solicitação.
  401 Unauthorized	Autenticação falhou.
  403 Forbidden	Sem permissão de operação.
  404 Not Found	Nenhum recurso encontrado.
  500 Internal Server Error	Erro de serviço interno.
  503 Service Unavailable	Serviço não está disponível.