tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SetLoadBalancerStartStatus

Last updated: 2024-09-05 19:29:22

1. API Description

Domain name for API request: clb.tencentcloudapi.com.

This API is used to enable or disable a CLB instance or listener.This is an asynchronous API. After it returns a result successfully, the obtained RequestID should be used as an input parameter to call the DescribeTaskStatus API, for checking whether this task succeeds.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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 No String Common Params. This parameter is not required for this API.
OperationType Yes String Operation type. Start: Start the instance; Stop: Stop the instance.
LoadBalancerId Yes String CLB instance 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.

3. Output Parameters

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.

4. Example

Example1 Enabling or Disabling a CLB Instance

This example shows you how to enable or disable a CLB instance.

Input Example

POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetLoadBalancerStartStatus
<Common request parameters>



{
    "LoadBalancerId": "lb-xxxxxxxx",
    "OperationType": "Stop"
}

Output Example

{
    "Response": {
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy