接口介绍
查询存储空间默认加密配置。
接口约束
支持的线上资源池 :上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。
URI
GET /v4/oss/get-bucket-encryption
请求参数
请求 Query 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
bucket | 是 | String | 桶名 | bucket1 |
regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回码 取值范围:800 成功 |
800 |
message | String | 状态描述 | SUCCESS |
description | String | 状态描述,一般为中文 | 成功 |
returnObj | Object | 响应对象 | 见下级对象 |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
serverSideEncryptionConfiguration | Object | 加密配置 | 见下级对象 |
表 serverSideEncryptionConfiguration
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
rules | Array of Objects | 规则 | 见下级对象 |
表 rules
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
applyServerSideEncryptionByDefault | Object | 加密配置规则 | 见下级对象 |
表 applyServerSideEncryptionByDefault
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
SSEAlgorithm | String | 加密算法,仅支持 AES256 或 aws:kms | aws:kms |
KMSMasterKeyID | String | KMS密钥ID | hesGckZJHzkbO2LpTJx3L3gFY0ju1a0I |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/get-bucket-encryption?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0
响应示例
{
"returnObj": {
"serverSideEncryptionConfiguration": {
"rules": [
{
"applyServerSideEncryptionByDefault": {
"KMSMasterKeyID": "hesGckZJHzkbO2LpTJx3L3gFY0ju1a0I",
"SSEAlgorithm": "aws:kms"
}
}
]
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
900 | 表示请求失败。 |
错误码
errorCode 枚举值,见错误码总表