DescribeParameterGroups - PolarDB: Central de Documentação do Alibaba Cloud

Consulta os modelos de parâmetros em uma região especificada.

Descrição da operação

Os modelos de parâmetros permitem que você gerencie parâmetros de cluster em lotes e os aplique rapidamente a clusters do PolarDB. Para obter mais informações, consulte Usar modelos de parâmetros.

Nota

Este recurso está disponível apenas para clusters do PolarDB for MySQL.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

polardb:DescribeParameterGroups

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Nota Chame a operação DescribeRegions para consultar as informações sobre todas as regiões disponíveis da sua conta, incluindo os IDs das regiões.	cn-hangzhou
DBType	string	Não	O tipo de mecanismo de banco de dados. Somente o MySQL é compatível.	MySQL
DBVersion	string	Não	A versão do mecanismo de banco de dados. Valores válidos: 5.6 5.7 8.0	8.0
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	944CED46-A6F7-40C6-B6DC-C6E5CC******
ParameterGroups	array<object>	A lista de modelos de parâmetros.
	object
DBType	string	O tipo do mecanismo de banco de dados.	MySQL
DBVersion	string	A versão do mecanismo de banco de dados.	8.0
ParameterGroupName	string	O nome do modelo de parâmetros.	test
ForceRestart	string	Indica se é necessária uma reinicialização do cluster para que o modelo de parâmetros entre em vigor. Valores válidos: 0: Não é necessária uma reinicialização. 1: É necessária uma reinicialização.	1
ParameterGroupType	string	O tipo do modelo de parâmetros. Valores válidos: 0: modelo padrão do sistema 1: modelo definido pelo usuário 2: modelo de backup automático (O sistema faz backup automaticamente das configurações de parâmetros anteriores como um modelo após a aplicação de um novo modelo.)	1
ParameterCounts	integer	O número de parâmetros no modelo de parâmetros.	2
ParameterGroupDesc	string	A descrição do modelo de parâmetros.	testgroup
CreateTime	string	A hora em que o modelo de parâmetros foi criado. A hora está no formato `yyyy-MM-ddTHH:mm:ssZ`. A hora é exibida em UTC.	2023-03-10T08:40:39Z
ParameterGroupId	string	O ID do modelo de parâmetros.	pcpg-**************

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "ParameterGroups": [
    {
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterCounts": 2,
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterGroupId": "pcpg-**************"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	The specified RegionId parameter is invalid.
400	InvalidEngine.Unsupported	The specified Engine does not support this feature.	This feature is not supported by the specified engine.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.