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

文档中心

立即注册

导航

DescribeParameterTemplates

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

调用 DescribeParameterTemplates 接口查询参数模板列表。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
TemplateName	String	否	template_test	参数模板名称。
TemplateId	String	否	vedbmpt-5j37992t****	参数模板 ID。
TemplateCategory	String	否	DBEngine	参数模板分类，默认值为 `DBEngine`。
TemplateType	String	否	MySQL	参数模板的数据库类型，默认值为 `MySQL`。
TemplateTypeVersion	String	否	MySQL_8_0	参数模板适用的数据库引擎版本，取值范围： `MySQL_5_7`：MySQL 5.7 版本。 `MySQL_8_0`：MySQL 8.0 版本。
TemplateSource	String	否	User	参数模板的类型。取值： `User`：用户模板。 `System`：系统模板。
PageSize	Integer	是	10	每页记录数。取值范围 1~1000，默认值为 10。
PageNumber	Integer	是	1	页码，取值大于等于 1，且不超过 Integer 的最大值，默认值为 1。

返回参数

名称	类型	示例值	描述
Total	Integer	1	查询返回总数。
TemplateInfos	Array of TemplateInfoObject	请参见返回示例。	参数模板详情信息。关于 TemplateInfos 的详细信息，请参见 TemplateInfoObject。

请求示例

POST /?Action=DescribeParameterTemplates&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****

{
    "TemplateId": "vedbmpt-5j37992t****",
    "PageSize": 10,
    "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025022811260336F1105012D3D74618B5-3063f3",
        "Action": "DescribeParameterTemplates",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "TemplateInfos": [
            {
                "CreateTime": "2025-02-28T02:46:03Z",
                "NeedRestart": false,
                "ParameterNumber": 1,
                "TemplateCategory": "DBEngine",
                "TemplateDescription": "描述",
                "TemplateId": "vedbmpt-5j37992t****",
                "TemplateName": "template_test",
                "TemplateSource": "User",
                "TemplateType": "MySQL",
                "TemplateTypeVersion": "MySQL_8_0",
                "UpdateTime": "2025-02-28T02:46:03Z"
            }
        ],
        "Total": 1
    }
}

错误码

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