QueryCustomAuthIdentity - 查詢身份認證 - ApsaraMQ for MQTT

查詢自訂身份認證。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryCustomAuthIdentity

get

*Instance

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

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	雲Message QueueTT 版執行個體的 ID。	post-111****
Username	string	否	使用者名稱。	test
IdentityType	string	否	身份類型。	USER
ClientId	string	否	當查詢身份類型是 CLIENT 時，可以指定裝置的 ClientID。	GID_test@@@test
NextToken	string	否	用來標記當前查詢結束的位置，以便下一次調用時作為參數傳入，繼續翻頁。首次調用或返回最後一頁時，取值為空白字串。	eyJhY2NvdW50IjoiMTM4MTcxODk3NDQzMjQ1OSIsImV2ZW50SWQiOiJGMkUxOUE3QS1FM0Q0LTVCOEYtQkU4OS1CNkMyM0RBM0UyRjIiLCJsb2dJZCI6IjY2LTEzODE3MTg5NzQ0MzI0NTkiLCJydyI6IlciLCJ0aW1lIjoxNjc4MzI2MTI1MDAwfQ
Size	integer	是	查詢數量，最大值：100。	100

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	11568B5B-13A8-4E72-9DBA-3A14F7D3****
Code	integer	介面返回碼：200：表示成功。其它：表示錯誤碼。錯誤碼詳情，請參見錯誤碼。	200
Success	boolean	是否調用成功：true：調用成功。 false：調用失敗。	True
Message	string	附加資訊。	operation success.
Data	object	查詢結果。
Results	array<object>	返回資料。
	object	返回資料。
Username	string	使用者名稱。	test
Secret	string	密鑰。	62a5916d71767185b48907d85c2efa****
IdentityType	string	身份類型。 USER：僅使用者名稱。 CLIENT：具體到用戶端。	USER
ClientId	string	當身份類型是 CLIENT 時，指定裝置的 ClientID。	GID_ICP@@@4d378084
SignMode	string	簽名校正方式，ORIGIN：原始值比較，即比較 password 與 secret，SIGNED：對 clientId 進行 HmacSHA1 加簽（使用 secret）驗證，然後比較 password。	SIGNED
NextToken	string	如果還有多餘的傳回值則會返回 NextToken。	AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.	執行個體許可權校正失敗，請確認MQTT執行個體的所屬關係以及授權策略。
404	ApiNotSupport	The specified API is not supported.	當前介面不支援，請檢查。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。