All Products
Search
Document Center

ApsaraMQ for MQTT:AddCustomAuthPermission

Last Updated:Aug 22, 2024

Adds permissions on topics. You must create a level-1 topic in the ApsaraMQ for MQTT console before you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the ApsaraMQ for MQTT instance.

mqtt-cn-0pp12gl****
IdentityTypestringYes

The identity type. Valid values: USER and CLIENT.

USER
IdentitystringYes

The username or client ID.

test
PermitActionstringYes

The permissions that you want to add.

Enumeration Value:
  • PUB
  • SUB
  • PUB_SUB
PUB_SUB
EffectstringYes

Specify whether to allow or deny the permissions.

Enumeration Value:
  • ALLOW
  • DENY
ALLOW
TopicstringYes

The topic on which you want to add the permissions. Multi-level topics and wildcard characters are supported.

test/t1

Response parameters

ParameterTypeDescriptionExample
object

The schema object.

RequestIdstring

The request ID.

82B9E503-F4A1-4F30-976F-C6999FF9****
Codeinteger

The HTTP status code. The status code 200 indicates that the request is successful.

200
Successboolean

Indicates whether the request is successful. Valid values: true and false.

True
Messagestring

The error message returned.

operation success.

Examples

Sample success responses

JSONformat

{
  "RequestId": "82B9E503-F4A1-4F30-976F-C6999FF9****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

Error codes

HTTP status codeError codeError messageDescription
400InstancePermissionCheckFailedAn error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.-
400InvalidParameter.%sAn error occurred while validating the parameter. The parameter may be missing or invalid.-
400Customauth.over.capacityOver custom auth capacity.User-defined permission quantity capacity exceeds the limit
404ApiNotSupportThe specified API is not supported.-

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