tag · 2018-08-13

DescribeResourceTags

POST

Query the tags associated with a resource.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /tag/DescribeResourceTags 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: DescribeResourceTags' \
  -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
CreateUin	integer	—	Creator `uin`
ResourceRegion	string	—	Resource region.
ServiceType	string	—	Service type.
ResourcePrefix	string	—	Resource prefix
ResourceId	string	—	Unique resource ID. Queries with `ResourceId` only may be slow or fail to return results. We recommend you also enter `ServiceType`, `ResourcePrefix`, and `ResourceRegion` (which can be ignored for resources that don't have the region attribute) when entering `ResourceId`.
Offset	integer	—	Data offset. Default value: 0. It must be an integer multiple of the `Limit` parameter
Limit	integer	—	Number of entries per page. Default value: 15
CosResourceId	integer	—	Whether it is a COS resource (0 or 1). This parameter is required when the entered `ResourceId` is a COS resource.

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	Number of entries per page.
Rows	TagResource[]	Resource tag
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 · DescribeResourceTags

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

Read-only. Creates nothing.

Recorded example response

{
  "Limit": 15,
  "Offset": 0,
  "Rows": [],
  "TotalCount": 0
}