Help Center/ Data Warehouse Service/ API Reference/ API Description/ Data Sources/ Querying Data Sources
Updated on 2025-08-06 GMT+08:00
View PDF

Querying Data Sources

Function

This API is used to query data sources.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/ext-data-sources

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

data_sources

Array of ExtDataSource objects

Definition

Data source list.

Range

N/A

project_id

String

Definition

Project ID.

Range

N/A

cluster_id

String

Definition

Cluster ID.

Range

It is a 36-digit UUID.

type

String

Definition

Data source type.

Range

N/A

count

Integer

Definition

Total number.

Range

N/A
Table 3 ExtDataSource

Parameter

Type

Description

id

String

Definition

Data source ID.

Range

N/A

name

String

Definition

Data source name.

Range

N/A

type

String

Definition

Type.

Range

N/A

connect_info

String

Definition

Database.

Range

N/A

user_name

String

Definition

Username.

Range

N/A

version

String

Definition

Version.

Range

N/A

configure_status

String

Definition

Configuration status.

Range

N/A

status

String

Definition

Status.

Range

N/A

data_source_id

String

Definition

External data source ID.

Range

N/A

created

String

Definition

Creation time.

Range

N/A

updated

String

Definition

Update time.

Range

N/A

data_source_updated

String

Definition

Data source update time.

Range

N/A

extend_properties

Object

Definition

Extended information.

Range

N/A

description

String

Definition

Description.

Range

N/A

fail_reason

String

Definition

Failure cause.

Range

N/A

Example Requests

GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/ext-data-sources

Example Responses

Status code: 200

Query succeeded.

{
  "data_sources" : [ {
    "id" : "8010dbc0-c1d2-48d6-87eb-3229f9195fed",
    "name" : "tes54",
    "type" : "OBS",
    "connect_info" : "gaussdb",
    "user_name" : "DWSAccessOBS",
    "configure_status" : "300",
    "created" : "2022-10-30T07:38:33",
    "extend_properties" : { },
    "description" : "xxx",
    "fail_reason" : ""
  } ],
  "project_id" : "0536cdee2200d5912f7cc00b877980f1",
  "cluster_id" : "a07cb2f7-b17e-4d95-923b-a33d0c884d37",
  "type" : "OBS",
  "count" : 5
}

Status Codes

Status Code

Description

200

Query succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.
Parent Topic: Data Sources