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

文档中心

立即注册

导航

DescribeDBInstanceParameters

最近更新时间：2025.03.25 10:11:37首次发布时间：2025.03.25 10:11:37

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

请求类型

同步请求。

请求参数

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

返回参数

名称	类型	示例值	描述
InstanceId	String	vedbm-gzwdsf9b****	实例 ID。
Parameters	Array of ParameterObject	请参见返回示例。	实例参数列表。关于 Parameters 的详细信息，请参见 ParameterObject。

请求示例

POST /?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20250228T114308Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20250228/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"
            }
         ]
    }
}

错误码

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