GetTableEncryption

更新时间:
复制为 MD 格式

调用GetTableEncryption接口获取指定表的服务端加密配置信息。

注意事项

  • 表的加密配置继承自Table Bucket的默认加密配置,目前只支持AES256算法。

  • 当使用KMS加密时,返回结果中的kmsKeyArn字段包含KMS密钥的ARN。

  • 当使用AES256加密时,kmsKeyArn字段为空字符串。

权限说明

API

Action

说明

GetTableEncryption

oss:GetTableEncryption

获取表加密配置(同时检查Table Policy)

请求语法

GET /tables/{tableBucketARN}/{namespace}/{name}/encryption HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

请求参数

名称

数据类型

是否必选

示例值

描述

tableBucketARN

字符串

acs:osstables:cn-hangzhou:1234567890:bucket/my-table-bucket

Table BucketARN,格式为acs:osstables:{region}:{uid}:bucket/{bucketName}。位于URI中。

namespace

字符串

my_namespace

表所在的命名空间名称。位于URI中。

name

字符串

my_table

表名称。位于URI中。

响应参数

名称

数据类型

示例值

描述

encryptionConfiguration

容器

-

服务端加密配置。

父节点:无

子节点:sseAlgorithm, kmsKeyArn

sseAlgorithm

字符串

AES256

服务端加密算法,取值为AES256KMS。

父节点:encryptionConfiguration

子节点:无

kmsKeyArn

字符串

acs:kms:cn-hangzhou:1234567890:key/key-id

KMS密钥的ARN。使用AES256加密时为空字符串。

父节点:encryptionConfiguration

子节点:无

示例

请求示例

GET /tables/acs%3Aosstables%3Acn-hangzhou%3A1234567890%3Abucket%2Fmy-table-bucket/my_namespace/my_table/encryption HTTP/1.1
Host: cn-hangzhou.oss-tables.aliyuncs.com
Date: Thu, 10 Apr 2025 08:00:00 GMT
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/osstables/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c****

返回示例

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"
   }
}

SDK

GetTableEncryption接口所对应的各语言SDK如下:

命令行工具ossutil

GetTableEncryption接口所对应的ossutil命令,请参见get-table-encryption

错误码

错误码

HTTP状态码

描述

ForbiddenException

403

调用者无权执行此请求。

NotFoundException

404

请求的资源不存在。