文档首页/ 云数据库 GeminiDB/ API参考（联盟区域）/ API v3/ 参数模板管理/ 查询参数模板应用历史
更新时间：2026-07-31 GMT+08:00
查看PDF
分享

查询参数模板应用历史

功能介绍

查询参数模板应用历史。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Cassandra
  • GeminiDB Influx

实例删除后，参数模板应用历史中相关记录也将删除。

URI

GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

config_id

是

String

参数模板id。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置，偏移量。

从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。

取值必须为数字，不能为负数。

limit

否

Integer

查询个数上限值。

  • 取值范围: 1~100。
  • 不传该参数时，默认查询前100条信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

数据总数。

histories

Array of ApplyHistoryRsp objects

参数模板应用历史列表。
表5 ApplyHistoryRsp

参数

参数类型

描述

instance_id

String

实例ID。

instance_name

String

实例名称

applied_at

String

生效时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。

其中，T指某个时间的开始；Z指时区偏移量。

apply_result

String
  • SUCCESS：应用成功。
  • APPLYING：应用中。
  • FAILED：应用失败。

failure_reason

String

失败原因。

请求示例

  • URI样例 
    GET https://{Endpoint}/v3/056f86e8d480d3cb2f43c00183f75e1f/configurations/e02e76567ae04662a2753492b77f965bpr06/applied-histories?offset=0&limit=10

响应示例

状态码： 200

Success

{
    "total_count" : 1,
    "histories" : [
    {
      "instance_id" : "a2d0cf32db3e4f2aa3a684240e10b457in06",
      "instance_name" : "test",
      "applied_at" : "2022-09-20T11:17:04+0000",
      "apply_result" : "SUCCESS",
      "failure_reason": ""
    }
  ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理