Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Custom Backend Management/ Querying Data Sources of a Custom Backend Service
Updated on 2025-03-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Data Sources of a Custom Backend Service

Function

This API is used to query the data sources of a custom backend service.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/data-sources

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.

instance_id

Yes

String

Instance ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0.

limit

No

Integer

Number of items displayed on each page.

app_id

Yes

String

Application ID

name

No

String

Data source name.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

data_sources

Array of LdDatasourceInfo objects

Data source list.
Table 5 LdDatasourceInfo

Parameter

Type

Description

name

String

Data source name.

type

String

Data source type.

  • oracle

  • mysql

  • mongodb

  • redis

  • postgresql

  • hive

  • mssql: SQL Server

  • sqlserver: SQL Server

  • dws

  • gauss100

  • zenith

  • hana

  • clickhouse

  • mrshive(tag:Site_hybrid)

description

String

Data source description.

url

String

Data source connection string.

user

String

Username.

password

String

Password.

Sensitive information will not be returned as a response.

remotepath

String

Path on FTP server to which backup files are uploaded.

This parameter is reserved.

id

String

Data source ID.

status

String

Data source status:

  • old

  • new

created_time

String

Time when the data source is created.

modified_time

String

Time when the data source is updated.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "size" : 1,
  "total" : 1,
  "data_sources" : [ {
    "created_time" : "2020-09-19T07:10:12Z",
    "id" : "b71d74cd5889433bb90083f6fbc3adae",
    "modified_time" : "2020-09-19T07:10:12Z",
    "name" : "fdi_ds_demo",
    "status" : "new",
    "type" : "mysql",
    "url" : "jdbc:mysql://10.10.10.156:3306/apic?allowPublicKeyRetrieval=true&characterEncoding=UTF-8",
    "user" : "apictest"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.