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.
Atualizado em 2024-09-10 GMT+08:00

Criação de uma instância

Esta API está desatualizada e pode não ser mantida no futuro. Use a API descrita em Criação de uma instância.

Função

Essa API é usada para criar uma instância de pay-per-use.

URI

POST /v1.0/{project_id}/instances

Tabela 1 descreve os parâmetros.

Tabela 1 Parâmetros

Parâmetro

Tipo

Obrigatório

Descrição

project_id

String

Sim

Indica o ID de um projeto.

Solicitação

Parâmetros de solicitação

Tabela 2 descreve os parâmetros.

Tabela 2 Parâmetros de solicitação

Parâmetro

Tipo

Obrigatório

Descrição

name

String

Sim

Indica o nome da instância.

Um nome de instância começa com uma letra, consiste de 4 a 64 caracteres e pode conter apenas letras, dígitos, sublinhados (_) e hifens (-).

description

String

Não

Indica a descrição de uma instância.

É uma cadeia de caracteres que não contém mais de 1024 caracteres.

NOTA:

A barra invertida (\) e aspas (") são caracteres especiais para pacotes JSON. Ao usar esses caracteres em um valor de parâmetro, adicione o caractere de escape (\) antes desses caracteres, por exemplo, \\ e \".

engine

String

Sim

Indica o mecanismo de mensagens. Defina o valor como kafka.

engine_version

String

Sim

Indica a versão do mecanismo de mensagens. Valor: 1.1.0, 2.3.0 ou 2.7.

specification

String

Sim

Indica a largura de banda da linha de base de uma instância do Kafka, ou seja, a quantidade máxima de dados transferidos por unidade de tempo. Unidade: MB

Opções:

  • 100 MB
  • 300 MB
  • 600 MB
  • 1200 MB

storage_space

Integer

Sim

Indica o espaço de armazenamento da mensagem.

Unidade: GB. Intervalo de valores:

  • Instância do Kafka com specification de 100MB: 600–90.000 GB
  • Instância do Kafka com specification de 300MB: 1200–90.000 GB
  • Instância do Kafka com specification de 600MB: 2400–90.000 GB
  • Instância do Kafka com specification de 1200MB: 4800–90.000 GB

partition_num

Integer

Sim

Indica o número máximo de partições em uma instância do Kafka.

Opções:

  • Quando specification for 100MB: 300
  • Quando specification for 300MB: 900
  • Quando specification for 600MB: 1800
  • Quando specification for 1200 MB: 1800

access_user

String

Não

Este parâmetro é obrigatório quando ssl_enable é definido como true. Este parâmetro é inválido quando ssl_enable é definido como false.

Indica um nome de usuário. Um nome de usuário consiste de 4 a 64 caracteres e pode conter letras, dígitos e hifens (-).

password

String

Não

Este parâmetro é obrigatório quando ssl_enable é definido como true. Este parâmetro é inválido quando ssl_enable é definido como false.

Indica uma senha de instância.

A senha deve atender aos seguintes requisitos de complexidade:

  • Deve ser uma cadeia de caracteres com 8 a 32 caracteres.
  • Deve conter pelo menos três dos seguintes tipos de caracteres:
    • Letras minúsculas
    • Letras maiúsculas
    • Dígitos
    • Caracteres especiais `~!@#$%^&*()-_=+\|[{}];:',<.>/?

vpc_id

String

Sim

Indica o ID da VPC.

Obtenha o valor utilizando um dos seguintes métodos:

  • Método 1: faça logon no console da VPC e visualize o ID da VPC nos detalhes da VPC.
  • Método 2: consulte o ID da VPC por meio da API da VPC. Para obter detalhes, consulte Consulta das VPCs.

security_group_id

String

Sim

Indica o grupo de segurança ao qual a instância pertence.

Obtenha o valor utilizando um dos seguintes métodos:

  • Método 1: faça logon no console da VPC. Escolha Access Control > Security Groups no painel de navegação à esquerda. Na página exibida, clique no grupo de segurança de destino. Você pode visualizar o ID do grupo de segurança na página exibida.
  • Método 2: chame a API para consultar grupos de segurança. Para obter detalhes, consulte Consulta dos grupos de segurança.

subnet_id

String

Sim

Indica o ID da sub-rede.

Obtenha o valor utilizando um dos seguintes métodos:

  • Método 1: faça logon no console da VPC e clique na sub-rede de destino na página de guia Subnets. Você pode visualizar o ID da rede na página exibida.
  • Método 2: chame a API para consultar sub-redes. Para obter detalhes, consulte Consulta das sub-redes.

available_zones

Array

Sim

Indica o ID da AZ onde os corretores residem e que tem recursos disponíveis. Esse parâmetro não pode ser uma matriz nula ou uma matriz em branco. Para obter detalhes sobre como obter o valor, consulte Consulta de informações da AZ. Verifique se a AZ tem recursos disponíveis.

Ao criar uma instância do Kafka, você pode selecionar 1 AZ ou pelo menos 3 AZs. Ao especificar as AZs para corretores, use vírgulas (,) para separar várias AZs. Exemplo de configurações de parâmetros:

  • Uma AZ: "available_zones": [ "a0865121f83b41cbafce65930a22a6e8" ]
  • Três ou mais AZs: "available_zones": ["a0865121f83b41cbafce65930a22a6e8","a0865121f83b41cbafce65930a22a6e7","a0865121f83b41cbafce65930a22a6e6"]

product_id

String

Sim

Indica o ID do produto.

Para obter detalhes sobre como obter o ID, consulte Consulta das especificações do produto.

kafka_manager_user

String

Sim

Indica o nome de usuário para fazer logon no Kafka Manager. O nome de usuário consiste de 4 a 64 caracteres e pode conter letras, dígitos, hifens (-) e sublinhados (_).

kafka_manager_password

String

Sim

Indica a senha para efetuar logon no Kafka Manager.

A senha deve atender aos seguintes requisitos de complexidade:

  • Deve ser uma cadeia de caracteres com 8 a 32 caracteres.
  • Deve conter pelo menos três dos seguintes tipos de caracteres:
    • Letras minúsculas
    • Letras maiúsculas
    • Dígitos
    • Caracteres especiais `~!@#$%^&*()-_=+\|[{}];:',<.>/?

maintain_begin

String

Não

Indica a hora em que uma janela de tempo de manutenção é iniciada.

Formato: HH:mm:ss

  • A hora de início e a hora de término da janela de tempo de manutenção devem indicar o segmento de tempo de uma janela de tempo de manutenção suportada. Para obter detalhes sobre como consultar os segmentos de tempo das janelas de tempo de manutenção suportadas, consulte Consultando janelas de tempo de manutenção.
  • A hora de início deve ser definida para 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00 ou 18:00:00.
  • Os parâmetros maintain_begin e maintain_end devem ser definidos em pares. Se o parâmetro maintain_begin for deixado em branco, o parâmetro maintain_end também será deixado em branco. Neste caso, o sistema define automaticamente a hora de início para 02:00:00.

maintain_end

String

Não

Indica a hora em que uma janela de tempo de manutenção termina.

Formato: HH:mm:ss

  • A hora de início e a hora de término da janela de tempo de manutenção devem indicar o segmento de tempo de uma janela de tempo de manutenção suportada. Para obter detalhes sobre como consultar os segmentos de tempo das janelas de tempo de manutenção suportadas, consulte Consultando janelas de tempo de manutenção.
  • A hora de término é quatro horas mais tarde do que a hora de início. Por exemplo, se a hora de início for 22:00:00, a hora de término será 02:00:00.
  • Os parâmetros maintain_begin e maintain_end devem ser definidos em pares. Se o parâmetro maintain_end for deixado em branco, o parâmetro maintain_start também estará em branco. Nesse caso, o sistema define automaticamente a hora de término para 06:00:00.

enable_publicip

Boolean

Não

Indica se deve ativar o acesso público para uma instância.

  • true: ativar
  • false: desativar

public_bandwidth

String

Não

Indica a largura de banda da rede pública. Unidade: Mbit/s

Intervalo de valores:

  • Quando specification é 100MB, o valor deve ser um múltiplo do número de corretores e estar no intervalo de 3 a 900.
  • Quando specification é 300MB, o valor deve ser um múltiplo do número de corretores e estar no intervalo de 3 a 900.
  • Quando specification é 600MB, o valor deve ser um múltiplo do número de corretores e estar no intervalo de 4 a 1200.
  • Quando specification é 1200MB, o valor deve ser um múltiplo do número de corretores e estar no intervalo de 8 a 2400.

publicip_id

String

Não

Indica o ID do endereço IP elástico (EIP) vinculado a uma instância.

Use vírgulas (,) para separar vários IDs de EIP.

Esse parâmetro é obrigatório se o acesso público estiver ativado (ou seja, enable_publicip estiver definido como true).

ssl_enable

Boolean

Não

Indica se deve ativar o acesso criptografado por SSL.

  • true: ativar
  • false: desativar

retention_policy

String

Não

Indica a ação a ser executada quando o uso da memória atingir o limite de capacidade do disco. Opções:

  • time_base: excluir automaticamente as mensagens mais anteriores.
  • produce_reject: parar de produzir novas mensagens

enable_auto_topic

Boolean

Não

Indica se a criação automática de tópicos deve ser ativada.

  • true: ativar
  • false: desativar

Se a criação automática de tópicos estiver ativada, um tópico será criado automaticamente com 3 partições e 3 réplicas quando uma mensagem for produzida ou consumida a partir de um tópico que não existe.

storage_spec_code

String

Sim

Indica a especificação de I/O de armazenamento. Para obter detalhes sobre como selecionar um tipo de disco, consulte Tipos de disco e desempenho.

Opções:

  • dms.physical.storage.high ou dms.physical.storage.ultra quando o parâmetro specification for 100MB
  • dms.physical.storage.high ou dms.physical.storage.ultra quando o parâmetro specification for 300MB
  • dms.physical.storage.ultra quando o parâmetro specification for 600MB
  • dms.physical.storage.ultra quando o parâmetro specification for 1200MB

enterprise_project_id

String

Não

Indica o ID do projeto empresarial.

tags

Array<Object>

Não

Indica a lista de tags.

Tabela 3 tags

Parâmetro

Tipo

Obrigatório

Descrição

key

String

Não

Indica a chave da tag. Uma chave de tag pode conter um máximo de 36 caracteres Unicode.

A chave não pode ser deixada em branco ou ser uma cadeia vazia.

Não pode conter caracteres ASCII (0–31) não imprimíveis e os seguintes caracteres especiais: =*<>\,|/

value

String

Não

Indica o valor. Um valor de tag pode conter no máximo 43 caracteres Unicode.

O valor não pode ser deixado em branco ou ser uma cadeia de caracteres vazia.

Não pode conter caracteres ASCII (0–31) não imprimíveis e os seguintes caracteres especiais: =*<>\,|/

{
 "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"
}

Resposta

Parâmetros de resposta

Tabela 4 descreve os parâmetros.

Tabela 4 Parâmetros de resposta

Parâmetro

Tipo

Descrição

instance_id

String

Indica o ID da instância.

Exemplo de respostas

{  
    "instance_id": "8959ab1c-7n1a-yyb1-a05t-93dfc361b32d"  
}

Código de status

Tabela 5 descreve o código de status das operações bem-sucedidas. Para obter detalhes sobre outros códigos de status, consulte Código de status.

Tabela 5 Código de status

Código de status

Descrição

200

A instância foi criada com sucesso.