Update workspace resources using UpdateWorkspaceResource - Platform For AI

Updates the resources of a workspace.

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

paiworkspace:UpdateWorkspaceResource

*All Resource

*

None

Request syntax

PUT /api/v1/workspaces/{WorkspaceId}/resources HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID. For more information about how to obtain a workspace ID, see ListWorkspaces.	123

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
IsDefault	boolean	No	Specifies whether the resource is the default resource. This parameter currently supports only true. false is not supported.	true
ProductType	string	No	This field is deprecated and will be removed. Use the ResourceType field instead.	MaxCompute
GroupName	string	No	The group name.	group-kjds******sd
ResourceType	string	No	The list of resource types. Valid values: MaxCompute: MaxCompute resources ECS: general computing resources Lingjun: Lingjun resources ACS: ACS computing resources FLINK: Flink resources	MaxCompute
Labels	array<object>	No	The collection of resource tags. If you specify multiple tags, only the resources that have all these tags are returned.
	object	No	The resource tag.
Key	string	No	The key of the tag.	system.******
Value	string	No	The value of the tag.	True
ResourceIds	array	No	The collection of resource IDs. GroupName and ResourceIds cannot both be empty. If both are specified, the GroupName must be the same for all resource IDs in the collection.
	string	No	The resource ID.	Resource-dks******jkf
Spec	object	No	The specifications of the resource.	{ "clusterType": "share" }

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	5A14FA81-DD4E-******-6343FE44B941
ResourceIds	array	The collection of IDs of the updated resources.	Resource-dks******jkf
	string	The ID of the updated resource.	Resource-dks******jkf

Examples

Success response

JSON format

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "ResourceIds": [
    "Resource-dks******jkf\n"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.