Swift获取存储空间的信息

本文介绍如何通过OSS Swift SDK获取指定存储空间的访问跟踪状态信息、地域、创建日期、读写权限、拥有者的名称和ID、存储类型、数据容灾类型、外网域名、内网域名、跨区域复制状态、版本控制状态、加密方式等内容,以便进行相应操作。

注意事项

  • 本文示例代码以华东1(杭州)的地域IDcn-hangzhou为例,默认使用外网Endpoint,如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的RegionEndpoint的对应关系,请参见OSS地域和访问域名

  • 要获取存储空间的信息,您必须具有oss:GetBucketInfo权限。具体操作,请参见RAM用户授予自定义的权限策略

示例代码

您可以使用以下代码获取存储空间的信息。

import AlibabaCloudOSS
import Foundation

@main
struct Main {
    static func main() async {
        do {
        
            // 填写Bucket所在地域。以华东1(杭州)为例,Region填写为cn-hangzhou。
            let region = "cn-hangzhou"
            // 填写Bucket名称。
            let bucket = "yourBucketName"
            // 可选项,指定访问OSS服务的域名。以华东1(杭州)为例,Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com
            let endpoint: String? = nil

            // 从环境变量加载凭证(需提前设置 OSS_ACCESS_KEY_ID 和 OSS_ACCESS_KEY_SECRET)
            let credentialsProvider = EnvironmentCredentialsProvider()

            // 配置OSS客户端参数
            let config = Configuration.default()
                .withRegion(region) // 设置区域
                .withCredentialsProvider(credentialsProvider) // 设置凭证
                
            // 设置Endpoint
            if let endpoint = endpoint {
                config.withEndpoint(endpoint)
            }

            // 创建OSS客户端实例
            let client = Client(config)

            // 执行获取存储空间信息操作
            let result = try await client.getBucketInfo(
                GetBucketInfoRequest(
                    bucket: bucket
                )
            )

            // 输出操作结果
            print("result:\n\(result)")

        } catch {
            // 捕获并处理异常
            print("error:\n\(error)")
        }
    }
}

常用存储空间信息列表

参数

描述

BucketInfo.Name

存储空间名称

BucketInfo.AccessMonitor

存储空间访问跟踪状态信息

BucketInfo.Location

存储空间所在地域

BucketInfo.CreationDate

存储空间创建日期

BucketInfo.ExtranetEndpoint

存储空间外网域名

BucketInfo.IntranetEndpoint

同地域ECS访问存储空间的内网域名

BucketInfo.ACL

存储空间读写权限

BucketInfo.RedundancyType

存储空间数据容灾类型

BucketInfo.Owner

包含以下参数:

  • BucketInfo.Owner.ID:存储空间拥有者的用户ID

  • BucketInfo.Owner.DisplayName:存储空间拥有者名称

BucketInfo.StorageClass

存储空间存储类型

BucketInfo.SseRule

包含以下参数:

  • BucketInfo.SseRule.KMSDataEncryption:是否使用KMS加密

  • BucketInfo.SseRule.KMSMasterKeyID:当前使用的KMS密钥ID

  • BucketInfo.SseRule.SSEAlgorithm:服务器端默认加密方式

BucketInfo.Versioning

存储空间版本控制状态

BucketInfo.CrossRegionReplication

存储空间跨区域复制状态

相关文档