Help & DocumentationCloud Load BalancerAPI DocumentationCLB APIsCreateRule

CreateRule

Last updated: 2020-03-16 17:04:17

PDF

1. API Description

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

This API (CreateRule) is used to create a forwarding rule under an existing layer-7 CLB listener, where real servers must be bound to the rule instead of the listener.
This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateRule.
Version Yes String Common parameter. The value used for this API: 2018-03-17.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String CLB instance ID
ListenerId Yes String Listener ID
Rules.N Yes Array of RuleInput Information of the new forwarding rule

3. Output Parameters

Parameter Name Type Description
LocationIds Array of String Array of unique IDs of created forwarding rules
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a forwarding rule

Input Example

https://clb.tencentcloudapi.com/?Action=CreateRule
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-4fbxq45k
&Rules.0.Domain=foo.net
&Rules.0.Url=/bar
&<Common request parameters>

Output Example

{
  "Response": {
    "LocationIds": [
      "loc-ho6lvh8m"
    ],
    "RequestId": "6c915c06-53e0-4717-9358-09b32cf47f08"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError Wrong parameter format.
InvalidParameterValue Wrong parameter value.
InvalidParameterValue.Length Wrong parameter length.
LimitExceeded Reached quota.
MissingParameter Missing parameter.
ResourceInsufficient Insufficient resource.
UnauthorizedOperation Unauthorized operation.