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/ TaurusDB/ Referencia de la API/ Las API (Próximamente no disponibles)/ Gestión de instancias/ Consulta de detalles de una instancia de base de datos
Actualización más reciente 2025-03-21 GMT+08:00
Ver PDF
Compartir

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 2025.

URI

GET /v3/{project_id}/instances/{instance_id}

Tabla 1 Parámetros de URI

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

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

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

instance_id

Sí

String

ID de instancia.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Token de usuario.

Para obtener este valor, invoque a la API de IAM para obtener un token de usuario.

El valor de X-Subject-Token en el encabezado de respuesta es el valor del token.

X-Language

No

String

Tipo de idioma de solicitud. El valor predeterminado es en-us.

Valores:

  • en-us
  • zh-cn

Parámetros de respuesta

Código de estado: 200

Tabla 3 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

instance

MysqlInstanceInfoDetail object

Información de la instancia.
Tabla 4 MysqlInstanceInfoDetail

Parámetro

Tipo

Descripción

id

String

ID de instancia.

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:

  • BUILD: Se está creando la instancia de BD.
  • ACTIVE: La instancia de BD es normal.
  • FAILED: La instancia de BD es anormal.
  • FROZEN: La instancia de base de datos está congelada.
  • MODIFYING: Se está escalando verticalmente la instancia de base de datos.
  • REBOOTING: Se está reiniciando la instancia de base de datos.
  • RESTORING: Se está restaurando la instancia de BD.
  • MODIFYING INSTANCE TYPE: La instancia de BD está cambiando de primaria a en espera.
  • SWITCHOVER: Se está realizando una conmutación primario/ en espera.
  • MIGRATING: Se está migrando la instancia de base de datos.
  • BACKING UP: Se está realizando una copia de respaldo de la instancia de base de datos.
  • MODIFYING DATABASE PORT: Se está cambiando el puerto de la base de datos.
  • STORAGE FULL: El espacio de almacenamiento de la instancia de BD está lleno.

port

String

Puerto de base de datos.

alias

String

Observaciones de instancia.

type

String

Tipo de instancia. El valor es Cluster.

charge_info

MysqlInstanceChargeInfo object

Modo de facturación, que es anual/mensual o de pago por uso (configuración predeterminada).

node_count

Integer

Número de nodos.

datastore

MysqlDatastore object

Información de la base de datos.

backup_used_space

Double

Espacio de copia de respaldo usado en GB.

created

String

Tiempo de creación en el formato "aaaa-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 la zona horaria se muestra como +0800.

NOTA:

El valor está vacío cuando se crea la instancia de base de datos. Después de crear la instancia de base de datos, el valor no está vacío.

updated

String

Hora de actualización. El formato es el mismo que el del campo created.

NOTA:

El valor está vacío cuando se crea la instancia de base de datos. Después de crear la instancia de base de datos, el valor no está vacío.

private_write_ips

Array of strings

Dirección IP privada para escribir.

private_dns_names

Array of strings

Nombres de dominio privados de la instancia. Después de crear una instancia de base de datos, debe solicitar manualmente un nombre de dominio privado, o el nombre de dominio privado se deja en blanco.

public_ips

String

Dirección IP pública de la instancia.

db_user_name

String

Nombre de usuario predeterminado.

vpc_id

String

ID de VPC.

subnet_id

String

ID de red de la subred.

security_group_id

String

ID del grupo de seguridad.

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.

backup_strategy

MysqlBackupStrategy object

Política de copia de respaldo automatizada.

nodes

Array of MysqlInstanceNodeInfo objects

Información del nodo.

enterprise_project_id

String

ID de proyecto de empresa.

time_zone

String

Zona horaria.

az_mode

String

Tipo de zona de disponibilidad.

Valores:

  • single: zona de disponibilidad única
  • multi: zonas de disponibilidad múltiples

master_az_code

String

Zona de disponibilidad primaria.

maintenance_window

String

Ventana de mantenimiento en formato UTC.

tags

Array of MysqlTags objects

Etiquetas para gestionar instancias.

dedicated_resource_id

String

ID del grupo de recursos dedicado. Este parámetro se devuelve solo cuando la instancia pertenece a un grupo de recursos dedicado.

proxies

Array of MysqlProxyInfo objects

Información de instancia proxy.
Tabla 5 MysqlInstanceChargeInfo

Parámetro

Tipo

Descripción

charge_mode

String

Modo de facturación.

order_id

String

ID de pedido.
Tabla 6 MysqlDatastoreWithKernelVersion

Parámetro

Tipo

Descripción

type

String

Motor de base de datos. Actualmente, solo se admite gaussdb-mysql.

version

String

Versión de base de datos.

Para obtener más información acerca de las versiones de bases de datos compatibles, consulte Consulta de información de versión acerca de un motor de base de datos.

kernel_version

String

Versión del kernel de la base de datos.
Tabla 7 MysqlBackupStrategy

Parámetro

Tipo

Descripción

start_time

String

Tiempo de inicio de copia de respaldo automatizado. La copia de respaldo automatizada se activará dentro de una hora después del tiempo especificado por este parámetro.

El valor no puede estar vacío. Debe ser un valor válido en el formato "hh:mm-HH:MM". La hora actual está en el formato UTC.

  1. El valor HH debe ser 1 mayor que el valor hh.
  2. Los valores de mm y MM deben ser los mismos y deben establecerse en 00.

keep_days

String

Días de retención de copia de respaldo automatizados. Rango de valores 1-732.
Tabla 8 MysqlInstanceNodeInfo

Parámetro

Tipo

Descripción

id

String

ID de instancia.

name

String

Nombre del nodo.

type

String

Tipo de nodo.

Valores:

  • master: nodo primario
  • slave: lectura de réplica

status

String

Estado del nodo.

port

Integer

Puerto de base de datos.

private_read_ips

Array of strings

Dirección IP privada para la lectura del nodo.

volume

MysqlInstanceNodeVolumeInfo object

Información del disco de almacenamiento.

az_code

String

Zona de disponibilidad.

region_code

String

Región donde se encuentra la instancia.

created

String

Tiempo de creación en el formato "aaaa-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 la zona horaria se muestra como +0800.

NOTA:

El valor está vacío cuando se crea la instancia de base de datos. Después de crear la instancia de base de datos, el valor no está vacío.

updated

String

Tiempo de actualización. El formato es el mismo que el del campo created.

NOTA:

El valor está vacío cuando se crea la instancia de base de datos. Después de crear la instancia de base de datos, el valor no está vacío.

flavor_id

String

ID de especificación.

flavor_ref

String

Código de especificación.

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 para que surtan efecto las modificaciones de parámetros.

priority

Integer

Prioridad de conmutación por error.
Tabla 9 MysqlInstanceNodeVolumeInfo

Parámetro

Tipo

Descripción

type

String

Tipo de disco.

used

String

Tamaño de disco usado en GB.

size

Long

Tamaño de disco de la instancia anual/mensual en GB
Tabla 10 MysqlTags

Parámetro

Tipo

Descripción

key

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 (_).

value

String

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

Parámetro

Tipo

Descripción

pool_id

String

ID de instancia proxy.

name

String

Nombre de instancia de proxy.

address

String

Dirección de división de lectura/escritura de una instancia proxy

Código de estado: 400

Tabla 12 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 13 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitud de ejemplo

Consulta de detalles de una instancia de BD especificada

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

Ejemplo de respuesta

Código de estado: 201

Los valores de region_code y az_code se usan como ejemplos.

Operación exitosa.

{
  "instance" : {
    "id" : "d738399de028480fabb2b8120d4e01a4in07",
    "name" : "gaussdb-mysql-instance01",
    "alias" : "",
    "status" : "ACTIVE",
    "project_id" : "3cedfc54-b105-4652-a4e0-847b11576628",
    "enterprise_project_id" : 0,
    "type" : "Cluster",
    "charge_info" : {
      "charge_mode" : "postPaid",
      "order_id" : ""
    },
    "node_count" : 2,
    "datastore" : {
      "type" : "gaussdb-mysql",
      "version" : "8.0",
      "kernel_version" : "2.0.29.1"
    },
    "created" : "2022-07-14T16:26:58+0800",
    "updated" : "2022-07-18T14:20:33+0800",
    "public_ips" : [ "10.154.219.187" ],
    "private_write_ips" : [ "192.168.0.142" ],
    "private_dns_names" : [ "d738399de028480fabb2b8120d4e01a4in07.internal.cn-xianhz-1.gaussdbformysql.myhuaweicloud.com" ],
    "db_user_name" : "root",
    "port" : 3306,
    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
    "backup_strategy" : {
      "start_time" : "19:00-20:00",
      "keep_days" : 7
    },
    "nodes" : [ {
      "id" : "799a0f2fa49a4151bf9f7063c1fbba36no07",
      "name" : "gauss-d616-lb07_node01",
      "type" : "master",
      "status" : "ACTIVE",
      "port" : 3306,
      "private_read_ips" : [ "192.168.0.163" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1xahz",
      "region_code" : "cn-xianhz-1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysql.xlarge.x86.4",
      "max_connections" : 1500,
      "vcpus" : 4,
      "ram" : 16,
      "need_restart" : false,
      "priority" : 1,
      "created" : "2022-07-14T16:26:58+0800",
      "updated" : "2022-07-18T09:24:18+0800"
    }, {
      "id" : "799a0f2fa49a4151bf9f7063c1fbba35no07",
      "name" : "gauss-d616-lb07_node02",
      "type" : "slave",
      "status" : "ACTIVE",
      "port" : 3306,
      "private_read_ips" : [ "192.168.0.162" ],
      "volume" : {
        "type" : "POOL",
        "used" : 0.07
      },
      "az_code" : "az1xahz",
      "region_code" : "cn-xianhz-1",
      "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
      "flavor_ref" : "gaussdb.mysqlxlarge.arm.2.ha",
      "max_connections" : 1500,
      "vcpus" : 1,
      "ram" : 4,
      "need_restart" : false,
      "priority" : 1,
      "created" : "2022-07-14T16:26:58+0800",
      "updated" : "2022-07-18T09:36:18+0800"
    } ],
    "time_zone" : "UTC+08:00",
    "backup_used_space" : 0.24,
    "az_mode" : "single",
    "master_az_code" : "az1",
    "maintenance_window" : "18:00-22:00",
    "tags" : [ ],
    "configuration_id" : "53570e0de54e40c5a15f331aa5sd2176pr07",
    "dedicated_resource_id" : "",
    "proxies" : [ {
      "pool_id" : "dab1cfc5150c4d1ca0e8c6596bfc0d8cpo01",
      "address" : "192.168.10.76",
      "name" : "proxy-name"
    } ]
  }
}

Código de estado

Para más detalles, véase Códigos de estado.

Código de error

Para más detalles, véase Códigos de error.

Tema principal: Gestión de instancias