Documentation | Tencent Cloud

Recent Pages

Bucket Management

Last updated: 2020-11-17 16:05:54

Overview

This document provides an overview of APIs and SDK code samples related to cross-origin access, lifecycle, versioning, and cross-region replication.

Cross-origin access

API	Operation	Description
PUT Bucket cors	Setting cross-origin access configuration	Sets cross-origin access permissions for a bucket
GET Bucket cors	Querying cross-origin access configuration	Queries the cross-origin access configuration of a bucket
DELETE Bucket cors	Deleting cross-origin access configuration	Deletes the cross-origin access configuration from a bucket

Lifecycle

API	Operation	Description
PUT Bucket lifecycle	Setting lifecycle configuration	Sets lifecycle management configuration for a bucket
GET Bucket lifecycle	Querying lifecycle configuration	Queries the lifecycle management configuration of a bucket
DELETE Bucket lifecycle	Deleting lifecycle configuration	Deletes the lifecycle management configuration from a bucket

Versioning

API	Operation	Description
PUT Bucket versioning	Setting versioning	Sets versioning configuration for a bucket
GET Bucket versioning	Querying versioning	Queries the versioning information of a bucket

Cross-region replication

API	Operation	Description
PUT Bucket replication	Setting a cross-region replication rule	Sets a cross-region replication rule for a bucket
GET Bucket replication	Querying a cross-region replication rule	Queries the cross-region replication rule of a bucket
DELETE Bucket replication	Deleting a cross-region replication rule	Deletes the cross-region replication rule from a bucket

Access policy

API	Operation	Description
PUT Bucket policy	Setting a bucket policy	Sets an access policy for a bucket
GET Bucket policy	Querying a bucket policy	Queries the access policy of a bucket
DELETE Bucket policy	Deleting a bucket policy	Deletes the access policy from a bucket

Cross-Origin Access

Setting cross-origin access configuration

API description

This API is used to set the cross-origin access configuration for a bucket.

Method prototype

put_bucket_cors(Bucket, CORSConfiguration={}, **kwargs)

Sample request

response = client.put_bucket_cors(
    Bucket='examplebucket-1250000000',
    CORSConfiguration={
        'CORSRule': [
            {
                'ID': 'string',
                'MaxAgeSeconds': 100,
                'AllowedOrigin': [
                    'string',
                ],
                'AllowedMethod': [
                    'string',
                ],
                'AllowedHeader': [
                    'string',
                ],
                'ExposeHeader': [
                    'string',
                ]
            }
        ]
    },
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes
CORSRule	Specifies the cross-origin access rule, including ID, MaxAgeSeconds, AllowedOrigin, AllowedMethod, AllowedHeader, and ExposeHeader	List	Yes
ID	Sets rule ID	String	No
MaxAgeSeconds	Sets the validity period of the OPTIONS request result	Int	No
AllowedOrigin	Sets allowed access sources, e.g. `"http://cloud.tencent.com"`. The wildcard "*" is supported.	Dict	Yes
AllowedMethod	Sets allowed methods, including GET, PUT, HEAD, POST, DELETE	Dict	Yes
AllowedHeader	Sets custom HTTP request headers that can be included in a request. The wildcard "*" is supported.	Dict	No
ExposeHeader	Configures custom headers that can be received by the browser from the server.	Dict	No

Response description

This method returns None.

Querying cross-origin access configuration

API description

This API is used to query the cross-origin access configuration of a bucket.

Method prototype

get_bucket_cors(Bucket, **kwargs)

Sample request

response = client.get_bucket_cors(
    Bucket='examplebucket-1250000000',
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This API returns the cross-origin access configuration on a bucket in dict format.

{
    'CORSRule': [
        {
            'ID': 'string',
            'MaxAgeSeconds': 100,
            'AllowedOrigin': [
                'string',
            ],
            'AllowedMethod': [
                'string',
            ],
            'AllowedHeader': [
                'string',
            ],
            'ExposeHeader': [
                'string',
            ],
        }
    ]
}

Parameter Name	Description	Type
CORSRule	Specifies the cross-origin access rule, including ID, MaxAgeSeconds, AllowedOrigin, AllowedMethod, AllowedHeader, and ExposeHeader	List
ID	Rule ID	String
MaxAgeSeconds	Sets the validity period of the OPTIONS request result	String
AllowedOrigin	Allowed access sources, e.g. `"http://cloud.tencent.com"`. The wildcard "*" is supported.	Dict
AllowedMethod	Allowed methods, including GET, PUT, HEAD, POST, DELETE	Dict
AllowedHeader	Sets custom HTTP request headers that can be included in a request. The wildcard "*" is supported.	Dict
ExposeHeader	Configures custom headers that can be received by the browser from the server.	Dict

Deleting cross-origin access configuration

API description

This API is used to delete the cross-origin access configuration from a bucket.

Method prototype

delete_bucket_cors(Bucket, **kwargs)

Sample request

response = client.delete_bucket_cors(
    Bucket='examplebucket-1250000000',
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This method returns None.

Lifecycle

Setting lifecycle configuration

API description

This API is used to set the lifecycle configuration for a bucket.

Method prototype

put_bucket_lifecycle(Bucket, LifecycleConfiguration={}, **kwargs)

Sample request

response = client.put_bucket_lifecycle(
    Bucket='examplebucket-1250000000',
    LifecycleConfiguration={
        'Rule': [
            {
                'ID': 'string',
                'Filter': {
                    'Prefix': '',
                },
                'Status': 'Enabled',
                'Expiration': {
                    'Days': 200
                },
                'Transition': [
                    {
                        'Days': 100,
                        'StorageClass': 'Standard_IA'
                    },
                ],
                'AbortIncompleteMultipartUpload': {
                    'DaysAfterInitiation': 7
                }
            }
        ]   
    }
)

Sample request with all parameters

from qcloud_cos import get_date
response = client.put_bucket_lifecycle(
    Bucket='examplebucket-1250000000',
    LifecycleConfiguration={
        'Rule': [
            {
                'ID': 'string',
                'Filter': {
                    'Prefix': 'string',
                    'Tag': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        }
                    ]
                },
                'Status': 'Enabled'|'Disabled',
                'Expiration': {
                    'Days': 100,
                    'Date': get_date(2018, 4, 20)
                },
                'Transition': [
                    {
                        'Days': 100,
                        'Date': get_date(2018, 4, 20),
                        'StorageClass': 'Standard_IA'|'Archive'
                    },
                ],
                'NoncurrentVersionExpiration': {
                    'NoncurrentDays': 100
                },
                'NoncurrentVersionTransition': [
                    {
                        'NoncurrentDays': 100,
                        'StorageClass': 'Standard_IA'
                    },
                ],
                'AbortIncompleteMultipartUpload': {
                    'DaysAfterInitiation': 100
                }
            }
        ]   
    }
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes
Rule	Sets the rule, including ID, Filter, Status, Expiration, Transition, NoncurrentVersionExpiration, NoncurrentVersionTransition, AbortIncompleteMultipartUpload	List	Yes
ID	Sets rule ID.	String	No
Filter	Describes a set of objects that are subject to the rule. To set the rule for all objects in the bucket, leave `Prefix` empty.	Dict	Yes
Status	Sets whether the rule is enabled. Valid values: `Enabled`, `Disabled`	Dict	Yes
Expiration	Specifies when objects expire. It can be an expiry date or the number of days before objects expire. The date must be in GMT ISO 8601 format. You can specify the date using the `get_date` method.	Dict	No
Transition	Sets one or more rules for when an object transitions to a specified storage class. You can specify the number of days before the transition occurs or a transition date. The date must be in GMT ISO 8601 format. You can specify the date using the `get_date` method. The valid values for StorageClass include Standard_IA and Archive.	List	No
NoncurrentVersionExpiration	Sets when noncurrent object versions expire. You can specify the number of days before objects expire (NoncurrentDays).	Dict	No
NoncurrentVersionTransition	Sets one or more transition rules that describe when noncurrent objects transition to another storage class. You can specify the number of days (NoncurrentDays). The valid value for `StorageClass` is Standard_IA.	List	No
AbortIncompleteMultipartUpload	Indicates the number of days within which the upload must be completed after the multipart upload starts.	Dict	No

Response description

This method returns None.

Querying lifecycle configuration

API description

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

Sample request

response = client.get_bucket_lifecycle(
    Bucket='examplebucket-1250000000',
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This API returns the lifecycle configuration on a bucket in dict format.

{
    'Rule': [
        {
            'ID': 'string',
            'Filter': {
                'Prefix': 'string',
                'Tag': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        }
                ]
            },
            'Status': 'string',
            'Expiration': {
                'Days': 100,
                'Date': 'string'
            },
            'Transition': [
                {
                    'Days': 100,
                    'Date': 'string',
                    'StorageClass': 'STANDARD_IA'|'Archive'
                },
            ],
            'NoncurrentVersionExpiration': {
                'NoncurrentDays': 100
            },
            'NoncurrentVersionTransition': [
                {
                    'NoncurrentDays': 100,
                    'StorageClass': 'STANDARD_IA'
                },
            ],
            'AbortIncompleteMultipartUpload': {
                'DaysAfterInitiation': 100
            }
        }
    ]   
}

Parameter Name	Description	Type
Rule	Sets the rule, including ID, Filter, Status, Expiration, Transition, NoncurrentVersionExpiration, NoncurrentVersionTransition, AbortIncompleteMultipartUpload	List
ID	Rule ID	String
Filter	Describes a set of objects that are subject to the rule.	Dict
Status	Sets whether the rule is enabled. Valid values: `Enabled`, `Disabled`	Dict
Expiration	Specifies when objects expire. It can be an expiry date (`Date`) or the number of days before objects expire (`Days`)	Dict
Transition	Specifies when objects transition to another storage class. It can be an expiry date (`Date`) or the number of days before objects transition (`Days`). Valid values for StorageClass: STANDARD_IA，Archive	List
NoncurrentVersionExpiration	Sets the expiration rule for noncurrent object versions. You can specify the number of days before the object expires (NoncurrentDays).	Dict
NoncurrentVersionTransition	Specifies the rule for transitioning noncurrent objects to another storage class. You can specify the number of days (NoncurrentDays). Valid value for StorageClass: STANDARD_IA.	List
AbortIncompleteMultipartUpload	Specifies the number of days within which the upload must be completed after the multipart upload starts.	Dict

Deleting lifecycle configuration

API description

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

Method prototype

delete_bucket_lifecycle(Bucket, **kwargs)

Sample request

response = client.delete_bucket_lifecycle(
    Bucket='examplebucket-1250000000',
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This method returns None.

Versioning

Setting versioning

API description

This API is used to set the versioning configuration for a bucket.

Method prototype

put_bucket_versioning(Bucket, Status, **kwargs)

Sample request

Enabling versioning

response = client.put_bucket_versioning(
    Bucket='examplebucket-1250000000',
    Status='Enabled'
)

Suspending versioning

response = client.put_bucket_versioning(
    Bucket='examplebucket-1250000000',
    Status='Suspended'
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes
Status	Sets the versioning status of a bucket. Valid values: `Suspended`, `Enabled`	String	Yes

Response description

This method returns None.

Querying versioning

API description

This API is used to query the versioning configuration of a bucket.

Method prototype

get_bucket_versioning(Bucket, **kwargs)

Sample request

response = client.get_bucket_versioning(
    Bucket='examplebucket-1250000000',
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This API returns the versioning configuration on a bucket in dict format.

{
    'Status': 'Enabled'|'Suspended'
}

Parameter Name	Description	Type
Status	Sets the versioning status of a bucket. Valid values: `Suspended`, `Enabled`	String

Cross-Region Replication

Setting a cross-region replication rule

API description

This API is used to set the cross-region replication rule on a bucket.

Method prototype

put_bucket_replication(Bucket, ReplicationConfiguration={}, **kwargs)

Sample request

response = client.put_bucket_replication(
    Bucket='examplebucket-1250000000',
    ReplicationConfiguration={
        'Role': 'qcs::cam::uin/100000000001:uin/100000000001',
        'Rule': [
            {
                'ID': 'string',
                'Status': 'Enabled',
                'Destination': {
                    'Bucket': 'qcs::cos:ap-shanghai::destinationbucket-1250000000',
                    'StorageClass': 'STANDARD'
                }
            }
        ]   
    }
)

Sample request with all parameters

response = client.put_bucket_replication(
    Bucket='examplebucket-1250000000',
    ReplicationConfiguration={
        'Role': 'qcs::cam::uin/100000000001:uin/100000000001',
        'Rule': [
            {
                'ID': 'string',
                'Status': 'Enabled'|'Disabled',
                'Prefix': 'string',
                'Destination': {
                    'Bucket': 'qcs::cos:ap-beijing::destinationbucket-1250000000',
                    'StorageClass': 'STANDARD'|'STANDARD_IA'
                }
            },
            {
                'ID': 'string',
                'Status': 'Enabled'|'Disabled',
                'Prefix': 'string',
                'Destination': {
                    'Bucket': 'qcs::cos:ap-beijing::destinationbucket2-1250000000',
                    'StorageClass': 'STANDARD'|'STANDARD_IA'
                }
            },
        ]   
    }
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes
Role	Replication initiator identifier: `qcs::cam::uin/<OwnerUin>:uin/<SubUin>`	String	No
Rule	Sets the rule, including ID, Status, Prefix, and Destination	List	Yes
ID	Sets rule ID	String	No
Status	Sets whether the rule is enabled. Valid values: `Enabled`, `Disabled`	String	Yes
Prefix	Specifies the prefix used to filter objects. If it is left empty, the rule applies to all objects in the bucket	String	Yes
Destination	Describes the destination resource, including `Bucket` and `StorageClass`	Dict	Yes
Bucket	Sets the destination bucket for cross-region replication. Format: `qcs::cos:[region]::[BucketName-APPID]`	String	Yes
StorageClass	Sets the storage class of the object copies. Valid values: `STANDARD`, `STANDARD_IA`	String	No

Response description

This method returns None.

Querying a cross-region replication rule

API description

This API is used to query the cross-region replication rule of a bucket.

Method prototype

get_bucket_replication(Bucket, **kwargs)

Sample request

response = client.get_bucket_replication(
    Bucket='examplebucket-1250000000'
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This API returns the cross-region replication configuration on a bucket in dict format.

{
    'Role': 'qcs::cam::uin/100000000001:uin/100000000001',
    'Rule': [
        {
            'ID': 'string',
            'Status': 'Enabled'|'Disabled',
            'Prefix': 'string',
            'Destination': {
                'Bucket': 'qcs::cos:ap-beijing::destinationbucket-1250000000',
                'StorageClass': 'STANDARD'|'STANDARD_IA'
            }
        },
        {
            'ID': 'string',
            'Status': 'Enabled'|'Disabled',
            'Prefix': 'string',
            'Destination': {
                'Bucket': 'qcs::cos:ap-beijing::destinationbucket2-1250000000',
                'StorageClass': 'STANDARD'|'STANDARD_IA'
            }
        },
    ]  
}

Parameter Name	Description	Type
Role	Replication initiator identifier: `qcs::cam::uin/<OwnerUin>:uin/<SubUin>`	String
Rule	Sets the rule for cross-region replication, including ID, Status, Prefix, and Destination	List
ID	Specifies the ID of the cross-region replication rule	String
Status	Sets whether the rule is enabled. Valid values: `Enabled`, `Disabled`	String
Prefix	Specifies the prefix used to filter objects that are subject to the rule. If it is left empty, the rule applies to all objects in the bucket	String
Destination	Describes the destination resource, including `Bucket` and `StorageClass`	Dict
Bucket	Sets the destination bucket for cross-region replication. Format: `qcs::cos:[region]::[BucketName-APPID]`	String
StorageClass	Sets the storage class of the object copies. Valid values: `STANDARD`, `STANDARD_IA`	String

Deleting a cross-region replication rule

API description

This API is used to delete the cross-region replication rule from a bucket.

Method prototype

delete_bucket_replication(Bucket, **kwargs)

Sample request

response = client.delete_bucket_replication(
    Bucket='examplebucket-1250000000',
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This method returns None.

Access Policy

Setting an access policy

API description

This API is used to set an access policy on a bucket.

Method prototype

put_bucket_policy(Bucket, Policy, **kwargs)

Sample request

response = client.put_bucket_policy(
    Bucket='examplebucket-1250000000',
    Policy={
        "Statement": [
            {
                "Principal": {
                    "qcs": [
                    "qcs::cam::uin/100000000001:uin/100000000011"
                    ]
                },
                "Effect": "allow",
                "Action": [
                    "name/cos:GetBucket"
                ],
                "Resource": [
                    "qcs::cos:ap-guangzhou:uid/1250000000:examplebucket-1250000000/*"
                ]
                "condition": {
                    "ip_equal": {
                    "qcs:ip": "10.121.2.10/24"
                    }
                }
            }
        ],
        "version": "2.0"
    }
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes
Statement	Specifies one or more permissions	List	Yes
Principal	Specifies the entity to which the permission is granted. For more information, see Access Policy Language Overview	Dict	Yes
Version	Specifies the version of policy syntax. Default: 2.0	String	Yes
Effect	Allow or deny	String	Yes
Action	COS API. You can specify one, several, or all (``) COS APIs as needed, e.g. `name/cos:GetService`. Note that this value is case-sensitive*.	List	Yes
Resource	Specifies the resource for which permission is granted. It can be any resource, a resource in a path with a specified prefix, a resource in a specified absolute path, or a combination thereof.	List	Yes
Condition	(Optional) Specifies the rule condition. For more information, see condition	List	No

Response description

This method returns None.

Querying an access policy

API description

This API is used to query the access policy on a bucket.

Method prototype

get_bucket_policy(Bucket, **kwargs)

Sample request

response = client.get_bucket_policy(
    Bucket='examplebucket-1250000000',
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This API returns the access policy on a bucket in dict format.

{
    "Statement": [
        {
            "Principal": {
                "qcs": [
                "qcs::cam::uin/100000000001:uin/100000000011"
                ]
            },
            "Effect": "allow",
            "Action": [
                "name/cos:GetBucket"
            ],
            "Resource": [
                "qcs::cos:ap-guangzhou:uid/1250000000:examplebucket-1250000000/*"
            ]
            "condition": {
                "ip_equal": {
                "qcs:ip": "10.121.2.10/24"
                }
            }
        }
    ],
    "version": "2.0"
}

Parameter Name	Description	Type	Required
Statement	Specifies one or more permissions	List	Yes
Principal	Specifies the entity to which the permission is granted. For more information, see Access Policy Language Overview	Dict	Yes
Version	Specifies the version of policy syntax. Default: 2.0	String	Yes
Effect	Allow or deny	String	Yes
Action	COS API. You can specify one, several, or all (``) COS APIs as needed, e.g. `name/cos:GetService`. Note that this value is case-sensitive*.	List	Yes
Resource	Specifies the resource for which permission is granted. It can be any resource, a resource in a path with a specified prefix, a resource in a specified absolute path, or a combination thereof.	List	Yes
Condition	(Optional) Specifies the rule condition. For more information, see condition	List	No

Deleting an access policy

API description

This API is used to delete the access policy from a specified bucket.

Method prototype

delete_bucket_policy(Bucket, **kwargs)

Sample request

response = client.delete_bucket_policy(
    Bucket='examplebucket-1250000000',
)

Parameter description

Parameter Name	Description	Type	Required
Bucket	Bucket name in the format: BucketName-APPID	String	Yes

Response description

This method returns None.

Was this page helpful?

Confirm

Was this page helpful?

Not at all
Not very helpful
Somewhat helpful
Very helpful
Extremely helpful

Send Feedback

Hide

Submit a Ticket Contact sales

Help

Sign Up

Log in

Recent Pages

Bucket Management

Overview

Cross-Origin Access

Setting cross-origin access configuration

API description

Method prototype

Sample request

Parameter description

Response description

Querying cross-origin access configuration

API description

Method prototype

Sample request

Parameter description

Response description

Deleting cross-origin access configuration

API description

Method prototype

Sample request

Parameter description

Response description

Lifecycle

Setting lifecycle configuration

API description

Method prototype

Sample request

Sample request with all parameters

Parameter description

Response description

Querying lifecycle configuration

API description

Sample request

Parameter description

Response description

Deleting lifecycle configuration

API description

Method prototype

Sample request

Parameter description

Response description

Versioning

Setting versioning

API description

Method prototype

Sample request

Enabling versioning

Suspending versioning

Parameter description

Response description

Querying versioning

API description

Method prototype

Sample request

Parameter description

Response description

Cross-Region Replication

Setting a cross-region replication rule

API description

Method prototype

Sample request

Sample request with all parameters

Parameter description

Response description

Querying a cross-region replication rule

API description

Method prototype

Sample request

Parameter description

Response description

Deleting a cross-region replication rule

API description

Method prototype

Sample request

Parameter description

Response description

Access Policy

Setting an access policy