全部產品
Search

搜尋本產品

    IoT Platform：ListDeviceDistributeJob

    文件中心

    IoT Platform：ListDeviceDistributeJob

    更新時間：Feb 14, 2025

    調用該介面擷取裝置分發工作清單。

    使用說明

    如果在企業版執行個體中調用該介面，請求參數IotInstanceId必須填寫。否則，調用介面會失敗。

    QPS限制

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

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

    調試

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

    請求參數

    名稱 類型 是否必選 樣本值 描述
    Action String 是 ListDeviceDistributeJob

    系統規定參數。取值：ListDeviceDistributeJob。
    PageSize Integer 是 10

    每頁顯示的分發任務數量。最大不超過200條。
    TargetUid String 否 198***

    裝置分發的目標阿里雲帳號ID。
    CurrentPage Integer 否 1

    指定從返回結果中的第幾頁開始顯示。預設值是1。

    NextToken與CurrentPage是設定顯示結果的條件參數，可任選一個傳入。如果同時傳入，則NextToken優先順序更高。

    NextToken參數的使用說明，請參見NextToken描述。
    Status Integer 否 1

    裝置分發任務的狀態。

    • 0：任務初始化。
    • 1：任務執行中。
    • 2：任務完成。該狀態僅表示分發任務執行完成，不表示所有產品和裝置都分發成功。擷取分髮結果詳情，請調用QueryDeviceDistributeDetail。
    • 3：任務異常中斷。
    JobId String 否 UbmsMHmkqv0PiAG****010001

    裝置分發任務的ID。任務的通用唯一識別碼。
    NextToken String 否 TGlzdFJlc291***

    下一頁標識，首次查詢無需傳入。

    NextToken與CurrentPage是設定顯示結果的條件參數，可任選一個傳入。如果同時傳入，則NextToken優先順序更高。

    重要

    定義查詢結果的位移數量為：PageSize×（CurrentPage-1）。

    當位移數量大於10,000時，必須傳入上一次調用本介面返回的NextToken值，才會返回Data資料。否則，介面請求會被中斷，無法返回Data資料。
    ProductKey String 否 aw3zse****

    裝置所屬的產品ProductKey。

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

    返回資料

    名稱 類型 樣本值 描述
    Code String iot.system.SystemException

    調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
    Data Struct

    調用成功後，返回的裝置分發工作清單，詳情參見JobInfo下資訊。
    JobInfo Array of items

    任務的資訊。
    items
    GmtCreate Long 1581595942000

    任務的建立時間。
    JobId String UbmsMHmkqv0PiAG****010001

    任務的ID。
    ProductKey String a1BwAGV****

    裝置所屬產品的ProductKey。
    SourceInstanceId String iot-cn-6ja***

    源執行個體ID。
    SourceInstanceName String 執行個體調試1

    源執行個體名稱。
    SourceRegion String cn-shanghai

    源執行個體所在地區。
    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。
    TargetInstanceName String 執行個體調試2

    目標執行個體名稱。
    TargetRegion String cn-shanghai

    目標執行個體所在地區。
    TargetUid String 198***

    目標阿里雲帳號ID。
    Total Integer 5

    分發任務中的裝置總數。
    NextToken String TGlzdFJlc291***

    下一頁標識。可在下次請求時傳入，來擷取下一頁資料。

    如果傳回值為空白，則表示沒有下一頁資料了。
    Total Integer 10

    返回的裝置分發任務總條數。
    ErrorMessage String 系統異常

    調用失敗時，返回的出錯資訊。
    RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

    阿里雲為該請求產生的唯一識別碼。
    Success Boolean true

    是否調用成功。

    • true：調用成功。
    • false：調用失敗。

    樣本

    請求樣本

    http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDeviceDistributeJob
&CurrentPage=1
&PageSize=10
&TargetUid=198***
&<公用請求參數>

    正常返回樣本

    XML格式

    <ListDeviceDistributeJobResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <NextToken>TGlzdFJlc291***</NextToken>
        <Total>10</Total>
        <JobInfo>
              <items>
                    <Status>1</Status>
                    <SourceInstanceName>執行個體調試1</SourceInstanceName>
                    <GmtCreate>1581595942000</GmtCreate>
                    <SourceUid>198***</SourceUid>
                    <Total>5</Total>
                    <Strategy>0</Strategy>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <ProductKey>a1BwAGV****</ProductKey>
                    <JobId>UbmsMHmkqv0PiAG****010001</JobId>
                    <TargetInstanceConfigs>
                          <targetInstanceConfigs>
                                <TargetRegion>cn-shanghai</TargetRegion>
                                <TargetInstanceName>執行個體調試2</TargetInstanceName>
                                <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
                          </targetInstanceConfigs>
                    </TargetInstanceConfigs>
              </items>
        </JobInfo>
  </Data>
  <Success>true</Success>
</ListDeviceDistributeJobResponse>

    JSON格式

    {
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "NextToken":"TGlzdFJlc291***",
        "Total": 10,
        "JobInfo": {
            "items": {
                "Status": 1,
                "SourceInstanceName": "執行個體調試1",
                "GmtCreate": 1581595942000,
                "SourceUid": "198***",
                "Total": 5,
                "Strategy": 0,
                "TargetUid": "198***",
                "SourceRegion": "cn-shanghai",
                "SourceInstanceId": "iot-cn-6ja***",
                "ProductKey": "a1BwAGV****",
                "JobId": "UbmsMHmkqv0PiAG****010001",
                "TargetInstanceConfigs": {
                    "targetInstanceConfigs": {
                        "TargetRegion": "cn-shanghai",
                        "TargetInstanceName": "執行個體調試2",
                        "TargetInstanceId": "iot-cn-6ja***"
                    }
                }
            }
        }
    },
    "Success": true
}

    錯誤碼

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