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

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

调试

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

请求参数

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

要执行的操作。取值:DescribeDeviceInfo

PageSize Integer 20

查询每页数目。

CurrentPage Integer 1

当前查询页数。

DeviceId String wd.6ziUffspAeW5FVYbaqmexR-1qwNjM

实人认证服务端为接入方设备生成的唯一ID,只有在设备成功激活后才会生成,该ID可通过离线人脸识别SDK里的getLicenseExtraInfo函数获得。

BizType String FACE_TEST

业务类型。不超过64字符。

UserDeviceId String 3iJ1AY$oHcu7mC69

不超过64字符,由接入方自定义,可用于标识具体设备。

ExpiredStartDay String 20190401

查询的开始时间,即查询在ExpiredStartDay和ExpiredEndDay之间要过期的授权。

ExpiredEndDay String 20200330

查询的结束时间。即查询在ExpiredStartDay和ExpiredEndDay之间要过期的授权。

返回数据

名称 类型 示例值 描述
RequestId String 969434DF-926B-4997-9881-4DE94E39F805

本次请求的ID。

PageSize Integer 20

每页数目。

CurrentPage Integer 1

当前查询页数。

TotalCount Integer 1

总数。

DeviceInfoList Array

设备信息数组。

DeviceId String wd.6ziUffspAeW5FVYbaqmexR-1qwNjM

对应于请求中的DeviceId。

UserDeviceId String 3iJ1AY$oHcu7mC69

对应于请求中的UserDeviceId。

BizType String FACE_TEST

对应于请求中的BizType。

BeginDay String 20180101

授权开始时间。

ExpiredDay String 20180101

授权到期时间。

示例

请求示例

https://cloudauth.aliyuncs.com/?Action= DescribeDeviceInfo
&DeviceId=wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
&BizType=FACE_TEST
&UserDeviceId=3iJ1AY$oHcu7mC69
&ExpiredStartDay=20190401
&ExpiredEndDay=20200330
&PageSize=20
&CurrentPage=1
&<公共请求参数>

正常返回示例

XML 格式

<DescribeDeviceInfoResponse>
         <PageSize>20</PageSize>
         <CurrentPage>1</CurrentPage>
         <TotalCount>1</TotalCount>
         <DeviceInfoList>
                   <DeviceInfo>
                           <DeviceId>wd.6ziUffspAeW5FVYbaqmexR-1qwNjM</DeviceId>
                           <UserDeviceId>3iJ1AY$oHcu7mC69</UserDeviceId>
                           <BizType>FACE_TEST</BizType>
                           <BeginDay>20190101</BeginDay>
                           <ExpiredDay>20200101</ExpiredDay>
                    </DeviceInfo>
              </DeviceInfoList>
        <RequestId>969434DF-926B-4997-9881-4DE94E39F805</RequestId>
</DescribeDeviceInfoResponse>

JSON 格式

{
    "TotalCount": 0,
    "PageSize": 20,
    "RequestId": "969434DF-926B-4997-9881-4DE94E39F805",
    "DeviceInfoList": {
        "DeviceInfo": [
            "DeviceId" : "wd.6ziUffspAeW5FVYbaqmexR-1qwNjM",
            "UserDeviceId": "3iJ1AY$oHcu7mC69",
            "BizType": "FACE_TEST",
            "BeginDay": "20190101",
            "ExpiredDay": "20200101"
        ]
    },
    "CurrentPage": 1
}

错误码

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