clb · 2018-03-17

DeleteListener

POST

Delete listeners (layer-4 and layer-7) under a Cloud Load Balancer instance.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /clb/DeleteListener path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://clb.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/clb/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: clb.api3.convergecloud.com' \
  -H 'X-TC-Action: DeleteListener' \
  -H 'X-TC-Version: 2018-03-17' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"LoadBalancerId":"<LoadBalancerId>","ListenerId":"<ListenerId>"}'

Request parameters

Field	Type	Required	Description
LoadBalancerId	string	Yes	ID of the CLB instance. You can call the DescribeLoadBalancers API to query the ID.
ListenerId	string	Yes	The listener ID to be deleted, can be accessed through the DescribeListeners api.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    // action-specific fields,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/clb.

SecretIdSecretKey

Request bodyvalid JSONPOST clb.api3.convergecloud.com · DeleteListener

{
  "LoadBalancerId": "<LoadBalancerId>",
  "ListenerId": "<ListenerId>"
}

This action changes resources in my own account and may create a charge. I understand.

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "InvalidParameter",
      "Message": "LoadBalancer not exist"
    },
    "RequestId": "7b15897b-3c3b-cab2-1b5e-19b51ea70982"
  }
}