调用ModifyDeviceInfo更新设备相关信息,比如设备授权有效期延长、更新业务方自定义的业务标识和设备ID等。适用于设备有效期续期等场景。

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

调试

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

请求参数

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

要执行的操作。取值:ModifyDeviceInfo

DeviceId String wd.6ziUffspAeW5FVYbaqmexR-1qwNjM

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

UserDeviceId String 3iJ1AY$oHcu7mC69

更新的用户设备ID。不超过64字符,由接入方自定义,可用于标识具体设备,建议可以使用设备物理编号。

BizType String FACE_TEST

更新的业务类型。不超过64字符。由接入方自定义,可用于对具体业务进行备注,例如可以取接入方不同的人脸使用场景,或者待交付的客户标识等。

Duration String 1

延长设备到期的时间。单位:年,范围为[1,100],取值100表示永久使用。一年按365天计算。

ExpiredDay String 20190401

当前设备的失效时间。失效日期不正确(和实人认证服务端记录的失效时间相差超过一周),则报错。

说明 该失效时间可以通过DescribeDeviceInfo接口查询获得,失效日期不正确则报错,这个校验是为了确保业务方不因为一些误操作导致重复激活一台设备,误消耗授权。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

本次请求的ID。

DeviceId String wd.6ziUffspAeW5FVYbaqmexR-1qwNjM

对应于请求参数中的DeviceId。

UserDeviceId String 3iJ1AY$oHcu7mC69

对应于请求参数中的UserDeviceId。

BizType String FACE_TEST

对应于请求参数中的BizType。

BeginDay String 20190401

若请求参数中Duration不为空,则该字段表示延长设备有效期后,授权开始时间。Duration的1年按365天计算。示例:20180101。

ExpiredDay String 20200330

若请求参数中Duration不为空,则该字段表示延长设备有效期后,授权到期时间。Duration的1年按365天计算。示例:20180101。

示例

请求示例

https://cloudauth.aliyuncs.com/?Action=ModifyDeviceInfo
&DeviceId=wd.6ziUffspAeW5FVYbaqmexR-1qwNjM
&UserDeviceId=3iJ1AY$oHcu7mC69
&BizType=FACE_TEST
&Duration=1
&ExpiredDay=20190401
&<公共请求参数>

正常返回示例

XML 格式

<ModifyDeviceInfoResponse>
      <Data>
            <DeviceId>wd.6ziUffspAeW5FVYbaqmexR-1qwNjM</DeviceId>
            <UserDeviceId>3iJ1AY$oHcu7mC69</UserDeviceId>
            <BizType>FACE_TEST</BizType>
            <BeginDay>20190401</BeginDay>
            <ExpiredDay>20200330</ExpiredDay>
      </Data>
      <Success>true</Success>
      <Code>1</Code>
</ModifyDeviceInfoResponse>

JSON 格式

{
  "Data": {
    "DeviceId":"wd.6ziUffspAeW5FVYbaqmexR-1qwNjM",
    "UserDeviceId":"3iJ1AY$oHcu7mC69",
    "BizType":"FACE_TEST",
    "BeginDay":"20190401",
    "ExpiredDay":"20200330"
  },
  "Success": true
}

错误码

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