TagResources API - create and bind tags to cloud resources - Resource Management

Adds tags to resources across Alibaba Cloud services.

Operation description

Tags identify and classify resources across dimensions, simplifying resource management. Tag overview.

Supported services: Services that work with Tag.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

tag:TagResources

update

*All Resource

*

None

*:TagResources
vod:TagVodResources
dcdn:TagDcdnResources
ecs:AddTags
rds:AddTagsToResource
slb:AddTags
oss:PutBucketTagging
live:TagLiveResources

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. For centrally deployed services, set to `cn-hangzhou` or a region ID from Regions supported by tag-related operations on resources of centrally deployed Alibaba Cloud services. For non-centrally deployed services, set to the resource's region ID.	cn-hangzhou
RegionId	string	Yes	The region ID. For centrally deployed services, set to `cn-hangzhou` or a region ID from Regions supported by tag-related operations on resources of centrally deployed Alibaba Cloud services. For non-centrally deployed services, set to the resource's region ID.	cn-hangzhou
Tags	string	Yes	Tag key-value pairs. Specify 1 to 10 pairs. Multiple tags are applied to all specified resources. Limits: Tag key: 1 to 128 characters. Tag value: 1 to 128 characters. Tag keys and tag values are case-sensitive. Each tag key supports only one value per resource. A new tag with an existing key overwrites the previous value.	{"k1":"v1","k2":"v2"}
ResourceARN	array	Yes	The Alibaba Cloud Resource Name (ARN) of a resource.	arn:acs:vpc:cn-hangzhou:123456789**:vpc/vpc-bp19dd90tkt6tz7wu**
	string	No	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. Obtain valid values from the ListSupportResourceTypes operation. `Region`: the resource's region ID. Use * for the current region. `Account`: the Alibaba Cloud account ID that owns the resource. Use * for the current account. `ResourceType`: the resource type. Obtain valid values from the ListSupportResourceTypes operation. `ResourceId`: the resource ID. Note `ProductCode` and `ResourceType` accept values defined in Resource Group, ActionTrail, or Resource Center.	arn:acs:vpc:cn-hangzhou:123456789**:vpc/vpc-bp19dd90tkt6tz7wu**

Common request parameters: Common parameters.

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	72086426-9F8C-4A60-852B-864048FD1199
FailedResources	object
FailedResource	array<object>	Resources to which tag binding failed. Note If all tags are bound successfully, `FailedResources` is empty. If binding fails for some or all resources, `FailedResources` contains the failure details.
	array<object>	Details of resources with failed tag binding.
ResourceARN	string	The ARN of the resource.	arn:acs:vpc:cn-hangzhou:123456789**:vpc/vpc-bp19dd90tkt6tz7wu**
Result	object	The error details.
Code	string	The error code.	InvalidResourceId.NotFound
Message	string	The error message.	The specified ResourceIds are not found in our records.

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidResourceARN.Region	The Region specified in the ResourceARN parameter does not match the RegionId parameter, specifically: %s.	The Region in the ResourceARN does not match the parameter RegionId. They are: %s
400	InvalidResourceARN.Account	The Account specified in the ResourceARN parameter does not match the actual account, specifically: %s.	The Account in the ResourceARN do not match the actual user, namely: %s
400	InvalidResourceARN.FormatError	The format of parameter ResourceARN: %s is not valid, for the correct format, you can refer to the Recommend.	The ResourceARN format does not conform to the specification. For the correct format, please refer
400	InvalidParameter.ResourceType	The parameter resource type: %s in ResourceARN is not valid or not support.	ResourceType in ResourceARN: %s is Illegal or unsupported.
400	InvalidParameter.ServiceCode	The parameter service code: %s in ResourceARN is not valid or not support.	ServiceCode in ResourceARN: %s is Illegal or unsupported.
400	InvalidParameter.TagKey	The TagKey parameter is invalid. The following TagKeys are invalid: %s.	Illegal tag keys exist in the parameter. Illegal tag keys are as follows: %s
400	InvalidParameter.TagValue	The TagValue parameter is invalid. The following TagValues are invalid: %s.	The parameter contains illegal tag values. Illegal tag values are as follows: %s
400	InvalidParameter.Tags	The Tags parameter cannot be empty, and JSON parsing should adhere to the format of a Map.
403	Duplicate.TagKey	The Tag.N.Key contains duplicate keys.	The Tag.N.Key contains duplicate keys.
403	InvalidParameter.Category	The specified Category is invalid. Valid values are Custom and System.	The specified Category is invalid. Valid values are Custom and System.
403	MissingParameter.Createby	You must specify Createby.	You must specify Createby.
403	MissingParameter.ResourceIds	You must specify ResourceIds.	You must specify ResourceIds.
403	NoPermission.Operator	The user is not authorized to operate on the specified resource.	The user is not authorized to operate on the specified resource.
403	NoPermissionKey.Category	Some keys cannot be modified because the user does not have permission.	Some keys cannot be modified because the user does not have permission.
403	NoPermissionKey.Operator	You are not authorized to operate the tag key.	You are not authorized to operate the tag key.
403	NumberExceed.ResourceIds	The maximum number of ResourceIds is exceeded.	The maximum number of ResourceIds is exceeded.
403	NumberExceed.Tags	The maximum number of Tags is exceeded.	The maximum number of Tags is exceeded.
403	QuotaExceed.TagsPerResource	The maximum number of tags for each resource is exceeded.	The maximum number of tags for each resource is exceeded.
404	Missing.TagKey	Tag.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.
404	MissingParameter.AliUid	You must specify AliUid.	You must specify AliUid.
404	MissingParameter.Bid	You must specify Bid.	You must specify Bid.
404	MissingParameter.TagKey	You must specify TagKey.	You must specify TagKey.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.