GetInstanceAccount - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Obtains the account used to access a specific instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:GetInstanceAccount	get	*Instance `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}`	none	none

Request syntax

GET /instances/{instanceId}/account HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-20p36ja4m0y
username	string	No	The username of the account. If you do not configure this parameter, the default username of the instance is used.	test

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	Request ID, each request's ID is unique and can be used for troubleshooting and problem localization.	B5C59E80-FCFC-5796-ABE4-D39EAAE578E4
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
username	string	The username of the account.	xxx
password	string	The password of the account.	*************
accountStatus	string	The status of the account. Valid values: DISABLE ENABLE	ENABLE
code	string	The error code.	MissingInstanceId
message	string	The error message.	The instance cannot be found.
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	ConsumerGroupId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "B5C59E80-FCFC-5796-ABE4-D39EAAE578E4",
  "success": true,
  "data": {
    "username": "xxx",
    "password": "*************",
    "accountStatus": "ENABLE"
  },
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "instanceId"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-02-13	The response structure of the API has changed	View Change Details