Add additional certificates to a listener by calling AssociateAdditionalCertificatesWithListener - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Operation description

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 ListListenerCertificates operation to query the status of the task:

If the listener is in the Associating state, the additional certificates are being associated.
If the listener is in the Associated state, the additional certificates are associated.

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

nlb:AssociateAdditionalCertificatesWithListener

update

*LoadBalancer

acs:nlb:{#regionId}:{#AccountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
AdditionalCertificateIds	array	Yes	The additional certificates. You can associate up to 15 additional certificates with a listener in each call.
	string	No	The additional certificate. You can associate up to 15 additional certificates with a listener in each call.	12315790343_166f8204689_1714763408_70998****
ListenerId	string	Yes	The listener ID. Only TCPSSL listener IDs are supported.	lsn-bpn0kn908w4nbw****@80
DryRun	boolean	No	Whether to perform a dry run. Valid values: true: validates the request without performing the operation. The system checks for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails validation, the corresponding error message is returned. If the request passes validation, the `DryRunOperation` error code is returned. false (default): validates the request and performs the operation. If the request passes validation, a 2xx HTTP status code is returned and the operation is performed.	true
ClientToken	string	No	The client token that ensures the idempotence of the request. You can use the client to generate the token. The token must be unique among different requests and contain only ASCII characters. Note If you do not set this parameter, the value of RequestId is used. The value of RequestId is different for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The ID of the region where the NLB instance is deployed. You can call the DescribeRegions operation to query the available regions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response for associating additional certificates with a TCPSSL listener.
RequestId	string	The request ID.	365F4154-92F6-4AE4-93F8-7FF34B540710
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	SystemBusy	System is busy, please try again later.
400	OperationDenied.%s	The operation is not allowed because of %s.
400	OperationFailed.%s	The operation failed because of %s.	Failed to call the API operation due to %.
400	IncorrectStatus.%s	The status of %s [%s] is incorrect.
400	ResourceAlreadyAssociated.%s	The specified resource of %s is already associated.
400	IncorrectStatus.listener	The status of listener [%s] is incorrect.	The current operation cannot be performed on the listener as its status is unavailable. Please check if the listener is currently undergoing any other operations.
400	ResourceAlreadyAssociated.Certificate	The specified resource %s is already associated.
400	Conflict.Lock	The Lock [%s] is conflict.	The specific resource is conflict.
400	OperationDenied.Protocol	The operation is not allowed because of %s.
400	ResourceNotFound.Certificate	The specified resource %s is not found.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
404	ResourceNotFound.%s	The specified resource of %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.