# 查询SQL PATCH - QueryingSQLPatchInformation #### 功能介绍 查询SQL PATCH信息。 - 调用接口前，您需要了解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=ShowSqlPatch)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/sql-patch 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | 表2请求Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | node_id | 是 | String | **参数解释：** 节点ID。获取方式请参考[查询实例的组件列表 - QueryingtheComponentsofaDBInstance](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_028.html)。 **约束限制：** 不涉及 **取值范围：** 由 32 个字符（英文字母、数字、-或\\），后跟 "no"，再跟 "14" 或 "20" 组成的字符串。 **默认取值** **：** 不涉及。 | | sql_id | 是 | String | **参数解释：** 慢SQL的ID，通过[查询慢SQL列表 - QueryingSlowSQLStatements](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_297.html)获取。 **约束限制：** 不涉及。 **取值范围：** 由数字组成，且长度为1\~256个字符。 **默认取值** **：** 不涉及。 | | database_name | 否 | String | **参数解释：** 数据库名称。慢SQL场景可以不填，其他场景必填。 **约束限制：** 不能使用模板库，且是已存在的数据库名称。 模板库包括 template0 ，template1。 **取值范围：** 只能由字母、数字、_及$组成，且长度为0\~63个字符，不能以数字开头。 **默认取值：** 不涉及。 | #### 请求参数 表3请求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** | #### 响应参数 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | patch_name | String | **参数解释：** PATCH名称。 **取值范围：** 不涉及。 | | hint | String | **参数解释：** PATCH内容（Hint文本）。对于abort 类型的SQL PATCH此字段为空。 **取值范围：** 不涉及。 | | patch_status | String | **参数解释：** PATCH状态。 **取值范围：** - enabled：表示SQL PATCH生效。 - disabled：表示SQL PATCH失效。 | #### 请求示例 查询SQL PATCH。 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/sql-patch?node_id=d8e6ca5a624745bcb546a227aa3ae1cfin14&sql_id=28f61af50fc9452aa0ed5ea25c3cc3d3 ``` #### 响应示例 查询SQL PATCH信息成功。 ``` { "patch_name": "patch1", "hint": "indexscan(t1)", "patch_status": "enabled" } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。