獲取搜索測試結果。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
searchengine:ListQueryResult | get |
|
| 無 |
請求語法
GET /openapi/ha3/instances/{instanceId}/query HTTP/1.1
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
instanceId | string | 是 | 實例 ID | ha-cn-pl32rf0**** |
query | string | 否 | query 語句 | query%3D1%26%26config%3Dstart%3A0%2Chit%3A10%2Cformat%3Ajson%26%26cluster%3Dgeneral |
sql | string | 否 | SQL 語句。 | query%3Dselect%20max(content_id)%20from%20generation |
返回參數
字段 | 類型 | 描述 |
---|---|---|
requestId | String | 請求 ID |
result | String | 引擎返回結果 |
示例
正常返回示例
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": {}
}