Todos os produtos
Search
Central de documentação

:Modelos de parâmetros de consulta

Última atualização: Jun 29, 2026

Chame a operação DescribeParameterGroups para consultar modelos de parâmetros disponíveis em uma região.

Use um modelo de parâmetros para configurar vários parâmetros simultaneamente e aplique-o às instâncias. Para mais informações, consulte Usar um modelo de parâmetros para configurar os parâmetros de instâncias do ApsaraDB RDS for MySQL ou Usar um modelo de parâmetros para configurar os parâmetros de instâncias do ApsaraDB RDS for PostgreSQL.

Nota

Modelos de parâmetros são compatíveis apenas com instâncias do ApsaraDB RDS for MySQL e do ApsaraDB RDS for PostgreSQL.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que 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

DescribeParameterGroups

Operação a ser executada. Defina este parâmetro como DescribeParameterGroups.

RegionId

String

Sim

cn-hangzhou

ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

ResourceGroupId

String

Não

rg-acfmy****

ID do grupo de recursos.

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
SignalForOptimizeParams Boolean false

Indica se existem modelos de parâmetros na região especificada. Valores válidos:

  • true
  • false
RequestId String D4A23265-C5B6-42E1-98A0-EFA1EB42E723

ID da solicitação.

ParameterGroups Array of ParameterGroup

Detalhes dos modelos de parâmetros.

ParameterGroup
UpdateTime String 2019-11-21T02:21:35Z

Hora da última atualização do modelo de parâmetros. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibida em UTC.

ParameterGroupDesc String 1

Tipo do modelo de parâmetros. Valores válidos:

  • 0: modelo de parâmetros padrão.
  • 1: modelo de parâmetros personalizado.
  • 2: modelo de parâmetros de backup automático. Ao aplicar esse tipo de modelo, o sistema faz backup automático das configurações originais de parâmetros e o salva como um modelo.
CreateTime String 2019-11-21T01:48:39Z

Hora de criação do modelo de parâmetros. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibida em UTC.

ForceRestart Integer 1

Indica se é necessário reiniciar a instância para que o modelo de parâmetros entre em vigor. Valores válidos:

  • 0: reinicialização não necessária.
  • 1: reinicialização necessária.
ParameterGroupId String rpg-****

ID do modelo de parâmetros.

ParameterGroupName String test1234

Nome do modelo de parâmetros.

Engine String mysql

Mecanismo de banco de dados.

ParamCounts Integer 2

Quantidade de parâmetros no modelo de parâmetros.

EngineVersion String 5.7

Versão do mecanismo de banco de dados da instância.

ParameterGroupType Integer 1

Tipo do modelo de parâmetros. Valores válidos:

  • 0: modelo de parâmetros padrão.
  • 1: modelo de parâmetros personalizado.
  • 2: modelo de parâmetros de backup automático. Ao aplicar esse tipo de modelo, o sistema faz backup automático das configurações originais de parâmetros e o salva como um modelo.

Exemplos

Solicitações de exemplo

http(s)://rds.aliyuncs.com/?Action=DescribeParameterGroups
&RegionId=cn-hangzhou
&Common request parameters

Respostas de sucesso de exemplo

Formato XML

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

<DescribeParameterGroupsResponse>
    <SignalForOptimizeParams>false</SignalForOptimizeParams>
    <RequestId>D4A23265-C5B6-42E1-98A0-EFA1EB42E723</RequestId>
    <ParameterGroups>
        <UpdateTime>2019-11-21T02:21:35Z</UpdateTime>
        <ParameterGroupDesc>1</ParameterGroupDesc>
        <CreateTime>2019-11-21T01:48:39Z</CreateTime>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupId>rpg-****</ParameterGroupId>
        <ParameterGroupName>test1234</ParameterGroupName>
        <Engine>mysql</Engine>
        <ParamCounts>2</ParamCounts>
        <EngineVersion>5.7</EngineVersion>
        <ParameterGroupType>1</ParameterGroupType>
    </ParameterGroups>
</DescribeParameterGroupsResponse>

Formato JSON

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

{
  "SignalForOptimizeParams" : false,
  "RequestId" : "D4A23265-C5B6-42E1-98A0-EFA1EB42E723",
  "ParameterGroups" : [ {
    "UpdateTime" : "2019-11-21T02:21:35Z",
    "ParameterGroupDesc" : "1",
    "CreateTime" : "2019-11-21T01:48:39Z",
    "ForceRestart" : 1,
    "ParameterGroupId" : "rpg-****",
    "ParameterGroupName" : "test1234",
    "Engine" : "mysql",
    "ParamCounts" : 2,
    "EngineVersion" : "5.7",
    "ParameterGroupType" : 1
  } ]
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros de API.