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

Consulta los parámetros predeterminados de un clúster de base de datos.

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:DescribeParameterTemplates

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBType	string	Sí	El tipo de motor de base de datos. Solo se admite MySQL.	MySQL
DBVersion	string	Sí	La versión de la base de datos. Valores válidos: 5.6 5.7 8.0	5.7
RegionId	string	Sí	El ID de la región. Nota Llame a la operación DescribeRegions para consultar los ID de las regiones disponibles.	cn-hangzhou
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-************

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
ParameterCount	string	El número de parámetros.	183
DBVersion	string	La versión del motor de base de datos.	5.7
Parameters	object
TemplateRecord	array<object>	Una lista de parámetros.
	object
CheckingCode	string	Los valores válidos para el parámetro.	[ROW\|STATEMENT\|MIXED]
ParameterName	string	El nombre del parámetro.	binlog_format
ParameterValue	string	El valor predeterminado del parámetro.	ROW
ForceModify	string	Indica si el parámetro se puede modificar. Valores válidos: true: El parámetro se puede modificar. false: El parámetro no se puede modificar.	true
ForceRestart	string	Indica si es necesario reiniciar para que un nuevo valor de parámetro surta efecto. Valores válidos: true: Es necesario reiniciar. false: No es necesario reiniciar.	false
ParameterDescription	string	La descripción del parámetro.	Qué forma de registro binario utilizará el maestro
IsNodeAvailable	string	Indica si el parámetro es un parámetro global. Valores válidos: 0: El parámetro es un parámetro global. El valor modificado del parámetro se sincroniza con otros nodos de forma predeterminada. 1: El parámetro no es un parámetro global. Puede especificar los nodos con los que se sincroniza el valor modificado del parámetro.	1
ParamRelyRule	string	Las dependencias del parámetro.	utf8
RequestId	string	El ID de la solicitud.	D963934D-8605-4473-8EAC-54C719******
DBType	string	El tipo de motor de base de datos.	MySQL
Engine	string	El motor de base de datos.	POLARDB

Ejemplos

Respuesta exitosa

JSON Formato

{
  "ParameterCount": "183",
  "DBVersion": "5.7",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[ROW|STATEMENT|MIXED]",
        "ParameterName": "binlog_format",
        "ParameterValue": "ROW",
        "ForceModify": "true",
        "ForceRestart": "false",
        "ParameterDescription": "What form of binary logging the master will use.",
        "IsNodeAvailable": "1",
        "ParamRelyRule": "utf8"
      }
    ]
  },
  "RequestId": "D963934D-8605-4473-8EAC-54C719******",
  "DBType": "MySQL",
  "Engine": "POLARDB"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidDBType.NotFound	The Specified DBType does not found.
400	InvalidDBVersion.Malformed	The Specified DBVersion 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.