client.go 25 KB

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