QueryDeviceProvisioning - IoT Platform

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為50。

說明 RAM使用者共用阿里雲帳號配額。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDeviceProvisioning	系統規定參數。取值：QueryDeviceProvisioning。
ProductKey	String	是	a1ji*****	裝置所屬產品的ProductKey。
DeviceName	String	是	testDevcieBwT3Un	裝置名稱。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用成功時，返回success。調用失敗，返回錯誤碼。詳細資料，請參見下文錯誤碼。
Data	Struct		調用成功後，返回的裝置分髮結果。
AliyunUid	String	io****@example.com	裝置當前所屬阿里雲帳號。
DeviceName	String	testDevcieBwT3Un	裝置名稱。
GmtCreate	Long	1676297683000	裝置所屬分發任務的建立時間（毫秒級時間戳記）。如果裝置未分發，則返回當前伺服器時間戳記。
GmtModified	Long	1676297683000	裝置所屬分發任務的修改時間（毫秒級時間戳記）。如果裝置未分發，則返回當前伺服器時間戳記。
ProductKey	String	a1ji*****	裝置所屬產品的ProductKey。
SourceIotInstanceId	String	iot-6ja****	裝置所屬的源執行個體ID。
SourceRegion	String	cn-shanghai	裝置所屬的源地區。
TargetIotInstanceId	String	iot-09k****	裝置所屬的目標執行個體ID。
TargetRegion	String	ap-southeast-1	裝置所屬的目標地區。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceProvisioning
&ProductKey=a1ji*****
&DeviceName=testDevcieBwT3Un
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceProvisioningResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <TargetRegion>ap-southeast-1</TargetRegion>
        <GmtCreate>1676297683000</GmtCreate>
        <TargetIotInstanceId>iot-09k****</TargetIotInstanceId>
        <AliyunUid>io****@example.com</AliyunUid>
        <GmtModified>1676297683000</GmtModified>
        <SourceIotInstanceId>iot-6ja****</SourceIotInstanceId>
        <SourceRegion>cn-shanghai</SourceRegion>
        <ProductKey>a1ji*****</ProductKey>
        <DeviceName>testDevcieBwT3Un</DeviceName>
  </Data>
  <Code>success</Code>
  <Success>true</Success>
</QueryDeviceProvisioningResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "TargetRegion": "ap-southeast-1",
        "GmtCreate": 1676297683000,
        "TargetIotInstanceId": "iot-09k****",
        "AliyunUid": "io****@example.com",
        "GmtModified": 1676297683000,
        "SourceIotInstanceId": "iot-6ja****",
        "SourceRegion": "cn-shanghai",
        "ProductKey": "a1ji*****",
        "DeviceName": "testDevcieBwT3Un"
    },
    "Code": "success",
    "Success": true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	iot.common.APINotSupportedInInstance	This API operation is not supported in this instance.	當前執行個體不支援該API。
400	iot.common.RamActionPermissionDeny	You do not have the RAM permission.	沒有資源存取控制（RAM）許可權。
400	iot.common.InvalidTenant	The Invalid tenant.	不合法的租戶或者建立租戶失敗。
400	iot.common.InvalidFormattedParameter	The parameter format is invalid.	參數格式錯誤。

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