# 查询参数模板的应用记录 - QueryingApplicationRecordsofaParameterTemplate #### 功能介绍 查询参数模板的应用记录。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListApplicableInstances)中调试该接口。 #### URI GET /v3/{project_id}/configurations/{config_id}/applied-histories 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | config_id | 是 | String | **参数解释：** 参数模板ID。 请参考[获取参数模板列表 - ObtainingParameterTemplates](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_049.html)获取参数模板ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，例如：该参数指定为0，limit指定为10，则只展示第1\~10条数据。 **约束限制：** 不涉及。 **取值范围：** \[0, 2147483647\]。 **默认取值：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询记录数。例如该参数设定为10，则查询结果最多只显示10条记录。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值：** 100 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | histories | Array of objects | **参数解释：** 应用记录列表，具体参数请参考[表4]。 | | total_count | Integer | **参数解释：** 参数模板所应用实例的总记录数。 **取值范围：** 不涉及。 | 表4histories字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | apply_result | String | **参数解释：** 应用状态。 **取值范围：** - SUCCESS：应用成功。 - FAILED：应用失败。 - APPLYING：应用中。 | | applied_at | String | **参数解释：** 应用时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | error_code | String | **参数解释：** 失败原因错误码，如DBS.280005。 **取值范围：** 不涉及。 | #### 请求示例 查询参数模板的应用记录。 ``` GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/applied-histories ``` #### 响应示例 查询参数模板的应用记录成功。 ``` { "histories": [ { "instance_id": "1995a67680474481b3e42ac1474e32e0in14", "instance_name": "gauss-a283", "apply_result" : "SUCCESS", "applied_at" : "2022-08-09T03:06:52+0800", "error_code" : "" }, { "instance_id": "8303819fd8744ef69f34595e9710a33din14", "instance_name": "gauss-2423-lt-master", "apply_result" : "FAILED", "applied_at" : "2022-08-09T03:06:52+0800", "error_code" : "DBS.280005" } ], "total_count": 2 } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。