Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::POLARDB::ParameterGroup

Última atualização: Jun 27, 2026

Cria um modelo de parâmetros para o PolarDB.

Sintaxe

{
  "Type": "ALIYUN::POLARDB::ParameterGroup",
  "Properties": {
    "Parameters": List,
    "DbVersion": String,
    "ResourceGroupId": String,
    "ParameterGroupName": String,
    "ParameterGroupDesc": String,
    "DbType": String
  }
}

Propriedades

Propriedade

Tipo

Obrigatório

Editável

Descrição

Restrição

Parameters

List

Sim

Não

Parâmetros do modelo.

Para mais informações, consulte Propriedades de Parameters.

Nota

Use a operação DescribeParameterTemplates para consultar todos os parâmetros de um cluster em uma versão específica do mecanismo de banco de dados, incluindo nomes e valores válidos.

DbVersion

String

Sim

Não

Versão do mecanismo de banco de dados.

Valores válidos:

  • 5.6

  • 5.7

  • 8.0

ResourceGroupId

String

Não

Não

ID do grupo de recursos.

Nenhuma.

ParameterGroupName

String

Sim

Não

Nome do modelo de parâmetros.

O nome deve atender aos seguintes requisitos:

  • Pode conter letras, dígitos e sublinhados (_). Deve começar com uma letra e não pode terminar com sublinhado (_).

  • Deve ter de 8 a 64 caracteres.

ParameterGroupDesc

String

Não

Não

Descrição do modelo de parâmetros.

A descrição pode ter até 199 caracteres.

DbType

String

Sim

Não

Tipo do mecanismo de banco de dados.

Somente MySQL é compatível.

Sintaxe de Parameters

"Parameters": [
  {
    "ParamValue": String,
    "ParamName": String
  }
]

Propriedades de Parameters

Propriedade

Tipo

Obrigatório

Editável

Descrição

Restrição

ParamValue

String

Sim

Não

Valor do parâmetro.

Nenhuma.

ParamName

String

Sim

Não

Nome do parâmetro.

Nenhuma.

Valores de retorno

Fn::GetAtt

  • Parameters: parâmetros do modelo.

  • ParameterGroupId: ID do modelo de parâmetros.

  • DbVersion: versão do mecanismo de banco de dados.

  • ForceRestart: indica se é necessário reiniciar o cluster para aplicar o modelo de parâmetros.

  • ParameterGroupName: nome do modelo de parâmetros.

  • ParameterGroupDesc: descrição do modelo de parâmetros.

  • ParameterGroupType: tipo do modelo de parâmetros.

  • CreateTime: momento da criação do modelo de parâmetros.

  • ParameterCounts: quantidade de parâmetros no modelo.

  • DbType: tipo do mecanismo de banco de dados.

Exemplos

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      ExtensionResource:
        Type: ALIYUN::POLARDB::ParameterGroup
        Properties:
          Parameters:
            - ParamValue: '86400'
              ParamName: wait_timeout
          DbVersion: '8.0'
          ParameterGroupName: test_group
          ParameterGroupDesc: test_group
          DbType: MySQL
    Outputs:
      Parameters:
        Description: The list of the parameters.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - Parameters
      ParameterGroupId:
        Description: The ID of the parameter group.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterGroupId
      DbVersion:
        Description: The version of the database engine.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - DbVersion
      ForceRestart:
        Description: Indicates whether to restart the cluster when this parameter template is applied.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ForceRestart
      ParameterGroupName:
        Description: The name of the parameter template.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterGroupName
      ParameterGroupDesc:
        Description: The description of the parameter template.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterGroupDesc
      ParameterGroupType:
        Description: The type of the parameter template.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterGroupType
      CreateTime:
        Description: The time when the parameter template was created.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - CreateTime
      ParameterCounts:
        Description: The number of parameters in the parameter template.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - ParameterCounts
      DbType:
        Description: The type of the database engine.
        Value:
          Fn::GetAtt:
            - ExtensionResource
            - DbType
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "ExtensionResource": {
          "Type": "ALIYUN::POLARDB::ParameterGroup",
          "Properties": {
            "Parameters": [
              {
                "ParamValue": "86400",
                "ParamName": "wait_timeout"
              }
            ],
            "DbVersion": "8.0",
            "ParameterGroupName": "test_group",
            "ParameterGroupDesc": "test_group",
            "DbType": "MySQL"
          }
        }
      },
      "Outputs": {
        "Parameters": {
          "Description": "The list of the parameters.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "Parameters"
            ]
          }
        },
        "ParameterGroupId": {
          "Description": "The ID of the parameter group.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterGroupId"
            ]
          }
        },
        "DbVersion": {
          "Description": "The version of the database engine.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "DbVersion"
            ]
          }
        },
        "ForceRestart": {
          "Description": "Indicates whether to restart the cluster when this parameter template is applied.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ForceRestart"
            ]
          }
        },
        "ParameterGroupName": {
          "Description": "The name of the parameter template.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterGroupName"
            ]
          }
        },
        "ParameterGroupDesc": {
          "Description": "The description of the parameter template.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterGroupDesc"
            ]
          }
        },
        "ParameterGroupType": {
          "Description": "The type of the parameter template.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterGroupType"
            ]
          }
        },
        "CreateTime": {
          "Description": "The time when the parameter template was created.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "CreateTime"
            ]
          }
        },
        "ParameterCounts": {
          "Description": "The number of parameters in the parameter template.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "ParameterCounts"
            ]
          }
        },
        "DbType": {
          "Description": "The type of the database engine.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionResource",
              "DbType"
            ]
          }
        }
      }
    }