All Products
Search
Document Center

OpenSearch:GetDataSource

Last Updated:Oct 16, 2024

Obtains a data source.

Operation description

Method

GET

URI

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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
searchengine:GetDataSourceget
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringNo

The instance ID.

ha-cn-2r42ostoc01
dataSourceNamestringNo

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

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

Id of the request

FE03180A-0E29-5474-8A86-33F0683294A4
resultobject

The information about the data source.

namestring

The name of the data source.

my_index
typestring

The type of the data source

odps
domainstring

The data center where the data source is deployed in offline mode

vpc_hz_domain_1
indexesarray

The list of index information

indexesstring

The index table

index1
lastFulTimelong

The time when the full data of the data source was last queried.

1718787219
statusstring

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 timeSummary of changesOperation
2023-07-19The response structure of the API has changedView Change Details
2022-01-12Add OperationView Change Details