Plantillas de parámetros de consulta - - Centro de documentación de Alibaba Cloud

Puede llamar a la operación DescribeParameterGroups para consultar las plantillas de parámetros disponibles en una región.

Configure varios parámetros simultáneamente mediante una plantilla de parámetros y, posteriormente, aplique dicha plantilla a las instancias. Para obtener más información, consulte Usar una plantilla de parámetros para configurar los parámetros de instancias de ApsaraDB RDS for MySQL o Usar una plantilla de parámetros para configurar los parámetros de instancias de ApsaraDB RDS for PostgreSQL.

Nota

Las plantillas de parámetros solo se pueden aplicar a instancias de ApsaraDB RDS for MySQL y de ApsaraDB RDS for PostgreSQL.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeParameterGroups	La operación que desea ejecutar. Establezca este parámetro en DescribeParameterGroups.
RegionId	String	Sí	cn-hangzhou	El ID de región de la instancia. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
ResourceGroupId	String	No	rg-acfmy****	El ID del resource group.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
SignalForOptimizeParams	Boolean	false	Indica si existen plantillas de parámetros en la región especificada. Valores válidos: true false
RequestId	String	D4A23265-C5B6-42E1-98A0-EFA1EB42E723	El ID de la solicitud.
ParameterGroups	Array of ParameterGroup		Los detalles de las plantillas de parámetros.
ParameterGroup
UpdateTime	String	2019-11-21T02:21:35Z	La hora de la última actualización de la plantilla de parámetros. La hora sigue el estándar ISO 8601 con el formato yyyy-MM-ddTHH:mm:ssZ y se muestra en UTC.
ParameterGroupDesc	String	1	El tipo de la plantilla de parámetros. Valores válidos: 0: la plantilla de parámetros predeterminada. 1: una plantilla de parámetros personalizada. 2: una plantilla de parámetros de copia de seguridad automática. Al aplicar este tipo de plantilla, el sistema crea automáticamente una copia de seguridad de la configuración original de parámetros y la guarda como plantilla.
CreateTime	String	2019-11-21T01:48:39Z	La hora de creación de la plantilla de parámetros. La hora sigue el estándar ISO 8601 con el formato yyyy-MM-ddTHH:mm:ssZ y se muestra en UTC.
ForceRestart	Integer	1	Indica si es necesario reiniciar la instancia para que la plantilla de parámetros surta efecto. Valores válidos: 0: no es necesario reiniciar. 1: es necesario reiniciar.
ParameterGroupId	String	rpg-****	El ID de la plantilla de parámetros.
ParameterGroupName	String	test1234	El nombre de la plantilla de parámetros.
Engine	String	mysql	El motor de base de datos.
ParamCounts	Integer	2	El número de parámetros en la plantilla de parámetros.
EngineVersion	String	5.7	La versión del motor de base de datos de la instancia.
ParameterGroupType	Integer	1	El tipo de la plantilla de parámetros. Valores válidos: 0: la plantilla de parámetros predeterminada. 1: una plantilla de parámetros personalizada. 2: una plantilla de parámetros de copia de seguridad automática. Al aplicar este tipo de plantilla, el sistema crea automáticamente una copia de seguridad de la configuración original de parámetros y la guarda como plantilla.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Para obtener una lista de códigos de error, visite el Centro de errores de API.