type.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609
  1. package oss
  2. import (
  3. "encoding/xml"
  4. "fmt"
  5. "net/url"
  6. "time"
  7. )
  8. // ListBucketsResult defines the result object from ListBuckets request
  9. type ListBucketsResult struct {
  10. XMLName xml.Name `xml:"ListAllMyBucketsResult"`
  11. Prefix string `xml:"Prefix"` // The prefix in this query
  12. Marker string `xml:"Marker"` // The marker filter
  13. MaxKeys int `xml:"MaxKeys"` // The max entry count to return. This information is returned when IsTruncated is true.
  14. IsTruncated bool `xml:"IsTruncated"` // Flag true means there's remaining buckets to return.
  15. NextMarker string `xml:"NextMarker"` // The marker filter for the next list call
  16. Owner Owner `xml:"Owner"` // The owner information
  17. Buckets []BucketProperties `xml:"Buckets>Bucket"` // The bucket list
  18. }
  19. // BucketProperties defines bucket properties
  20. type BucketProperties struct {
  21. XMLName xml.Name `xml:"Bucket"`
  22. Name string `xml:"Name"` // Bucket name
  23. Location string `xml:"Location"` // Bucket datacenter
  24. CreationDate time.Time `xml:"CreationDate"` // Bucket create time
  25. StorageClass string `xml:"StorageClass"` // Bucket storage class
  26. }
  27. // GetBucketACLResult defines GetBucketACL request's result
  28. type GetBucketACLResult struct {
  29. XMLName xml.Name `xml:"AccessControlPolicy"`
  30. ACL string `xml:"AccessControlList>Grant"` // Bucket ACL
  31. Owner Owner `xml:"Owner"` // Bucket owner
  32. }
  33. // LifecycleConfiguration is the Bucket Lifecycle configuration
  34. type LifecycleConfiguration struct {
  35. XMLName xml.Name `xml:"LifecycleConfiguration"`
  36. Rules []LifecycleRule `xml:"Rule"`
  37. }
  38. // LifecycleRule defines Lifecycle rules
  39. type LifecycleRule struct {
  40. XMLName xml.Name `xml:"Rule"`
  41. ID string `xml:"ID,omitempty"` // The rule ID
  42. Prefix string `xml:"Prefix"` // The object key prefix
  43. Status string `xml:"Status"` // The rule status (enabled or not)
  44. Tags []Tag `xml:"Tag,omitempty"` // the tags property
  45. Expiration *LifecycleExpiration `xml:"Expiration,omitempty"` // The expiration property
  46. Transitions []LifecycleTransition `xml:"Transition,omitempty"` // The transition property
  47. AbortMultipartUpload *LifecycleAbortMultipartUpload `xml:"AbortMultipartUpload,omitempty"` // The AbortMultipartUpload property
  48. }
  49. // LifecycleExpiration defines the rule's expiration property
  50. type LifecycleExpiration struct {
  51. XMLName xml.Name `xml:"Expiration"`
  52. Days int `xml:"Days,omitempty"` // Relative expiration time: The expiration time in days after the last modified time
  53. Date string `xml:"Date,omitempty"` // Absolute expiration time: The expiration time in date, not recommended
  54. CreatedBeforeDate string `xml:"CreatedBeforeDate,omitempty"` // objects created before the date will be expired
  55. }
  56. // LifecycleTransition defines the rule's transition propery
  57. type LifecycleTransition struct {
  58. XMLName xml.Name `xml:"Transition"`
  59. Days int `xml:"Days,omitempty"` // Relative transition time: The transition time in days after the last modified time
  60. CreatedBeforeDate string `xml:"CreatedBeforeDate,omitempty"` // objects created before the date will be expired
  61. StorageClass StorageClassType `xml:"StorageClass,omitempty"` // Specifies the target storage type
  62. }
  63. // LifecycleAbortMultipartUpload defines the rule's abort multipart upload propery
  64. type LifecycleAbortMultipartUpload struct {
  65. XMLName xml.Name `xml:"AbortMultipartUpload"`
  66. Days int `xml:"Days,omitempty"` // Relative expiration time: The expiration time in days after the last modified time
  67. CreatedBeforeDate string `xml:"CreatedBeforeDate,omitempty"` // objects created before the date will be expired
  68. }
  69. const iso8601DateFormat = "2006-01-02T15:04:05.000Z"
  70. // BuildLifecycleRuleByDays builds a lifecycle rule objects will expiration in days after the last modified time
  71. func BuildLifecycleRuleByDays(id, prefix string, status bool, days int) LifecycleRule {
  72. var statusStr = "Enabled"
  73. if !status {
  74. statusStr = "Disabled"
  75. }
  76. return LifecycleRule{ID: id, Prefix: prefix, Status: statusStr,
  77. Expiration: &LifecycleExpiration{Days: days}}
  78. }
  79. // BuildLifecycleRuleByDate builds a lifecycle rule objects will expiration in specified date
  80. func BuildLifecycleRuleByDate(id, prefix string, status bool, year, month, day int) LifecycleRule {
  81. var statusStr = "Enabled"
  82. if !status {
  83. statusStr = "Disabled"
  84. }
  85. date := time.Date(year, time.Month(month), day, 0, 0, 0, 0, time.UTC).Format(iso8601DateFormat)
  86. return LifecycleRule{ID: id, Prefix: prefix, Status: statusStr,
  87. Expiration: &LifecycleExpiration{Date: date}}
  88. }
  89. // ValidateLifecycleRule Determine if a lifecycle rule is valid, if it is invalid, it will return an error.
  90. func verifyLifecycleRules(rules []LifecycleRule) error {
  91. if len(rules) == 0 {
  92. return fmt.Errorf("invalid rules, the length of rules is zero")
  93. }
  94. for _, rule := range rules {
  95. if rule.Status != "Enabled" && rule.Status != "Disabled" {
  96. return fmt.Errorf("invalid rule, the value of status must be Enabled or Disabled")
  97. }
  98. expiration := rule.Expiration
  99. if expiration != nil {
  100. if (expiration.Days != 0 && expiration.CreatedBeforeDate != "") || (expiration.Days != 0 && expiration.Date != "") || (expiration.CreatedBeforeDate != "" && expiration.Date != "") || (expiration.Days == 0 && expiration.CreatedBeforeDate == "" && expiration.Date == "") {
  101. return fmt.Errorf("invalid expiration lifecycle, must be set one of CreatedBeforeDate, Days and Date")
  102. }
  103. }
  104. abortMPU := rule.AbortMultipartUpload
  105. if abortMPU != nil {
  106. if (abortMPU.Days != 0 && abortMPU.CreatedBeforeDate != "") || (abortMPU.Days == 0 && abortMPU.CreatedBeforeDate == "") {
  107. return fmt.Errorf("invalid abort multipart upload lifecycle, must be set one of CreatedBeforeDate and Days")
  108. }
  109. }
  110. transitions := rule.Transitions
  111. if len(transitions) > 0 {
  112. if len(transitions) > 2 {
  113. return fmt.Errorf("invalid count of transition lifecycles, the count must than less than 3")
  114. }
  115. for _, transition := range transitions {
  116. if (transition.Days != 0 && transition.CreatedBeforeDate != "") || (transition.Days == 0 && transition.CreatedBeforeDate == "") {
  117. return fmt.Errorf("invalid transition lifecycle, must be set one of CreatedBeforeDate and Days")
  118. }
  119. if transition.StorageClass != StorageIA && transition.StorageClass != StorageArchive {
  120. return fmt.Errorf("invalid transition lifecylce, the value of storage class must be IA or Archive")
  121. }
  122. }
  123. } else if expiration == nil && abortMPU == nil {
  124. return fmt.Errorf("invalid rule, must set one of Expiration, AbortMultipartUplaod and Transitions")
  125. }
  126. }
  127. return nil
  128. }
  129. // GetBucketLifecycleResult defines GetBucketLifecycle's result object
  130. type GetBucketLifecycleResult LifecycleConfiguration
  131. // RefererXML defines Referer configuration
  132. type RefererXML struct {
  133. XMLName xml.Name `xml:"RefererConfiguration"`
  134. AllowEmptyReferer bool `xml:"AllowEmptyReferer"` // Allow empty referrer
  135. RefererList []string `xml:"RefererList>Referer"` // Referer whitelist
  136. }
  137. // GetBucketRefererResult defines result object for GetBucketReferer request
  138. type GetBucketRefererResult RefererXML
  139. // LoggingXML defines logging configuration
  140. type LoggingXML struct {
  141. XMLName xml.Name `xml:"BucketLoggingStatus"`
  142. LoggingEnabled LoggingEnabled `xml:"LoggingEnabled"` // The logging configuration information
  143. }
  144. type loggingXMLEmpty struct {
  145. XMLName xml.Name `xml:"BucketLoggingStatus"`
  146. }
  147. // LoggingEnabled defines the logging configuration information
  148. type LoggingEnabled struct {
  149. XMLName xml.Name `xml:"LoggingEnabled"`
  150. TargetBucket string `xml:"TargetBucket"` // The bucket name for storing the log files
  151. TargetPrefix string `xml:"TargetPrefix"` // The log file prefix
  152. }
  153. // GetBucketLoggingResult defines the result from GetBucketLogging request
  154. type GetBucketLoggingResult LoggingXML
  155. // WebsiteXML defines Website configuration
  156. type WebsiteXML struct {
  157. XMLName xml.Name `xml:"WebsiteConfiguration"`
  158. IndexDocument IndexDocument `xml:"IndexDocument"` // The index page
  159. ErrorDocument ErrorDocument `xml:"ErrorDocument"` // The error page
  160. }
  161. // IndexDocument defines the index page info
  162. type IndexDocument struct {
  163. XMLName xml.Name `xml:"IndexDocument"`
  164. Suffix string `xml:"Suffix"` // The file name for the index page
  165. }
  166. // ErrorDocument defines the 404 error page info
  167. type ErrorDocument struct {
  168. XMLName xml.Name `xml:"ErrorDocument"`
  169. Key string `xml:"Key"` // 404 error file name
  170. }
  171. // GetBucketWebsiteResult defines the result from GetBucketWebsite request.
  172. type GetBucketWebsiteResult WebsiteXML
  173. // CORSXML defines CORS configuration
  174. type CORSXML struct {
  175. XMLName xml.Name `xml:"CORSConfiguration"`
  176. CORSRules []CORSRule `xml:"CORSRule"` // CORS rules
  177. }
  178. // CORSRule defines CORS rules
  179. type CORSRule struct {
  180. XMLName xml.Name `xml:"CORSRule"`
  181. AllowedOrigin []string `xml:"AllowedOrigin"` // Allowed origins. By default it's wildcard '*'
  182. AllowedMethod []string `xml:"AllowedMethod"` // Allowed methods
  183. AllowedHeader []string `xml:"AllowedHeader"` // Allowed headers
  184. ExposeHeader []string `xml:"ExposeHeader"` // Allowed response headers
  185. MaxAgeSeconds int `xml:"MaxAgeSeconds"` // Max cache ages in seconds
  186. }
  187. // GetBucketCORSResult defines the result from GetBucketCORS request.
  188. type GetBucketCORSResult CORSXML
  189. // GetBucketInfoResult defines the result from GetBucketInfo request.
  190. type GetBucketInfoResult struct {
  191. XMLName xml.Name `xml:"BucketInfo"`
  192. BucketInfo BucketInfo `xml:"Bucket"`
  193. }
  194. // BucketInfo defines Bucket information
  195. type BucketInfo struct {
  196. XMLName xml.Name `xml:"Bucket"`
  197. Name string `xml:"Name"` // Bucket name
  198. Location string `xml:"Location"` // Bucket datacenter
  199. CreationDate time.Time `xml:"CreationDate"` // Bucket creation time
  200. ExtranetEndpoint string `xml:"ExtranetEndpoint"` // Bucket external endpoint
  201. IntranetEndpoint string `xml:"IntranetEndpoint"` // Bucket internal endpoint
  202. ACL string `xml:"AccessControlList>Grant"` // Bucket ACL
  203. Owner Owner `xml:"Owner"` // Bucket owner
  204. StorageClass string `xml:"StorageClass"` // Bucket storage class
  205. }
  206. // ListObjectsResult defines the result from ListObjects request
  207. type ListObjectsResult struct {
  208. XMLName xml.Name `xml:"ListBucketResult"`
  209. Prefix string `xml:"Prefix"` // The object prefix
  210. Marker string `xml:"Marker"` // The marker filter.
  211. MaxKeys int `xml:"MaxKeys"` // Max keys to return
  212. Delimiter string `xml:"Delimiter"` // The delimiter for grouping objects' name
  213. IsTruncated bool `xml:"IsTruncated"` // Flag indicates if all results are returned (when it's false)
  214. NextMarker string `xml:"NextMarker"` // The start point of the next query
  215. Objects []ObjectProperties `xml:"Contents"` // Object list
  216. CommonPrefixes []string `xml:"CommonPrefixes>Prefix"` // You can think of commonprefixes as "folders" whose names end with the delimiter
  217. }
  218. // ObjectProperties defines Objecct properties
  219. type ObjectProperties struct {
  220. XMLName xml.Name `xml:"Contents"`
  221. Key string `xml:"Key"` // Object key
  222. Type string `xml:"Type"` // Object type
  223. Size int64 `xml:"Size"` // Object size
  224. ETag string `xml:"ETag"` // Object ETag
  225. Owner Owner `xml:"Owner"` // Object owner information
  226. LastModified time.Time `xml:"LastModified"` // Object last modified time
  227. StorageClass string `xml:"StorageClass"` // Object storage class (Standard, IA, Archive)
  228. }
  229. // Owner defines Bucket/Object's owner
  230. type Owner struct {
  231. XMLName xml.Name `xml:"Owner"`
  232. ID string `xml:"ID"` // Owner ID
  233. DisplayName string `xml:"DisplayName"` // Owner's display name
  234. }
  235. // CopyObjectResult defines result object of CopyObject
  236. type CopyObjectResult struct {
  237. XMLName xml.Name `xml:"CopyObjectResult"`
  238. LastModified time.Time `xml:"LastModified"` // New object's last modified time.
  239. ETag string `xml:"ETag"` // New object's ETag
  240. }
  241. // GetObjectACLResult defines result of GetObjectACL request
  242. type GetObjectACLResult GetBucketACLResult
  243. type deleteXML struct {
  244. XMLName xml.Name `xml:"Delete"`
  245. Objects []DeleteObject `xml:"Object"` // Objects to delete
  246. Quiet bool `xml:"Quiet"` // Flag of quiet mode.
  247. }
  248. // DeleteObject defines the struct for deleting object
  249. type DeleteObject struct {
  250. XMLName xml.Name `xml:"Object"`
  251. Key string `xml:"Key"` // Object name
  252. }
  253. // DeleteObjectsResult defines result of DeleteObjects request
  254. type DeleteObjectsResult struct {
  255. XMLName xml.Name `xml:"DeleteResult"`
  256. DeletedObjects []string `xml:"Deleted>Key"` // Deleted object list
  257. }
  258. // InitiateMultipartUploadResult defines result of InitiateMultipartUpload request
  259. type InitiateMultipartUploadResult struct {
  260. XMLName xml.Name `xml:"InitiateMultipartUploadResult"`
  261. Bucket string `xml:"Bucket"` // Bucket name
  262. Key string `xml:"Key"` // Object name to upload
  263. UploadID string `xml:"UploadId"` // Generated UploadId
  264. }
  265. // UploadPart defines the upload/copy part
  266. type UploadPart struct {
  267. XMLName xml.Name `xml:"Part"`
  268. PartNumber int `xml:"PartNumber"` // Part number
  269. ETag string `xml:"ETag"` // ETag value of the part's data
  270. }
  271. type uploadParts []UploadPart
  272. func (slice uploadParts) Len() int {
  273. return len(slice)
  274. }
  275. func (slice uploadParts) Less(i, j int) bool {
  276. return slice[i].PartNumber < slice[j].PartNumber
  277. }
  278. func (slice uploadParts) Swap(i, j int) {
  279. slice[i], slice[j] = slice[j], slice[i]
  280. }
  281. // UploadPartCopyResult defines result object of multipart copy request.
  282. type UploadPartCopyResult struct {
  283. XMLName xml.Name `xml:"CopyPartResult"`
  284. LastModified time.Time `xml:"LastModified"` // Last modified time
  285. ETag string `xml:"ETag"` // ETag
  286. }
  287. type completeMultipartUploadXML struct {
  288. XMLName xml.Name `xml:"CompleteMultipartUpload"`
  289. Part []UploadPart `xml:"Part"`
  290. }
  291. // CompleteMultipartUploadResult defines result object of CompleteMultipartUploadRequest
  292. type CompleteMultipartUploadResult struct {
  293. XMLName xml.Name `xml:"CompleteMultipartUploadResult"`
  294. Location string `xml:"Location"` // Object URL
  295. Bucket string `xml:"Bucket"` // Bucket name
  296. ETag string `xml:"ETag"` // Object ETag
  297. Key string `xml:"Key"` // Object name
  298. }
  299. // ListUploadedPartsResult defines result object of ListUploadedParts
  300. type ListUploadedPartsResult struct {
  301. XMLName xml.Name `xml:"ListPartsResult"`
  302. Bucket string `xml:"Bucket"` // Bucket name
  303. Key string `xml:"Key"` // Object name
  304. UploadID string `xml:"UploadId"` // Upload ID
  305. NextPartNumberMarker string `xml:"NextPartNumberMarker"` // Next part number
  306. MaxParts int `xml:"MaxParts"` // Max parts count
  307. IsTruncated bool `xml:"IsTruncated"` // Flag indicates all entries returned.false: all entries returned.
  308. UploadedParts []UploadedPart `xml:"Part"` // Uploaded parts
  309. }
  310. // UploadedPart defines uploaded part
  311. type UploadedPart struct {
  312. XMLName xml.Name `xml:"Part"`
  313. PartNumber int `xml:"PartNumber"` // Part number
  314. LastModified time.Time `xml:"LastModified"` // Last modified time
  315. ETag string `xml:"ETag"` // ETag cache
  316. Size int `xml:"Size"` // Part size
  317. }
  318. // ListMultipartUploadResult defines result object of ListMultipartUpload
  319. type ListMultipartUploadResult struct {
  320. XMLName xml.Name `xml:"ListMultipartUploadsResult"`
  321. Bucket string `xml:"Bucket"` // Bucket name
  322. Delimiter string `xml:"Delimiter"` // Delimiter for grouping object.
  323. Prefix string `xml:"Prefix"` // Object prefix
  324. KeyMarker string `xml:"KeyMarker"` // Object key marker
  325. UploadIDMarker string `xml:"UploadIdMarker"` // UploadId marker
  326. NextKeyMarker string `xml:"NextKeyMarker"` // Next key marker, if not all entries returned.
  327. NextUploadIDMarker string `xml:"NextUploadIdMarker"` // Next uploadId marker, if not all entries returned.
  328. MaxUploads int `xml:"MaxUploads"` // Max uploads to return
  329. IsTruncated bool `xml:"IsTruncated"` // Flag indicates all entries are returned.
  330. Uploads []UncompletedUpload `xml:"Upload"` // Ongoing uploads (not completed, not aborted)
  331. CommonPrefixes []string `xml:"CommonPrefixes>Prefix"` // Common prefixes list.
  332. }
  333. // UncompletedUpload structure wraps an uncompleted upload task
  334. type UncompletedUpload struct {
  335. XMLName xml.Name `xml:"Upload"`
  336. Key string `xml:"Key"` // Object name
  337. UploadID string `xml:"UploadId"` // The UploadId
  338. Initiated time.Time `xml:"Initiated"` // Initialization time in the format such as 2012-02-23T04:18:23.000Z
  339. }
  340. // ProcessObjectResult defines result object of ProcessObject
  341. type ProcessObjectResult struct {
  342. Bucket string `json:"bucket"`
  343. FileSize int `json:"fileSize"`
  344. Object string `json:"object"`
  345. Status string `json:"status"`
  346. }
  347. // decodeDeleteObjectsResult decodes deleting objects result in URL encoding
  348. func decodeDeleteObjectsResult(result *DeleteObjectsResult) error {
  349. var err error
  350. for i := 0; i < len(result.DeletedObjects); i++ {
  351. result.DeletedObjects[i], err = url.QueryUnescape(result.DeletedObjects[i])
  352. if err != nil {
  353. return err
  354. }
  355. }
  356. return nil
  357. }
  358. // decodeListObjectsResult decodes list objects result in URL encoding
  359. func decodeListObjectsResult(result *ListObjectsResult) error {
  360. var err error
  361. result.Prefix, err = url.QueryUnescape(result.Prefix)
  362. if err != nil {
  363. return err
  364. }
  365. result.Marker, err = url.QueryUnescape(result.Marker)
  366. if err != nil {
  367. return err
  368. }
  369. result.Delimiter, err = url.QueryUnescape(result.Delimiter)
  370. if err != nil {
  371. return err
  372. }
  373. result.NextMarker, err = url.QueryUnescape(result.NextMarker)
  374. if err != nil {
  375. return err
  376. }
  377. for i := 0; i < len(result.Objects); i++ {
  378. result.Objects[i].Key, err = url.QueryUnescape(result.Objects[i].Key)
  379. if err != nil {
  380. return err
  381. }
  382. }
  383. for i := 0; i < len(result.CommonPrefixes); i++ {
  384. result.CommonPrefixes[i], err = url.QueryUnescape(result.CommonPrefixes[i])
  385. if err != nil {
  386. return err
  387. }
  388. }
  389. return nil
  390. }
  391. // decodeListUploadedPartsResult decodes
  392. func decodeListUploadedPartsResult(result *ListUploadedPartsResult) error {
  393. var err error
  394. result.Key, err = url.QueryUnescape(result.Key)
  395. if err != nil {
  396. return err
  397. }
  398. return nil
  399. }
  400. // decodeListMultipartUploadResult decodes list multipart upload result in URL encoding
  401. func decodeListMultipartUploadResult(result *ListMultipartUploadResult) error {
  402. var err error
  403. result.Prefix, err = url.QueryUnescape(result.Prefix)
  404. if err != nil {
  405. return err
  406. }
  407. result.Delimiter, err = url.QueryUnescape(result.Delimiter)
  408. if err != nil {
  409. return err
  410. }
  411. result.KeyMarker, err = url.QueryUnescape(result.KeyMarker)
  412. if err != nil {
  413. return err
  414. }
  415. result.NextKeyMarker, err = url.QueryUnescape(result.NextKeyMarker)
  416. if err != nil {
  417. return err
  418. }
  419. for i := 0; i < len(result.Uploads); i++ {
  420. result.Uploads[i].Key, err = url.QueryUnescape(result.Uploads[i].Key)
  421. if err != nil {
  422. return err
  423. }
  424. }
  425. for i := 0; i < len(result.CommonPrefixes); i++ {
  426. result.CommonPrefixes[i], err = url.QueryUnescape(result.CommonPrefixes[i])
  427. if err != nil {
  428. return err
  429. }
  430. }
  431. return nil
  432. }
  433. // createBucketConfiguration defines the configuration for creating a bucket.
  434. type createBucketConfiguration struct {
  435. XMLName xml.Name `xml:"CreateBucketConfiguration"`
  436. StorageClass StorageClassType `xml:"StorageClass,omitempty"`
  437. }
  438. // LiveChannelConfiguration defines the configuration for live-channel
  439. type LiveChannelConfiguration struct {
  440. XMLName xml.Name `xml:"LiveChannelConfiguration"`
  441. Description string `xml:"Description,omitempty"` //Description of live-channel, up to 128 bytes
  442. Status string `xml:"Status,omitempty"` //Specify the status of livechannel
  443. Target LiveChannelTarget `xml:"Target"` //target configuration of live-channel
  444. // use point instead of struct to avoid omit empty snapshot
  445. Snapshot *LiveChannelSnapshot `xml:"Snapshot,omitempty"` //snapshot configuration of live-channel
  446. }
  447. // LiveChannelTarget target configuration of live-channel
  448. type LiveChannelTarget struct {
  449. XMLName xml.Name `xml:"Target"`
  450. Type string `xml:"Type"` //the type of object, only supports HLS
  451. FragDuration int `xml:"FragDuration,omitempty"` //the length of each ts object (in seconds), in the range [1,100]
  452. FragCount int `xml:"FragCount,omitempty"` //the number of ts objects in the m3u8 object, in the range of [1,100]
  453. PlaylistName string `xml:"PlaylistName,omitempty"` //the name of m3u8 object, which must end with ".m3u8" and the length range is [6,128]
  454. }
  455. // LiveChannelSnapshot snapshot configuration of live-channel
  456. type LiveChannelSnapshot struct {
  457. XMLName xml.Name `xml:"Snapshot"`
  458. RoleName string `xml:"RoleName,omitempty"` //The role of snapshot operations, it sholud has write permission of DestBucket and the permission to send messages to the NotifyTopic.
  459. DestBucket string `xml:"DestBucket,omitempty"` //Bucket the snapshots will be written to. should be the same owner as the source bucket.
  460. NotifyTopic string `xml:"NotifyTopic,omitempty"` //Topics of MNS for notifying users of high frequency screenshot operation results
  461. Interval int `xml:"Interval,omitempty"` //interval of snapshots, threre is no snapshot if no I-frame during the interval time
  462. }
  463. // CreateLiveChannelResult the result of crete live-channel
  464. type CreateLiveChannelResult struct {
  465. XMLName xml.Name `xml:"CreateLiveChannelResult"`
  466. PublishUrls []string `xml:"PublishUrls>Url"` //push urls list
  467. PlayUrls []string `xml:"PlayUrls>Url"` //play urls list
  468. }
  469. // LiveChannelStat the result of get live-channel state
  470. type LiveChannelStat struct {
  471. XMLName xml.Name `xml:"LiveChannelStat"`
  472. Status string `xml:"Status"` //Current push status of live-channel: Disabled,Live,Idle
  473. ConnectedTime time.Time `xml:"ConnectedTime"` //The time when the client starts pushing, format: ISO8601
  474. RemoteAddr string `xml:"RemoteAddr"` //The ip address of the client
  475. Video LiveChannelVideo `xml:"Video"` //Video stream information
  476. Audio LiveChannelAudio `xml:"Audio"` //Audio stream information
  477. }
  478. // LiveChannelVideo video stream information
  479. type LiveChannelVideo struct {
  480. XMLName xml.Name `xml:"Video"`
  481. Width int `xml:"Width"` //Width (unit: pixels)
  482. Height int `xml:"Height"` //Height (unit: pixels)
  483. FrameRate int `xml:"FrameRate"` //FramRate
  484. Bandwidth int `xml:"Bandwidth"` //Bandwidth (unit: B/s)
  485. }
  486. // LiveChannelAudio audio stream information
  487. type LiveChannelAudio struct {
  488. XMLName xml.Name `xml:"Audio"`
  489. SampleRate int `xml:"SampleRate"` //SampleRate
  490. Bandwidth int `xml:"Bandwidth"` //Bandwidth (unit: B/s)
  491. Codec string `xml:"Codec"` //Encoding forma
  492. }
  493. // LiveChannelHistory the result of GetLiveChannelHistory, at most return up to lastest 10 push records
  494. type LiveChannelHistory struct {
  495. XMLName xml.Name `xml:"LiveChannelHistory"`
  496. Record []LiveRecord `xml:"LiveRecord"` //push records list
  497. }
  498. // LiveRecord push recode
  499. type LiveRecord struct {
  500. XMLName xml.Name `xml:"LiveRecord"`
  501. StartTime time.Time `xml:"StartTime"` //StartTime, format: ISO8601
  502. EndTime time.Time `xml:"EndTime"` //EndTime, format: ISO8601
  503. RemoteAddr string `xml:"RemoteAddr"` //The ip address of remote client
  504. }
  505. // ListLiveChannelResult the result of ListLiveChannel
  506. type ListLiveChannelResult struct {
  507. XMLName xml.Name `xml:"ListLiveChannelResult"`
  508. Prefix string `xml:"Prefix"` //Filter by the name start with the value of "Prefix"
  509. Marker string `xml:"Marker"` //cursor from which starting list
  510. MaxKeys int `xml:"MaxKeys"` //The maximum count returned. the default value is 100. it cannot be greater than 1000.
  511. IsTruncated bool `xml:"IsTruncated"` //Indicates whether all results have been returned, "true" indicates partial results returned while "false" indicates all results have been returned
  512. NextMarker string `xml:"NextMarker"` //NextMarker indicate the Marker value of the next request
  513. LiveChannel []LiveChannelInfo `xml:"LiveChannel"` //The infomation of live-channel
  514. }
  515. // LiveChannelInfo the infomation of live-channel
  516. type LiveChannelInfo struct {
  517. XMLName xml.Name `xml:"LiveChannel"`
  518. Name string `xml:"Name"` //The name of live-channel
  519. Description string `xml:"Description"` //Description of live-channel
  520. Status string `xml:"Status"` //Status: disabled or enabled
  521. LastModified time.Time `xml:"LastModified"` //Last modification time, format: ISO8601
  522. PublishUrls []string `xml:"PublishUrls>Url"` //push urls list
  523. PlayUrls []string `xml:"PlayUrls>Url"` //play urls list
  524. }
  525. // Tag a tag for the object
  526. type Tag struct {
  527. XMLName xml.Name `xml:"Tag"`
  528. Key string `xml:"Key"`
  529. Value string `xml:"Value"`
  530. }
  531. // ObjectTagging tagset for the object
  532. type ObjectTagging struct {
  533. XMLName xml.Name `xml:"Tagging"`
  534. Tags []Tag `xml:"TagSet>Tag,omitempty"`
  535. }