ModifyDomainAttributes

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-04-07 19:47:20

Download PDF

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.

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

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 parameter. The value used for this API: ModifyDomainAttributes.
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	CLB listener ID
Domain	Yes	String	Domain name, which must be under a created forwarding rule.
NewDomain	No	String	New domain name
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	A listener must be configured with a default domain name. If you need to disable the default domain name, you must specify another one as the new default domain name.

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

https://clb.tencentcloudapi.com/?Action=ModifyDomainAttributes
&LoadBalancerId=lb-1wvl0ejw
&ListenerId=lbl-n8mb2r3a
&Domain=foo.net
&<Common request parameters>

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.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameter.FormatError	Wrong parameter format.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.Length	Wrong parameter length.
MissingParameter	Missing parameter.
UnauthorizedOperation	Unauthorized operation.

Recent Pages