1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API (ModifyDomainAttributes) is used to modify the domain name-level attributes of a layer-7 listener's forwarding rule, such as changing the domain name, changing the DefaultServer, enabling/disabling HTTP/2, and changing certificates.
This is an async API. After it returns a successful result, you need to call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.
Default interface request rate limit: 20 times per second.
Interface update time: 2021-04-06 21:40:04.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyDomainAttributes |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-03-17 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| LoadBalancerId | Yes | No | String | CLB instance ID Example: lb-1wvlji93 |
| ListenerId | Yes | No | String | CLB listener ID Example: lbl-n8mbji93 |
| Domain | Yes | No | String | Domain name (must be a domain name under an already created forwarding rule) Example: foo.net |
| NewDomain | No | No | String | The new domain name for modification Example: www.new.example.com |
| Certificate | No | No | CertificateInput | Domain name-related certificate information, applicable only to listeners with SNI enabled. Example:View |
| Http2 | No | No | Bool | Whether to enable HTTP/2. 1: yes, 0: no. Note: HTTP/2 can be enabled only for HTTPS domain names. Example: true |
| DefaultServer | No | No | Bool | Whether to set as the default domain name. true: Set as the default domain name. 0: Do not set as the default domain name. Note: Only one default domain name can be set under a listener. Example: true |
| NewDefaultServerDomain | No | No | String | A default domain name must be configured under the listener. To disable the original default domain name, another domain name must be simultaneously designated as the new default domain name. Example: www.yuncloud.example.com |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameter | Wrong parameter. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue | Incorrect parameter value |
| UnauthorizedOperation | Unauthorized operation |
| InvalidParameterValue.Length | Invalid parameter length. |
| MissingParameter | Missing parameter error. |
| FailedOperation | Failed to operate. |
| InternalError | Internal Error |