All Products
Search
Document Center

ApsaraMQ for Kafka:DescribeSaslUsers

Last Updated:Mar 15, 2024

Queries Simple Authentication and Security Layer (SASL) users.

Debugging

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

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
alikafka:ListSaslUserRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
InstanceIdstringYes

The ID of the instance.

alikafka_pre-cn-v0h1cng0****

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

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

200
Messagestring

The returned message.

operation success.
RequestIdstring

The ID of the request.

9E3B3592-5994-4F65-A61E-E62A77A****
Successboolean

Indicates whether the request is successful.

true
SaslUserListobject []

The SASL users.

Typestring

The request type. Valid values:

  • plain: a simple mechanism that uses usernames and passwords to verify user identities. Message Queue for Apache Kafka provides an optimized PLAIN mechanism that allows you to dynamically create SASL users for an instance without the need to restart the instance.
  • scram: a mechanism that uses usernames and passwords to verify user identities. This mechanism provides better security protection than the PLAIN mechanism. Message Queue for Apache Kafka uses SCRAM-SHA-256.

Default value: plain.

scram
Passwordstring

The password that is used to access the Elasticsearch cluster.

******
Usernamestring

The name of the user.

test12***

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "9E3B3592-5994-4F65-A61E-E62A77A****",
  "Success": true,
  "SaslUserList": {
    "SaslUserVO": [
      {
        "Type": "scram",
        "Password": "******",
        "Username": "test12***"
      }
    ]
  }
}

Error codes

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