Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ GaussDB(DWS)/ Referencia de la API/ Descripción de la API/ API de administración de clústeres/ Consulta de los detalles del clúster

Actualización más reciente 2022-11-07 GMT+08:00

Consulta de los detalles del clúster

Función

Esta API se utiliza para consultar los detalles del clúster.

URI

Formato URI

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

Descripción del parámetro

**Tabla 1** Parámetros URI
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID de proyecto. Para obtener más información sobre cómo obtener el ID, consulte Obtención de un ID de proyecto.
cluster_id	Sí	String	ID de clúster. Para obtener más información sobre cómo obtener el ID, consulte Obtención del ID de clúster.

Mensaje de solicitud

Ejemplo de solicitud

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/b5c45780-1006-49e3-b2d5-b3229975bbc7

Mensaje de la respuesta

Ejemplo de respuesta

{
    "cluster": {
        "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
        "status": "AVAILABLE",
        "name": "dws-1",
        "updated": "2018-02-10T14:28:14Z",
        "created": "2018-02-10T14:28:14Z",
        "user_name": "dbadmin",
        "sub_status": "READONLY",
        "task_status": "SNAPSHOTTING",
        "action_progress": {"SNAPSHOTTING": "20%"},
        "node_type":   "dws.m1.xlarge.ultrahigh",
        "subnet_id": "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
        "security_group_id": "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
        "number_of_node": 3,
        "availability_zone": "ap-southeast-1",
        "port": 8000,
        "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
        "public_ip": {
            "public_bind_type": "auto_assign",
            "eip_id": "85b20d7e-9etypeb2a-98f3-3c8843ea3574"
        },        
        "private_ip":["192.168.0.12","192.168.0.66"],        
        "public_endpoints": [
            {
                "public_connect_info": "dws-1.cn-north-4.myhuaweicloud.com",
                "jdbc_url": "jdbc:postgresql://dws-1.cn-north-4.myhuaweicloud.com/<YOUR_DATABASE_name>"
            }
         ],
        "endpoints": [
            {
                "connect_info": "dws-1.cn-north-4.myhuaweicloud.com",
                "jdbc_url": "jdbc:postgresql://dws-1.cn-north-4.myhuaweicloud.com/<YOUR_DATABASE_name>"
            }
         ],
        "version": "1.2.0",
        "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"
        }, 
        "enterprise_project_id": "6a6a18fe-417a-4188-9214-75fd08c22065",       
        "recent_event": 6, 
        "tags":[           
            { 
                "key": "key1",              
                "value": "value1"           
             }, 
            { 
                "key": "key2",              
                "value": "value2"            
             } 
          ], 

         "parameter_group": {               "id": "157e9cc4-64a8-11e8-adc0-fa7ae01bbebc",
              "name": "Default-Parameter-Group-dws ",               "status": "In-Sync"
         } 
    }
}

Descripción del parámetro

**Tabla 2** Descripción del parámetro de respuesta
Parámetro	Tipo	Descripción
cluster	ClusterDetail object	Objeto de clúster

**Tabla 3** ClusterDetail
Parámetro	Tipo	Descripción
id	String	ID de clúster
status	String	Estado del clúster. El valor puede ser uno de los siguientes: CREATING AVAILABLE UNAVAILABLE CREATION FAILED FROZEN
name	String	Nombre del clúster
updated	String	Hora de la última modificación de un clúster. Formato: ISO8601: YYYY-MM-DDThh:mm:ssZ
created	String	Tiempo de creación del clúster. Formato: ISO8601: YYYY-MM-DDThh:mm:ssZ
user_name	String	Nombre de usuario del administrador
sub_status	String	Subestado de clústeres en el estado AVAILABLE. El valor puede ser uno de los siguientes: 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	Tarea de gestión de clústeres. El valor puede ser uno de los siguientes: UNFREEZING FREEZING RESTORING SNAPSHOTTING GROWING REBOOTING SETTING_CONFIGURATION CONFIGURING_EXT_DATASOURCE DELETING_EXT_DATASOURCE REBOOT_FAILURE RESIZE_FAILURE
action_progress	Map<String,String>	La clave indica una tarea en curso. El valor puede ser uno de los siguientes: GROWING RESTORING SNAPSHOTTING REPAIRING CREATING: La tarea se está creando. Su valor es el progreso de la tarea de creación. El valor indica el progreso de la tarea.
node_type	String	Tipo de nodo
subnet_id	String	ID de subred
security_group_id	String	ID de grupo de seguridad
number_of_node	Integer	Número de nodos en un clúster. El valor varía de 2 a 256.
availability_zone	String	AZ
port	Integer	Puerto de servicio de un clúster. El valor varía de 8000 a 30000. El valor predeterminado es 8000.
vpc_id	String	ID de la VPC
public_ip	PublicIp object	Dirección IP pública. Si no se especifica el parámetro, la conexión pública no se utiliza de forma predeterminada.
private_ip	Array of strings	Lista de direcciones IP de red privada
public_endpoints	Array of PublicEndpoints objects	Información de conexión de red pública sobre el clúster. Si no se especifica el parámetro, la información de conexión de red pública no se utiliza de forma predeterminada.
endpoints	Array of Endpoints objects	Información de conexión de red privada sobre el clúster.
version	String	Versión de almacén de datos
maintain_window	MaintainWindow object	Ventana de mantenimiento del clúster
resize_info	ResizeInfo object	Detalles de escalamiento horizontal de clústeres
enterprise_project_id	String	ID del proyecto de empresa. El valor 0 indica el ID del proyecto de empresa predeterminado.
recent_event	Integer	Cantidad de eventos
tags	Array of Tags objects	Etiquetas en un clúster
parameter_group	ParameterGroup object	Detalles del grupo de parámetros
node_type_id	String	ID de tipo de nodo
failed_reasons	FailedReason object	Causa del fracaso. Si el parámetro se deja vacío, el clúster se encuentra en el estado normal.

**Tabla 4** FailedReason
Parámetro	Tipo	Descripción
error_code	String	Código de error
error_msg	String	Mensaje de error

**Tabla 5** PublicIp
Parámetro	Obligatorio	Tipo	Descripción
public_bind_type	Sí	String	Tipo de vinculación de un EIP. El valor puede ser uno de los siguientes: auto_assign not_use bind_existing
eip_id	No	String	ID de la EIP

**Tabla 6** PublicEndpoints
Parámetro	Obligatorio	Tipo	Descripción
public_connect_info	No	String	Información de conexión de red pública
jdbc_url	No	String	JDBC URL de la red pública. El siguiente es el formato predeterminado: jdbc:postgresql://< public_connect_info>/<YOUR_DATABASE_name>

**Tabla 7** Puntos de conexión
Parámetro	Obligatorio	Tipo	Descripción
connect_info	Sí	String	Información de conexión de red privada
jdbc_url	Sí	String	URL JDBC en la red privada. El siguiente es el formato predeterminado: jdbc:postgresql://< connect_info>/<YOUR_DATABASE_name>

**Tabla 8** MaintainWindow
Parámetro	Obligatorio	Tipo	Descripción
day	No	String	Tiempo de mantenimiento en cada semana en la unidad de día. El valor puede ser uno de los siguientes: Mon Tue Wed Thu Fri Sat Sun
start_time	No	String	Hora de inicio del mantenimiento en formato HH:mm. La zona horaria es GMT+0.
end_time	No	String	Tiempo de finalización del mantenimiento en formato HH:mm. La zona horaria es GMT+0.

**Tabla 9** ResizeInfo
Parámetro	Tipo	Descripción
target_node_num	Integer	Número de nodos después del escalamiento horizontal
origin_node_num	Integer	Número de nodos antes del escalamiento horizontal
resize_status	String	Estado de escalamiento horizontal. El valor puede ser uno de los siguientes: GROWING RESIZE_FAILURE
start_time	String	Hora de inicio escalable. Formato: ISO8601: YYYY-MM-DDThh: mm: ss

**Tabla 10** Etiquetas
Parámetro	Tipo	Descripción
key	String	Clave. Una clave puede contener un máximo de 36 caracteres Unicode, que no pueden ser nulos. Los caracteres primero y último no pueden ser espacios. Solo se permiten letras, dígitos, guiones (-) y guiones bajos (_). No puede contener los siguientes caracteres: =*<>\,\|/
value	String	Valor. Un valor puede contener un máximo de 43 caracteres Unicode, que pueden ser nulos. Los caracteres primero y último no pueden ser espacios. Solo se permiten letras, dígitos, guiones (-) y guiones bajos (_). No puede contener los siguientes caracteres: =*<>\,\|/

**Tabla 11** ParameterGroup
Parámetro	Obligatorio	Tipo	Descripción
id	Sí	String	ID de grupo de parámetros
name	Sí	String	Nombre del grupo de parámetros
status	Sí	String	Estado del parámetro de clúster. El valor puede ser uno de los siguientes: In-Sync: sincronizado Applying: en aplicación Pending-Reboot: reiniciar para que la modificación surta efecto Sync-Failure: error de la aplicación

Código de estado

Normal
200

Excepción

**Tabla 12** Valores devueltos
Valor devuelto	Descripción
400 Bad Request	Error de solicitud.
401 Unauthorized	Error en la autorización.
403 Forbidden	No hay permiso de operación.
404 Not Found	No se encontraron recursos.
500 Internal Server Error	Error interno del servicio.
503 Service Unavailable	El servicio no está disponible.