UpdateDataset - Platform For AI - Alibaba Cloud Documentation Center

Updates the properties of a dataset, such as its name and description.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

paidataset:UpdateDataset

update

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	The ID of the dataset. For more information, see ListDatasets.	d-rbvg5wz****c9ks92

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
Name	string	No	The name of the dataset. For more information, see ListDatasets.	myName
Description	string	No	The description.	This is a description of the dataset.
Options	string	No	An extended field in the JSON string format. When Data Lake Compute (DLC) uses the dataset, you can set the mountPath field to specify the default mount path.	{ "mountPath": "/mnt/data/" }
Edition	string	No	The type of the dataset. You can upgrade the dataset from BASIC to ADVANCED.	ADVANCED
MountAccessReadWriteRoleIdList	array	No	A list of workspace roles that have read and write permissions when the dataset is mounted. Role IDs that start with PAI are basic role IDs. Role IDs that start with role- are custom role IDs. If the list contains an asterisk (), all roles have read and write permissions. Specified roles: ["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"] All roles: [""] Only the dataset creator: []
	string	No	A workspace role ID.	PAI.AlgoOperator
SharingConfig	object	No	The sharing configuration of the dataset.
SharedTo	array	No	The sharing relationships of the dataset.
	DatasetShareRelationship	No	A sharing relationship.

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request.	5A14FA81-DD4E-******-6343FE44B941

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.