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 2023-05-06 GMT+08:00

Alteração da descrição de uma instância

Descrição da API

Essa API é usada para modificar a descrição de uma instância.

Restrições

A descrição das instâncias excluídas não pode ser modificada.

Depuração

Você pode depurar essa API no API Explorer.

URI

  • Formato de URI

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/remark

  • Exemplo de URI

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/remark

Tabela 1 Parâmetros de solicitação

Nome

Tipo

IN

Obrigatório

Descrição

x-auth-token

string

header

Sim

Token do usuário

project_id

string

path

Sim

ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto.

instance_id

string

path

Sim

ID da instância, que pode ser obtido chamando a API descrita em Consulta de instâncias e detalhes. Se você não tiver uma instância, chame a API descrita em Criação de uma instância de banco de dados para criar uma.

Solicitações

  • Descrição do parâmetro
    Tabela 2 Parâmetros de corpo de solicitação

    Parâmetro

    Obrigatório

    Tipo

    Descrição

    remark

    Sim

    String

    Observações de instância

    O comprimento não pode exceder 64 caracteres. O caractere de retorno de carro e os seguintes caracteres especiais não são suportados >!<"&'=

  • Exemplo de solicitação
    {
    "remark":"test"
    }

Respostas

Exemplo de resposta
{}

SDK

Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.

Código de status

Para obter mais informações, consulte Código de status.

Código de erro

Para obter mais informações, consulte Código de erro.