注意事项
-
文件大小限制
简单上传的Object的大小不能超过5 GB。超过5 GB的Object上传请使用云盒分片上传。
-
Object命名规则
-
使用UTF-8编码。
-
长度必须在1~1023字符之间。
-
不能以正斜线(/)或者反斜线(\)字符开头。
-
权限控制
为防止未授权用户向您的云盒Bucket上传数据,OSS ON云盒提供了云盒Bucket ACL和云盒Bucket Policy。
-
防止同名文件被覆盖
OSS的文件上传默认会覆盖同名文件, 为防止文件被意外覆盖,您可以通过以下方式保护您的文件:
-
开启版本控制功能
开启版本控制功能后,被覆盖的文件会以历史版本的形式保存下来。您可以随时恢复历史版本文件。更多信息,请参见云盒版本控制。
-
在上传请求中携带禁止覆盖同名Object的参数
在上传请求的Header中携带参数x-oss-forbid-overwrite,并指定其值为true。当您上传的Object在OSS中存在同名Object时,该Object会上传失败,并返回FileAlreadyExists错误。当不携带此参数或此参数的值为false时,同名Object会被覆盖。
-
上传性能调优
如果您在上传大量Object时,在命名上使用了顺序前缀(如时间戳或字母顺序),可能会出现大量Object索引集中存储于存储空间中某个特定分区的情况,此时如果您的请求速率过大,会导致请求速率下降。建议您在上传大量Object时,不要使用顺序前缀的Object名称,而是将顺序前缀改为随机性前缀。具体操作,请参见OSS性能最佳实践。
操作步骤
使用阿里云SDK
支持通过Java、Python、Go SDK将本地文件上传至云盒Bucket(Java SDK要求3.15.0及以上版本,Python SDK V2要求1.1.1及以上版本,Go SDK V2要求v1.2.1及以上版本)。云盒场景下,Python、Go SDK的操作调用方式与公共云OSS一致,创建客户端的方式请参见SDK支持。
import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.PutObjectRequest;
import java.io.File;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;
public class Demo {
public static void main(String[] args) throws Exception {
// 填写云盒Bucket的数据域名。
String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// 填写云盒Bucket名称,例如examplebucket。
String bucketName = "examplebucket";
// 填写云盒Bucket所在地域。
String region = "cn-hangzhou";
// 填写云盒ID。
String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";
// 填写Object完整路径,完整路径中不能包含Bucket名称,例如exampledir/exampleobject.txt。
String objectName = "exampledir/exampleobject.txt";
// 填写本地文件的完整路径,例如D:\\localpath\\examplefile.txt。
// 如果未指定本地路径,则默认从示例程序所属项目对应本地路径中上传文件。
String filePath= "D:\\localpath\\examplefile.txt";
// 创建OSSClient实例。
// 当OSSClient实例不再使用时,调用shutdown方法以释放资源。
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
conf.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(new DefaultCredentialProvider(credentialsProvider.getCredentials()))
.clientConfiguration(conf)
.region(region)
.cloudBoxId(cloudBoxId)
.build();
try {
// 创建PutObjectRequest对象。
PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, objectName, new File(filePath));
// 如果需要上传时设置存储类型和访问权限,请参考以下示例代码。
// ObjectMetadata metadata = new ObjectMetadata();
// metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());
// metadata.setObjectAcl(CannedAccessControlList.Private);
// putObjectRequest.setMetadata(metadata);
// 上传文件。
ossClient.putObject(putObjectRequest);
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
}
}
import alibabacloud_oss_v2 as oss
# 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
# 使用SDK的默认配置。
cfg = oss.config.load_default()
cfg.credentials_provider = credentials_provider
# 填写云盒Bucket所在地域,例如cn-hangzhou。
cfg.region = "cn-hangzhou"
# 填写云盒ID。设置云盒ID后,SDK会自动将签名产品切换为oss-cloudbox。
cfg.cloud_box_id = "cb-f8z7yvzgwfkl9q0h****"
# 填写云盒Bucket的数据域名,格式为CloudboxId.Region.oss-cloudbox.aliyuncs.com。
cfg.endpoint = "cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com"
# 创建OSS客户端。
client = oss.Client(cfg)
# 上传本地文件。填写Object完整路径(不能包含Bucket名称)和本地文件的完整路径。
result = client.put_object_from_file(oss.PutObjectRequest(
bucket="examplebucket",
key="exampledir/exampleobject.txt"
), "D:\\localpath\\examplefile.txt")
print(f'status code: {result.status_code},'
f' request id: {result.request_id},'
f' etag: {result.etag}')
package main
import (
"context"
"log"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
func main() {
// 使用SDK的默认配置,并从环境变量中获取访问凭证。
// 运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
// 填写云盒Bucket所在地域,例如cn-hangzhou。
WithRegion("cn-hangzhou").
// 填写云盒Bucket的数据域名,格式为CloudboxId.Region.oss-cloudbox.aliyuncs.com。
WithEndpoint("cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com").
// 填写云盒ID。设置云盒ID后,SDK会自动将签名产品切换为oss-cloudbox。
WithCloudBoxId("cb-f8z7yvzgwfkl9q0h****")
// 创建OSS客户端。
client := oss.NewClient(cfg)
// 填写本地文件的完整路径。
localFile := "D:\\localpath\\examplefile.txt"
// 上传本地文件。填写云盒Bucket名称和Object完整路径(不能包含Bucket名称)。
result, err := client.PutObjectFromFile(context.TODO(), &oss.PutObjectRequest{
Bucket: oss.Ptr("examplebucket"),
Key: oss.Ptr("exampledir/exampleobject.txt"),
}, localFile)
if err != nil {
log.Fatalf("failed to put object from file %v", err)
}
log.Printf("put object from file result:%#v\n", result)
}
使用命令行工具ossutil
关于使用ossutil简单上传的具体操作, 请参见put-object。
使用REST API
如果您的程序自定义要求较高,您可以直接发起REST API请求。直接发起REST API请求需要手动编写代码计算签名。更多信息,请参见PutObject。