DescribeRoleTagStatus - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Describes the status of a tag for a node.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-wz9760547de1****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	69D55DEC-B219-569F-A686-AC2F67A1****
RoleTagStatus	string	The tag status of the ReplicaSet node. Valid values: true: The tag is created. false: The tag is not created. Note If the instance is a sharded cluster, this parameter returns false. Valid values: true : true false : false	false
ShardRoleTagStatus	object	The tag status of each node in the sharded cluster. Valid values: true: The tag is created. false: The tag is not created.	{ "d-2ze204b4db58**": "false", "d-2zeb9716646e*": "false" }

Examples

Success response

JSON format

{
  "RequestId": "69D55DEC-B219-569F-A686-AC2F67A1****",
  "RoleTagStatus": "false",
  "ShardRoleTagStatus": {
    "d-2ze204b4db58****": "false",
    "d-2zeb9716646e***": "false"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.