QueryDeviceDistributeJob - IoT Platform

使用說明

調用雲端服務的接入地址Endpoint僅支援華東2（上海），即iot.cn-shanghai.aliyuncs.com。
單阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為10。
說明 RAM使用者共用阿里雲帳號配額。

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDeviceDistributeJob	系統規定參數。取值：QueryDeviceDistributeJob。
JobId	String	是	UbmsMHmkqv0PiAG****010001	分發任務ID。任務的通用唯一識別碼。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功後，返回的裝置分發任務詳情。
GmtCreate	Long	1581595942000	分發任務的建立時間。
JobId	String	UbmsMHmkqv0PiAG****010001	分發任務的ID。
ProductKey	String	a1BwAGV****	裝置所屬產品的ProductKey。
SourceInstanceId	String	iot-cn-6ja***	源執行個體ID。
SourceUid	String	198***	阿里雲帳號ID。
Status	Integer	1	分發任務狀態。 0：任務初始化。 1：任務執行中。 2：任務完成。該狀態僅表示分發任務執行完成，不表示所有產品和裝置都分發成功。擷取分髮結果詳情，請調用QueryDeviceDistributeDetail。 3：任務異常中斷。
Strategy	Integer	0	分發策略。 0：指定地區，將裝置分發到指定地區的指定執行個體。 1：就近接入，配置了多個地區的執行個體ID，裝置將根據裝置的IP位置動態接入其中距離最近的地區。
TargetInstanceConfigs	Array of targetInstanceConfigs		目標執行個體ID列表。當參數Strategy為1時，列表可有多個執行個體ID。當參數Strategy為0時，列表有一個執行個體ID。
targetInstanceConfigs
TargetInstanceId	String	iot-cn-6ja***	目標執行個體ID。
TargetUid	String	198***	阿里雲帳號ID。
Total	Integer	5	分發任務中的裝置總數。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDistributeJob
&JobId=UbmsMHmkqv0PiAG****010001
&<公用請求參數>

正常返回樣本

XML 格式

<QueryDeviceDistributeJobResponse>
  <RequestId> E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>1</Status>
        <GmtCreate>1581595942000</GmtCreate>
        <SourceUid>198***</SourceUid>
        <Total>5</Total>
        <Strategy>0</Strategy>
        <TargetUid>198***</TargetUid>
        <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
        <TargetInstanceConfigs>
              <targetInstanceConfigs>
                    <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
              </targetInstanceConfigs>
        </TargetInstanceConfigs>
        <ProductKey>a1BwAGV****</ProductKey>
        <JobId>UbmsMHmkqv0PiAG****010001</JobId>
  </Data>
  <Success>true</Success>
</QueryDeviceDistributeJobResponse>

JSON 格式

{
	"RequestId": " E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
	"Data": {
		"Status": "1",
		"GmtCreate": "1581595942000",
		"SourceUid": "198***",
		"Total": "5",
		"Strategy": "0",
		"TargetUid": "198***",
		"SourceInstanceId": "iot-cn-6ja***",
		"TargetInstanceConfigs": {
			"targetInstanceConfigs": [{
				"TargetInstanceId": "iot-cn-6ja***"
			}]
		},
		"ProductKey": "a1BwAGV****",
		"JobId": "UbmsMHmkqv0PiAG****010001"
	},
	"Success": "true"
}

錯誤碼

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