Enable Multi-Domain HTTPS with SNI via API - Classic Load Balancer

Adds an additional domain name.

Operation description

Note

Listeners on shared-resource instances do not support additional domain names.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

slb:CreateDomainExtension

create

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Server Load Balancer (SLB) instance.	cn-hangzhou
LoadBalancerId	string	Yes	The ID of the SLB instance.	lb-bp1o94dp5i6earrxxxxxx
ListenerPort	integer	Yes	The frontend port that is used by the HTTPS listener of the SLB instance. Valid values: 1 to 65535.	443
Domain	string	Yes	The domain name.	*.example1.com
ServerCertificateId	string	No	The ID of the certificate used by the domain name.	123157xxxxxxx_166f820xxxxxx_1714763408_709981xxxx

Response elements

Element	Type	Description	Example
	object
ListenerPort	integer	The frontend port that is used by the SLB instance.	80
RequestId	string	The request ID.	A6E7EFC9-0938-40CA-877D-9BE******
DomainExtensionId	string	The ID of the additional domain name.	de-bp1rp7ta19******

Examples

Success response

JSON format

{
  "ListenerPort": 80,
  "RequestId": "A6E7EFC9-0938-40CA-877D-9BE******",
  "DomainExtensionId": "de-bp1rp7ta19******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAction.RegionNotSupport	The region does not support this action.
400	InvalidParameter.ServerCertificateId	The specified ServerCertificateId does not exist.
400	InvalidParameter.Domain	The specified Domain exists.
400	DomainExtensionProcessing	A previous configuration of the DomainExtension is pending, please try again later.
400	DomainExtensionNumberOverLimit	The number of domainExtension has reached to the quota limit of this listener.
400	DomainExtensionNotSupport	The instance with shared loadBalancerSpec does not support domainExtension.
400	InvalidParameter.CertificateId	The specified CertificateId contains duplicate certificate EncryptionAlgorithm.
400	InvalidParamSize.CertificateId	The size of parameter CertificateId is invalid.
400	MissingParameter.CertificateId	The parameter CertificateId is required.
400	InvalidParameter.RegionNotSupport	The region does not support the parameter: %s.
400	CertificateTypeMismatched	The certificate type does not match.
400	SPEC_NOT_SUPPORT_PARAMETER	The loadbalancer with share spec does not support the parameter.
400	CnCertificateNotSupport	The cn certificate is not support.
400	InvalidParam.CertificateBindingType	The param is invalid.
400	MissingParam.ServerCertificates	The param ServerCertificates is missing.
400	InvalidParamSize.ServerCertificates	The size of param ServerCertificates is invalid.
400	TooManyListeners	More than 1 listener is found, please be more specified.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.