Creación de una instancia de StarRocks
Función
Esta API se utiliza para crear una instancia de StarRocks. 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/{instance_id}/starrocks
| 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. |
| instance_id | Sí | String | ID de instancia de TaurusDB, que es compatible con el formato UUID. |
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. |
| Content-Type | Sí | String | Tipo de contenido. Valor: application/json |
| X-Language | No | String | Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| name | Sí | String | Nombre de instancia. Las instancias del mismo tipo pueden tener el mismo nombre 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 (_). |
| engine | Sí | engine object | Información del motor. |
| ha | Sí | ha object | Información de despliegue. |
| fe_flavor_id | Sí | String | ID de especificación del nodo frontend. Puede utilizar el valor de id en la respuesta a la consulta de especificaciones HTAP. |
| be_flavor_id | Sí | String | ID de especificación del nodo backend. Puede utilizar el valor de id en la respuesta a la consulta de especificaciones HTAP. |
| db_root_pwd | Sí | String | Contraseña de base de datos. La contraseña debe cumplir los siguientes requisitos:
|
| fe_count | Sí | Integer | Cantidad de nodos frontend.
|
| be_count | Sí | Integer | Cantidad de nodos backend.
|
| az_mode | Sí | String | Tipo de AZ. Actualmente, solo se admite una sola AZ. Valor enumerado: single |
| fe_volume | Sí | fe_volume object | Almacenamiento de información del nodo frontend. |
| be_volume | Sí | be_volume object | Almacenamiento de información del nodo backend. |
| az_code | Sí | String | Código de zona de disponibilidad. |
| time_zone | No | String | Zona horaria. El huso horario predeterminado es UTC+08:00. |
| tags_info | Sí | tags_info object | Información de la etiqueta. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| type | Sí | String | Tipo de motor. Solo se soporta StarRocks. |
| version | Sí | String | Número de versión principal del motor. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| mode | Sí | String | Modo del despliegue. Valores enumerados:
|
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| io_type | Sí | String | Tipo de almacenamiento. El valor se puede obtener de la respuesta a la consulta de recursos del motor HTAP. |
| capacity_in_gb | Sí | Integer | Espacio de almacenamiento en GB. Incremento: 10 GB
|
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| io_type | Sí | String | Tipo de almacenamiento. El valor se puede obtener de la respuesta a la consulta de recursos del motor HTAP. |
| capacity_in_gb | Sí | Integer | Espacio de almacenamiento en GB. Incremento: 10 GB
|
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| sys_tags | Sí | Array of sys_tags objects | Etiquetas del sistema. |
Parámetros de respuesta
Código de estado: 201
| Parámetro | Tipo | Descripción |
|---|---|---|
| instance | instance object | información sobre instancias |
| job_id | String | ID de flujo de trabajo. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de instancia de StarRocks, que es compatible con el formato UUID. |
| az_code | String | Código de zona de disponibilidad. |
| az_mode | String | Tipo de zona de disponibilidad. Valores:
|
| name | String | Nombre de instancia. |
| engine | engine object | Información del motor. |
| vpc_id | String | ID de VPC. |
| security_group_id | String | ID del grupo de seguridad. |
| sub_net_id | String | ID de subred. |
| db_user | String | Usuario de base de datos. El valor predeterminado es root. |
| port | Integer | Número de puerto de la base de datos. El valor predeterminado es 3306. |
| ha_mode | String | Modo del despliegue. |
| pay_info | pay_info object | Información de facturación. |
| enable_ssl | Boolean | Si se debe habilitar SSL. |
| status | String | Estado de la instancia. |
| region | String | Región donde se despliega la instancia. |
| tags_info | tags_info object | Etiquetas de instancia. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| type | String | Tipo de motor. |
| version | String | Número de versión principal del motor. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| pay_model | String | Modo de facturación.
Las instancias de StarRocks solo admiten la facturación de pago por uso. El valor predeterminado es 0. |
| order_id | String | ID de pedido anual/mensual. |
| period | String | Período de suscripción anual/mensual. |
| period_type | String | Tipo de período de suscripción. |
| is_auto_renew | String | Si se debe renovar automáticamente la suscripción anual/mensual. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| tags | Array of tags objects | Etiquetas de usuario. Este parámetro se deja en blanco por defecto. |
| sys_tags | Array of sys_tags objects | Etiquetas del sistema. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| key | String | Clave de etiqueta. |
| value | String | Valor de etiqueta. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| key | String | Clave de etiqueta. |
| value | String | Valor de etiqueta. |
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. |
Ejemplo de la solicitud
Creación de una instancia de BD
POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/40dc4c5729f14aad893e2dcd5baf6a15in07/starrocks
{
"name" : "htap-ff64",
"engine" : {
"type" : "star-rocks",
"version" : "3.1"
},
"ha" : {
"mode" : "Single"
},
"fe_flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
"be_flavor_id" : "de565db8-0a96-37ea-9388-61167624712c",
"db_root_pwd" : "Test@123!",
"fe_count" : 1,
"be_count" : 1,
"az_mode" : "single",
"fe_volume" : {
"io_type" : "SSD",
"capacity_in_gb" : 50
},
"be_volume" : {
"io_type" : "SSD",
"capacity_in_gb" : 50
},
"az_code" : "az",
"time_zone" : "UTC+08:00",
"tags_info" : {
"sys_tags" : [ {
"key" : "_sys_enterprise_project_id",
"value" : "0"
} ]
}
} Ejemplo de la respuesta
Código de estado: 201
Operación exitosa.
{
"instance" : {
"id" : "590031445ef845bb912d7fc8243db80cin17",
"az_code" : "az1",
"az_mode" : "single",
"name" : "htap-ff64",
"engine" : {
"type" : "star-rocks",
"version" : "3.1"
},
"vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
"security_group_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
"sub_net_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
"db_user" : "root",
"port" : 3306,
"ha_mode" : "Single",
"pay_info" : {
"pay_model" : "0",
"order_id" : null,
"period" : null,
"period_type" : null,
"is_auto_renew" : null
},
"enable_ssl" : false,
"status" : "creating",
"region" : "az",
"tags_info" : {
"tags" : [ ],
"sys_tags" : [ {
"key" : "_sys_enterprise_project_id",
"value" : "0"
} ]
}
},
"job_id" : "cf0b7506-1505-450f-9d95-ce9d93b6b5c3"
} 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.