DescribeDataSources - Cloud Backup - Alibaba Cloud Documentation Center

Queries a list of data sources. Filter results by data source type, data source ID, data source name, or client group ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of data sources to return on each page.	10
DataSourceType	string	No	The data source type.	COMMON_NAS
ClusterId	string	No	The client group ID used to access the data source.	cl-0003jyv******fsku5m
DataSourceId	string	No	The data source ID.	ds-000******2nqeo
DataSourceName	string	No	The data source name.	MyLocalNas

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	36A5CD24-**--**-5F30C3F1753F
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	The HTTP status code. A value of 200 indicates success.	200
Message	string	The response message. The value is "successful" if the request was successful, or an error message if the request failed.	successful
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	The page size. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of returned data sources.	20
DataSources	array<object>	The data sources.
	object	The details of a data source.
IndexLevel	string	The index level. Valid values: OFF: No index is created. META: A metadata index is created. ALL: A full-text index is created. This value is deprecated.	META
Schedule	string	The analysis schedule. Archiving feature only. Format: `I\|{startTime}\|{interval}`. `{startTime}` is the start time as a UNIX timestamp in seconds. `{interval}` is the execution interval in ISO 8601 format. Example: PT1H for one hour, P1D for one day.	I\|1729493847\|P1D
DataSourceName	string	The data source name.	COMMON_NAS
DataSourceId	string	The data source ID.	ds-000******2nqeo
Options	string	The analysis options. Archiving feature only.	{}
SpeedLimit	string	The rate limit configuration. Archiving feature only.	6:21:10240
PlanId	string	The analysis plan ID. Archiving feature only.	plan-123***7890
IndexUpdateTime	boolean	The time when the index was last updated. UNIX timestamp in seconds. Archiving feature only.	1745454604
Exclude	string	The paths excluded from analysis. Archiving feature only.	[ "/home/alice/log" ]
Indexing	boolean	Whether an index is being built. Archiving feature only.	false
UpdatedTime	integer	The time when the data source was last updated. UNIX timestamp in seconds.	1745454604
DataSourceType	string	The data source type.	COMMON_NAS
ConnectionInfo	string	The connection information of the data source, which describes how to access the data source.	{ "dataServerAddresses": [ { "host": "123.123.123.123", "port": "8080" } ], "sharePath": "/share", "mountOptions": "vers=3", "fileSystemType": "nfs" }
IndexAvailable	boolean	Whether the index is available. Archiving feature only.	true
CreatedTime	integer	The time when the data source was created. UNIX timestamp in seconds.	1770257653
Include	string	The paths included in the analysis. Archiving feature only.	[ "/home/alice", "/home/bob" ]
ClusterId	string	The client group ID used to access the data source.	cl-0003jyv******fsku5m
Paths	array	The analysis paths. Archiving feature only.
	string	An analysis path. Archiving feature only.	/home

Examples

Success response

JSON format

{
  "RequestId": "36A5CD24-****-****-****-5F30C3F1753F",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "DataSources": [
    {
      "IndexLevel": "META",
      "Schedule": "I|1729493847|P1D\t",
      "DataSourceName": "COMMON_NAS",
      "DataSourceId": "ds-000******2nqeo",
      "Options": "{}",
      "SpeedLimit": "6:21:10240",
      "PlanId": "plan-123***7890",
      "IndexUpdateTime": true,
      "Exclude": "[\n      \"/home/alice/log\"\n]",
      "Indexing": false,
      "UpdatedTime": 1745454604,
      "DataSourceType": "COMMON_NAS",
      "ConnectionInfo": "{\n    \"dataServerAddresses\": [\n        {\n            \"host\": \"123.123.123.123\",\n            \"port\": \"8080\"\n        }\n    ],\n    \"sharePath\": \"/share\",\n    \"mountOptions\": \"vers=3\",\n    \"fileSystemType\": \"nfs\"\n}",
      "IndexAvailable": true,
      "CreatedTime": 1770257653,
      "Include": "[\n      \"/home/alice\",\n      \"/home/bob\"\n]",
      "ClusterId": "cl-0003jyv******fsku5m",
      "Paths": [
        "/home"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.