Domain name for API request: clb.intl.tencentcloudapi.com.
This API is used to start or stop a load balancing instance or listener.
This API is used to perform asynchronous operations. After returning a successful result, call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.
This feature is currently in beta test. To use it, submit a ticket for application.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SetLoadBalancerStartStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2018-03-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| OperationType | Yes | String | Operation type. Start: Start the instance; Stop: Stop the instance. |
| LoadBalancerId | Yes | String | ID of the cloud load balancer instance. you can call the DescribeLoadBalancers API to query the ID. |
| ListenerIds.N | No | Array of String | Listener ID. If this field is empty, it indicates operating the CLB instance; if not empty, it indicates operating the listener. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to enable or disable a CLB instance.
POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetLoadBalancerStartStatus
<Common request parameters>
{
"LoadBalancerId": "lb-hwdt33e0",
"OperationType": "Stop"
}{
"Response": {
"RequestId": "b3196d4c-2722-4893-8d86-e33136199469"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.NoListenerInLB | Instances without listeners cannot be stopped. |
| FailedOperation.ResourceInOperating | The specified resource is currently being operated. Please try again later. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.FormatError | Wrong parameter format. |
| InvalidParameter.ListenerIdNotFound | Wrong listener ID. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.Length | Wrong parameter length. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック