tag · 2018-08-13

DescribeTags

POST

Query the list of created tags.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /tag/DescribeTags 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://tag.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/tag/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: tag.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeTags' \
  -H 'X-TC-Version: 2018-08-13' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Offset":0,"Limit":20}'

Request parameters

Field	Type	Required	Description
TagKey	string	—	Tag key. Either exists or does not exist alongside the tag value. If it does not exist, all of the user's tags will be queried.
TagValue	string	—	Tag value. Either exists or does not exist alongside the tag key. If it does not exist, all of the user's tags will be queried.
Offset	integer	—	Data offset. The default value is 0. Must be an integral multiple of the `Limit` parameter.
Limit	integer	—	Page size. The default value is 0.
CreateUin	integer	—	Creator `Uin`. If not specified, `Uin` is only used as the query condition.
TagKeys	string[]	—	Tag key array, which either exists or does not exist with the tag value. If it does not exist, all tags of the user will be queried. If it is passed in together with `TagKey`, it will be used and the `TagKey` will be ignored.
ShowProject	integer	—	Whether to show project 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	Total number of results.
Offset	integer	Data offset.
Limit	integer	Page size.
Tags	TagWithDelete[]	Tag list.
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": …,
    "Offset": …,
    "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/tag.

SecretIdSecretKey

Request bodyvalid JSONPOST tag.api3.convergecloud.com · DescribeTags

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

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "TotalCount": 0,
    "Offset": 0,
    "Limit": 100,
    "Tags": [],
    "RequestId": "c85e96a3-4362-8d0a-c538-5aefe3a49785"
  }
}