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 modelo de parâmetro/ Obtenção de informações de parâmetro de uma instância de banco de dados especificada

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

Ver PDF

Obtenção de informações de parâmetro de uma instância de banco de dados especificada

Função

Essa API é usada para obter informações de parâmetros de uma instância de banco de dados especificada. Antes de chamar essa API:

Saiba como autorizá-la e autenticá-la.
Obtenha a região e o ponto de extremidade necessários.

URI

GET /v3/{project_id}/instances/{instance_id}/configurations

**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.

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
offset	Não	Integer	Deslocamento do índice. Se offset for definido como N, a consulta de recursos será iniciada a partir da parte N+1 dos dados. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor não pode ser um número negativo.
limit	Não	Integer	Número de registros a serem consultados. O valor padrão é 100. o valor deve ser um número inteiro positivo. O valor mínimo é 1 e o valor máximo é 100.

Parâmetros de solicitação

**Tabela 3** 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

Parâmetros de resposta

Código de status: 200

**Tabela 4** Parâmetros do corpo de resposta
Parâmetro	Tipo	Descrição
configurations	ParameterConfigurationInfo object	Informações do parâmetro.
total_count	Long	Número total de parâmetros.
parameter_values	Array of ParameterValuesInfo objects	Objeto de parâmetro.

**Tabela 5** ParameterConfigurationInfo
Parâmetro	Tipo	Descrição
datastore_version_name	String	Nome da versão do BD.
datastore_name	String	Nome do banco de dados.
created	String	Tempo de criação no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.
updated	String	Hora de atualização no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

**Tabela 6** ParameterValuesInfo
Parâmetro	Tipo	Descrição
name	String	Nome do parâmetro.
value	String	Valor do parâmetro.
restart_required	Boolean	Se a instância precisa ser reinicializada. false: a instância não precisa ser reinicializada. true: a instância precisa ser reinicializada.
readonly	Boolean	Se a instância é somente leitura false: a instância é somente leitura. true: a instância não é somente leitura.
value_range	String	Intervalo de valores do parâmetro. Se o tipo de parâmetro for integer, o valor será 0 ou 1. Se o tipo de parâmetro for boolean, o valor será true ou false.
type	String	Tipo de parâmetro. string integer boolean list float
description	String	Descrição do parâmetro.

Código de status: 400

**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.

Código de status: 500

**Tabela 8** 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

Obtenção de informações de parâmetro de uma instância de banco de dados especificada

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/configurations

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "configurations" : {
    "datastore_version_name" : 2.0,
    "datastore_name" : "taurus",
    "created" : "2022-10-29T09:38:36+0000",
    "updated" : "2022-10-29T09:38:36+0000"
  },
  "total_count" : 125,
  "parameter_values" : [ {
    "name" : "auto_increment_increment",
    "value" : 1,
    "restart_required" : false,
    "readonly" : false,
    "value_range" : "1-65535",
    "type" : "integer",
...."description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
  }, {
    "name" : "auto_increment_offset",
    "value" : 1,
    "restart_required" : false,
    "readonly" : false,
    "value_range" : "1-65535",
    "type" : "integer",
...."description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column.
  } ]
}