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

Consulta os parâmetros padrão de um cluster de banco de dados.

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:DescribeParameterTemplates

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

Nenhuma

Parâmetros da solicitação

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ParameterCount	string	O número de parâmetros.	183
DBVersion	string	A versão do mecanismo de banco de dados.	5.7
Parameters	object
TemplateRecord	array<object>	Uma lista de parâmetros.
	object
CheckingCode	string	The valid values for the parameter.	[ROW\|STATEMENT\|MIXED]
ParameterName	string	The parameter name.	binlog_format
ParameterValue	string	The default value of the parameter.	ROW
ForceModify	string	Indicates whether the parameter can be modified. Valid values: true: The parameter can be modified. false: The parameter cannot be modified.	true
ForceRestart	string	Indicates whether a restart is required for a new parameter value to take effect. Valid values: true: A restart is required. false: A restart is not required.	false
ParameterDescription	string	The parameter description.	What form of binary logging the master will use.
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: The parameter is a global parameter. The modified parameter value is synchronized to other nodes by default. 1: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value is synchronized.	1
ParamRelyRule	string	The parameter dependencies.	utf8
RequestId	string	O ID da solicitação.	D963934D-8605-4473-8EAC-54C719******
DBType	string	O tipo de mecanismo de banco de dados.	MySQL
Engine	string	O mecanismo de banco de dados.	POLARDB

Exemplos

Resposta de sucesso

JSON formato

{
  "ParameterCount": "183",
  "DBVersion": "5.7",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[ROW|STATEMENT|MIXED]",
        "ParameterName": "binlog_format",
        "ParameterValue": "ROW",
        "ForceModify": "true",
        "ForceRestart": "false",
        "ParameterDescription": "What form of binary logging the master will use.",
        "IsNodeAvailable": "1",
        "ParamRelyRule": "utf8"
      }
    ]
  },
  "RequestId": "D963934D-8605-4473-8EAC-54C719******",
  "DBType": "MySQL",
  "Engine": "POLARDB"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBType.NotFound	The Specified DBType does not found.
400	InvalidDBVersion.Malformed	The Specified DBVersion is not valid.	The specified DBVersion 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.