Querying the Data Connection List
Function
This API is used to query the data connection list.
URI
GET /v2/{project_id}/data-connectors
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID |
Parameter | Mandatory | Type | Description |
---|---|---|---|
connector_id | No | String | Connection ID |
source_type | No | String | Data source type |
connector_name | No | String | Data connection name |
limit | No | Integer | Number of results returned on each page |
offset | No | Integer | Start offset of the pagination query |
available | No | Boolean | Whether the data connection is available |
Request Parameters
None
Response Parameters
Status code: 200
Parameter | Type | Description |
---|---|---|
total_count | Integer | Total number of data connections |
data_connectors | Array of DataConnectorDetail objects | Data connection details list. For details, see Table 4. |
Parameter | Type | Description |
---|---|---|
connector_name | String | Data connection name |
source_type | String | Data connection type. The options are as follows:
|
source_info | String | Data source information, in JSON format. The content varies from one data connection to another. For details about the source_info content for each data source, see the example request. |
connector_id | String | Data connection ID |
create_time | Long | Creation time |
last_update_time | Long | Last update time |
create_by | String | Creator ID |
create_user | String | Creator |
tenant_id | String | Tenant ID |
last_update_by | String | ID of the user who last updated the information |
status | Integer | Data connection status. The options are as follows:
|
used_clusters | String | Clusters using the connection |
encrypt_type | Integer | Encryption type |
Example Request
None
Example Response
Status code: 200
Successful query of the data connection list
{"total_count" : 1,"data_connectors" : [ {"connector_id" : "7d169c6c-ab50-4a56-a5d2-240ca20aabda","connector_name" : "test","create_time" : 1681270961,"source_type" : "RDS_MYSQL","source_info" : "{\"rds_instance_id\":\"3ce1ae8af8cd43b2bcbd18b7541bb8b0in01\",\"jdbc_url\":\"jdbc:mysql://192.XXX.XXX.XXX:3306/test?socketTimeout=60000\",\"db_name\":\"test\",\"user_name\":\"root\",\"driver_path\":\"mrs-public/dirvers/mysql-connector-java-5.1.47.jar\"}","last_update_time" : 1681270961,"create_by" : "148c89d603e048b291f5940935b38f46","create_user" : "xxx","tenant_id" : "xxxxe662a7e24cc99bfc858c4558dbf6","last_update_by" : "148c89d603e048b291f5940935b38f46","status" : 0,"encrypt_type" : 2} ]}
Status Codes
See Status Codes.
Error Codes
See Error Codes.
- Function
- URI
- Request Parameters
- Response Parameters
- Example Request
- Example Response
- Status Codes
- Error Codes