All Products
Search
Document Center

OpenSearch:ListDataSources

Last Updated:Oct 16, 2024

Obtains the list of data sources.

Operation description

Method

GET

URI

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

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:ListDataSourceslist
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-2r42ostoc01

Sample requests

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

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

The ID of the request.

93A9E542-8CF8-5BA6-99AB-94C0FE520429
resultarray<object>

The results returned.

resultobject

The list of data source information.

namestring

The name of the data source.

data_source_name
typestring

The type of the data source.

odps
domainstring

The data center in which the data source is deployed.

test
indexesarray

The indexes.

indexesstring

The index of the data source.

index1
lastFulTimelong

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

1718787785
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": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
  "result": [
    {
      "name": "data_source_name",
      "type": "odps",
      "domain": "test",
      "indexes": [
        "index1"
      ],
      "lastFulTime": 1718787785,
      "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