全部產品
Search

搜尋本產品

    ApsaraMQ for MQTT：AddCustomAuthIdentity - 添加身份認證

    文件中心

    ApsaraMQ for MQTT：AddCustomAuthIdentity - 添加身份認證

    更新時間：Dec 21, 2025

    添加帳號身份認證資訊，可以具體到用戶端。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mq:AddCustomAuthIdentity

    create

    *Instance

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    雲Message QueueTT 版執行個體的 ID。

    mqtt-cn-xxxx
    Username

    string

    是

    使用者名稱。

    test
    Secret

    string

    是

    密鑰。

    xxxxx
    IdentityType

    string

    是

    身份類型。

    • USER：僅使用者名稱。

    • CLIENT：具體到用戶端。

    USER
    ClientId

    string

    否

    當身份類型是 CLIENT 時，指定裝置的 ClientID。

    GID_test@@@test
    SignMode

    string

    是

    簽名校正方式，ORIGIN：原始值比較，即比較 password 與 secret，SIGNED： 對 clientId 進行 HmacSHA1 加簽（使用 secret，參考簽名模式）驗證，然後比較 password。

    SIGNED

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    Id of the request

    020F6A43-19E6-4B6E-B846-44EB31DF****
    Code

    integer

    狀態代碼。說明 200 表示成功。

    200
    Success

    boolean

    操作是否成功。true 表示成功，false 表示失敗。

    True
    Message

    string

    返回資訊。

    operation success.

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    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執行個體的所屬關係以及授權策略。
    400 InvalidParameter.%s An error occurred while validating the parameter. The parameter may be missing or invalid. 參數校正失敗，可能缺失或者傳入值非法。
    400 Customauth.over.capacity Over custom auth capacity. 自訂許可權數量容量超限
    404 ApiNotSupport The specified API is not supported. 當前介面不支援，請檢查。

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

    變更歷史

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