查询参数模板应用历史 - ViewingApplicationRecordsofaParameterTemplate

功能介绍

查询参数模板应用历史。

接口约束

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

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx经典部署模式实例
GeminiDB Redis经典部署模式实例

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:configuration:listAppliedHistory
List
-
-
nosql:param:list
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbfornosql:configuration:listAppliedHistory	List	-	-	nosql:param:list	-

URI

GET /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参数
参数	参数类型	描述
histories	Array of ApplyHistoryRsp objects	参数解释：参数组模板应用历史列表。取值范围：不涉及。
total_count	Integer	参数解释：数据总数。取值范围：不涉及

表5 ApplyHistoryRsp
参数	参数类型	描述
instance_id	String	参数解释：实例ID。取值范围：不涉及。
instance_name	String	参数解释：实例名称。取值范围：不涉及。
applied_at	String	参数解释：生效时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。取值范围：其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。
apply_result	String	参数解释：应用结果。取值范围： SUCCESS：应用成功。 APPLYING：应用中。 FAILED：应用失败。
failure_reason	String	参数解释：失败原因。取值范围：不涉及。

请求示例

URI样例

GET https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/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": ""
    }
  ]
}