All Products
Search
Document Center

Resource Management:TagResources

Last Updated:Jun 20, 2024

Adds tags to the resources of various Alibaba Cloud services.

Operation description

Tags are used to identify resources. Tags allow you to categorize, search for, and aggregate resources that have the same characteristics from different dimensions. This facilitates resource management. For more information, see Tag overview.

For information about the Alibaba Cloud services that support tags, see Services that work with Tag.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
tag:TagResourcesWrite
  • TagVirtual
    acs:tag:{#regionId}:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
TagsstringYes

The key-value pairs of tags. You can specify 1 to 10 key-value pairs.

If you specify multiple tags, the system adds all the tags to the specified resources.

Limits:

  • A tag key must be 1 to 128 characters in length.
  • A tag value must be 1 to 128 characters in length.
  • Tag keys and tag values are case-sensitive.
  • Each tag key on a resource can have only one tag value. If you create a tag that has the same key as an existing tag, the value of the existing tag is overwritten.
{"k1":"v1","k2":"v2"}
ResourceARNarrayYes

The Alibaba Cloud Resource Name (ARN) of a resource.

stringYes

The ARN of a resource.

Valid values of N: 1 to 50.

Format: arn:acs:${ProductCode}:${Region}:${Account}:${ResourceType}/${ResourceId}. Fields:

  • ProductCode: the service code. You can set this field to a value obtained from the response of the ListSupportResourceTypes operation.
  • Region: the region ID of the resource. You can set this field to an asterisk (*) to indicate the current region.
  • Account: the ID of the Alibaba Cloud account to which the resource belongs. You can set this field to an asterisk (*) to indicate the current Alibaba Cloud account.
  • ResourceType: the resource type. You can set this field to a value obtained from the response of the ListSupportResourceTypes operation.
  • ResourceId: the resource ID.
Note You can set ProductCode and ResourceType in ResourceARN to values defined in Resource Group, ActionTrail, or Resource Center.
arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The ID of the request.

72086426-9F8C-4A60-852B-864048FD1199
FailedResourcesobject []

The information about the resources to which tags fail to be added.

Note
  • If tags are added to all resources, the value of FailedResources is empty.

  • If tags fail to be added to some or all resources, the value of FailedResources contains the detailed information about the resources.

ResourceARNstring

The ARN of the resource.

arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****
Resultobject

The information about the error.

Codestring

The error code.

InvalidResourceId.NotFound
Messagestring

The error message.

The specified ResourceIds are not found in our records.

Examples

Sample success responses

JSONformat

{
  "RequestId": "72086426-9F8C-4A60-852B-864048FD1199",
  "FailedResources": {
    "FailedResource": [
      {
        "ResourceARN": "arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****",
        "Result": {
          "Code": "InvalidResourceId.NotFound",
          "Message": "The specified ResourceIds are not found in our records."
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.TagsThe specified value of parameter Tags is not valid.The specified value of parameter Tags is not valid.
403Duplicate.TagKeyThe Tag.N.Key contains duplicate keys.The Tag.N.Key contains duplicate keys.
403InvalidParameter.CategoryThe specified Category is invalid. Valid values are Custom and System.The specified Category is invalid. Valid values are Custom and System.
403MissingParameter.CreatebyYou must specify Createby.You must specify Createby.
403MissingParameter.ResourceIdsYou must specify ResourceIds.You must specify ResourceIds.
403NoPermission.OperatorThe user is not authorized to operate on the specified resource.The user is not authorized to operate on the specified resource.
403NoPermissionKey.CategorySome keys cannot be modified because the user does not have permission.Some keys cannot be modified because the user does not have permission.
403NoPermissionKey.OperatorYou are not authorized to operate the tag key.You are not authorized to operate the tag key.
403NumberExceed.ResourceIdsThe maximum number of ResourceIds is exceeded.The maximum number of ResourceIds is exceeded.
403NumberExceed.TagsThe maximum number of Tags is exceeded.The maximum number of Tags is exceeded.
403QuotaExceed.TagsPerResourceThe maximum number of tags for each resource is exceeded.The maximum number of tags for each resource is exceeded.
403Invalid.ResourceIdARNThe parameter ResourceIdARN is invalid.The parameter ResourceIdARN is invalid.
403InvalidParameter.ResourceTypeThe ResourceType parameter is invalid.The ResourceType parameter is invalid.
403InvalidParameter.TagKeyThe Tag.N.Key parameter is invalid.The Tag.N.Key parameter is invalid.
403InvalidParameter.TagValueThe Tag.N.Value parameter is invalid.The Tag.N.Value parameter is invalid.
404Missing.TagKeyTag.N.Value has been specified and you must specify Tag.N.Key.Tag.N.Value has been specified and you must specify Tag.N.Key.
404MissingParameter.AliUidYou must specify AliUid.You must specify AliUid.
404MissingParameter.BidYou must specify Bid.You must specify Bid.
404MissingParameter.TagKeyYou must specify TagKey.You must specify TagKey.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-02-27The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 403 change
    delete Error Codes: 404