全部產品
Search

搜尋本產品

    ApsaraMQ for MQTT：GetDeviceCertificate - 擷取裝置認證詳情

    文件中心

    ApsaraMQ for MQTT：GetDeviceCertificate - 擷取裝置認證詳情

    更新時間：Dec 21, 2025

    裝置認證是由CA根憑證簽發給用戶端裝置使用的數位憑證，用於用戶端和服務端串連時，服務端對用戶端進行安全認證。認證通過後服務端和用戶端可基於認證內的加密金鑰進行安全通訊，若認證不通過則服務端拒絕用戶端接入。 您可以調用本介面擷取裝置認證的詳細資料。

    介面說明

    • 僅鉑金版執行個體支援使用 GetDeviceCertificate 介面。

    • 單使用者請求頻率限制為 500 次/秒。如有特殊需求，請聯絡雲Message QueueTT 版支援人員，DingTalk群號：35228338。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mq:GetDeviceCertificate

    get

    *Instance

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

    		 無
    • mq:MqttInstanceAccess

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    MqttInstanceId

    string

    是

    裝置認證所綁定的執行個體 ID，即雲Message QueueTT 版的執行個體 ID。

    post-cn-7mz2d******
    DeviceSn

    string

    是

    待查詢裝置認證的 SN 序號，用於唯一標識一個裝置認證。

    取值範圍：不超過 128 Byte。

    356217374433******
    CaSn

    string

    是

    待查詢裝置認證所屬的 CA 憑證的 SN 序號，用於唯一標識一個 CA 憑證。

    取值範圍：不超過 128 Byte。

    007269004887******

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。

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

    object

    認證詳細資料。

    ValidBegin

    string

    裝置認證生效的起始時間。格式為毫秒層級的 Unix 時間戳記。

    1654137303000
    ValidEnd

    string

    裝置認證生效的終止時間。格式為毫秒層級的 Unix 時間戳記。

    1969497303000
    DeviceSn

    string

    裝置認證的 SN 序號，用於唯一標識一個裝置認證。

    356217374433******
    DeviceName

    string

    裝置認證的名稱。

    mqtt_device
    DeviceContent

    string

    裝置認證的內容。

    \n 表示換行。

    -----BEGIN DEVICECERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END DEVICECERTIFICATE-----
    CaSn

    string

    裝置認證所屬的 CA 憑證的 SN 序號，用於唯一標識一個 CA 憑證。

    00f26900ba87******
    Status

    string

    裝置認證的狀態。取值如下：

    • 0：表示認證為未啟用狀態。

    • 1：表示認證為啟用狀態。

    說明

    裝置憑證註冊後，預設為啟用狀態。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Data": {
    "ValidBegin": "1654137303000",
    "ValidEnd": "1969497303000",
    "DeviceSn": "356217374433******",
    "DeviceName": "mqtt_device",
    "DeviceContent": "-----BEGIN DEVICECERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END DEVICECERTIFICATE-----",
    "CaSn": "00f26900ba87******",
    "Status": "1"
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ParameterFieldCheckFailed Failed to validate the parameters. The parameters may be missing or invalid.
    400 MqttOwnerCheckError Failed to validate the instance permission
    500 ParameterFieldCheckFailed Failed to validate the parameters. The parameters may be missing or invalid.
    500 FindDeviceBySnError Failed to find the device certificate by the SN. Please check sn is valid
    500 MqttInstanceNotFound Specified instance is not found
    403 PermissionCheckFailed Failed to verify API permissions.

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

    變更歷史

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