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

Atualizado em 2025-05-23 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	Explicação: ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. Restrições: Nenhuma Intervalo de valores: O valor pode conter 32 caracteres. Apenas letras e dígitos são permitidos. Valor padrão: Nenhum

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
offset	Não	Integer	Explicação: Deslocamento do índice. A consulta começa a partir da próxima parte dos dados indexados por este parâmetro. Restrições: O valor deve ser um número inteiro e não pode ser um número negativo. Intervalo de valores: ≥0 Valor padrão: 0
limit	Não	Integer	Explicação: Número de registros a serem consultados. Restrições: O valor deve ser um número inteiro e não pode ser um número negativo. Intervalo de valores: 1–100 Valor padrão: 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	Explicação: Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. Restrições: Nenhuma Intervalo de valores: Nenhum Valor padrão: Nenhum
X-Language	Não	String	Explicação: Tipo de linguagem da solicitação. Restrições: Nenhuma Intervalo de valores: en-us zh-cn Valor padrão: en-us

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	Explicação: Informações do modelo de parâmetro.
total_count	Integer	Explicação: Número total de modelos de parâmetros. Intervalo de valores: ≥0

**Tabela 5** ConfigurationSummary
Parâmetro	Tipo	Descrição
id	String	Explicação: ID do modelo de parâmetro. Intervalo de valores: O valor pode conter 36 caracteres, começando com um UUID e terminando com pr07. Apenas letras e dígitos são permitidos.
name	String	Explicação: Nome do modelo de parâmetro. Intervalo de valores: Nenhum
datastore_version_name	String	Explicação: Versão de BD. Intervalo de valores: 8.0
datastore_name	String	Explicação: Nome do banco de dados. Intervalo de valores: GaussDB(for MySQL)
created	String	Explicação: Hora em que o modelo de parâmetro foi criado. O 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. Intervalo de valores: Nenhum
updated	String	Explicação: Hora em que o modelo de parâmetro foi atualizado. O 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. Intervalo de valores: Nenhum
user_defined	Boolean	Explicação: Se o modelo de parâmetro é um modelo personalizado. Intervalo de valores: false: o modelo de parâmetro é um modelo padrão. true: o modelo de parâmetro é um modelo personalizado.
description	String	Explicação: Descrição do modelo de parâmetro. Intervalo de valores: Nenhum

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
  } ]
}