UpdateDataset - Platform For AI - Alibaba Cloud Documentation Center

Updates the name, description, and other information about a dataset.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
paidataset:UpdateDataset	update	All Resources ``	none	none

Request syntax

PUT /api/v1/datasets/{DatasetId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	The dataset ID. You can call ListDatasets to obtain the dataset ID.	d-rbvg5wz****c9ks92
body	object	No	The request data.
Name	string	No	The dataset name. You can call ListDatasets to obtain the dataset name.	myName
Description	string	No	The description of the dataset.
Options	string	No	The extended field, which is a JSON string. When you use the dataset in Deep Learning Containers (DLC), you can configure the mountPath field to specify the default mount path of the dataset.	{ "mountPath": "/mnt/data/" }
MountAccessReadWriteRoleIdList	array	No	The list of role names in the workspace that have read and write permissions on the mounted database. The names start with PAI are basic role names and the names start with role- are custom role names. If the list contains asterisks (), all roles have read and write permissions. If you set the value to ["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"], the account of the specified role is granted the read and write permissions. If you set the value to [""], all accounts are granted the read and write permissions. If you set the value to [], only the creator of the dataset has the read and write permissions.
	string	No	The ID of the workspace role.	PAI.AlgoOperator

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	5A14FA81-DD4E-******-6343FE44B941

Examples

Sample success responses

JSONformat

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-02-06	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-07-09	The internal configuration of the API is changed, but the call is not affected	View Change Details