UpdateCustomAuthPermission - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

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.

Updates the permissions on a topic.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
mq:UpdateCustomAuthPermission	update	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID of the Cloud Message Queue MQTT version instance.	post-cn-0pp12gl****
IdentityType	string	Yes	The identity type. Valid values: USER CLIENT	USER
Identity	string	Yes	Username or Client ID.	test
PermitAction	string	Yes	The permissions that you want to grant. Enumeration Value: PUB SUB PUB_SUB	PUB_SUB
Effect	string	Yes	Specifies whether to allow or deny access. Enumeration Value: ALLOW DENY	ALLOW
Topic	string	Yes	Authorized Topic, supporting multi-level MQTT topics and wildcards.	test/t1

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	8CC04203-679B-4DED-89D9-E7C2E979****
Code	integer	Error code returned upon failed invocation. For more information, see Error Codes.	200
Success	boolean	Indicates whether the call was successful. true: Call succeeded. false: Call failed.	True
Message	string	Information	operation success.

Examples

Sample success responses

JSONformat

{
  "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.

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

Change history

Change time	Summary of changes	Operation

No change history