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

Setting Static Website Configuration

Description

This API is used to configure a static website for a bucket.

Method prototype

public Guzzle\Service\Resource\Model PutBucketWebsite(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->putBucketWebsite(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
       'IndexDocument' => array(
           'Suffix' => 'index.html',
       ),
       'RedirectAllRequestsTo' => array(
           'Protocol' => 'https',
       ),
       'ErrorDocument' => array(
           'Key' => 'Error.html',
       ),
       'RoutingRules' => array(
           array(
               'Condition' => array(
                   'HttpErrorCodeReturnedEquals' => '405',
               ),
               'Redirect' => array(
                   'Protocol' => 'https',
                   'ReplaceKeyWith' => '404.html',
               ),
           ),  
           // ... repeated
       ),  
   )); 
   // Request succeeded
   print_r($result);
} catch (\Exception $e) {
   // Request failed
   echo "$e\n";
}

Parameter description

Querying Static Website Configuration

Description

This API is used to query the static website configuration associated with a bucket.

Method prototype

public Guzzle\Service\Resource\Model GetBucketWebsite(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->getBucketWebsite(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\n";
}

Parameter description

Sample response

GuzzleHttp\Command\Result Object
(
  [RedirectAllRequestsTo] => Array
      (
          [Protocol] => https
      )
   [IndexDocument] => Array
      (
          [Suffix] => index.html
      )
   [ErrorDocument] => Array
      (
          [Key] => Error.html
      )
   [RoutingRules] => Array
      (
          [0] => Array
              (
                  [Condition] => Array
                      (
                          [HttpErrorCodeReturnedEquals] => 405
                      )
                   [Redirect] => Array
                      (
                          [Protocol] => https
                          [ReplaceKeyWith] => 404.html
                      )
               )
       )
  [RequestId] => NWRmMzQ3YjlfMTlhYTk0MGFfNzMzYl84YWIy****
)

Response description

Deleting Static Website Configuration

Description

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

Method prototype

public Guzzle\Service\Resource\Model DeleteBucketWebsite(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->deleteBucketWebsite(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\n";
}

Parameter description