ModifyDomainAttributes

Last updated: 2025-11-25 10:11:22

ModifyDomainAttributes

Last updated: 2025-11-25 10:11:22

1. API Description

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

This API is used to modify domain-level attributes of Cloud Load Balancer layer-7 listener forwarding rules, such as modifying domain name, changing DefaultServer, enabling/disabling Http/2, and modifying certificates.
This is an async API. After it returns a successful result, 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	ID of the CLB instance. You can call the DescribeLoadBalancers API to query the ID.
ListenerId	Yes	String	ID of the CLB instance listener. You can call the DescribeListeners API to query the ID.
Domain	Yes	String	Domain name (must be a domain name under a created forwarding rule). if it is multiple domains, you can specify any one of the domain name list. it can be accessed through the DescribeListeners api.
NewDomain	No	String	The one domain name to modify. `NewDomain` and `NewDomains` can not be both specified.
Certificate	No	CertificateInput	Certificate information of the domain name. It is only applicable to listeners with SNI enabled. `Certificate` and `MultiCertInfo` cannot be specified at the same time.
Http2	No	Boolean	Specifies whether to enable HTTP/2. note that only HTTPS domain names support HTTP/2. True: enable HTTP2. false: disable HTTP2.
DefaultServer	No	Boolean	Whether to set as the default domain name. Note: Only one default domain name can be set under a listener. True: set as default domain name. false: do not set as default domain name.
Quic	No	Boolean	Specifies whether QUIC is enabled. note that QUIC can only be enabled for HTTPS domains. True: enable QUIC. False: disable.
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.
MultiCertInfo	No	MultiCertInfo	Certificate information related to the domain name. Note: This applies only to listeners with SNI enabled. Multiple server certificates with different algorithm types can be input simultaneously, but this parameter cannot be input together with the Certificate.

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 Modifying the domain name attributes of a layer-7 listener

This example shows you how to modify the domain name attributes of a layer-7 listener.

Input Example

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

{
    "Domain": "foo.net",
    "ListenerId": "lbl-n8mb2r3a",
    "LoadBalancerId": "lb-1wvl0ejw"
}

Output Example

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

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

Tencent Cloud CLI 3.0

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.ResourceInOperating	The specified resource is currently being operated. Please try again later.
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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud