All Products
Search
Document Center

AnalyticDB:ListExternalDataServices

Last Updated:Jan 23, 2026

Queries a list of external data services.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:ListExternalDataServiceslist
*DBInstance
acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBInstanceIdstringYes

The instance ID.

Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
gp-bp10g78o9807yv9h3
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

50

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
TotalRecordCountinteger

The total number of entries returned.

2
PageNumberinteger

The page number.

1
ServiceItemsarray<object>

The queried services.

itemsobject
ServiceIdstring

The service ID.

1
ServiceTypestring

The type of the service. Valid values:

  • pxf
pxf
ServiceNamestring

The name of the service.

test-adbpgss
ServiceDescriptionstring

The description of the service.

test-adbpgss
ServiceSpecstring

The specifications of the service. Unit: compute units (CUs).

2
Statusstring

The status of the service. Valid values:

  • Init
  • Running
  • Exception
  • Paused
Running
CreateTimestring

The time when the service was created.

2019-09-08T16:00:00Z
ModifyTimestring

The time when the service was last modified.

2019-09-08T17:00:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "TotalRecordCount": 2,
  "PageNumber": 1,
  "ServiceItems": [
    {
      "ServiceId": 1,
      "ServiceType": "pxf",
      "ServiceName": "test-adbpgss",
      "ServiceDescription": "test-adbpgss",
      "ServiceSpec": 2,
      "Status": "Running",
      "CreateTime": "2019-09-08T16:00:00Z",
      "ModifyTime": "2019-09-08T17:00:00Z"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history