tencent cloud

Feedback

Image Style

Last updated: 2024-02-04 14:25:57

    Overview

    This document provides an overview of APIs and SDK code samples related to image styles.
    API
    Description
    Adds a style to a bucket
    Queries styles set for a bucket
    Deletes a style from a bucket

    Adding a Style

    Description

    This API is used to add a style to a bucket. This style will be added to images newly uploaded to this bucket.

    Sample code

    <?php
    
    require dirname(__FILE__) . '/../vendor/autoload.php';
    
    $secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
    $secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
    $region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket
    $cosClient = new Qcloud\\Cos\\Client(
    array(
    'region' => $region,
    'schema' => 'https', // Protocol header, which is http by default
    'credentials'=> array(
    'secretId' => $secretId ,
    'secretKey' => $secretKey)));
    
    try {
    $result = $cosClient->PutBucketImageStyle(array(
    'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
    'StyleName' => 'style_name',// Style name
    'StyleBody' => 'imageMogr2/thumbnail/!50px', // Style configurations
    ));
    // Request succeeded
    print_r($result);
    } catch (\\Exception $e) {
    // Request failed
    echo($e);
    }

    Parameter description

    Parameter
    Type
    Description
    Required
    Bucket
    String
    Bucket name in the format of BucketName-APPID
    Yes
    StyleName
    String
    Style name
    Yes
    StyleBody
    String
    Style configurations
    Yes

    Sample response

    Guzzle\\Service\\Resource\\Model Object
    (
    [structure:protected] =>
    [data:protected] => Array
    (
    [RequestId] => NWQwOGRkNDdfMjJiMjU4NjRfNzVjXzEwNmVjY2M=
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.pic.ap-beijing.myqcloud.com/
    )
    )
    

    Response description

    Parameter
    Type
    Description
    Parent Node
    RequestId
    String
    Request ID
    None
    Bucket
    String
    Bucket name in the format of BucketName-APPID
    None
    Location
    String
    Address of the requested resource
    None

    Querying Styles

    Description

    This API is used to query the styles set for a bucket.

    Sample code

    <?php
    
    require dirname(__FILE__) . '/../vendor/autoload.php';
    
    $secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
    $secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
    $region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket
    $cosClient = new Qcloud\\Cos\\Client(
    array(
    'region' => $region,
    'schema' => 'https', // Protocol header, which is http by default
    'credentials'=> array(
    'secretId' => $secretId ,
    'secretKey' => $secretKey)));
    
    try {
    $result = $cosClient->GetBucketImageStyle(array(
    'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
    'StyleName' => 'style_name', // Style name
    ));
    // Request succeeded
    print_r($result);
    } catch (\\Exception $e) {
    // Request failed
    echo($e);
    }

    Parameter description

    Parameter
    Type
    Description
    Required
    Bucket
    String
    Bucket name in the format of BucketName-APPID
    Yes
    StyleName
    String
    Style name
    No

    Sample response

    Guzzle\\Service\\Resource\\Model Object
    (
    [structure:protected] =>
    [data:protected] => Array
    (
    [RequestId] => NWQwOGRkNDdfMjJiMjU4NjRfNzVjXzEwNmVjY2M=
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.pic.ap-beijing.myqcloud.com/
    [StyleRule] => Array(
    [0] => Array(
    [StyleName] => style_name
    [StyleBody] => imageMogr2/thumbnail/!50px
    )
    )
    )
    )
    

    Response description

    Parameter
    Type
    Description
    Parent Node
    RequestId
    String
    Request ID
    None
    Bucket
    String
    Bucket name in the format of BucketName-APPID
    None
    Location
    String
    Address of the requested resource
    None
    StyleRule
    Array
    A list of styles
    None

    Deleting a Style

    Description

    This API is used to delete a style from a bucket.

    Sample code

    <?php
    
    require dirname(__FILE__) . '/../vendor/autoload.php';
    
    $secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
    $secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.tencentcloud.com/cam/capi
    $region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket
    $cosClient = new Qcloud\\Cos\\Client(
    array(
    'region' => $region,
    'schema' => 'https', // Protocol header, which is http by default
    'credentials'=> array(
    'secretId' => $secretId ,
    'secretKey' => $secretKey)));
    
    try {
    $result = $cosClient->DeleteBucketImageStyle(array(
    'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
    'StyleName' => 'style_name', // Style name
    ));
    // Request succeeded
    print_r($result);
    } catch (\\Exception $e) {
    // Request failed
    echo($e);
    }

    Parameter description

    Parameter
    Type
    Description
    Required
    Bucket
    String
    Bucket name in the format of BucketName-APPID
    Yes
    StyleName
    String
    Style name
    Yes

    Sample response

    Guzzle\\Service\\Resource\\Model Object
    (
    [structure:protected] =>
    [data:protected] => Array
    (
    [RequestId] => NWQwOGRkNDdfMjJiMjU4NjRfNzVjXzEwNmVjY2M=
    [Bucket] => examplebucket-1250000000
    [Location] => examplebucket-1250000000.pic.ap-beijing.myqcloud.com/
    )
    )
    

    Response description

    Parameter
    Type
    Description
    Parent Node
    RequestId
    String
    Request ID
    None
    Bucket
    String
    Bucket name in the format of BucketName-APPID
    None
    Location
    String
    Address of the requested resource
    None
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support