# 快速入门(Go SDK)
#### 准备访问密钥
OBS通过用户账户中的AK和SK进行签名验证，确保通过授权的账户才能访问指定的OBS资源。以下是对AK和SK的解释说明：
- AK：Access Key ID，接入键标识，用户在对象存储服务系统中的接入键标识，一个接入键标识唯一对应一个用户，一个用户可以同时拥有多个接入键标识。对象存储服务系统通过接入键标识识别访问系统的用户。
- SK：Secret Access Key，安全接入键，用户在对象存储服务系统中的安全接入键，是用户访问对象存储服务系统的密钥，用户根据安全接入键和请求头域生成鉴权信息。安全接入键和接入键标识一一对应。
访问密钥分永久访问密钥（AK/SK）和临时访问密钥（AK/SK和SecurityToken）两种。每个用户最多可创建两个有效的永久访问密钥。临时访问密钥只在设置的有效期内能够访问OBS，过期后需要重新获取。出于安全性考虑，建议您使用临时访问密钥访问OBS，或使用永久访问密钥访问OBS时，定期更新您的访问密钥（AK/SK）。两种密钥的获取方式如下所示。
1. 登录[管理控制台](https://console.huaweicloud.com)。
2. 单击页面右上角的用户名，并选择"我的凭证"。
3. 在"我的凭证"页面，单击左侧导航栏的"访问密钥"。
4. 在"访问密钥"页面，单击"新增访问密钥"。
   ![](https://support.huaweicloud.com/sdk-go-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
   每个用户最多可创建两个有效的访问密钥。
   
5. 在弹出的"新增访问密钥"对话框中，输入描述内容（建议），单击"确定"。
6. （可选）在弹出的"身份验证"对话框中，选择合适的验证方式进行验证，单击"确定"。
7. 在弹出的"创建成功"提示框中，单击"立即下载"后，密钥会直接保存到浏览器默认的下载文件夹中。
8. 打开下载下来的"credentials.csv"文件即可获取到访问密钥（AK和SK）。
![](https://support.huaweicloud.com/sdk-go-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
- 在密钥文件中，Access Key ID列对应的值即AK，Secret Access Key列对应的值即SK。
- 为防止访问密钥泄露，建议您将其保存到安全的位置。如果用户在此提示框中单击"取消"，则不会下载密钥，后续也将无法重新下载。如果需要使用访问密钥，可以重新创建新的访问密钥。
 
#### 获取服务地址
- 您可以从[这里](https://developer.huaweicloud.com/endpoint?OBS)查看OBS当前开通的服务地址和区域信息。
![](https://support.huaweicloud.com/sdk-go-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
SDK支持带协议名和不带协议名两种方式传入服务地址，例如获取到的服务地址为"your-endpoint"，则初始化OBS客户端时传入的服务地址可以为"http://your-endpoint"、"https://your-endpoint"和"your-endpoint"三种形式。
#### 初始化OBS客户端
向OBS发送任一HTTP/HTTPS请求之前，必须先创建一个ObsClient结构体：
```
package main
// 引入依赖包
import (
    "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 {
        // 使用访问OBS
        // 关闭obsClient
        obsClient.Close()
    }
}
```
![](https://support.huaweicloud.com/sdk-go-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
- 更多关于OBS客户端初始化的内容请参考"初始化"章节。
- 日志配置详见[日志初始化](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0103.html)。
- 如果设置的endpoint不带协议类型，则默认使用HTTPS协议。
- 出于DNS解析性能和OBS服务可靠性的考虑，不允许将endpoint设置为IP，必须使用域名访问OBS服务。
 
#### 创建桶
桶是OBS全局命名空间，相当于数据的容器、文件系统的根目录，可以存储若干对象。
本示例用于创建名为examplebucket的桶，并设置所在区域在华北-北京四（cn-north-4），桶ACL是私有桶，存储类型是低频访问存储，多AZ方式存储。
```
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.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.CreateBucketInput{}
    // 指定存储桶名称
    input.Bucket = "examplebucket"
    // 指定存储桶所在区域，此处以“cn-north-4”为例，必须跟传入的Endpoint中Region保持一致。
    input.Location = "cn-north-4"
    // 指定存储桶ACL，此处以obs.AclPrivate为例。
    input.ACL = obs.AclPrivate
    // 指定存储桶的存储类型，此处以obs.StorageClassWarm为例。如果未指定该参数，则创建的桶为标准存储类型（StorageClassStandard）。
    input.StorageClass = obs.StorageClassWarm
    // 指定存储桶的AZ类型，此处以“3az”为例。不携带时默认为单AZ，如果对应region不支持多AZ存储，则该桶的存储类型仍为单AZ。
    input.AvailableZone = "3az"
    // 创建桶
    output, err := obsClient.CreateBucket(input)
    if err == nil {
        fmt.Printf("Create bucket:%s successful!\n", input.Bucket)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        return
    }
    fmt.Printf("Create bucket:%s fail!\n", input.Bucket)
    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)
    }
}
```
![](https://support.huaweicloud.com/sdk-go-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
- 桶命名规则如下：
  - 需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。用户删除桶后，立即创建同名桶或并行文件系统会创建失败，需要等待30分钟才能创建。
  
  - 长度范围为3到63个字符，仅支持小写字母、数字、中划线（-）、英文句号（.）。
  
  - 禁止两个英文句号（.）相邻，禁止英文句号（.）和中划线（-）相邻，禁止以英文句号（.）和中划线（-）开头或结尾。
  
  - 禁止使用IP地址。
   

- 同一用户多次创建同名桶不会报错，创建的桶属性以第一次请求为准。
- 更多创建桶的信息，请参见[创建桶](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0402.html)。
 
![](https://support.huaweicloud.com/sdk-go-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
创建桶时，如果使用的终端节点归属于默认区域华北-北京一（cn-north-1），则可以不指定区域；如果使用的终端节点归属于其他区域，则必须指定区域（指定方法参见[带参数创建](https://support.huaweicloud.com/sdk-go-devg-obs/obs_33_0402.html)），且指定的区域必须与终端节点归属的区域一致。当前有效的区域名称可从[这里](https://developer.huaweicloud.com/endpoint?OBS)查询。
#### 上传对象
完成桶创建后，您可以往桶中上传对象。
本示例用于将本地localfile文件上传到examplebucket桶中的example/objectname对象。
```
package main
import (
    "fmt"
    "os"
)
func main() {
    // 推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    // 您可以登录访问管理控制台获取访问密钥AK/SK。
    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.WithSecurityToken(securityToken))
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.PutFileInput{}
    // 指定存储桶名称
    input.Bucket = "examplebucket"
    // 指定上传对象，此处以 example/objectname 为例。
    input.Key = "example/objectname"
    // 指定本地文件，此处以localfile为例
    input.SourceFile = "localfile"
    // 文件上传
    output, err := obsClient.PutFile(input)
    if err == nil {
        fmt.Printf("Put file(%s) under the bucket(%s) successful!\n", input.Key, input.Bucket)
        fmt.Printf("StorageClass:%s, ETag:%s\n",
            output.StorageClass, output.ETag)
        return
    }
    fmt.Printf("Put file(%s) under the bucket(%s) fail!\n", input.Key, input.Bucket)
    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)
    }
}
```
![](https://support.huaweicloud.com/sdk-go-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
更多上传对象的信息，请参见[上传对象](https://support.huaweicloud.com/sdk-go-devg-obs/obs_23_0401.html)。