Consultar valores válidos e padrão de parâmetros - : Central de Documentação do Alibaba Cloud

Chame a operação DescribeParameterTemplates para consultar os valores válidos e padrão dos parâmetros de uma instância.

Antes de chamar esta operação, verifique se a instância utiliza um dos seguintes mecanismos de banco de dados:

MySQL 5.5, MySQL 5.6, MySQL 5.7 ou MySQL 8.0
SQL Server 2008 R2
PostgreSQL 10, PostgreSQL 11, PostgreSQL 12, PostgreSQL 13, PostgreSQL 14 ou PostgreSQL 15
MariaDB 10.3

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para facilitar, recomendamos chamar esta operação no OpenAPI Explorer. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeParameterTemplates	Operação a ser executada. Defina o valor como DescribeParameterTemplates.
ClientToken	String	Não	ETnLKlblzczshOTUbOCz****	Token do cliente usado para garantir a idempotência da solicitação. Gere o valor pelo cliente, mas garanta que o token seja exclusivo entre solicitações diferentes. O token aceita apenas caracteres ASCII e não pode exceder 64 caracteres.
Engine	String	Sim	mysql	Mecanismo de banco de dados da instância. Valores válidos: mysql: MySQL mssql: SQL Server PostgreSQL: PostgreSQL MariaDB: MariaDB
EngineVersion	String	Sim	8,0	Versão do mecanismo de banco de dados da instância. Se Engine for mysql: 5.5, 5.6, 5.7 e 8.0. Se Engine for mssql: 2008r2. Se Engine for PostgreSQL: 10,0, 11,0, 12,0, 13,0, 14,0 e 15,0. Se Engine for MariaDB: 10,3.
Category	String	Não	Basic	Edição do RDS da instância. Valores válidos: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition Finance: RDS Enterprise Edition
RegionId	String	Não	cn-hangzhou	ID da região da instância. Chame a operação DescribeRegions para obter a lista de regiões mais recente.
DBInstanceId	String	Sim	rm-bp1imnm****	ID da instância.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	0F9B7410-EC73-510C-B385-8339455C12C6	ID da solicitação.
Engine	String	mysql	Mecanismo de banco de dados da instância.
ParameterCount	String	2	Número de parâmetros.
EngineVersion	String	8,0	Versão do mecanismo de banco de dados da instância.
Parameters	Array of TemplateRecord		Array com detalhes dos parâmetros.
TemplateRecord
CheckingCode	String	[0-1024]	Valores válidos do parâmetro.
ParameterName	String	loose_multi_blocks_ddl_count	Nome do parâmetro.
ParameterValue	String	0	Valor padrão do parâmetro.
ForceModify	String	true	Indica se o parâmetro permite reconfiguração. Valores válidos: true: Permite reconfiguração. false: Não permite reconfiguração.
ForceRestart	String	false	Indica se é necessário reiniciar a instância para aplicar as modificações. Valores válidos: true: Reinício necessário para aplicar as modificações. false: Reinício desnecessário para aplicar as modificações.
ParameterDescription	String	Page numbers of multi blocks reading once in some ddl query.	Descrição do parâmetro.

Exemplos

Solicitações de exemplo

http(s)://rds.aliyuncs.com/?Action=DescribeParameterTemplates
&ClientToken=ETnLKlblzczshOTUbOCz****
&Engine=mysql
&EngineVersion=8.0
&Category=Basic
&RegionId=cn-hangzhou
&DBInstanceId=rm-bp1imnm****
&Common request parameters

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParameterTemplatesResponse>
    <ParameterCount>2</ParameterCount>
    <EngineVersion>8.0</EngineVersion>
    <Parameters>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[OFF|ON]</CheckingCode>
            <ParameterValue>OFF</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>loose_recycle_scheduler</ParameterName>
            <ParameterDescription>Switch of purge thread.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[0-1024]</CheckingCode>
            <ParameterValue>0</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>loose_multi_blocks_ddl_count</ParameterName>
            <ParameterDescription>Page numbers of multi blocks reading once in some ddl query.</ParameterDescription>
        </TemplateRecord>
    </Parameters>
    <RequestId>0F9B7410-EC73-510C-B385-8339455C12C6</RequestId>
    <Engine>mysql</Engine>
</DescribeParameterTemplatesResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ParameterCount" : 2,
  "EngineVersion" : "8.0",
  "Parameters" : {
    "TemplateRecord" : [ {
      "ForceModify" : "true",
      "CheckingCode" : "[OFF|ON]",
      "ParameterValue" : "OFF",
      "ForceRestart" : "false",
      "ParameterName" : "loose_recycle_scheduler",
      "ParameterDescription" : "Switch of purge thread."
    }, {
      "ForceModify" : "true",
      "CheckingCode" : "[0-1024]",
      "ParameterValue" : "0",
      "ForceRestart" : "false",
      "ParameterName" : "loose_multi_blocks_ddl_count",
      "ParameterDescription" : "Page numbers of multi blocks reading once in some ddl query."
    } ]
  },
  "RequestId" : "0F9B7410-EC73-510C-B385-8339455C12C6",
  "Engine" : "mysql"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.ParamGroupDBCategory	Invalid parameter group category	Categorias de grupos de parâmetros inválidas.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.