Creates a pre-signed URL for an object stored in Object Storage Service (OSS).

Limits

A single Alibaba Cloud account can run a maximum of 5 queries per second (QPS).

Note RAM users share the quota of the Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateEdgeOssPreSignedAddress

The operation that you want to perform. Set the value to CreateEdgeOssPreSignedAddress.

FileName String Yes testfile.zip

The name of the object whose URL is to be obtained. The format is <File name>. <File name extension>.

ResourceId String Yes df9b9f441*********4c90d0c21d14

The ID of the resource for which the object URL is to be obtained. Currently, only driver resources are supported. Therefore, set this parameter to the ID of the corresponding driver.

ResourceVersion String Yes 2.0.0

The version number of the resource. Currently, only driver resources are supported. Therefore, set this parameter to the version number of the corresponding driver.

Type String Yes DRIVER_VERSION_CONTENT

The content type of the object. Valid values:

  • DRIVER_VERSION_CONTENT: the code of a specific driver version.
  • DRIVER_VERSION_DEFAULT_CONFIG: the default configuration of a specific driver version.
  • INSTANCE_DRIVER_VERSION_CONFIG: the configuration of a specific driver version used in an edge instance.
IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the Internet of Things (IoT) service instance. This parameter is not required for public instances. However, this parameter is required for the instances that you have purchased.

InstanceId String No F3APY0tPLhmgGtx0****

The ID of the edge instance that uses the driver.

Note When the Type parameter is set to INSTANCE_DRIVER_VERSION_CONFIG, this parameter is required.

In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String Success

The error code. Success indicates that the call was successful. Other values indicate that specific errors occurred. For more information, see Error codes.

Data Struct N/A

The data returned if the call was successful.

OssPreSignedAddress String http://xxxx.oss-cn-shanghai.aliyuncs.com/driver/a534d3b81*******8fe7da0/DRIVER_VERSION_CONTENT/df9b9f441*********4c90d0c21d14/2.0.0/1581586102750/driver_code.zip?Expires\u003d1581586402\u0026OSSAccessKeyId\u003daS4MT0IYrP******\u0026Signature\u003dIUUjZ881H3rUoCOwjMXPmGb******

The pre-signed URL of the OSS object. For more information, see Authorized access.

OssAddress String http://xxxx.oss-cn-shanghai.aliyuncs.com/driver/a534d3b81*******8fe7da0/DRIVER_VERSION_CONTENT/df9b9f441*********4c90d0c21d14/2.0.0/1581586102750/driver_code.zip

The URL of the OSS object.

ErrorMessage String request parameter error

The error message returned if the call failed.

RequestId String 91E2BFA2-ECD7-4E11-B36B-66BCC4773922

The ID of the request.

Success Boolean true

Indicates whether the call was successful. true indicates that the call was successful. false indicates that the call failed.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=CreateEdgeOssPreSignedAddress
&Type=DRIVER_VERSION_CONTENT
&ResourceId=df9b9f441*********4c90d0c21d14
&FileName=driver_code.zip
&ResourceVersion=2.0.0
&<Common request parameters>

Sample success responses

XML format

<CreateEdgeOssPreSignedAddressResponse>
    <RequestId>91E2BFA2-ECD7-4E11-B36B-66BCC4773922</RequestId>
    <Data>
        <OssPreSignedAddress>http://xxxx.oss-cn-shanghai.aliyuncs.com/driver/a534d3b81*******8fe7da0/DRIVER_VERSION_CONTENT/df9b9f441*********4c90d0c21d14/2.0.0/1581586102750/driver_code.zip?Expires=1581586402&amp;OSSAccessKeyId=aS4MT0IYrPSPj6Gy&amp;Signature=IUUjZ881H3rUoCOwjMXPmGbwYjc%3D</OssPreSignedAddress>
        <OssAddress>http://xxxx.oss-cn-shanghai.aliyuncs.com/driver/a534d3b81*******8fe7da0/DRIVER_VERSION_CONTENT/df9b9f441*********4c90d0c21d14/2.0.0/1581586102750/driver_code.zip</OssAddress>
    </Data>
    <Code>Success</Code>
    <Success>true</Success>
</CreateEdgeOssPreSignedAddressResponse>

JSON format

{
  "RequestId": "91E2BFA2-ECD7-4E11-B36B-66BCC4773922",
  "Data": {
    "OssPreSignedAddress": "http://xxxx.oss-cn-shanghai.aliyuncs.com/driver/a534d3b81*******8fe7da0/DRIVER_VERSION_CONTENT/df9b9f441*********4c90d0c21d14/2.0.0/1581586102750/driver_code.zip?Expires\u003d1581586402\u0026OSSAccessKeyId\u003daS4MT0IYrPSPj6Gy\u0026Signature\u003dIUUjZ881H3rUoCOwjMXPmGbwYjc%3D",
    "OssAddress": "http://xxxx.oss-cn-shanghai.aliyuncs.com/driver/a534d3b81*******8fe7da0/DRIVER_VERSION_CONTENT/df9b9f441*********4c90d0c21d14/2.0.0/1581586102750/driver_code.zip"
  },
  "Code": "Success",
  "Success": true
}

Error codes

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