Help Center> ROMA Connect> API Reference> FDI APIs> Data Source Management> Obtaining All Tables in the Data Source
View PDF

Obtaining All Tables in the Data Source

Function

This API is used to obtain all tables in the data source.

URI

GET /v2/{project_id}/fdi/instances/{instance_id}/datasources/{datasource_id}/tables

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

Minimum: 1

Maximum: 64

instance_id

Yes

String

Instance ID.

Minimum: 1

Maximum: 64

datasource_id

Yes

String

Data source ID.

Minimum: 1

Maximum: 64
Table 2 Query parameters

Parameter

Mandatory

Type

Description

position

Yes

String

Task location of the data source.

  • SOURCE: Data source is at the task source.

  • TARGET: Data source is at the task destination.

Minimum: 0

Maximum: 6

db_name

No

String

Database name. Only data sources of the MRSHIVE and FIHIVE types are supported.

Minimum: 0

Maximum: 64

db_schema

No

String

Database mode. This API is used by the Gauss100 database.

Minimum: 0

Maximum: 64

filter

No

String

Filter for fuzzy match of table names.

Minimum: 0

Maximum: 64

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tables

Array of strings

Names of all tables in the data source.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

detail

String

Description details.

Minimum: 2

Maximum: 512

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Example Requests

None

Example Responses

Status code: 200

OK

  • Example 1

    null

  • Example 2

    [ "app.0" ]

Status Codes

Status Code

Description

200

OK

400

Error response

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Data Source Management