Automate Virtual Resource Group Updates with API - Platform for AI - Alibaba Cloud - Platform For AI

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

eas:UpdateVirtualResource

update

*VirtualResource

acs:eas:{#regionId}:{#accountId}:virtualresource/{#VirtualResourceId}

None

Request syntax

PUT /api/v2/virtualresources/{ClusterId}/{VirtualResourceId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The region ID of the virtual resource group.	cn-hangzhou
VirtualResourceId	string	Yes	The ID of the virtual resource group.	eas-vr-npovr28onap1xxxxxx

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
Resources	array<object>	No	The resources in the virtual resource group. Note If you specify this parameter, previous data is overwritten.
	object	No	The details of the resource.
Region	string	No	The region of the resource.	cn-hangzhou
Priority	integer	No	The priority of resource scheduling. A higher value indicates a higher priority.	6
InstanceType	string	No	The instance type of the public resource group. Note You must specify one and only one of the InstanceType, ResourceId, and QuotaId parameters.	ecs.s6-c1m2.xlarge
ResourceId	string	No	The ID of the dedicated resource group. To obtain the ID, see ListResources. Note You must specify one and only one of the InstanceType, ResourceId, and QuotaId parameters.	eas-r-g55ieatgg3butwrn7a
QuotaId	string	No	The ID of the Lingjun resource quota. Note You must specify one and only one of the InstanceType, ResourceId, and QuotaId parameters.	quota185lqf994k6
SpotPriceLimit	number	No	The maximum price of preemptible instances in a public resource group. Note If you leave this parameter empty, preemptible instances are not used.	10.05
VirtualResourceName	string	No	The new name of the virtual resource group.	NewMyVirtualResource
DisableSpotProtectionPeriod	boolean	No	Whether to disable the retention period of preemptible instances.	true

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	40325405-579C-4D82****
Message	string	The returned message.	Successfully updated virtual resource eas-vr-npovr28onap1xxxxxx

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "Successfully updated virtual resource eas-vr-npovr28onap1xxxxxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.