Modify the Domain Name of Application CLB layer-7 Listener

Last updated: 2018-06-25 15:47:02

PDF

API Description

This API (ModifyForwardLBRulesDomain) is used to modify the domain name under an application-based load balancer layer-7 listener.

Domain name for API access: lb.api.qcloud.com

Request Parameters

The following request parameter list only provides the API request parameters. Common request parameters are required when the API is called. For more information, please see Common Request Parameters page. The Action field for this API is ModifyForwardLBRulesDomain.

Parameter Name Required Type Description
loadBalancerId Yes String ID of load balancer instance. It can be queried by entering 1 or -1 in input parameter "forward" field through the API DescribeLoadBalancers.
listenerId Yes String ID of application-based load balancer listener, which can be queried via the API DescribeForwardLBListeners.
domain Yes String An old domain name under the listener.
newDomain Yes String Length limit: 1-80. Three formats are supported: non-regular expression, wildcard and regular expression. Non-regular expressions can only contain letters, numbers, "-", and ".". For wildcard format, "*" can only be placed at the beginning or the end. Regular expressions must start with "~".

Response Parameters

Parameter Name Type Description
code Int Common error code. 0: Successful; other values: Failed. For more information, please see Common Error Codes on the Error Codes page.
message String Module error message description depending on API.
codeDesc String Error code. For a successful operation, "Success" is returned. For a failed operation, a message describing the failure is returned.
requestId Int Request task ID. The operation status can be queried via the API DescribeLoadBalancersTaskResult.

Example

Request

https://lb.api.qcloud.com/v2/index.php?Action=ModifyForwardLBRulesDomain
&<Common request parameters>
&loadBalancerId=lb-ltkip4do
&listenerId=lbl-6hkiqc6c
&SSLMode=unidirectional

Response

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "requestId": 18642
}