All Products
Search
Document Center

ApsaraDB for MongoDB:DescribeTags

Last Updated:Mar 15, 2024

Queries all tags in a specified region.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ResourceTypestringNo

The resource type. Set the value to INSTANCE.

INSTANCE
ResourceGroupIdstringNo

The ID of the resource group.

dds-bp17e7a04960****
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****

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 value of this parameter in the next query.
212db86****
RequestIdstring

The ID of the request.

EEDBE38F-5CF5-4316-AAC2-35817BA60D68
Tagsobject []

Details about the tags.

TagValuesarray

The values of the tags.

string

The value of the tag.

newValue
TagKeystring

The key of the tag.

newKey

Examples

Sample success responses

JSONformat

{
  "NextToken": "212db86****",
  "RequestId": "EEDBE38F-5CF5-4316-AAC2-35817BA60D68",
  "Tags": [
    {
      "TagValues": [
        "newValue"
      ],
      "TagKey": "newKey"
    }
  ]
}

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