All Products
Search
Document Center

:UpdateInstanceAcl

Last Updated:Nov 28, 2024

Updates the permissions on the resources of a specific instance for a specific user.

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

Request syntax

PATCH /instances/{instanceId}/acl/account/{username} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

rmq-cn-7e22ody****
usernamestringYes

The username.

test
bodyobjectNo

The request body.

resourceTypestringYes

The type of the resource on which you want to grant permissions.

Valid values:

  • Group
  • Topic
Topic
resourceNamestringYes

The name of the resource on which you want to grant permissions.

test
actionsstringNo

The following items describe the types of permissions that can be granted based on the resource type:

  • Topic: Pub, Sub, and Pub|Sub
  • Consumer group: Sub

Valid values:

  • SUB: subscribe
  • Pub|Sub: publish and subscribe
  • Pub: publish
Pub
decisionstringNo

The decision result of the authorization.

Valid values:

  • Deny
  • Allow
Allow
ipWhitelistsarrayNo

The IP address whitelists.

ipWhiteliststringNo

The IP address whitelist.

0.0.0.0/0

Response parameters

ParameterTypeDescriptionExample
object

Result

requestIdstring

The request ID.

C115601B-8736-5BBF-AC99-7FEAE1245A80
successboolean

Indicates whether the request was successful.

true
databoolean

The returned data.

true
codestring

The error code.

MissingInstanceId
messagestring

The error message.

Parameter instanceId is mandatory for this action .
httpStatusCodeinteger

The HTTP status code.

200
dynamicCodestring

The dynamic error code.

InstanceId
dynamicMessagestring

The dynamic error message.

instanceId
accessDeniedDetailstring

The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.

xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "C115601B-8736-5BBF-AC99-7FEAE1245A80",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

Error codes

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