调用DescribeShadowSchema根据机型获取schema信息。

调试

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

请求参数

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

系统规定参数。取值:DescribeShadowSchema

DeviceModel String model_2nd

机型

ProjectId String PIC3UA0V

项目ID

IsSimple Boolean false

是否不返回描述信息

RegionId String cn-shanghai

地域ID

返回数据

名称 类型 示例值 描述
RequestId String 629586FE-CB2E-4742-995E-121F952CEB72

请求ID

Schema String [ { \"id\": 102, \"name\": \"product:对内型号\", \"open\": false, \"pId\": 1, \"path\": \"/device_info/product\" }, { \"id\": 101, \"name\": \"manufacture:制造商\", \"open\": false, \"pId\": 1, \"path\": \"/device_info/manufacture\" } ]

schema信息

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeShadowSchema
&DeviceModel=model_2nd
&ProjectId=PIC3UA0V
&<公共请求参数>

正常返回示例

XML 格式

<DescribeShadowSchemaResponse>
      <RequestId>195D7F63-0904-49ED-854B-13C7BB37F764</RequestId>
	  <Schema>[{"path":"/device_info/product","name":"product:对内型号","pId":1,"id":102,"open":false},{"path":"/device_info/manufacture","name":"manufacture:制造商","pId":1,"id":101,"open":false}]</Schema>
</DescribeShadowSchemaResponse>

JSON 格式

{
	"Schema":"[{\"path\":\"/device_info/product\",\"name\":\"product:对内型号\",\"pId\":1,\"id\":102,\"open\":false},{\"path\":\"/device_info/manufacture\",\"name\":\"manufacture:制造商\",\"pId\":1,\"id\":101,\"open\":false}]",
	"RequestId":"195D7F63-0904-49ED-854B-13C7BB37F764"
}

错误码

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