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

Obtém os detalhes de um modelo de parâmetros especificado.

Descrição da operação

Os modelos de parâmetros permitem gerenciar centralmente parâmetros para vários clusters. Você pode aplicar rapidamente um modelo de parâmetros a clusters PolarDB. Para mais informações, consulte Usar modelos de parâmetros.

Nota

Este recurso atualmente suporta apenas clusters 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:DescribeParameterGroup

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 Você pode chamar a operação DescribeRegions para consultar todas as regiões disponíveis e seus IDs em sua conta.	cn-hangzhou
DBType	string	Não	O tipo de mecanismo de banco de dados. Valores válidos: MySQL PostgreSQL Oracle	MySQL
ParameterGroupId	string	Sim	O ID do grupo de parâmetros. Nota Você pode chamar a operação DescribeParameterGroups para consultar os detalhes de todos os grupos de parâmetros na região especificada.	pcpg-**************
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
RequestId	string	O ID da solicitação.	F1F16757-D31B-49CA-9BF4-305BAF******
ParameterGroup	array<object>	Uma lista de modelos de parâmetros.
	array<object>
ParameterDetail	array<object>	Uma lista de parâmetros.
	object
ParamValue	string	The parameter value.	3000
ParamName	string	The parameter name.	back_log
DBVersion	string	A versão do mecanismo de banco de dados.	8.0
ParameterGroupId	string	O ID do modelo de parâmetros.	pcpg-**************
ParameterGroupName	string	O nome do modelo de parâmetros.	test
ForceRestart	string	Especifica se é necessário reiniciar o cluster para que o modelo de parâmetros entre em vigor. Valores válidos: 0: Nenhuma reinicialização é necessária. 1: Uma reinicialização é necessária.	1
ParameterGroupType	string	O tipo do modelo de parâmetros. Valores válidos: 0: modelo padrão 1: modelo personalizado 2: modelo de backup automático. Este tipo de modelo é um backup automático das configurações anteriores, criado quando você aplica um novo modelo.	1
ParameterGroupDesc	string	A descrição do modelo de parâmetros.	testgroup
CreateTime	string	A hora de criação do modelo de parâmetros, no formato `yyyy-MM-ddTHH:mm:ssZ` (UTC).	2023-03-10T08:40:39Z
ParameterCounts	integer	O número de parâmetros no modelo de parâmetros.	2
DBType	string	O tipo de mecanismo de banco de dados.	MySQL

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F1F16757-D31B-49CA-9BF4-305BAF******",
  "ParameterGroup": [
    {
      "ParameterDetail": [
        {
          "ParamValue": "3000",
          "ParamName": "back_log"
        }
      ],
      "DBVersion": "8.0",
      "ParameterGroupId": "pcpg-**************",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterCounts": 2,
      "DBType": "MySQL"
    }
  ]
}

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	InvalidParameterGroupId.Malformed	The Specified parameter ParameterGroupId is not valid.	The specified ParameterGroupId parameter is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.