UpdateAdditionalCertificateWithListener - Global Accelerator

Replaces an additional certificate for an HTTPS listener.

Operation description

The UpdateAdditionalCertificateWithListener operation is used to replace an additional certificate. You can use this operation when you want to replace an expired additional certificate with a new additional certificate without changing the associated domain name.

UpdateAdditionalCertificateWithListener is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can use the ListListenerCertificates operation to query the state of the additional certificate that is associated with an HTTP listener:
- If the certificate that you want to replace is in the updating state, it is being replaced for the HTTP listener. In this case, you can perform only query operations.
- If the replacement certificate is in the active state, it indicates that the replacement operation is complete and the replacement certificate is associated with the HTTP listener.
You cannot perform the UpdateAdditionalCertificateWithListener operation again on the same Global Accelerator (GA) instance before the previous operation is complete.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
ga:UpdateAdditionalCertificateWithListener	Write	AdditionalCertificate acs:ga:{#regionId}:{#accountId}:listener/{#ListenerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and 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: performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed. This is the default value.	false
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 value of RequestId as the value of ClientToken. The value of RequestId for each API request may be different.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	The ID of the GA instance.	ga-bp1odcab8tmno0hdq****
ListenerId	string	Yes	The ID of the listener. Only HTTPS listeners are supported.	lsr-bp1bpn0kn908w4nbw****
Domain	string	Yes	The domain name associated with the additional certificate that you want to replace.	example.com
CertificateId	string	Yes	The ID of the replacement certificate.	6092**-cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters of the operation.
RequestId	string	The ID of the request.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
ListenerId	string	The ID of the listener.	lsr-bp1bpn0kn908w4nbw****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
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	NotExist.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The listener is unstable.
400	ResourceNotFound.CertificateDomain	The specified domain is not found.	-
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.

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

Change history

Change time

Summary of changes

Operation

2023-10-09

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 500