All Products
Search
Document Center

:GetInstanceAccount

Last Updated:Nov 28, 2024
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.

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
rocketmq:GetInstanceAccountget
*Instance
acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

rmq-cn-20p36ja4m0y
usernamestringNo

The username of the account.

If you do not configure this parameter, the default username of the instance is used.

test

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

Request ID, each request's ID is unique and can be used for troubleshooting and problem localization.

B5C59E80-FCFC-5796-ABE4-D39EAAE578E4
successboolean

Indicates whether the request was successful.

true
dataobject

The data returned.

usernamestring

The username of the account.

xxx
passwordstring

The password of the account.

*************
codestring

The error code.

MissingInstanceId
messagestring

The error message.

The instance cannot be found.
httpStatusCodeinteger

The HTTP status code.

200
dynamicCodestring

The dynamic error code.

ConsumerGroupId
dynamicMessagestring

The dynamic error message.

instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "B5C59E80-FCFC-5796-ABE4-D39EAAE578E4",
  "success": true,
  "data": {
    "username": "xxx",
    "password": "*************"
  },
  "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 timeSummary of changesOperation
No change history