tag · 2018-08-13

AddResourceTag

POST

Associate resources with 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/AddResourceTag 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: AddResourceTag' \
  -H 'X-TC-Version: 2018-08-13' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

Field	Type	Required	Description
TagKey	string	Yes	The tag key that needs to be bound. For the requirements, refer to:
TagValue	string	Yes	The tag value that needs to be bound. For the requirements, refer to:
Resource	string	Yes	Resource to be associated, represented in the standard six-segment resource format. For the correct format, see

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
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": {
    // action-specific fields,
    "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 · AddResourceTag

{}

This action changes resources in my own account and may create a charge. I understand.

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "unknow",
      "Message": "tagKey invalid."
    },
    "RequestId": "a395140a-2b52-8e63-7eb3-dfaef8bc8966"
  }
}