UpdateDataSource - Cloud Backup - Alibaba Cloud Documentation Center

Updates the data source configuration.

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
DataSourceId	string	Yes	The ID of the data source.	ds-0006xo****dtle
DataSourceName	string	No	The name of the data source.	MyLocalNas
Credential	string	No	The access credentials for the data source. This parameter is used for on-premises NAS data sources that use the SMB protocol, and for OSS and S3 protocol-compatible data sources. Examples: On-premises NAS data source (SMB protocol): { "mountUsername": "***", "mountPassword": "*" } OSS protocol-compatible data source/S3 protocol-compatible data source: { "accessKeyId": "*", "accessKeySecret": "***" }	{"mountUsername":"*","mountPassword":"*"}
ConnectionInfo	string	No	The connection information for the data source. Examples: On-premises NAS data source: { "dataServerAddresses": [ { "host": "123.123.123.123", "port": "8080" } ], "sharePath": "/share", "mountOptions": "vers=3", "fileSystemType": "nfs" } Intelligent Computing CPFS data source: {"vpcMountTarget":"cpfs-010wn*wy-vpc-ta*8.cn-shanghai.cpfs.aliyuncs.com","sharePath":"/"} Other large-scale file system data sources: {"path":"/mnt"}	{ "dataServerAddresses": [ { "host": "123.123.123.123", "port": "8080" } ], "sharePath": "/share", "mountOptions": "vers=3", "fileSystemType": "nfs" }
IndexLevel	string	No	The index level for data source analysis. This parameter applies only to the archive feature. OFF: No index is created. META: A metadata index is created. ALL: A full-text index is created. (Deprecated) Valid values: META : META OFF : OFF	META
ClusterId	string	No	The ID of the client group used to access the data source.	cl-000**************hg9
Schedule	string	No	The schedule for data source analysis. This parameter applies only to the archive feature. The format is `I\|{startTime}\|{interval}`. This specifies a task that starts at `{startTime}` and repeats at the specified `{interval}`. `startTime` is a Unix time value in seconds. `interval` is an ISO 8601 time interval. For example, `PT1H` indicates a one-hour interval, and `P1D` indicates a one-day interval.	I\|1729493847\|P1D
SpeedLimit	string	No	The rate limiting configuration for data source analysis. This parameter applies only to the archive feature.	0:24:102400
Options	string	No	The options for data source analysis. This parameter applies only to the archive feature.	{}
Include	string	No	A filter to specify which files to include. This parameter applies only to the archive feature.	["/home/alice/", "/home/bob/"]
Exclude	string	No	A filter to specify which files to exclude. This parameter applies only to the archive feature.	["/home/alice/log/"]
Path	array	No	A list of paths for data source analysis. This parameter applies only to the archive feature.
	string	No	A path for data source analysis. This parameter applies only to the archive feature.	/home

Response elements

Element	Type	Description	Example
	object	The response object.
Code	string	The response code. A value of 200 indicates success.	200
Message	string	The response message. If the request is successful, `successful` is returned. Otherwise, an error message is returned.	successful
RequestId	string	The request ID.	1F22A695-*--**-DDC66F5E5ACB
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "1F22A695-***-***-***-DDC66F5E5ACB",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.