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(for MySQL)> Referencia de la API> Las API (recomendadas)> Gestión de instancias de base de datos> Consulta de instancias

Actualización más reciente 2023-12-14 GMT+08:00

Ver PDF

Consulta de instancias

Función

Esta API se utiliza para consultar instancias de base de datos de acuerdo con los criterios de búsqueda. Antes de invocar a esta API:

Aprender cómo autorizar y autenticarla.
Obtener los región y punto de conexión requeridos.

URI

GET /v3/{project_id}/instances

**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, consulte Obtención de un ID de proyecto.

**Tabla 2** Parámetros de Query
Parámetro	Obligatorio	Tipo	Descripción
id	No	String	ID de instancia. El asterisco () está reservado para el sistema. Si el ID de instancia comienza con , indica que se realiza una coincidencia difusa basada en el valor siguiente a . De lo contrario, la coincidencia exacta se realiza basándose en el ID de instancia. El valor no puede contener solo asteriscos ().
name	No	String	Nombre de instancia. El asterisco () está reservado para el sistema. Si el nombre de la instancia comienza por , indica que se realiza una coincidencia difusa basada en el valor siguiente a . De lo contrario, la coincidencia exacta se realiza basándose en el nombre de la instancia. El valor no puede contener solo asteriscos ().
type	No	String	Tipo de instancia que se va a consultar. Actualmente, solo se admite el tipo de clúster.
datastore_type	No	String	Tipo de base de datos. Actualmente, solo se admite gaussdb-mysql.
vpc_id	No	String	ID de VPC. Método 1: Inicie sesión en la consola de VPC y vea el ID de VPC en los detalles de la VPC. Método 2: Consulte la sección "Consulta de VPCs" en el Referencia de API de Virtual Private Cloud.
subnet_id	No	String	ID de red de la subred. Método 1: Inicie sesión en la consola de VPC y haga clic en la subred de destino en la página Subnets. Puede ver el ID de red en la página mostrada. Método 2: Vea la sección "Consulta de subredes" en la Referencia de API de Virtual Private Cloud.
private_ip	No	String	Dirección IP privada.
offset	No	Integer	Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor es 0 de forma predeterminada, lo que indica que la consulta comienza desde el primer dato. El valor no puede ser un número negativo.
limit	No	Integer	Número de registros a consultar. El valor predeterminado es 100. El valor debe ser un número positivo entero. El valor mínimo es de 1 y el valor máximo de 100.
tags	No	String	Consulta basada en la clave y el valor de la etiqueta de instancia. {key} indica la clave de la etiqueta, y {value} indica el valor de la etiqueta. Para consultar instancias con varias claves y valores de etiquetas, separe los pares de clave-valor con comas (,). La clave debe ser única. Múltiples claves están en relación AND.

Parámetros de solicitud

**Tabla 3** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario.
X-Language	No	String	Idioma.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
instances	Array of MysqlInstanceListInfo objects	Información de lista de instancias.
total_count	Integer	Número total de registros.

**Tabla 5** MysqlInstanceListInfo
Parámetro	Tipo	Descripción
id	String	ID de instancia.
name	String	Nombre de instancia.
status	String	Estado de la instancia.
private_ips	Array of strings	Dirección IP privada para escribir. Es una cadena en blanco hasta que se crea un ECS.
public_ips	Array of strings	Direcciones IP públicas.
port	String	Puerto de base de datos.
type	String	Tipo de instancia de base de datos. El valor es Cluster.
region	String	Región donde se despliega la instancia de base de datos.
datastore	MysqlDatastore object	Información de la base de datos.
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 la 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.
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.
flavor_ref	String	Código de especificación.
flavor_info	MysqlFlavorInfo object	Información de variante.
volume	MysqlVolumeInfo object	Información del disco de almacenamiento.
backup_strategy	MysqlBackupStrategy object	Política de copia de respaldo automatizada.
enterprise_project_id	String	ID de proyecto de empresa.
time_zone	String	Zona horaria.
charge_info	MysqlChargeInfo object	Modo de facturación, que es anual/mensual o pago por uso. De forma predeterminada, se utiliza el pago por uso.
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.
tags	Array of InstanceTagItem objects	Lista de etiquetas.

**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 detalles sobre las versiones del motor de base de datos compatibles, invoque a la API para consultar las versiones del motor de base de datos.
kernel_version	String	Versión del kernel de la base de datos.

**Tabla 7** MysqlFlavorInfo
Parámetro	Tipo	Descripción
vcpus	String	Número de vCPUs.
ram	String	Tamaño de la memoria en GB.

**Tabla 8** MysqlVolumeInfo
Parámetro	Tipo	Descripción
type	String	Tipo de disco.
size	String	Tamaño de disco usado en GB.

**Tabla 9** 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. El valor HH debe ser 1 mayor que el valor hh. 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. Valor: 1-732.

**Tabla 10** MysqlChargeInfo
Parámetro	Tipo	Descripción
charge_mode	String	Modo de facturación. Valores válidos: prePaid: indica el modo de facturación anual/mensual. postPaid: indica el modo de facturación de pago por uso.
period_type	String	Período de suscripción. Valores válidos: month: El servicio se suscribe por mes. year: El servicio se suscribe por año. Este parámetro es válido y obligatorio solo cuando se establece charge_mode en prePaid. Valores válidos: month year
period_num	Integer	Este parámetro es válido y obligatorio solo cuando se establece charge_mode en prePaid. Valores válidos: Cuando period_type se establece en month, el valor del parámetro oscila entre 1 y 9. Cuando period_type se establece en year, el valor del parámetro oscila entre 1 y 3.
is_auto_renew	String	Si la renovación automática está habilitada para instancias de base de datos anuales/mensuales. El período de renovación es el mismo que el período original y el pedido se pagará automáticamente durante la renovación de la suscripción. true: indica que la renovación automática está activada. false: indica que la renovación automática está deshabilitada. El valor predeterminado es false.
is_auto_pay	String	Si el pedido se pagará automáticamente después de que se creen instancias anuales/mensuales. Este parámetro no afecta al método de pago de la renovación automática. true: indica que el pedido se pagará automáticamente desde su cuenta. El valor predeterminado es true. false: indica que el pedido se pagará manualmente.

**Tabla 11** InstanceTagItem
Parámetro	Tipo	Descripción
key	String	Clave de etiqueta.
value	String	Valor de etiqueta.

Código de estado: 400

**Tabla 12** Parámetros de body 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 body 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 instancias

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=hyAbc&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1

Ejemplo de respuesta

Código de estado: 200

El valor de region se usa como ejemplo en la siguiente respuesta.

Success.

{
  "total_count" : 1,
  "instances" : [ {
    "id" : "d738399de028480fabb2b8120d4e01a4in07",
    "name" : "gaussdb-mysql-instance01",
    "status" : "ACTIVE",
    "port" : 3306,
    "type" : "Cluster",
    "private_ips" : [ "192.168.0.142" ],
    "db_user_name" : "root",
    "region" : "aaa",
    "datastore" : {
      "type" : "gaussdb-mysql",
      "version" : "8.0",
      "kernel_version" : "2.0.29.1"
    },
    "created" : "2018-08-20T02:33:49_0800",
    "updated" : "2018-08-20T02:33:49_0800",
    "volume" : {
      "type" : "POOL",
      "size" : 100
    },
    "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
    "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
    "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
    "flavor_ref" : "gaussdb.mysql.c3.small.4",
    "flavor_info" : {
      "vcpus" : 8,
      "ram" : 16
    },
    "backup_strategy" : {
      "start_time" : "19:00-20:00",
      "keep_days" : 7
    },
    "charge_info" : {
      "charge_mode" : "postPaid"
    },
    "enterprise_project_id" : 0,
    "time_zone" : "UTC",
    "tags" : [ ]
  } ]
}