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/ Distributed Message Service for Kafka/ Referência de API/ APIs desatualizadas/ API V1/ APIs para gerenciamento de instâncias/ Modificação de uma instância

Atualizado em 2024-09-10 GMT+08:00

Ver PDF

Modificação de uma instância

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

Função

Essa API é usada para modificar as informações da instância, incluindo o nome da instância, a descrição, a janela de manutenção e o grupo de segurança.

URI

PUT /v1.0/{project_id}/instances/{instance_id}

**Tabela 1** Parâmetros
Parâmetro	Tipo	Obrigatório	Descrição
project_id	String	Sim	Indica o ID de um projeto.
instance_id	String	Sim	Indica o ID da instância.

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	Não	Indica o nome da instância. Um nome de instância consiste em 4 a 64 caracteres, incluindo letras, dígitos e hifens (-) e deve começar com uma letra.
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 \".
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 será deixado em branco. Nesse caso, o sistema define automaticamente a hora de término para 06:00:00.
security_group_id	String	Não	Indica o ID do grupo de segurança.
retention_policy	String	Não	Indica a política de limite de capacidade. Opções: produce_reject: novas mensagens não podem ser criadas. time_base: as mensagens mais antigas são excluídas.
enterprise_project_id	String	Não	Indica o ID do projeto empresarial.

Exemplos de solicitações

Exemplo 1:

PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
{  
    "name": "dms002",  
    "description": "instance description"  
}

Exemplo 2:

PUT https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}
{ 
     "name": "dms002",   
     "description": "instance description", 
     "maintain_begin":"02:00:00", 
     "maintain_end":"06:00:00" 
}