文档

ListQueryResult - 获取搜索测试结果

获取搜索测试结果。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/query?query=xxxx

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:ListQueryResultRead
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

GET /openapi/ha3/instances/{instanceId}/query

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

ha-cn-i7m2olkw201
querystring

query 语句

query%3D1%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson%26%26cluster%3Dgeneral
sqlstring

SQL 语句。

query%3Dselect%20max(content_id)%20from%20generation

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

9E5BCFAA-98B3-51D0-9188-B1BC07589337
字段类型描述
requestIdString请求 ID
resultString引擎返回结果

示例

正常返回示例

JSON格式

{
  "requestId": "9E5BCFAA-98B3-51D0-9188-B1BC07589337"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI看变更集

示例

请求示例

sql: GET /openapi/ha3/instances/ha3_instances_id/query?sql=query%3Dselect+%2A+from+mx_index1217

query: GET /openapi/ha3/instances/ha3_instances_id/query?query=config%3Dhit%3A4%2Cformat%3Ajson%2Cfetch_summary_type%3Apk%2Cqrs_chain%3Asearch%26%26query%3Did%3A8148508889615505646%26%26cluster%3Dgeneral

返回示例

正确返回

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {}
}
  • 本页导读 (0)