# Golang SDK
# 说明
云存储Golang SDK。
# 源码
请从GitHub项目获取，https://github.com/SinaCloudStorage/SinaCloudStorage-SDK-Go (opens new window)
# 如何使用
在你的项目中导入SinaCloudStorage/SinaCloudStorage-SDK-Go项目。
import sdk "github.com/SinaCloudStorage/SinaCloudStorage-SDK-Go"
# 常量定义
const (
Private = ACL("private")
PublicRead = ACL("public-read")
PublicReadWrite = ACL("public-read-write")
AuthenticatedRead = ACL("authenticated-read")
)
# 类型
# ACL类型
type ACL string
快捷ACL
private Bucket和Object Owner权限 = FULL_CONTROL，其他人没有任何权限
public-read Bucket和Object Owner权限 = FULL_CONTROL，GRPS000000ANONYMOUSE权限 = READ
public-read-write Bucket和Object Owner权限 = FULL_CONTROL，GRPS000000ANONYMOUSE权限 = READ + WRITE
authenticated-read Bucket和Object Owner权限 = FULL_CONTROL，GRPS0000000CANONICAL权限 = READ
GRPS0000000CANONICAL：此组表示所有的新浪云存储注册帐户。
所有的请求必须签名（认证），如果签名认证通过，即可按照已设置的权限规则进行访问。
GRPS000000ANONYMOUSE：匿名用户组，对应的请求可以不带签名。
SINA000000000000IMGX：图片处理服务，将您的bucket的ACL设置为对
SINA000000000000IMGX的读写权限，在您使用图片处理服务的时候可以免签名。
# SCS结构体
type SCS struct {
AccessKey string
SecretKey string
EndPoint string
}
# Bucket结构体
type Bucket struct {
*SCS
Name string
}
# Bucket和Object操作
# func NewSCS（创建SCS类）
创建一个SCS类
func NewSCS(accessKey, secretKey, endPoint string) (scs *SCS)
``
示例：
```go
import sdk "github.com/SinaCloudStorage/SinaCloudStorage-SDK-Go"
// ak 和 sk 可以从https://scs.sinacloud.com管理面板处获取
scs := sdk.NewSCS(ak, sk, "http://sinacloud.net")
# 创建一个名为name的Bucket类
func (scs *SCS) Bucket(name string) *Bucket
返回一个名为name的Bucket类
# 列出所有的bucket
func (b *Bucket) ListBucket() (data []byte, err error)
列出用户账户下所有的buckets
# 列出bucket下所有的文件
func (b *Bucket) ListObject(prefix, delimiter, marker string, maxKeys int) (data []byte, err error)
列出Bucket下的所有objects。
参数说明：
delimiter 折叠显示字符,通常使用：'/'
"" 时，以"join/mailaddresss.txt" 这种”目录+object“的形式展示,
"/" 时，以"join" 这种"目录"的形式展示，不会展开目录
prefix 列出以指定字符为开头的Key,可为""空字符串
marker Key的初始位置，系统将列出比Key大的值，通常用作‘分页’的场景,可为""空字符串
max-keys 返回值的最大Key的数量
# 获取bucket的meta和acl信息
func (b *Bucket) GetBucketInfo(info string) (data []byte, err error)
获取bucket的meta或acl信息，"info"值为"meta" or "acl"
# 创建一个bucket
func (b *Bucket) PutBucket(acl ACL) error
创建bucket
# 删除一个bucket
func (b *Bucket) DelBucket() error
删除bucket。
提示
如果bucket下还有未删除的object文件，则不允许删除，需要先遍历删除所有的object后再删除bucket。
# 获取object的meta和acl信息
func (b *Bucket) GetInfo(object string, info string) (data []byte, err error)
获取object的meta或acl信息，"info"值为"meta" or "acl"
# 获取object内容
func (b *Bucket) Get(object string) (data []byte, err error)
下载object
示例：
scs := sdk.NewSCS(ak, sk, "http://sinacloud.net")
bt := scs.Bucket("bucketname")
fd, err := os.Create("/tmp/3.png")
if err != nil {
return err
}
data, err := bt.Get("3.png")
if err != nil {
return err
}
n, err := fd.Write(data)
if err != nil {
return err
}
fmt.Println(n)
# 通过range方式下载object
func (b *Bucket) Get(object string, offset int64) (data []byte, err error)
通过range方式下载object
示例：
scs := sdk.NewSCS(ak, sk, "http://sinacloud.net")
bt := scs.Bucket("bucketname")
fd, err := os.Create("/tmp/3.txt")
if err != nil {
return err
}
data, err := bt.Get("3.txt", 5)
if err != nil {
return err
}
fmt.Println(string(data))
# 创建object
func (b *Bucket) Put(object, uploadFile string, acl ACL) error
上传object
示例：
err := bt.Put("test.go", "/tmp/test.go", sdk.Private)
if err != nil {
return err
}
# 创建object并设置属性
func (b *Bucket) PutExpire(object, uploadFile string, acl ACL, expire time.Time) error
创建文件object并添加文件过期时间。
示例：
err := bt.PutExpire("test.go", "/tmp/test.go", sdk.Private, time.Now().Add(60*time.Second))
if err != nil {
return err
}
# 以ssk的方式上传object
func (b *Bucket) PutSsk(object, uploadFile string, acl ACL) (string, error)
以ssk的方式上传object, 返回响应header头的x-sina-serverside-key
# 设置指定object 的acl
func (b *Bucket) PutAcl(object string, acl map[string][]string) error
设置指定object的acl，当object值为/时，设置的是对应bucket的acl，acl格式如下：
acl := map[string][]string{
"SINA000000000000IMGX": []string{"read"},
"GRPS000000ANONYMOUSE": []string{"read", "read_acp", "write", "write_acp"},
}
# 更新一个已经存在的object的附加meta信息
func (b *Bucket) PutMeta(object string, meta map[striring]string) error
更新一个已经存在的object的附加meta信息，这个接口无法更新文件的基本信息，如文件的大小和类型等，meta格式如下：
meta := map[string]string{"x-amz-meta-name": "sandbox", "x-amz-meta-age": "13"}
# 通过拷贝方式创建object
func (b *Bucket) Copy(dstObject, srcBucket, srcObject string) error
通过拷贝方式创建object（不上传具体的文件内容,而是通过COPY方式对系统内另一文件进行复制）
# 通过秒传创建object
func (b *Bucket) Relax(object, uploadFile string, acl ACL) error
通过“秒传”方式创建Object（不上传具体的文件内容，而是通过SHA-1值对系统内文件进行复制）
# 删除object
func (b *Bucket) Del(object string) error
删除object
# 生成带有过期时间的下载签名URL
func (b *Bucket) SignURL(object string, expires time.Time) string
返回带有过期时间的下载签名URL
示例：
uri := bt.SignURL("test.go", time.Now().Add(15*time.Second))
fmt.Println(uri)
//output: http://url/bucket/test.go?Expires=1479722790&KID=sina%2Cruikuntest&ssig=T233ytgAOv
# 返回object的URL
func (b *Bucket) URL(object string) string
返回URL
# 分片上传
# 分片上传的结构体
type Multi struct {
Bucket *Bucket
Object string
UploadId string
}
# 分片上传初始化
func (b *Bucket) InitMulti(object string) (*Multi, error)
大文件分片上传初始化，返回Multi类 。
注意：
- 在初始化上传接口中要求必须进行用户认证，匿名用户无法使用该接口
- 在初始化上传时需要给定文件上传所需要的meta绑定信息，在后续的上传中该信息将被保留，并在最终完成时写入云存储系统
# 上传分片
func (m *Multi) PutPart(uploadFile string, acl ACL, partSize int) ([]Part, error)
上传分片, 注意：分片数不能超过2048
# 列出已经上传的分片
func (m *Multi) ListPart() ([]Part, error)
列出已经上传的所有分片信息
# 合并上传的分片
func (m *Multi) Complete(partInfo []Part) error
大文件分片上传拼接（合并）
示例：
multi, err := bt.InitMulti("pict.tar.gz")
if err != nil {
return err
}
partInfo, err := multi.PutPart("/tmp/pict.tar.gz", sdk.Private, 1024*1024*3)
if err != nil {
return err
}
listPart, err := multi.ListPart()
if err != nil {
return err
}
for k, v := range listPart {
if partInfo[k].ETag != v.ETag {
return fmt.Errorf("分片不匹配")
}
}
err = multi.Complete(listPart)
if err != nil {
return err
}
# 错误相关
# 错误信息的结构
type Error struct {
StatusCode int
RequestId string
ErrorCode string
Date string
}
# 获取错误信息
func (e *Error) Error() string
← iOS-Swift SDK 命令行工具 →