All Products
Search
Document Center

ApsaraDB for MongoDB:TagResources

Last Updated:Jan 17, 2023

You can call this operation to bind tags to one or more ApsaraDB for MongoDB instances.

Operation Description

You can create multiple tags and bind them to multiple instances. This allows you to classify and filter instances by tag.

  • A tag consists of a key and a value. Each key must be unique in a region for an Alibaba Cloud account. Different keys can have the same value.
  • If the tag you specify does not exist, this tag is automatically created and bound to the specified instance.
  • If a tag that has the same key is already bound to the instance, the new tag overwrites the existing tag.
  • You can bind up to 20 tags to each instance.
  • You can bind tags to up to 50 instances each time you call the operation.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
dds:TagResources WRITE
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/*
    without
without

Request parameters

Parameter Type Required Description Example
RegionId string Yes

The region ID of the instance. You can call the DescribeDBInstanceAttribute operation to query the region ID of the instance.

cn-hangzhou
ResourceType string Yes

The resource type. Set the value to INSTANCE.

INSTANCE
ResourceGroupId string No

The ID of the resource group.

rg-acfmyiu4ekp****
ResourceId array Yes

The resource IDs.

string No

The ID of instance.

dds-bp1fa5efaa93****
Tag array Yes

The list of tags that you want to associate with the resources. You can specify up to 20 tags.

object No
Key string Yes

The key of tag.

  • The key cannot start with aliyun, acs:, http://, or https://.
  • It can be up to 64 characters in length.
  • The key cannot be an empty string.
env
Value string Yes

The value of tag.

  • The value cannot start with aliyun, acs:, http://, or https://.
  • It can be up to 128 characters in length.
  • The value can be an empty string.
test

Response parameters

Parameter Type Description Example
object
RequestId string

The ID of the request.

0FDDC511-7252-4A4A-ADDA-5CB1BF63****

Example

Normal return example

JSONFormat

{
  "RequestId": "0FDDC511-7252-4A4A-ADDA-5CB1BF63****"
}

Error codes

Http code Error code Error message
400 InvalidTagKey.Malformed The specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.
400 InvalidTagValue.Malformed The specified parameter 'Tag.n.Value' is not valid.
400 InvalidParameter.ResourceId The specified parameter 'ResourceId.n' is not valid.
400 MissParameter.TagOrResourceId The parameter 'Tag.n'' or 'ResourceId.n' is needed.
400 InvalidParameter.Scope The specified parameter 'Scope' is not valid.
400 NumberExceed.ResourceIds The ResourceIds parameter's number is exceed.
400 NumberExceed.Tags The Tags parameter's number is exceed.
400 NumberExceed.CustomTags The Custom Tags parameter's number is exceed. Valid 20.
400 Duplicate.TagKey The specified parameter 'Tag.n.Key' is duplicated.
400 InvalidParameter.ResourceType The specified parameter 'ResourceType' is not valid.
404 InvalidDbInstanceId.NotFound Specified instance does not exist.

For a list of error codes, visit the API error center.