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/ GaussDB(for MySQL)/ Referência de API/ APIs (recomendadas)/ Gerenciamento de banco de dados/ Modificação de observações do banco de dados
Atualizado em 2024-09-29 GMT+08:00
Ver PDF
Compartilhar

Modificação de observações do banco de dados

Função

Esta API é usada para modificar observações de banco de dados de uma instância do GaussDB(for MySQL). Antes de chamar essa API:

URI

PUT /v3/{project_id}/instances/{instance_id}/databases/comment

Tabela 1 Parâmetros de URI

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto de um locatário em uma região.

Para obter esse valor, consulte Obtenção de um ID de projeto.

instance_id

Sim

String

ID da instância.

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.

Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida.

Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token.

X-Language

Não

String

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

Valor:

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

Parâmetro

Obrigatório

Tipo

Descrição

databases

Sim

Array of Tabela 4 objects

Lista de bancos de dados para os quais você deseja alterar as observações. A lista contém até 50 bancos de dados.
Tabela 4 UpdateDatabaseComment

Parâmetro

Obrigatório

Tipo

Descrição

name

Sim

String

Nome do banco de dados.

comment

Sim

String

Observações do banco de dados.

Valor:

O valor pode consistir em até 512 caracteres e não pode conter os caracteres de retorno de carro ou caracteres especiais (!<"='>&).

Parâmetros de resposta

Código de status: 202

Tabela 5 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

job_id

String

ID da tarefa para alterar as observações do banco de dados.

Código de status: 400

Tabela 6 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 7 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

Modificação de observações do banco de dados

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases/comment 
 
{ 
  "databases" : [ { 
    "name" : "gaussdb_mysql_user1", 
    "comment" : "first_database" 
  } ] 
}

Exemplo de resposta

Código de status: 202

Bem-sucedido.

{ 
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d" 
}

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.

Tópico principal: Gerenciamento de banco de dados