文档

QueryShareProductNameByProductKey

更新时间:

调用该接口根据产品ProductKey查询分享任务中共享设备所属产品的名称。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。

说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String QueryShareProductNameByProductKey

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

ProductKey String a2YwD2****

共享设备所属产品的ProductKey

ShareTaskCode String 52******_7**e_4**3_9**e_61**********

分享任务的分享码。

分享任务的分享码信息,请参见使用共享设备播报分享语料

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

返回数据

名称

类型

示例值

描述

Code String iot.speech.InvalidIotInstanceId

调用结果状态码:

  • 调用成功,返回空值。
  • 调用失败,返回错误码。详细信息,请参见下文错误码
Data Struct

返回的结果。

ProductName String 播报音响

产品名称。

ErrorMessage String Invalid instance ID.

调用失败时,返回的出错信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryShareProductNameByProductKey
&ProductKey=a2YwD2****
&ShareTaskCode=52******_7**e_4**3_9**e_61**********
&<公共请求参数>

正常返回示例

XML格式

<QueryShareProductNameByProductKeyResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <ProductName>播报音响</ProductName>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryShareProductNameByProductKeyResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "ProductName": "播报音响"
    },
    "Code": "",
    "Success": true
}

  • 本页导读 (1)