查询SQL PATCH
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/instances/{instance_id}/sql-patch
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID,此参数是用户创建实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
node_id |
是 |
String |
参数解释: 节点ID。 约束限制: 不涉及 取值范围: 由 32 个字符(英文字母、数字、-或\),后跟 "no",再跟 "14" 或 "20" 组成的字符串。 默认取值: 不涉及。 |
sql_id |
是 |
String |
参数解释: 慢SQL的ID,通过查询慢SQL列表获取。 约束限制: 不涉及。 取值范围: 由数字组成,且长度为1~256个字符。 默认取值: 不涉及。 |
database_name |
否 |
String |
参数解释: 数据库名称。慢SQL场景可以不填,其他场景必填。 约束限制: 不能使用模板库,且是已存在的数据库名称。 模板库包括 template0 ,template1。 取值范围: 只能由字母、数字、_及$组成,且长度为0~63个字符,不能以数字开头。 默认取值: 不涉及。 |
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
patch_name |
String |
参数解释: PATCH名称。 取值范围: 不涉及。 |
hint |
String |
参数解释: PATCH内容(Hint文本)。对于abort 类型的SQL PATCH此字段为空。 取值范围: 不涉及。 |
patch_status |
String |
参数解释: 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" }
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。