QueryCustomAuthIdentity - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Queries the information about custom identity authentication.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance.	post-111****
Username	string	No	The username.	test
IdentityType	string	No	The identity type. Valid values: USER CLIENT	USER
ClientId	string	No	The client ID if you set IdentityType to CLIENT.	GID_test@@@test
NextToken	string	No	The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.	eyJhY2NvdW50IjoiMTM4MTcxODk3NDQzMjQ1OSIsImV2ZW50SWQiOiJGMkUxOUE3QS1FM0Q0LTVCOEYtQkU4OS1CNkMyM0RBM0UyRjIiLCJsb2dJZCI6IjY2LTEzODE3MTg5NzQ0MzI0NTkiLCJydyI6IlciLCJ0aW1lIjoxNjc4MzI2MTI1MDAwfQ
Size	integer	Yes	The number of identities to be queried. Maximum value: 100.	100

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	11568B5B-13A8-4E72-9DBA-3A14F7D3****
Code	integer	The HTTP status code. The status code 200 indicates that the request is successful. Other status codes indicate that the request failed. For a list of error codes, see Error codes.	200
Success	boolean	Indicates whether the request is successful. Valid values: true and false.	True
Message	string	The returned message.	operation success.
Data	object	The returned data.
Results	array<object>	The returned results.
	object
Username	string	The username.	test
Secret	string	The AccessKey secret.	62a5916d71767185b48907d85c2efae2
IdentityType	string	The identity type. Valid values: USER CLIENT	USER
ClientId	string	The client ID if IdentityType is set to CLIENT.	GID_ICP@@@4d378084
SignMode	string	The signature verification mode. ORIGIN: compares the password and the AccessKey secret. SIGNED: uses the HMAC_SHA1 algorithm to sign the client ID to obtain a password and then compares the password.	SIGNED
NextToken	string	If excess return values exist, this parameter is returned.	AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ

Examples

Sample success responses

JSONformat

{
  "RequestId": "11568B5B-13A8-4E72-9DBA-3A14F7D3****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "Username": "test",
        "Secret": "62a5916d71767185b48907d85c2efae2",
        "IdentityType": "USER",
        "ClientId": "GID_ICP@@@4d378084",
        "SignMode": "SIGNED"
      }
    ],
    "NextToken": "AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ"
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
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