DescribeParameters - ApsaraDB RDS - Centro de documentación de Alibaba Cloud

Consulta la configuración de parámetros de una instancia.

Descripción de la operación

Motores compatibles

MySQL
PostgreSQL
SQL Server
MariaDB

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

rds:DescribeParameters

get

*DBInstance.

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero debe asegurarse de que el token sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede superar los 64 caracteres de longitud.	ETnLKlblzczshOTUbOCz****
DBInstanceId	string	Sí	El ID de la instancia. Puede llamar a la operación DescribeDBInstances para consultar el ID de la instancia.	rm-uf6wjk5****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
ConfigParameters	object
DBInstanceParameter	array<object>	La lista de parámetros que se están sincronizando. Nota Después de modificar y enviar los parámetros, debe esperar a que se sincronicen con la instancia. Una vez completada la sincronización, puede eliminar los parámetros de la lista.
	object
ParameterDescription	string	La descripción del parámetro.	La cantidad en bytes en la que se debe aumentar un pool de memoria por transacción que requiere memoria. Consulte la descripción de transaction_prealloc_size
ParameterName	string	El nombre del parámetro.	transaction_alloc_block_size
ParameterValue	string	El valor del parámetro.	8192
Engine	string	El tipo de motor de base de datos.	MySQL
EngineVersion	string	La versión del motor de base de datos.	8.0
ParamGroupInfo	object	La información sobre la plantilla de parámetros.
ParamGroupId	string	El ID de la plantilla de parámetros.	rpg-sys-01040401010200
ParameterGroupDesc	string	La descripción de la plantilla de parámetros.	sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async
ParameterGroupName	string	El nombre de la plantilla de parámetros.	mysql_innodb_8.0_basic_normal_high
ParameterGroupType	string	El tipo de plantilla de parámetros.	0
RequestId	string	El ID de la solicitud.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
RunningParameters	object
DBInstanceParameter	array<object>	Los parámetros que están en uso.
	object	Los detalles del parámetro que está en uso.
ParameterDefaultValue	string	El valor predeterminado del parámetro.	100
ParameterDescription	string	La descripción del parámetro.	La cantidad en bytes en la que se debe aumentar un pool de memoria por transacción que requiere memoria. Consulte la descripción de transaction_prealloc_size
ParameterName	string	El nombre del parámetro.	transaction_alloc_block_size
ParameterValue	string	El valor del parámetro.	1024
ParameterValueRange	string	Los valores válidos del parámetro.	1~100

Ejemplos

Respuesta exitosa

JSON Formato

{
  "ConfigParameters": {
    "DBInstanceParameter": [
      {
        "ParameterDescription": "La cantidad en bytes en la que se incrementa un pool de memoria por transacción que requiere memoria. Consulte la descripción de transaction_prealloc_size",
        "ParameterName": "transaction_alloc_block_size",
        "ParameterValue": "8192"
      }
    ]
  },
  "Engine": "MySQL",
  "EngineVersion": "8.0",
  "ParamGroupInfo": {
    "ParamGroupId": "rpg-sys-01040401010200",
    "ParameterGroupDesc": "sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async",
    "ParameterGroupName": "mysql_innodb_8.0_basic_normal_high",
    "ParameterGroupType": "0"
  },
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "RunningParameters": {
    "DBInstanceParameter": [
      {
        "ParameterDefaultValue": "100",
        "ParameterDescription": "La cantidad en bytes en la que se incrementa un pool de memoria por transacción que requiere memoria. Consulte la descripción de transaction_prealloc_size",
        "ParameterName": "transaction_alloc_block_size",
        "ParameterValue": "1024",
        "ParameterValueRange": "1~100"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
400	ConcurrentLimit	The request processing has been concurrent limit.
400	DbossGeneralError	The instance is being created. Please wait.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.
408	NetworkOrSqlTimeoutError	Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.

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.