华为云用户手册

上传字符串 static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 流式上传字符串 OBSPutObjectWithDataRequest *request = [[OBSPutObjectWithDataRequest alloc]initWithBucketName:@"bucketname" objectKey:@"objectname" uploadData:[@"hello" dataUsingEncoding:NSUTF8StringEncoding]]; // 上传文件进度 request.uploadProgressBlock = ^(int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) { NSLog(@"%0.1f%%",(float)floor(totalBytesSent*10000/totalBytesExpectedToSend)/100); }; [client putObject:request completionHandler:^(OBSPutObjectResponse *response, NSError *error){ NSLog(@"%@",response); }];

上传网络流 static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 流式上传网络流 OBSPutObjectWithDataRequest *request = [[OBSPutObjectWithDataRequest alloc] initWithBucketName:@"bucketname" objectKey:@"objectname" uploadDataURL:[NSURL URLWithString:@"DateURL"]]; // 上传文件进度 request.uploadProgressBlock = ^(int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) { NSLog(@"%0.1f%%",(float)floor(totalBytesSent*10000/totalBytesExpectedToSend)/100); }; [client putObject:request completionHandler:^(OBSPutObjectResponse *response, NSError *error){ NSLog(@"%@",response); }];

上传文件流 static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; NSString *filePath = [[NSBundle mainBundle]pathForResource:@"fileName" ofType:@"Type"]; // 文件流上传 NSData *uploadData = [NSData dataWithContentsOfFile:filePath]; OBSPutObjectWithDataRequest *request = [[OBSPutObjectWithDataRequest alloc]initWithBucketName:@"bucketname" objectKey:@"test/image1" uploadData:uploadData]; // 上传文件进度 request.uploadProgressBlock = ^(int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) { NSLog(@"%0.1f%%",(float)floor(totalBytesSent*10000/totalBytesExpectedToSend)/100); }; [client putObject:request completionHandler:^(OBSPutObjectResponse *response, NSError *error){ NSLog(@"%@",response); }]; 推荐使用文件上传的形式上传本地文件，而不是文件流形式。 大文件上传建议使用分段上传。 上传的内容大小不能超过5GB。

对象上传简介 在OBS中，用户操作的基本数据单元是对象。OBS iOS SDK提供了丰富的对象上传接口，可以通过以下方式上传对象： 流式上传 文件上传 分段上传 追加上传 断点续传上传 SDK支持上传0KB~5GB的对象。流式上传、文件上传和追加上传的内容大小不能超过5GB；当上传较大文件时，请使用分段上传，分段上传每段内容大小不能超过5GB。 如果上传的对象权限设置为匿名用户读取权限，对象上传成功后，匿名用户可通过链接地址访问该对象数据。对象链接地址格式为：https://桶名. 域名 /文件夹目录层级/对象名。如果该对象存在于桶的根目录下，则链接地址将不需要有文件夹目录层级。 父主题： 上传对象

获取桶存量信息 桶存量信息包括桶已使用的空间大小以及桶包含的对象个数。您可以通过getBucketStorageInfo获取桶的存量信息。以下代码展示如何获取桶存量信息： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 获取桶存量信息 OBSGetBucketStorageInfoRequest *request = [[OBSGetBucketStorageInfoRequest alloc] initWithBucketName:@"bucketname"]; [client getBucketStorageInfo:request completionHandler:^(OBSGetBucketStorageInfoResponse *response, NSError *error) { NSLog(@"%@",response.storageInfo); }]; 父主题： 管理桶

设置桶策略 您可以通过setBucketPolicy设置桶策略。示例代码如下： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 设置桶策略 OBSSetBucketPolicyWithStringRequest *request = [[OBSSetBucketPolicyWithStringRequest alloc] initWithBucketName:@"bucketname" policyString:@"policystring"]; [client setBucketPolicy:request completionHandler:^(OBSSetBucketPolicyResponse *response, NSError *error){ NSLog(@"%@",response); }];

获取桶策略 您可以通过getBucketPolicy获取桶策略。示例代码如下： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 获取桶策略 OBSGetBucketPolicyRequest *request = [[OBSGetBucketPolicyRequest alloc] initWithBucketName:g_bucketName]; [client getBucketPolicy:request completionHandler:^(OBSGetBucketPolicyResponse *response, NSError *error){ NSLog(@"%@",response); }];

删除桶策略 您可以通过deleteBucketPolicy删除桶策略。示例代码如下： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 删除桶策略 OBSDeleteBucketPolicyRequest *request = [[OBSDeleteBucketPolicyRequest alloc] initWithBucketName:g_bucketName]; [client deleteBucketPolicy:request completionHandler:^(OBSDeleteBucketPolicyResponse *response, NSError *error) { NSLog(@"%@",response); }];

获取桶区域位置 您可以通过getBucketLocation获取桶的区域位置。以下代码展示如何获取桶区域位置： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 获取桶区域 OBSGetBucketLocationRequest *request = [[OBSGetBucketLocationRequest alloc]initWithBucketName:@"bucketname"]; [client getBucketLocation:request completionHandler:^(OBSGetBucketLocationResponse *response, NSError *error){ NSLog(response.configuration.locationConstraint); }]; 创建桶时可以指定桶的区域位置，请参见创建桶。 父主题： 管理桶

获取桶元数据 您可以通过getBucketMetaData获取桶元数据。以下代码展示如何获取桶元数据： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; //获取桶元数据 OBSGetBucketMetaDataRequest *request = [[OBSGetBucketMetaDataRequest alloc]initWithBucketName:@"bucketname"]; [client getBucketMetaData:request completionHandler:^(OBSGetBucketMetaDataResponse *response, NSError *error){ NSLog(@"%@",response); }]; 父主题： 管理桶

删除桶 您可以通过deleteBucket来删除桶。以下代码展示如何删除桶： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; //删除桶 OBSDeleteBucketRequest *deleteRequest = [[OBSDeleteBucketRequest alloc] initWithBucketName:@"bucketname"]; [client deleteBucket:deleteRequest completionHandler:^(OBSDeleteBucketResponse *response, NSError *error) { NSLog(@"%@",response); }]; 如果桶不为空（包含对象或分段上传碎片），则该桶无法删除。 删除桶非幂等操作，删除不存在的桶会报错。 父主题： 管理桶

列举桶 您可以通过listBuckets来列举桶。以下代码展示如何获取桶列表： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; // 列举桶 OBSListBucketsRequest *request = [OBSListBucketsRequest new]; [client listBuckets:request completionHandler:^(OBSListBucketsResponse *response, NSError *error) { for(OBSBucket *bucket in response.bucketsList){ NSLog(@"bucketname=%@",bucket.name); } }]; 获取到的桶列表将按照桶名字典顺序排列。 父主题： 管理桶

带参数创建 创建桶时可以指定桶的访问权限、存储类型和区域位置。OBS支持的桶的存储类型有三类，参见桶存储类型。示例代码如下： static OBSClient *client; NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; //初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client client = [[OBSClient alloc] initWithConfiguration:conf]; //创建桶 OBSCreateBucketRequest *request = [[OBSCreateBucketRequest alloc] initWithBucketName:@"bucketname"]; // 设置权限为公共读写 request.bucketACLPolicy = OBSACLPolicyPublicReadWrite; // 存储模式设置为标准存储 request.defaultStorageClass = OBSStorageClassStandard; // 设置桶区域配置 request.configuration = [[OBSBucketConfiguration alloc] initWithLocationConstraint:@"bucketlocation"]; [client createBucket:request completionHandler:^(OBSCreateBucketResponse *response, NSError *error) { NSLog(@"%@",response.location); }];

配置OBS客户端 您可通过OBSServiceConfiguration配置类对OBSClient进行配置，可配置代理、连接超时、最大连接数等参数。通过OBSServiceConfiguration可以设置的参数见下表： 表1 OBS网络请求配置表 参数 描述 建议值 OBSServiceConfiguration.credentialProvider 用户凭证，参见表2 OBS服务身份验证配置表。 N/A OBSServiceConfiguration.proxyConfig 代理配置，默认为空，参见表3 代理服务配置表。 N/A OBSServiceConfiguration.trustUnsafeCert 是否信任不安全证书，默认为“NO”。 默认 OBSServiceConfiguration.maxConcurrentCommandRequestCount 允许的最大的命令请求并发数，默认为3。 默认 OBSServiceConfiguration.maxConcurrentUploadRequestCount 允许的最大的上传请求并发数，默认为3。 默认 OBSServiceConfiguration.maxConcurrentDownloadRequestCount 允许的最大的下载请求并发数，默认为3。 默认 OBSServiceConfiguration.defaultDomainMode 指定域名访问模式的参数，可设置为OBSDomainModeCustom以使用自定义域名, 默认为非自定义域名访问模式。 默认 OBSServiceConfiguration.commandSessionConfiguration.HTTPMaximumConnectionsPerHost 允许打开的最大的命令请求连接数, ios系统中默认为4。 N/A OBSServiceConfiguration.uploadSessionConfiguration.HTTPMaximumConnectionsPerHost 允许打开的最大的上传请求连接数, ios系统中默认为4。 N/A OBSServiceConfiguration.downloadSessionConfiguration.HTTPMaximumConnectionsPerHost 允许打开的最大的下载请求连接数, ios系统中默认为4。 N/A OBSServiceConfiguration.backgroundUploadSessionConfiguration.HTTPMaximumConnectionsPerHost 允许打开的最大的后台上传请求连接数, ios系统中默认为4。 N/A OBSServiceConfiguration.backgroundDownloadSessionConfiguration.HTTPMaximumConnectionsPerHost 允许打开的最大的后台下载请求连接数, ios系统中默认为4。 N/A OBSServiceConfiguration.commandSessionConfiguration.timeoutIntervalForRequest 配置命令请求的超时时间；（单位秒） 60 OBSServiceConfiguration.uploadSessionConfiguration.timeoutIntervalForRequest 配置上传相关请求的超时时间；（单位秒） 60 OBSServiceConfiguration.downloadSessionConfiguration.timeoutIntervalForRequest 配置下载相关请求的超时时间；（单位秒） 60 建议值为N/A的表示需要根据实际情况进行设置。出于安全性考虑，endpoint建议使用https协议。 OBSStaticCredentialProvider可以设置的参数见下表： 表2 OBS服务身份验证配置表 参数 描述 方法 accessKey 用户的 Access Key。 credentialProvider.Access_Key = Access_Key secretKey 用户的Secret Key。 credentialProvider.Secret_Key = Secret_Key securityToken 临时Token credentialProvider.securityToken = token credentialProvider是OBSStaticCredentialProvider的实例对象。 securityToken获取方式参见OBS服务环境搭建。 OBSHTTPProxyConfiguration可以设置的参数见下表： 表3 代理服务配置表 参数 描述 方法 proxyType 网络访问的类型（枚举类型）。 只允许HTTP： proxyConfig.proxyType=OBSHTTPRroxyTypeHTTP 只允许HTTPS： proxyConfig.proxyType=OBSHTTPRroxyTypeHTTPS 允许HTTP和HTTPS： proxyConfig.proxyType=OBSHTTPRroxyTypeHTTPAndHTTPS proxyHost 代理服务器的主机地址。 proxyConfig.proxyHost = @"host" proxyPort 代理服务器的端口号。 proxyConfig.proxyPort = @"port" username 连接代理服务器时使用的用户名。 proxyConfig.username = @"username" password 连接代理服务器时使用的用户密码。 proxyConfig.password = @"password" proxyConfig是OBSHTTPProxyConfiguration实例对象。 父主题： 初始化

自定义域名访问介绍与配置 当以自定义域名访问OBS桶时，需要先将该自定义域名同对应OBS桶访问域名进行绑定，相关配置请参见自定义域名绑定简介，自定义域名绑定配置。 当在自定义域名上配置了 CDN加速 服务，即自定义域名为CDN服务的加速域名时，需要额外对CDN服务进行配置，以保证可以正常使用自定义域名访问OBS服务。 以华为云CDN服务为例，相关配置如下所示： 登录华为云CDN服务，从CDN服务左侧列表中选择域名管理项，在该项中可以查看到所有配置的CDN服务域名信息。 配置源站。单击要使用的自定义域名项，进入域名配置界面，编辑源站配置，选择主源站类型为源站域名类型，对应源站为要访问的OBS桶域名。 配置回源HOST。回源HOST必须指定为加速域名即访问OBS服务时访问的自定义域名，否则可能会出现回源鉴权失败的问题。

OBS客户端通用示例 调用OBSClient类的相关接口时，没有错误产生则说明调用成功；当有错误产生时，则说明操作失败。以下代码展示了使用OBS客户端的通用方式： NSString *endPoint = @"your-endpoint"; // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; // 初始化身份验证 OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; // 初始化服务配置 OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider]; // 初始化client OBSClient *client = [[OBSClient alloc] initWithConfiguration:conf]; // 创建列举对象请求 OBSListBucketsRequest *request = [OBSListBucketsRequest new]; // 列举对象 OBSBFTask *task = [client listBuckets:request completionHandler:^(OBSListBucketsResponse *response, NSError *error) { if(error){ // 处理错误 }else{ // 获取结果 for(OBSBucket *bucket in response.bucketsList){ NSLog(@"bucketname=%@",bucket.name); } } }]; [task waitUntilFinished]; 在调用OBSClient类的相关接口时，如果将Client声明为局部变量，则应该通过对请求任务执行waitUntilFinished操作以保证Client在请求任务执行期间始终有效，否则可能造成网络请求失败，程序崩溃的问题。 父主题： 快速入门

删除对象 以下代码展示如何删除指定的对象： OBSDeleteObjectRequest *request = [[OBSDeleteObjectRequest alloc] initWithBucketName:@"bucketname" objectKey:@"objectname"]; [client deleteObject:request completionHandler:^(OBSDeleteObjectResponse *response, NSError *error) { NSLog(@"%@",response); }]; 父主题： 快速入门

列举对象 当完成一系列上传对象操作后，可能需要查看桶中包含哪些对象。以下代码展示如何列举指定桶中的对象： OBSListObjectsRequest *request = [[OBSListObjectsRequest alloc] initWithBucketName:@"bucketname"]; request.maxKeys = [NSNumber numberWithInt:10]; request.origin = @"www.example1.com"; [client listObjects:request completionHandler:^(OBSListObjectsResponse *response, NSError *error) { NSLog(@"%d",response.contentsList.count); }]; 调用listObjects返回OBSListObjectsResponse实例，该实例包含此次listObject请求的返回结果。 上面的代码默认列举1000个对象（Object）。 更丰富的列举功能，请参见列举对象。 父主题： 快速入门

下载对象 以下代码展示如何获取对象的内容： NSString * outfilePath = [NSTemporaryDirectory() stringByAppendingString:@"filename"]; OBSGetObjectToFileRequest *request = [[OBSGetObjectToFileRequest alloc]initWithBucketName:@"bucketname" objectKey:@"objectname" downloadFilePath:outfilePath]; // 下载进度 request.downloadProgressBlock = ^(int64_t bytesWritten, int64_t totalBytesWritten, int64_t totalBytesExpectedToWrite) { NSLog(@"%0.1f%%",(float)floor(totalBytesWritten*10000/totalBytesExpectedToWrite)/100); }; [client getObject:request completionHandler:^(OBSGetObjectResponse *response, NSError *error){ NSLog(@"%@",response.etag); }]; 调用getObject返回一个OBSObject实例，该实例包含对象内容及其属性。 更多下载对象的信息，请参见下载对象。 父主题： 快速入门

上传对象 以下代码展示如何上传对象至OBS： NSString *filePath = [[NSBundle mainBundle]pathForResource:@"fileName" ofType:@"Type"]; OBSPutObjectWithFileRequest *request = [[OBSPutObjectWithFileRequest alloc]initWithBucketName:@"bucketname" objectKey:@"objectname" uploadFilePath:filePath]; // 上传进度 request.uploadProgressBlock = ^(int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) { NSLog(@"%0.1f%%",(float)floor(totalBytesSent*10000/totalBytesExpectedToSend)/100); }; // 上传文件 [ client putObject:request completionHandler:^(OBSPutObjectResponse *response, NSError *error){ NSLog(@"%@",response.etag); }]; 更多上传对象的信息，请参见上传对象。 父主题： 快速入门

创建桶 桶是OBS全局命名空间，相当于数据的容器、文件系统的根目录，可以存储若干对象。以下代码展示如何新建一个桶： OBSCreateBucketRequest *request = [[OBSCreateBucketRequest alloc] initWithBucketName:@"bucketname"]; [client createBucket:request completionHandler:^(OBSCreateBucketResponse *response, NSError *error) { NSLog(response.location); }]; 桶的名字是全局唯一的，所以您需要确保不与已有的桶名称重复。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 更多创建桶的信息，请参见管理桶。 创建桶时，如果使用的终端节点归属于默认区域华北-北京一（cn-north-1），则可以不指定区域；如果使用的终端节点归属于其他区域，则必须指定区域，且指定的区域必须与终端节点归属的区域一致。当前有效的区域名称可从这里查询。 您可以使用带参数创建方式，在创建桶时，指定桶的区域位置。 父主题： 快速入门

初始化OBS客户端 向OBS发送任一HTTP/HTTPS请求之前，必须先创建一个OBSClient实例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。 // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html char* ak_env = getenv("AccessKeyID"); char* sk_env = getenv("SecretAccessKey"); NSString *AK = [NSString stringWithUTF8String:ak_env]; NSString *SK = [NSString stringWithUTF8String:sk_env]; OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK]; OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:@"https://your-endpoint" credentialProvider:credentialProvider]; // 初始化client OBSClient *client = [[OBSClient alloc] initWithConfiguration:conf]; 更多OBS客户端初始化的内容请参考“初始化”章节。 父主题： 快速入门

对象相关接口说明(Go SDK) OBS Go SDK为对象相关接口（断点续传除外），均提供了使用带授权信息的URL访问OBS服务的方法，这些方法可能包含以下三个参数（ObsClient.PutFileWithSignedUrl除外）： 带授权信息的URL 通过带授权信息的URL发起请求时实际应携带的头域 请求携带的数据（可选） 关于如何生成带授权信息的URL，请参考生成带授权信息的URL。 父主题： 对象相关接口(Go SDK)

其他使用前须知 请确认您已经熟悉OBS的基本概念，如桶（Bucket）、对象（Object）、访问密钥（AK和SK）、终端节点（Endpoint）和访问域名等。 当前各区域特性开放不一致，部分特性只在部分区域开放，使用过程中如果接口HTTP状态码为405，请确认该区域是否支持该功能特性。您可以查看功能总览确认区域是否支持该功能特性，或者提交工单寻求技术支持。 命名空间：与OBS 2.0 旧版本（2.2.x）保持兼容，使用obs作为命名空间，SDK包含的所有数据类型和接口定义均归属于该命名空间，使用SDK前需要引入obs。 接口函数：与OBS 2.0 旧版本（2.2.x）保持兼容。

代码示例 本示例用于获取桶名为examplebucket的日志管理配置 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 package main import ( "fmt" "os" obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs" ) func main() { //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。 //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html。 ak := os.Getenv("AccessKeyID") sk := os.Getenv("SecretAccessKey") // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。 // securityToken := os.Getenv("SecurityToken") // endpoint填写Bucket对应的Endpoint, 这里以华北-北京四为例，其他地区请按实际情况填写。 endPoint := "https://obs.cn-north-4.myhuaweicloud.com" // 创建obsClient实例 // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。 obsClient, err := obs.New(ak, sk, endPoint, obs.WithSignature(obs.SignatureObs)/*, obs.WithSecurityToken(securityToken)*/) if err != nil { fmt.Printf("Create obsClient error, errMsg: %s", err.Error()) } // 指定存储桶名称 bucketname := "examplebucket" // 获取桶的日志管理配置 output, err := obsClient.GetBucketLoggingConfiguration(bucketname) if err == nil { fmt.Printf("Get bucket(%s)'s BucketLoggingConfiguration successful!\n", bucketname) fmt.Printf("RequestId:%s\n", output.RequestId) fmt.Printf("TargetBucket:%s, TargetPrefix:%s\n", output.TargetBucket, output.TargetPrefix) for index, grant := range output.TargetGrants { fmt.Printf("Grant[%d]-Type:%s, ID:%s, URI:%s, Permission:%s\n", index, grant.Grantee.Type, grant.Grantee.ID, grant.Grantee.URI, grant.Permission) } return } fmt.Printf("Get bucket(%s)'s BucketLoggingConfiguration fail!\n", bucketname) if obsError, ok := err.(obs.ObsError); ok { fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.") fmt.Println(obsError.Error()) } else { fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.") fmt.Println(err) } }

返回结果说明 表2 返回结果列表 参数名称 参数类型 描述 output *GetBucketLoggingConfigurationOutput 参数解释： 接口返回信息，详情参考GetBucketLoggingConfigurationOutput。 err error 参数解释： 接口返回错误信息。 表3 GetBucketLoggingConfigurationOutput 参数名称 参数类型 描述 StatusCode int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ResponseHeaders map[string][]string 参数解释： HTTP响应头信息。 默认取值： 无 Agency string 参数解释： 目标桶（存放日志文件的桶）的所有者通过 统一身份认证 服务（ IAM ）创建的对OBS云服务的委托的名称。 可以选择账号下已有的IAM委托，也可以创建一个新的委托。创建委托参见创建IAM委托。 约束限制： 默认情况下，在为委托配置权限时只需设置日志存储桶的上传对象（PutObject）权限。如果日志存储桶开启了默认加密功能，还需要委托同时具有日志存储桶所在区域的KMS Administrator权限。 默认取值： 无 TargetBucket string 参数解释： 日志存储桶的桶名，该桶用于存放日志文件。 约束限制： 需要和开启日志功能的桶在同一个region中。 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 TargetPrefix string 参数解释： 日志文件对象的对象名前缀，设置后日志文件对象将携带统一前缀存储在日志存储桶中。 取值范围： 长度大于0且不超过1024的字符串。 默认取值： 无 TargetGrants []Grant 参数解释： 被授权用户权限信息列表，定义哪些用户可以针对日志文件进行哪些访问操作，详情参考Grant。 表4 Grant 参数名称 参数类型 描述 Grantee Grantee 参数解释： 被授权用户，包括用户类型，账号ID，账号名和被授权用户组，详情参考Grantee。 Permission PermissionType 参数解释： 被授予的权限。 取值范围： 授权策略的取详情参考PermissionType。 默认取值： 无 表5 Grantee 参数名称 参数类型 描述 Type GranteeType 参数解释： 被授权用户的类型。 取值范围： 用户类型的取值范围详见GranteeType。 默认取值： 无 ID string 参数解释： 被授权用户的账号ID，即domain_id。 取值范围： 如何获取账号ID请参见如何获取账号ID和用户ID？ 默认取值： 无 DisplayName string 参数解释： 被授权用户的账号名。 约束限制： 不支持中文。 只能以字母开头。长度为6-32个字符。 只能包含英文字母、数字或特殊字符(-_)。 默认取值： 无 URI GroupUriType 参数解释： 被授权的用户组，详见GroupUriType。 表6 GranteeType 常量名 原始值 说明 GranteeGroup Group 用户组。 GranteeUser CanonicalUser 单个用户。 表7 GroupUriType 常量名 原始值 说明 GroupAllUsers AllUsers 所有用户。 表8 PermissionType 常量名 原始值 说明 PermissionRead READ 读权限。 PermissionWrite WRITE 写权限。 PermissionReadAcp READ_ACP 读取ACL配置的权限。 PermissionWriteAcp WRITE_ACP 修改ACL配置的权限。 PermissionFullControl FULL_CONTROL 完全控制权限，包括对桶或对象的读写权限，以及对桶或对象ACL配置的读写权限。

接口约束 您必须是桶拥有者或拥有获取桶日志管理配置的权限，才能获取桶日志管理配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:GetBucketLogging权限，如果使用桶策略则需授予GetBucketLogging权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

请求参数说明 表1 请求参数列表 参数名称 参数类型 是否必选 描述 bucketName string 必选 参数解释： 桶名。 约束限制： 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。 桶命名规则如下： 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。 禁止使用IP地址。 禁止以“-”或“.”开头及结尾。 禁止两个“.”相邻（如：“my..bucket”）。 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。 同一用户在同一个区域多次创建同名桶不会报错，创建的桶属性以第一次请求为准。 默认取值： 无 extensions extensionOptions 可选 参数解释： 桶相关扩展信息。通过调用拓展配置项为对应请求配置额外的拓展请求头，详情参考extensionOptions。

接口约束 由于日志文件是OBS产生，并且由OBS上传到存放日志的桶中，因此OBS需要获得委托授权，用于上传生成的日志文件，所以在配置桶日志管理前，需要先到统一身份认证服务生成一个对OBS服务的委托，委托配置权限只需设置目标桶的上传对象权限。 您必须是桶拥有者或拥有设置桶日志管理配置的权限，才能设置桶日志管理配置。建议使用IAM或桶策略进行授权，如果使用IAM则需授予obs:bucket:PutBucketLogging权限，如果使用桶策略则需授予PutBucketLogging权限。相关授权方式介绍可参见OBS权限控制概述，配置方式详见使用IAM自定义策略、自定义创建桶策略。 OBS支持的Region与Endpoint的对应关系，详细信息请参见地区与终端节点。

返回结果说明 表8 返回结果列表 参数名称 参数类型 描述 output *BaseModel 参数解释： 接口返回信息，详见BaseModel。 err error 参数解释： 接口返回错误信息。 表9 BaseModel 参数名称 参数类型 描述 StatusCode int 参数解释： HTTP状态码。 取值范围： 状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值： 无 RequestId string 参数解释： OBS服务端返回的请求ID。 默认取值： 无 ResponseHeaders map[string][]string 参数解释： HTTP响应头信息。 默认取值： 无