DescribeStreamingDataService - AnalyticDB - Alibaba Cloud Documentation Center

Queries a real-time data service.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
ServiceId	string	Yes	The service ID.	1
DBInstanceId	string	Yes	The instance ID.	gp-bp10g78o9807yv9h3

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
ServiceId	string	The service ID.	1
ServiceName	string	The name of the service.	test-adbpgss
ServiceDescription	string	The description of the service.	test-adbpgss
ServiceSpec	string	The specifications of the service.	2
Status	string	The status of the service. Valid values: Init Running Exception Paused	Running
ServiceIp	string	The IP address of the service.	192.168.0.1
ServicePort	integer	The port number of the service.	5432
CreateTime	string	The time when the service was created.	2019-09-08T16:00:00Z
ModifyTime	string	The time when the service was last modified.	2019-09-08T17:00:00Z
ServiceManaged	boolean	The service is managed by other aliyun product or not.	False
ServiceOwnerId	string	The service account uid of the aliyun product	123456

Examples

Sample success responses

JSONformat

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "ServiceId": 1,
  "ServiceName": "test-adbpgss",
  "ServiceDescription": "test-adbpgss",
  "ServiceSpec": 2,
  "Status": "Running",
  "ServiceIp": "192.168.0.1",
  "ServicePort": 5432,
  "CreateTime": "2019-09-08T16:00:00Z",
  "ModifyTime": "2019-09-08T17:00:00Z",
  "ServiceManaged": true,
  "ServiceOwnerId": 123456
}

Error codes

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

Change history

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