调用GetFile查看索引表版本详情_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

查看索引表版本详情。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file?fileName=/root/test.txt

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
searchengine:GetFile	Read	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

GET /openapi/ha3/instances/{instanceId}/indexes/{indexName}/versions/{versionName}/file

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-i7m2rpzm605
indexName	string	是	索引名称	ecmon_table_index_test
versionName	string	是	版本名称	ha-cn-tl32nd2nq01@ha-cn-tl32nd2nq01_00@bj_vpc_domain_1@point_cloud_3d@index_config_edit
fileName	string	是	文件全路径名称	/schemas/automobile_vector_schema.json

请求示例

GET  /openapi/ha3/instances/ose-test1/indexes/index1/versions/version1?fileName=/root/test.txt

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	id of request	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	索引信息
name	string	文件名称	ha-cn-2r42ostoc01_qrs
fullPathName	string	全路径名称	""
dataSource	string	数据源	ha-cn-2r42p5oi202_xijie_test
partition	long	分片数	ds=20210828
isDir	boolean	是否为目录	True
content	string	内容	None

返回示例

正确返回

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "name":"version1",  // 文件名
    "fullPathName": "/root/version1",   // 全路径名称
    "dataSource": "odps1", // 数据源
    "partition": 1,  // 分片
    "isDir": false, // 是否为目录
    "content": ""
  }
}

示例

正常返回示例

JSON格式

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "name": "ha-cn-2r42ostoc01_qrs",
    "fullPathName": "\"\"",
    "dataSource": "ha-cn-2r42p5oi202_xijie_test",
    "partition": 0,
    "isDir": true,
    "content": "None"
  }
}

错误码

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

变更历史

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