ListStreamingDataServices - 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.

Create External Data Source Configuration

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	Region ID	cn-beijing
DBInstanceId	string	Yes	Instance ID.	gp-bp10g78o9807yv9h3
PageNumber	integer	No	Page number, greater than 0 and not exceeding the maximum value of Integer, default value: 1.	1
PageSize	integer	No	Number of records per page, with the following values: 30 (default) 50 100	50

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
ServiceItems	array<object>	Returns real-time data service items
items	object
ServiceId	string	Service ID.	1
ServiceType	string	Service type, with the following value: adbpgss	adbpgss
ServiceName	string	Service name.	test-adbpgss
ServiceDescription	string	Service description.	test-adbpgss
ServiceSpec	string	Service specification (in CU).	8
Status	string	Service status, with the following values: Init: Initializing Running: In operation Exception: Abnormal Paused: Suspended	Running
ServiceIp	string	Service IP.	192.168.0.1
ServicePort	string	Service port.	5432
CreateTime	string	Creation time.	2019-09-08T16:00:00Z
ModifyTime	string	Last modified time	2019-09-08T17:00:00Z
ServiceManaged	boolean	Whether it is a managed service.	true
ServiceOwnerId	string	Service owner ID.	123
TotalRecordCount	integer	Total record count.	1

Examples

Sample success responses

JSONformat

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

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