Creación de una instancia de base de datos
Función
Esta API se utiliza para crear una instancia de GaussDB(for MySQL). 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 (Creación de una instancia) antes de esa fecha.
- Aprender cómo autorizar y autenticarla.
- Obtener los región y punto de conexión requeridos.
URI
- Formato de URI
- Ejemplo
POST https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances
- Descripción de parámetro
Tabla 1 Descripción de parámetro Nombre
Obligatorio
Descripción
project_id
Sí
ID de proyecto de un tenant en una región.
Para obtener este valor, consulte Obtención de un ID de proyecto.
Solicitud
Nombre |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
charge_info |
No |
Object |
Modo de facturación, que es anual/mensual o de pago por uso (configuración predeterminada). Para obtener más información, consulte Tabla 3. Nota: No puede crear instancias anuales/mensuales en un DeC. |
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 valor consta de 4 a 64 caracteres y comienza con una letra. Es sensible a mayúsculas y minúsculas y contiene solo letras, dígitos, guiones (-) y guiones bajos (_). |
datastore |
Sí |
Object |
Información de la base de datos. Para obtener más información, consulte Tabla 4. |
mode |
Sí |
String |
Tipo de instancia de base de datos, que no distingue entre mayúsculas y minúsculas. Actualmente, solo se admite el tipo de clúster. |
flavor_ref |
Sí |
String |
Código de especificación. Para obtener más información, consulte Tabla 3. |
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:
|
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. |
password |
Sí |
String |
Contraseña de la base de datos. Valores válidos: 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 introducir una contraseña segura para mejorar la seguridad y evitar riesgos de seguridad, como el agrietamiento por fuerza bruta. Si introduce una contraseña débil, el sistema determina automáticamente que la contraseña no es válida. |
backup_strategy |
No |
Object |
Política de copia de respaldo automatizada. Para obtener más información, consulte Tabla 5. |
time_zone |
No |
String |
Zona horaria de UTC.
|
availability_zone_mode |
Sí |
String |
Tipo de zona de disponibilidad. Puede ser single o multi. |
master_availability_zone |
Si availability_zone_mode se establece en multi este parámetro es obligatorio. Si availability_zone_mode se establece en single no se puede especificar este parámetro. |
String |
Zona de disponibilidad primaria. |
slave_count |
Sí |
Integer |
Número de réplicas de lectura. El valor es de 1 a 9. Una instancia contiene hasta 15 réplicas de lectura. |
region |
Sí |
String |
ID de región. El valor no puede estar vacío. Para obtener este valor, consulte Regiones y puntos de conexión. |
volume |
No |
Object |
Información de volumen. Este parámetro es opcional durante la creación de instancias anuales/mensuales. Para obtener más información, consulte Tabla 6. |
enterprise_project_id |
No |
String |
ID de proyecto de empresa. Este parámetro es obligatorio cuando el proyecto de empresa está habilitado y no se puede especificar cuando el proyecto de empresa está deshabilitado. |
lower_case_table_names |
No |
Integer |
Si un nombre de tabla del núcleo distingue entre mayúsculas y minúsculas. Si el valor es de forma predeterminada (1), el nombre de la tabla no distingue entre mayúsculas y minúsculas. Si el valor es de 0, el nombre de la tabla distingue entre mayúsculas y minúsculas. |
tags |
No |
Array of 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 20 pares clave-valor. Para obtener más información, consulte Tabla 7. |
Nombre |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
charge_mode |
Sí |
String |
Modo de facturación. Valores válidos:
|
period_type |
No |
String |
Período de suscripción. Valores válidos:
|
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 válidos:
|
Nombre |
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. 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. |
Nombre |
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:
|
Nombre |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
size |
Sí |
Integer |
Tamaño del disco. El valor predeterminado es 40 GB. El valor oscila entre 40 GB y 128,000 GB y debe ser un múltiplo de 10. |
Nombre |
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 (_). |
El valor de region en lo siguiente se usa como ejemplo.
- Ejemplo de solicitud
{ "charge_info":{ "charge_mode":"postPaid" }, "region":"cn-north-4b", "name":"gaussdb-2d34", "datastore":{ "type":"gaussdb-mysql", "version":"8.0" }, "mode":"Cluster", "flavor_ref":"gaussdb.mysql.large.x86.4", "vpc_id":"f7ee62e2-9705-4523-ba49-a85ea1a1fa87", "subnet_id":"140af7bf-a9da-4dcf-8837-34199fd6d186", "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902", "configuration_id":"43570e0de32e40c5a15f831aa5ce4176pr07", "password":"Gauss_234", "backup_strategy":{ "start_time":"17:00-18:00" }, "time_zone":"UTC+08:00", "availability_zone_mode":"multi", "master_availability_zone":"az1pod1", "slave_count":1, "enterprise_project_id":"0", "lower_case_table_names":1 }
Respuesta
- Respuesta normal
Tabla 8 Descripción de parámetro Nombre
Tipo
Descripción
instance
Object
Información de la instancia.
Para obtener más información, consulte Tabla 9.
job_id
String
ID de tarea de creación de instancia de base de datos.
Este parámetro sólo 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.
Tabla 9 descripción de la estructura de datos de campo de instancia Nombre
Tipo
Descripción
id
String
ID de instancia de base de datos.
name
String
Nombre de instancia de base de datos. Las instancias del mismo tipo pueden tener los mismos nombres bajo el mismo tenant.
El valor consta de 4 a 64 caracteres y comienza con una letra. Es insensible a mayúsculas y minúsculas y contiene solo letras, dígitos, guiones (-) y guiones bajos (_).
status
String
Estado de instancia de base de datos.
Este parámetro sólo se devuelve cuando se crean instancias de base de datos de pago por uso.
datastore
Object
Información de la base de datos.
Para obtener más información, consulte Tabla 10.
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 la base de datos, que es el mismo que el parámetro de solicitud.
backup_strategy
Object
Política de copia de respaldo automatizada.
Para obtener más información, consulte Tabla 11.
enterprise_project_id
String
ID de proyecto de empresa, que es el mismo que el parámetro de solicitud.
region
String
ID de región, que es el mismo que el parámetro de solicitud.
availability_zone_mode
String
Tipo 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.
Para obtener más información, consulte Tabla 3.
charge_info
Object
Modo de facturación, que es anual/mensual o de pago por uso.
Para obtener más información, consulte Tabla 12.
Tabla 10 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 11 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
Integer
Días de retención de copia de respaldo.
Tabla 12 descripción de la estructura de datos del campo de charge_info Nombre
Tipo
Descripción
charge_mode
String
Modo de facturación, que es anual/mensual o de pago por uso.
period_num
Integer
Duración de la suscripción, que se calcula por mes.
Este parámetro es válido cuando charge_mode se establece en prePaid (este parámetro es válido solo para instancias anuales/mensuales).
Los valores de region y master_availability_zone se usan como ejemplos.
- Ejemplo de respuesta normal
{ "instance":{ "id":"5eebbb4c0f9f4a99b42ed1b6334569aain07", "name":"gaussdb-2d34", "status":"BUILD", "datastore":{ "type":"gaussdb-mysql", "version":"8.0" }, "mode":"Cluster", "configuration_id": "", "port":null, "backup_strategy":{ "start_time":null, "keep_days":"7" }, "enterprise_project_id": "0", "region":"aaa", "availability_zone_mode":"multi", "master_availability_zone":"aaa", "vpc_id":"f7ee62e2-9705-4523-ba49-a85ea1a1fa87", "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902", "subnet_id":"140af7bf-a9da-4dcf-8837-34199fd6d186" "charge_info":{ "charge_mode":"postPaid" }, "flavor_ref":"gaussdb.mysql.large.x86.4" }, "job_id":"43672fe5-56bd-47f1-8fd1-595cded08a7c" }
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.