調用該接口,查詢指定V系列邊緣一體機已關聯的所有設備組。
限制條件
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為100。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | QueryFaceDeviceGroupsByDevice | 系統規定參數。取值:QueryFaceDeviceGroupsByDevice。 |
DeviceName | String | 是 | TestDevice | V系列邊緣一體機對應的設備名稱。在邊緣計算控制臺V系列邊緣一體機的主機詳情頁面基本信息頁簽,找到視頻網關信息,獲取DeviceName值。 |
IotInstanceId | String | 是 | iot_instc_pu****_c*-v64******** | 實例ID。 必須傳入實例ID,否則調用會失敗。您可在物聯網平臺控制臺的實例概覽頁面,查看您的實例ID。 重要 如果公共實例沒有ID,請參見如何獲取實例ID。 |
IsolationId | String | 是 | ZheJiangHZ | 業務隔離ID,用于隔離同一個阿里云賬號下不同業務應用之間的數據。請與調用AddFaceDeviceGroup接口創建設備組時設置的IsolationId保持一致。 |
PageNo | Integer | 是 | 1 | 指定從返回結果中的第幾頁開始顯示。最小取值為1。 |
PageSize | Integer | 是 | 20 | 返回結果中,每頁顯示的記錄數量。最大取值100,最小取值1,默認取值為20。 |
ProductKey | String | 是 | a1Tp7KY**** | V系列邊緣一體機對應的設備所屬產品唯一標識。請在邊緣計算控制臺V系列邊緣一體機的主機詳情頁面基本信息頁簽,找到視頻網關信息,獲取ProductKey值。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
Code | String | 200 | 接口返回碼:
|
Data | Struct | 調用成功時,返回的數據。 |
|
DeviceGroupList | Array of deviceGroupList | 設備組列表。 |
|
DeviceGroupId | String | jykv**** | 設備組ID。 |
DeviceGroupName | String | TestDeviceGroup | 設備組名稱。 |
ModifiedTime | String | 2020-05-12 17:12:37 | 最后一次更新設備組信息的時間。 |
PageNo | Integer | 1 | 當前頁碼。 |
PageSize | Integer | 20 | 返回結果中每頁顯示的記錄數量。 |
Total | Integer | 5 | 設備組總數。 |
ErrorMessage | String | request parameter error | 調用失敗時,返回的出錯信息。 |
RequestId | String | 0A13279A-5640-45E7-87AA-83750541AD0E | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功:
|
示例
請求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=QueryFaceDeviceGroupsByDevice
&DeviceName=TestDevice
&IotInstanceId=iot_instc_pu****_c*-v64********
&IsolationId=ZheJiangHZ
&PageNo=1
&PageSize=20
&ProductKey=a1Tp7KY****
&<公共請求參數>
正常返回示例
XML
格式
<QueryFaceDeviceGroupsByDeviceResponse>
<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>
<Data>
<PageSize>20</PageSize>
<Total>5</Total>
<DeviceGroupList>
<ModifiedTime>2020-05-12 17:12:37</ModifiedTime>
<DeviceGroupName>TestDeviceGroup</DeviceGroupName>
<DeviceGroupId>jykv****</DeviceGroupId>
</DeviceGroupList>
<PageNo>1</PageNo>
</Data>
<Code>200</Code>
<Success>true</Success>
</QueryFaceDeviceGroupsByDeviceResponse>
JSON
格式
{
"RequestId": "0A13279A-5640-45E7-87AA-83750541AD0E",
"Data": {
"PageSize": 20,
"Total": 5,
"DeviceGroupList": {
"ModifiedTime": "2020-05-12 17:12:37",
"DeviceGroupName": "TestDeviceGroup",
"DeviceGroupId": "jykv****"
},
"PageNo": 1
},
"Code": "200",
"Success": true
}