All Products
Search
Document Center

ApsaraDB for MongoDB:ListTagResources

Last Updated:Mar 15, 2024

Queries the relationship between ApsaraDB for MongoDB instances and tags.

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:ListTagResourcesLIST
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/*
    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
NextTokenstringNo

The token used to start the next query to retrieve more results.

Note This parameter is not required in the first query. If not all results are returned in one query, you can pass in the NextToken value returned in the previous query to perform the query again.
212db86****
ResourceIdarrayNo

The resource IDs. You must specify this parameter or the Tag parameter.

stringNo

The ID of the instance.

dds-8vbe0445c6e12***
Tagobject []No

The tags that are attached to the resources.

KeystringNo

The key of tag.

env
ValuestringNo

The value of tag.

dev

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The token used to start the next query.

Note If not all results are returned in the first query, this parameter is returned. You can pass in the returned value of this parameter in the next query.
212db86****
RequestIdstring

The ID of the request.

96017AF2-9AB1-4BC9-88D2-7966B3CD****
TagResourcesobject []

Details about the tags of the instance.

ResourceTypestring

The resource type. The return value is fixed to ALIYUN: KVSTORE: INSTANCE, indicating an ApsaraDB for MongoDB instance.

ALIYUN::DDS::INSTANCE
TagValuestring

The value of the tag.

dev
ResourceIdstring

The ID of the resource. It is the ID of the ApsaraDB for MongoDB instance.

dds-bp17e7a04960****
TagKeystring

The key of the tag.

Environment

Examples

Sample success responses

JSONformat

{
  "NextToken": "212db86****",
  "RequestId": "96017AF2-9AB1-4BC9-88D2-7966B3CD****",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "ALIYUN::DDS::INSTANCE",
        "TagValue": "dev",
        "ResourceId": "dds-bp17e7a04960****",
        "TagKey": "Environment"
      }
    ]
  }
}

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.-
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
No change history