client.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748
  1. // Package oss implements functions for access oss service.
  2. // It has two main struct Client and Bucket.
  3. package oss
  4. import (
  5. "bytes"
  6. "encoding/xml"
  7. "io"
  8. "net/http"
  9. "strings"
  10. "time"
  11. )
  12. //
  13. // Client Sdk的入口,Client的方法可以完成bucket的各种操作,如create/delete bucket,
  14. // set/get acl/lifecycle/referer/logging/website等。文件(object)的上传下载通过Bucket完成。
  15. // 用户用oss.New创建Client。
  16. //
  17. type (
  18. // Client oss client
  19. Client struct {
  20. Config *Config // Oss Client configure
  21. Conn *Conn // Send http request
  22. }
  23. // ClientOption client option such as UseCname, Timeout, SecurityToken.
  24. ClientOption func(*Client)
  25. )
  26. //
  27. // New 生成一个新的Client。
  28. //
  29. // endpoint 用户Bucket所在数据中心的访问域名,如http://oss-cn-hangzhou.aliyuncs.com。
  30. // accessKeyId 用户标识。
  31. // accessKeySecret 用户密钥。
  32. //
  33. // Client 生成的新Client。error为nil时有效。
  34. // error 操作无错误时为nil,非nil时表示操作出错。
  35. //
  36. func New(endpoint, accessKeyID, accessKeySecret string, options ...ClientOption) (*Client, error) {
  37. // configuration
  38. config := getDefaultOssConfig()
  39. config.Endpoint = endpoint
  40. config.AccessKeyID = accessKeyID
  41. config.AccessKeySecret = accessKeySecret
  42. // url parse
  43. url := &urlMaker{}
  44. url.Init(config.Endpoint, config.IsCname, config.IsUseProxy)
  45. // http connect
  46. conn := &Conn{config: config, url: url}
  47. // oss client
  48. client := &Client{
  49. config,
  50. conn,
  51. }
  52. // client options parse
  53. for _, option := range options {
  54. option(client)
  55. }
  56. // create http connect
  57. err := conn.init(config, url)
  58. return client, err
  59. }
  60. //
  61. // Bucket 取存储空间(Bucket)的对象实例。
  62. //
  63. // bucketName 存储空间名称。
  64. // Bucket 新的Bucket。error为nil时有效。
  65. //
  66. // error 操作无错误时返回nil,非nil为错误信息。
  67. //
  68. func (client Client) Bucket(bucketName string) (*Bucket, error) {
  69. return &Bucket{
  70. client,
  71. bucketName,
  72. }, nil
  73. }
  74. //
  75. // CreateBucket 创建Bucket。
  76. //
  77. // bucketName bucket名称,在整个OSS中具有全局唯一性,且不能修改。bucket名称的只能包括小写字母,数字和短横线-,
  78. // 必须以小写字母或者数字开头,长度必须在3-255字节之间。
  79. // options 创建bucket的选项。您可以使用选项ACL,指定bucket的访问权限。Bucket有以下三种访问权限,私有读写(ACLPrivate)、
  80. // 公共读私有写(ACLPublicRead),公共读公共写(ACLPublicReadWrite),默认访问权限是私有读写。
  81. //
  82. // error 操作无错误时返回nil,非nil为错误信息。
  83. //
  84. func (client Client) CreateBucket(bucketName string, options ...Option) error {
  85. headers := make(map[string]string)
  86. handleOptions(headers, options)
  87. resp, err := client.do("PUT", bucketName, "", "", headers, nil)
  88. if err != nil {
  89. return err
  90. }
  91. defer resp.Body.Close()
  92. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  93. }
  94. //
  95. // ListBuckets 获取当前用户下的bucket。
  96. //
  97. // options 指定ListBuckets的筛选行为,Prefix、Marker、MaxKeys三个选项。Prefix限定前缀。
  98. // Marker设定从Marker之后的第一个开始返回。MaxKeys限定此次返回的最大数目,默认为100。
  99. // 常用使用场景的实现,参数示例程序list_bucket.go。
  100. // ListBucketsResponse 操作成功后的返回值,error为nil时该返回值有效。
  101. //
  102. // error 操作无错误时返回nil,非nil为错误信息。
  103. //
  104. func (client Client) ListBuckets(options ...Option) (ListBucketsResult, error) {
  105. var out ListBucketsResult
  106. params, err := handleParams(options)
  107. if err != nil {
  108. return out, err
  109. }
  110. resp, err := client.do("GET", "", params, "", nil, nil)
  111. if err != nil {
  112. return out, err
  113. }
  114. defer resp.Body.Close()
  115. err = xmlUnmarshal(resp.Body, &out)
  116. return out, err
  117. }
  118. //
  119. // IsBucketExist Bucket是否存在。
  120. //
  121. // bucketName 存储空间名称。
  122. //
  123. // bool 存储空间是否存在。error为nil时有效。
  124. // error 操作无错误时返回nil,非nil为错误信息。
  125. //
  126. func (client Client) IsBucketExist(bucketName string) (bool, error) {
  127. listRes, err := client.ListBuckets(Prefix(bucketName), MaxKeys(1))
  128. if err != nil {
  129. return false, err
  130. }
  131. if len(listRes.Buckets) == 1 && listRes.Buckets[0].Name == bucketName {
  132. return true, nil
  133. }
  134. return false, nil
  135. }
  136. //
  137. // DeleteBucket 删除空存储空间。非空时请先清理Object、Upload。
  138. //
  139. // bucketName 存储空间名称。
  140. //
  141. // error 操作无错误时返回nil,非nil为错误信息。
  142. //
  143. func (client Client) DeleteBucket(bucketName string) error {
  144. resp, err := client.do("DELETE", bucketName, "", "", nil, nil)
  145. if err != nil {
  146. return err
  147. }
  148. defer resp.Body.Close()
  149. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  150. }
  151. //
  152. // GetBucketLocation 查看Bucket所属数据中心位置的信息。
  153. //
  154. // 如果您想了解"访问域名和数据中心"详细信息,请参看
  155. // https://help.aliyun.com/document_detail/oss/user_guide/oss_concept/endpoint.html
  156. //
  157. // bucketName 存储空间名称。
  158. //
  159. // string Bucket所属的数据中心位置信息。
  160. // error 操作无错误时返回nil,非nil为错误信息。
  161. //
  162. func (client Client) GetBucketLocation(bucketName string) (string, error) {
  163. resp, err := client.do("GET", bucketName, "location", "location", nil, nil)
  164. if err != nil {
  165. return "", err
  166. }
  167. defer resp.Body.Close()
  168. var LocationConstraint string
  169. err = xmlUnmarshal(resp.Body, &LocationConstraint)
  170. return LocationConstraint, err
  171. }
  172. //
  173. // SetBucketACL 修改Bucket的访问权限。
  174. //
  175. // bucketName 存储空间名称。
  176. // bucketAcl bucket的访问权限。Bucket有以下三种访问权限,Bucket有以下三种访问权限,私有读写(ACLPrivate)、
  177. // 公共读私有写(ACLPublicRead),公共读公共写(ACLPublicReadWrite)。
  178. //
  179. // error 操作无错误时返回nil,非nil为错误信息。
  180. //
  181. func (client Client) SetBucketACL(bucketName string, bucketACL ACLType) error {
  182. headers := map[string]string{HTTPHeaderOssACL: string(bucketACL)}
  183. resp, err := client.do("PUT", bucketName, "", "", headers, nil)
  184. if err != nil {
  185. return err
  186. }
  187. defer resp.Body.Close()
  188. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  189. }
  190. //
  191. // GetBucketACL 获得Bucket的访问权限。
  192. //
  193. // bucketName 存储空间名称。
  194. //
  195. // GetBucketAclResponse 操作成功后的返回值,error为nil时该返回值有效。
  196. // error 操作无错误时返回nil,非nil为错误信息。
  197. //
  198. func (client Client) GetBucketACL(bucketName string) (GetBucketACLResult, error) {
  199. var out GetBucketACLResult
  200. resp, err := client.do("GET", bucketName, "acl", "acl", nil, nil)
  201. if err != nil {
  202. return out, err
  203. }
  204. defer resp.Body.Close()
  205. err = xmlUnmarshal(resp.Body, &out)
  206. return out, err
  207. }
  208. //
  209. // SetBucketLifecycle 修改Bucket的生命周期设置。
  210. //
  211. // OSS提供Object生命周期管理来为用户管理对象。用户可以为某个Bucket定义生命周期配置,来为该Bucket的Object定义各种规则。
  212. // Bucket的拥有者可以通过SetBucketLifecycle来设置Bucket的Lifecycle配置。Lifecycle开启后,OSS将按照配置,
  213. // 定期自动删除与Lifecycle规则相匹配的Object。如果您想了解更多的生命周期的信息,请参看
  214. // https://help.aliyun.com/document_detail/oss/user_guide/manage_object/object_lifecycle.html
  215. //
  216. // bucketName 存储空间名称。
  217. // rules 生命周期规则列表。生命周期规则有两种格式,指定绝对和相对过期时间,分布由days和year/month/day控制。
  218. // 具体用法请参考示例程序sample/bucket_lifecycle.go。
  219. //
  220. // error 操作无错误时返回error为nil,非nil为错误信息。
  221. //
  222. func (client Client) SetBucketLifecycle(bucketName string, rules []LifecycleRule) error {
  223. lxml := lifecycleXML{Rules: convLifecycleRule(rules)}
  224. bs, err := xml.Marshal(lxml)
  225. if err != nil {
  226. return err
  227. }
  228. buffer := new(bytes.Buffer)
  229. buffer.Write(bs)
  230. contentType := http.DetectContentType(buffer.Bytes())
  231. headers := map[string]string{}
  232. headers[HTTPHeaderContentType] = contentType
  233. resp, err := client.do("PUT", bucketName, "lifecycle", "lifecycle", headers, buffer)
  234. if err != nil {
  235. return err
  236. }
  237. defer resp.Body.Close()
  238. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  239. }
  240. //
  241. // DeleteBucketLifecycle 删除Bucket的生命周期设置。
  242. //
  243. //
  244. // bucketName 存储空间名称。
  245. //
  246. // error 操作无错误为nil,非nil为错误信息。
  247. //
  248. func (client Client) DeleteBucketLifecycle(bucketName string) error {
  249. resp, err := client.do("DELETE", bucketName, "lifecycle", "lifecycle", nil, nil)
  250. if err != nil {
  251. return err
  252. }
  253. defer resp.Body.Close()
  254. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  255. }
  256. //
  257. // GetBucketLifecycle 查看Bucket的生命周期设置。
  258. //
  259. // bucketName 存储空间名称。
  260. //
  261. // GetBucketLifecycleResponse 操作成功的返回值,error为nil时该返回值有效。Rules为该bucket上的规则列表。
  262. // error 操作无错误时为nil,非nil为错误信息。
  263. //
  264. func (client Client) GetBucketLifecycle(bucketName string) (GetBucketLifecycleResult, error) {
  265. var out GetBucketLifecycleResult
  266. resp, err := client.do("GET", bucketName, "lifecycle", "lifecycle", nil, nil)
  267. if err != nil {
  268. return out, err
  269. }
  270. defer resp.Body.Close()
  271. err = xmlUnmarshal(resp.Body, &out)
  272. return out, err
  273. }
  274. //
  275. // SetBucketReferer 设置bucket的referer访问白名单和是否允许referer字段为空的请求访问。
  276. //
  277. // 防止用户在OSS上的数据被其他人盗用,OSS支持基于HTTP header中表头字段referer的防盗链方法。可以通过OSS控制台或者API的方式对
  278. // 一个bucket设置referer字段的白名单和是否允许referer字段为空的请求访问。例如,对于一个名为oss-example的bucket,
  279. // 设置其referer白名单为http://www.aliyun.com。则所有referer为http://www.aliyun.com的请求才能访问oss-example
  280. // 这个bucket中的object。如果您还需要了解更多信息,请参看
  281. // https://help.aliyun.com/document_detail/oss/user_guide/security_management/referer.html
  282. //
  283. // bucketName 存储空间名称。
  284. // referers 访问白名单列表。一个bucket可以支持多个referer参数。referer参数支持通配符"*"和"?"。
  285. // 用法请参看示例sample/bucket_referer.go
  286. // allowEmptyReferer 指定是否允许referer字段为空的请求访问。 默认为true。
  287. //
  288. // error 操作无错误为nil,非nil为错误信息。
  289. //
  290. func (client Client) SetBucketReferer(bucketName string, referers []string, allowEmptyReferer bool) error {
  291. rxml := RefererXML{}
  292. rxml.AllowEmptyReferer = allowEmptyReferer
  293. if referers == nil {
  294. rxml.RefererList = append(rxml.RefererList, "")
  295. } else {
  296. for _, referer := range referers {
  297. rxml.RefererList = append(rxml.RefererList, referer)
  298. }
  299. }
  300. bs, err := xml.Marshal(rxml)
  301. if err != nil {
  302. return err
  303. }
  304. buffer := new(bytes.Buffer)
  305. buffer.Write(bs)
  306. contentType := http.DetectContentType(buffer.Bytes())
  307. headers := map[string]string{}
  308. headers[HTTPHeaderContentType] = contentType
  309. resp, err := client.do("PUT", bucketName, "referer", "referer", headers, buffer)
  310. if err != nil {
  311. return err
  312. }
  313. defer resp.Body.Close()
  314. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  315. }
  316. //
  317. // GetBucketReferer 获得Bucket的白名单地址。
  318. //
  319. // bucketName 存储空间名称。
  320. //
  321. // GetBucketRefererResponse 操作成功的返回值,error为nil时该返回值有效。
  322. // error 操作无错误时为nil,非nil为错误信息。
  323. //
  324. func (client Client) GetBucketReferer(bucketName string) (GetBucketRefererResult, error) {
  325. var out GetBucketRefererResult
  326. resp, err := client.do("GET", bucketName, "referer", "referer", nil, nil)
  327. if err != nil {
  328. return out, err
  329. }
  330. defer resp.Body.Close()
  331. err = xmlUnmarshal(resp.Body, &out)
  332. return out, err
  333. }
  334. //
  335. // SetBucketLogging 修改Bucket的日志设置。
  336. //
  337. // OSS为您提供自动保存访问日志记录功能。Bucket的拥有者可以开启访问日志记录功能。当一个bucket开启访问日志记录功能后,
  338. // OSS自动将访问这个bucket的请求日志,以小时为单位,按照固定的命名规则,生成一个Object写入用户指定的bucket中。
  339. // 如果您需要更多,请参看 https://help.aliyun.com/document_detail/oss/user_guide/security_management/logging.html
  340. //
  341. // bucketName 需要记录访问日志的Bucket。
  342. // targetBucket 访问日志记录到的Bucket。
  343. // targetPrefix bucketName中需要存储访问日志记录的object前缀。为空记录所有object的访问日志。
  344. //
  345. // error 操作无错误为nil,非nil为错误信息。
  346. //
  347. func (client Client) SetBucketLogging(bucketName, targetBucket, targetPrefix string,
  348. isEnable bool) error {
  349. var err error
  350. var bs []byte
  351. if isEnable {
  352. lxml := LoggingXML{}
  353. lxml.LoggingEnabled.TargetBucket = targetBucket
  354. lxml.LoggingEnabled.TargetPrefix = targetPrefix
  355. bs, err = xml.Marshal(lxml)
  356. } else {
  357. lxml := loggingXMLEmpty{}
  358. bs, err = xml.Marshal(lxml)
  359. }
  360. if err != nil {
  361. return err
  362. }
  363. buffer := new(bytes.Buffer)
  364. buffer.Write(bs)
  365. contentType := http.DetectContentType(buffer.Bytes())
  366. headers := map[string]string{}
  367. headers[HTTPHeaderContentType] = contentType
  368. resp, err := client.do("PUT", bucketName, "logging", "logging", headers, buffer)
  369. if err != nil {
  370. return err
  371. }
  372. defer resp.Body.Close()
  373. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  374. }
  375. //
  376. // DeleteBucketLogging 删除Bucket的日志设置。
  377. //
  378. // bucketName 需要删除访问日志的Bucket。
  379. //
  380. // error 操作无错误为nil,非nil为错误信息。
  381. //
  382. func (client Client) DeleteBucketLogging(bucketName string) error {
  383. resp, err := client.do("DELETE", bucketName, "logging", "logging", nil, nil)
  384. if err != nil {
  385. return err
  386. }
  387. defer resp.Body.Close()
  388. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  389. }
  390. //
  391. // GetBucketLogging 获得Bucket的日志设置。
  392. //
  393. // bucketName 需要删除访问日志的Bucket。
  394. // GetBucketLoggingResponse 操作成功的返回值,error为nil时该返回值有效。
  395. //
  396. // error 操作无错误为nil,非nil为错误信息。
  397. //
  398. func (client Client) GetBucketLogging(bucketName string) (GetBucketLoggingResult, error) {
  399. var out GetBucketLoggingResult
  400. resp, err := client.do("GET", bucketName, "logging", "logging", nil, nil)
  401. if err != nil {
  402. return out, err
  403. }
  404. defer resp.Body.Close()
  405. err = xmlUnmarshal(resp.Body, &out)
  406. return out, err
  407. }
  408. //
  409. // SetBucketWebsite 设置/修改Bucket的默认首页以及错误页。
  410. //
  411. // OSS支持静态网站托管,Website操作可以将一个bucket设置成静态网站托管模式 。您可以将自己的Bucket配置成静态网站托管模式。
  412. // 如果您需要更多,请参看 https://help.aliyun.com/document_detail/oss/user_guide/static_host_website.html
  413. //
  414. // bucketName 需要设置Website的Bucket。
  415. // indexDocument 索引文档。
  416. // errorDocument 错误文档。
  417. //
  418. // error 操作无错误为nil,非nil为错误信息。
  419. //
  420. func (client Client) SetBucketWebsite(bucketName, indexDocument, errorDocument string) error {
  421. wxml := WebsiteXML{}
  422. wxml.IndexDocument.Suffix = indexDocument
  423. wxml.ErrorDocument.Key = errorDocument
  424. bs, err := xml.Marshal(wxml)
  425. if err != nil {
  426. return err
  427. }
  428. buffer := new(bytes.Buffer)
  429. buffer.Write(bs)
  430. contentType := http.DetectContentType(buffer.Bytes())
  431. headers := make(map[string]string)
  432. headers[HTTPHeaderContentType] = contentType
  433. resp, err := client.do("PUT", bucketName, "website", "website", headers, buffer)
  434. if err != nil {
  435. return err
  436. }
  437. defer resp.Body.Close()
  438. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  439. }
  440. //
  441. // DeleteBucketWebsite 删除Bucket的Website设置。
  442. //
  443. // bucketName 需要删除website设置的Bucket。
  444. //
  445. // error 操作无错误为nil,非nil为错误信息。
  446. //
  447. func (client Client) DeleteBucketWebsite(bucketName string) error {
  448. resp, err := client.do("DELETE", bucketName, "website", "website", nil, nil)
  449. if err != nil {
  450. return err
  451. }
  452. defer resp.Body.Close()
  453. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  454. }
  455. //
  456. // GetBucketWebsite 获得Bucket的默认首页以及错误页。
  457. //
  458. // bucketName 存储空间名称。
  459. //
  460. // GetBucketWebsiteResponse 操作成功的返回值,error为nil时该返回值有效。
  461. // error 操作无错误为nil,非nil为错误信息。
  462. //
  463. func (client Client) GetBucketWebsite(bucketName string) (GetBucketWebsiteResult, error) {
  464. var out GetBucketWebsiteResult
  465. resp, err := client.do("GET", bucketName, "website", "website", nil, nil)
  466. if err != nil {
  467. return out, err
  468. }
  469. defer resp.Body.Close()
  470. err = xmlUnmarshal(resp.Body, &out)
  471. return out, err
  472. }
  473. //
  474. // SetBucketCORS 设置Bucket的跨域访问(CORS)规则。
  475. //
  476. // 跨域访问的更多信息,请参看 https://help.aliyun.com/document_detail/oss/user_guide/security_management/cors.html
  477. //
  478. // bucketName 需要设置Website的Bucket。
  479. // corsRules 待设置的CORS规则。用法请参看示例代码sample/bucket_cors.go。
  480. //
  481. // error 操作无错误为nil,非nil为错误信息。
  482. //
  483. func (client Client) SetBucketCORS(bucketName string, corsRules []CORSRule) error {
  484. corsxml := CORSXML{}
  485. for _, v := range corsRules {
  486. cr := CORSRule{}
  487. cr.AllowedMethod = v.AllowedMethod
  488. cr.AllowedOrigin = v.AllowedOrigin
  489. cr.AllowedHeader = v.AllowedHeader
  490. cr.ExposeHeader = v.ExposeHeader
  491. cr.MaxAgeSeconds = v.MaxAgeSeconds
  492. corsxml.CORSRules = append(corsxml.CORSRules, cr)
  493. }
  494. bs, err := xml.Marshal(corsxml)
  495. if err != nil {
  496. return err
  497. }
  498. buffer := new(bytes.Buffer)
  499. buffer.Write(bs)
  500. contentType := http.DetectContentType(buffer.Bytes())
  501. headers := map[string]string{}
  502. headers[HTTPHeaderContentType] = contentType
  503. resp, err := client.do("PUT", bucketName, "cors", "cors", headers, buffer)
  504. if err != nil {
  505. return err
  506. }
  507. defer resp.Body.Close()
  508. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  509. }
  510. //
  511. // DeleteBucketCORS 删除Bucket的Website设置。
  512. //
  513. // bucketName 需要删除cors设置的Bucket。
  514. //
  515. // error 操作无错误为nil,非nil为错误信息。
  516. //
  517. func (client Client) DeleteBucketCORS(bucketName string) error {
  518. resp, err := client.do("DELETE", bucketName, "cors", "cors", nil, nil)
  519. if err != nil {
  520. return err
  521. }
  522. defer resp.Body.Close()
  523. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  524. }
  525. //
  526. // GetBucketCORS 获得Bucket的CORS设置。
  527. //
  528. //
  529. // bucketName 存储空间名称。
  530. // GetBucketCORSResult 操作成功的返回值,error为nil时该返回值有效。
  531. //
  532. // error 操作无错误为nil,非nil为错误信息。
  533. //
  534. func (client Client) GetBucketCORS(bucketName string) (GetBucketCORSResult, error) {
  535. var out GetBucketCORSResult
  536. resp, err := client.do("GET", bucketName, "cors", "cors", nil, nil)
  537. if err != nil {
  538. return out, err
  539. }
  540. defer resp.Body.Close()
  541. err = xmlUnmarshal(resp.Body, &out)
  542. return out, err
  543. }
  544. //
  545. // GetBucketInfo 获得Bucket的信息。
  546. //
  547. // bucketName 存储空间名称。
  548. // GetBucketInfoResult 操作成功的返回值,error为nil时该返回值有效。
  549. //
  550. // error 操作无错误为nil,非nil为错误信息。
  551. //
  552. func (client Client) GetBucketInfo(bucketName string) (GetBucketInfoResult, error) {
  553. var out GetBucketInfoResult
  554. resp, err := client.do("GET", bucketName, "bucketInfo", "bucketInfo", nil, nil)
  555. if err != nil {
  556. return out, err
  557. }
  558. defer resp.Body.Close()
  559. err = xmlUnmarshal(resp.Body, &out)
  560. return out, err
  561. }
  562. //
  563. // UseCname 设置是否使用CNAME,默认不使用。
  564. //
  565. // isUseCname true设置endpoint格式是cname格式,false为非cname格式,默认false
  566. //
  567. func UseCname(isUseCname bool) ClientOption {
  568. return func(client *Client) {
  569. client.Config.IsCname = isUseCname
  570. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  571. }
  572. }
  573. //
  574. // Timeout 设置HTTP超时时间。
  575. //
  576. // connectTimeoutSec HTTP链接超时时间,单位是秒,默认10秒。0表示永不超时。
  577. // readWriteTimeout HTTP发送接受数据超时时间,单位是秒,默认20秒。0表示永不超时。
  578. //
  579. func Timeout(connectTimeoutSec, readWriteTimeout int64) ClientOption {
  580. return func(client *Client) {
  581. client.Config.HTTPTimeout.ConnectTimeout =
  582. time.Second * time.Duration(connectTimeoutSec)
  583. client.Config.HTTPTimeout.ReadWriteTimeout =
  584. time.Second * time.Duration(readWriteTimeout)
  585. client.Config.HTTPTimeout.HeaderTimeout =
  586. time.Second * time.Duration(readWriteTimeout)
  587. client.Config.HTTPTimeout.LongTimeout =
  588. time.Second * time.Duration(readWriteTimeout*10)
  589. }
  590. }
  591. //
  592. // SecurityToken 临时用户设置SecurityToken。
  593. //
  594. // token STS token
  595. //
  596. func SecurityToken(token string) ClientOption {
  597. return func(client *Client) {
  598. client.Config.SecurityToken = strings.TrimSpace(token)
  599. }
  600. }
  601. //
  602. // EnableMD5 是否启用MD5校验,默认启用。
  603. //
  604. // isEnableMD5 true启用MD5校验,false不启用MD5校验
  605. //
  606. func EnableMD5(isEnableMD5 bool) ClientOption {
  607. return func(client *Client) {
  608. client.Config.IsEnableMD5 = isEnableMD5
  609. }
  610. }
  611. //
  612. // MD5ThresholdCalcInMemory 使用内存计算MD5值的上限,默认16MB。
  613. //
  614. // threshold 单位Byte。上传内容小于threshold在MD5在内存中计算,大于使用临时文件计算MD5
  615. //
  616. func MD5ThresholdCalcInMemory(threshold int64) ClientOption {
  617. return func(client *Client) {
  618. client.Config.MD5Threshold = threshold
  619. }
  620. }
  621. //
  622. // EnableCRC 上传是否启用CRC校验,默认启用。
  623. //
  624. // isEnableCRC true启用CRC校验,false不启用CRC校验
  625. //
  626. func EnableCRC(isEnableCRC bool) ClientOption {
  627. return func(client *Client) {
  628. client.Config.IsEnableCRC = isEnableCRC
  629. }
  630. }
  631. //
  632. // UserAgent 指定UserAgent,默认如下aliyun-sdk-go/1.2.0 (windows/-/amd64;go1.5.2)。
  633. //
  634. // userAgent user agent字符串。
  635. //
  636. func UserAgent(userAgent string) ClientOption {
  637. return func(client *Client) {
  638. client.Config.UserAgent = userAgent
  639. }
  640. }
  641. //
  642. // Proxy 设置代理服务器,默认不使用代理。
  643. //
  644. // proxyHost 代理服务器地址,格式是host或host:port
  645. //
  646. func Proxy(proxyHost string) ClientOption {
  647. return func(client *Client) {
  648. client.Config.IsUseProxy = true
  649. client.Config.ProxyHost = proxyHost
  650. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  651. }
  652. }
  653. //
  654. // AuthProxy 设置需要认证的代理服务器,默认不使用代理。
  655. //
  656. // proxyHost 代理服务器地址,格式是host或host:port
  657. // proxyUser 代理服务器认证的用户名
  658. // proxyPassword 代理服务器认证的用户密码
  659. //
  660. func AuthProxy(proxyHost, proxyUser, proxyPassword string) ClientOption {
  661. return func(client *Client) {
  662. client.Config.IsUseProxy = true
  663. client.Config.ProxyHost = proxyHost
  664. client.Config.IsAuthProxy = true
  665. client.Config.ProxyUser = proxyUser
  666. client.Config.ProxyPassword = proxyPassword
  667. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  668. }
  669. }
  670. // Private
  671. func (client Client) do(method, bucketName, urlParams, subResource string,
  672. headers map[string]string, data io.Reader) (*Response, error) {
  673. return client.Conn.Do(method, bucketName, "", urlParams,
  674. subResource, headers, data, 0)
  675. }