文档中心

云数据库 MySQL 版

请输入

参数管理

DescribeDBInstanceParameters - 查询实例参数

调用 DescribeDBInstanceParameters 接口查询实例参数。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-h441603c****	实例 ID。
ParameterName	String	否	auto_increment_increment	参数名。
NodeId	String	否	mysql-8baa525f****-mf741-0	查询指定节点的参数设置。说明如不设置该字段，只返回主节点和备节点的参数设置。

返回参数

参数	类型	示例值	描述
InstanceId	String	mysql-h441603c****	实例 ID。
DBEngine	String	Mysql	数据库类型。取值固定为 Mysql。
DBEngineVersion	String	MySQL_8_0	兼容版本。取值： MySQL_5_7：MySQL 5.7。 MySQL_8_0：MySQL 8.0。
ParameterCount	Integer	56	参数个数。
Parameters	Array of InstanceParametersObject	请参见返回示例。	实例当前运行的参数列表。
ApplyParamTemplateInfo	Object of ApplyParamTemplateInfo		参数模板信息

InstanceParametersObject

参数	类型	示例值	描述
ParameterName	String	auto_increment_increment	参数名。
ParameterValue	String	1	参数值。特指当前实例运行值。
CheckingCode	String	[1-65535]	参数取值范围。
ForceRestart	Boolean	false	修改该参数是否需要重启实例。
ParameterDefaultValue	String	1	参数默认值。
ParameterDescription	String	Auto-increment columns are incremented by this.	参数描述的信息。
Expression	String	{MAX(DBInstanceCpu, 2)}	参数的表达式。

ApplyParamTemplateInfo

参数	类型	示例值	描述
TemplateId	String		参数模板ID
TemplateName	String		参数模板名称
TemplateSource	String	System	备份的创建者。取值： System：系统。 User：用户。

示例

请求示例

POST /?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1​
Accept: application/json​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
    "InstanceId": "mysql-8baa525f****",​
    "ParameterName": "auto_increment_increment"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230111141659DE3A3BEFAE571076CBB2",​
        "Action": "DescribeDBInstanceParameters",​
        "Version": "2022-01-01",​
        "Service": "rds_mysql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "ApplyParamTemplateInfo": {​
            "TemplateId": "mysql-8baa525f****",​
            "TemplateName": "Parameters_demo",​
            "TemplateSource": "User"​
        },​
        "DBEngine": "Mysql",​
        "DBEngineVersion": "MySQL_5_7",​
        "InstanceId": "mysql-8baa525f****",​
        "ParameterCount": 1,​
        "Parameters": [​
            {​
                "CheckingCode": "[1-65535]",​
                "ForceRestart": false,​
                "ParameterDefaultValue": "1",​
                "ParameterDescription": "Auto-increment columns are incremented by this.",​
                "ParameterName": "auto_increment_increment",​
                "ParameterValue": "1"​
            }​
        ]​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.05.28 11:52:20

这个页面对您有帮助吗？

有用

无用