调用ListDataSourceSchemas获取某一数据源的schema信息_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

获取某一数据源的schema信息。

接口说明

方法

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

请求示例

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>	返回结果。
item	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
    }
  ]
}

错误码

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