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.
Actualización más reciente 2023-12-14 GMT+08:00

Consulta de detalles de una instancia de base de datos

Función

Esta API se utiliza para consultar los detalles de una instancia de base de datos especificada. Antes de invocar a esta API:

Esta API no estará disponible el 31 de marzo de 2024. Se recomienda cambiar las cargas de trabajo a la nueva API (Consulta de detalles de una instancia de base de datos) antes de esa fecha.

URI

  • Formato de URI

    GET https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}

  • Ejemplo

    GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/436aaafb689c4250a9a5bb33cb271e8cin07

  • Descripción de parámetro
    Tabla 1 Descripción de parámetro

    Nombre

    Tipo

    Obligatorio

    Descripción

    project_id

    String

    ID de proyecto de un tenant en una región.

    Para obtener este valor, consulte Obtención de un ID de proyecto.

    instance_id

    String

    ID de instancia de base de datos.

Solicitud

Ninguna.

Respuesta

  • Respuesta normal
    Tabla 2 Descripción de parámetro

    Nombre

    Tipo

    Descripción

    instance

    Object

    Información de la instancia.

    Para obtener más información, consulte Tabla 3.

    Tabla 3 descripción de la estructura de datos de campo de instancia

    Nombre

    Tipo

    Descripción

    id

    String

    ID de instancia de base de datos.

    name

    String

    Nombre de instancia de base de datos.

    project_id

    String

    ID de proyecto de un tenant en una región.

    status

    String

    Estado de instancia de base de datos.

    Valores válidos:

    Si el valor es de BUILD, se está creando la instancia de base de datos.

    Si el valor es ACTIVE, la instancia de base de datos es normal.

    Si el valor es de FAILED, la instancia de base de datos es anormal.

    Si el valor es de FROZEN, la instancia de base de datos se congela.

    Si el valor es de MODIFYING, se está escalando la instancia de base de datos.

    Si el valor es de REBOOTING, se está reiniciando la instancia de base de datos.

    Si el valor es de RESTORING, se está restaurando la instancia de base de datos.

    Si el valor es de MODIFYING INSTANCE TYPE, la instancia de base de datos está cambiando de primaria a en espera.

    Si el valor es de SWITCHOVER, se está realizando la conmutación primaria/en espera.

    Si el valor es de MIGRATING, se está migrando la instancia de base de datos.

    Si el valor es de BACKING UP, se está realizando una copia de respaldo de la instancia de base de datos.

    Si el valor es de MODIFYING DATABASE PORT, se está cambiando el puerto de la base de datos.

    Si el valor es de STORAGE FULL, el espacio de almacenamiento de la instancia está lleno.

    enterprise_project_id

    String

    ID de proyecto de empresa.

    type

    String

    Tipo de instancia de base de datos. Actualmente, solo se admite el tipo de clúster.

    node_count

    Integer

    Número de nodos.

    datastore

    Object

    Información de la base de datos. Para obtener más información, consulte Tabla 4.

    backup_used_space

    Double

    Espacio de copia de respaldo usado en GB.

    created

    String

    Tiempo de creación en el formato "yyyy-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, en la zona horaria de Beijing, el desplazamiento de zona horaria se muestra como +0800. El valor está vacío a menos que se complete la creación de la instancia.

    updated

    String

    Hora de actualización. El formato es el mismo que el del campo created. El valor está vacío a menos que se complete la creación de la instancia.

    public_ips

    String

    Dirección IP pública de la instancia.

    private_write_ips

    Array of List

    Dirección IP privada para escribir.

    db_user_name

    String

    Nombre de usuario predeterminado.

    port

    String

    Puerto de base de datos.

    vpc_id

    String

    ID de VPC.

    subnet_id

    String

    ID de red de la subred.

    security_group_id

    String

    ID del grupo de seguridad.

    volume

    Object

    Información del disco. Para obtener más información, consulte Tabla 7.

    backup_strategy

    Object

    Política de copia de respaldo. Para obtener más información, consulte Tabla 5.

    nodes

    Arrays of object

    Información del nodo. Para obtener más información, consulte Tabla 6.

    time_zone

    String

    Zona horaria.

    az_mode

    String

    Tipo de zona de disponibilidad. Puede ser single o multi.

    master_az_code

    String

    Zona de disponibilidad primaria.

    maintenance_window

    String

    Ventana de mantenimiento en formato UTC.

    configuration_id

    String

    ID de la plantilla de parámetros utilizada para crear una instancia o ID de la última plantilla de parámetros que se aplica a una instancia.

    tags

    Arrays of object

    Etiquetas para gestionar instancias. Para obtener más información, consulte Tabla 8.

    Tabla 4 descripción de la estructura de datos del campo del almacén de datos

    Nombre

    Tipo

    Descripción

    type

    String

    Motor de base de datos.

    version

    String

    Versión de base de datos.

    Tabla 5 descripción de la estructura de datos del campo backup_strategy

    Nombre

    Tipo

    Descripción

    start_time

    String

    Ventana de tiempo de copia de respaldo. Las copias de respaldo automatizadas se activarán durante la ventana de tiempo de copia de respaldo.

    keep_days

    Integer

    Días de retención de copia de respaldo.

    Tabla 6 descripción de estructura de datos de campo de nodos

    Nombre

    Tipo

    Descripción

    id

    String

    ID del nodo.

    name

    Array of object

    Nombre del nodo.

    type

    String

    Tipo de nodo, que puede ser master o slave.

    status

    String

    Estado del nodo.

    port

    Integer

    Puerto de base de datos.

    private_read_ips

    Array of String

    Dirección IP privada para lectura.

    volume

    Object

    Información del disco.

    az_code

    String

    Zona de disponibilidad.

    region_code

    String

    Región donde se despliega la instancia de base de datos.

    created

    String

    Hora de creación de instancia de base de datos.

    updated

    String

    Hora de actualización.

    flavor_ref

    String

    Código de especificación.

    Para obtener más información, consulte Tabla 3.

    max_connections

    String

    Número máximo de conexiones.

    vcpus

    String

    Número de vCPUs.

    ram

    String

    Tamaño de la memoria en GB.

    need_restart

    Boolean

    Si se debe reiniciar la instancia de base de datos para que las modificaciones surtan efecto.

    priority

    String

    Prioridad de conmutación por error.

    Tabla 7 descripción de la estructura de datos de campo de volumen

    Nombre

    Tipo

    Descripción

    type

    String

    Tipo de almacenamiento. Actualmente, solo se admite POOL.

    used

    String

    Tamaño de almacenamiento usado en GB.

    Tabla 8 descripción de estructura de datos de campo de etiquetas

    Nombre

    Tipo

    Descripción

    type

    String

    Clave de etiqueta. El valor puede contener un máximo de 36 caracteres unicode. El valor no puede ser una cadena vacía, un espacio o dejarse en blanco. Solo se permiten mayúsculas/minúsculas, dígitos, guiones medios (-) y guiones bajos (_).

    used

    String

    Valor de etiqueta. El valor contiene un máximo de 43 caracteres Unicode y también puede ser una cadena vacía. Solo se permiten letras mayúsculas, minúsculas, dígitos, puntos (.), guiones (-) y guiones bajos (_).

    Los valores de region_code y az_code se usan como ejemplos.

  • Ejemplo de respuesta normal
    {
      "instance": {
        "id": "d2cda7b97a39488e8b30e3cea4066204in07",
        "name": "gauss-d616-lb07",
        "status": "FAILED",
        "project_id": "053f533ead80d5102f0cc012e8d468a4",
        "enterprise_project_id": "0",
        "type": "Cluster",
        "charge_info": {
          "charge_mode": "postPaid",
          "order_id": ""
        },
        "node_count": 2,
        "datastore": {
          "type": "GaussDB(for MySQL)",
          "version": "8.0"
        },
        "created": "2020-07-21T09:13:56+0800",
        "updated": "2020-07-21T09:27:54+0800",
        "public_ips": "",
        "private_write_ips": [
          "192.168.0.235"
        ],
        "db_user_name": "root",
        "port": "3306",
        "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
        "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
        "security_group_id": "c7f69884-fe2b-4630-8114-70a11499d902",
        "backup_strategy": {
          "start_time": "00:00-00:00",
          "keep_days": "0"
        },
        "nodes": [
          {
            "id": "799a0f2fa49a4151bf9f7063c1fbba36no07",
            "name": "gauss-d616-lb07_node01",
            "type": "master",
            "status": "FAILED",
            "port": 3306,
            "private_read_ips": [
              "192.168.0.163"
            ],
            "volume": {
              "type": "POOL",
              "used": "0.0"
            },
            "az_code": "az1xahz",
            "region_code": "cn-xianhz-1",
            "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
            "flavor_ref": "gaussdb.large.4",
            "max_connections": null,
            "vcpus": "1",
            "ram": "4",
            "need_restart": false,
            "priority": 1
          },
          {
            "id": "816459d771c444db9fa4c1d5c173cb1cno07",
            "name": "gauss-d616-lb07_node02",
            "type": "slave",
            "status": "FAILED",
            "port": 3306,
            "private_read_ips": [
              "192.168.0.160"
            ],
            "volume": {
              "type": "POOL",
              "used": "0.0"
            },
            "az_code": "az1xahz",
            "region_code": "cn-xianhz-1",
            "flavor_id": "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
            "flavor_ref": "gausssdb.large.4",
            "max_connections": null,
            "vcpus": "1",
            "ram": "4",
            "need_restart": false,
            "priority": 1
          }
        ],
        "time_zone": "UTC+08:00",
        "backup_used_space": 0,
        "az_mode": "single",
        "master_az_code": "az1xahz",
        "maintenance_window": "18:00-22:00"
      }
    }

Código de estado

Para obtener más información, consulte Códigos de estado.

Código de error

Para obtener más información, consulte Códigos de error.