ModifyInstanceAttribute

Updated at:

Modifies specific attributes of an ECS instance in a scaling group by specifying parameters such as the instance ID, scaling group ID, and region ID. Currently, only the lifecycle management attribute of instances manually added to the scaling group can be modified.

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

ess:ModifyInstanceAttribute

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None None

Request parameters

Parameter

Type

Required

Description

Example

ScalingGroupId

string

Yes

The ID of the ECS instance in the scaling group.

asg-bp18p2yfxow2dloq****

InstanceId

string

No

The ID of the scaling group.

i-bp109k5j3dum1ce6****

Entrusted

boolean

Yes

Specifies whether to entrust the lifecycle of an ECS instance manually added to a scaling group to the scaling group. Valid values:

  • true: Entrusted. The lifecycle of the instance is managed by elastic scaling, which is the same as that of instances automatically created in the scaling group. The instance is automatically released when it is removed from the scaling group, excluding instances removed by calling the DetachInstances operation.

  • false: Not entrusted. The instance is not released when it is removed from the scaling group.

Note

This parameter applies only to instances manually added to a scaling group, and not to instances created within a scaling group.

true

RegionId

string

Yes

The region ID of the scaling group.

cn-hangzhou

InstanceIds

array

No

The IDs of the ECS instances in the scaling group.

string

No

The instance ID.

i-bp109k5j3dum1ce6****

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.