Docs

Load Balancer

CLB instances

SetLoadBalancerRenewal - Setting the CLB renewal type

Call the SetLoadBalancerRenewal API to set the renewal type for subscription CLB instances.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Action String required Example: SetLoadBalancerRenewal

Action to execute. Set the value to SetLoadBalancerRenewal.

Version String required Example: 2020-04-01

API version. The current version is 2020-04-01.

LoadBalancerId String required Example: clb-bp1b6c719dfa08ex****

CLB Instance ID.

You can call the DescribeLoadBalancers API to query the CLB Instance ID.

RenewType Integer required Example: 2

Renewal type of the CLB instance. Valid values:

1: Manual renewal

2: Automatic renewal.

RenewPeriodTimes Integer optional Example: 1

The period for a single automatic renewal, in month.

This parameter is valid when the parameter RenewType is set to 2.

Valid values: 1–3, 6, and 12. Default: 1.

RemainRenewTimes Integer optional Example: -1

The number of automatic renewals available.

This parameter is valid when the parameter RenewType is set to 2.

Values include -1 and 1 to 100. The default is -1, meaning unlimited automatic renewals.

Response parameters

RequestId String Example: 20210811152539010225146063030****

Request ID.

Request examples

GET /?Action=SetLoadBalancerRenewal&Version=2020-04-01&LoadBalancerId=clb-bp1b6c719dfa08ex****&RenewType=2&RenewPeriodTimes=1&RemainRenewTimes=-1​
Host: clb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/clb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "SetLoadBalancerRenewal",​
        "Version": "2020-04-01",​
        "Service": "clb",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "RequestId": "20210811152539010225146063030****"​
    }​
}​

Error codes

This section displays only the error codes of the current API. For more error codes, see Common error codes.

Status code	Error codes	Error message	Notes
400	InvalidLoadBalancer.InvalidStatus	The specified LoadBalancer is not in the correct status for the request.	The specified load balancer cannot respond to this request due to its status.
400	InvalidLoadBalancer.UnSupportAction	The specified LoadBalancer does not support this action.	The specified CLB does not support this action.
400	InvalidRemainRenewTimes.Malformed	The specified RemainRenewTimes is malformed.	The specified RemainRenewTimes parameter format is invalid.
400	InvalidRenewPeriodTimes.Malformed	The specified RenewPeriodTimes is malformed.	The specified RenewPeriodTimes parameter format is invalid.
400	InvalidRenewType.Malformed	The specified RenewType is malformed.	The specified RenewType parameter format is invalid.
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'LoadBalancerId'.	This request is missing a required parameter. Please ensure the request includes all required parameters, such as LoadBalancerId.
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'RenewType'.	This request is missing a required parameter. Please ensure the request includes all required parameters, such as RenewType.
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the ''.	This request is missing a required parameter. Ensure the request includes all required parameters, such as .
400	OrderError.OrderPay	Failed to create order and pay.	The order payment failed.
400	UnsupportedOperation.AccountArrears	The request on the specified instance is denied due to the account in arrears status.	The action request on this instance is denied because the account is in arrears.
403	InvalidResourceType.ServcieManaged	The specified ResourceType is managed by a service.	The specified resource is a service-managed resource.
404	InvalidLoadBalancer.NotFound	The specified LoadBalancer does not exist.	The specified load balancer does not exist.
412	InvalidLoadBalancer.InvalidBillingType	The specified LoadBalancer is not in the correct BillingType for the request.	The specified CLB's billing method is incompatible with this request.
500	InternalError	An internal error has occurred.	An internal error occurred.

Last updated: 2026.05.09 10:34:42