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 usar esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
GET /v3.1/{project_id}/instances/{instance_id}
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. |
instance_id |
Sí |
String |
ID de instancia, que es compatible con el formato UUID. |
Parámetros 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:
|
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
instancia |
información sobre instancias |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de instancia, que es compatible con el formato UUID. |
name |
String |
Nombre de instancia. |
project_id |
String |
ID de proyecto de un tenant en una región. |
status |
String |
Estado de la instancia. Valores:
|
port |
String |
Puerto de base de datos. |
alias |
String |
Descripción de la instancia. |
type |
String |
Tipo de instancia. El valor es de 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 |
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. El formato es 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, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
updated |
String |
Hora de actualización. El formato es el mismo que el del campo created. |
private_write_ips |
Array of strings |
Lista de direcciones IP privadas. |
private_dns_names |
Array of strings |
Lista de nombres de dominio privado. 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 |
Las EIP. |
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 de BD o ID de la última plantilla de parámetros que se aplica a una instancia de BD. |
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:
|
master_az_code |
String |
Zona de disponibilidad primaria. |
maintenance_window |
String |
Ventana de mantenimiento en formato UTC. |
tags |
Array of MysqlTags objects |
Etiquetas de instancia. |
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 proxy. |
tde_info |
MysqlTdeInfo object |
Configuración de TDE. Se soportan los algoritmos AES 256 y SM4. TDE está en la fase de prueba beta abierta (OBT). Para usarlo, envíe un ticket de servicio. |
Parámetro |
Tipo |
Descripción |
---|---|---|
charge_mode |
String |
Modo de facturación. |
order_id |
String |
ID de pedido. Este parámetro se devuelve solo para instancias anuales/mensuales. |
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. |
kernel_version |
String |
Versión del kernel de la base de datos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
start_time |
String |
Tiempo de inicio de copia de respaldo automatizado. La creación de una copia de respaldo automatizada se activará dentro de una hora después del tiempo especificado por este parámetro. El campo de valor no puede estar vacío. Debe ser un valor válido en el formato "hh:mm-HH:MM". La hora actual está en formato UTC.
|
keep_days |
String |
Días de retención de copia de respaldo automatizados. Rango de valores: 1–732. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de instancia, que es compatible con el formato UUID. |
name |
String |
Nombre del nodo. |
type |
String |
Tipo de nodo. Valores:
|
status |
String |
Estado del nodo. |
port |
Integer |
Puerto de base de datos. |
private_read_ips |
Array of strings |
Direcciones IP privadas para lectura de nodos. |
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. El formato es 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, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
updated |
String |
Hora de actualización. El formato es el mismo que el del campo created. |
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 vCPU. |
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. |
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. |
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. Puede contener hasta 43 caracteres Unicode y puede ser una cadena vacía. Solo se permiten letras mayúsculas, minúsculas, dígitos, puntos (.), guiones (-) y guiones bajos (_). |
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 proxy. |
Parámetro |
Tipo |
Descripción |
---|---|---|
enable_tde |
Boolean |
Si se debe habilitar TDE. |
encryption_type |
String |
Algoritmo de TDE. Se soportan los algoritmos AES 256 y SM4. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Ejemplo de la solicitud
Consulta de detalles de una instancia de BD especificada
GET https://{endpoint}/v3.1/3cedfc54-b105-4652-a4e0-847b11576628/instances/d738399de028480fabb2b8120d4e01a4in07
Ejemplo de la respuesta
Código de estado: 200
Operación exitosa.
{ "instance" : { "id" : "d738399de028480fabb2b8120d4e01a4in07", "name" : "gaussdb-mysql-instance01", "alias" : "", "status" : "normal", "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.*.*.*", "private_write_ips" : [ "192.*.*.*" ], "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" : "normal", "port" : 3306, "private_read_ips" : [ "192.*.*.*" ], "volume" : { "type" : "POOL", "used" : 0.07 }, "az_code" : "az1", "region_code" : "region-1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "max_connections" : 1500, "vcpus" : 1, "ram" : 4, "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" : "normal", "port" : 3306, "private_read_ips" : [ "192.*.*.*" ], "volume" : { "type" : "POOL", "used" : 0.07 }, "az_code" : "az1*", "region_code" : "region-1", "flavor_id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "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.*.*.*", "name" : "proxy-name" } ] } }
Código de estado
Código de estado |
Descripción |
---|---|
200 |
Operación exitosa. |
400 |
Error de cliente. |
500 |
Error de servidor. |
Código de error
Para más detalles, véase Códigos de error.