Secure Multi-Domain HTTPS with ALB Extension Certificates - Application Load Balancer - Alibaba Cloud - Server Load Balancer

Associates additional certificates with a listener.

Operation description

The AssociateAdditionalCertificatesWithListener is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the GetListenerAttribute operation to query the status of the task:

If an HTTPS or QUIC listener is in the Associating state, the certificate association is in progress.
If an HTTPS or QUIC listener is in the Associated state, the certificate association is complete.

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

alb:AssociateAdditionalCertificatesWithListener

create

*LoadBalancer

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

None

Request parameters

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	The listener ID. This parameter applies only to HTTPS and QUIC listeners.	lsn-5qnirjhpt******
Certificates	array<object>	Yes	The additional certificates.
	object	No	An additional certificate.
CertificateId	string	Yes	The certificate ID. The certificate must be a server certificate. Note The certificate ID must be globally unique and end with a region ID. For example, 1011****-cn-hangzhou.	1011****-cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate a client token and make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each API request is unique.	5A2CFF0E-5718-45B5-9D4D-70B3F******
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, and service limits without associating the additional certificate. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): sends a normal request. If the request passes the check, the system returns an HTTP `2xx` status code and performs the operation.	true

Response elements

Element	Type	Description	Example
	object
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF3******

Examples

Success response

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.
400	OperationDenied.DefaultCertificateUsed	The operation is not allowed because of %s.
400	OperationFailed.DefaultCertificateNotFound	The operation failed because of %s.	The operation failed because of %s.
400	ResourceAlreadyAssociated.Certificate	The specified resource %s is already associated.
400	ResourceQuotaExceeded.LoadBalancerCertificatesNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	OperationDenied.HttpListenerNotSupport	The operation is not allowed because of %s.
400	InvalidParameter	Invalid parameter, please check the parameter input.	Invalid parameter, please check the parameter input.
400	ResourceInConfiguring.Listener	The specified resource %s is configuring, please try again later.	The specified resource %s is being configured. Please try again later.
403	Forbidden.LoadBalancer	Authentication has failed for LoadBalancer.
404	ResourceNotFound.Certificate	The specified resource %s is not found.	The specified resource %s is not found.
404	ResourceNotFound.Listener	The specified resource %s is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.