开启或者关闭查询队列功能
功能介绍
开启或者关闭查询队列功能。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/instances/{instance_id}/htap/query-queue/switch
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 |
instance_id |
是 |
String |
参数解释: HTAP标准版实例ID,严格匹配UUID规则。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in17,且长度为36个字符。 默认值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
X-Language |
是 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围:
默认值: en-us。 |
Content-Type |
是 |
String |
参数解释: 内容类型。 约束限制: 不涉及。 取值范围: application/json。 默认值: application/json。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable_query_queue_select |
是 |
String |
参数解释: 查询队列的开关状态。 约束限制: 不涉及。 取值范围:
默认值: false。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 响应返回结果。 取值范围:
|
msg |
String |
参数解释: 响应错误信息。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
-
开启查询队列。
POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin17/query-queue/switch { "enable_query_queue_select" : "true" }
-
关闭查询队列。
POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin17/query-queue/switch { "enable_query_queue_select" : "false" }
响应示例
状态码:200
Success.
{ "status" : "success", "msg" : "success" }
状态码:400
Client error.
{ "error_code" : "DBS.200022", "error_msg" : "实例不存在" }
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。