client.go 26 KB

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