This document provides an overview of APIs and SDK code samples related to lifecycles.

Setting a Lifecycle Configuration

Description

This API (PUT Bucket lifecycle) is used to set the lifecycle configuration for a bucket.

Method prototype

public Guzzle\Service\Resource\Model putBucketLifecycle(array $args = array());

Sample request

Sample 1: Delete all objects with a lifecycle of 1 day

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.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->putBucketLifecycle(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
      'Rules' => array(
          array(
              'Expiration' => array(
                  'Days' => 1,
              ),
              'ID' => 'rule01',
              'Filter' => array(
                  'Prefix' => ''
              ),
              'Status' => 'Enabled',
          ),
      )
  ));
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo "$e\n";
}

Sample 2: Transition a prefixed object with a lifecycle of 1 day to ARCHIVE

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.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->putBucketLifecycle(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
      'Rules' => array(
          array(
              'ID' => 'rule01',
              'Filter' => array(
                  'Prefix' => 'prefix01/'
              ),  
              'Status' => 'Enabled',
              'Transitions' => array(
                  array(
                      'Days' => 1,
                      'StorageClass' => 'Archive'
                  ),
              ),  
          ),
      )
  ));  
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo "$e\n";
}

Parameter description

Querying a Lifecycle Configuration

Description

This API (GET Bucket lifecycle) is used to query the lifecycle configuration of a bucket.

Method prototype

public Guzzle\Service\Resource\Model getBucketLifecycle(array $args = array());

Sample request

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.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->getBucketLifecycle(array(
      'Bucket' => 'examplebucket-1250000000' // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
  )); 
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Parameter description

Sample response

Guzzle\Service\Resource\Model Object
(
  [data:protected] => Array
      (
          [Rules] => Array
              (
                  [0] => Array
                      (
                          [ID] => id1
                          [Filter] => Array
                              (
                                  [Prefix] => documents/
                              )
                          [Status] => Enabled
                          [Transition] => Array
                              (
                                  [Days] => 200
                                  [StorageClass] => Standard_IA
                              )
                          [Expiration] => Array
                              (
                                  [Days] => 1000
                              )
                      )
              )
          [RequestId] => NWE3YzhlZjNfY2FhMzNiMGFfNDVkNF8yZDIxODE=
      )
)

Response description

Deleting a Lifecycle Configuration

Description

This API is used to delete the lifecycle configuration of a bucket.

Method prototype

public Guzzle\Service\Resource\Model deleteBucketLifecycle(array $args = array());

Sample request

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.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->deleteBucketLifecycle(array(
      'Bucket' => 'examplebucket-1250000000' // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
  )); 
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Parameter description