Disassociates an additional certificate from an HTTPS listener.

Description

  • DissociateAdditionalCertificatesFromListener is an asynchronous operation. After you send a request, the system returns a request ID, but this operation is still being performed in the system background. You can call the DescribeListener operation to query the state of an HTTPS listener.
    • If the listener is in the updating state, it indicates that the additional certificate is being dissociated from the listener. In this case, you can perform only query operations.
    • If the listener is in the active state, it indicates that the additional certificate is dissociated from the listener.
  • The DissociateAdditionalCertificatesFromListener operation cannot be repeatedly called for the same Global Accelerator (GA) instance with a specific period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DissociateAdditionalCertificatesFromListener

The operation that you want to perform. Set the value to DissociateAdditionalCertificatesFromListener.

RegionId String Yes cn-hangzhou

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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 it is unique among all requests. ClientToken can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
AcceleratorId String Yes ga-bp1odcab8tmno0hdq****

The ID of the GA instance.

ListenerId String Yes lsr-bp1bpn0kn908w4nbw****

The ID of the listener.

Domains.N String Yes example.com

The domain name associated with the additional certificate.

You can specify up to 10 domain names in each request.

Response parameters

Parameter Type Example Description
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DissociateAdditionalCertificatesFromListener
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&Domains=["example.com"]
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DissociateAdditionalCertificatesFromListenerResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>
</DissociateAdditionalCertificatesFromListenerResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}

Error codes

HttpCode Error code Error message Description
400 AlreadyInBandwidthPackage.Accelerator The accelerated instance is already in the bandwidth package. The error message returned because the GA instance is already associated with a bandwidth plan.
400 BandwidthIllegal.BandwidthPackage The bandwidth of the basic bandwidth package must be lower than or equal to the bandwidth of the cross-domain bandwidth package. The error message returned because the bandwidth value of a basic bandwidth plan must not be greater than that of a bandwidth plan for cross-border connections.
400 BindExist.Accelerator The accelerated instance is already bound to a bandwidth package. The error message returned because the specified GA instance is already associated with a bandwidth plan.
400 BindExist.BandwidthPackage The bandwidth package is already bound. The error message returned because the bandwidth plan is associated with a resource.
400 BindExist.EndPointGroup The endpoint group %s contains binding. The error message returned because the endpoint group %s is associated with a resource.
400 EndPointGroupTypeIllegal.EndpointGroup The endpoint group type is illegal. The error message returned because the type of the endpoint group is invalid.
400 EndPointRequestProtocolIllegal.EndpointGroup The endpoint group request protocol is illegal. The error message returned because the endpoint uses an invalid request protocol.
400 Exist.EndpointGroup The endpoint group already exists. The error message returned because the specified endpoint group already exists.
400 Exist.ForwardingRule The forwarding rule already exists. The error message returned when the forwarding rule already exists.
400 Exist.IpSet The IpSet already exists. The error message returned because the specified accelerated IP address exists.
400 Exist.Listener The listener already exists. The error message returned because the specified listener exists.
400 Exist.VirtualEndpointGroup A virtual endpoint group already exists. The error message returned because specified virtual endpoint group already exists.
400 GaSpecExceeded.IpSet The number of IpSet exceeds the specification of the GA instance. The error message returned because the number of accelerated IP addresses has reached the upper limit supported by the GA instance.
400 GreaterThanGa.IpSetBandwidth The total bandwidth for IpSet exceeds the total bandwidth of the GA instance. The error message returned because the total bandwidth of accelerated IP addresses has reached the upper limit supported by the GA instance.
400 IllegalBandwidth.IpSet The bandwidth of IpSet is invalid. The error message returned because the bandwidth value of the accelerated IP address is invalid.
400 IllegalParameter.BandwidthType The parameter BandwidthType is illegal. The error message returned because the GA instance associated with a basic bandwidth plan has a non-EIP endpoint and the bandwidth type of a basic bandwidth plan cannot be changed to Basic.
400 IllegalParameter.Spec The specified Spec is invalid. The error message returned because Spec is set to an invalid value.
400 IllegalParameter.Type The specified Type is invalid. The error message returned because Type is set to an invalid value.
400 MissingParameter.BandwidthType You must specify BandwidthType. The error message returned because BandwidthType is not set.
400 NoPermission.GaDdosRoleSession You are not authorized to perform the operation. The error message returned because you are not authorized to create the service-linked role. Contact the owner of the Alibaba Cloud account or the administrator to attach the AliyunGlobalAccelerationFullAccess policy or a custom permission policy that grants the permissions to create the required service-linked role to your RAM user. In the custom permission policy, set the service name in the custom policy to ddos.ga.aliyuncs.com, set the service-linked role to AliyunServiceRoleForGaAntiDDos, and set the permissions that you want to grant to ram:CreateServiceLinkedRole.
400 NoPermission.VpcEndpoint You are not authorized to perform the operation. The error message returned because you are not authorized to create the service-linked role. Contact the owner of the Alibaba Cloud account or the administrator to attach the AliyunGlobalAccelerationFullAccess policy or a custom permission policy that grants the permissions to create the required service-linked role to your RAM user. In the custom permission policy, set the service name to vpcendpoint.ga.aliyuncs.com, the service-linked role to AliyunServiceRoleForGaVpcEndpoint, and the permissions that you want to grant to ram:CreateServiceLinkedRole.
400 NotActive.IpSet The state of IpSet is not active. The error message returned because the specified accelerated IP address is in an unstable state.
400 NotActive.Listener The state of the listener is not active. The error message returned because the specified listener is unstable.
400 NotExist.Accelerator The accelerated instance does not exist. The error message returned because the GA instance does not exist.
400 NotExist.BandwidthPackage The bandwidth package does not exist. The error message returned because the specified bandwidth plan does not exist.
400 NotExist.BasicBandwidthPackage You must specify the basic bandwidth package. The error message returned because no basic bandwidth plan is specified.
400 NotExist.BusinessRegion The business region does not exist. The error message returned because the specified region does not exist.
400 NotExist.EndPointGroup The endpoint group does not exist. The error message returned because the specified endpoint group does not exist.
400 NotExist.IpSet The IpSet does not exist. The error message returned because the specified accelerated IP address does not exist.
400 NotExist.IpSets The IpSet does not exist. The error message returned because the specified accelerated IP address does not exist.
400 NotExist.Listener The listener does not exist. The error message returned because the specified listener does not exist.
400 NotExist.ListenerPort The listening port %s does not exist. The error message returned because the specified listener port %s does not exist.
400 NotInBandwidthPackage.Accelerator The accelerated instance is not in the bandwidth package. The error message returned because the GA instance is not associated with a bandwidth plan.
400 PortConflict.Listener The listener port configuration is in conflict. The error message returned because the configuration of the specified listener port conflicts with that of another listener port.
400 PortRangeIllegal.Count The hugePort listener only supports one port range. The error message returned because you can specify only one port range for a listener that supports more than 300 ports.
400 PortRangeIllegal.Listener The specified listener port range is invalid. The error message returned because the listener port range is invalid.
400 PortRanges.MustOne The portRanges must be one for HTTPS and HTTP type listener. The error message returned because an HTTP or HTTPS listener supports only one port.
400 ProtocalIllegal.Listener The specified listener protocol is invalid. The error message returned because the listener protocol is invalid.
400 QuotaExceeded.EndPoint The maximum number of endpoints is exceeded. The error message returned because the number of endpoints has reached the upper limit.
400 QuotaExceeded.ForwardingRule The number of forwarding rule exceeds the limit. The error message returned because the number of forwarding rules has reached the upper limit.
400 QuotaExceeded.Listener The maximum number of listeners is exceeded. The error message returned because the number of listeners has reached the upper limit.
400 QuotaExceeded.ListenerPort The maximum number of listener ports is exceeded. The error message returned because the number of listener ports has reached the upper limit.
400 QuotaExceeded.PortOverride The number of port override exceeds the limit. The error message returned because the number of port mappings has reached the upper limit.
400 RegionRepeat.IpSet Only one IpSet can be created in an accelerated region. The error message returned because an acceleration region supports only a single accelerated IP address.
400 Repeat.IpSets The configuration of IpSet is duplicated. The error message returned because duplicated accelerated IP addresses are specified.
400 RepeatPathAndHost.ForwardingRule The path and host %s are duplicated. The error message returned because duplicated paths and domain names are specified.
400 StateError.BandwidthPackage The state of bandwidth package is invalid. The error message returned because the specified bandwidth plan is in an invalid state.
400 StateError.BandwidthPackageBind The state of binding for the bandwidth package is invalid. The error message returned because the association status of the bandwidth plan is invalid.
400 StateError.EndPointGroup The specified state of endpoint group is invalid. The error message returned because the specified endpoint group is in an invalid state.
400 StateError.ForwardingRule The forwarding rule state %s is illegal. The error message returned because the specified forwarding rule is in an invalid state.
400 StateError.IpSet The state of IpSet is invalid. The error message returned because the specified accelerated IP address is in an invalid state.
400 TooManySpareIp.Accelerator Too many SpareIp accepted under the same Accelerator The error message returned because the secondary IP addresses configured for the current GA instance are excessive.
400 UpgradeError.BandwidthPackage The bandwidth package configurations should be either all upgrades or all downgrades. The error message returned because the bandwidth plan is upgraded and downgraded at the same time. You can only upgrade or downgrade a bandwidth plan each time.

For a list of error codes, visit the API Error Center.