All Products
Search
Document Center

:CreateInstanceAccount

Last Updated:Nov 28, 2024

Creates an account that is used to access an 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:CreateInstanceAccountcreate
*Instance
acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

POST /instances/{instanceId}/accounts HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

rmq-cn-7e22ody****
bodyobjectNo

The request body.

passwordstringYes

The password of the account.

xxx
usernamestringYes

The username of the account.

xxx

Response parameters

ParameterTypeDescriptionExample
object

Result

requestIdstring

The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.

3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D
successboolean

Indicates whether the call was successful.

true
databoolean

The returned result.

true
codestring

The error code returned if the call failed.

MissingInstanceId
messagestring

The error message.

The instance cannot be found.
httpStatusCodeinteger

The HTTP status code.

200
dynamicCodestring

The dynamic error code.

InstanceId
dynamicMessagestring

The dynamic error message.

InstanceId
accessDeniedDetailstring

No permission details

xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "3AE0999C-8DBA-5CEE-8D9A-BE8D4A90DF8D",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId",
  "accessDeniedDetail": "xxx"
}

Error codes

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