文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 参数模板管理/ 查询参数模板应用记录 - ListParamsTemplateApplyHistory
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询参数模板应用记录 - ListParamsTemplateApplyHistory

功能介绍

查询参数模板应用记录。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:param:list

    List

    -

    -

    gaussdb:param:list

    -

URI

GET /v3/{project_id}/configurations/{config_id}/apply-history

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

config_id

是

String

参数解释：

参数组ID。

约束限制：

实例对应的参数组ID。

取值范围：

只能由英文字母、数字组成，前面为UUID，后缀为pr07，长度为36个字符。

通过调用查询实例详情信息 - ShowGaussMySqlInstanceInfoUnifyStatus接口获取。

请求响应成功后在响应消息体中包含的“configuration_id”的值即为configuration_id值。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

查询记录数。

约束限制：

必须为整数，不能为负数。

取值范围：

1-100。

默认取值：

100。

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为整数，不能为负数。

取值范围：

≥0。

默认取值：

0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

String

参数解释:

参数模板应用记录数量。

取值范围：

不涉及。

histories

Array of TemplateApplyHistory objects

参数解释：

参数模板应用记录信息。
表5 TemplateApplyHistory

参数

参数类型

描述

target_id

String

参数解释：

应用实例ID。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

target_name

String

参数解释：

应用实例名称。

取值范围：

实例ID对应的实例名称。

apply_result

String

参数解释：

应用结果。

取值范围：

  • SUCCESS：应用成功。

  • FAILED：应用失败。

  • APPLYING: 应用中。

applied_at

Number

参数解释：

应用时间。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询参数模板应用记录。

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/b366363c95b04b0eac39e73ea2672ffepr07/apply-history

响应示例

状态码： 200

Success.

{
  "total_count" : 1,
  "histories" : [ {
    "target_id" : "06789bdfbe414d78b9cef1b79d7d9680in07",
    "target_name" : "gauss-11",
    "apply_result" : "SUCCESS",
    "applied_at" : 1712246191000,
    "error_code" : ""
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 参数模板管理