UpdateWorkspace - E-MapReduce - Alibaba Cloud Documentation Center

Updates the properties 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

emr-serverless-spark:UpdateWorkspace

update

*All Resource

*

None

Request syntax

POST /api/v1/workspaces/update HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request struct.
workspaceId	string	No	The workspace ID.	w-975bcfda9625****
workspaceName	string	No	The workspace name.	default
cu	integer	No	The upper limit of workspace resources.	5000
subscription	object	No	The information for converting from pay-as-you-go to subscription.
queue	array	No	The list of running queues to be converted.
	string	No	The running queue to be converted.	dev_queue
paymentDurationUnit	string	No	The subscription period unit.	MONTH
duration	string	No	The number of subscription periods. This parameter is required for the pre-paid billing type.	1799
autoRenew	string	No	Specifies whether to enable auto-renewal. This parameter is required for the pre-paid billing type.	true
autoRenewPeriod	string	No	The auto-renewal duration. This parameter is required for the pre-paid billing type.	1
autoRenewPeriodUnit	string	No	The auto-renewal period unit. This parameter is required for the pre-paid billing type.	MONTH
clientToken	string	No	The idempotency token.	my-token-asxkxxxxxxx
resourceGroupId	string	No	The resource group ID.	rg-acfmwpi66knkxny
gpu	integer	No	The number of GPU cards.	100
gpuSpec	array	No	The GPU instance type.
	string	No	The GPU instance type.	ecs-gpu-8x-large
ipWhiteList	array	No	The IP whitelist.
	string	No	An IP address to include in the IP whitelist.	0.0.0.1
gpuSubscription	object	No
instanceTypeId	string	No		ecs.gn7i-c8g1.2xlarge
operation	string	No		BUY
gpuMachineNum	integer	No		8
paymentDurationUnit	string	No
duration	integer	No
autoRenew	boolean	No
instanceId	string	No
regionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	DD6B1B2A-5837-5237-ABE4-FF0C8944****
data	object	The returned data.
orderId	string	The order ID.	1005565802416783361
orderId	string	The order ID.	979071171373334529

Examples

Success response

JSON format

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "data": {
    "orderId": "1005565802416783361"
  },
  "orderId": "979071171373334529"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.