Update RocketMQ Instance Accounts to Control Access via API - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

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

rocketmq:UpdateInstanceAccount

update

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

PATCH /instances/{instanceId}/accounts/{username} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance.	rmq-cn-7e22ody****
username	string	Yes	The name of the account.	test

Request parameters

Parameter	Type	Required	Description	Example
accountStatus	string	No	The status of the account. Valid values: DISABLE : Disables the account. ENABLE : Enables the account.	ENABLE
password	string	No	The password for the account.	test
remark	string	No	The remark for the account.	test

Response elements

Element	Type	Description	Example
	object	The data returned for the request.
requestId	string	The ID of the request.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indicates whether the request was successful.	true
data	boolean	Indicates whether the update was successful. The value is `true` if the update succeeded.	true
code	string	The error code that is returned if the request fails.	Instance.NotFound
message	string	The error message that is returned if the request fails.	The instance cannot be found.
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId
accessDeniedDetail	string	Details about the access denial. This parameter is returned only when a request is denied due to insufficient RAM permissions.	xxx

Examples

Success response

JSON format

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "Instance.NotFound",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.