tencent cloud



Last updated: 2022-05-19 15:57:45

1. API Description

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

This API is used to modify the domain name-level attributes of a layer-7 listener's forwarding rule, such as modifying the domain name, changing the DefaultServer, enabling/disabling HTTP/2, and modifying certificates.
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.

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: ModifyDomainAttributes.
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.
LoadBalancerId Yes String CLB instance ID
ListenerId Yes String CLB listener ID
Domain Yes String The domain name, which must be associated with an existing forwarding rule. If there are multiple domain names, you only need to specify one.
NewDomain No String The one domain name to modify. NewDomain and NewDomains can not be both specified.
Certificate No CertificateInput Domain name certificate information. Note: This is only applicable to SNI-enabled listeners.
Http2 No Boolean Whether to enable HTTP/2. Note: HTTP/2 can be enabled only for HTTPS domain names.
DefaultServer No Boolean Whether to set this domain name as the default domain name. Note: Only one default domain name can be set under one listener.
NewDefaultServerDomain No String Specifies a new default domain name for the listener. This field is used when the original default domain name is disabled. If there are multiple domain names, specify one of them.
NewDomains.N No Array of String The new domain names to modify. NewDomain and NewDomains can not be both specified.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the domain name attributes of a layer-7 listener

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "db141822-c025-4765-88d4-02bdec0e67ed"

5. Developer Resources


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 Incorrect parameter value.
InvalidParameterValue.Length Wrong parameter length.
LimitExceeded Quota exceeded.
MissingParameter Missing parameter.
UnauthorizedOperation Unauthorized operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support