clb · 2018-03-17

DeregisterTargets

POST

Unbind one or more real servers from a CLB listener or forwarding rule. For layer-4 listeners, only the listener ID needs to be specified. For layer-7 listeners, the forwarding rule also needs to be specified through LocationId or Domain+Url.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /clb/DeregisterTargets 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: DeregisterTargets' \
  -H 'X-TC-Version: 2018-03-17' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"LoadBalancerId":"<LoadBalancerId>","ListenerId":"<ListenerId>","Targets":"<Targets>"}'

Request parameters

Field	Type	Required	Description
LoadBalancerId	string	Yes	CLB instance ID in the format of "lb-12345678"
ListenerId	string	Yes	Listener ID in the format of "lbl-12345678"
Targets	Target[]	Yes	List of real servers to be unbound. Array length limit: 20.
LocationId	string	No	Forwarding rule ID in the format of "loc-12345678". When unbinding a server from a layer-7 forwarding rule, you must provide either this parameter or Domain+Url.
Domain	string	No	Target rule domain name. This parameter does not take effect if LocationId is specified.
Url	string	No	Target rule URL. This parameter does not take effect if LocationId is specified.

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 · DeregisterTargets

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

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": "abd32216-f60e-dddc-1dc3-c962cc246edd"
  }
}