DescribeParameterGroup - PolarDB - Centro de documentación de Alibaba Cloud

Obtiene los detalles de una plantilla de parámetros especificada.

Descripción de la operación

Las plantillas de parámetros permiten administrar de forma centralizada los parámetros de múltiples clústeres. Puede aplicar rápidamente una plantilla de parámetros a clústeres de PolarDB. Para obtener más información, consulte Uso de plantillas de parámetros.

Nota

Esta función actualmente solo es compatible con clústeres de PolarDB for MySQL.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

polardb:DescribeParameterGroup

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Nota Puede llamar a la operación DescribeRegions para consultar todas las regiones disponibles y sus ID en su cuenta.	cn-hangzhou
DBType	string	No	El tipo de motor de base de datos. Valores válidos: MySQL PostgreSQL Oracle	MySQL
ParameterGroupId	string	Sí	El ID del grupo de parámetros. Nota Puede llamar a la operación DescribeParameterGroups para consultar los detalles de todos los grupos de parámetros en la región especificada.	pcpg-**************
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-************

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.
RequestId	string	El ID de la solicitud.	F1F16757-D31B-49CA-9BF4-305BAF******
ParameterGroup	array<object>	Una lista de plantillas de parámetros.
	array<object>
ParameterDetail	array<object>	Una lista de parámetros.
	object
ParamValue	string	El valor del parámetro.	3000
ParamName	string	El nombre del parámetro.	back_log
DBVersion	string	La versión del motor de base de datos.	8.0
ParameterGroupId	string	El ID de la plantilla de parámetros.	pcpg-**************
ParameterGroupName	string	El nombre de la plantilla de parámetros.	test
ForceRestart	string	Especifica si se requiere reiniciar el clúster para que la plantilla de parámetros surta efecto. Valores válidos: 0: No se requiere reinicio. 1: Se requiere reinicio.	1
ParameterGroupType	string	El tipo de la plantilla de parámetros. Valores válidos: 0: plantilla predeterminada 1: plantilla personalizada 2: plantilla de respaldo automático. Este tipo de plantilla es un respaldo automático de la configuración anterior, que se crea cuando aplica una nueva plantilla.	1
ParameterGroupDesc	string	La descripción de la plantilla de parámetros.	testgroup
CreateTime	string	La hora de creación de la plantilla de parámetros, en formato `yyyy-MM-ddTHH:mm:ssZ` (UTC).	2023-03-10T08:40:39Z
ParameterCounts	integer	El número de parámetros en la plantilla de parámetros.	2
DBType	string	El tipo de motor de base de datos.	MySQL

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "F1F16757-D31B-49CA-9BF4-305BAF******",
  "ParameterGroup": [
    {
      "ParameterDetail": [
        {
          "ParamValue": "3000",
          "ParamName": "back_log"
        }
      ],
      "DBVersion": "8.0",
      "ParameterGroupId": "pcpg-**************",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterCounts": 2,
      "DBType": "MySQL"
    }
  ]
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.
400	InvalidParameterGroupId.Malformed	The Specified parameter ParameterGroupId is not valid.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.