Set Robot Lease Period
Overview
- This API is used to modify the lease of a robot.
- When the set lease is in the past, the robot will be locked after restarting.
- When the set lease is in the future, a locked robot will be unlocked after restarting.
Authorization Method
| Data Dimension Authorization | Enterprise-level Authorization | This API requires enterprise-level authorization. Both enterprise-level and agent-level authorization accounts can call this API. Please refer to Authorization Methods. |
|---|
| Interface Dimension Authorization | Special Authorization | This API requires special authorization. You need to apply for interface dimension authorization separately for your authorization account in order to call it. Please refer to Authorization Methods. |
|---|
Request
Request Entry Point
| Region | Entry Point |
|---|---|
| China Region | https://openapi.orionstar.com |
| Europe Region | https://global-openapi.orionstar.com |
| USA Region | https://us-openapi.orionstar.com |
| Japan Region | https://jp-openapi.orionstar.com |
Request Protocol
| HTTP URL Path | /v1/robot/set_robot_expires_time |
|---|---|
| HTTP Method | POST |
| Content-Type | application/x-www-form-urlencoded |
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| robot_sn | string | Yes | Robot SN |
| robot_expires_time | int | Yes | The end time of the lease. Format is: YYYY-MM-DD +(-)HH:II, +(-)HH:II is the time zone, for example: 2024-04-02 +08:00.
|
Request cURL Example
# Please replace the entry point with yours according to your region curl --location 'https://global-openapi.orionstar.com/v1/robot/set_robot_expires_time' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'robot_sn=test_sn' \ --data-urlencode 'robot_expires_time=2024-04-02 +08:00'
Response
Common Response Body
| Parameter | Type | Description |
|---|---|---|
| code | int | Error code. 0 means success, non-zero means failure, Please refer to Error Codes. |
| msg | string | Error description. When there is a failure, a specific error description will be provided. |
| req_id | string | Log tracking ID. When encountering problems that require assistance from OrionStar, please provide this tracking ID value. |
| data | object | Business data object, see below for details Response Body Data Object. |
Response Body Data Object
- None
Response Body Example
{ "code": 0, "msg": "", "data" : { } }