All Products
Search

This Product

    ApsaraDB for MongoDB:TagResources

    Document Center

    ApsaraDB for MongoDB:TagResources

    Last Updated:Sep 03, 2024

    Binds tags to ApsaraDB for MongoDB instances.

    Operation description

    If you have a large number of instances, you can create multiple tags, bind the tags to the instances, and filter the 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 be mapped to the same value.
    • If the tag that 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.

    Debugging

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

    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
    dds:TagResourcesupdate
    • Instance
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-hangzhou
    ResourceTypestringYes

    The resource type. Set the value to INSTANCE.

    		INSTANCE
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-acfmyiu4ekp****
    ResourceIdarrayYes

    The details of the tags bound to the instance.

    stringYes

    The ID of instance.

    N specifies the serial number of the instance. The following example shows how to calculate consumption intervals:

    • ResourceId.1 indicates the ID of the first instance.
    • ResourceId.2 indicates the ID of the second instance.
    		dds-bp1fa5efaa93****
    Tagarray<object>Yes

    The tags that are attached to the resources.

    objectYes

    The details of the tags bound to the instance.

    KeystringYes

    The key of tag.

    N specifies the serial number of the tag. The following example shows how to calculate consumption intervals:

    • Tag.1.Key specifies the key of the first tag.
    • Tag.2.Key specifies the key of the second tag.
    		Development team
    ValuestringYes

    The value of tag.

    N specifies the serial number of the tag. The following example shows how to calculate consumption intervals:

    • Tag.1.Value specifies the value of the first tag.
    • Tag.2.Value specifies the value of the second tag.
    		MongoDB 4.0 environment

    Response parameters

    ParameterTypeDescriptionExample
    object

    The information of parameters that is returned.

    RequestIdstring

    The request ID.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidTagKey.MalformedThe specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid.-
    400InvalidTagValue.MalformedThe specified parameter 'Tag.n.Value' is not valid.-
    400InvalidParameter.ResourceIdThe specified parameter 'ResourceId.n' is not valid.-
    400MissParameter.TagOrResourceIdThe parameter 'Tag.n'' or 'ResourceId.n' is needed.-
    400InvalidParameter.ScopeThe specified parameter 'Scope' is not valid.-
    400NumberExceed.ResourceIdsThe ResourceIds parameter's number is exceed.-
    400NumberExceed.TagsThe Tags parameter's number is exceed.-
    400NumberExceed.CustomTagsThe Custom Tags parameter's number is exceed. Valid 20.-
    400Duplicate.TagKeyThe specified parameter 'Tag.n.Key' is duplicated.-
    400InvalidParameter.ResourceTypeThe specified parameter 'ResourceType' is not valid.-
    404InvalidDbInstanceId.NotFoundSpecified instance does not exist.Instance not found. Refresh the page to check whether the instance has been released.

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

    Change history

    Change timeSummary of changesOperation
    2023-07-13The Error code has changedView Change Details