Consulta de instancias de base de datos

Función

Esta API se utiliza para consultar instancias de acuerdo con criterios de búsqueda. 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 instancias) antes de esa fecha.

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

URI

• Formato de URI

  GET https://{endpoint}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}

• Ejemplo

  GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

• Descripción de parámetro

  Tabla 1 Descripción de parámetro

  Nombre	Tipo	Obligatorio	Descripción
  project_id	String	Sí	ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto.
  id	String	No	ID de instancia de base de datos. El asterisco (*) está reservado para el sistema. Si el ID de instancia comienza con un asterisco (*), se utiliza el valor siguiente al asterisco (*) para la coincidencia difusa. De lo contrario, el ID de instancia se utiliza para la coincidencia exacta.
  name	String	No	Nombre de instancia de base de datos. El asterisco (*) está reservado para el sistema. Si el nombre de la instancia comienza con un asterisco (*), el valor siguiente asterisco (*) se utiliza para la coincidencia difusa. De lo contrario, el nombre de instancia se utiliza para la coincidencia exacta.
  type	String	No	Tipo de instancia de base de datos que se va a consultar. Actualmente, solo se admite el tipo de clúster.
  datastore_type	String	No	Tipo de base de datos. Actualmente, solo se admite gaussdb-mysql.
  vpc_id	String	No	ID de VPC. Método 1: Inicie sesión en la consola de VPC y vea el ID de VPC en la página de detalles de VPC. Método 2: Consulte "Consultar VPCs" en la Referencia de API de Virtual Private Cloud.
  subnet_id	String	No	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: Consulte "Consultar subredes" en la Referencia de API de Virtual Private Cloud.
  offset	Integer	No	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	Integer	No	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.

Solicitud

Ninguna.

Respuesta

• Respuesta normal

  Tabla 2 Descripción de parámetro

  Nombre	Tipo	Descripción
  instances	Array of objects	Información de la instancia. Para obtener más información, consulte Tabla 3.
  total_count	Integer	Número total de registros.

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

  Nombre	Tipo	Descripción
  id	String	ID de instancia de base de datos.
  name	String	Nombre de instancia de base de datos.
  status	String	Estado de instancia de base de datos.
  private_ips	List<String>	Dirección IP privada para escribir. Es una cadena en blanco hasta que se crea un ECS.
  public_ips	List<String>	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	Object	Información de la base de datos. Para obtener más información, consulte Tabla 4.
  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.
  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. Para obtener más información, consulte Tabla 3.
  flavor_info	Object	Descripción de la especificación.
  volume	Object	Información de volumen. Para obtener más información, consulte Tabla 5.
  backup_strategy	Object	Política de copia de respaldo. Para obtener más información, consulte Tabla 7.
  enterprise_project_id	String	ID de proyecto de empresa.
  time_zone	String	Zona horaria.
  charge_info	Object	Modo de facturación, que es anual/mensual o pago por uso. De forma predeterminada, se utiliza el pago por uso. 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 de campo de volumen

  Nombre	Tipo	Descripción
  type	String	Tipo de disco.
  size	String	Tamaño de disco usado en GB.

  Tabla 6 descripción de la estructura de datos del campo de flavor_ref

  Nombre	Tipo	Descripción
  vcpus	String	Número de vCPUs.
  ram	String	Tamaño de la memoria en GB.

  Tabla 7 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	String	Días de retención de copia de respaldo.

  Tabla 8 descripción de la estructura de datos del campo de charge_info

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

  

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

• Ejemplo de respuesta normal

  {
      "total_count":6,
      "instances":[
          {
              "id":"d738399de028480fabb2b8120d4e01a4in07",
              "status":"ACTIVE",
              "name":"oMoS_001",
              "port":3306,
              "type":"Cluster",
              "private_ips": ["192.168.0.142"],
              "public_ips": ["10.154.219.187"],
              "db_user_name": "root",
              "region": "aaa",
              "datastore": {"type": "gaussdb-mysql", "version":"8.0"},
              "created": "2018-08-20T02:33:49+0800",
              "updated": "2018-08-20T02:33:50+0800",
              "volume": {
                      "type": "POOL",
                      "used_size": 100
              },                         
              "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
              "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
              "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902",
              "flavor_ref":"gaussdb.mysql.c3.small.4",
              "backup_strategy": {"start_time": "19:00-20:00", "keep_days": 7},                          
              "charge_info": {
                  "charge_mode": "postPaid"
              },
              "enterprise_project_id": "0",
                   "time_zone": "",
          }
      ]
  }

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.