tag · 2018-08-13

DescribeResourceTagsByTagKeys

POST

Get resource tags based on tag keys.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /tag/DescribeResourceTagsByTagKeys 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: DescribeResourceTagsByTagKeys' \
  -H 'X-TC-Version: 2018-08-13' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"ResourceIds":["<ResourceId>"],"ResourcePrefix":"<ResourcePrefix>","ResourceRegion":"<ResourceRegion>","ServiceType":"<ServiceType>","TagKeys":"<TagKeys>","Offset":0,"Limit":20}'

Request parameters

Field	Type	Required	Description
ServiceType	string	Yes	Service type
ResourcePrefix	string	Yes	Resource prefix
ResourceRegion	string	Yes	Resource region
ResourceIds	string[]	Yes	List of unique resource IDs, which can contain no more than 20 IDs.
TagKeys	string[]	Yes	List of resource tag keys, which can contain no more than 20 keys.
Limit	integer	Yes	Number of entries per page. Default value: 400
Offset	integer	Yes	Data offset. Default value: 0. It must be an integer multiple of the `Limit` parameter

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	ResourceIdTag[]	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 · DescribeResourceTagsByTagKeys

{
  "ResourceIds": [
    "<ResourceId>"
  ],
  "ResourcePrefix": "<ResourcePrefix>",
  "ResourceRegion": "<ResourceRegion>",
  "ServiceType": "<ServiceType>",
  "TagKeys": "<TagKeys>",
  "Offset": 0,
  "Limit": 20
}

Read-only. Creates nothing.