All Products
Search

This Product

    Elastic Compute Service:TagResources

    Document Center

    Elastic Compute Service:TagResources

    Last Updated:Apr 11, 2024

    Creates and adds tags to specified Elastic Compute Service (ECS) resources.

    Operation description

    Before you add tags to a resource, Alibaba Cloud checks the number of existing tags of the resource. If the maximum number of tags is reached, an error message is returned. For more information, see the "Tag limits" section in Limits .

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the resource. You can call the DescribeRegions operation to query the most recent list of regions.

    		cn-hangzhou
    ResourceTypestringYes

    The type of the resource. Valid values:

    • instance: ECS instance
    • disk: disk
    • snapshot: snapshot
    • image: image
    • securitygroup: security group
    • volume: storage volume
    • eni: elastic network interface (ENI)
    • ddh: dedicated host
    • ddhcluster: dedicated host cluster
    • keypair: SSH key pair
    • launchtemplate: launch template
    • reservedinstance: reserved instance
    • snapshotpolicy: automatic snapshot policy
    • elasticityassurance: elasticity assurance
    • capacityreservation: capacity reservation
    • command: Cloud Assistant command
    • invocation: Cloud Assistant command execution result
    		instance
    ResourceIdarrayYes

    The ID of resource N. Valid values of N: 1 to 50.

    stringYes

    The ID of resource N. Valid values of N: 1 to 50.

    		r-XXX
    Tagobject []Yes

    The tags to add to the resource.

    KeystringNo

    The key of tag N to add to the resource. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.

    		TestKey
    ValuestringNo

    The value of tag N to add to the resource. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with acs:.

    		TestValue

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400NumberExceed.ResourceIdsThe ResourceIds parameter's number is exceed , Valid : 50.-
    400NumberExceed.TagsThe Tags parameter's number is exceed , Valid : 20.-
    400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.The specified tag key already exists. Tag keys must be unique.
    400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.The specified Tag.N.Key parameter is invalid.
    400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.The specified tag value is invalid.
    400OperationDenied.QuotaExceedThe quota of tags on resource is beyond permitted range.The maximum number of tags on resource is exceeded.
    400InvalidTag.MismatchThe specified Tag.n.Key and Tag.n.Value are not match.The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
    400InvalidTagCountThe specified tags are beyond the permitted range.The number of specified tags exceeds the upper limit.
    400Invalid.ScopeThe specified scope is invalid.The specified Scope parameter is invalid.
    403PermissionDenied.TagOwnerBidThe specified operator not have permission to set TagOwnerBid value.-
    403PermissionDenied.TagOwnerUidThe specified operator not have permission to set TagOwnerUid value.You are not authorized to specify the TagOwnerUid parameter.
    403PermissionDenied.ScopeThe specified operator not have permission to set Scope value.You are not authorized to specify the Scope parameter.
    403InvalidResourceId.NotSupportedThe specified ResourceId does not support tagging.The specified resource does not support tagging.
    403NoPermissionKey.Scope%s-
    403NoPermission.TagThe operator is not permission for the tag.You are not authorized to manage the tag.
    403QuotaExceed.Tags%sThe number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions.
    403TagKey.DuplicationThe TagKey has duplication with others, case-insensitive.-
    404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
    404InvalidRegionId.NotFound%sThe specified region ID does not exist.
    404MissingParameter.ResourceIdsThe parameter - ResourceIds.N should not be null.-
    404MissingParameter.TagOwnerUidThe parameter - TagOwnerUid should not be null.-
    404MissingParameter.TagOwnerBidThe parameter - TagOwnerBid should not be null.-
    404MissingParameter.ResourceTypeThe parameter - ResourceType should not be null.The ResourceType parameter is required.
    404MissingParameter.TagsThe parameter - Tags should not be null.-
    404MissingParameter.RegionIdThe parameter - RegionId should not be null.-
    404InvalidResourceId.NotFoundThe specified ResourceIds are not found in our records.The specified resource does not exist. Check whether the ResourceId parameter is correct.
    404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.The specified resource type does not exist.
    404InvalidRegionId.NotFoundThe specified RegionId does not exist.The specified region ID does not exist.
    500ServiceUnavailableThe service is unavailable, please try again later.-

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