DescribeApsDatasource - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about an AnalyticDB Pipeline Service (APS) 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
adb:DescribeApsDatasource	none	*DBClusterLakeVersion `acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL cluster.	am-*******
DatasourceId	long	Yes	The data source ID.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****-D8-5*-A-***587
ApsDatasource	object	The queried APS data source.
DatasourceName	string	The name of the data source.	kafka-2024***
CreateTime	string	The time when the data source was created.	2024-04-12T15:03:38Z
DatasourceType	string	The type of the data source.	KAFKA
DatasourceDescription	string	The description of the data source.	test
SlsInfo	object	The Simple Log Service (SLS) project.
SourceRegionId	string	The region ID.	cn-hangzhou
Project	string	The name of the SLS project.	***
Store	string	The name of the SLS Logstore.	***
Across	boolean	Indicates whether the data source is a cross-account resource. Valid values: true false	false
AcrossUid	string	The cross-account UID.	123456
AcrossRole	string	The name of the cross-account role.	test
KafkaInfo	object	The information about the Kafka instance.
KafkaClusterId	string	The ID of the Kafka instance.	-
KafkaTopic	string	The topic of the Kafka instance.	[{'value': 'hongxian_test'}]
HiveInfo	object	The information about the Hive data source.
MetaStoreUri	string	The URL of the Hive Metastore.	-
Vswitch	string	The vSwitch ID.	vsw-******
SecurityGroup	string	The security group ID.	sg-******
EmrClusterId	string	The ID of the E-MapReduce (EMR) cluster.	-
RdsMysqlInfo	object	The parameter is no longer supported.
UserName	string	The parameter is no longer supported.	-
RegionId	string	The parameter is no longer supported.	-
InstanceId	string	The parameter is no longer supported.	-
ConnectUrl	string	The parameter is no longer supported.	-
SecurityGroup	string	The parameter is no longer supported.	-
PolarDBMysqlInfo	object	The parameter is no longer supported.
UserName	string	The parameter is no longer supported.	-
RegionId	string	The parameter is no longer supported.	-
InstanceId	string	The parameter is no longer supported.	-
ConnectUrl	string	The parameter is no longer supported.	-
SecurityGroup	string	The parameter is no longer supported.	-
Across	boolean	The parameter is no longer supported.	-
AcrossUid	string	The parameter is no longer supported.	-
AcrossRole	string	The parameter is no longer supported.	-
DBClusterId	string	The cluster ID.	amv-******
DatabricksInfo	object	The information about Databricks.
accessToken	string	The token that is used to access Databricks.	******
workspaceURL	string	The URL of the workspace.	-

Examples

Sample success responses

JSONformat

{
  "RequestId": "******-**D8-5***-A***-****587",
  "ApsDatasource": {
    "DatasourceName": "kafka-2024***",
    "CreateTime": "2024-04-12T15:03:38Z",
    "DatasourceType": "KAFKA",
    "DatasourceDescription": "test",
    "SlsInfo": {
      "SourceRegionId": "cn-hangzhou",
      "Project": "***",
      "Store": "***",
      "Across": false,
      "AcrossUid": 123456,
      "AcrossRole": "test"
    },
    "KafkaInfo": {
      "KafkaClusterId": "-",
      "KafkaTopic": "[{'value': 'hongxian_test'}]"
    },
    "HiveInfo": {
      "MetaStoreUri": "-",
      "Vswitch": "vsw-******",
      "SecurityGroup": "sg-******",
      "EmrClusterId": "-"
    },
    "RdsMysqlInfo": {
      "UserName": "-",
      "RegionId": "-",
      "InstanceId": "-",
      "ConnectUrl": "-",
      "SecurityGroup": "-"
    },
    "PolarDBMysqlInfo": {
      "UserName": "-",
      "RegionId": "-",
      "InstanceId": "-",
      "ConnectUrl": "-",
      "SecurityGroup": "-",
      "Across": true,
      "AcrossUid": "-",
      "AcrossRole": "-"
    },
    "DBClusterId": "amv-******",
    "DatabricksInfo": {
      "accessToken": "******",
      "workspaceURL": "-"
    }
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidInput	The specified parameter is invalid.

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