調用該接口查詢指定數據目的詳細信息。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為10。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetDestination |
系統規定參數。取值:GetDestination。 |
DestinationId | Long | 是 | 1004 |
數據目的ID。您可調用接口ListDestination,查詢數據目的列表,獲取DestinationId。 |
IotInstanceId | String | 否 | iot-2w**** |
實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 注意
實例的更多信息,請參見實例概述。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
Destination | Struct |
返回的數據目的信息。 |
|
Configuration | String | {"topic":"/a1POX0c****/device1/user/get","topicType":1} |
數據目的對應的配置信息。 |
DestinationId | String | 1003 |
數據目的ID。 |
IsFailover | Boolean | false |
該數據目的配置是否為轉發錯誤操作數據,即轉發流轉到其他云產品失敗且重試失敗的數據。
默認值為false。 |
Name | String | DataPurpose |
數據目的名稱。 |
Status | String | NORMAL |
數據目的對應的狀態。返回值:
|
Type | String | REPUBLISH |
數據目的的操作類型。
|
UtcCreated | String | 2022-03-27T12:45:43.000Z |
創建數據目的對應的UTC時間。格式為 |
ErrorMessage | String | 系統異常 |
調用失敗時,返回的出錯信息。 |
RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E |
阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true |
表示是否調用成功。
|
示例
請求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetDestination
&DestinationId=1004
&<公共請求參數>
正常返回示例
XML
格式
<GetDestinationResponse>
<Destination>
<Type>REPUBLISH</Type>
<UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
<Configuration>{"topic":"/a1POX0c****/device1/user/get","topicType":1}</Configuration>
<IsFailover>false</IsFailover>
<Status>NORMAL</Status>
<DestinationId>1003</DestinationId>
<Name>DataPurpose</Name>
</Destination>
<RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
<Success>true</Success>
</GetDestinationResponse>
JSON
格式
{
"Destination": {
"Type": "REPUBLISH",
"UtcCreated": "2022-03-27T12:45:43.000Z",
"Configuration": "{\"topic\":\"/a1POX0c****/device1/user/get\",\"topicType\":1}",
"IsFailover": false,
"Status": "NORMAL",
"DestinationId": 1003,
"Name": "DataPurpose"
},
"RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
"Success": true
}