Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ TaurusDB/ Referência de API/ APIs (recomendadas)/ HTAP (edição leve)/ Criação de uma instância
Atualizado em 2025-05-23 GMT+08:00
Ver PDF
Compartilhar

Criação de uma instância

Função

Essa API é usada para criar uma instância. Antes de chamar essa API:

URI

POST /v3/{project_id}/instances/{instance_id}/clickhouse

Tabela 1 Parâmetros de URI

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

Tabela 2 Parâmetros de cabeçalho 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.

X-Language

Não

String

Tipo de linguagem da solicitação. O valor padrão é en-us.

Valores:

  • en-us
  • zh-cn
Tabela 3 Parâmetros do corpo da solicitação

Parâmetro

Obrigatório

Tipo

Descrição

name

Sim

String

Nome da instância do ClickHouse. O valor:

  • Consiste de 4 a 64 caracteres.
  • Deve começar com uma letra e pode conter letras, dígitos, hifens (-) e sublinhados (_).
  • Não pode conter outros caracteres especiais.

engine

Sim

ClickHouseEngineInfo object

Informações do mecanismo.

ha

Sim

ha object

Informações de implementação.

flavor_id

Sim

String

ID de especificação do nó. Para obter esse valor, consulte Consulta de especificações de uma instância de HTAP.

db_root_pwd

Sim

String

Senha do usuário root. O valor:

  • Consiste de 8 a 32 caracteres.
  • Deve conter pelo menos três tipos dos seguintes caracteres: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais (~!@#/%^*-_=+?,)

az_mode

Sim

String

Tipo de AZ. Valores:

  • single: AZ única
  • double: várias AZs

volume

Sim

volume object

Especificações de armazenamento.

az_code

Sim

String

Código de AZ.

Se o mode em ha estiver definido como Ha, insira várias AZs e separe-as com vírgulas (,), por exemplo, cn-southwest-244b,cn-southwest-244a.

time_zone

Não

String

Fuso horário. O valor padrão é o fuso horário da instância do TaurusDB.

tags_info

Sim

tags_info object

Valor da tag.

pay_info

Não

pay_info object

Informações de pagamento.
Tabela 4 ClickHouseEngineInfo

Parâmetro

Obrigatório

Tipo

Descrição

type

Sim

String

Tipo de mecanismo de BD. Apenas click-house é suportado.

version

Sim

String

Versão do banco de dados com apenas um dígito. Para obter esse valor, consulte Consulta de recursos do mecanismo HTAP.
Tabela 5 ha

Parâmetro

Obrigatório

Tipo

Descrição

mode

Sim

String

Modo de implementação. Valores:

  • Single: nó único
  • Ha: primário/em espera
Tabela 6 volume

Parâmetro

Obrigatório

Tipo

Descrição

io_type

Sim

String

Tipo de I/O de disco. Valores:

  • SSD: I/O ultra-alta
  • ESSD: SSD extremo

capacity_in_gb

Sim

Integer

Capacidade do disco. Intervalo de valores: 50 GB a 32.000 GB.
Tabela 7 tags_info

Parâmetro

Obrigatório

Tipo

Descrição

sys_tags

Sim

Array of sys_tags objects

Tags do sistema.
Tabela 8 sys_tags

Parâmetro

Obrigatório

Tipo

Descrição

key

Sim

String

Chave da tag.

value

Sim

String

Valor da tag.
Tabela 9 pay_info

Parâmetro

Obrigatório

Tipo

Descrição

pay_model

Não

String

Modo de cobrança. O valor padrão é 0. Valores: Valores:

  • 0: cobrança de pagamento por uso
  • 1: cobrança anual/mensal

order_id

Não

String

ID de pedido anual/mensal.

period

Não

Integer

Período de assinatura anual/mensal.

period_type

Não

Integer

Tipo de período de assinatura. Valores:

  • 2: mensal
  • 3: anual

is_auto_renew

Não

Integer

Se a assinatura anual/mensal deve ser renovada automaticamente. Valores:

  • 1: renovação automática ativada
  • 0: renovação automática desativada

Parâmetros de resposta

Código de status: 202

Tabela 10 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

instance

CreateChInstanceInfo object

Informações da instância de BD.

job_id

String

ID da tarefa.
Tabela 11 CreateChInstanceInfo

Parâmetro

Tipo

Descrição

id

String

ID da instância.

az_code

String

AZ.

az_mode

String

Tipo de AZ. Valores:

  • single: AZ única
  • double: várias AZs

name

String

Nome da instância.

engine

ClickHouseEngineInfo object

Informações do mecanismo.

vpc_id

String

ID de VPC

security_group_id

String

ID do grupo de segurança.

subnet_id

String

ID da sub-rede.

db_user

String

Usuário do banco de dados.

port

Integer

Porta do banco de dados. Intervalo de valores: 0–65535.

ha_mode

String

Modo de implementação. Valores:

  • Single: nó único
  • Ha: primário/em espera

pay_info

pay_info object

Informações de cobrança.

ssl_option

Boolean

Se deve ativar o SSL.

status

String

Status da instância. Valores:

  • creating
  • normal
  • abnormal
  • createfailed
  • deleted

region

String

Região onde a instância é implementada.

tags_info

tags_info object

Tags de instância.
Tabela 12 ClickHouseEngineInfo

Parâmetro

Tipo

Descrição

type

String

Tipo de mecanismo de BD. Apenas click-house é suportado.

version

String

Versão do banco de dados com apenas um dígito. Para obter esse valor, consulte Consulta de recursos do mecanismo HTAP.
Tabela 13 pay_info

Parâmetro

Tipo

Descrição

pay_model

String

Modo de cobrança. O valor padrão é 0. Valores: Valores:

  • 0: cobrança de pagamento por uso
  • 1: cobrança anual/mensal

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. Valores:

  • 2: mensal
  • 3: anual

is_auto_renew

String

Se a assinatura anual/mensal deve ser renovada automaticamente. Valores:

  • 1: renovação automática ativada
  • 0: renovação automática desativada
Tabela 14 tags_info

Parâmetro

Tipo

Descrição

tags

Array of tags objects

Tags do usuário.

sys_tags

Array of sys_tags objects

Tags do sistema.
Tabela 15 tags

Parâmetro

Tipo

Descrição

key

String

Chave da tag.

value

String

Valor da tag.
Tabela 16 sys_tags

Parâmetro

Tipo

Descrição

key

String

Chave da tag.

value

String

Valor da tag.

Código de status: 400

Tabela 17 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 18 Parâmetros do corpo de resposta

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 do ClickHouse

POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/40dc4c5729f14aad893e2dcd5baf6a15in07/clickhouse

{
  "name" : "htap-cfd5",
  "engine" : {
    "type" : "click-house",
    "version" : "1"
  },
  "ha" : {
    "mode" : "Single"
  },
  "flavor_id" : "b44cfde6-d250-313c-8d7a-cd216f071658",
  "db_root_pwd" : "Rds_1234",
  "az_mode" : "single",
  "volume" : {
    "io_type" : "ESSD",
    "capacity_in_gb" : 40
  },
  "az_code" : "cn-southwest-244a",
  "time_zone" : "UTC+08:00",
  "tags_info" : {
    "sys_tags" : [ {
      "key" : "_sys_enterprise_project_id",
      "value" : "0"
    } ]
  }
}

Exemplo de resposta

Código de status: 202

Bem-sucedido.

{
    "instance": {
        "id": "2cdec02d8c4a4c88aecae08684dd8076in16",
        "az_code": "cn-southwest-244a",
        "az_mode": "double",
        "name": "htap-cfd5",
        "engine": {
            "type": "click-house",
            "version": "1"
        },
        "vpc_id": "467f1291-994f-4d3a-9db6-d4c563218df5",
        "security_group_id": "3dc780b1-9d92-4850-9b98-be248e1b5962",
        "subnet_id": "d99cd68c-0067-436d-869e-d32e902d0074",
        "db_user": "root",
        "port": null,
        "ha_mode": "Single"
        "pay_info": {
            "pay_model": "0",
            "order_id": null,
            "period": null,
            "period_type": null,
            "is_auto_renew": null,
        },
        "ssl_option": false,      
        "status": "creating",
        "region": "cn-southwest-244",
        "tags_info": {
            "tags": [],
            "sys_tags": [
                {
                    "key": "_sys_enterprise_project_id",
                    "value": "0"
                }
            ]
        }
    },
    "job_id": "76078f0b-5162-45c8-b95f-4c1afd37536c",
}

Código de status

Código de status

Descrição

202

Bem-sucedido.

400

Erro do cliente.

500

Erro no servidor.

Código de erro

Para obter detalhes, consulte Códigos de erro.

Tópico principal: HTAP (edição leve)