Apply an Image File Update to Phones

Applies an image file update to the phones that use the image file, and triggers the phones to fetch the new configuration.

Request URL

POST {base_url}/uc-cautop/api/v1/image-files/{imageId}/update-to-device

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
imageId Yes String The image file ID. You can obtain the ID using the Search Image Files interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Apply_Result> The result of the update.
Apply_Result
Parameter Type Description
triggeredCount Integer The number of phones triggered to update.

Example

Request example

POST /uc-cautop/api/v1/image-files/1/update-to-device HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc3MDY4NiwiaWF0IjoxNzkwNzQ5MDg2LCJqdGkiOiIyNjQ5ZTk2Yi1kZjBkLTQ3ZjItOTJlNS01ODEyYTg4NmJjOWQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.0wcK9nXqw2qECw8dH5sEp68buMqqDyWsqKIZ6uaXBPF1OAcywjSbIw4jCtll7s9cfsXh8iO0n1dVb90yh5eepg2g7YxI-BibZLFG68qGdCLT2wjaSS1AjvXfL10fkdLfTopn_9Ie9XrW_5C6k1p02hea_q5tEqTWM23ICVKnhXo3J6pSYUHWnKfwJCk3UqEQBu1bc5lTLCH-Sa096FrwtNuNfynyHK5WHcmopYio5fNGggplSQKrAXjrw4azV6VF4E6EPoMszj_cS68zACNDNdZW4kj6gF0Ui5A60UZ_7N3n9sczLv4Ico4sKxC9SnRv1cXlmbO_18piJejxI_3T8g
Content-Type: application/json
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "36ac8588625799ed4979a3f069a1b6c9",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "triggeredCount": 0
  }
}
Note:

triggeredCount indicates the number of phones that are triggered to update. The value 0 means that no phone is using the image file.