DescribeJDBCDataSource - AnalyticDB - Alibaba Cloud Documentation Center

Queries the configurations of a Java Database Connectivity (JDBC) data source.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeJDBCDataSource	get	DBInstance `acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-xxx
DataSourceId	string	Yes	The data source ID.	123

Response parameters

Parameter	Type	Description	Example
	object
DataSourceId	string	The data source ID.	123
RequestId	string	The request ID.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
DataSourceName	string	The name of data soruce	hdfs_pxf
DataSourceDescription	string	The description of the service. The description can be up to 256 characters in length.	mysql data source config
DataSourceStatus	string	The status of the service. Valid values: Init Running Exception	Running
StatusMessage	string	The message of the status	""
CreateTime	string	The time when the service was created.	2019-09-08T16:00:00Z
DataSourceType	string	The type of the data source.	MySQL
JDBCConnectionString	string	The JDBC connection string.	xxxxxx
JDBCUserName	string	The name of the database account.	xxxxxx
JDBCPassword	string	The password of the database account.	xxxxxx
ModifyTime	string	The time when the data source was last modified.	2024-08-27T02:01:10Z
ExternalDataServiceId	string	The id of the external data service	2989

Examples

Sample success responses

JSONformat

{
  "DataSourceId": 123,
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "DataSourceName": "hdfs_pxf",
  "DataSourceDescription": "mysql data source config",
  "DataSourceStatus": "Running",
  "StatusMessage": "",
  "CreateTime": "2019-09-08T16:00:00Z",
  "DataSourceType": "MySQL",
  "JDBCConnectionString": "xxxxxx",
  "JDBCUserName": "xxxxxx",
  "JDBCPassword": "xxxxxx",
  "ModifyTime": "2024-08-27T02:01:10Z",
  "ExternalDataServiceId": 2989
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-20	The response structure of the API has changed	View Change Details