计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
态势感知 SA
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

ObsClient初始化(Go SDK)

更新时间:2024-09-05 GMT+08:00

功能说明

ObsClient是访问OBS服务的Go客户端,它为调用者提供一系列与OBS服务进行交互的接口,用于管理、操作桶(Bucket)和对象(Object)等OBS服务上的资源。使用OBS Go SDK向OBS发起请求,您需要初始化一个ObsClient实例,并根据需要调整客户端配置参数。

初始化方法

func New(ak, sk, endpoint string, configurers ...configurer) (*ObsClient, error)

参数描述

字段名

类型

约束

说明

ak

string

必选

访问密钥中的AK。

sk

string

必选

访问密钥中的SK。

endpoint

string

必选

连接OBS的服务地址。包含协议类型、域名(或IP)、端口号。示例:https://your-endpoint:443。(出于安全性考虑,建议使用https协议)

您可以从这里查看OBS当前开通的服务地址。

securityToken

string

可选

临时访问密钥中的SecurityToken。

configurers

configurer(obs包中的私有类型)

可选

一组用于配置ObsClient的参数,可进行连接超时时间、最大重试次数、最大连接数等配置。

可用的configurer

您可通过configurer(obs命名空间中的私有类型)对ObsClient进行配置,可用的configurer见下表:

创建方式

描述

建议值

WithSslVerifyAndPemCerts(sslVerify bool, pemCerts []byte)

配置验证服务端证书的参数。默认为不验证。

N/A

WithHeaderTimeout(headerTimeout int)

配置获取响应头的超时时间。默认为60秒。

[10,60]

WithMaxConnections(maxIdleConns int)

配置允许最大HTTP空闲连接数。默认为1000。

N/A

WithConnectTimeout(connectTimeout int)

配置建立HTTP/HTTPS连接的超时时间(单位:秒)。默认为60秒。

[10,60]

WithSocketTimeout(socketTimeout int)

配置读写数据的超时时间(单位:秒)。默认为60秒。

[10,60]

WithIdleConnTimeout(idleConnTimeout int)

配置空闲的HTTP连接在连接池中的超时时间(单位:秒)。默认为30秒。

默认

WithMaxRetryCount(maxRetryCount int)

配置HTTP/HTTPS连接异常时的请求重试次数。默认为3次。

[1,5]

WithProxyUrl(proxyUrl string)

配置HTTP代理。

N/A

WithCustomDomainName(cname bool)

是否通过自定义域名访问OBS服务。默认为false。

默认

WithHttpTransport(transport *http.Transport)

配置自定义的Transport。

默认

WithRequestContext(ctx context.Context)

配置每次HTTP请求的上下文。

N/A

WithMaxRedirectCount(maxRedirectCount int)

配置HTTP/HTTPS请求重定向的最大次数。默认为3次。

[1,5]

WithSecurityToken(securityToken string)

配置临时访问密钥中的SecurityToken

N/A

说明:
  • 建议值为N/A的表示需要根据实际情况进行设置。
  • 如网络状况不佳,建议增大WithConnectTimeout和WithSocketTimeout的值。

代码示例

  • 您可以通过New函数创建OBS客户端,永久访问密钥(AK/SK)创建OBS客户端示例代码如下:
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    // 引入依赖包
    import (
        obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
    )
    
    func main() {
        //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
        //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html。
        ak := os.Getenv("AccessKeyID")
        sk := os.Getenv("SecretAccessKey")
        // endpoint填写Bucket对应的Endpoint, 这里以中国-香港为例,其他地区请按实际情况填写。
        endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
        // 创建obsClient实例
        obsClient, err := obs.New(ak, sk, endPoint)
        if err == nil {
             // 使用访问OBS
    
             // 关闭obsClient
             obsClient.Close()
        }
    }
    
  • 携带代理proxy创建OBS客户端代码如下:
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    // 引入依赖包
    import (
           "obs"
    )
    
    func main() {
        //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
        //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html。
        ak := os.Getenv("AccessKeyID")
        sk := os.Getenv("SecretAccessKey")
        // endpoint填写Bucket对应的Endpoint, 这里以中国-香港为例,其他地区请按实际情况填写。
        endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
        // 创建obsClient实例
        obsClient, err := obs.New(ak, sk, endPoint, obs.WithProxyUrl("https://username:password!@yourProxy"))
        if err == nil {
             // 使用访问OBS
    
             // 关闭obsClient
             obsClient.Close()
        }
    }
    
  • 临时访问密钥(AK/SK和SecurityToken)创建OBS客户端代码如下:
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    // 引入依赖包
    import (
        obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
    )
    
    func main() {
        //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
        //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/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.ap-southeast-1.myhuaweicloud.com"
        // 创建obsClient实例
        // 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
        obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
        if err == nil {
             // 使用访问OBS
    
             // 关闭obsClient
             obsClient.Close()
        }
    }
    
  • 您还可以通过配置系统环境变量的方式或者通过访问ECS服务器获取临时访问密钥的方式创建OBS客户端。
    • 从环境变量中获取访问密钥创建OBS客户端的代码如下:
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      // 引入依赖包
      import (
          obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
      )
      
      func main() {
          //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
          //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/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.ap-southeast-1.myhuaweicloud.com"
          // 创建obsClient实例
          // 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
          obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityProviders(obs.NewEnvSecurityProvider(""))
          if err == nil {
               // 使用访问OBS
      
               // 关闭obsClient
               obsClient.Close()
          }
      }
      
      说明:

      以上方式会从当前系统的环境变量中寻找访问密钥,需要对应在环境变量中定义OBS_ACCESS_KEY_ID、OBS_SECRET_ACCESS_KEY字段。同时如果采用临时访问密钥时,还需要在环境变量中定义OBS_SECURITY_TOKEN字段。

    • 从ECS获取临时访问密钥创建OBS客户端的代码如下:
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      // 引入依赖包
      import (
          obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
      )
      
      func main() {
          //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
          //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/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.ap-southeast-1.myhuaweicloud.com"
          // 创建obsClient实例
          // 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
          obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityProviders(obs.NewEcsSecurityProvider(1))
          if err == nil {
               // 使用访问OBS
      
               // 关闭obsClient
               obsClient.Close()
          }
      }
      
      说明:

      当应用程序部署在ECS服务器上且该ECS绑定了相关委托项时,可以采用以上方式从ECS服务器上自动获取临时访问密钥。

    • 使用链式方式从系统环境变量及ECS上获取访问密钥创建OBS客户端的代码如下:
       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
      // 引入依赖包
      import (
          obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
      )
      
      func main() {
          //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
          //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/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.ap-southeast-1.myhuaweicloud.com"
          // 创建obsClient实例
          // 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
          obsClient, err := obs.New(ak, sk, endPoint,
            obs.WithSecurityProviders(obs.NewEnvSecurityProvider(""), obs.NewEcsSecurityProvider(1)) 
          )
          if err == nil {
               // 使用访问OBS
      
               // 关闭obsClient
               obsClient.Close()
          }
      }
      
      说明:

      以上初始化过程指定以链式的方式从环境变量和ECS中顺序获取访问密钥,并采用第一组成功获取到的访问密钥创建obsClient。

说明:
  • 您的工程中可以有多个ObsClient,也可以只有一个ObsClient。
  • ObsClient是协程安全的,可在并发场景下使用。
  • ObsClient在调用ObsClient.close方法关闭后不能再次使用。
  • 您可以通过调用WithHttpTransport传入自定义Transport实现指定单Host最大连接数的功能,示例代码如下:
     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
    // 引入依赖包
    import (
           "time"
        obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
    )
    
    // 创建ObsClient结构体
    var obsClient, err = obs.New(ak, sk, endpoint, obs.WithHttpTransport(transport))
    
    func main() {
        //推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险。
        //您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/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.ap-southeast-1.myhuaweicloud.com"
        // 初始化自定义transport
        var maxIdleConns = 1000
        var maxConnsPerHost = 1000
        var idleConnTimeout = 30
        var transport = &http.Transport{
            MaxIdleConns:        maxIdleConns,
            MaxIdleConnsPerHost: maxIdleConns,
            MaxConnsPerHost:     maxConnsPerHost,
            IdleConnTimeout:     time.Second * time.Duration(idleConnTimeout),
        }
        // 创建obsClient实例
        // 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
        obsClient, err := obs.New(ak, sk, endPoint,obs.WithHttpTransport(transport))
    
        if err == nil {
            // 使用访问OBS
            // 关闭obsClient
            obsClient.Close()
        }
    }
    
    须知:
    • 只有在Golang 1.11以上的版本中才支持在Transport结构中指定MaxConnsPerHost参数。
    • 如果指定了自定义的Transport,则无法通过WithMaxConnections、WithProxyUrl等配置方法配置Transport相关的最大空闲连接数、代理配置等参数,对应参数应直接在自定义Transport中指定。

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容