Modify instance network configurations using ModifyInstanceNetworkOptions - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

调用该接口时，您需要注意：

当前接口是异步接口。调用后返回异步任务 ID。通查查询异步任务结果来判断是否执行完成。
当前接口每次调用仅支持修改一个属性。如果修改多个属性，请分多次调用。
修改 BandwidthWeighting，需要对应的规格支持设置该参数。您可以通过 DescribeInstanceTypes 查询当前实例规格是否支持带宽权重及支持的带宽权重值。

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

ecs:ModifyInstanceNetworkOptions

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance whose network bandwidth weight is to be modified.	i-bp67acfmxazb4p****
BandwidthWeighting	string	No	The bandwidth weight. The supported values vary with instance types. You can query the bandwidth weights supported by the current instance type by using the DescribeInstanceTypes. Valid values: Vpc-L1: Vpc-L1. Vpc-L2: Vpc-L2. Ebs-L1: Ebs-L1. Ebs-L2: Ebs-L2. Default: the Default. Valid values: Vpc-L1 : Vpc-L1 Vpc-L2 : Vpc-L2 Ebs-L1 : Ebs-L1 Ebs-L2 : Ebs-L2 Default : Default	Vpc-L1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	The ID of the task for which the bandwidth weight is modified. You can use the DescribeTaskAttribute interface to modify the bandwidth weight result.	t-bp198jigq7l0h5ac****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-bp198jigq7l0h5ac****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
400	InvalidInstanceType.NetworkOptionsBandwidthWeightingUnsupported	The current instance type does not support setting or modifying the BandwidthWeighting parameter.	The current instance type does not support setting or modifying the BandwidthWeighting parameter.
400	InvalidParameter.NetworkOptionsBandwidthWeighting	The specified parameter BandwidthWeighting is not valid.The correct value should be in [%s].	The specified parameter BandwidthWeighting is not valid.The correct value should be in [%s].
404	InvalidInstanceId.NotFound	Specified instance does not exist.	The specified instance does not exist. Check whether the instance ID is correct.
503	LimitedOperation.ServiceUnavailable	The service is currently unavailable. Please try again later.	The service is currently unavailable. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.