調(diào)用該接口查詢(xún)?cè)O(shè)備的X.509證書(shū)。

使用說(shuō)明

僅支持地域?yàn)槿A東2（上海），且認(rèn)證方式為X.509證書(shū)的設(shè)備。

QPS限制

單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為10。

說(shuō)明 RAM用戶(hù)共享阿里云賬號(hào)配額。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱(chēng) 類(lèi)型 是否必選 示例值 描述
Action String 是 QueryDeviceCert

系統(tǒng)規(guī)定參數(shù)。取值：QueryDeviceCert。
DeviceName String 是 light

設(shè)備名稱(chēng)。
ProductKey String 是 a1BwAGV****

設(shè)備所屬產(chǎn)品的ProductKey。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁(yè)面，查看當(dāng)前實(shí)例的ID。

重要
  • 若有ID值，必須傳入該ID值，否則調(diào)用會(huì)失敗。
  • 若無(wú)ID值，則無(wú)需傳入。

實(shí)例的更多信息，請(qǐng)參見(jiàn)實(shí)例概述。

調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說(shuō)明，請(qǐng)參見(jiàn)公共參數(shù)文檔。

返回?cái)?shù)據(jù)

名稱(chēng) 類(lèi)型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見(jiàn)錯(cuò)誤碼。

DeviceCertInfo Struct

返回的證書(shū)信息列表。
CertSN String 636217374433****

X.509證書(shū)ID。
Certificate String tXHf4ezGEHcwdyMwoCDHGBmk9avi****

X.509證書(shū)。
PrivateKey String CqXL5h5ysRTA4NxjABjj0010fa****

X.509證書(shū)密鑰。
Status Integer 2

證書(shū)生成狀態(tài)。

  • 0：生成中。
  • 1：生成失敗。
  • 2：生成成功。
ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時(shí)，返回的出錯(cuò)信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。

示例

請(qǐng)求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceCert
&ProductKey=alRedOt****
&DeviceName=device1
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式 

<QueryDeviceCertResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <DeviceCertInfo>
        <Status>2</Status>
        <Certificate>tXHf4ezGEHcwdyMwoCDHGBmk9avi****</Certificate>
        <PrivateKey>CqXL5h5ysRTA4NxjABjj0010fa****</PrivateKey>
        <CertSN>636217374433****</CertSN>
  </DeviceCertInfo>
</QueryDeviceCertResponse>

JSON格式 

{
    "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
    "Success": true,
    "DeviceCertInfo": {
        "Status": 2,
        "Certificate": "tXHf4ezGEHcwdyMwoCDHGBmk9avi****",
        "PrivateKey": "CqXL5h5ysRTA4NxjABjj0010fa****",
        "CertSN": "636217374433****"
    }
}

錯(cuò)誤碼

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。