github.com/qiniu/go-sdk/v7@v7.27.0/pili/conf.go (about)

     1  package pili
     2  
     3  import (
     4  	"net/http"
     5  
     6  	"github.com/qiniu/go-sdk/v7/client"
     7  )
     8  
     9  const (
    10  	// APIHost 标准 API 服务器地址
    11  	APIHost = "pili.qiniuapi.com"
    12  
    13  	// IAMAPIHost IAM(权限策略) API 服务器地址
    14  	IAMAPIHost = "pili-iam.qiniuapi.com"
    15  
    16  	// APIHTTPScheme HTTP 模式
    17  	APIHTTPScheme = "http://"
    18  
    19  	// APIHTTPSScheme HTTPS 模式
    20  	APIHTTPSScheme = "https://"
    21  
    22  	// DefaultAppName 默认 AppName 名称
    23  	DefaultAppName = "pili"
    24  )
    25  
    26  // ManagerConfig 构建Manager的参数配置
    27  type ManagerConfig struct {
    28  	// AppName 用户自定义APP名称
    29  	// 命名规则遵循 [A-Za-z0-9_\ \-\.]*
    30  	// AppName 将在发送HTTP请求的User-Agent中体现
    31  	// 留空即使用默认值,默认 AppName 名称为 `pili`
    32  	AppName string
    33  
    34  	// APIHost 访问API的地址
    35  	// 标准账户 和 IAM(权限策略)账户 对应的 Host 不同,注意区分
    36  	// 留空即使用默认值,默认 APIHost 为 `pili.qiniuapi.com`
    37  	APIHost string
    38  
    39  	// APIHTTPScheme 访问API使用的HTTP模式
    40  	// 支持 APIHTTPScheme / APIHTTPSScheme 两种模式
    41  	// 留空即使用默认值,默认使用 `http://`
    42  	APIHTTPScheme string
    43  
    44  	// AccessKey 访问密钥
    45  	// 密钥对由 AccessKey(访问密钥) 和 SecretKey(安全密钥) 组成
    46  	// 每一个七牛账户最多拥有两对密钥,在七牛控制台 个人中心 - 密钥管理 中获取
    47  	// 密钥对用于API鉴权,会在HTTP请求的 Header Authorization 中携带鉴权签算信息
    48  	// 必填参数
    49  	AccessKey string
    50  
    51  	// SecretKey 安全密钥
    52  	// 必填参数
    53  	SecretKey string
    54  
    55  	// Transport 访问控制
    56  	// 支持外部传入自定义RoundTripper,用于HTTP代理/Context/超时控制等逻辑
    57  	// 留空即使用默认值,默认使用 http.DefaultTransport
    58  	Transport http.RoundTripper
    59  }
    60  
    61  // SetAppName 设置App名称
    62  // 命名规则遵循 [A-Za-z0-9_\ \-\.]*
    63  func SetAppName(appName string) {
    64  	if appName == "" {
    65  		appName = DefaultAppName
    66  	}
    67  	_ = client.SetAppName(appName)
    68  }