Overview

The SDK for Python provides APIs to get signatures, pre-signed request URLs, and pre-signed object download URLs. The methods to get a pre-signed URL using a permanent key and a temporary key are the same. To use a temporary key, you need to add x-cos-security-token to the header or query_string.

Getting a Signature

Feature Description

This API is used to get the signature of the specified operation, which is often used for signature distribution to mobile devices.

Method Prototype

get_auth(Method, Bucket, Key, Expired=300, Headers={}, Params={})

Sample Request for Upload

response = client.get_auth(
    Method='PUT',
    Bucket='examplebucket-1250000000',
    Key='exampleobject'
)

Sample Request for Download

response = client.get_auth(
    Method='GET',
    Bucket='examplebucket-1250000000',
    Key='exampleobject'
)

Request Example with All Parameters

response = client.get_auth(
    Method='PUT'|'POST'|'GET'|'DELETE'|'HEAD',
    Bucket='examplebucket-1250000000',
    Key='exampleobject',
    Expired=300,
    Headers={
        'Content-Length': 'string',
        'Content-MD5': 'string'
    },
    Params={
        'param1': 'string',
        'param2': 'string'
    }
)

Parameter Descriptions

Return Result Descriptions

The return value of this method is the signature value of the corresponding operation.

Getting a Pre-signed URL

Feature Description

This API is used to get a pre-signed link for distribution.

Sample Request for Upload

response = client.get_presigned_url(
    Method='PUT',
    Bucket='examplebucket-1250000000',
    Key='exampleobject'
)

Sample Request for Download

response = client.get_presigned_url(
    Method='GET',
    Bucket='examplebucket-1250000000',
    Key='exampleobject'
)

Method Prototype

get_presigned_url(Bucket, Key, Method, Expired=300, Params={}, Headers={})

Sample Request

response = client.get_presigned_url(
    Bucket='examplebucket-1250000000',
    Key='exampleobject',
    Method='PUT'|'POST'|'GET'|'DELETE'|'HEAD',
    Expired=300,
    Headers={
        'Content-Length': 'string',
        'Content-MD5': 'string'
    },
    Params={
        'param1': 'string',
        'param2': 'string'
    }
)

Parameter Descriptions

Return Result Descriptions

The return value of this method is a pre-signed URL.

Getting a Pre-signed Download URL

Feature Description

This API is used to get a pre-signed download link for direct download.

Method Prototype

get_presigned_download_url(Bucket, Key, Expired=300, Params={}, Headers={})

Sample Request

response = client.get_presigned_download_url(
    Bucket='examplebucket-1250000000',
    Key='exampleobject'
)

Parameter Descriptions

Return Result Descriptions

The return value of this method is a pre-signed download URL.