tencent cloud

DeregisterInstancesFromLoadBalancer
Last updated: 2024-12-19 17:17:54
DeregisterInstancesFromLoadBalancer
Last updated: 2024-12-19 17:17:54

API Description

This API is used to unbind one or multiple CVM instances from a CLB instance.
API domain name: lb.api.qcloud.com

Request Parameters

The list below contains only the API request parameters. Common request parameters need to be added when a call is made. For more information, please see Common Request Parameters. The Action field of this API is DeregisterInstancesFromLoadBalancer.
Parameter Name
Required
Type
Description
loadBalancerId
Yes
String
CLB instance ID, which can be queried through the DescribeLoadBalancers API.
backends.n.instanceId
Yes
String
Unique ID of CVM instance, which can be obtained through the `unInstanceId` (recommended) or `instanceId` field returned by the DescribeInstances API. You can enter the IDs of multiple CVM instances (for example, for two CVM instances, enter `backends.0.instanceId&backends.1.instanceId`).

Response Parameters

Parameter Name
Type
Description
code
Int
Common error code. 0: success; other values: failure. For more information, please see Common Error Codes.
message
String
Module error message related to the API.
codeDesc
String
Error code. For a successful operation, "Success" will be returned. For a failed operation, a message describing the failure will be returned.
requestId
Int
Request task ID. This API is an async task. You can call the DescribeLoadBalancersTaskResult API to query the task operation result based on this parameter.

Sample

Request
https://lb.api.qcloud.com/v2/index.php?Action=DeregisterInstancesFromLoadBalancer
&loadBalancerId=lb-abcdefgh
&backends.0.instanceId=ins-1234test
&backends.1.instanceId=ins-6789test
Return
{
  "code" : 0,
  "message" : "",
  "codeDesc": "Success",
  "requestId" : 1234
}

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback