文档首页/ 文档数据库服务 DDS/ API参考/ API v3（推荐）/ 参数配置/ 查询参数模板应用历史-ViewingApplicationRecordsofaParameterTemplate
更新时间：2025-12-05 GMT+08:00
查看PDF
分享

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

功能介绍

查询参数模板应用历史。

接口约束

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

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    dds:configuration:listAppliedHistory

    list

    -

    -

    dds:instance:list

    -

URI

  • URI格式

    GET /v3/{project_id}/configurations/{config_id}/applied-histories

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02/applied-histories?offset=0&limit=10

表1 路径参数

名称

是否必选

参数类型

说明

project_id

是

String

参数解释：

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

config_id

是

String

参数解释：

参数模板ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

名称

是否必选

参数类型

说明

offset

否

Integer

参数解释：

索引位置，偏移量。

约束限制：

必须为整数数字。

取值范围：

不能为负数。

默认取值：

0。偏移0条数据，表示从第一条数据开始查询。

limit

否

Integer

参数解释：

查询记录数。

约束限制：

正整数。

取值范围：

1~100。

默认取值：

100。

请求参数

表3 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

参数解释：

从IAM服务获取的用户Token。请参考认证鉴权。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

表4 响应Body参数

参数

参数类型

说明

histories

Array of 表5-5 objects

参数解释：

参数模板应用历史列表。

取值范围：

不涉及。

total_count

Integer

参数解释：

总记录数。

取值范围：

不涉及。
表5 ApplicableInstancesInfo

参数

参数类型

说明

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

instance_name

String

参数解释：

实例名称。

取值范围：

不涉及。

applied_at

String

参数解释：

应用时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

取值范围：

不涉及。

apply_result

String

参数解释：

应用结果。

取值范围：

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

failure_reason

String

参数解释：

失败原因。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02/applied-histories?offset=0&limit=10

响应示例

{ 
  "histories" : [ { 
    "instance_id" : "1967d9d9d6ef4c5ea38bd5a754f5737ein02", 
    "instance_name" : "dds-4525",
    "applied_at" : "2022-06-07T09:25:45+0000", 
    "apply_result" : "SUCCESS" 
  } ] 
}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 参数配置

相关文档