All Products
Search

This Product

    Elastic Compute Service:TagResources

    Document Center

    Elastic Compute Service:TagResources

    Last Updated:Nov 21, 2024

    Creates tags and adds the tags to Elastic Block Storage (EBS) 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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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
    ebs:TagResourcescreate
    *DedicatedBlockStorageCluster
    acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId}
    *DiskReplicaGroup
    acs:ebs:{#regionId}:{#accountId}:diskreplicagroup/{#ReplicaGroupId}
    *DiskReplicaPair
    acs:ebs:{#regionId}:{#accountId}:diskreplicapair/{#ReplicaPairId}
    *EnterpriseSnapshotPolicy
    acs:ebs:{#regionId}:{#accountId}:enterprisesnapshotpolicy/{#EnterpriseSnapshotPolicyId}
    *SolutionInstance
    acs:ebs:{#regionId}:{#accountId}:solutioninstance/{#SolutionInstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ResourceIdarrayYes

    The ID list of the resources. You can specify up to 50 IDs in each request.

    ResourceIdstringYes

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

    		pair-cn-c4d2t7f****
    Tagarray<object>Yes

    The resource tags. You can specify up to 20 tags.

    TagobjectYes

    The value of tag N used for exact search of EBS resources. The tag value must be 1 to 128 characters in length. Valid values of N: 1 to 20.

    KeystringYes

    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://. It cannot start with acs: or aliyun.

    		tag-key
    ValuestringYes

    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 start with acs: or contain http:// or https://.

    		tag-value
    RegionIdstringYes

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

    		cn-hangzhou
    ResourceTypestringYes

    The type of the resource. Valid values:

    • dedicatedblockstoragecluster: dedicated block storage cluster
    • diskreplicapair: replication pair
    • diskreplicagroup: replication pair-consistent group
    		diskreplicagroup
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

    		0c593ea1-3bea-11e9-b96b-88e9fe63****

    Response parameters

    ParameterTypeDescriptionExample
    object

    TagResponse

    RequestIdstring

    The ID of the request. The request ID is returned regardless of whether the call is successful.

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameterThe parameter %s is invalid.The specified parameter value is invalid.
    400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.-
    400InvalidParameter.FormatSpecified parameter format is not valid.english description
    400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.The parameter must be specified.
    400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.-
    400NumberExceed.ResourceIdsThe ResourceIds parameter number is exceed , Valid : 50-
    400NumberExceed.TagsNumberExceed.Tags-
    403ForbiddenUser is not authorized to operate.You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
    403Forbidden.ActionUser is not authorized to operate this action.You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
    403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.-
    403LastTokenProcessingThe last token request is processing.The value of clientToken is used in another request that is being processed. Try again later.
    403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.You are not authorized to create service-linked roles.
    403OperationDeniedThe operation is not allowed.The operation is not supported.
    404InvalidApi.NotFoundSpecified api is not found, please check your url and method.-
    404InvalidResourceId.NotFoundThe specified ResourceIds are not found in our records.-
    404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.-
    404MissingParameter.ResourceTypeThe parameter - ResourceType should not be null-
    404NoSuchResourceThe specified resource does not exist.The specified resource does not exist.
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred.
    504RequestTimeoutThe request is timeout, please try again later.The request has timed out. Try again later.

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

    Change history

    Change timeSummary of changesOperation
    No change history