All Products
Search
Document Center

AnalyticDB:DescribeApsDatasources

Last Updated:Nov 10, 2025

Queries a list of AnalyticDB Pipeline Service (APS) data sources.

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
adb:DescribeApsDatasourcesnone
*DBClusterLakeVersion
acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerYes

The page number.

1
PageSizeintegerYes

The number of entries per page.

30
RegionIdstringNo

The region ID.

cn-hangzhou
DBClusterIdstringNo

The ID of the AnalyticDB for MySQL cluster.

amv-******
DatasourceTypestringNo

The type of the data source.

SLS
DatasourceNamestringNo

The name of the data source.

test
StartTimestringNo

The beginning of the time range to query.

2024-01-01
EndTimestringNo

The end of the time range to query.

2024-01-30

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

******-5213-******-B608-******
PageNumberstring

The page number.

1
PageSizestring

The number of entries per page.

30
TotalCountstring

The total number of entries returned.

1
ApsDatasourcesarray<object>

The queried APS data sources.

-
datasourceVOSobject

The queried APS data source.

DatasourceNamestring

The name of the data source.

test
CreateTimestring

The time when the data source was created.

2024-01-10 14:44:33
DatasourceTypestring

The type of the data source.

SLS
DatasourceDescriptionstring

The description of the data source.

test
DatasourceIdlong

The data source ID.

1
HasJobboolean

Indicates whether a job is using the data source.

false

Examples

Sample success responses

JSONformat

{
  "RequestId": "******-5213-******-B608-******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "ApsDatasources": [
    {
      "DatasourceName": "test",
      "CreateTime": "2024-01-10 14:44:33",
      "DatasourceType": "SLS",
      "DatasourceDescription": "test",
      "DatasourceId": 1,
      "HasJob": false
    }
  ]
}

Error codes

HTTP status codeError codeError message
400InvalidInputThe specified parameter is invalid.

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