DescribeHadoopDataSource - AnalyticDB - Alibaba Cloud Documentation Center

Obtains the configurations of a Hadoop 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:DescribeHadoopDataSource	get	DBInstance `acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	gp-xxx
DataSourceId	string	No	The data source ID.	123
RegionId	string	No	The region ID of the instance. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

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 the service.	hdfs_pxf
DataSourceDescription	string	The description of the service. The description can be up to 256 characters in length.	pxf for hdfs data source
DataSourceStatus	string	The status of the service. Valid values: Init Running Exception	Running
DataSourceDir	string	The service directory in which Hadoop-related configuration files are stored.	HadoopDir
StatusMessage	string	The information about the service status. For example, if the service is in the exception state, the cause of the exception is displayed. If the service is in the running state, this parameter is left empty.	""
CreateTime	string	The time when the service was created.	2019-09-08T16:00:00Z
DataSourceType	string	The type of the data source.	hive
HadoopCreateType	string	The type of the external service. Valid values: emr selfCreate	HDFS
HadoopHostsAddress	string	The IP address and hostname of the Hadoop cluster (data source) in the /etc/hosts file.	127.0.0.1 localhost
HadoopCoreConf	string	The content of the Hadoop core-site.xml file.	xxxxxx
HDFSConf	string	The content of the Hadoop hdfs-site.xml file.	xxxxxx
HiveConf	string	The content of the Hadoop hive-site.xml file.	xxxxxx
YarnConf	string	The content of the Hadoop yarn-site.xml file.	xxxxxx
MapReduceConf	string	The content of the Hadoop mapred-site.xml file.	xxxxxx
EmrInstanceId	string	The E-MapReduce (EMR) Hadoop cluster ID.	c-1234567
ModifyTime	string	The time when the data source was last modified.	2024-08-23T02:11:47Z
ExternalDataServiceId	string	The ID of the external data service.	2988

Examples

Sample success responses

JSONformat

{
  "DataSourceId": 123,
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "DataSourceName": "hdfs_pxf",
  "DataSourceDescription": "pxf for hdfs data source",
  "DataSourceStatus": "Running",
  "DataSourceDir": "HadoopDir",
  "StatusMessage": "",
  "CreateTime": "2019-09-08T16:00:00Z",
  "DataSourceType": "hive",
  "HadoopCreateType": "HDFS",
  "HadoopHostsAddress": "127.0.0.1 localhost",
  "HadoopCoreConf": "xxxxxx",
  "HDFSConf": "xxxxxx",
  "HiveConf": "xxxxxx",
  "YarnConf": "xxxxxx",
  "MapReduceConf": "xxxxxx",
  "EmrInstanceId": "c-1234567",
  "ModifyTime": "2024-08-23T02:11:47Z",
  "ExternalDataServiceId": 2988
}

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