Criação de uma instância do StarRocks
Função
Essa API é usada para criar uma instância do StarRocks. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
POST /v3/{project_id}/instances/{instance_id}/starrocks
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
instance_id |
Sim |
String |
ID da instância do TaurusDB, que é compatível com o formato UUID. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Para obter esse valor, chame a API do IAM para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. |
Content-Type |
Sim |
String |
Tipo de conteúdo. Valor: application/json |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Sim |
String |
Nome da instância. Instâncias do mesmo tipo podem ter o mesmo nome sob o mesmo locatário. O nome deve começar com uma letra e consistir de 4 a 64 caracteres. Somente letras (diferenciando maiúsculas de minúsculas), dígitos, hifens (-) e sublinhados (_) são permitidos. |
engine |
Sim |
engine object |
Informações do mecanismo. |
ha |
Sim |
ha object |
Informações de implementação. |
fe_flavor_id |
Sim |
String |
ID de especificação do nó de front-end. Você pode usar o valor de id na resposta à consulta das especificações de HTAP. |
be_flavor_id |
Sim |
String |
ID de especificação do nó de back-end. Você pode usar o valor de id na resposta à consulta das especificações de HTAP. |
db_root_pwd |
Sim |
String |
Senha do banco de dados. A senha deve atender aos seguintes requisitos:
|
fe_count |
Sim |
Integer |
Número de nós de front-end.
|
be_count |
Sim |
Integer |
Número de nós de back-end.
|
az_mode |
Sim |
String |
Tipo de AZ. Atualmente, apenas uma única AZ é suportada. Valor enumerado: single |
fe_volume |
Sim |
fe_volume object |
Informações de armazenamento do nó de front-end. |
be_volume |
Sim |
be_volume object |
Informações de armazenamento do nó de back-end. |
az_code |
Sim |
String |
Código de AZ. |
time_zone |
Não |
String |
Fuso horário. O fuso horário padrão é UTC+08:00. |
tags_info |
Sim |
tags_info object |
Informações de tag. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
type |
Sim |
String |
Tipo de mecanismo. Apenas o StarRocks é suportado. |
version |
Sim |
String |
Número da versão principal do mecanismo. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
mode |
Sim |
String |
Modo de implementação. Valores enumerados:
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
io_type |
Sim |
String |
Tipo de armazenamento. O valor pode ser obtido a partir da resposta à consulta de recursos do mecanismo HTAP. |
capacity_in_gb |
Sim |
Integer |
Espaço de armazenamento em GB. Incremento: 10 GB
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
io_type |
Sim |
String |
Tipo de armazenamento. O valor pode ser obtido a partir da resposta à consulta de recursos do mecanismo HTAP. |
capacity_in_gb |
Sim |
Integer |
Espaço de armazenamento em GB. Incremento: 10 GB
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
sys_tags |
Sim |
Array of sys_tags objects |
Tags do sistema. |
Parâmetros de resposta
Código de status: 201
Parâmetro |
Tipo |
Descrição |
---|---|---|
instance |
instance object |
Informações da instância. |
job_id |
String |
ID do fluxo de trabalho. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da instância do StarRocks, que é compatível com o formato UUID. |
az_code |
String |
Código de AZ. |
az_mode |
String |
Tipo de AZ. Valores:
|
name |
String |
Nome da instância. |
engine |
engine object |
Informações do mecanismo. |
vpc_id |
String |
ID de VPC |
security_group_id |
String |
ID do grupo de segurança. |
sub_net_id |
String |
ID da sub-rede. |
db_user |
String |
Usuário do banco de dados. O valor padrão é root. |
port |
Integer |
Número da porta do banco de dados. O valor padrão é 3306. |
ha_mode |
String |
Modo de implementação. |
pay_info |
pay_info object |
Informações de cobrança. |
enable_ssl |
Boolean |
Se deve ativar o SSL. |
status |
String |
Status da instância. |
region |
String |
Região onde a instância é implementada. |
tags_info |
tags_info object |
Tags de instância. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
type |
String |
Tipo de mecanismo. |
version |
String |
Número da versão principal do mecanismo. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
pay_model |
String |
Modo de cobrança.
As instâncias do StarRocks suportam apenas a cobrança de pagamento por uso. O valor padrão é 0. |
order_id |
String |
ID de pedido anual/mensal. |
period |
String |
Período de assinatura anual/mensal. |
period_type |
String |
Tipo de período de assinatura. |
is_auto_renew |
String |
Se a assinatura anual/mensal deve ser renovada automaticamente. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
tags |
Array of tags objects |
Tags do usuário. Este parâmetro é deixado em branco por padrão. |
sys_tags |
Array of sys_tags objects |
Tags do sistema. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Criação de uma instância 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" } ] } }
Exemplo de resposta
Código de status: 201
Bem-sucedido.
{ "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 status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.