client.go 23 KB

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