文档中心

云数据库 veDB MySQL 版

参数管理

DescribeDBInstanceParameters - 查询实例参数

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

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-gzwdsf9b****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。

返回参数

参数	类型	示例值	描述
InstanceId	String	vedbm-gzwdsf9b****	实例 ID。
Parameters	Array of ParameterObject	请参见返回示例。	实例参数列表。

ParameterObject

参数	类型	示例值	描述
ParameterName	String	auto_increment_increment	参数名称。
ParameterValue	String	1	参数运行值。
ParameterDisplayValue	String	1	参数展示值，若目标参数值设置为表达式，则此处展示表达式计算后得到的实际运行值。
CheckingCode	String	[1-65535]	参数取值范围。
NeedRestart	Boolean	false	修改该参数是否需要重启实例。
ParameterDefaultValue	String	1	参数默认值。
ParameterDescription	String	Auto-increment columns are incremented by this	参数描述的信息。
Modifiable	Boolean	true	参数是否可修改。
Status	String	Applied	参数状态，取值： Applied：已生效。 Syncing：正在修改中，尚未生效。
DataType	String	INT	参数的数据类型。取值： INT：整数。 FLOAT：浮点数。 STRING：字符串。

示例

请求示例

POST /?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host:vedbm.cn-beijing.volcengineapi.com​
X-Date: 20220101T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
    "InstanceId": "vedbm-gzwdsf9b****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2025021216380940A3519600F9A7798F0E-9be055",​
        "Action": "DescribeDBInstanceParameters",​
        "Version": "2022-01-01",​
        "Service": "vedbm",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "InstanceId": "vedbm-gzwdsf9b****",​
        "Parameters": [​
            {​
                "CheckingCode": "[1-65535]",​
                "DataType": "INT",​
                "Modifiable": true,​
                "NeedRestart": false,​
                "ParameterDefaultValue": "1",​
                "ParameterDescription": "Auto-increment columns are incremented by this",​
                "ParameterDisplayValue": "4",​
                "ParameterName": "auto_increment_increment",​
                "ParameterValue": "4",​
                "Status": "Applied"​
            },​
            {​
                "CheckingCode": "[1-65535]",​
                "DataType": "INT",​
                "Modifiable": true,​
                "NeedRestart": false,​
                "ParameterDefaultValue": "1",​
                "ParameterDescription": "Offset added to Auto-increment columns. Used when auto-increment-increment != 1",​
                "ParameterDisplayValue": "3",​
                "ParameterName": "auto_increment_offset",​
                "ParameterValue": "3",​
                "Status": "Applied"​
            }​
        ]​
    }​
}​

错误码

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

最近更新时间：2026.02.25 13:20:56

这个页面对您有帮助吗？

有用

无用