GOLANG SDK 手册
初始化
确定 EndPoint
EndPoint 是 NOS 各个区域的地址,目前支持以下形式
EndPoint 类型 | 备注 |
---|---|
NOS 区域域名地址 | 使用桶所在的区域的 NOS 域名地址 |
NOS 区域域名地址
进入 NOS 控制台,在桶的 属性 中可以查找到当前桶所在的区域及域名,桶的域名的后缀部分为 该桶的公网域名,例如:test-logging.nos-eastchina1.126.net 中的 nos-eastchina1.126.net 为该桶的公网 EndPoint。
配置秘钥
要接入 NOS 服务,您需要一对有效的 AccessKey (包括 AccessKeyId 与 AccessKeySecret)来进行 签名验证,开通服务与 AccessKey 请参考 访问控制:
在获取到 AccessKeyId 与 AccessKeySecret 之后,可以按照以下的步骤进行初始化
新建 NosClient
GO-SDK 提供的接口都在 NosClient 中实现,并以成员方法的方式对外提供调用。因此使用 GO-SDK 前必须实例化一个 NosClient 对象。
关于请求参数
NosClient 中的方法采用对象方式进行传参:
package main
import (
"fmt"
"github.com/NetEase-Object-Storage/nos-golang-sdk/nosclient"
"github.com/NetEase-Object-Storage/nos-golang-sdk/model"
)
func main() {
copyObjectRequest := &CopyObjectRequest{
SrcBucket : TEST_BUCKET,
SrcObject : PUTOBJECTFILE,
DestBucket : TEST_BUCKET,
DestObject : "CopiedTest",
}
err := nosClient.CopyObject(copyObjectRequest)
}
实例化 NosClient
如果您需要修改 NosClient 的默认参数,可以在实例化 NosClient 时传入 Config 实例。Config 是 NosClient 的配置类,可配置连接超时、Key 等参数。通过 Config 可以设置的参数见下表:
参数 | 描述 | 是否必须 |
---|---|---|
Endpoint | 上传的 NOS 地址 | 是 |
AccessKey | 认证使用的 Access Key | 否 |
SecretKey | 认证使用的 Access Secret | 否 |
NosServiceConnectTimeout | 建立连接的超时时间(单位:秒)默认:30 秒 | 否 |
NosServiceReadWriteTimeout | Socket 层传输数据超时时间(单位:秒)默认:60 秒 | 否 |
NosServiceMaxIdleConnection | 最大空闲连接时间(单位:秒)默认:60 秒 | 否 |
LogLevel | 打印日志的等级默认:Debug | 否 |
Logger | 打印日志的对象 | 否 |
带 Config 参数实例化 NosClient 的示例代码:
package main
import (
"fmt"
"github.com/NetEase-Object-Storage/nos-golang-sdk/nosclient"
"github.com/NetEase-Object-Storage/nos-golang-sdk/model"
"github.com/NetEase-Object-Storage/nos-golang-sdk/logger"
)
func main() {
conf := &config.Config{
Endpoint: "nos.netease.com",
AccessKey: "your-accesskey",
SecretKey: "your-secretkey",
NosServiceConnectTimeout: 3,
NosServiceReadWriteTimeout: 15,
NosServiceMaxIdleConnection: 500,
LogLevel: logger.LogLevel(logger.DEBUG),
Logger: logger.NewDefaultLogger(),
}
nosClient, err := nosclient.New(conf)
if err != nil {
fmt.Println(err.ERROR())
return
}
}
Attention
后面的示例代码默认您已经实例化了所需的 NosClient 对象, 不再赘述,后续的代码示例均需要将实例化的代码写入 main 函数