GenerateOTAUploadURL

Description

This operation can be used with other operations to create an update package. Procedure:

1. Call this API operation to generate the details of an update package file to be uploaded to OSS.

The response parameters of this API operation include:

• The following request parameters of the OSS PostObject operation that is used to upload the update package file: Key, OSSAccessKeyId, Signature, and Policy.
• The following request parameter of the CreateOTAFirmware that is used to create the update package:FirmwareUrl.

2. Use an OSS SDK to call the PostObject operation to upload the update package file. For more information about sample code, see the "Usage of response parameters" section.

3. After the update package file is uploaded, call the CreateOTAFirmware operation to create an update package.

If update package files are uploaded but you do not call the CreateOTAFirmware operation to create update packages for the files, these uploaded files are automatically deleted by the system on a regular basis.

Limits

Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).

Request parameters

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API operation. For more information, see Common request parameters.

Response parameters

Usage of response parameters

When you call the OSS PostObject operation to upload the update package file to OSS, specify the required response values that are returned from the GenerateOTAUploadURL operation.

The following sample code that is written in Java shows how to upload the update package file to OSS.

• Add the following dependencies to the pom.xml file:

  <dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.3</version>
  </dependency>
  
  <dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpmime</artifactId>
    <version>4.5.10</version>
  </dependency>
                      

• Sample code:

  public static boolean postObject(String key,
                                    String host,
                                    String policy,
                                    String ossAccessKeyId,
                                    String signature,
                                    String data) throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpPost uploadFile = new HttpPost(host);
  
    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    builder.addTextBody("key", key, ContentType.TEXT_PLAIN);
    builder.addTextBody("policy", policy, ContentType.TEXT_PLAIN);
    builder.addTextBody("OSSAccessKeyId", ossAccessKeyId, ContentType.TEXT_PLAIN);
    builder.addTextBody("signature", signature, ContentType.TEXT_PLAIN);
    builder.addTextBody("success_action_status", "200", ContentType.TEXT_PLAIN);
    builder.addBinaryBody("file", data.getBytes());
  
    HttpEntity multipart = builder.build();
    uploadFile.setEntity(multipart);
    CloseableHttpResponse response = httpClient.execute(uploadFile);
  
    if (response.getStatusLine().getStatusCode() == 200) {
      return true;
    }
  
    return false;
  }
                      

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=GenerateOTAUploadURL
&<Common request parameters>

Sample success responses

XML format

<GenerateOTAUploadURLResponse>
    <Data>
        <Key>ota/65dfcda0473be29836dfde585472****/ck2nfzljo00023g7kysg0****.bin</Key>
        <Host>https://iotx-ota.oss-cn-shanghai.aliyuncs.com</Host>
        <Policy>eyJleHBpcmF****</Policy>
        <OSSAccessKeyId>cS8uRRy54Rsz****</OSSAccessKeyId>
        <ObjectStorage>OSS</ObjectStorage>
        <UtcCreate>2019-11-04T06:21:54.607Z</UtcCreate>
        <Signature>PKmRTy40QxqIUUWy325SCT/****</Signature>
        <FirmwareUrl>https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/65dfcda0473be29836dfde585472****/ck2nfzljo00023g7kysg0****.bin</FirmwareUrl>
    </Data>
    <RequestId>B6E77674-09C4-4647-BF85-59CB72A72E4B</RequestId>
    <Success>true</Success>
</GenerateOTAUploadURLResponse>

JSON format

{
    "Data": {
        "Key": "ota/65dfcda0473be29836dfde585472****/ck2nfzljo00023g7kysg0****.bin",
        "Host": "https://iotx-ota.oss-cn-shanghai.aliyuncs.com",
        "Policy": "eyJleHBpcmF****",
        "OSSAccessKeyId": "cS8uRRy54Rsz****",
        "ObjectStorage": "OSS",
        "UtcCreate": "2019-11-04T06:21:54.607Z",
        "Signature": "PKmRTy40QxqIUUWy325SCT/****",
        "FirmwareUrl": "https://iotx-ota.oss-cn-shanghai.aliyuncs.com/ota/65dfcda0473be29836dfde585472****/ck2nfzljo00023g7kysg0****.bin"
    },
    "RequestId": "B6E77674-09C4-4647-BF85-59CB72A72E4B",
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.