Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ GaussDB(DWS)/ Referência de API/ Descrição de API/ As API de gerenciamento de cluster/ Consulta de detalhes do cluster

Atualizado em 2022-11-08 GMT+08:00

Consulta de detalhes do cluster

Função

Essa API é usada para consultar detalhes do cluster.

Depuração

Você pode depurar essa API no Explorador de API.

URI

Formato URI

GET /v1.0/{project_id}/clusters/{cluster_id}

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 de como conseguir o ID de domínio, consulte Obtenção de um ID do projeto.
cluster_id	Sim	String	ID do cluster. Para obter detalhes de como conseguir o ID de domínio, consulte Obtenção de ID de cluster.

Mensagem de solicitação

Exemplo de solicitação

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7

Mensagem de resposta

Exemplo de resposta

{
    "cluster": {
        "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
        "name": "dws-1",
        "status": "AVAILABLE",
        "version": "1.2.0",
        "updated": "2018-02-10T14:28:14Z",
        "created": "2018-02-10T14:28: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": "6a6a18fe-417a-4188-9214-75fd08c22065", 
        "node_type":   "dws.m1.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-9etypeb2a-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",
        "parameter_group": {               
           "id": "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc",
           "name": "Default-Parameter-Group-dws ",               
           "status": "In-Sync"
         },
        "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
        "private_ip":["192.168.0.12","192.168.0.66"],   
        "maintain_window": {
            "day": "Wed",
            "start_time": "22:00",
            "end_time": "02:00"
        },
        "resize_info" : { 
            "target_node_num": "6",
            "origin_node_num": "3",
            "resize_status": "GROWING",
            "start_time": "2018-02-14T14:28:14Z"
           }
    }
}

Descrição do parâmetro

**Tabela 2** Descrição do parâmetro de resultados
Parâmetro	Tipo	Descrição
cluster	ClusterDetail object	Objeto de cluster

**Tabela 3** ClusterDetail
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 objects	Etiquetas 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ó . Para obter detalhes, consulte Especificações do Data Warehouse.
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>	A chave indica uma tarefa em andamento. O valor pode ser um dos seguintes: GROWING RESTORING SNAPSHOTTING REPAIRING CREATING O valor indica o andamento da tarefa.
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
parameter_group	ParameterGroup object	Detalhes do grupo de parâmetros
node_type_id	String	ID do tipo de nó
security_group_id	String	ID do grupo de segurança
private_ip	Array of strings	Lista de endereços IP de rede privada
maintain_window	MaintainWindow object	Janela de manutenção do cluster
resize_info	ResizeInfo object	Detalhes de escala do cluster
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** Nodes
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
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. Não pode conter os seguintes caracteres: =*<>\,\|/
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. 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	Obrigatório	Tipo	Descrição
public_connect_info	Não	String	Informações de conexão de rede pública
jdbc_url	Não	String	URL JDBC da rede pública. O seguinte é o formato padrão: jdbc:postgresql://< public_connect_info>/<YOUR_DATABASE_name>

**Tabela 9** ParameterGroup
Parâmetro	Obrigatório	Tipo	Descrição
id	Sim	String	ID do grupo de parâmetros
name	Sim	String	Nome do grupo de parâmetros
status	Sim	String	Status do parâmetro do cluster. O valor pode ser um dos seguintes: In-Sync: sincronizado Applying: na aplicação Pending-Reboot: reinicia para que a modificação tenha efeito Sync-Failure: falha da aplicação

**Tabela 10** MaintainWindow
Parâmetro	Obrigatório	Tipo	Descrição
day	Não	String	Tempo de manutenção em cada semana na unidade de dia. O valor pode ser um dos seguintes: Mon Ter Qua Qui Sex Sáb Dom
start_time	Não	String	Hora de início da manutenção no formato HH:mm. O fuso horário é GMT+0.
end_time	Não	String	Tempo de fim de manutenção no formato HH:mm. O fuso horário é GMT+0.

**Tabela 11** ResizeInfo
Parâmetro	Tipo	Descrição
target_node_num	Integer	Número de nós após a escala
origin_node_num	Integer	Número de nós antes de escala
resize_status	String	Status de escala. O valor pode ser um dos seguintes: GROWING RESIZE_FAILURE
start_time	String	Hora de início de escala. Formato: ISO8601:YYYY-MM-DDThh:mm:ss

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

Código de status

Normal
200

Exceção

**Tabela 13** 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.