Enable Multi-Domain HTTPS on GA Listeners with Multiple SSL Certificates - Global Accelerator - Alibaba Cloud - Global Accelerator

Associates multiple certificates with an HTTPS listener of a Global Accelerator (GA) instance. Combined with virtual endpoint groups and forwarding rules, this operation accelerates access to multiple HTTPS domain names. You can call the AssociateAdditionalCertificatesWithListener operation to associate additional certificates with an HTTPS listener.

Operation description

Only HTTPS protocol listeners support attaching extension certificates.
The AssociateAdditionalCertificatesWithListener operation is asynchronous. After you invoke this operation, the system returns a request ID, but the extension certificates are not yet attached to the HTTPS listener. The association node is still running in the background. You can invoke the DescribeListener operation to query the status of the listener:
- If the listener is in the updating state, the extension certificates are being attached to the HTTPS listener. In this state, you can only execute query operations and cannot execute other operations.
- If the listener is in the active state, the extension certificates are attached to the HTTPS listener.
The AssociateAdditionalCertificatesWithListener operation does not support concurrent invocations to attach extension certificates to an HTTPS listener within the same Alibaba Cloud Global Accelerator (GA) instance.

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

ga:AssociateAdditionalCertificatesWithListener

update

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	The instance ID of the Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	Yes	The instance ID of the listener. Only HTTPS listeners are supported.	lsr-bp1bpn0kn908w4nbw****
Certificates	array<object>	Yes	The list of additional certificates. You can specify up to 10 certificates at a time.
	object	Yes	The list of additional certificates. You can specify up to 10 certificates at a time.
Domain	string	Yes	The domain name to which the certificate applies. You can associate only one additional certificate with each domain name. You can specify up to 10 domain names at a time.	example.com
Id	string	Yes	The ID of the certificate. Only server certificates are supported. You can specify up to 10 certificate IDs at a time.	6092**-cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The list of returned information.
ListenerId	string	The instance ID of the listener.	lsr-bp1bpn0kn908w4nbw****
RequestId	string	The ID of the request.	6FEA0CF3-D3B9-43E5-A304-D217037876A8

Examples

Success response

JSON format

{
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Resource.QuotaFull	The resource quota is exceeded.	The number of resources has reached the upper limit.
400	ProtocalIllegal.Listener	The specified listener protocol is invalid.	The specified listener protocol is invalid.
400	NotExist.Accelerator	The accelerated instance does not exist.	The GA instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The status of the GA instance is invalid.
400	QuotaExceeded.Listener	The maximum number of listeners is exceeded.	The maximum number of listeners is exceeded.
400	PortRangeIllegal.Listener	The specified listener port range is invalid.	The specified listener port range is invalid.
400	PortConflict.Listener	The listener port configuration is in conflict.	The listener port configurations are in conflict.
400	QuotaExceeded.ListenerPort	The maximum number of listener ports is exceeded.	The maximum number of listener ports is exceeded.
400	PortRangeIllegal.ExceedGaAbility	The listener port range is invalid. For each accelerator instance, you can only create a listener with port range over 300 for each protocol (TCP and UDP).	The listener port range is invalid. For each accelerator instance, you can only create a listener with port range over 300 for each protocol (TCP and UDP).
400	PortRangeIllegal.UDP	UDP ports 250, 4789, and 4790 are system reserved ports.
400	SystemPort.Listener	Ports 65500-65535 are system reserved ports.	Ports 65500 to 65535 are reserved by the system.
400	PortRanges.MustOne	The portRanges must be one for HTTPS and HTTP type listener.	Only one port is supported for HTTPS and HTTP type listeners.
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.
403	Forbbiden.SubUser	You are not authorized to operate on the specified resource because your account was created by another user.	The current account is a RAM user and does not have permissions to manage the specified resources.
403	Forbidden	The user is not authorized to operate on the specified resource.	The current account does not have permissions to manage the specified resources.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.