All Products
Search

This Product

    Auto Scaling:DetachVServerGroups

    Document Center

    Auto Scaling:DetachVServerGroups

    Last Updated:Nov 11, 2024

    Detaches vServer groups from a scaling group. Auto Scaling supports the attachment of load balancers to scaling groups to improve service performance. If the load balancer currently attached to your scaling group is no longer needed to distribute the access traffic to the instances in your scaling group, you can call the DetachVServerGroups operation to detach one or more vServer groups of this load balancer from the scaling group.

    Operation description

    • When you call the DetachVServerGroups operation, you must use the following parameters to specify the vServer groups that you want to detach from your scaling group:

      • LoadBalancerId: the ID of the load balancer
      • VServerGroupId: the ID of the vServer group
      • Port: the port number of the vServer group

    • When the vServer group specified by the request parameters matches that attached to your scaling group, this operation yields a favorable result. Otherwise, the request is ignored and no error is reported.

    • Before you call this operation, you must make sure that the load balancer has ceased routing the access traffic to the instances in the scaling group. Failure to do so may lead to service requests being dropped or lost during the detachment process.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ess:DetachVServerGroupsupdate
    • ScalingGroup
      acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the scaling group. Examples: cn-hangzhou and cn-shanghai.

    		cn-hangzhou
    ScalingGroupIdstringYes

    The ID of the scaling group.

    		asg-bp1fo0dbtsbmqa9h****
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see Ensure idempotence.

    		123e4567-e89b-12d3-a456-42665544****
    ForceDetachbooleanNo

    Specifies whether to remove the existing instances in the scaling group from the vServer group marked for detachment.

    • true: If you set this parameter to true, the detachment of the load balancer from the scaling group causes automatic removal of the existing instances in the scaling group from the corresponding vServer group.
    • false: If you set this parameter to false, the detachment of the load balancer from the scaling group does not cause automatic removal of the existing instances in the scaling group from the corresponding vServer group.

    Default value: false.

    		false
    VServerGroupsarray<object>Yes

    The collection of information about the vServer groups marked for detachment.

    objectYes

    Details of the vServer groups.

    VServerGroupAttributesarray<object>No

    The attributes of the backend vServer group.

    objectNo

    Details of the vServer group attributes.

    VServerGroupIdstringNo

    The ID of the backend vServer group.

    		rsp-bp1jp1rge****
    PortintegerNo

    The port number that Auto Scaling employs to incorporate instances into the vServer group. Valid values: 1 to 65535.

    		22
    LoadBalancerIdstringNo

    The ID of the load balancer to which the vServer group belongs.

    Note You can detach vServer groups of up to five load balancers from a scaling group in one call.
    		lb-bp1p90y3ya9h8s62d****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history