Creación de una instancia
Esta API está desactualizada y es posible que no se mantenga en el futuro. Utilice la API descrita en Creación de una instancia.
Función
Esta API se utiliza para crear una instancia de pago por uso.
Solicitud.
Parámetros de solicitud
Tabla 2 describe los parámetros.
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
|---|---|---|---|
|
name |
String |
Sí |
Indica el 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 |
String |
No |
Indica la descripción de una instancia. Es una string de caracteres que no contiene más de 1024 caracteres.
NOTA:
La barra invertida (\) y las comillas (") son caracteres especiales para los paquetes JSON. Cuando utilice estos caracteres en un valor de parámetro, agregue el carácter de escape (\) antes de estos caracteres, por ejemplo, \\ Y \". |
|
engine |
String |
Sí |
Indica el motor de mensajes. Establezca el valor en kafka. |
|
engine_version |
String |
Sí |
Indica la versión del motor de mensajes. Valor: 1.1.0 o 2.3.0. |
|
specification |
String |
Sí |
Indica el ancho de banda de línea base de una instancia de Kafka, es decir, la cantidad máxima de datos transferidos por unidad de tiempo. Unidad: MB Opciones:
|
|
storage_space |
Integer |
Sí |
Indica el espacio de almacenamiento del mensaje. Unidad: GB. Rango de valores:
|
|
partition_num |
Integer |
Sí |
Indica el número máximo de particiones en una instancia de Kafka. Opciones:
|
|
access_user |
String |
No |
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. Indica un nombre de usuario. Un nombre de usuario consta de 4 a 64 caracteres y puede contener letras, dígitos y guiones (-). |
|
password |
String |
No |
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. Indica una contraseña de instancia. La contraseña debe cumplir los siguientes requisitos de complejidad:
|
|
vpc_id |
String |
Sí |
Indica el ID de VPC. Obtenga el valor mediante uno de los métodos siguientes:
|
|
security_group_id |
String |
Sí |
Indica el grupo de seguridad al que pertenece la instancia. Obtenga el valor mediante uno de los métodos siguientes:
|
|
subnet_id |
String |
Sí |
Indica el ID de subred. Obtenga el valor mediante uno de los métodos siguientes:
|
|
available_zones |
Array |
Sí |
Indica el ID de la AZ donde residen los corredores y que tiene recursos disponibles. El valor del parámetro no puede ser una matriz vacía o una matriz vacía. Para obtener más información sobre cómo obtener el valor, consulte Consulta de información de AZ. Compruebe si la AZ tiene recursos disponibles. Al crear una instancia de Kafka, puede seleccionar 1 AZ o al menos 3 AZ. Al especificar AZs para los corredores, use comas (,) para separar varias AZs. Ejemplo de parámetros:
|
|
product_id |
String |
Sí |
Indica el ID del producto. Para obtener más información sobre cómo obtener el ID, consulte Consulta de especificaciones de producto. |
|
kafka_manager_user |
String |
Sí |
Indica el nombre de usuario para iniciar sesión en Kafka Manager. El nombre de usuario consta de 4 a 64 caracteres y puede contener letras, dígitos, guiones (-) y guiones bajos (_). |
|
kafka_manager_password |
String |
Sí |
Indica la contraseña para iniciar sesión en Kafka Manager. La contraseña debe cumplir los siguientes requisitos de complejidad:
|
|
maintain_begin |
String |
No |
Indica la hora en la que se inicia una ventana de tiempo de mantenimiento. Formato: HH: mm: ss
|
|
maintain_end |
String |
No |
Indica la hora en la que finaliza una ventana de tiempo de mantenimiento. Formato: HH: mm:ss
|
|
enable_publicip |
Boolean |
No |
Indica si se debe habilitar el acceso público para una instancia.
|
|
public_bandwidth |
String |
No |
Indica el ancho de banda de la red pública. Unidad: Mbit/s Rango de valores:
|
|
publicip_id |
String |
No |
Indica el ID de la dirección IP elástica (EIP) enlazada a una 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 |
Boolean |
No |
Indica si se debe habilitar el acceso cifrado SSL.
|
|
retention_policy |
String |
No |
Indica la acción que se debe realizar cuando el uso de la memoria alcanza el umbral de capacidad del disco. Opciones:
|
|
connector_enable |
Boolean |
No |
Indica si se debe habilitar el dumping. |
|
enable_auto_topic |
Boolean |
No |
Indica si se debe habilitar la creación automática de temas.
Si se habilita la creación automática de temas, se creará automáticamente un tema con 3 particiones y 3 réplicas cuando se produzca o se consuma un mensaje desde un tema que no existe. |
|
storage_spec_code |
String |
Sí |
Indica la especificación de E/S de almacenamiento. Para obtener más información sobre cómo seleccionar un tipo de disco, consulte Tipos de disco y rendimiento de disco. Opciones:
|
|
enterprise_project_id |
String |
No |
Indica el ID del proyecto de empresa. |
|
tags |
Array<Object> |
No |
Indica la lista de etiquetas. |
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
|---|---|---|---|
|
key |
String |
No |
Indica la clave de etiqueta. Una clave de etiqueta puede contener un máximo de 36 caracteres Unicode. La clave no puede dejarse en blanco ni ser una string vacía. No puede contener caracteres ASCII no imprimibles (0–31) y los siguientes caracteres especiales: =*<>\,|/ |
|
value |
String |
No |
Indica el valor. Un valor de etiqueta puede contener un máximo de 43 caracteres Unicode. El valor no se puede dejar en blanco ni ser una string vacía. No puede contener caracteres ASCII no imprimibles (0–31) y los siguientes caracteres especiales: =*<>\,|/ |
{
"name": "kafka-test",
"engine": "kafka",
"engine_version": "2.3.0",
"specification": "100MB",
"storage_space": 600,
"partition_num": 300,
"vpc_id": "b50c1aa7-39e0-420e-936b-ee5d35288f9c",
"security_group_id": "d8c81e0f-de6a-4110-8c96-81af3eacb3d1",
"subnet_id": "0b6cfaea-bce7-48eb-b38d-267c24df5f79",
"available_zones": [
"38b0f7a602344246bcb0da47b5d548e7"
],
"product_id": "00300-30308-0--0",
"kafka_manager_user": "test",
"kafka_manager_password": "Zxxxx",
"enable_publicip": true,
"publicip_id": "87864b85-7097-4c06-9d62-718d7359a503,72c12ba7-fade-4b06-a680-01d335cf786d,11b535df-ed6d-4521-8d00-12bb60beb617",
"storage_spec_code": "dms.physical.storage.high"
}
Respuesta
Parámetros de respuesta
Tabla 4 describe los parámetros.
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
instance_id |
String |
Indica el ID de instancia. |
Ejemplo de respuesta
{
"instance_id": "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"
}
Código de estado
Tabla 5 describe el código de estado de las operaciones exitosas. Para obtener más información sobre el código de estado, consulte Código de estado.
