AssociateAdditionalCertificatesWithListener - Server Load Balancer

Associates additional certificates with a listener that uses SSL over TCP.

Operation description

AssociateAdditionalCertificatesWithListener is an asynchronous operation. After a request is sent, 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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nlb:AssociateAdditionalCertificatesWithListener	update	LoadBalancer acs:nlb:{#regionId}:{#AccountId}:loadbalancer/{#LoadBalancerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
AdditionalCertificateIds	array	Yes	The additional certificates. You can associate at most 15 additional certificates with a listener in each call.
AdditionalCertificateId	string	Yes	The additional certificates. You can associate at most 15 additional certificates with a listener in each call.	12315790343_166f8204689_1714763408_70998****
ListenerId	string	Yes	The listener ID. Only TCP/SSL listener IDs are supported.	lsn-bpn0kn908w4nbw****@80
DryRun	boolean	No	Specifies whether to perform a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. 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): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	true
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must 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 request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	The region ID of the Network Load Balancer (NLB) instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The operation to add additional certificates to a listener that uses SSL over TCP.
RequestId	string	The request ID.	365F4154-92F6-4AE4-93F8-7FF34B540710
JobId	string	The ID of the asynchronous task.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Examples

Sample success responses

JSONformat

{
  "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.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-02-29	The Error code has changed	View Change Details
2024-02-22	The Error code has changed	View Change Details
2024-01-29	The Error code has changed	View Change Details
2023-12-18	The Error code has changed	View Change Details
2023-09-26	The Error code has changed	View Change Details
2023-08-22	The Error code has changed	View Change Details