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 la lista de clústeres

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

Consulta de la lista de clústeres

Función

Esta API se utiliza para consultar y mostrar la lista de clústeres.

URI

Formato URI
```
GET /v1.0/{project_id}/clusters
```

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.

Solicitud

Ejemplo de solicitud

GET /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters

Respuesta

Ejemplo de respuesta

{
        "clusters": [
        {
        "id": "7d85f602-a948-4a30-afd4-e84f47471c15",
        "status": "AVAILABLE",
        "sub_status": "READONLY",
        "task_status": "SNAPSHOTTING",
        "action_progress": {"SNAPSHOTTING": "20%"},
        "node_type":   "dws.d1.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,
        "name": "dws-1",
        "version": "1.2.0",
        "vpc_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
        "user_name": "dbadmin",
        "public_ip": {
            "public_bind_type": "auto_assign",
            "eip_id": "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574"
         },
        "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>"
            }
         ] , 
        "updated": "2016-02-10T14:28:14Z",
        "created": "2016-02-10T14:26:14Z", 
        "enterprise_project_id":"aca4e50a-266f-4786-827c-f8d6cc3fbada",  
        "recent_event": 6
        "tags":[           
                 { 
                  "key": "key1",              
                  "value": "value1"           
                 }, 
                { 
                "key": "key2",              
                "value": "value2"            
                } 
              ], 
        }
    ]
}

Descripción del parámetro

**Tabla 2** Descripción del parámetro de respuesta
Parámetro	Tipo	Descripción
clusters	Array of ClusterInfo objects	Lista de objetos de clúster
count	Integer	Número total de objetos de clúster

**Tabla 3** ClusterInfo
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
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>	Información de la tarea, que consiste en una clave y un valor. La clave indica una tarea en curso y el valor indica el progreso de la tarea en curso. Los valores de clave válidos incluyen: GROWING RESTORING SNAPSHOTTING REPAIRING CREATING: La tarea se está creando. Su valor es el progreso de la tarea de creación. A continuación se presenta un ejemplo: "action_progress": {"SNAPSHOTTING":"16%"}
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 3 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.
name	String	Nombre del clúster
version	String	Versión de almacén de datos
vpc_id	String	ID de la VPC
user_name	String	Nombre de usuario del administrador
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.
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.
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
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
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** 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 5** Etiquetas
Parámetro	Tipo	Descripción
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: =*<>\,\|/
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: =*<>\,\|/

**Tabla 6** PublicEndpoints
Parámetro	Tipo	Descripción
public_connect_info	String	Información de conexión de red pública
jdbc_url	String	JDBC URL de la red pública

**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** FailedReason
Parámetro	Tipo	Descripción
error_code	String	Código de error
error_msg	String	Mensaje de error

Valor devuelto

Normal
200

Excepción

**Tabla 9** 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.