DescribeDBInstanceParameters--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceParameters

最近更新时间：2024.11.05 16:00:06首次发布时间：2023.02.02 17:41:22

调用 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	Object[]	请参见返回示例。	实例当前运行的参数列表。

示例

请求示例

POST /?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.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": {
        "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"
            }
        ]
    }
}

错误码

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