TagResources

更新时间:
复制 MD 格式

Adds one or more tags to specified resources.

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

sae:TagResources

*All Resource

*

None None

Request syntax

POST /tags HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID.

cn-beijing

ResourceType

string

Yes

The resource type. Only application is supported.

application

Tags

string

No

The key-value pairs of the tags. This parameter is required unless you specify the ResourceIds parameter. The following rules apply:

  • key: The tag key. The key must be 1 to 128 characters in length.

  • value: The tag value. The value must be 1 to 128 characters in length.

Tags are case-sensitive. If you specify multiple tags, they are created and bound to the specified resources. For a single resource, each tag key must be unique. If you specify a tag key that already exists for a resource, the operation updates the existing tag value.

A tag key cannot start with aliyun or acs: and cannot contain http:// or https://.

[{"key":"k1","value":"v1"}]

ResourceIds

string

Yes

The resource IDs. You can specify up to 50 resource IDs in a JSON array. This parameter is required unless you specify the Tags parameter.

["d42921c4-5433-4abd-8075-0e536f8b****"]

Response elements

Element

Type

Description

Example

object

The data returned.

RequestId

string

The request ID.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

Message

string

The additional information returned.

  • If the request is successful, success is returned.

  • If the request fails, a specific error code is returned.

success

TraceId

string

The trace ID that you can use to query the details of the request.

0a98a02315955564772843261e****

Data

boolean

Indicates whether the operation was successful.

true

ErrorCode

string

The error code.

  • This parameter is returned only if the request fails.

  • For more information, see the Error codes section in this topic.

Code

string

The HTTP status code. Valid values:

  • 2xx: The request was successful.

  • 3xx: The request was redirected.

  • 4xx: A request error occurred.

  • 5xx: A server error occurred.

200

Success

boolean

Indicates whether the tags were added to the resources. Valid values:

  • true: The tags were added.

  • false: The tags failed to be added.

true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": true,
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 Duplicate.TagKey The TagKey contains duplicate keys.
400 InvalidParameter.TagKey The specified TagKey is invalid.
400 InvalidParameter.TagValue The specified TagValue is invalid.
400 Missing.TagKey You must specify TagKey.
400 NumberExceed.Tags The maximum number of tags is exceeded.
400 InvalidResourceType.NotFound The specified resource type is not supported.
400 InvalidParameter.Obviously The specified parameter is invalid {%s}.
400 NumberExceed.ResourceIds The number of resource IDs cannot exceed 50.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.