调用DescribeDatabaseInstanceParameters查看轻量数据库实例的参数信息

查看轻量数据库实例的参数信息。

接口说明

如果您需要查看轻量数据库实例的参数的具体信息，可通过此接口查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
swas-open:DescribeDatabaseInstanceParameters		Instance acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	指定的轻量数据库实例所属的地域 ID。您可以调用 ListRegions 查看支持的阿里云地域列表。	cn-hangzhou
DatabaseInstanceId	string	是	轻量数据库实例 ID。	db-38263fa955774501a2ae1bdaed6f****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	30637AD6-D977-4833-A54C-CC89483E****
Engine	string	数据库类型。目前仅支持数据库的类型为 MySQL。	MySQL
EngineVersion	string	数据库版本。可能值： 5.7：MySQL 5.7。 8.0：MySQL 8.0。	5.5
ConfigParameters	array<object>	正在同步的参数列表。修改并提交参数后，需要等待实例同步参数，同步结束后从此列表删除。
	object	正在同步的参数列表。修改并提交参数后，需要等待实例同步参数，同步结束后从此列表删除。
ParameterDescription	string	参数描述信息。	Auto-increment columns are incremented by this
ParameterName	string	参数名称。	auto_increment_increment
ParameterValue	string	参数值。说明不同参数的参数值不同。	1
ForceModify	string	是否支持修改参数值。可能值： true ：支持修改参数值。 false：不支持修改参数值。	true
ForceRestart	string	修改参数是否重启数据库。可能值： true：强制重启（若修改的参数当中，有需要重启的参数，则必须传入 true，否则修改将不生效）。 false：不强制重启。默认值：false。	false
CheckingCode	string	参数值范围。说明不同参数的参数值范围不同。	[1-65535]
RunningParameters	array<object>	运行参数信息。
	object	运行参数信息。
ParameterDescription	string	运行参数描述信息。	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	参数名称。	autocommit
ParameterValue	string	运行参数值。	ON
ForceModify	string	是否支持修改参数值。可能值： true ：支持修改参数值。 false：不支持修改参数值。	true
ForceRestart	string	修改参数是否重启数据库。可能值： true：强制重启（若修改的参数当中，有需要重启的参数，则必须传入 true，否则修改将不生效）。 false：不强制重启。默认值：false。	false
CheckingCode	string	参数值范围。说明不同参数的参数值范围不同。	[ON\|OFF]

示例

正常返回示例

JSON格式

{
  "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]"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史