Creación de una instancia de base de datos
Función
Esta API se utiliza para crear una instancia de TaurusDB. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
POST /v3/{project_id}/instances
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. |
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ámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
region |
Sí |
String |
ID de región. |
name |
Sí |
String |
Nombre de instancia de base de datos. Las instancias del mismo tipo pueden tener los mismos nombres bajo el mismo tenant. El nombre debe comenzar con una letra y debe contener entre 4 y 64 caracteres. Solo se permiten letras (distinguen mayúsculas de minúsculas), dígitos, guiones (-) y guiones bajos (_). |
datastore |
Sí |
MysqlDatastoreInReq object |
Información de la base de datos. |
mode |
Sí |
String |
Tipo de instancia. Actualmente, solo se admite el tipo de clúster. |
flavor_ref |
Sí |
String |
Código de especificación. Para más detalles, véase el spec_code en la Tabla 5 de Consulta de especificaciones de base de datos. |
vpc_id |
Sí |
String |
ID de VPC. Para obtener este valor, utilice uno de los métodos siguientes:
|
subnet_id |
Sí |
String |
ID de red. Para obtener este valor, utilice uno de los métodos siguientes:
|
password |
Sí |
String |
Contraseña de la base de datos. La contraseña consta de 8 a 32 caracteres y contiene al menos tres tipos de los siguientes: letras mayúsculas, minúsculas, dígitos y caracteres especiales ~!@#$%^*-_=+?,()& Se recomienda ingresar una contraseña segura para mejorar la seguridad y evitar riesgos de seguridad, como el agrietamiento por fuerza bruta. Si ingresa una contraseña débil, el sistema determina automáticamente que la contraseña no es válida. |
availability_zone_mode |
Sí |
String |
Tipo de zona de disponibilidad. Valores:
|
slave_count |
Sí |
Integer |
Número de réplicas de lectura. Se puede crear un máximo de nueve réplicas de lectura a la vez. |
charge_info |
No |
MysqlChargeInfo object |
Modo de facturación, que es anual/mensual o de pago por uso (configuración predeterminada). Nota: No puede crear instancias anuales/mensuales en un DeC. |
security_group_id |
No |
String |
ID del grupo de seguridad. Si la ACL de red está habilitada, no se puede especificar este parámetro. Si la ACL de red está deshabilitada, este parámetro es obligatorio.
|
configuration_id |
No |
String |
ID de plantilla de parámetro. Para más detalles, véase id en la Tabla 5 de Consulta de plantillas de parámetros. |
backup_strategy |
No |
MysqlBackupStrategy object |
Política de copia de respaldo automatizada. |
time_zone |
No |
String |
Zona horaria. La zona horaria predeterminada es UTC. |
master_availability_zone |
No |
String |
ID de zona de disponibilidad principal. |
volume |
No |
MysqlVolume object |
Información de volumen. Este parámetro solo está disponible para instancias anuales/mensuales. |
tags |
No |
Array of MysqlTags objects |
Lista de etiquetas. Las instancias se crean basándose en claves y valores de etiqueta.
Para crear instancias con varias claves y valores de etiqueta, separe los pares clave-valor con comas (,). Se pueden agregar hasta 10 pares de clave-valor. |
lower_case_table_names |
No |
Integer |
Si los nombres de tabla distinguen entre mayúsculas y minúsculas. El valor predeterminado es 1. Valores:
|
enterprise_project_id |
No |
String |
ID de proyecto de empresa. Este parámetro es obligatorio cuando el proyecto de empresa está habilitado. |
dedicated_resource_id |
No |
String |
ID del grupo de recursos dedicado. Este parámetro solo se muestra cuando el fondo de recursos dedicado está habilitado. |
restore_point |
No |
MysqlRestorePoint object |
Información de copia de respaldo. |
tde_info |
No |
MysqlTdeInfo object |
Configuración de TDE. Se admiten 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 |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
type |
Sí |
String |
Motor de base de datos. Actualmente, solo se admite gaussdb-mysql. |
version |
Sí |
String |
Versión de base de datos. Se devuelve una versión principal de dos números. Para obtener detalles sobre cómo obtener la versión, vea el campo name devuelto por el Consulta de información de versión acerca de un motor de base de datos. |
kernel_version |
No |
String |
Versión del kernel de BD. Si necesita especificar una versión del kernel, póngase en contacto con el servicio de atención al cliente. Se devuelve una versión completa del kernel de 4 dígitos. Para obtener detalles sobre cómo obtener el valor, vea el campo kernel_version devuelto por Consulta de información de versión acerca de un motor de base de datos. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
charge_mode |
Sí |
String |
Modo de facturación. Valores:
Valores enumerados:
|
period_type |
No |
String |
Período de suscripción. Valores:
NOTA:
Este parámetro es válido y obligatorio si charge_mode tiene el valor de prePaid. Valores enumerados:
|
period_num |
No |
Integer |
Duración de la suscripción. Este parámetro es válido y obligatorio si charge_mode tiene el valor de prePaid. Valores:
|
is_auto_renew |
No |
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.
|
is_auto_pay |
No |
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.
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
start_time |
Sí |
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.
Valor de ejemplo: 21:00-22:00 |
keep_days |
No |
String |
Período de retención de copias de respaldo automatizadas. Rango de valores: 1–732. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
size |
Sí |
String |
Tamaño del disco. El valor predeterminado es 10 GB. Rango de valores: de 10–128000. El valor debe ser un múltiplo de 10. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
key |
Sí |
String |
Clave de etiqueta. Contiene 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 |
Sí |
String |
Valor de etiqueta. Contiene un máximo de 43 caracteres Unicode. Puede ser una cadena vacía. Solo se permiten letras mayúsculas, minúsculas, dígitos, puntos (.), guiones (-) y guiones bajos (_). |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
source_instance_id |
Sí |
String |
ID de instancia de origen. |
restore_time |
No |
Long |
Punto en el tiempo al que se restauran los datos. |
backup_id |
No |
String |
ID del archivo de copia de respaldo. |
type |
No |
String |
Tipo de copia de respaldo. Si este parámetro se deja en blanco, backup_id no se puede dejar en blanco y los datos se restauran usando archivos copia de respaldo de forma predeterminada. Valores:
|
Parámetros de respuesta
Código de estado: 201
Parámetro |
Tipo |
Descripción |
---|---|---|
instance |
MysqlInstanceResponse object |
Información de instancia de BD. |
job_id |
String |
ID de la tarea para crear una instancia de BD. Este parámetro solo se devuelve cuando se crean instancias de base de datos de pago por uso. |
order_id |
String |
ID de pedido. Este parámetro solo se devuelve cuando se crean instancias anuales/mensuales. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de instancia de BD, que cumple con el formato UUID. |
name |
String |
Nombre de instancia de base de datos. Este parámetro especifica el nombre de una instancia. |
status |
String |
Estado de instancia de base de datos. |
datastore |
MysqlDatastore object |
Información de la base de datos. |
mode |
String |
Tipo de instancia de base de datos. Actualmente, solo se admite el tipo de clúster. |
configuration_id |
String |
ID de plantilla de parámetro. |
port |
String |
Puerto de base de datos. |
backup_strategy |
MysqlBackupStrategy object |
Política de copia de respaldo automatizada. |
enterprise_project_id |
String |
ID de proyecto de empresa. |
region |
String |
ID de región, que es el mismo que el parámetro de solicitud. |
availability_zone_mode |
String |
Modo de zona de disponibilidad, que es el mismo que el parámetro de solicitud. |
master_availability_zone |
String |
ID de zona de disponibilidad principal. |
vpc_id |
String |
ID de VPC, que es el mismo que el parámetro de solicitud. |
security_group_id |
String |
ID del grupo de seguridad, que es el mismo que el parámetro de solicitud. |
subnet_id |
String |
ID de subred, que es el mismo que el parámetro de solicitud. |
flavor_ref |
String |
Código de especificación, que es el mismo que el parámetro de solicitud. |
charge_info |
MysqlChargeInfo object |
Modo de facturación, que es anual/mensual o de pago por uso.By default, pay-per-use is used. |
volume |
MysqlVolumeResp object |
Información de volumen. Este parámetro se devuelve cuando se crea una instancia de BD anual/mensual. |
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. Se devuelve una versión principal de dos números. Para obtener detalles sobre cómo obtener la versión, vea el campo name devuelto por el Consulta de información de versión acerca de un motor de base de datos. |
kernel_version |
String |
Versión del kernel de BD. Se devuelve una versión completa del kernel de cuatro números. Para obtener detalles sobre cómo obtener el valor, vea el campo kernel_version devuelto por Consulta de información de versión acerca de un motor de base de datos. |
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.
|
keep_days |
String |
Días de retención de copia de respaldo automatizados. Rango de valores: 1–732. |
Parámetro |
Tipo |
Descripción |
---|---|---|
charge_mode |
String |
Modo de facturación. Valores:
Valores enumerados:
|
period_type |
String |
Período de suscripción. Valores:
NOTA:
Este parámetro solo está disponible y es obligatorio cuando charge_mode se establece en prePaid. Valores enumerados:
|
period_num |
Integer |
Este parámetro solo está disponible y es obligatorio cuando charge_mode se establece en prePaid. Valores:
|
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.
|
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.
|
Parámetro |
Tipo |
Descripción |
---|---|---|
size |
Integer |
Espacio de almacenamiento en GB. Rango de valores: 10–128000. El valor debe ser un múltiplo de 10. |
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. |
Solicitud de ejemplo

El valor de region se usa como ejemplo.
- Creación de una instancia de BD facturada en régimen de pago por uso (Se crea una copia de respaldo automatizada de 08:00 a 09:00).
POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances { "name" : "gaussdb-mysql-instance1", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "password" : "*****", "backup_strategy" : { "start_time" : "08:00-09:00" }, "availability_zone_mode" : "single", "slave_count" : 1, "enterprise_project_id" : 0 }
- Restauración de datos en una nueva instancia de BD de pago por uso mediante copias de respaldo
POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances { "name" : "gaussdb-mysql-instance2", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "password" : "****", "backup_strategy" : { "start_time" : "08:00-09:00" }, "availability_zone_mode" : "single", "slave_count" : 1, "enterprise_project_id" : 0, "restore_point" : { "source_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "backup_id" : "7ffbf305376b4cbea0ae491257b6aaf9br07", "type" : "backup" } }
- Restauración de datos en una nueva instancia de pago por uso a través de PITR
POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances { "name" : "gaussdb-mysql-instance3", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "password" : "xxxxx", "backup_strategy" : { "start_time" : "08:00-09:00" }, "availability_zone_mode" : "single", "slave_count" : 1, "enterprise_project_id" : 0, "restore_point" : { "source_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07", "restore_time" : 1673852043000, "type" : "timestamp" } }
Ejemplo de respuesta
Código de estado: 201

Los valores de region y master_availability_zone se usan como ejemplos.
Operación exitosa.
{ "instance" : { "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07", "name" : "gaussdb-mysql-instance1", "status" : "BUILD", "region" : "br-iaas-odin1", "charge_info" : { "charge_mode" : "postPaid" }, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "mode" : "Cluster", "port" : "3306", "enterprise_project_id" : 0, "flavor_ref" : "gaussdb.mysql.xlarge.arm.4", "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "configuration_id" : "43570e0de32e40c5a15f831aa5ce4176pr07", "backup_strategy" : { "start_time" : "08:00-09:00", "keep_days" : 7 }, "availability_zone_mode" : "single" }, "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" }
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.