Query SASL users-ApsaraMQ for Kafka(Kafka)-阿里云帮助中心

Call DescribeSaslUsers to query SASL users.

Debugging

You can run this operation directly in OpenAPI Explorer without calculating the signature. After a successful call, OpenAPI Explorer automatically generates sample code for different SDKs.

Authorization information

The following table describes the authorization information required for this operation. You can add this information to the Action element of a RAM policy statement to grant a RAM user or RAM role permission to call this operation.

Action: A specific permission.
Access level: The access level for each operation. The value can be Write, Read, or List.
Resource type: The type of resource that can be authorized in an operation. The following provides a detailed description:
- Required resource types are highlighted.
- If an operation does not support resource-level permission, the value is All resources.
Condition key: A condition key that is defined by the cloud service itself.
Associated operation: An operation that is linked to another operation. For an operation to succeed, the operator must also have the permissions for the associated operation.

Actions

Access level

Resource type

Condition key

Associated operation

alikafka:ListSaslUser

List

Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
InstanceId	string	Yes	The instance ID.	alikafka_pre-cn-v0h1cng0****

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The status code. A value of 200 indicates that the request was successful.	200
Message	string	The returned message.	operation success.
RequestId	string	The request ID.	9E3B3592-5994-4F65-A61E-E62A77A****
Success	boolean	Indicates whether the request was successful.	true
SaslUserList	array<object>	A list of SASL users.
	object
Type	string	The authentication type. Valid values: plain: a simple username and password authentication mechanism. ApsaraMQ for Kafka provides an enhanced PLAIN mechanism that enables you to dynamically add SASL users without restarting the instance. scram: a username and password authentication mechanism that is more secure than PLAIN. ApsaraMQ for Kafka uses SCRAM-SHA-256. LDAP: This user type applies only to Confluent instances. Default value: plain.	scram
Password	string	The password.	******
Username	string	The username.	test12***
Mechanism	string	The SASL mechanism. Note The API returns this parameter only for serverless instances.	SCRAM-SHA-256

Examples

Sample successful response

JSON format

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

Error codes

For a list of error codes, see Common error codes.

Change history

Effective date	Content	Actions
2024-04-02	Updated the error codes and request parameters for this operation.	View change details

上一篇: DeleteSaslUser - Delete a SASL user 下一篇: Common error codes