clb · 2018-03-17

DescribeTargetGroups

POST

Query the target group information.

Wire call

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

Request parameters

Field	Type	Required	Description
TargetGroupIds	string[]	—	Target group ID, which is exclusive of `Filters`.
Limit	integer	—	Limit of the number of displayed results. Default value: 20.
Offset	integer	—	Starting display offset
Filters	Filter[]	—	Filter condition array, mutually exclusive with TargetGroupIds, supports TargetGroupVpcId (vpc ID), TargetGroupName (target group name), and Tag.

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
TotalCount	integer	Number of displayed results
TargetGroupSet	TargetGroupInfo[]	Information set of displayed target groups
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": {
    "TotalCount": …,
    "TargetGroupSet": …,
    "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 · DescribeTargetGroups

{
  "Offset": 0,
  "Limit": 20
}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "TotalCount": 0,
    "TargetGroupSet": [],
    "RequestId": "f9ba3dce-9a75-555c-e940-a23dc23b9734"
  }
}