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/ Consulta de modelos de parâmetros

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

Ver PDF

Consulta de modelos de parâmetros

Função

Essa API é usada para consultar modelos de parâmetros, incluindo todos os modelos de parâmetros padrão e personalizados dos bancos de dados. 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}/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.

**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	Array of ConfigurationSummary objects	Informações do modelo de parâmetro.
total_count	Integer	Número total de modelos de parâmetros.

**Tabela 5** ConfigurationSummary
Parâmetro	Tipo	Descrição
id	String	ID do modelo de parâmetro.
name	String	Nome do modelo de parâmetro.
description	String	Descrição do modelo de parâmetro.
datastore_version_name	String	Versão de 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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.
user_defined	Boolean	Se o modelo de parâmetro é um modelo personalizado. Valor: false: o modelo de parâmetro é um modelo padrão. true: o modelo de parâmetro é um modelo personalizado.

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

Consulta de modelos de parâmetros

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/configurations

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "total_count" : 1,
  "configurations" : [ {
    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07",
    "name" : "configuration_test",
    "description" : "configuration_test",
    "datastore_version_name" : "8.0",
    "datastore_name" : "GaussDB(for MySQL)",
    "created" : "2019-05-15T11:53:34+0000",
    "updated" : "2019-05-15T11:53:34+0000",
    "user_defined" : true
  }, {
    "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr07",
    "name" : "Default-GaussDBforMySQL",
    "description" : "Default parameter template for GaussDBforMySQL",
    "datastore_version_name" : "8.0",
    "datastore_name" : "GaussDB(for MySQL)",
    "created" : "2019-05-27T03:38:51+0000",
    "updated" : "2019-05-27T03:38:51+0000",
    "user_defined" : false
  } ]
}