描述

接口名：DescribeDeviceInfo

查询设备相关信息，比如授权有效期、接入方自定义的业务标识和设备ID等。

请求方法：支持以HTTPS POST和GET方法发送请求。

请求参数

名称 类型 参数位置 是否必需 描述
DeviceId String Query 否 内容安全服务端为接入方设备生成的唯一ID，只有在设备成功激活后才会生成，该ID可通过离线人脸识别SDK里的getLicenseExtraInfo函数获得。
UserDeviceId String Query 否 不超过64字符，由接入方自定义，可用于标识具体设备。
BizType String Query 否 业务类型。不超过64字符。
ExpiredStartDay String Query 否 查询的开始时间，即查询在ExpiredStartDay和ExpiredEndDay之间要过期的授权。示例：20180101。
ExpiredEndDay String Query 否 查询的结束时间。即查询在ExpiredStartDay和ExpiredEndDay之间要过期的授权。示例：20180101。
PageSize Integer Query 否 查询每页数目。
CurrentPage Integer Query 否 当前查询页数。

返回参数

名称 类型 描述
PageSize Integer 每页数目。
CurrentPage Integer 当前查询页数。
TotalCount Integer 总数。
Devices Array 设备信息数组。每个元素如下表DeviceInfo。
表 1. DeviceInfo
名称 类型 描述
DeviceId String 对应于请求中的DeviceId。
UserDeviceId String 对应于请求中的UserDeviceId。
BizType String 对应于请求中的BizType。
BeginDay String 授权开始时间。示例：20180101。
ExpiredDay String 授权到期时间。示例：20180101。

示例

以下是拼接HTTPS请求的相关示例：
  • 请求示例 
    https://cloudauth.aliyuncs.com/?Action= DescribeDeviceInfo
&DeviceId=wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
&BizType=FACE_TEST
&UserDeviceId=3iJ1AY$oHcu7mC69
&ExpiredStartDay=20190401
&ExpiredEndDay=20200330
&PageSize=20
&CurrentPage=1
&<[公共请求参数]>
    其中，公共请求参数请参见API调用方式。
  • 返回示例
    • XML格式 
      <?xml version='1.0' encoding='UTF-8'?>
<DescribeDeviceInfoResponse>
    <Data>
        <PageSize>20</PageSize>
    <CurrentPage>1</CurrentPage>
    <TotalCount>1</TotalCount>
    <Devices>
    <DeviceId>wd.6ziUffspAeW5FVYbaqmexR-1qwNjM</DeviceId>
             <UserDeviceId>3iJ1AY$oHcu7mC69</UserDeviceId>
             <BizType>FACE_TEST</BizType>
             <BeginDay>20190101</BeginDay>
    <ExpiredDay>20200101</ExpiredDay>
    </Devices>
    </Data>
    <Success>true</Success>
    <Code>1</Code>
</DescribeDeviceInfoResponse>
    • JSON格式 
      {
  "Data": {
    "PageSize":20
    "CurrentPage":1
    "TotalCount":1
    "Devices":{
    "DeviceId":wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
             "UserDeviceId":3iJ1AY$oHcu7mC69
             "BizType":FACE_TEST
             "BeginDay":20190101
    "ExpiredDay":20200101
    }
  },
"Success": true
}