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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:GetFile	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

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

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	Schema of Response
requestId	string	The request ID.	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
extend	object	Extended information
	array	Extended information
extend	string	Extended information

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",
    "extend": {
      "key": [
        ""
      ]
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-07-31	The response structure of the API has changed	View Change Details
2022-01-12	Add Operation	View Change Details