The GetTableBucketEncryption operation retrieves the server-side encryption configuration of a specified Table Bucket.
Usage notes
The returned configuration includes the encryption algorithm and the KMS key ARN.
Permissions
API | Actions | Description |
GetTableBucketEncryption | oss:GetTableBucketEncryption | Retrieves the encryption configuration of a Table Bucket. |
Request syntax
GET /buckets/{tableBucketARN}/encryption HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: GMT Date
Authorization: SignatureValueRequest parameters
Parameter | Type | Required | Example | Description |
tableBucketARN | String | Yes | acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket | The ARN of the Table Bucket. The format is acs:osstables:{region}:{accountId}:bucket/{bucketName}. |
Response parameters
Parameter | Type | Example | Description |
encryptionConfiguration | container | - | A container for the encryption configuration that includes the sseAlgorithm and kmsKeyArn parameters. |
sseAlgorithm | String | AES256 | The server-side encryption algorithm, for example, AES256. This parameter is a child of encryptionConfiguration. |
kmsKeyArn | String | - | The KMS key ARN. This field is an empty string if no KMS key is configured. This parameter is a child of encryptionConfiguration. |
Examples
Request example
GET /buckets/acs%3Aosstables%3Acn-hangzhou%3A1234567890%3Abucket%2Fmy-table-bucket/encryption HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: GMT Date
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/osstables/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c****Response example
HTTP/1.1 200 OK
Server: AliyunOSS
x-oss-request-id: 5C06A3B67B8B5A3DA422****
x-oss-server-time: 3
Content-Type: application/json
{
"encryptionConfiguration": {
"kmsKeyArn": "",
"sseAlgorithm": "AES256"
}
}SDKs
You can call the GetTableBucketEncryption operation by using the following SDKs:
Ossutil CLI
The corresponding ossutil command is get-table-bucket-encryption.
Error codes
Error code | HTTP status code | Description |
ForbiddenException | 403 | The caller does not have the required permissions to perform this request. |
NotFoundException | 404 | The requested resource does not exist. |