GetDataSource - OpenSearch - Alibaba Cloud Documentation Center

Obtains a data source.

Operation description

Method

GET

URI

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

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}/data-sources/{dataSourceName}

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	ha-cn-2r42ostoc01
dataSourceName	string	No	The name of the data source.	ha-cn-2r42ostoc01_people_info

Sample requests

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	Id of the request	FE03180A-0E29-5474-8A86-33F0683294A4
result	object	The information about the data source.
name	string	The name of the data source.	my_index
type	string	The type of the data source	odps
domain	string	The data center where the data source is deployed in offline mode	vpc_hz_domain_1
indexes	array	The list of index information
	string	The index table	index1
lastFulTime	long	The time when the full data of the data source was last queried.	1718787219
status	string	The status of the data source. Valid values: new: The data source is being created. publish: The data source is in the normal state. trash: The data source is being deleted.	NEW

Examples

Sample success responses

JSONformat

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": {
    "name": "my_index",
    "type": "odps",
    "domain": "vpc_hz_domain_1",
    "indexes": [
      "index1"
    ],
    "lastFulTime": 1718787219,
    "status": "NEW"
  }
}

Error codes

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

Change history

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