ModifyInstanceSpec-阿里云帮助中心

Call this API to scale a workspace up or down.

Operation description

Before you use this API, review the billing methods and pricing for Realtime Compute for Apache Flink.

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

stream:ModifyVvpInstanceSpec

update

*VvpInstance

acs:stream:{#regionId}:{#accountId}:vvpinstance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region ID.	cn-beijing
InstanceId	string	Yes	The ID of the instance.	f-cn-wwo36qj4g06
ResourceSpec	object	Yes	The resource specifications.
Cpu	integer	Yes	The number of vCores.	10
MemoryGB	integer	Yes	The memory size. Note The memory size must be four times the number of vCores.	40
Ha	boolean	No	Specifies whether the workspace has zone-redundant high availability (HA) resources.	true
HaVSwitchIds	array	No	The vSwitch IDs for the secondary zone in the zone-redundant HA configuration.
	string	No	A vSwitch ID for the secondary zone.	[\"vsw-j6cft0ogy3agwdi3w8h21\"]
HaResourceSpec	object	No	The resource specifications for the zone-redundant HA configuration.
Cpu	integer	No	The number of vCores.	10
MemoryGB	integer	No	The memory size. Note The memory size must be four times the number of vCores.	40
UsePromotionCode	boolean	No
PromotionCode	string	No

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	67F33190-946B-1105-B6A1-E2DF0426DD51
OrderId	integer	The order ID.	211473228320700
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "67F33190-946B-1105-B6A1-E2DF0426DD51",
  "OrderId": 211473228320700,
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.