GetFile - OpenSearch - Alibaba Cloud Documentation Center

Queries the details of an index table version.

Operation description

Method

GET

URI

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-i7m2rpzm605
indexName	string	Yes	The index name.	ecmon_table_index_test
versionName	string	Yes	The version name.	ha-cn-tl32nd2nq01@ha-cn-tl32nd2nq01_00@bj_vpc_domain_1@point_cloud_3d@index_config_edit
fileName	string	Yes	The name of the file in full path	/schemas/automobile_vector_schema.json

Sample requests

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	id of request	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	The index information.
name	string	The file name.	ha-cn-2r42ostoc01_qrs
fullPathName	string	The full path of the file.	""
dataSource	string	The data source.	ha-cn-2r42p5oi202_xijie_test
partition	long	The number of shards.	ds=20210828
isDir	boolean	Indicates whether the file is a directory.	True
content	string	The file content.	None

Sample responses

Success responses

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "name":"version1",  // The file name
    "fullPathName": "/root/version1",   // The name of the full path
    "dataSource": "odps1", // The data source
    "partition": 1,  // The number of shards
    "isDir": false, // Indicates whether it is a directory.
    "content": ""
  }
}

Examples

Sample success responses

JSONformat

{
  "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"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details