文档首页/ 分布式缓存服务 DCS/ API参考（吉隆坡区域）/ API V2（推荐）/ 参数管理/ 查询实例参数修改记录列表
更新时间：2025-11-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例参数修改记录列表

功能介绍

查询实例的参数修改记录列表，支持按照关键字查询。

URI

GET /v2/{project_id}/instances/{instance_id}/config-histories

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。可通过DCS控制台进入实例详情界面查看。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量，表示生成的列表从此偏移量开始显示，例如偏移量为3时，生成的列表从第4条开始。

约束限制：

不涉及。

取值范围：

大于等于0。

默认取值：

0

limit

否

Integer

参数解释：

每页显示条数。

约束限制：

不涉及。

取值范围：

1~1000

默认取值：

10

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

history_num

Integer

参数解释：

实例参数修改记录个数。

取值范围：

不涉及。

histories

Array of HistoryInfo objects

参数解释：

实例参数修改记录详情。
表4 HistoryInfo

参数

参数类型

描述

history_id

String

参数解释：

修改记录ID。

取值范围：

不涉及。

type

String

参数解释：

修改类型。

取值范围：

config_param：实例配置参数。

created_at

String

参数解释：

修改时间。

取值范围：

不涉及。

status

String

参数解释：

修改状态。

取值范围：

  • SUCCESS：实例参数修改成功。

  • FAILURE：实例参数修改失败。

  • EXECUTING: 实例参数修改中。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

状态码：500

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

请参见错误码。

error_ext_msg

String

参数解释：

扩展错误信息（暂未使用，赋值为null）。

取值范围：

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/config-histories?offset=0&limit=10

响应示例

状态码：200

参数解释：

查询实例参数修改记录列表成功。

{
  "history_num" : 1,
  "histories" : [ {
    "history_id" : "4ae8507f-7992-40e2-9928-41ccf1db4bdc",
    "type" : "config_param",
    "created_at" : "2022-10-20T03:37:44.636Z",
    "status" : "SUCCESS"
  } ]
}

状态码

状态码

描述

200

参数解释：

查询实例参数修改记录列表成功。

400

参数解释：

非法请求。

500

参数解释：

内部服务错误。

错误码

请参见错误码。

父主题： 参数管理