DescribeDatabaseInstanceParameters-阿里云帮助中心

View parameters for a lightweight database instance.

Operation description

This operation retrieves the parameter details of a lightweight database instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

swas-open:DescribeDatabaseInstanceParameters

get

*Instance

acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the lightweight database instance is located. You can call ListRegions to query the most recent region list.	cn-hangzhou
DatabaseInstanceId	string	Yes	The ID of the lightweight database instance.	db-38263fa955774501a2ae1bdaed6f****

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
Engine	string	The database engine. Currently, only `MySQL` is supported.	MySQL
EngineVersion	string	The engine version. Valid values: `5.7`: MySQL 5.7. `8.0`: MySQL 8.0.	5.5
ConfigParameters	array<object>	A list of configuration parameters being synchronized. After you modify and submit parameters, the instance starts to synchronize them. Once synchronization is complete, these parameters are removed from this list.
	object	The details of a configuration parameter that is being synchronized.
ParameterDescription	string	The description of the parameter.	Auto-increment columns are incremented by this
ParameterName	string	The name of the parameter.	auto_increment_increment
ParameterValue	string	The value of the parameter. Note The value varies by parameter.	1
ForceModify	string	Indicates whether you can modify the parameter value. Valid values: `true`: You can modify the parameter value. `false`: You cannot modify the parameter value.	true
ForceRestart	string	Indicates if the database must be restarted for a parameter modification to take effect. Valid values: `true`: A restart is required. To apply changes for a parameter that requires a restart, you must set the `ForceRestart` parameter to `true`. `false`: A restart is not required. Default value: `false`.	false
CheckingCode	string	The value range of the parameter. Note The value range varies by parameter.	[1-65535]
RunningParameters	array<object>	A list of running parameters.
	object	The details of a running parameter.
ParameterDescription	string	The description of the running parameter.	When this variable has a value of 1 (the default), the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine, if the user cannot already execute and alter or drop the routine. (The ALTER ROUTINE privilege is required to drop the routine.) The server also automatically drops those privileges from the creator when the routine is dropped. If automatic_sp_privileges is 0, the server does not automatically add or drop these privileges.
ParameterName	string	The name of the parameter.	autocommit
ParameterValue	string	The value of the running parameter.	ON
ForceModify	string	Indicates whether you can modify the parameter value. Valid values: `true`: You can modify the parameter value. `false`: You cannot modify the parameter value.	true
ForceRestart	string	Indicates if the database must be restarted for a parameter modification to take effect. Valid values: `true`: A restart is required. To apply changes for a parameter that requires a restart, you must set the `ForceRestart` parameter to `true`. `false`: A restart is not required. Default value: `false`.	false
CheckingCode	string	The value range of the parameter. Note The value range varies by parameter.	[ON\|OFF]

Examples

Success response

JSON format

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "Engine": "MySQL",
  "EngineVersion": "5.5",
  "ConfigParameters": [
    {
      "ParameterDescription": "Auto-increment columns are incremented by this",
      "ParameterName": "auto_increment_increment",
      "ParameterValue": "1",
      "ForceModify": "true",
      "ForceRestart": "false",
      "CheckingCode": "[1-65535]"
    }
  ],
  "RunningParameters": [
    {
      "ParameterDescription": "When this variable has a value of 1 (the default), the server automatically grants the EXECUTE and ALTER ROUTINE privileges to the creator of a stored routine, if the user cannot already execute and alter or drop the routine. (The ALTER ROUTINE privilege is required to drop the routine.) The server also automatically drops those privileges from the creator when the routine is dropped. If automatic_sp_privileges is 0, the server does not automatically add or drop these privileges.",
      "ParameterName": "autocommit",
      "ParameterValue": "ON",
      "ForceModify": "true",
      "ForceRestart": "false",
      "CheckingCode": "[ON|OFF]"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.