ApsaraMQ for MQTT:UpdateCustomAuthPermission - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

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

mq:UpdateCustomAuthPermission

update

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance.	post-cn-0pp12gl****
IdentityType	string	Yes	The identity type. Valid values: USER CLIENT	USER
Identity	string	Yes	The username or client ID.	test
PermitAction	string	Yes	The permissions to grant.	PUB_SUB
Effect	string	Yes	Specifies whether to allow or deny the access.	ALLOW
Topic	string	Yes	The authorized topic. Multi-level MQTT topics and wildcards are supported.	test/t1

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	8CC04203-679B-4DED-89D9-E7C2E979****
Code	integer	The error code. For more information, see Error Codes.	200
Success	boolean	Indicates whether the call was successful. Valid values: true, false.	True
Message	string	The returned message.	operation success.

Examples

Success response

JSON format

{
  "RequestId": "8CC04203-679B-4DED-89D9-E7C2E979****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

Error codes

HTTP status code	Error code	Error message
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
404	ApiNotSupport	The specified API is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.