tag — Resource Tagging
tag · 2018-08-13
ModifyResourceTags
POST
Modify all 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/ModifyResourceTags 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: ModifyResourceTags' \
-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 |
|---|---|---|---|
| Resource | string | Yes | Six-segment resource description |
| ReplaceTags | Tag[] | No | The tags to be added or modified. If the resource described by `Resource` is not associated with the input tag keys, an association will be added. If the tag keys are already associated, the values corresponding to the associated tag keys will be modified to the input values. This API must contain either `ReplaceTags` or `DeleteTag`, and these two parameters cannot include the same tag keys. Th… |
| DeleteTags | TagKeyObject[] | No | The tags to be disassociated. This API must contain either `ReplaceTags` or `DeleteTag`, and these two parameters cannot include the same tag keys. This parameter can be omitted, but it cannot be an empty array. |
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.
Request bodyvalid JSONPOST tag.api3.convergecloud.com · ModifyResourceTags
What failure looks like
Example error responses for this action. Match on Code.
Recorded error 1
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.ResourceDescriptionError",
"Message": "resource error,resource uin not equal uin,resource uin:100000000001 uin:100000000001"
},
"RequestId": "903cb2c0-75b7-9cda-da6d-4416d603eee6"
}
}