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

文档中心

立即注册

导航

DescribeParameterTemplateDetail

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

调用 DescribeParameterTemplateDetail 接口查询参数模板详情。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
TemplateId	String	是	vedbmpt-5j37992t****	参数模板 ID。说明您可以调用 DescribeParameterTemplates 接口查询参数模板 ID。

返回参数

名称	类型	示例值	描述
TemplateId	String	vedbmpt-5j37992t****	参数模板 ID。
TemplateName	String	template_test	参数模板名称。
TemplateCategory	String	DBEngine	参数模板分类，默认值为 `DBEngine`。
TemplateDescription	String	test	参数模板描述，描述内容长度为 0~200 个字符。
TemplateTypeVersion	String	MySQL_8_0	参数模板适用的数据库引擎版本，取值范围： `MySQL_5_7`：MySQL 5.7 版本。 `MySQL_8_0`：MySQL 8.0 版本。
TemplateSource	String	User	参数模板的类型。取值： `System`：系统模板。 `User`：用户模板。
ParameterNumber	Integer	6	参数模板包含的参数数量。
NeedRestart	Bool	true	参数模板中是否包含需要重启生效的参数。
CreateTime	String	2022-10-10 10:10:37	参数模板创建时间。
UpdateTime	String	2022-10-10 10:10:37	参数模板修改时间。
TemplateParameters	Array of OverrideParameterObject	请参见返回示例。	参数模板包含的参数和参数值信息。关于 TemplateParameters 的详细信息，请参见 OverrideParameterObject。
TemplateType	String	MySQL	参数模板的数据库类型，默认值为 `MySQL`。

请求示例

POST /?Action=DescribeParameterTemplateDetail&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****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202502281127504EF4D8F43DBE31C83AE2-9d1be6",
        "Action": "DescribeParameterTemplateDetail",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "CreateTime": "2025-02-28T02:46:03Z",
        "NeedRestart": false,
        "ParameterNumber": 1,
        "TemplateCategory": "DBEngine",
        "TemplateDescription": "描述",
        "TemplateId": "vedbmpt-5j37992t****",
        "TemplateName": "template_test",
        "TemplateParameters": [
            {
                "ParameterName": "auto_increment_increment",
                "ParameterValue": "3"
            }
        ],
        "TemplateSource": "User",
        "TemplateType": "MySQL",
        "TemplateTypeVersion": "MySQL_8_0",
        "UpdateTime": "2025-02-28T02:46:03Z"
    }
}

错误码

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