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

文档中心

立即注册

导航

ListParameterTemplates

最近更新时间：2025.05.14 11:40:02首次发布时间：2023.08.14 13:15:55

调用 ListParameterTemplates 接口查询 MySQL 实例的参数模板列表。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
TemplateCategory	String	否	DBEngine	模板类别，取值为 `DBEngine`（数据库引擎参数）。
TemplateType	String	否	Mysql	参数模板的数据库类型，默认值为 `Mysql`。
TemplateTypeVersion	String	否	MySQL_5_7	参数模板的数据库版本，取值范围： `MySQL_5_7`：MySQL 5.7 版本。 `MySQL_8_0`：MySQL 8.0 版本。
TemplateSource	String	否	System	参数模板来源，取值范围： `System` ：系统。 `User`：用户。
Limit	Integer	否	10	每页记录数。最小值为 1，最大值不超过 100。默认值为 10。
Offset	Integer	否	0	当前页查询偏移量，取值最小为 0。默认值为 0。
ProjectName	String	否	default	所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
TemplateName	String	否		模板名称

返回参数

参数	类型	示例值	描述
Total	Integer	10	参数模板总数。
TemplateInfos	Object[]	请参见返回示例。	参数模板列表。

示例

请求示例

POST /?Action=ListParameterTemplates&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****
{
    "TemplateSource": "System"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308091938333AE08C8EA08E6091AACA",
        "Action": "ListParameterTemplates",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "TemplateInfos": [
            {
                "AccountId": "0",
                "CreateTime": "2023-11-20 16:51:22",
                "NeedRestart": true,
                "ParameterNum": 203,
                "ProjectName": "",
                "TemplateCategory": "DBEngine",
                "TemplateDesc": "sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async",
                "TemplateId": "mysql-sys-dec1f86e42872d8f",
                "TemplateName": "MySQL_8.0_HighPerformance",
                "TemplateParams": [],
                "TemplateSource": "System",
                "TemplateType": "MySQL",
                "TemplateTypeVersion": "MySQL_8_0",
                "UpdateTime": "2024-01-22 11:22:37"
            },
            {
                "AccountId": "0",
                "CreateTime": "2023-11-20 16:51:22",
                "NeedRestart": true,
                "ParameterNum": 203,
                "ProjectName": "",
                "TemplateCategory": "DBEngine",
                "TemplateDesc": "sync_binlog=1, innodb_flush_log_at_trx_commit=1, async",
                "TemplateId": "mysql-sys-fc06ea5a4b54c301",
                "TemplateName": "MySQL_8.0_Async",
                "TemplateParams": [],
                "TemplateSource": "System",
                "TemplateType": "MySQL",
                "TemplateTypeVersion": "MySQL_8_0",
                "UpdateTime": "2024-01-22 11:22:37"
            }
        ],
        "Total": 2
    }
}

错误码

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