调用该接口查询已分发的产品列表。

使用说明

  • 调用云服务的接入地址Endpoint仅支持华东2(上海),即iot.cn-shanghai.aliyuncs.com
  • 单阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
    说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListDistributedProduct

系统规定参数。取值:ListDistributedProduct。

CurrentPage Integer 1

指定从返回结果中的第几页开始显示。默认值是1。

PageSize Integer 5

每页显示的产品数量。最大不超过200条。

SourceInstanceId String iot-060***

产品所属的源实例ID。

  • 各地域公共实例ID:
    • 华东2(上海):iotx-oxssharez200。
    • 日本:iotx-oxssharez300。
    • 新加坡:iotx-oxssharez400。
    • 美国(硅谷):iotx-oxssharez500。
    • 美国(弗吉尼亚):iotx-oxssharez600。
    • 德国(法兰克福):iotx-oxssharez700。
  • 企业版实例ID:

    1. 登录物联网平台控制台,从顶部导航栏左上方的下拉菜单选择地域。

    2. 在实例概览页面,单击实例名称,在实例详情页面的实例基本信息中查看实例ID

ProductKey String a1BwAGV****

产品的ProductKey

TargetInstanceId String iot-cn-6ja***

产品分发的目标实例ID。实例ID详情,请参见参数SourceInstanceId描述。

TargetUid String 198***

产品所属的阿里云账号ID。可登录物联网平台控制台,单击账号头像,跳转至安全设置页面查看。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

Data Struct

调用成功时,返回的产品列表,详情请参见Info下信息。

Info Array of items

产品的信息。

items
GmtCreate Integer 1581595942

产品所属分发任务的创建时间。

ProductKey String a1BwAGV****

产品的ProductKey

SourceInstanceId String iot-cn-6ja***

产品的源实例ID。

SourceInstanceName String myproInstance

产品的源实例名称。

SourceRegion String cn-shanghai

产品所属的源地域。

SourceUid String 198***

分发产品的源阿里云账号ID。目前仅支持同一阿里云账号下跨地域和跨实例分发产品,此参数与TargetUid值相同。

TargetAliyunId String io****@example.com

接收产品的目标阿里云账号。

TargetInstanceId String iot-cn-09k***

产品分发的目标实例ID。

TargetInstanceName String newinstance

产品分发的目标实例名称。

TargetRegion String cn-shenzhen

产品分发的目标地域。

TargetUid String 198***

接收产品的目标阿里云账号ID。

目前仅支持同一阿里云账号下跨地域和跨实例分发设备,此参数与SourceUid值相同。

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=ListDistributedProduct
&CurrentPage=1
&PageSize=5
&TargetUid=198***
&<公共请求参数>

正常返回示例

XML格式

<ListDistributedProductResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Total>10</Total>
        <Info>
              <items>
                    <TargetRegion>cn-shenzhen</TargetRegion>
                    <SourceInstanceName>myproInstance</SourceInstanceName>
                    <TargetAliyunId>io****@example.com</TargetAliyunId>
                    <GmtCreate>1581595942</GmtCreate>
                    <SourceUid>198***</SourceUid>
                    <TargetInstanceName>newinstance</TargetInstanceName>
                    <TargetInstanceId>iot-cn-09k***</TargetInstanceId>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <ProductKey>a1BwAGV****</ProductKey>
              </items>
        </Info>
  </Data>
  <Success>true</Success>
</ListDistributedProductResponse>

JSON格式

{
	"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
	"Data": {
		"Total": "10",
		"Info": {
			"items": [{
				"TargetRegion": "cn-shenzhen",
				"SourceInstanceName": "myproInstance",
				"TargetAliyunId": "io****@example.com",
				"GmtCreate": "1581595942",
				"SourceUid": "198***",
				"TargetInstanceName": "newinstance",
				"TargetInstanceId": "iot-cn-09k***",
				"TargetUid": "198***",
				"SourceRegion": "cn-shanghai",
				"SourceInstanceId": "iot-cn-6ja***",
				"ProductKey": "a1BwAGV****"
			}]
		}
	},
	"Success": "true"
}

错误码

访问错误中心查看更多错误码。