DescribeStreamingDataSource - AnalyticDB - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get external data source configuration information

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:DescribeStreamingDataSource	get	*DBInstance `acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	Region ID. Note You can call the DescribeRegions API to view available region IDs.	cn-beijing
DBInstanceId	string	Yes	Instance ID.	gp-bp10g78o9807yv9h3
DataSourceId	integer	Yes	Data source ID.	1

Response parameters

Parameter	Type	Description	Example
	object
DataSourceId	string	Data source ID.	1
RequestId	string	Request ID.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
DataSourceName	string	Data source name.	test-kafka
DataSourceDescription	string	Data source description.	test-kafka
Status	string	Service status: Initializing init Running running Exception exception	running
ErrorMessage	string	Service status message, for example, in case of an exception, it will show the reason for the exception. In normal Running state, this value is empty.	""
CreateTime	string	Creation time.	2019-09-08T16:00:00Z
DataSourceConfig	string	Data source configuration information.	{"brokers":"broker0:9091,broker1:9091","topic":"topic"}
ServiceId	integer	External data service ID.	1
DataSourceType	string	Data source type, values include: kafka	kafka

Examples

Sample success responses

JSONformat

{
  "DataSourceId": 1,
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "DataSourceName": "test-kafka",
  "DataSourceDescription": "test-kafka",
  "Status": "running",
  "ErrorMessage": "",
  "CreateTime": "2019-09-08T16:00:00Z",
  "DataSourceConfig": {
    "brokers": "broker0:9091,broker1:9091",
    "topic": "topic"
  },
  "ServiceId": 1,
  "DataSourceType": "kafka"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history