DescribeDataSources - Cloud Backup - Alibaba Cloud Documentation Center

Lists data sources.

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 number of the page to return. Pages start from 1. Default: 1.	1
PageSize	integer	No	The number of data sources to return per page.	10
DataSourceType	string	No	The type of the data source.	COMMON_NAS
ClusterId	string	No	The ID of the client group used to access the data source.	cl-0003jyv******fsku5m
DataSourceId	string	No	The ID of the data source.	ds-000******2nqeo
DataSourceName	string	No	The name of the data source.	MyLocalNas

Response elements

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