tag — Resource Tagging
tag · 2018-08-13
DescribeResourcesByTags
POST
Query resources by 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/DescribeResourcesByTags 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: DescribeResourcesByTags' \
-H 'X-TC-Version: 2018-08-13' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"TagFilters":"<TagFilters>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| TagFilters | TagFilter[] | Yes | Tag filtering arrays. |
| CreateUin | integer | No | Tag creator uin. |
| Offset | integer | No | Data offset. The default value is 0. Must be an integral multiple of the `Limit` parameter. |
| Limit | integer | No | Page size. The default value is 15. |
| ResourcePrefix | string | No | Resource prefix. |
| ResourceId | string | No | Unique resource ID. |
| ResourceRegion | string | No | The resource's region. |
| ServiceType | string | No | Service type. |
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 | ResourceTag[] | 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.
Request bodyvalid JSONPOST tag.api3.convergecloud.com · DescribeResourcesByTags
Read-only. Creates nothing.