client.go 32 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088
  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. "fmt"
  8. "io"
  9. "log"
  10. "net/http"
  11. "strings"
  12. "time"
  13. )
  14. // Client SDK's entry point. It's for bucket related options such as create/delete/set bucket (such as set/get ACL/lifecycle/referer/logging/website).
  15. // Object related operations are done by Bucket class.
  16. // Users use oss.New to create Client instance.
  17. //
  18. type (
  19. // Client OSS client
  20. Client struct {
  21. Config *Config // OSS client configuration
  22. Conn *Conn // Send HTTP request
  23. HTTPClient *http.Client //http.Client to use - if nil will make its own
  24. }
  25. // ClientOption client option such as UseCname, Timeout, SecurityToken.
  26. ClientOption func(*Client)
  27. )
  28. // New creates a new client.
  29. //
  30. // endpoint the OSS datacenter endpoint such as http://oss-cn-hangzhou.aliyuncs.com .
  31. // accessKeyId access key Id.
  32. // accessKeySecret access key secret.
  33. //
  34. // Client creates the new client instance, the returned value is valid when error is nil.
  35. // error it's nil if no error, otherwise it's an error object.
  36. //
  37. func New(endpoint, accessKeyID, accessKeySecret string, options ...ClientOption) (*Client, error) {
  38. // Configuration
  39. config := getDefaultOssConfig()
  40. config.Endpoint = endpoint
  41. config.AccessKeyID = accessKeyID
  42. config.AccessKeySecret = accessKeySecret
  43. // URL parse
  44. url := &urlMaker{}
  45. url.Init(config.Endpoint, config.IsCname, config.IsUseProxy)
  46. // HTTP connect
  47. conn := &Conn{config: config, url: url}
  48. // OSS client
  49. client := &Client{
  50. Config: config,
  51. Conn: conn,
  52. }
  53. // Client options parse
  54. for _, option := range options {
  55. option(client)
  56. }
  57. // Create HTTP connection
  58. err := conn.init(config, url, client.HTTPClient)
  59. return client, err
  60. }
  61. // Bucket gets the bucket instance.
  62. //
  63. // bucketName the bucket name.
  64. // Bucket the bucket object, when error is nil.
  65. //
  66. // error it's nil if no error, otherwise it's an error object.
  67. //
  68. func (client Client) Bucket(bucketName string) (*Bucket, error) {
  69. return &Bucket{
  70. client,
  71. bucketName,
  72. }, nil
  73. }
  74. // CreateBucket creates a bucket.
  75. //
  76. // bucketName the bucket name, it's globably unique and immutable. The bucket name can only consist of lowercase letters, numbers and dash ('-').
  77. // It must start with lowercase letter or number and the length can only be between 3 and 255.
  78. // options options for creating the bucket, with optional ACL. The ACL could be ACLPrivate, ACLPublicRead, and ACLPublicReadWrite. By default it's ACLPrivate.
  79. // It could also be specified with StorageClass option, which supports StorageStandard, StorageIA(infrequent access), StorageArchive.
  80. //
  81. // error it's nil if no error, otherwise it's an error object.
  82. //
  83. func (client Client) CreateBucket(bucketName string, options ...Option) error {
  84. headers := make(map[string]string)
  85. handleOptions(headers, options)
  86. buffer := new(bytes.Buffer)
  87. isOptSet, val, _ := isOptionSet(options, storageClass)
  88. if isOptSet {
  89. cbConfig := createBucketConfiguration{StorageClass: val.(StorageClassType)}
  90. bs, err := xml.Marshal(cbConfig)
  91. if err != nil {
  92. return err
  93. }
  94. buffer.Write(bs)
  95. contentType := http.DetectContentType(buffer.Bytes())
  96. headers[HTTPHeaderContentType] = contentType
  97. }
  98. params := map[string]interface{}{}
  99. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  100. // get response header
  101. respHeader, _ := findOption(options, responseHeader, nil)
  102. if respHeader != nil {
  103. pRespHeader := respHeader.(*http.Header)
  104. *pRespHeader = resp.Headers
  105. }
  106. if err != nil {
  107. return err
  108. }
  109. defer resp.Body.Close()
  110. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  111. }
  112. // ListBuckets lists buckets of the current account under the given endpoint, with optional filters.
  113. //
  114. // options specifies the filters such as Prefix, Marker and MaxKeys. Prefix is the bucket name's prefix filter.
  115. // And marker makes sure the returned buckets' name are greater than it in lexicographic order.
  116. // Maxkeys limits the max keys to return, and by default it's 100 and up to 1000.
  117. // For the common usage scenario, please check out list_bucket.go in the sample.
  118. // ListBucketsResponse the response object if error is nil.
  119. //
  120. // error it's nil if no error, otherwise it's an error object.
  121. //
  122. func (client Client) ListBuckets(options ...Option) (ListBucketsResult, error) {
  123. var out ListBucketsResult
  124. params, err := getRawParams(options)
  125. if err != nil {
  126. return out, err
  127. }
  128. resp, err := client.do("GET", "", params, nil, nil)
  129. // get response header
  130. respHeader, _ := findOption(options, responseHeader, nil)
  131. if respHeader != nil {
  132. pRespHeader := respHeader.(*http.Header)
  133. *pRespHeader = resp.Headers
  134. }
  135. if err != nil {
  136. return out, err
  137. }
  138. defer resp.Body.Close()
  139. err = xmlUnmarshal(resp.Body, &out)
  140. return out, err
  141. }
  142. // IsBucketExist checks if the bucket exists
  143. //
  144. // bucketName the bucket name.
  145. //
  146. // bool true if it exists, and it's only valid when error is nil.
  147. // error it's nil if no error, otherwise it's an error object.
  148. //
  149. func (client Client) IsBucketExist(bucketName string) (bool, error) {
  150. listRes, err := client.ListBuckets(Prefix(bucketName), MaxKeys(1))
  151. if err != nil {
  152. return false, err
  153. }
  154. if len(listRes.Buckets) == 1 && listRes.Buckets[0].Name == bucketName {
  155. return true, nil
  156. }
  157. return false, nil
  158. }
  159. // DeleteBucket deletes the bucket. Only empty bucket can be deleted (no object and parts).
  160. //
  161. // bucketName the bucket name.
  162. //
  163. // error it's nil if no error, otherwise it's an error object.
  164. //
  165. func (client Client) DeleteBucket(bucketName string) error {
  166. params := map[string]interface{}{}
  167. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  168. if err != nil {
  169. return err
  170. }
  171. defer resp.Body.Close()
  172. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  173. }
  174. // GetBucketLocation gets the bucket location.
  175. //
  176. // Checks out the following link for more information :
  177. // https://help.aliyun.com/document_detail/oss/user_guide/oss_concept/endpoint.html
  178. //
  179. // bucketName the bucket name
  180. //
  181. // string bucket's datacenter location
  182. // error it's nil if no error, otherwise it's an error object.
  183. //
  184. func (client Client) GetBucketLocation(bucketName string) (string, error) {
  185. params := map[string]interface{}{}
  186. params["location"] = nil
  187. resp, err := client.do("GET", bucketName, params, nil, nil)
  188. if err != nil {
  189. return "", err
  190. }
  191. defer resp.Body.Close()
  192. var LocationConstraint string
  193. err = xmlUnmarshal(resp.Body, &LocationConstraint)
  194. return LocationConstraint, err
  195. }
  196. // SetBucketACL sets bucket's ACL.
  197. //
  198. // bucketName the bucket name
  199. // bucketAcl the bucket ACL: ACLPrivate, ACLPublicRead and ACLPublicReadWrite.
  200. //
  201. // error it's nil if no error, otherwise it's an error object.
  202. //
  203. func (client Client) SetBucketACL(bucketName string, bucketACL ACLType) error {
  204. headers := map[string]string{HTTPHeaderOssACL: string(bucketACL)}
  205. params := map[string]interface{}{}
  206. params["acl"] = nil
  207. resp, err := client.do("PUT", bucketName, params, headers, nil)
  208. if err != nil {
  209. return err
  210. }
  211. defer resp.Body.Close()
  212. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  213. }
  214. // GetBucketACL gets the bucket ACL.
  215. //
  216. // bucketName the bucket name.
  217. //
  218. // GetBucketAclResponse the result object, and it's only valid when error is nil.
  219. // error it's nil if no error, otherwise it's an error object.
  220. //
  221. func (client Client) GetBucketACL(bucketName string) (GetBucketACLResult, error) {
  222. var out GetBucketACLResult
  223. params := map[string]interface{}{}
  224. params["acl"] = nil
  225. resp, err := client.do("GET", bucketName, params, nil, nil)
  226. if err != nil {
  227. return out, err
  228. }
  229. defer resp.Body.Close()
  230. err = xmlUnmarshal(resp.Body, &out)
  231. return out, err
  232. }
  233. // SetBucketLifecycle sets the bucket's lifecycle.
  234. //
  235. // For more information, checks out following link:
  236. // https://help.aliyun.com/document_detail/oss/user_guide/manage_object/object_lifecycle.html
  237. //
  238. // bucketName the bucket name.
  239. // rules the lifecycle rules. There're two kind of rules: absolute time expiration and relative time expiration in days and day/month/year respectively.
  240. // Check out sample/bucket_lifecycle.go for more details.
  241. //
  242. // error it's nil if no error, otherwise it's an error object.
  243. //
  244. func (client Client) SetBucketLifecycle(bucketName string, rules []LifecycleRule) error {
  245. err := verifyLifecycleRules(rules)
  246. if err != nil {
  247. return err
  248. }
  249. lifecycleCfg := LifecycleConfiguration{Rules: rules}
  250. bs, err := xml.Marshal(lifecycleCfg)
  251. if err != nil {
  252. return err
  253. }
  254. buffer := new(bytes.Buffer)
  255. buffer.Write(bs)
  256. contentType := http.DetectContentType(buffer.Bytes())
  257. headers := map[string]string{}
  258. headers[HTTPHeaderContentType] = contentType
  259. params := map[string]interface{}{}
  260. params["lifecycle"] = nil
  261. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  262. if err != nil {
  263. return err
  264. }
  265. defer resp.Body.Close()
  266. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  267. }
  268. // DeleteBucketLifecycle deletes the bucket's lifecycle.
  269. //
  270. //
  271. // bucketName the bucket name.
  272. //
  273. // error it's nil if no error, otherwise it's an error object.
  274. //
  275. func (client Client) DeleteBucketLifecycle(bucketName string) error {
  276. params := map[string]interface{}{}
  277. params["lifecycle"] = nil
  278. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  279. if err != nil {
  280. return err
  281. }
  282. defer resp.Body.Close()
  283. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  284. }
  285. // GetBucketLifecycle gets the bucket's lifecycle settings.
  286. //
  287. // bucketName the bucket name.
  288. //
  289. // GetBucketLifecycleResponse the result object upon successful request. It's only valid when error is nil.
  290. // error it's nil if no error, otherwise it's an error object.
  291. //
  292. func (client Client) GetBucketLifecycle(bucketName string) (GetBucketLifecycleResult, error) {
  293. var out GetBucketLifecycleResult
  294. params := map[string]interface{}{}
  295. params["lifecycle"] = nil
  296. resp, err := client.do("GET", bucketName, params, nil, nil)
  297. if err != nil {
  298. return out, err
  299. }
  300. defer resp.Body.Close()
  301. err = xmlUnmarshal(resp.Body, &out)
  302. return out, err
  303. }
  304. // SetBucketReferer sets the bucket's referer whitelist and the flag if allowing empty referrer.
  305. //
  306. // To avoid stealing link on OSS data, OSS supports the HTTP referrer header. A whitelist referrer could be set either by API or web console, as well as
  307. // the allowing empty referrer flag. Note that this applies to requests from webbrowser only.
  308. // For example, for a bucket os-example and its referrer http://www.aliyun.com, all requests from this URL could access the bucket.
  309. // For more information, please check out this link :
  310. // https://help.aliyun.com/document_detail/oss/user_guide/security_management/referer.html
  311. //
  312. // bucketName the bucket name.
  313. // referers the referrer white list. A bucket could have a referrer list and each referrer supports one '*' and multiple '?' as wildcards.
  314. // The sample could be found in sample/bucket_referer.go
  315. // allowEmptyReferer the flag of allowing empty referrer. By default it's true.
  316. //
  317. // error it's nil if no error, otherwise it's an error object.
  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. bs, err := xml.Marshal(rxml)
  330. if err != nil {
  331. return err
  332. }
  333. buffer := new(bytes.Buffer)
  334. buffer.Write(bs)
  335. contentType := http.DetectContentType(buffer.Bytes())
  336. headers := map[string]string{}
  337. headers[HTTPHeaderContentType] = contentType
  338. params := map[string]interface{}{}
  339. params["referer"] = nil
  340. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  341. if err != nil {
  342. return err
  343. }
  344. defer resp.Body.Close()
  345. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  346. }
  347. // GetBucketReferer gets the bucket's referrer white list.
  348. //
  349. // bucketName the bucket name.
  350. //
  351. // GetBucketRefererResponse the result object upon successful request. It's only valid when error is nil.
  352. // error it's nil if no error, otherwise it's an error object.
  353. //
  354. func (client Client) GetBucketReferer(bucketName string) (GetBucketRefererResult, error) {
  355. var out GetBucketRefererResult
  356. params := map[string]interface{}{}
  357. params["referer"] = nil
  358. resp, err := client.do("GET", bucketName, params, nil, nil)
  359. if err != nil {
  360. return out, err
  361. }
  362. defer resp.Body.Close()
  363. err = xmlUnmarshal(resp.Body, &out)
  364. return out, err
  365. }
  366. // SetBucketLogging sets the bucket logging settings.
  367. //
  368. // OSS could automatically store the access log. Only the bucket owner could enable the logging.
  369. // Once enabled, OSS would save all the access log into hourly log files in a specified bucket.
  370. // For more information, please check out https://help.aliyun.com/document_detail/oss/user_guide/security_management/logging.html
  371. //
  372. // bucketName bucket name to enable the log.
  373. // targetBucket the target bucket name to store the log files.
  374. // targetPrefix the log files' prefix.
  375. //
  376. // error it's nil if no error, otherwise it's an error object.
  377. //
  378. func (client Client) SetBucketLogging(bucketName, targetBucket, targetPrefix string,
  379. isEnable bool) error {
  380. var err error
  381. var bs []byte
  382. if isEnable {
  383. lxml := LoggingXML{}
  384. lxml.LoggingEnabled.TargetBucket = targetBucket
  385. lxml.LoggingEnabled.TargetPrefix = targetPrefix
  386. bs, err = xml.Marshal(lxml)
  387. } else {
  388. lxml := loggingXMLEmpty{}
  389. bs, err = xml.Marshal(lxml)
  390. }
  391. if err != nil {
  392. return err
  393. }
  394. buffer := new(bytes.Buffer)
  395. buffer.Write(bs)
  396. contentType := http.DetectContentType(buffer.Bytes())
  397. headers := map[string]string{}
  398. headers[HTTPHeaderContentType] = contentType
  399. params := map[string]interface{}{}
  400. params["logging"] = nil
  401. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  402. if err != nil {
  403. return err
  404. }
  405. defer resp.Body.Close()
  406. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  407. }
  408. // DeleteBucketLogging deletes the logging configuration to disable the logging on the bucket.
  409. //
  410. // bucketName the bucket name to disable the logging.
  411. //
  412. // error it's nil if no error, otherwise it's an error object.
  413. //
  414. func (client Client) DeleteBucketLogging(bucketName string) error {
  415. params := map[string]interface{}{}
  416. params["logging"] = nil
  417. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  418. if err != nil {
  419. return err
  420. }
  421. defer resp.Body.Close()
  422. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  423. }
  424. // GetBucketLogging gets the bucket's logging settings
  425. //
  426. // bucketName the bucket name
  427. // GetBucketLoggingResponse the result object upon successful request. It's only valid when error is nil.
  428. //
  429. // error it's nil if no error, otherwise it's an error object.
  430. //
  431. func (client Client) GetBucketLogging(bucketName string) (GetBucketLoggingResult, error) {
  432. var out GetBucketLoggingResult
  433. params := map[string]interface{}{}
  434. params["logging"] = nil
  435. resp, err := client.do("GET", bucketName, params, nil, nil)
  436. if err != nil {
  437. return out, err
  438. }
  439. defer resp.Body.Close()
  440. err = xmlUnmarshal(resp.Body, &out)
  441. return out, err
  442. }
  443. // SetBucketWebsite sets the bucket's static website's index and error page.
  444. //
  445. // OSS supports static web site hosting for the bucket data. When the bucket is enabled with that, you can access the file in the bucket like the way to access a static website.
  446. // For more information, please check out: https://help.aliyun.com/document_detail/oss/user_guide/static_host_website.html
  447. //
  448. // bucketName the bucket name to enable static web site.
  449. // indexDocument index page.
  450. // errorDocument error page.
  451. //
  452. // error it's nil if no error, otherwise it's an error object.
  453. //
  454. func (client Client) SetBucketWebsite(bucketName, indexDocument, errorDocument string) error {
  455. wxml := WebsiteXML{}
  456. wxml.IndexDocument.Suffix = indexDocument
  457. wxml.ErrorDocument.Key = errorDocument
  458. bs, err := xml.Marshal(wxml)
  459. if err != nil {
  460. return err
  461. }
  462. buffer := new(bytes.Buffer)
  463. buffer.Write(bs)
  464. contentType := http.DetectContentType(buffer.Bytes())
  465. headers := make(map[string]string)
  466. headers[HTTPHeaderContentType] = contentType
  467. params := map[string]interface{}{}
  468. params["website"] = nil
  469. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  470. if err != nil {
  471. return err
  472. }
  473. defer resp.Body.Close()
  474. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  475. }
  476. // DeleteBucketWebsite deletes the bucket's static web site settings.
  477. //
  478. // bucketName the bucket name.
  479. //
  480. // error it's nil if no error, otherwise it's an error object.
  481. //
  482. func (client Client) DeleteBucketWebsite(bucketName string) error {
  483. params := map[string]interface{}{}
  484. params["website"] = nil
  485. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  486. if err != nil {
  487. return err
  488. }
  489. defer resp.Body.Close()
  490. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  491. }
  492. // GetBucketWebsite gets the bucket's default page (index page) and the error page.
  493. //
  494. // bucketName the bucket name
  495. //
  496. // GetBucketWebsiteResponse the result object upon successful request. It's only valid when error is nil.
  497. // error it's nil if no error, otherwise it's an error object.
  498. //
  499. func (client Client) GetBucketWebsite(bucketName string) (GetBucketWebsiteResult, error) {
  500. var out GetBucketWebsiteResult
  501. params := map[string]interface{}{}
  502. params["website"] = nil
  503. resp, err := client.do("GET", bucketName, params, nil, nil)
  504. if err != nil {
  505. return out, err
  506. }
  507. defer resp.Body.Close()
  508. err = xmlUnmarshal(resp.Body, &out)
  509. return out, err
  510. }
  511. // SetBucketCORS sets the bucket's CORS rules
  512. //
  513. // For more information, please check out https://help.aliyun.com/document_detail/oss/user_guide/security_management/cors.html
  514. //
  515. // bucketName the bucket name
  516. // corsRules the CORS rules to set. The related sample code is in sample/bucket_cors.go.
  517. //
  518. // error it's nil if no error, otherwise it's an error object.
  519. //
  520. func (client Client) SetBucketCORS(bucketName string, corsRules []CORSRule) error {
  521. corsxml := CORSXML{}
  522. for _, v := range corsRules {
  523. cr := CORSRule{}
  524. cr.AllowedMethod = v.AllowedMethod
  525. cr.AllowedOrigin = v.AllowedOrigin
  526. cr.AllowedHeader = v.AllowedHeader
  527. cr.ExposeHeader = v.ExposeHeader
  528. cr.MaxAgeSeconds = v.MaxAgeSeconds
  529. corsxml.CORSRules = append(corsxml.CORSRules, cr)
  530. }
  531. bs, err := xml.Marshal(corsxml)
  532. if err != nil {
  533. return err
  534. }
  535. buffer := new(bytes.Buffer)
  536. buffer.Write(bs)
  537. contentType := http.DetectContentType(buffer.Bytes())
  538. headers := map[string]string{}
  539. headers[HTTPHeaderContentType] = contentType
  540. params := map[string]interface{}{}
  541. params["cors"] = nil
  542. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  543. if err != nil {
  544. return err
  545. }
  546. defer resp.Body.Close()
  547. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  548. }
  549. // DeleteBucketCORS deletes the bucket's static website settings.
  550. //
  551. // bucketName the bucket name.
  552. //
  553. // error it's nil if no error, otherwise it's an error object.
  554. //
  555. func (client Client) DeleteBucketCORS(bucketName string) error {
  556. params := map[string]interface{}{}
  557. params["cors"] = nil
  558. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  559. if err != nil {
  560. return err
  561. }
  562. defer resp.Body.Close()
  563. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  564. }
  565. // GetBucketCORS gets the bucket's CORS settings.
  566. //
  567. // bucketName the bucket name.
  568. // GetBucketCORSResult the result object upon successful request. It's only valid when error is nil.
  569. //
  570. // error it's nil if no error, otherwise it's an error object.
  571. //
  572. func (client Client) GetBucketCORS(bucketName string) (GetBucketCORSResult, error) {
  573. var out GetBucketCORSResult
  574. params := map[string]interface{}{}
  575. params["cors"] = nil
  576. resp, err := client.do("GET", bucketName, params, nil, nil)
  577. if err != nil {
  578. return out, err
  579. }
  580. defer resp.Body.Close()
  581. err = xmlUnmarshal(resp.Body, &out)
  582. return out, err
  583. }
  584. // GetBucketInfo gets the bucket information.
  585. //
  586. // bucketName the bucket name.
  587. // GetBucketInfoResult the result object upon successful request. It's only valid when error is nil.
  588. //
  589. // error it's nil if no error, otherwise it's an error object.
  590. //
  591. func (client Client) GetBucketInfo(bucketName string) (GetBucketInfoResult, error) {
  592. var out GetBucketInfoResult
  593. params := map[string]interface{}{}
  594. params["bucketInfo"] = nil
  595. resp, err := client.do("GET", bucketName, params, nil, nil)
  596. if err != nil {
  597. return out, err
  598. }
  599. defer resp.Body.Close()
  600. err = xmlUnmarshal(resp.Body, &out)
  601. // convert None to ""
  602. if err == nil {
  603. if out.BucketInfo.SseRule.KMSMasterKeyID == "None" {
  604. out.BucketInfo.SseRule.KMSMasterKeyID = ""
  605. }
  606. if out.BucketInfo.SseRule.SSEAlgorithm == "None" {
  607. out.BucketInfo.SseRule.SSEAlgorithm = ""
  608. }
  609. }
  610. return out, err
  611. }
  612. // SetBucketVersioning set bucket versioning:Enabled、Suspended
  613. // bucketName the bucket name.
  614. // error it's nil if no error, otherwise it's an error object.
  615. func (client Client) SetBucketVersioning(bucketName string, versioningConfig VersioningConfig, options ...Option) error {
  616. var err error
  617. var bs []byte
  618. bs, err = xml.Marshal(versioningConfig)
  619. if err != nil {
  620. return err
  621. }
  622. buffer := new(bytes.Buffer)
  623. buffer.Write(bs)
  624. contentType := http.DetectContentType(buffer.Bytes())
  625. headers := map[string]string{}
  626. headers[HTTPHeaderContentType] = contentType
  627. params := map[string]interface{}{}
  628. params["versioning"] = nil
  629. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  630. // get response header
  631. respHeader, _ := findOption(options, responseHeader, nil)
  632. if respHeader != nil {
  633. pRespHeader := respHeader.(*http.Header)
  634. *pRespHeader = resp.Headers
  635. }
  636. if err != nil {
  637. return err
  638. }
  639. defer resp.Body.Close()
  640. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  641. }
  642. // GetBucketVersioning get bucket versioning status:Enabled、Suspended
  643. // bucketName the bucket name.
  644. // error it's nil if no error, otherwise it's an error object.
  645. func (client Client) GetBucketVersioning(bucketName string, options ...Option) (GetBucketVersioningResult, error) {
  646. var out GetBucketVersioningResult
  647. params := map[string]interface{}{}
  648. params["versioning"] = nil
  649. resp, err := client.do("GET", bucketName, params, nil, nil)
  650. // get response header
  651. respHeader, _ := findOption(options, responseHeader, nil)
  652. if respHeader != nil {
  653. pRespHeader := respHeader.(*http.Header)
  654. *pRespHeader = resp.Headers
  655. }
  656. if err != nil {
  657. return out, err
  658. }
  659. defer resp.Body.Close()
  660. err = xmlUnmarshal(resp.Body, &out)
  661. return out, err
  662. }
  663. // SetBucketEncryption set bucket encryption config
  664. // bucketName the bucket name.
  665. // error it's nil if no error, otherwise it's an error object.
  666. func (client Client) SetBucketEncryption(bucketName string, encryptionRule ServerEncryptionRule, options ...Option) error {
  667. var err error
  668. var bs []byte
  669. bs, err = xml.Marshal(encryptionRule)
  670. if err != nil {
  671. return err
  672. }
  673. buffer := new(bytes.Buffer)
  674. buffer.Write(bs)
  675. contentType := http.DetectContentType(buffer.Bytes())
  676. headers := map[string]string{}
  677. headers[HTTPHeaderContentType] = contentType
  678. params := map[string]interface{}{}
  679. params["encryption"] = nil
  680. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  681. // get response header
  682. respHeader, _ := findOption(options, responseHeader, nil)
  683. if respHeader != nil {
  684. pRespHeader := respHeader.(*http.Header)
  685. *pRespHeader = resp.Headers
  686. }
  687. if err != nil {
  688. return err
  689. }
  690. defer resp.Body.Close()
  691. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  692. }
  693. // GetBucketEncryption get bucket encryption
  694. // bucketName the bucket name.
  695. // error it's nil if no error, otherwise it's an error object.
  696. func (client Client) GetBucketEncryption(bucketName string, options ...Option) (GetBucketEncryptionResult, error) {
  697. var out GetBucketEncryptionResult
  698. params := map[string]interface{}{}
  699. params["encryption"] = nil
  700. resp, err := client.do("GET", bucketName, params, nil, nil)
  701. // get response header
  702. respHeader, _ := findOption(options, responseHeader, nil)
  703. if respHeader != nil {
  704. pRespHeader := respHeader.(*http.Header)
  705. *pRespHeader = resp.Headers
  706. }
  707. if err != nil {
  708. return out, err
  709. }
  710. defer resp.Body.Close()
  711. err = xmlUnmarshal(resp.Body, &out)
  712. return out, err
  713. }
  714. // DeleteBucketEncryption delete bucket encryption config
  715. // bucketName the bucket name.
  716. // error it's nil if no error, otherwise it's an error bucket
  717. func (client Client) DeleteBucketEncryption(bucketName string, options ...Option) error {
  718. params := map[string]interface{}{}
  719. params["encryption"] = nil
  720. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  721. // get response header
  722. respHeader, _ := findOption(options, responseHeader, nil)
  723. if respHeader != nil {
  724. pRespHeader := respHeader.(*http.Header)
  725. *pRespHeader = resp.Headers
  726. }
  727. if err != nil {
  728. return err
  729. }
  730. defer resp.Body.Close()
  731. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  732. }
  733. //
  734. // SetBucketTagging add tagging to bucket
  735. // bucketName name of bucket
  736. // tagging tagging to be added
  737. // error nil if success, otherwise error
  738. func (client Client) SetBucketTagging(bucketName string, tagging Tagging, options ...Option) error {
  739. var err error
  740. var bs []byte
  741. bs, err = xml.Marshal(tagging)
  742. if err != nil {
  743. return err
  744. }
  745. buffer := new(bytes.Buffer)
  746. buffer.Write(bs)
  747. contentType := http.DetectContentType(buffer.Bytes())
  748. headers := map[string]string{}
  749. headers[HTTPHeaderContentType] = contentType
  750. params := map[string]interface{}{}
  751. params["tagging"] = nil
  752. resp, err := client.do("PUT", bucketName, params, headers, buffer)
  753. // get response header
  754. respHeader, _ := findOption(options, responseHeader, nil)
  755. if respHeader != nil {
  756. pRespHeader := respHeader.(*http.Header)
  757. *pRespHeader = resp.Headers
  758. }
  759. if err != nil {
  760. return err
  761. }
  762. defer resp.Body.Close()
  763. return checkRespCode(resp.StatusCode, []int{http.StatusOK})
  764. }
  765. // GetBucketTagging get tagging of the bucket
  766. // bucketName name of bucket
  767. // error nil if success, otherwise error
  768. func (client Client) GetBucketTagging(bucketName string, options ...Option) (GetBucketTaggingResult, error) {
  769. var out GetBucketTaggingResult
  770. params := map[string]interface{}{}
  771. params["tagging"] = nil
  772. resp, err := client.do("GET", bucketName, params, nil, nil)
  773. // get response header
  774. respHeader, _ := findOption(options, responseHeader, nil)
  775. if respHeader != nil {
  776. pRespHeader := respHeader.(*http.Header)
  777. *pRespHeader = resp.Headers
  778. }
  779. if err != nil {
  780. return out, err
  781. }
  782. defer resp.Body.Close()
  783. err = xmlUnmarshal(resp.Body, &out)
  784. return out, err
  785. }
  786. //
  787. // DeleteBucketTagging delete bucket tagging
  788. // bucketName name of bucket
  789. // error nil if success, otherwise error
  790. //
  791. func (client Client) DeleteBucketTagging(bucketName string, options ...Option) error {
  792. params := map[string]interface{}{}
  793. params["tagging"] = nil
  794. resp, err := client.do("DELETE", bucketName, params, nil, nil)
  795. // get response header
  796. respHeader, _ := findOption(options, responseHeader, nil)
  797. if respHeader != nil {
  798. pRespHeader := respHeader.(*http.Header)
  799. *pRespHeader = resp.Headers
  800. }
  801. if err != nil {
  802. return err
  803. }
  804. defer resp.Body.Close()
  805. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  806. }
  807. // GetBucketStat get bucket stat
  808. // bucketName the bucket name.
  809. // error it's nil if no error, otherwise it's an error object.
  810. func (client Client) GetBucketStat(bucketName string) (GetBucketStatResult, error) {
  811. var out GetBucketStatResult
  812. params := map[string]interface{}{}
  813. params["stat"] = nil
  814. resp, err := client.do("GET", bucketName, params, nil, nil)
  815. if err != nil {
  816. return out, err
  817. }
  818. defer resp.Body.Close()
  819. err = xmlUnmarshal(resp.Body, &out)
  820. return out, err
  821. }
  822. // LimitUploadSpeed set upload bandwidth limit speed,default is 0,unlimited
  823. // upSpeed KB/s, 0 is unlimited,default is 0
  824. // error it's nil if success, otherwise failure
  825. func (client Client) LimitUploadSpeed(upSpeed int) error {
  826. if client.Config == nil {
  827. return fmt.Errorf("client config is nil")
  828. }
  829. return client.Config.LimitUploadSpeed(upSpeed)
  830. }
  831. // UseCname sets the flag of using CName. By default it's false.
  832. //
  833. // isUseCname true: the endpoint has the CName, false: the endpoint does not have cname. Default is false.
  834. //
  835. func UseCname(isUseCname bool) ClientOption {
  836. return func(client *Client) {
  837. client.Config.IsCname = isUseCname
  838. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  839. }
  840. }
  841. // Timeout sets the HTTP timeout in seconds.
  842. //
  843. // connectTimeoutSec HTTP timeout in seconds. Default is 10 seconds. 0 means infinite (not recommended)
  844. // readWriteTimeout HTTP read or write's timeout in seconds. Default is 20 seconds. 0 means infinite.
  845. //
  846. func Timeout(connectTimeoutSec, readWriteTimeout int64) ClientOption {
  847. return func(client *Client) {
  848. client.Config.HTTPTimeout.ConnectTimeout =
  849. time.Second * time.Duration(connectTimeoutSec)
  850. client.Config.HTTPTimeout.ReadWriteTimeout =
  851. time.Second * time.Duration(readWriteTimeout)
  852. client.Config.HTTPTimeout.HeaderTimeout =
  853. time.Second * time.Duration(readWriteTimeout)
  854. client.Config.HTTPTimeout.IdleConnTimeout =
  855. time.Second * time.Duration(readWriteTimeout)
  856. client.Config.HTTPTimeout.LongTimeout =
  857. time.Second * time.Duration(readWriteTimeout*10)
  858. }
  859. }
  860. // SecurityToken sets the temporary user's SecurityToken.
  861. //
  862. // token STS token
  863. //
  864. func SecurityToken(token string) ClientOption {
  865. return func(client *Client) {
  866. client.Config.SecurityToken = strings.TrimSpace(token)
  867. }
  868. }
  869. // EnableMD5 enables MD5 validation.
  870. //
  871. // isEnableMD5 true: enable MD5 validation; false: disable MD5 validation.
  872. //
  873. func EnableMD5(isEnableMD5 bool) ClientOption {
  874. return func(client *Client) {
  875. client.Config.IsEnableMD5 = isEnableMD5
  876. }
  877. }
  878. // MD5ThresholdCalcInMemory sets the memory usage threshold for computing the MD5, default is 16MB.
  879. //
  880. // threshold the memory threshold in bytes. When the uploaded content is more than 16MB, the temp file is used for computing the MD5.
  881. //
  882. func MD5ThresholdCalcInMemory(threshold int64) ClientOption {
  883. return func(client *Client) {
  884. client.Config.MD5Threshold = threshold
  885. }
  886. }
  887. // EnableCRC enables the CRC checksum. Default is true.
  888. //
  889. // isEnableCRC true: enable CRC checksum; false: disable the CRC checksum.
  890. //
  891. func EnableCRC(isEnableCRC bool) ClientOption {
  892. return func(client *Client) {
  893. client.Config.IsEnableCRC = isEnableCRC
  894. }
  895. }
  896. // UserAgent specifies UserAgent. The default is aliyun-sdk-go/1.2.0 (windows/-/amd64;go1.5.2).
  897. //
  898. // userAgent the user agent string.
  899. //
  900. func UserAgent(userAgent string) ClientOption {
  901. return func(client *Client) {
  902. client.Config.UserAgent = userAgent
  903. }
  904. }
  905. // Proxy sets the proxy (optional). The default is not using proxy.
  906. //
  907. // proxyHost the proxy host in the format "host:port". For example, proxy.com:80 .
  908. //
  909. func Proxy(proxyHost string) ClientOption {
  910. return func(client *Client) {
  911. client.Config.IsUseProxy = true
  912. client.Config.ProxyHost = proxyHost
  913. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  914. }
  915. }
  916. // AuthProxy sets the proxy information with user name and password.
  917. //
  918. // proxyHost the proxy host in the format "host:port". For example, proxy.com:80 .
  919. // proxyUser the proxy user name.
  920. // proxyPassword the proxy password.
  921. //
  922. func AuthProxy(proxyHost, proxyUser, proxyPassword string) ClientOption {
  923. return func(client *Client) {
  924. client.Config.IsUseProxy = true
  925. client.Config.ProxyHost = proxyHost
  926. client.Config.IsAuthProxy = true
  927. client.Config.ProxyUser = proxyUser
  928. client.Config.ProxyPassword = proxyPassword
  929. client.Conn.url.Init(client.Config.Endpoint, client.Config.IsCname, client.Config.IsUseProxy)
  930. }
  931. }
  932. //
  933. // HTTPClient sets the http.Client in use to the one passed in
  934. //
  935. func HTTPClient(HTTPClient *http.Client) ClientOption {
  936. return func(client *Client) {
  937. client.HTTPClient = HTTPClient
  938. }
  939. }
  940. //
  941. // SetLogLevel sets the oss sdk log level
  942. //
  943. func SetLogLevel(LogLevel int) ClientOption {
  944. return func(client *Client) {
  945. client.Config.LogLevel = LogLevel
  946. }
  947. }
  948. //
  949. // SetLogger sets the oss sdk logger
  950. //
  951. func SetLogger(Logger *log.Logger) ClientOption {
  952. return func(client *Client) {
  953. client.Config.Logger = Logger
  954. }
  955. }
  956. // Private
  957. func (client Client) do(method, bucketName string, params map[string]interface{},
  958. headers map[string]string, data io.Reader) (*Response, error) {
  959. return client.Conn.Do(method, bucketName, "", params,
  960. headers, data, 0, nil)
  961. }