Creación de una instancia
Función
Esta API se utiliza para crear una instancia de Kafka de pago por uso.
URI
POST /v2/{project_id}/instances
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
name |
Sí |
String |
Nombre de instancia. Un nombre de instancia comienza con una letra, consta de 4 a 64 caracteres y solo puede contener letras, dígitos, guiones bajos (_) y guiones (-). |
description |
No |
String |
Descripción de la instancia. La descripción puede contener un máximo de 1024 caracteres.
NOTA:
La barra invertida () y las comillas (") son caracteres especiales para los mensajes JSON. Cuando utilice estos caracteres en un valor de parámetro, agregue el carácter de escape () antes de los caracteres, por ejemplo, \ y ". |
engine |
Sí |
String |
Motor de mensajes. Valor: kafka. |
engine_version |
Sí |
String |
Versión del motor de mensajes. Valor: 1.1.0 y 2.3.0. |
specification |
No |
String |
Para una instancia de Kafka que usa nuevas especificaciones, este parámetro indica el TPS de servicio de la instancia. Opciones:
Para una instancia de Kafka que usa especificaciones antiguas: Este parámetro indica el ancho de banda de la instancia, es decir, la cantidad máxima de datos que se pueden transferir por unidad de tiempo. Unidad: MB. Opciones:
|
broker_num |
No |
Integer |
Número de corredores. No es necesario establecer este parámetro si la instancia utiliza especificaciones antiguas. Si la instancia utiliza nuevas especificaciones, el intervalo de valores es de 3 a 30. No es necesario configurar este parámetro. |
storage_space |
Sí |
Integer |
Espacio de almacenamiento de mensajes en GB. Rango de valores:
|
partition_num |
No |
Integer |
Número máximo de particiones en una instancia de Kafka.
No es necesario establecer este parámetro si la instancia utiliza nuevas especificaciones. Para obtener detalles sobre el número máximo de particiones para cada especificación, consulte https://support.huaweicloud.com/en-us/productdesc-kafka/Kafka-specification.html. No es necesario establecer este parámetro si la instancia utiliza nuevas especificaciones. Para obtener detalles sobre el número máximo de particiones para cada especificación, consulte https://support.huaweicloud.com/intl/en-us/productdesc-kafka/Kafka-specification.html. |
access_user |
No |
String |
Este parámetro es obligatorio cuando ssl_enable se establece en true. Este parámetro no es válido cuando ssl_enable se establece en false. El nombre de usuario debe tener entre 4 y 64 caracteres y solo puede contener letras, dígitos y guiones (-). |
password |
No |
String |
Este parámetro es obligatorio cuando ssl_enable se establece en true. Este parámetro no es válido cuando ssl_enable se establece en false. Contraseña de la instancia. La contraseña debe cumplir los siguientes requisitos de complejidad:
|
vpc_id |
Sí |
String |
ID de VPC. Para obtenerlo, inicie sesión en la consola de VPC y vea el ID de VPC en la página de detalles de VPC. |
security_group_id |
Sí |
String |
ID del grupo de seguridad al que pertenece la instancia. Para obtenerlo, inicie sesión en la consola de VPC y vea el ID del grupo de seguridad en la página de detalles del grupo de seguridad. |
subnet_id |
Sí |
String |
Información de subred. Para obtenerla, 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. |
available_zones |
Sí |
Matriz de strings |
ID de la AZ donde residen los corredores de instancia y que tiene recursos disponibles. Este parámetro no puede estar vacío o nulo. Una instancia de Kafka puede desplegarse en 1 AZ o al menos 3 AZs. Al especificar AZs para los corredoress, separe varios AZs con comas (,). |
product_id |
Sí |
String |
ID del producto. El ID del producto se puede obtener llamando a la API de Querying Product Specifications List. El formato de ID del producto puede variar dependiendo del sitio. Un formato contiene tanto dígitos como letras, por ejemplo, c6.2u4g.cluster. El otro formato contiene solo dígitos, por ejemplo, 00300-30308-0--0. |
kafka_manager_user |
Sí |
String |
Nombre de usuario para iniciar sesión en Kafka Manager. El nombre de usuario consta de 4 a 64 caracteres y puede contener solo letras, dígitos y guiones (-). |
kafka_manager_password |
Sí |
String |
Contraseña para iniciar sesión en Kafka Manager. La contraseña debe cumplir los siguientes requisitos de complejidad:
|
maintain_begin |
No |
String |
Hora en la que comienza la ventana de tiempo de mantenimiento. Formato: HH:mm.- La hora de inicio y la hora de finalización de la ventana de tiempo de mantenimiento debe indicar el segmento de tiempo de una ventana de tiempo de mantenimiento compatible.- La hora de inicio debe ajustarse a 22:00, 02:00, 06:00, 10:00, 14:00, o 18:00.- La hora de inicio y la hora de finalización deben establecerse en pares. Si la hora de inicio se deja en blanco, la hora de finalización también debe dejarse en blanco. En este caso, el sistema establece automáticamente la hora de inicio en 02:00. |
maintain_end |
No |
String |
Hora en la que finaliza la ventana de tiempo de mantenimiento. Formato: HH:mm.- La hora de inicio y la hora de finalización de la ventana de tiempo de mantenimiento debe indicar el segmento de tiempo de una ventana de tiempo de mantenimiento compatible.- La hora de finalización es cuatro horas más tarde que la hora de inicio. Por ejemplo, si la hora de inicio es 22:00, la hora de finalización es 02:00.- La hora de inicio y la hora de finalización deben establecerse en pares. Si la hora de finalización se deja en blanco, la hora de inicio también se deja en blanco. En este caso, el sistema establece automáticamente la hora de finalización en 06:00. |
enable_publicip |
No |
Boolean |
Si se debe habilitar el acceso público. De forma predeterminada, el acceso público está deshabilitado.
|
public_bandwidth |
No |
Integer |
Ancho de banda de la red pública. Unidad: Mbit/s. Rango de valores:
Rango de valores para nuevas especificaciones:
|
publicip_id |
No |
String |
ID del EIP enlazado a la instancia. Utilice comas (,) para separar varios ID de EIP. Este parámetro es obligatorio si el acceso público está habilitado (es decir, enable_publicip se establece en true). |
ssl_enable |
No |
Boolean |
Si se debe habilitar el cifrado SSL para el acceso. Esta configuración se corrige una vez que se crea la instancia.
|
retention_policy |
No |
String |
Acción que debe tomarse cuando el uso de la memoria alcanza el umbral de capacidad del disco. El valor puede ser:
|
connector_enable |
No |
Boolean |
Si se activa el volcado de mensajes. De forma predeterminada, el volcado de mensajes está deshabilitado. |
enable_auto_topic |
No |
Boolean |
Si se debe habilitar la creación automática de temas.
Si está habilitado, se creará automáticamente un tema con 3 particiones y 3 réplicas cuando se crea o se recupera un mensaje de un tema que no existe. El valor predeterminado es false. |
storage_spec_code |
Sí |
String |
Especificación de E/S de almacenamiento. Las especificaciones de E/S de almacenamiento de las especificaciones antiguas y nuevas son diferentes. Seleccione las especificaciones de E/S de almacenamiento correspondientes al crear una instancia. Rango de valores para nuevas especificaciones: - dms.physical.storage.high.v2: E/S alta - dms.physical.storage.ultra.v2: E/S ultra-alta Rango de valores para especificaciones antiguas: - dms.physical.storage.high o dms.physical.storage.ultra cuando specification del parámetro es 100MB - dms.physical.storage.high o dms.physical.storage.ultra cuando specification del parámetro es 300MB - dms.physical.storage.ultra cuando specification del parámetro es 600MB - dms.physical.storage.ultra cuando specification del parámetro es 1200MB Para obtener detalles sobre cómo seleccionar un tipo de disco, consulte "Tipos de disco y rendimiento del disco". |
enterprise_project_id |
No |
String |
ID del proyecto de empresa. Este parámetro es obligatorio para una cuenta de proyecto de empresa. |
tags |
No |
Matriz de objetos TagEntity |
Lista de etiquetas. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
key |
No |
String |
Clave de etiqueta, que puede contener un máximo de 36 caracteres Unicode. La clave no puede dejarse en blanco ni ser una cadena vacía. No puede contener caracteres ASCII no imprimibles (0–31) ni los siguientes caracteres especiales: =*<>,|/ |
value |
No |
String |
Valor de etiqueta, que puede contener un máximo de 43 caracteres Unicode. El valor no se puede dejar en blanco ni ser una cadena vacía. No puede contener caracteres ASCII no imprimibles (0–31) ni los siguientes caracteres especiales: =*<>,|/ |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
|---|---|---|
instance_id |
String |
ID de instancia. |
Solicitudes de ejemplo
{
"name" : "kafka-test",
"description" : "",
"engine" : "kafka",
"engine_version" : "1.1.0",
"storage_space" : 300,
"kafka_manager_user" : "root",
"kafka_manager_password" : "**********",
"vpc_id" : "23921d2a-****-****-****-5f2fa5327a48",
"security_group_id" : "2e888928-****-****-****-e36c6520d473",
"subnet_id" : "37bb12c9-****-****-****-ae8f7d336ab6",
"available_zones" : [ "a0865121f83b41cbafce65930a22a6e8" ],
"product_id" : "00300-30310-0--0",
"maintain_begin" : "22:00",
"maintain_end" : "02:00",
"ssl_enable" : true,
"enable_publicip" : true,
"publicip_id" : "",
"access_user" : "root",
"password" : "**********",
"enterprise_project_id" : "0",
"specification" : "300MB",
"partition_num" : 900,
"retention_policy" : "time_base",
"public_boundwidth" : 3,
"connector_enable" : false,
"enable_auto_topic" : true,
"storage_spec_code" : "dms.physical.storage.ultra",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ]
}
Respuestas de ejemplo
Código de estado: 200
Una instancia se crea correctamente.
{
"instance_id" : "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
}
Códigos de estado
Código de estado |
Descripción |
|---|---|
200 |
Una instancia se crea correctamente. |
Códigos de error
Consulte Códigos de error.
