type.go 26 KB

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