使用ListDataSourceSchemas擷取指定資料來源的schema資訊-智能OpenSearch OpenSearch-阿里雲

介面說明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListDataSourceSchemas

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

無

請求文法

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/schemas HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID	ha-cn-pl32rf0****
dataSourceName	string	是	資料來源名稱	ha-cn-pl32rf0****_test_api

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

請求樣本

GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/schemas

返回參數

名稱	類型	描述	樣本值
	object	返回參數
requestId	string	請求 ID	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	返回結果。
	array<object>	schema 資訊
name	string	欄位名稱	id
custom	boolean	是否自訂欄位。取值：-true：是-false：否	false
type	string	欄位類型	STRING
attribute	boolean	是否為屬性欄位。取值：-true：是-false：否	false
summary	boolean	是否可展示。取值：-true：是-false：否	false
primaryKey	object	主鍵
isPrimaryKey	boolean	是否為主鍵。取值：-true：是-false：否	false
hasPrimaryKeyAttribute	boolean	是否有主鍵屬性。取值：-true：是-false：否	false
isPrimaryKeySorted	boolean	是否可排序。取值：-true：是-false：否	false
addIndex	boolean	是否添加了 index 屬性。取值：-true：是-false：否	false

返回樣本

正確返回

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result":[
    {
      "summary": false,
      "custom": false,
      "addIndex": false,
      "type": "INT64",
      "name": "id",
      "attribute": false,
      "primaryKey": {
        "hasPrimaryKeyAttribute": false,
        "primaryKeySorted": false,
        "primaryKey": false
      }
    },
    {
      "summary": false,
      "custom": false,
      "addIndex": false,
      "type": "STRING",
      "name": "fb_boolean",
      "attribute": false,
      "primaryKey": {
        "hasPrimaryKeyAttribute": false,
        "primaryKeySorted": false,
        "primaryKey": false
      }
    }
  ]
}

樣本

正常返回樣本

JSON格式

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "name": "id",
      "custom": false,
      "type": "STRING",
      "attribute": false,
      "summary": false,
      "primaryKey": {
        "isPrimaryKey": false,
        "hasPrimaryKeyAttribute": false,
        "isPrimaryKeySorted": false
      },
      "addIndex": false
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。