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/ Creación de una instancia

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

Ver PDF

Creación de una instancia

Función

Esta API se utiliza para crear una instancia de base de datos de GaussDB(for MySQL). Antes de invocar a esta API:

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

URI

POST /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.

Parámetros de solicitud

**Tabla 2** 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.

**Tabla 3** Parámetros de body de solicitud
Parámetro	Obligatorio	Tipo	Descripción
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.
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.
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 debe tener entre 4 y 64 caracteres y empezar con una letra. Distingue mayúsculas y minúsculas y solo puede contener letras, dígitos, guiones (-) y guiones bajos (_).
datastore	Sí	MysqlDatastore 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.
vpc_id	Sí	String	ID de VPC. Para obtener este valor, utilice uno de los métodos siguientes: 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	Sí	String	ID de red. Para obtener este valor, utilice uno de los métodos siguientes: 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.
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. Método 1: Inicie sesión en la consola de VPC. Seleccione Access Control > Security Groups en el panel de navegación de la izquierda. En la página mostrada, haga clic en el grupo de seguridad de destino. Puede ver el ID del grupo de seguridad en la página mostrada. Método 2: Consulte "Consulta de grupos de seguridad" en la Referencia de API de Virtual Private Cloud.
configuration_id	No	String	ID de plantilla de parámetro.
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 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	MysqlBackupStrategy object	Política de copia de respaldo automatizada.
time_zone	No	String	Zona horaria. La zona horaria predeterminada es UTC.
availability_zone_mode	Sí	String	Tipo de zona de disponibilidad. El valor puede ser single o multi.
master_availability_zone	No	String	Zona de disponibilidad primaria. 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.
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.
volume	No	MysqlVolume object	Información de volumen. Este parámetro es opcional durante la creación de instancias anuales/mensuales.
tags	No	Array of MysqlTags objects	Lista de etiquetas. Las instancias se crean basándose en claves y valores de etiqueta. {key} indica la clave de etiqueta. Debe ser único y no puede estar vacío. {value} indica el valor de la etiqueta, que puede estar vacío. 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. Valor: 0: Los nombres de las tablas son fijos y distinguen entre mayúsculas y minúsculas. 1: Los nombres de las tablas se almacenan en minúsculas y no distinguen entre mayúsculas y minúsculas.
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 sólo se muestra cuando el fondo de recursos dedicado está habilitado.

**Tabla 4** MysqlChargeInfo
Parámetro	Obligatorio	Tipo	Descripción
charge_mode	Sí	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	No	String	Período de suscripción. Valores válidos: month: El servicio se suscribe por mes. year: El servicio se suscribe por año. NOTA: Este parámetro es válido y obligatorio si charge_mode tiene el valor de prePaid.
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: 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	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. 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	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. true: indica que el pedido se pagará automáticamente. false: indica que el pedido se pagará manualmente. El valor predeterminado es false.

**Tabla 5** MysqlDatastore
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. 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.

**Tabla 6** MysqlBackupStrategy
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. 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. Valor de ejemplo: 21:00-22:00
keep_days	No	String	Días de retención de copia de respaldo automatizados. Valor: 1-732.

**Tabla 7** MysqlVolume
Parámetro	Obligatorio	Tipo	Descripción
size	Sí	String	Tamaño del disco. El valor predeterminado es 40 GB. Valor: de 40 a 128000. El valor debe ser un múltiplo de 10.

**Tabla 8** MysqlTags
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ámetros de respuesta

Código de estado: 201

**Tabla 9** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
instance	MysqlInstanceResponse object	Información de la instancia.
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 10** MysqlInstanceResponse
Parámetro	Tipo	Descripción
id	String	ID de instancia.
name	String	Nombre de instancia de base de datos. Las instancias del mismo tipo pueden tener los mismos nombres bajo el mismo tenant. El nombre 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	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.

**Tabla 11** MysqlDatastore
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.

**Tabla 12** 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 13** MysqlChargeInfo
Parámetro	Tipo	Descripción
charge_mode	String	Modo de facturación, que es anual/mensual o 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.

Código de estado: 400

**Tabla 14** 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 15** 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

El valor de region se usa como ejemplo.

Creación de una instancia

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" : "taurus.large.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" : "Hu2wei@13",
  "backup_strategy" : {
    "start_time" : "08:00-09:00"
  },
  "availability_zone_mode" : "single",
  "slave_count" : 1,
  "enterprise_project_id" : 0
}

Ejemplo de respuesta

Código de estado: 201

Los valores de region y master_availability_zone se usan como ejemplos.

Success.

{
  "instance" : {
    "id" : "5eebbb4c0f9f4a99b42ed1b6334569aain07",
    "name" : "gaussdb-mysql-instance1",
    "region" : "br-iaas-odin1",
    "charge_info" : {
      "charge_mode" : "postPaid"
    },
    "datastore" : {
      "type" : "gaussdb-mysql",
      "version" : "8.0"
    },
    "mode" : "Cluster",
    "flavor_ref" : "taurus.large.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",
    "slave_count" : 1
  },
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}