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)/Gerenciamento de instâncias/Alteração de um nome de instância de BD
Atualizado em 2025-05-23 GMT+08:00
Ver PDF
Compartilhar

Alteração de um nome de instância de BD

Função

Essa API é usada para alterar o nome de uma instância de BD. Antes de chamar essa API:

URI

PUT /v3/{project_id}/instances/{instance_id}/name

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, 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. Instâncias do mesmo tipo podem ter os mesmos nomes sob o mesmo locatário.

O nome deve começar com uma letra e consistir de 4 a 64 caracteres. Somente letras (diferenciando maiúsculas de minúsculas), dígitos, hifens (-) e sublinhados (_) são permitidos.

is_modify_node_name

Não

String

Se os nomes de nó devem ser alterados de forma síncrona. O valor pode ser true ou false. O valor padrão é true.

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetro do corpo da resposta

Parâmetro

Tipo

Descrição

job_id

String

ID da tarefa para alterar o nome de uma instância de BD.

Código de status: 400

Tabela 5 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 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.

Exemplo de solicitação

Alteração do nome da instância para gaussdb-name

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name
{
  "name" : "gaussdb-name"
}

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"
}

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.