This document provides an overview of APIs and SDK code samples related to logging.
API |
Operation |
Description |
PUT Bucket logging |
Setting logging |
Enables logging for a source bucket |
GET Bucket logging |
Querying logging configuration |
Queries the logging configuration of a source bucket |
Setting Logging Configuration
Description
This API is used to enable logging for a source bucket and store the access logs in a specified destination bucket.
Method prototype
public Guzzle\Service\Resource\Model PutBucketLogging(array $args = array());
Sample request
<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID";
$secretKey = "SECRETKEY";
$region = "ap-beijing";
$cosClient = new Qcloud\Cos\Client(
array(
'region' => $region,
'schema' => 'https',
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));
try {
$result = $cosClient->putBucketLogging(array(
'Bucket' => 'examplebucket-1250000000',
'LoggingEnabled' => array(
'TargetBucket' => 'examplebucket2-1250000000',
'TargetPrefix' => '',
));
print_r($result);
} catch (\Exception $e) {
echo($e);
}
Parameter description
Parameter |
Description |
Type |
Bucket |
Source bucket for which logging is to be enabled, in the format of BucketName-APPID . For more information, please see Bucket Naming Conventions. |
String |
TargetBucket |
Destination bucket to store logs, in the format of BucketName-APPID . For more information, please see Bucket Naming Conventions. |
String |
TargetPrefix |
Path to the directory that stores logs in the destination bucket |
String |
Querying Logging Configuration
Description
This API is used to query the logging configuration of a specified bucket.
Method prototype
public Guzzle\Service\Resource\Model GetBucketLogging(array $args = array());
Sample request
<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID";
$secretKey = "SECRETKEY";
$region = "ap-beijing";
$cosClient = new Qcloud\Cos\Client(
array(
'region' => $region,
'schema' => 'https',
'credentials'=> array(
'secretId' => $secretId ,
'secretKey' => $secretKey)));
try {
$result = $cosClient->getBucketLogging(array(
'Bucket' => 'examplebucket-1250000000',
));
print_r($result);
} catch (\Exception $e) {
echo($e);
}
Parameter description
Parameter |
Description |
Type |
Bucket |
Source bucket in the format of BucketName-APPID . For more information, please see Bucket Naming Conventions. |
String |
Sample response
GuzzleHttp\Command\Result Object
(
[LoggingEnabled] => Array
(
[TargetBucket] => examplebucket2-1250000000
[TargetPrefix] =>
)
[RequestId] => NWRmMWJjOThfMjZiMjU4NjRfODY4X2ExMjcy****
)
Response description
Member Variable |
Description |
Type |
TargetBucket |
Destination bucket that stores logs |
String |
TargetPrefix |
Path to the directory that stores logs in the destination bucket |
String |
Was this page helpful?