ListTagResources - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Queries the relationship between ApsaraDB for MongoDB instances and tags.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:ListTagResources

get

*All Resource

*

None

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
NextToken	string	No	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****
ResourceId	array	No	The resource IDs. You must specify this parameter or the Tag parameter.	dds-bpxxxxxxxx
	string	No	The ID of the instance.	开发组
Tag	array<object>	No	The tags that are attached to the resources.
	object	No
Key	string	No	The key of tag.	开发组
Value	string	No	The value of tag.	4.0环境

Response elements

Element	Type	Description	Example
	object
NextToken	string	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****
RequestId	string	The ID of the request.	96017AF2-9AB1-4BC9-88D2-7966B3CD****
TagResources	object
TagResource	array<object>	Details about the tags of the instance.
	object
ResourceType	string	The resource type. The return value is fixed to ALIYUN: KVSTORE: INSTANCE, indicating an ApsaraDB for MongoDB instance.	ALIYUN::DDS::INSTANCE
TagValue	string	The value of the tag.	4.0环境
ResourceId	string	The ID of the resource. It is the ID of the ApsaraDB for MongoDB instance.	dds-bp17e7a04960****
TagKey	string	The key of the tag.	开发组

Examples

Success response

JSON format

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

Error codes

HTTP status 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	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.