api.py 122 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517
  1. # -*- coding: utf-8 -*-
  2. """
  3. 文件上传方法中的data参数
  4. ------------------------
  5. 诸如 :func:`put_object <Bucket.put_object>` 这样的上传接口都会有 `data` 参数用于接收用户数据。`data` 可以是下述类型
  6. - unicode类型(对于Python3则是str类型):内部会自动转换为UTF-8的bytes
  7. - bytes类型:不做任何转换
  8. - file-like object:对于可以seek和tell的file object,从当前位置读取直到结束。其他类型,请确保当前位置是文件开始。
  9. - 可迭代类型:对于无法探知长度的数据,要求一定是可迭代的。此时会通过Chunked Encoding传输。
  10. Bucket配置修改方法中的input参数
  11. -----------------------------
  12. 诸如 :func:`put_bucket_cors <Bucket.put_bucket_cors>` 这样的Bucket配置修改接口都会有 `input` 参数接收用户提供的配置数据。
  13. `input` 可以是下述类型
  14. - Bucket配置信息相关的类,如 `BucketCors`
  15. - unicode类型(对于Python3则是str类型)
  16. - 经过utf-8编码的bytes类型
  17. - file-like object
  18. - 可迭代类型,会通过Chunked Encoding传输
  19. 也就是说 `input` 参数可以比 `data` 参数多接受第一种类型的输入。
  20. 返回值
  21. ------
  22. :class:`Service` 和 :class:`Bucket` 类的大多数方法都是返回 :class:`RequestResult <oss2.models.RequestResult>`
  23. 及其子类。`RequestResult` 包含了HTTP响应的状态码、头部以及OSS Request ID,而它的子类则包含用户真正想要的结果。例如,
  24. `ListBucketsResult.buckets` 就是返回的Bucket信息列表;`GetObjectResult` 则是一个file-like object,可以调用 `read()` 来获取响应的
  25. HTTP包体。
  26. :class:`CryptoBucket`:
  27. 加密接口
  28. -------
  29. CryptoBucket仅提供上传下载加密数据的接口,诸如`get_object` 、 `put_object` ,返回值与Bucket相应接口一致。
  30. 异常
  31. ----
  32. 一般来说Python SDK可能会抛出三种类型的异常,这些异常都继承于 :class:`OssError <oss2.exceptions.OssError>` :
  33. - :class:`ClientError <oss2.exceptions.ClientError>` :由于用户参数错误而引发的异常;
  34. - :class:`ServerError <oss2.exceptions.ServerError>` 及其子类:OSS服务器返回非成功的状态码,如4xx或5xx;
  35. - :class:`RequestError <oss2.exceptions.RequestError>` :底层requests库抛出的异常,如DNS解析错误,超时等;
  36. 当然,`Bucket.put_object_from_file` 和 `Bucket.get_object_to_file` 这类函数还会抛出文件相关的异常。
  37. .. _byte_range:
  38. 指定下载范围
  39. ------------
  40. 诸如 :func:`get_object <Bucket.get_object>` 以及 :func:`upload_part_copy <Bucket.upload_part_copy>` 这样的函数,可以接受
  41. `byte_range` 参数,表明读取数据的范围。该参数是一个二元tuple:(start, last)。这些接口会把它转换为Range头部的值,如:
  42. - byte_range 为 (0, 99) 转换为 'bytes=0-99',表示读取前100个字节
  43. - byte_range 为 (None, 99) 转换为 'bytes=-99',表示读取最后99个字节
  44. - byte_range 为 (100, None) 转换为 'bytes=100-',表示读取第101个字节到文件结尾的部分(包含第101个字节)
  45. 分页罗列
  46. -------
  47. 罗列各种资源的接口,如 :func:`list_buckets <Service.list_buckets>` 、 :func:`list_objects <Bucket.list_objects>` 都支持
  48. 分页查询。通过设定分页标记(如:`marker` 、 `key_marker` )的方式可以指定查询某一页。首次调用将分页标记设为空(缺省值,可以不设),
  49. 后续的调用使用返回值中的 `next_marker` 、 `next_key_marker` 等。每次调用后检查返回值中的 `is_truncated` ,其值为 `False` 说明
  50. 已经到了最后一页。
  51. .. _line_range:
  52. 指定查询CSV文件范围
  53. ------------
  54. 诸如 :func:`select_object <Bucket.select_object>` 以及 :func:`select_object_to_file <Bucket.select_object_to_file>` 这样的函数的select_csv_params参数,可以接受
  55. `LineRange` 参数,表明读取CSV数据的范围。该参数是一个二元tuple:(start, last):
  56. - LineRange 为 (0, 99) 表示读取前100行
  57. - LineRange 为 (None, 99) 表示读取最后99行
  58. - LineRange 为 (100, None) 表示读取第101行到文件结尾的部分(包含第101行)
  59. .. _split_range:
  60. 指定查询CSV文件范围
  61. ------------
  62. split可以认为是切分好的大小大致相等的csv行簇。每个Split大小大致相等,这样以便更好的做到负载均衡。
  63. 诸如 :func:`select_object <Bucket.select_object>` 以及 :func:`select_object_to_file <Bucket.select_object_to_file>` 这样的函数的select_csv_params参数,可以接受
  64. `SplitRange` 参数,表明读取CSV数据的范围。该参数是一个二元tuple:(start, last):
  65. - SplitRange 为 (0, 9) 表示读取前10个Split
  66. - SplitRange 为 (None, 9) 表示读取最后9个split
  67. - SplitRange 为 (10, None) 表示读取第11个split到文件结尾的部分(包含第11个Split)
  68. 分页查询
  69. -------
  70. 和create_csv_object_meta配合使用,有两种方法:
  71. - 方法1:先获取文件总的行数(create_csv_object_meta返回),然后把文件以line_range分成若干部分并行查询
  72. - 方法2:先获取文件总的Split数(create_csv_object_meta返回), 然后把文件分成若干个请求,每个请求含有大致相等的Split
  73. .. _progress_callback:
  74. 上传下载进度
  75. -----------
  76. 上传下载接口,诸如 `get_object` 、 `put_object` 、`resumable_upload`,都支持进度回调函数,可以用它实现进度条等功能。
  77. `progress_callback` 的函数原型如下 ::
  78. def progress_callback(bytes_consumed, total_bytes):
  79. '''进度回调函数。
  80. :param int bytes_consumed: 已经消费的字节数。对于上传,就是已经上传的量;对于下载,就是已经下载的量。
  81. :param int total_bytes: 总长度。
  82. '''
  83. 其中 `total_bytes` 对于上传和下载有不同的含义:
  84. - 上传:当输入是bytes或可以seek/tell的文件对象,那么它的值就是总的字节数;否则,其值为None
  85. - 下载:当返回的HTTP相应中有Content-Length头部,那么它的值就是Content-Length的值;否则,其值为None
  86. .. _unix_time:
  87. Unix Time
  88. ---------
  89. OSS Python SDK会把从服务器获得时间戳都转换为自1970年1月1日UTC零点以来的秒数,即Unix Time。
  90. 参见 `Unix Time <https://en.wikipedia.org/wiki/Unix_time>`_
  91. OSS中常用的时间格式有
  92. - HTTP Date格式,形如 `Sat, 05 Dec 2015 11:04:39 GMT` 这样的GMT时间。
  93. 用在If-Modified-Since、Last-Modified这些HTTP请求、响应头里。
  94. - ISO8601格式,形如 `2015-12-05T00:00:00.000Z`。
  95. 用在生命周期管理配置、列举Bucket结果中的创建时间、列举文件结果中的最后修改时间等处。
  96. `http_date` 函数把Unix Time转换为HTTP Date;而 `http_to_unixtime` 则做相反的转换。如 ::
  97. >>> import oss2, time
  98. >>> unix_time = int(time.time()) # 当前UNIX Time,设其值为 1449313829
  99. >>> date_str = oss2.http_date(unix_time) # 得到 'Sat, 05 Dec 2015 11:10:29 GMT'
  100. >>> oss2.http_to_unixtime(date_str) # 得到 1449313829
  101. .. note::
  102. 生成HTTP协议所需的日期(即HTTP Date)时,请使用 `http_date` , 不要使用 `strftime` 这样的函数。因为后者是和locale相关的。
  103. 比如,`strftime` 结果中可能会出现中文,而这样的格式,OSS服务器是不能识别的。
  104. `iso8601_to_unixtime` 把ISO8601格式转换为Unix Time;`date_to_iso8601` 和 `iso8601_to_date` 则在ISO8601格式的字符串和
  105. datetime.date之间相互转换。如 ::
  106. >>> import oss2
  107. >>> d = oss2.iso8601_to_date('2015-12-05T00:00:00.000Z') # 得到 datetime.date(2015, 12, 5)
  108. >>> date_str = oss2.date_to_iso8601(d) # 得到 '2015-12-05T00:00:00.000Z'
  109. >>> oss2.iso8601_to_unixtime(date_str) # 得到 1449273600
  110. .. _select_params:
  111. 指定OSS Select的文件格式。
  112. 对于Csv文件,支持如下Keys:
  113. >>> CsvHeaderInfo: None|Use|Ignore #None表示没有CSV Schema头,Use表示启用CSV Schema头,可以在Select语句中使用Name,Ignore表示有CSV Schema头,但忽略它(Select语句中不可以使用Name)
  114. 默认值是None
  115. >>> CommentCharacter: Comment字符,默认值是#,不支持多个字符
  116. >>> RecordDelimiter: 行分隔符,默认是\n,最多支持两个字符分隔符(比如:\r\n)
  117. >>> FieldDelimiter: 列分隔符,默认是逗号(,), 不支持多个字符
  118. >>> QuoteCharacter: 列Quote字符,默认是双引号("),不支持多个字符。注意转义符合Quote字符相同。
  119. >>> LineRange: 指定查询CSV文件的行范围,参见 `line_range`。
  120. >>> SplitRange: 指定查询CSV文件的Split范围,参见 `split_range`.
  121. 注意LineRange和SplitRange两种不能同时指定。若同时指定LineRange会被忽略。
  122. >>> CompressionType: 文件的压缩格式,默认值是None, 支持GZIP。
  123. >>> OutputRawData: 指定是响应Body返回Raw数据,默认值是False.
  124. >>> SkipPartialDataRecord: 当CSV行数据不完整时(select语句中出现的列在该行为空),是否跳过该行。默认是False。
  125. >>> OutputHeader:是否输出CSV Header,默认是False.
  126. >>> EnablePayloadCrc:是否启用对Payload的CRC校验,默认是False. 该选项不能和OutputRawData:True混用。
  127. >>> MaxSkippedRecordsAllowed: 允许跳过的最大行数。默认值是0表示一旦有一行跳过就报错。当下列两种情况下该行CSV被跳过:1)当SkipPartialDataRecord为True时且该行不完整时 2)当该行的数据类型和SQL不匹配时
  128. 对于Json 文件, 支持如下Keys:
  129. >>> Json_Type: DOCUMENT | LINES . DOCUMENT就是指一般的Json文件,LINES是指每一行是一个合法的JSON对象,文件由多行Json对象组成,整个文件本身不是合法的Json对象。
  130. >>> LineRange: 指定查询JSON LINE文件的行范围,参见 `line_range`。注意该参数仅支持LINES类型
  131. >>> SplitRange: 指定查询JSON LINE文件的Split范围,参见 `split_range`.注意该参数仅支持LINES类型
  132. >>> CompressionType: 文件的压缩格式,默认值是None, 支持GZIP。
  133. >>> OutputRawData: 指定是响应Body返回Raw数据,默认值是False.
  134. >>> SkipPartialDataRecord: 当一条JSON记录数据不完整时(select语句中出现的Key在该对象为空),是否跳过该Json记录。默认是False。
  135. >>> EnablePayloadCrc:是否启用对Payload的CRC校验,默认是False. 该选项不能和OutputRawData:True混用。
  136. >>> MaxSkippedRecordsAllowed: 允许跳过的最大Json记录数。默认值是0表示一旦有一条Json记录跳过就报错。当下列两种情况下该JSON被跳过:1)当SkipPartialDataRecord为True时且该条Json记录不完整时 2)当该记录的数据类型和SQL不匹配时
  137. >>> ParseJsonNumberAsString: 将Json文件中的数字解析成字符串。使用场景是当Json文件中的浮点数精度较高时,系统默认的浮点数精度无法达到要求,当解析成字符串时将完整保留原始数据精度,在Sql中使用Cast可以将字符串无精度损失地转成decimal.
  138. >>> AllowQuotedRecordDelimiter: 允许CSV中的列包含转义过的换行符。默认为true。当值为False时,select API可以用Range:bytes来设置选取目标对象内容的范围
  139. .. _select_meta_params:
  140. create_select_object_meta参数集合,支持如下Keys:
  141. - RecordDelimiter: CSV换行符,最多支持两个字符
  142. - FieldDelimiter: CSV列分隔符,最多支持一个字符
  143. - QuoteCharacter: CSV转移Quote符,最多支持一个字符
  144. - OverwriteIfExists: true|false. true表示重新获得csv meta,并覆盖原有的meta。一般情况下不需要使用
  145. """
  146. import logging
  147. from . import xml_utils
  148. from . import http
  149. from . import utils
  150. from . import exceptions
  151. from . import defaults
  152. from . import models
  153. from . import select_params
  154. from .models import *
  155. from .compat import urlquote, urlparse, to_unicode, to_string
  156. from .headers import *
  157. from .select_params import *
  158. import time
  159. import shutil
  160. logger = logging.getLogger(__name__)
  161. class _Base(object):
  162. def __init__(self, auth, endpoint, is_cname, session, connect_timeout,
  163. app_name='', enable_crc=True):
  164. self.auth = auth
  165. self.endpoint = _normalize_endpoint(endpoint.strip())
  166. if utils.is_valid_endpoint(self.endpoint) is not True:
  167. raise ClientError('The endpoint you has specified is not valid, endpoint: {0}'.format(endpoint))
  168. self.session = session or http.Session()
  169. self.timeout = defaults.get(connect_timeout, defaults.connect_timeout)
  170. self.app_name = app_name
  171. self.enable_crc = enable_crc
  172. self._make_url = _UrlMaker(self.endpoint, is_cname)
  173. def _do(self, method, bucket_name, key, **kwargs):
  174. key = to_string(key)
  175. req = http.Request(method, self._make_url(bucket_name, key),
  176. app_name=self.app_name,
  177. **kwargs)
  178. self.auth._sign_request(req, bucket_name, key)
  179. resp = self.session.do_request(req, timeout=self.timeout)
  180. if resp.status // 100 != 2:
  181. e = exceptions.make_exception(resp)
  182. logger.info("Exception: {0}".format(e))
  183. raise e
  184. # Note that connections are only released back to the pool for reuse once all body data has been read;
  185. # be sure to either set stream to False or read the content property of the Response object.
  186. # For more details, please refer to http://docs.python-requests.org/en/master/user/advanced/#keep-alive.
  187. content_length = models._hget(resp.headers, 'content-length', int)
  188. if content_length is not None and content_length == 0:
  189. resp.read()
  190. return resp
  191. def _do_url(self, method, sign_url, **kwargs):
  192. req = http.Request(method, sign_url, app_name=self.app_name, **kwargs)
  193. resp = self.session.do_request(req, timeout=self.timeout)
  194. if resp.status // 100 != 2:
  195. e = exceptions.make_exception(resp)
  196. logger.info("Exception: {0}".format(e))
  197. raise e
  198. # Note that connections are only released back to the pool for reuse once all body data has been read;
  199. # be sure to either set stream to False or read the content property of the Response object.
  200. # For more details, please refer to http://docs.python-requests.org/en/master/user/advanced/#keep-alive.
  201. content_length = models._hget(resp.headers, 'content-length', int)
  202. if content_length is not None and content_length == 0:
  203. resp.read()
  204. return resp
  205. @staticmethod
  206. def _parse_result(resp, parse_func, klass):
  207. result = klass(resp)
  208. parse_func(result, resp.read())
  209. return result
  210. class Service(_Base):
  211. """用于Service操作的类,如罗列用户所有的Bucket。
  212. 用法 ::
  213. >>> import oss2
  214. >>> auth = oss2.Auth('your-access-key-id', 'your-access-key-secret')
  215. >>> service = oss2.Service(auth, 'oss-cn-hangzhou.aliyuncs.com')
  216. >>> service.list_buckets()
  217. <oss2.models.ListBucketsResult object at 0x0299FAB0>
  218. :param auth: 包含了用户认证信息的Auth对象
  219. :type auth: oss2.Auth
  220. :param str endpoint: 访问域名,如杭州区域的域名为oss-cn-hangzhou.aliyuncs.com
  221. :param session: 会话。如果是None表示新开会话,非None则复用传入的会话
  222. :type session: oss2.Session
  223. :param float connect_timeout: 连接超时时间,以秒为单位。
  224. :param str app_name: 应用名。该参数不为空,则在User Agent中加入其值。
  225. 注意到,最终这个字符串是要作为HTTP Header的值传输的,所以必须要遵循HTTP标准。
  226. """
  227. QOS_INFO = 'qosInfo'
  228. def __init__(self, auth, endpoint,
  229. session=None,
  230. connect_timeout=None,
  231. app_name=''):
  232. logger.debug("Init oss service, endpoint: {0}, connect_timeout: {1}, app_name: {2}".format(
  233. endpoint, connect_timeout, app_name))
  234. super(Service, self).__init__(auth, endpoint, False, session, connect_timeout,
  235. app_name=app_name)
  236. def list_buckets(self, prefix='', marker='', max_keys=100, params=None):
  237. """根据前缀罗列用户的Bucket。
  238. :param str prefix: 只罗列Bucket名为该前缀的Bucket,空串表示罗列所有的Bucket
  239. :param str marker: 分页标志。首次调用传空串,后续使用返回值中的next_marker
  240. :param int max_keys: 每次调用最多返回的Bucket数目
  241. :param dict params: list操作参数,传入'tag-key','tag-value'对结果进行过滤
  242. :return: 罗列的结果
  243. :rtype: oss2.models.ListBucketsResult
  244. """
  245. logger.debug("Start to list buckets, prefix: {0}, marker: {1}, max-keys: {2}".format(prefix, marker, max_keys))
  246. listParam = {}
  247. listParam['prefix'] = prefix
  248. listParam['marker'] = marker
  249. listParam['max-keys'] = str(max_keys)
  250. if params is not None:
  251. if 'tag-key' in params:
  252. listParam['tag-key'] = params['tag-key']
  253. if 'tag-value' in params:
  254. listParam['tag-value'] = params['tag-value']
  255. resp = self._do('GET', '', '', params=listParam)
  256. logger.debug("List buckets done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  257. return self._parse_result(resp, xml_utils.parse_list_buckets, ListBucketsResult)
  258. def get_user_qos_info(self):
  259. """获取User的QoSInfo
  260. :return: :class:`GetUserQosInfoResult <oss2.models.GetUserQosInfoResult>`
  261. """
  262. logger.debug("Start to get user qos info.")
  263. resp = self._do('GET', '', '', params={Service.QOS_INFO: ''})
  264. logger.debug("get use qos, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  265. return self._parse_result(resp, xml_utils.parse_get_qos_info, GetUserQosInfoResult)
  266. class Bucket(_Base):
  267. """用于Bucket和Object操作的类,诸如创建、删除Bucket,上传、下载Object等。
  268. 用法(假设Bucket属于杭州区域) ::
  269. >>> import oss2
  270. >>> auth = oss2.Auth('your-access-key-id', 'your-access-key-secret')
  271. >>> bucket = oss2.Bucket(auth, 'http://oss-cn-hangzhou.aliyuncs.com', 'your-bucket')
  272. >>> bucket.put_object('readme.txt', 'content of the object')
  273. <oss2.models.PutObjectResult object at 0x029B9930>
  274. :param auth: 包含了用户认证信息的Auth对象
  275. :type auth: oss2.Auth
  276. :param str endpoint: 访问域名或者CNAME
  277. :param str bucket_name: Bucket名
  278. :param bool is_cname: 如果endpoint是CNAME则设为True;反之,则为False。
  279. :param session: 会话。如果是None表示新开会话,非None则复用传入的会话
  280. :type session: oss2.Session
  281. :param float connect_timeout: 连接超时时间,以秒为单位。
  282. :param str app_name: 应用名。该参数不为空,则在User Agent中加入其值。
  283. 注意到,最终这个字符串是要作为HTTP Header的值传输的,所以必须要遵循HTTP标准。
  284. """
  285. ACL = 'acl'
  286. CORS = 'cors'
  287. LIFECYCLE = 'lifecycle'
  288. LOCATION = 'location'
  289. LOGGING = 'logging'
  290. REFERER = 'referer'
  291. WEBSITE = 'website'
  292. LIVE = 'live'
  293. COMP = 'comp'
  294. STATUS = 'status'
  295. VOD = 'vod'
  296. SYMLINK = 'symlink'
  297. STAT = 'stat'
  298. BUCKET_INFO = 'bucketInfo'
  299. PROCESS = 'x-oss-process'
  300. TAGGING = 'tagging'
  301. ENCRYPTION = 'encryption'
  302. VERSIONS = 'versions'
  303. VERSIONING = 'versioning'
  304. VERSIONID = 'versionId'
  305. RESTORE = 'restore'
  306. OBJECTMETA = 'objectMeta'
  307. POLICY = 'policy'
  308. REQUESTPAYMENT = 'requestPayment'
  309. QOS_INFO = 'qosInfo'
  310. USER_QOS = 'qos'
  311. ASYNC_FETCH = 'asyncFetch'
  312. SEQUENTIAL = 'sequential'
  313. INVENTORY = "inventory"
  314. INVENTORY_CONFIG_ID = "inventoryId"
  315. CONTINUATION_TOKEN = "continuation-token"
  316. WORM = "worm"
  317. WORM_ID = "wormId"
  318. WORM_EXTEND = "wormExtend"
  319. def __init__(self, auth, endpoint, bucket_name,
  320. is_cname=False,
  321. session=None,
  322. connect_timeout=None,
  323. app_name='',
  324. enable_crc=True):
  325. logger.debug("Init Bucket: {0}, endpoint: {1}, isCname: {2}, connect_timeout: {3}, app_name: {4}, enabled_crc: "
  326. "{5}".format(bucket_name, endpoint, is_cname, connect_timeout, app_name, enable_crc))
  327. super(Bucket, self).__init__(auth, endpoint, is_cname, session, connect_timeout, app_name, enable_crc)
  328. self.bucket_name = bucket_name.strip()
  329. if utils.is_valid_bucket_name(self.bucket_name) is not True:
  330. raise ClientError("The bucket_name is invalid, please check it.")
  331. def sign_url(self, method, key, expires, headers=None, params=None, slash_safe=False):
  332. """生成签名URL。
  333. 常见的用法是生成加签的URL以供授信用户下载,如为log.jpg生成一个5分钟后过期的下载链接::
  334. >>> bucket.sign_url('GET', 'log.jpg', 5 * 60)
  335. r'http://your-bucket.oss-cn-hangzhou.aliyuncs.com/logo.jpg?OSSAccessKeyId=YourAccessKeyId\&Expires=1447178011&Signature=UJfeJgvcypWq6Q%2Bm3IJcSHbvSak%3D'
  336. :param method: HTTP方法,如'GET'、'PUT'、'DELETE'等
  337. :type method: str
  338. :param key: 文件名
  339. :param expires: 过期时间(单位:秒),链接在当前时间再过expires秒后过期
  340. :param headers: 需要签名的HTTP头部,如名称以x-oss-meta-开头的头部(作为用户自定义元数据)、
  341. Content-Type头部等。对于下载,不需要填。
  342. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  343. :param params: 需要签名的HTTP查询参数
  344. :param slash_safe: 是否开启key名称中的‘/’转义保护,如果不开启'/'将会转义成%2F
  345. :type slash_safe: bool
  346. :return: 签名URL。
  347. """
  348. key = to_string(key)
  349. logger.debug(
  350. "Start to sign_url, method: {0}, bucket: {1}, key: {2}, expires: {3}, headers: {4}, params: {5}, slash_safe: {6}".format(
  351. method, self.bucket_name, to_string(key), expires, headers, params, slash_safe))
  352. req = http.Request(method, self._make_url(self.bucket_name, key, slash_safe),
  353. headers=headers,
  354. params=params)
  355. return self.auth._sign_url(req, self.bucket_name, key, expires)
  356. def sign_rtmp_url(self, channel_name, playlist_name, expires):
  357. """生成RTMP推流的签名URL。
  358. 常见的用法是生成加签的URL以供授信用户向OSS推RTMP流。
  359. :param channel_name: 直播频道的名称
  360. :param expires: 过期时间(单位:秒),链接在当前时间再过expires秒后过期
  361. :param playlist_name: 播放列表名称,注意与创建live channel时一致
  362. :param params: 需要签名的HTTP查询参数
  363. :return: 签名URL。
  364. """
  365. logger.debug("Sign RTMP url, bucket: {0}, channel_name: {1}, playlist_name: {2}, expires: {3}".format(
  366. self.bucket_name, channel_name, playlist_name, expires))
  367. url = self._make_url(self.bucket_name, 'live').replace('http://', 'rtmp://').replace(
  368. 'https://', 'rtmp://') + '/' + channel_name
  369. params = {}
  370. if playlist_name is not None and playlist_name != "":
  371. params['playlistName'] = playlist_name
  372. return self.auth._sign_rtmp_url(url, self.bucket_name, channel_name, expires, params)
  373. def list_objects(self, prefix='', delimiter='', marker='', max_keys=100, headers=None):
  374. """根据前缀罗列Bucket里的文件。
  375. :param str prefix: 只罗列文件名为该前缀的文件
  376. :param str delimiter: 分隔符。可以用来模拟目录
  377. :param str marker: 分页标志。首次调用传空串,后续使用返回值的next_marker
  378. :param int max_keys: 最多返回文件的个数,文件和目录的和不能超过该值
  379. :param headers: HTTP头部
  380. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  381. :return: :class:`ListObjectsResult <oss2.models.ListObjectsResult>`
  382. """
  383. headers = http.CaseInsensitiveDict(headers)
  384. logger.debug(
  385. "Start to List objects, bucket: {0}, prefix: {1}, delimiter: {2}, marker: {3}, max-keys: {4}".format(
  386. self.bucket_name, to_string(prefix), delimiter, to_string(marker), max_keys))
  387. resp = self.__do_object('GET', '',
  388. params={'prefix': prefix,
  389. 'delimiter': delimiter,
  390. 'marker': marker,
  391. 'max-keys': str(max_keys),
  392. 'encoding-type': 'url'},
  393. headers=headers)
  394. logger.debug("List objects done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  395. return self._parse_result(resp, xml_utils.parse_list_objects, ListObjectsResult)
  396. def list_objects_v2(self, prefix='', delimiter='', continuation_token='', start_after='', fetch_owner=False, encoding_type='url', max_keys=100, headers=None):
  397. """根据前缀罗列Bucket里的文件。
  398. :param str prefix: 只罗列文件名为该前缀的文件
  399. :param str delimiter: 分隔符。可以用来模拟目录
  400. :param str continuation_token: 分页标志。首次调用传空串,后续使用返回值的next_continuation_token
  401. :param str start_after: 起始文件名称,OSS会返回按照字典序排列start_after之后的文件。
  402. :param bool fetch_owner: 是否获取文件的owner信息,默认不返回。
  403. :param int max_keys: 最多返回文件的个数,文件和目录的和不能超过该值
  404. :param headers: HTTP头部
  405. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  406. :return: :class:`ListObjectsV2Result <oss2.models.ListObjectsV2Result>`
  407. """
  408. headers = http.CaseInsensitiveDict(headers)
  409. logger.debug(
  410. "Start to List objects, bucket: {0}, prefix: {1}, delimiter: {2}, continuation_token: {3}, "
  411. "start-after: {4}, fetch-owner: {5}, encoding_type: {6}, max-keys: {7}".format(
  412. self.bucket_name, to_string(prefix), delimiter, continuation_token, start_after, fetch_owner, encoding_type, max_keys))
  413. resp = self.__do_object('GET', '',
  414. params={'list-type': '2',
  415. 'prefix': prefix,
  416. 'delimiter': delimiter,
  417. 'continuation-token': continuation_token,
  418. 'start-after': start_after,
  419. 'fetch-owner': str(fetch_owner).lower(),
  420. 'max-keys': str(max_keys),
  421. 'encoding-type': encoding_type},
  422. headers=headers)
  423. logger.debug("List objects V2 done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  424. return self._parse_result(resp, xml_utils.parse_list_objects_v2, ListObjectsV2Result)
  425. def put_object(self, key, data,
  426. headers=None,
  427. progress_callback=None):
  428. """上传一个普通文件。
  429. 用法 ::
  430. >>> bucket.put_object('readme.txt', 'content of readme.txt')
  431. >>> with open(u'local_file.txt', 'rb') as f:
  432. >>> bucket.put_object('remote_file.txt', f)
  433. :param key: 上传到OSS的文件名
  434. :param data: 待上传的内容。
  435. :type data: bytes,str或file-like object
  436. :param headers: 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-meta-开头的头部等
  437. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  438. :param progress_callback: 用户指定的进度回调函数。可以用来实现进度条等功能。参考 :ref:`progress_callback` 。
  439. :return: :class:`PutObjectResult <oss2.models.PutObjectResult>`
  440. """
  441. headers = utils.set_content_type(http.CaseInsensitiveDict(headers), key)
  442. if progress_callback:
  443. data = utils.make_progress_adapter(data, progress_callback)
  444. if self.enable_crc:
  445. data = utils.make_crc_adapter(data)
  446. logger.debug("Start to put object, bucket: {0}, key: {1}, headers: {2}".format(self.bucket_name, to_string(key),
  447. headers))
  448. resp = self.__do_object('PUT', key, data=data, headers=headers)
  449. logger.debug("Put object done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  450. result = PutObjectResult(resp)
  451. if self.enable_crc and result.crc is not None:
  452. utils.check_crc('put object', data.crc, result.crc, result.request_id)
  453. return result
  454. def put_object_from_file(self, key, filename,
  455. headers=None,
  456. progress_callback=None):
  457. """上传一个本地文件到OSS的普通文件。
  458. :param str key: 上传到OSS的文件名
  459. :param str filename: 本地文件名,需要有可读权限
  460. :param headers: 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-meta-开头的头部等
  461. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  462. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  463. :return: :class:`PutObjectResult <oss2.models.PutObjectResult>`
  464. """
  465. headers = utils.set_content_type(http.CaseInsensitiveDict(headers), filename)
  466. logger.debug("Put object from file, bucket: {0}, key: {1}, file path: {2}".format(
  467. self.bucket_name, to_string(key), filename))
  468. with open(to_unicode(filename), 'rb') as f:
  469. return self.put_object(key, f, headers=headers, progress_callback=progress_callback)
  470. def put_object_with_url(self, sign_url, data, headers=None, progress_callback=None):
  471. """ 使用加签的url上传对象
  472. :param sign_url: 加签的url
  473. :param data: 待上传的数据
  474. :param headers: 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-meta-开头的头部等,必须和签名时保持一致
  475. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  476. :return:
  477. """
  478. headers = http.CaseInsensitiveDict(headers)
  479. if progress_callback:
  480. data = utils.make_progress_adapter(data, progress_callback)
  481. if self.enable_crc:
  482. data = utils.make_crc_adapter(data)
  483. logger.debug("Start to put object with signed url, bucket: {0}, sign_url: {1}, headers: {2}".format(
  484. self.bucket_name, sign_url, headers))
  485. resp = self._do_url('PUT', sign_url, data=data, headers=headers)
  486. logger.debug("Put object with url done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  487. result = PutObjectResult(resp)
  488. if self.enable_crc and result.crc is not None:
  489. utils.check_crc('put object', data.crc, result.crc, result.request_id)
  490. return result
  491. def put_object_with_url_from_file(self, sign_url, filename,
  492. headers=None,
  493. progress_callback=None):
  494. """ 使用加签的url上传本地文件到oss
  495. :param sign_url: 加签的url
  496. :param filename: 本地文件路径
  497. :param headers: 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-meta-开头的头部等,必须和签名时保持一致
  498. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  499. :return:
  500. """
  501. logger.debug("Put object from file with signed url, bucket: {0}, sign_url: {1}, file path: {2}".format(
  502. self.bucket_name, sign_url, filename))
  503. with open(to_unicode(filename), 'rb') as f:
  504. return self.put_object_with_url(sign_url, f, headers=headers, progress_callback=progress_callback)
  505. def append_object(self, key, position, data,
  506. headers=None,
  507. progress_callback=None,
  508. init_crc=None):
  509. """追加上传一个文件。
  510. :param str key: 新的文件名,或已经存在的可追加文件名
  511. :param int position: 追加上传一个新的文件, `position` 设为0;追加一个已经存在的可追加文件, `position` 设为文件的当前长度。
  512. `position` 可以从上次追加的结果 `AppendObjectResult.next_position` 中获得。
  513. :param data: 用户数据
  514. :type data: str、bytes、file-like object或可迭代对象
  515. :param headers: 用户指定的HTTP头部。可以指定Content-Type、Content-MD5、x-oss-开头的头部等
  516. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  517. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  518. :return: :class:`AppendObjectResult <oss2.models.AppendObjectResult>`
  519. :raises: 如果 `position` 和当前文件长度不一致,抛出 :class:`PositionNotEqualToLength <oss2.exceptions.PositionNotEqualToLength>` ;
  520. 如果当前文件不是可追加类型,抛出 :class:`ObjectNotAppendable <oss2.exceptions.ObjectNotAppendable>` ;
  521. 还会抛出其他一些异常
  522. """
  523. headers = utils.set_content_type(http.CaseInsensitiveDict(headers), key)
  524. if progress_callback:
  525. data = utils.make_progress_adapter(data, progress_callback)
  526. if self.enable_crc and init_crc is not None:
  527. data = utils.make_crc_adapter(data, init_crc)
  528. logger.debug("Start to append object, bucket: {0}, key: {1}, headers: {2}, position: {3}".format(
  529. self.bucket_name, to_string(key), headers, position))
  530. resp = self.__do_object('POST', key,
  531. data=data,
  532. headers=headers,
  533. params={'append': '', 'position': str(position)})
  534. logger.debug("Append object done, req_id: {0}, statu_code: {1}".format(resp.request_id, resp.status))
  535. result = AppendObjectResult(resp)
  536. if self.enable_crc and result.crc is not None and init_crc is not None:
  537. utils.check_crc('append object', data.crc, result.crc, result.request_id)
  538. return result
  539. def get_object(self, key,
  540. byte_range=None,
  541. headers=None,
  542. progress_callback=None,
  543. process=None,
  544. params=None):
  545. """下载一个文件。
  546. 用法 ::
  547. >>> result = bucket.get_object('readme.txt')
  548. >>> print(result.read())
  549. 'hello world'
  550. :param key: 文件名
  551. :param byte_range: 指定下载范围。参见 :ref:`byte_range`
  552. :param headers: HTTP头部
  553. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  554. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  555. :param process: oss文件处理,如图像服务等。指定后process,返回的内容为处理后的文件。
  556. :param params: http 请求的查询字符串参数
  557. :type params: dict
  558. :return: file-like object
  559. :raises: 如果文件不存在,则抛出 :class:`NoSuchKey <oss2.exceptions.NoSuchKey>` ;还可能抛出其他异常
  560. """
  561. headers = http.CaseInsensitiveDict(headers)
  562. range_string = _make_range_string(byte_range)
  563. if range_string:
  564. headers['range'] = range_string
  565. params = {} if params is None else params
  566. if process:
  567. params.update({Bucket.PROCESS: process})
  568. logger.debug("Start to get object, bucket: {0}, key: {1}, range: {2}, headers: {3}, params: {4}".format(
  569. self.bucket_name, to_string(key), range_string, headers, params))
  570. resp = self.__do_object('GET', key, headers=headers, params=params)
  571. logger.debug("Get object done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  572. return GetObjectResult(resp, progress_callback, self.enable_crc)
  573. def select_object(self, key, sql,
  574. progress_callback=None,
  575. select_params=None,
  576. byte_range=None,
  577. headers=None
  578. ):
  579. """Select一个文件内容,支持(Csv,Json Doc,Json Lines及其GZIP压缩文件).
  580. 用法 ::
  581. 对于Csv:
  582. >>> result = bucket.select_object('access.log', 'select * from ossobject where _4 > 40')
  583. >>> print(result.read())
  584. 'hello world'
  585. 对于Json Doc: { contacts:[{"firstName":"abc", "lastName":"def"},{"firstName":"abc1", "lastName":"def1"}]}
  586. >>> result = bucket.select_object('sample.json', 'select s.firstName, s.lastName from ossobject.contacts[*] s', select_params = {"Json_Type":"DOCUMENT"})
  587. 对于Json Lines: {"firstName":"abc", "lastName":"def"},{"firstName":"abc1", "lastName":"def1"}
  588. >>> result = bucket.select_object('sample.json', 'select s.firstName, s.lastName from ossobject s', select_params = {"Json_Type":"LINES"})
  589. :param key: 文件名
  590. :param sql: sql statement
  591. :param select_params: select参数集合,对于Json文件必须制定Json_Type类型。参见 :ref:`select_params`
  592. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  593. :param byte_range: select content of specific range。可以设置Bytes header指定select csv时的文件起始offset和长度。
  594. :param headers: HTTP头部
  595. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  596. :return: file-like object
  597. :raises: 如果文件不存在,则抛出 :class:`NoSuchKey <oss2.exceptions.NoSuchKey>` ;还可能抛出其他异常
  598. """
  599. range_select = False
  600. headers = http.CaseInsensitiveDict(headers)
  601. range_string = _make_range_string(byte_range)
  602. if range_string:
  603. headers['range'] = range_string
  604. range_select = True
  605. if (range_select == True and
  606. (select_params is None or
  607. (SelectParameters.AllowQuotedRecordDelimiter not in select_params or str(select_params[SelectParameters.AllowQuotedRecordDelimiter]).lower() != 'false'))):
  608. raise ClientError('"AllowQuotedRecordDelimiter" must be specified in select_params as False when "Range" is specified in header.')
  609. body = xml_utils.to_select_object(sql, select_params)
  610. params = {'x-oss-process': 'csv/select'}
  611. if select_params is not None and SelectParameters.Json_Type in select_params:
  612. params['x-oss-process'] = 'json/select'
  613. self.timeout = 3600
  614. resp = self.__do_object('POST', key, data=body, headers=headers, params=params)
  615. crc_enabled = False
  616. if select_params is not None and SelectParameters.EnablePayloadCrc in select_params:
  617. if str(select_params[SelectParameters.EnablePayloadCrc]).lower() == "true":
  618. crc_enabled = True
  619. return SelectObjectResult(resp, progress_callback, crc_enabled)
  620. def get_object_to_file(self, key, filename,
  621. byte_range=None,
  622. headers=None,
  623. progress_callback=None,
  624. process=None,
  625. params=None):
  626. """下载一个文件到本地文件。
  627. :param key: 文件名
  628. :param filename: 本地文件名。要求父目录已经存在,且有写权限。
  629. :param byte_range: 指定下载范围。参见 :ref:`byte_range`
  630. :param headers: HTTP头部
  631. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  632. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  633. :param process: oss文件处理,如图像服务等。指定后process,返回的内容为处理后的文件。
  634. :param params: http 请求的查询字符串参数
  635. :type params: dict
  636. :return: 如果文件不存在,则抛出 :class:`NoSuchKey <oss2.exceptions.NoSuchKey>` ;还可能抛出其他异常
  637. """
  638. logger.debug("Start to get object to file, bucket: {0}, key: {1}, file path: {2}".format(
  639. self.bucket_name, to_string(key), filename))
  640. with open(to_unicode(filename), 'wb') as f:
  641. result = self.get_object(key, byte_range=byte_range, headers=headers, progress_callback=progress_callback,
  642. process=process, params=params)
  643. if result.content_length is None:
  644. shutil.copyfileobj(result, f)
  645. else:
  646. utils.copyfileobj_and_verify(result, f, result.content_length, request_id=result.request_id)
  647. if self.enable_crc and byte_range is None:
  648. if (headers is None) or ('Accept-Encoding' not in headers) or (headers['Accept-Encoding'] != 'gzip'):
  649. utils.check_crc('get', result.client_crc, result.server_crc, result.request_id)
  650. return result
  651. def get_object_with_url(self, sign_url,
  652. byte_range=None,
  653. headers=None,
  654. progress_callback=None):
  655. """使用加签的url下载文件
  656. :param sign_url: 加签的url
  657. :param byte_range: 指定下载范围。参见 :ref:`byte_range`
  658. :param headers: HTTP头部
  659. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict,必须和签名时保持一致
  660. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  661. :return: file-like object
  662. :raises: 如果文件不存在,则抛出 :class:`NoSuchKey <oss2.exceptions.NoSuchKey>` ;还可能抛出其他异常
  663. """
  664. headers = http.CaseInsensitiveDict(headers)
  665. range_string = _make_range_string(byte_range)
  666. if range_string:
  667. headers['range'] = range_string
  668. logger.debug("Start to get object with url, bucket: {0}, sign_url: {1}, range: {2}, headers: {3}".format(
  669. self.bucket_name, sign_url, range_string, headers))
  670. resp = self._do_url('GET', sign_url, headers=headers)
  671. return GetObjectResult(resp, progress_callback, self.enable_crc)
  672. def get_object_with_url_to_file(self, sign_url,
  673. filename,
  674. byte_range=None,
  675. headers=None,
  676. progress_callback=None):
  677. """使用加签的url下载文件
  678. :param sign_url: 加签的url
  679. :param filename: 本地文件名。要求父目录已经存在,且有写权限。
  680. :param byte_range: 指定下载范围。参见 :ref:`byte_range`
  681. :param headers: HTTP头部
  682. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict,,必须和签名时保持一致
  683. :param progress_callback: 用户指定的进度回调函数。参考 :ref:`progress_callback`
  684. :return: file-like object
  685. :raises: 如果文件不存在,则抛出 :class:`NoSuchKey <oss2.exceptions.NoSuchKey>` ;还可能抛出其他异常
  686. """
  687. logger.debug(
  688. "Start to get object with url, bucket: {0}, sign_url: {1}, file path: {2}, range: {3}, headers: {4}"
  689. .format(self.bucket_name, sign_url, filename, byte_range, headers))
  690. with open(to_unicode(filename), 'wb') as f:
  691. result = self.get_object_with_url(sign_url, byte_range=byte_range, headers=headers,
  692. progress_callback=progress_callback)
  693. if result.content_length is None:
  694. shutil.copyfileobj(result, f)
  695. else:
  696. utils.copyfileobj_and_verify(result, f, result.content_length, request_id=result.request_id)
  697. return result
  698. def select_object_to_file(self, key, filename, sql,
  699. progress_callback=None,
  700. select_params=None,
  701. headers=None
  702. ):
  703. """Select一个文件的内容到本地文件
  704. :param key: OSS文件名
  705. :param filename: 本地文件名。其父亲目录已经存在且有写权限。
  706. :param progress_callback: 调用进度的callback。参考 :ref:`progress_callback`
  707. :param select_params: select参数集合。参见 :ref:`select_params`
  708. :param headers: HTTP头部
  709. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  710. :return: 如果文件不存在, 抛出 :class:`NoSuchKey <oss2.exceptions.NoSuchKey>`
  711. """
  712. with open(to_unicode(filename), 'wb') as f:
  713. result = self.select_object(key, sql, progress_callback=progress_callback,
  714. select_params=select_params, headers=headers)
  715. for chunk in result:
  716. f.write(chunk)
  717. return result
  718. def head_object(self, key, headers=None, params=None):
  719. """获取文件元信息。
  720. HTTP响应的头部包含了文件元信息,可以通过 `RequestResult` 的 `headers` 成员获得。
  721. 用法 ::
  722. >>> result = bucket.head_object('readme.txt')
  723. >>> print(result.content_type)
  724. text/plain
  725. :param key: 文件名
  726. :param headers: HTTP头部
  727. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  728. :param params: HTTP请求参数,传入versionId,获取指定版本Object元信息
  729. :type params: 可以是dict,建议是oss2.CaseInsensitiveDict
  730. :return: :class:`HeadObjectResult <oss2.models.HeadObjectResult>`
  731. :raises: 如果Bucket不存在或者Object不存在,则抛出 :class:`NotFound <oss2.exceptions.NotFound>`
  732. """
  733. logger.debug("Start to head object, bucket: {0}, key: {1}, headers: {2}".format(
  734. self.bucket_name, to_string(key), headers))
  735. resp = self.__do_object('HEAD', key, headers=headers, params=params)
  736. logger.debug("Head object done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  737. return HeadObjectResult(resp)
  738. def create_select_object_meta(self, key, select_meta_params=None, headers=None):
  739. """获取或创建CSV,JSON LINES 文件元信息。如果元信息存在,返回之;不然则创建后返回之
  740. HTTP响应的头部包含了文件元信息,可以通过 `RequestResult` 的 `headers` 成员获得。
  741. CSV文件用法 ::
  742. >>> select_meta_params = { 'FieldDelimiter': ',',
  743. 'RecordDelimiter': '\r\n',
  744. 'QuoteCharacter': '"',
  745. 'OverwriteIfExists' : 'false'}
  746. >>> result = bucket.create_select_object_meta('csv.txt', select_meta_params)
  747. >>> print(result.rows)
  748. JSON LINES文件用法 ::
  749. >>> select_meta_params = { 'Json_Type':'LINES', 'OverwriteIfExists':'False'}
  750. >>> result = bucket.create_select_object_meta('jsonlines.json', select_meta_params)
  751. :param key: 文件名
  752. :param select_meta_params: 参数词典,可以是dict,参见ref:`csv_meta_params`
  753. :param headers: HTTP头部
  754. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  755. :return: :class:`GetSelectObjectMetaResult <oss2.models.HeadObjectResult>`.
  756. 除了 rows 和splits 属性之外, 它也返回head object返回的其他属性。
  757. rows表示该文件的总记录数。
  758. splits表示该文件的总Split个数,一个Split包含若干条记录,每个Split的总字节数大致相当。用户可以以Split为单位进行分片查询。
  759. :raises: 如果Bucket不存在或者Object不存在,则抛出:class:`NotFound <oss2.exceptions.NotFound>`
  760. """
  761. headers = http.CaseInsensitiveDict(headers)
  762. body = xml_utils.to_get_select_object_meta(select_meta_params)
  763. params = {'x-oss-process': 'csv/meta'}
  764. if select_meta_params is not None and 'Json_Type' in select_meta_params:
  765. params['x-oss-process'] = 'json/meta'
  766. self.timeout = 3600
  767. resp = self.__do_object('POST', key, data=body, headers=headers, params=params)
  768. return GetSelectObjectMetaResult(resp)
  769. def get_object_meta(self, key, params=None, headers=None):
  770. """获取文件基本元信息,包括该Object的ETag、Size(文件大小)、LastModified,并不返回其内容。
  771. HTTP响应的头部包含了文件基本元信息,可以通过 `GetObjectMetaResult` 的 `last_modified`,`content_length`,`etag` 成员获得。
  772. :param key: 文件名
  773. :param dict params: 请求参数
  774. :param headers: HTTP头部
  775. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  776. :return: :class:`GetObjectMetaResult <oss2.models.GetObjectMetaResult>`
  777. :raises: 如果文件不存在,则抛出 :class:`NoSuchKey <oss2.exceptions.NoSuchKey>` ;还可能抛出其他异常
  778. """
  779. headers = http.CaseInsensitiveDict(headers)
  780. logger.debug("Start to get object metadata, bucket: {0}, key: {1}".format(self.bucket_name, to_string(key)))
  781. if params is None:
  782. params = dict()
  783. if Bucket.OBJECTMETA not in params:
  784. params[Bucket.OBJECTMETA] = ''
  785. resp = self.__do_object('GET', key, params=params, headers=headers)
  786. logger.debug("Get object metadata done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  787. return GetObjectMetaResult(resp)
  788. def object_exists(self, key, headers=None):
  789. """如果文件存在就返回True,否则返回False。如果Bucket不存在,或是发生其他错误,则抛出异常。"""
  790. #:param key: 文件名
  791. #:param headers: HTTP头部
  792. #:type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  793. # 如果我们用head_object来实现的话,由于HTTP HEAD请求没有响应体,只有响应头部,这样当发生404时,
  794. # 我们无法区分是NoSuchBucket还是NoSuchKey错误。
  795. #
  796. # 2.2.0之前的实现是通过get_object的if-modified-since头部,把date设为当前时间24小时后,这样如果文件存在,则会返回
  797. # 304 (NotModified);不存在,则会返回NoSuchKey。get_object会受回源的影响,如果配置会404回源,get_object会判断错误。
  798. #
  799. # 目前的实现是通过get_object_meta判断文件是否存在。
  800. logger.debug("Start to check if object exists, bucket: {0}, key: {1}".format(self.bucket_name, to_string(key)))
  801. try:
  802. self.get_object_meta(key, headers=headers)
  803. except exceptions.NoSuchKey:
  804. return False
  805. except:
  806. raise
  807. return True
  808. def copy_object(self, source_bucket_name, source_key, target_key, headers=None, params=None):
  809. """拷贝一个文件到当前Bucket。
  810. :param str source_bucket_name: 源Bucket名
  811. :param str source_key: 源文件名
  812. :param str target_key: 目标文件名
  813. :param dict params: 请求参数
  814. :param headers: HTTP头部
  815. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  816. :return: :class:`PutObjectResult <oss2.models.PutObjectResult>`
  817. """
  818. headers = http.CaseInsensitiveDict(headers)
  819. if params and Bucket.VERSIONID in params:
  820. headers[OSS_COPY_OBJECT_SOURCE] = '/' + source_bucket_name + \
  821. '/' + urlquote(source_key, '') + '?versionId=' + params[Bucket.VERSIONID]
  822. else:
  823. headers[OSS_COPY_OBJECT_SOURCE] = '/' + source_bucket_name + '/' + urlquote(source_key, '')
  824. logger.debug(
  825. "Start to copy object, source bucket: {0}, source key: {1}, bucket: {2}, key: {3}, headers: {4}".format(
  826. source_bucket_name, to_string(source_key), self.bucket_name, to_string(target_key), headers))
  827. resp = self.__do_object('PUT', target_key, headers=headers)
  828. logger.debug("Copy object done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  829. return PutObjectResult(resp)
  830. def update_object_meta(self, key, headers):
  831. """更改Object的元数据信息,包括Content-Type这类标准的HTTP头部,以及以x-oss-meta-开头的自定义元数据。
  832. 用户可以通过 :func:`head_object` 获得元数据信息。
  833. :param str key: 文件名
  834. :param headers: HTTP头部,包含了元数据信息
  835. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  836. :return: :class:`RequestResult <oss2.models.RequestResults>`
  837. """
  838. logger.debug("Start to update object metadata, bucket: {0}, key: {1}".format(self.bucket_name, to_string(key)))
  839. return self.copy_object(self.bucket_name, key, key, headers=headers)
  840. def delete_object(self, key, params=None, headers=None):
  841. """删除一个文件。
  842. :param str key: 文件名
  843. :param params: 请求参数
  844. :param headers: HTTP头部
  845. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  846. :return: :class:`RequestResult <oss2.models.RequestResult>`
  847. """
  848. headers = http.CaseInsensitiveDict(headers)
  849. logger.info("Start to delete object, bucket: {0}, key: {1}".format(self.bucket_name, to_string(key)))
  850. resp = self.__do_object('DELETE', key, params=params, headers=headers)
  851. logger.debug("Delete object done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  852. return RequestResult(resp)
  853. def restore_object(self, key, params=None, headers=None, input=None):
  854. """restore an object
  855. 如果是第一次针对该object调用接口,返回RequestResult.status = 202;
  856. 如果已经成功调用过restore接口,且服务端仍处于解冻中,抛异常RestoreAlreadyInProgress(status=409)
  857. 如果已经成功调用过restore接口,且服务端解冻已经完成,再次调用时返回RequestResult.status = 200,且会将object的可下载时间延长一天,最多延长7天。
  858. 如果object不存在,则抛异常NoSuchKey(status=404);
  859. 对非Archive类型的Object提交restore,则抛异常OperationNotSupported(status=400)
  860. 也可以通过调用head_object接口来获取meta信息来判断是否可以restore与restore的状态
  861. 代码示例::
  862. >>> meta = bucket.head_object(key)
  863. >>> if meta.resp.headers['x-oss-storage-class'] == oss2.BUCKET_STORAGE_CLASS_ARCHIVE:
  864. >>> bucket.restore_object(key)
  865. >>> while True:
  866. >>> meta = bucket.head_object(key)
  867. >>> if meta.resp.headers['x-oss-restore'] == 'ongoing-request="true"':
  868. >>> time.sleep(5)
  869. >>> else:
  870. >>> break
  871. :param str key: object name
  872. :param params: 请求参数
  873. :param headers: HTTP头部
  874. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  875. :param input: 解冻配置。
  876. :type input: class:`RestoreConfiguration <oss2.models.RestoreConfiguration>`
  877. :return: :class:`RequestResult <oss2.models.RequestResult>`
  878. """
  879. headers = http.CaseInsensitiveDict(headers)
  880. logger.debug("Start to restore object, bucket: {0}, key: {1}".format(self.bucket_name, to_string(key)))
  881. if params is None:
  882. params = dict()
  883. if Bucket.RESTORE not in params:
  884. params[Bucket.RESTORE] = ''
  885. data = self.__convert_data(RestoreConfiguration, xml_utils.to_put_restore_config, input)
  886. resp = self.__do_object('POST', key, params=params, headers=headers, data=data)
  887. logger.debug("Restore object done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  888. return RequestResult(resp)
  889. def put_object_acl(self, key, permission, params=None, headers=None):
  890. """设置文件的ACL。
  891. :param str key: 文件名
  892. :param str permission: 可以是oss2.OBJECT_ACL_DEFAULT、oss2.OBJECT_ACL_PRIVATE、oss2.OBJECT_ACL_PUBLIC_READ或
  893. oss2.OBJECT_ACL_PUBLIC_READ_WRITE。
  894. :param dict params: 请求参数
  895. :param headers: HTTP头部
  896. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  897. :return: :class:`RequestResult <oss2.models.RequestResult>`
  898. """
  899. logger.debug("Start to put object acl, bucket: {0}, key: {1}, acl: {2}".format(
  900. self.bucket_name, to_string(key), permission))
  901. headers = http.CaseInsensitiveDict(headers)
  902. headers[OSS_OBJECT_ACL] = permission
  903. if params is None:
  904. params = dict()
  905. if Bucket.ACL not in params:
  906. params[Bucket.ACL] = ''
  907. resp = self.__do_object('PUT', key, params=params, headers=headers)
  908. logger.debug("Put object acl done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  909. return RequestResult(resp)
  910. def get_object_acl(self, key, params=None, headers=None):
  911. """获取文件的ACL。
  912. :param key: 文件名
  913. :param params: 请求参数
  914. :param headers: HTTP头部
  915. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  916. :return: :class:`GetObjectAclResult <oss2.models.GetObjectAclResult>`
  917. """
  918. logger.debug("Start to get object acl, bucket: {0}, key: {1}".format(self.bucket_name, to_string(key)))
  919. headers = http.CaseInsensitiveDict(headers)
  920. if params is None:
  921. params = dict()
  922. if Bucket.ACL not in params:
  923. params[Bucket.ACL] = ''
  924. resp = self.__do_object('GET', key, params=params, headers=headers)
  925. logger.debug("Get object acl done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  926. return self._parse_result(resp, xml_utils.parse_get_object_acl, GetObjectAclResult)
  927. def batch_delete_objects(self, key_list, headers=None):
  928. """批量删除文件。待删除文件列表不能为空。
  929. :param key_list: 文件名列表,不能为空。
  930. :type key_list: list of str
  931. :param headers: HTTP头部
  932. :return: :class:`BatchDeleteObjectsResult <oss2.models.BatchDeleteObjectsResult>`
  933. """
  934. if not key_list:
  935. raise ClientError('key_list should not be empty')
  936. logger.debug("Start to delete objects, bucket: {0}, keys: {1}".format(self.bucket_name, key_list))
  937. data = xml_utils.to_batch_delete_objects_request(key_list, False)
  938. headers = http.CaseInsensitiveDict(headers)
  939. headers['Content-MD5'] = utils.content_md5(data)
  940. resp = self.__do_object('POST', '',
  941. data=data,
  942. params={'delete': '', 'encoding-type': 'url'},
  943. headers=headers)
  944. logger.debug("Delete objects done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  945. return self._parse_result(resp, xml_utils.parse_batch_delete_objects, BatchDeleteObjectsResult)
  946. def delete_object_versions(self, keylist_versions, headers=None):
  947. """批量删除带版本文件。待删除文件列表不能为空。
  948. :param key_list_with_version: 带版本的文件名列表,不能为空。(如果传入,则不能为空)
  949. :type key_list: list of BatchDeleteObjectsList
  950. :param headers: HTTP头部
  951. :return: :class:`BatchDeleteObjectsResult <oss2.models.BatchDeleteObjectsResult>`
  952. """
  953. if not keylist_versions:
  954. raise ClientError('keylist_versions should not be empty')
  955. logger.debug("Start to delete object versions, bucket: {0}".format(self.bucket_name))
  956. data = xml_utils.to_batch_delete_objects_version_request(keylist_versions, False)
  957. headers = http.CaseInsensitiveDict(headers)
  958. headers['Content-MD5'] = utils.content_md5(data)
  959. resp = self.__do_object('POST', '',
  960. data=data,
  961. params={'delete': '', 'encoding-type': 'url'},
  962. headers=headers)
  963. logger.debug("Delete object versions done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  964. return self._parse_result(resp, xml_utils.parse_batch_delete_objects, BatchDeleteObjectsResult)
  965. def init_multipart_upload(self, key, headers=None, params=None):
  966. """初始化分片上传。
  967. 返回值中的 `upload_id` 以及Bucket名和Object名三元组唯一对应了此次分片上传事件。
  968. :param str key: 待上传的文件名
  969. :param headers: HTTP头部
  970. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  971. :return: :class:`InitMultipartUploadResult <oss2.models.InitMultipartUploadResult>`
  972. """
  973. headers = utils.set_content_type(http.CaseInsensitiveDict(headers), key)
  974. if params is None:
  975. tmp_params = dict()
  976. else:
  977. tmp_params = params.copy()
  978. tmp_params['uploads'] = ''
  979. logger.debug("Start to init multipart upload, bucket: {0}, keys: {1}, headers: {2}, params: {3}".format(
  980. self.bucket_name, to_string(key), headers, tmp_params))
  981. resp = self.__do_object('POST', key, params=tmp_params, headers=headers)
  982. logger.debug("Init multipart upload done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  983. return self._parse_result(resp, xml_utils.parse_init_multipart_upload, InitMultipartUploadResult)
  984. def upload_part(self, key, upload_id, part_number, data, progress_callback=None, headers=None):
  985. """上传一个分片。
  986. :param str key: 待上传文件名,这个文件名要和 :func:`init_multipart_upload` 的文件名一致。
  987. :param str upload_id: 分片上传ID
  988. :param int part_number: 分片号,最小值是1.
  989. :param data: 待上传数据。
  990. :param progress_callback: 用户指定进度回调函数。可以用来实现进度条等功能。参考 :ref:`progress_callback` 。
  991. :param headers: 用户指定的HTTP头部。可以指定Content-MD5头部等
  992. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  993. :return: :class:`PutObjectResult <oss2.models.PutObjectResult>`
  994. """
  995. headers = http.CaseInsensitiveDict(headers)
  996. if progress_callback:
  997. data = utils.make_progress_adapter(data, progress_callback)
  998. if self.enable_crc:
  999. data = utils.make_crc_adapter(data)
  1000. logger.debug(
  1001. "Start to upload multipart, bucket: {0}, key: {1}, upload_id: {2}, part_number: {3}, headers: {4}".format(
  1002. self.bucket_name, to_string(key), upload_id, part_number, headers))
  1003. resp = self.__do_object('PUT', key,
  1004. params={'uploadId': upload_id, 'partNumber': str(part_number)},
  1005. headers=headers,
  1006. data=data)
  1007. logger.debug("Upload multipart done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1008. result = PutObjectResult(resp)
  1009. if self.enable_crc and result.crc is not None:
  1010. utils.check_crc('upload part', data.crc, result.crc, result.request_id)
  1011. return result
  1012. def complete_multipart_upload(self, key, upload_id, parts, headers=None):
  1013. """完成分片上传,创建文件。
  1014. :param str key: 待上传的文件名,这个文件名要和 :func:`init_multipart_upload` 的文件名一致。
  1015. :param str upload_id: 分片上传ID
  1016. :param parts: PartInfo列表。PartInfo中的part_number和etag是必填项。其中的etag可以从 :func:`upload_part` 的返回值中得到。
  1017. :type parts: list of `PartInfo <oss2.models.PartInfo>`
  1018. :param headers: HTTP头部
  1019. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1020. :return: :class:`PutObjectResult <oss2.models.PutObjectResult>`
  1021. """
  1022. headers = http.CaseInsensitiveDict(headers)
  1023. parts = sorted(parts, key=lambda p: p.part_number)
  1024. data = xml_utils.to_complete_upload_request(parts)
  1025. logger.debug("Start to complete multipart upload, bucket: {0}, key: {1}, upload_id: {2}, parts: {3}".format(
  1026. self.bucket_name, to_string(key), upload_id, data))
  1027. resp = self.__do_object('POST', key,
  1028. params={'uploadId': upload_id},
  1029. data=data,
  1030. headers=headers)
  1031. logger.debug(
  1032. "Complete multipart upload done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1033. result = PutObjectResult(resp)
  1034. if self.enable_crc:
  1035. object_crc = utils.calc_obj_crc_from_parts(parts)
  1036. utils.check_crc('multipart upload', object_crc, result.crc, result.request_id)
  1037. return result
  1038. def abort_multipart_upload(self, key, upload_id, headers=None):
  1039. """取消分片上传。
  1040. :param str key: 待上传的文件名,这个文件名要和 :func:`init_multipart_upload` 的文件名一致。
  1041. :param str upload_id: 分片上传ID
  1042. :param headers: HTTP头部
  1043. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1044. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1045. """
  1046. logger.debug("Start to abort multipart upload, bucket: {0}, key: {1}, upload_id: {2}".format(
  1047. self.bucket_name, to_string(key), upload_id))
  1048. headers = http.CaseInsensitiveDict(headers)
  1049. resp = self.__do_object('DELETE', key,
  1050. params={'uploadId': upload_id}, headers=headers)
  1051. logger.debug("Abort multipart done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1052. return RequestResult(resp)
  1053. def list_multipart_uploads(self,
  1054. prefix='',
  1055. delimiter='',
  1056. key_marker='',
  1057. upload_id_marker='',
  1058. max_uploads=1000,
  1059. headers=None):
  1060. """罗列正在进行中的分片上传。支持分页。
  1061. :param str prefix: 只罗列匹配该前缀的文件的分片上传
  1062. :param str delimiter: 目录分割符
  1063. :param str key_marker: 文件名分页符。第一次调用可以不传,后续设为返回值中的 `next_key_marker`
  1064. :param str upload_id_marker: 分片ID分页符。第一次调用可以不传,后续设为返回值中的 `next_upload_id_marker`
  1065. :param int max_uploads: 一次罗列最多能够返回的条目数
  1066. :param headers: HTTP头部
  1067. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1068. :return: :class:`ListMultipartUploadsResult <oss2.models.ListMultipartUploadsResult>`
  1069. """
  1070. logger.debug("Start to list multipart uploads, bucket: {0}, prefix: {1}, delimiter: {2}, key_marker: {3}, "
  1071. "upload_id_marker: {4}, max_uploads: {5}".format(self.bucket_name, to_string(prefix), delimiter,
  1072. to_string(key_marker), upload_id_marker,
  1073. max_uploads))
  1074. headers = http.CaseInsensitiveDict(headers)
  1075. resp = self.__do_object('GET', '',
  1076. params={'uploads': '',
  1077. 'prefix': prefix,
  1078. 'delimiter': delimiter,
  1079. 'key-marker': key_marker,
  1080. 'upload-id-marker': upload_id_marker,
  1081. 'max-uploads': str(max_uploads),
  1082. 'encoding-type': 'url'},
  1083. headers=headers)
  1084. logger.debug("List multipart uploads done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1085. return self._parse_result(resp, xml_utils.parse_list_multipart_uploads, ListMultipartUploadsResult)
  1086. def upload_part_copy(self, source_bucket_name, source_key, byte_range,
  1087. target_key, target_upload_id, target_part_number,
  1088. headers=None, params=None):
  1089. """分片拷贝。把一个已有文件的一部分或整体拷贝成目标文件的一个分片。
  1090. :source_bucket_name: 源文件所在bucket的名称
  1091. :source_key:源文件名称
  1092. :param byte_range: 指定待拷贝内容在源文件里的范围。参见 :ref:`byte_range`
  1093. :target_key: 目的文件的名称
  1094. :target_upload_id: 目的文件的uploadid
  1095. :target_part_number: 目的文件的分片号
  1096. :param params: 请求参数
  1097. :param headers: HTTP头部
  1098. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1099. :return: :class:`PutObjectResult <oss2.models.PutObjectResult>`
  1100. """
  1101. headers = http.CaseInsensitiveDict(headers)
  1102. if params and Bucket.VERSIONID in params:
  1103. headers[OSS_COPY_OBJECT_SOURCE] = '/' + source_bucket_name + \
  1104. '/' + urlquote(source_key, '') + '?versionId=' + params[Bucket.VERSIONID]
  1105. else:
  1106. headers[OSS_COPY_OBJECT_SOURCE] = '/' + source_bucket_name + '/' + urlquote(source_key, '')
  1107. range_string = _make_range_string(byte_range)
  1108. if range_string:
  1109. headers[OSS_COPY_OBJECT_SOURCE_RANGE] = range_string
  1110. logger.debug("Start to upload part copy, source bucket: {0}, source key: {1}, bucket: {2}, key: {3}, range"
  1111. ": {4}, upload id: {5}, part_number: {6}, headers: {7}".format(source_bucket_name,
  1112. to_string(source_key),self.bucket_name,to_string(target_key),
  1113. byte_range, target_upload_id,target_part_number, headers))
  1114. if params is None:
  1115. params = dict()
  1116. params['uploadId'] = target_upload_id
  1117. params['partNumber'] = str(target_part_number)
  1118. resp = self.__do_object('PUT', target_key,
  1119. params=params,headers=headers)
  1120. logger.debug("Upload part copy done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1121. return PutObjectResult(resp)
  1122. def list_parts(self, key, upload_id,
  1123. marker='', max_parts=1000, headers=None):
  1124. """列举已经上传的分片。支持分页。
  1125. :param headers: HTTP头部
  1126. :param str key: 文件名
  1127. :param str upload_id: 分片上传ID
  1128. :param str marker: 分页符
  1129. :param int max_parts: 一次最多罗列多少分片
  1130. :param headers: HTTP头部
  1131. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1132. :return: :class:`ListPartsResult <oss2.models.ListPartsResult>`
  1133. """
  1134. logger.debug("Start to list parts, bucket: {0}, key: {1}, upload_id: {2}, marker: {3}, max_parts: {4}".format(
  1135. self.bucket_name, to_string(key), upload_id, marker, max_parts))
  1136. headers = http.CaseInsensitiveDict(headers)
  1137. resp = self.__do_object('GET', key,
  1138. params={'uploadId': upload_id,
  1139. 'part-number-marker': marker,
  1140. 'max-parts': str(max_parts)},
  1141. headers=headers)
  1142. logger.debug("List parts done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1143. return self._parse_result(resp, xml_utils.parse_list_parts, ListPartsResult)
  1144. def put_symlink(self, target_key, symlink_key, headers=None):
  1145. """创建Symlink。
  1146. :param str target_key: 目标文件,目标文件不能为符号连接
  1147. :param str symlink_key: 符号连接类文件,其实质是一个特殊的文件,数据指向目标文件
  1148. :param headers: HTTP头部
  1149. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1150. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1151. """
  1152. headers = http.CaseInsensitiveDict(headers)
  1153. headers[OSS_SYMLINK_TARGET] = urlquote(target_key, '')
  1154. logger.debug("Start to put symlink, bucket: {0}, target_key: {1}, symlink_key: {2}, headers: {3}".format(
  1155. self.bucket_name, to_string(target_key), to_string(symlink_key), headers))
  1156. resp = self.__do_object('PUT', symlink_key, headers=headers, params={Bucket.SYMLINK: ''})
  1157. logger.debug("Put symlink done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1158. return RequestResult(resp)
  1159. def get_symlink(self, symlink_key, params=None, headers=None):
  1160. """获取符号连接文件的目标文件。
  1161. :param str symlink_key: 符号连接类文件
  1162. :param dict params: 请求参数
  1163. :param headers: HTTP头部
  1164. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1165. :return: :class:`GetSymlinkResult <oss2.models.GetSymlinkResult>`
  1166. :raises: 如果文件的符号链接不存在,则抛出 :class:`NoSuchKey <oss2.exceptions.NoSuchKey>` ;还可能抛出其他异常
  1167. """
  1168. logger.debug(
  1169. "Start to get symlink, bucket: {0}, symlink_key: {1}".format(self.bucket_name, to_string(symlink_key)))
  1170. headers = http.CaseInsensitiveDict(headers)
  1171. if params is None:
  1172. params = dict()
  1173. if Bucket.SYMLINK not in params:
  1174. params[Bucket.SYMLINK] = ''
  1175. resp = self.__do_object('GET', symlink_key, params=params, headers=headers)
  1176. logger.debug("Get symlink done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1177. return GetSymlinkResult(resp)
  1178. def create_bucket(self, permission=None, input=None):
  1179. """创建新的Bucket。
  1180. :param str permission: 指定Bucket的ACL。可以是oss2.BUCKET_ACL_PRIVATE(推荐、缺省)、oss2.BUCKET_ACL_PUBLIC_READ或是
  1181. oss2.BUCKET_ACL_PUBLIC_READ_WRITE。
  1182. :param input: :class:`BucketCreateConfig <oss2.models.BucketCreateConfig>` object
  1183. """
  1184. if permission:
  1185. headers = {OSS_CANNED_ACL: permission}
  1186. else:
  1187. headers = None
  1188. data = self.__convert_data(BucketCreateConfig, xml_utils.to_put_bucket_config, input)
  1189. logger.debug("Start to create bucket, bucket: {0}, permission: {1}, config: {2}".format(self.bucket_name,
  1190. permission, data))
  1191. resp = self.__do_bucket('PUT', headers=headers, data=data)
  1192. logger.debug("Create bucket done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1193. return RequestResult(resp)
  1194. def delete_bucket(self):
  1195. """删除一个Bucket。只有没有任何文件,也没有任何未完成的分片上传的Bucket才能被删除。
  1196. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1197. ":raises: 如果试图删除一个非空Bucket,则抛出 :class:`BucketNotEmpty <oss2.exceptions.BucketNotEmpty>`
  1198. """
  1199. logger.info("Start to delete bucket, bucket: {0}".format(self.bucket_name))
  1200. resp = self.__do_bucket('DELETE')
  1201. logger.debug("Delete bucket done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1202. return RequestResult(resp)
  1203. def put_bucket_acl(self, permission):
  1204. """设置Bucket的ACL。
  1205. :param str permission: 新的ACL,可以是oss2.BUCKET_ACL_PRIVATE、oss2.BUCKET_ACL_PUBLIC_READ或
  1206. oss2.BUCKET_ACL_PUBLIC_READ_WRITE
  1207. """
  1208. logger.debug("Start to put bucket acl, bucket: {0}, acl: {1}".format(self.bucket_name, permission))
  1209. resp = self.__do_bucket('PUT', headers={OSS_CANNED_ACL: permission}, params={Bucket.ACL: ''})
  1210. logger.debug("Put bucket acl done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1211. return RequestResult(resp)
  1212. def get_bucket_acl(self):
  1213. """获取Bucket的ACL。
  1214. :return: :class:`GetBucketAclResult <oss2.models.GetBucketAclResult>`
  1215. """
  1216. logger.debug("Start to get bucket acl, bucket: {0}".format(self.bucket_name))
  1217. resp = self.__do_bucket('GET', params={Bucket.ACL: ''})
  1218. logger.debug("Get bucket acl done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1219. return self._parse_result(resp, xml_utils.parse_get_bucket_acl, GetBucketAclResult)
  1220. def put_bucket_cors(self, input):
  1221. """设置Bucket的CORS。
  1222. :param input: :class:`BucketCors <oss2.models.BucketCors>` 对象或其他
  1223. """
  1224. data = self.__convert_data(BucketCors, xml_utils.to_put_bucket_cors, input)
  1225. logger.debug("Start to put bucket cors, bucket: {0}, cors: {1}".format(self.bucket_name, data))
  1226. resp = self.__do_bucket('PUT', data=data, params={Bucket.CORS: ''})
  1227. logger.debug("Put bucket cors done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1228. return RequestResult(resp)
  1229. def get_bucket_cors(self):
  1230. """获取Bucket的CORS配置。
  1231. :return: :class:`GetBucketCorsResult <oss2.models.GetBucketCorsResult>`
  1232. """
  1233. logger.debug("Start to get bucket CORS, bucket: {0}".format(self.bucket_name))
  1234. resp = self.__do_bucket('GET', params={Bucket.CORS: ''})
  1235. logger.debug("Get bucket CORS done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1236. return self._parse_result(resp, xml_utils.parse_get_bucket_cors, GetBucketCorsResult)
  1237. def delete_bucket_cors(self):
  1238. """删除Bucket的CORS配置。"""
  1239. logger.debug("Start to delete bucket CORS, bucket: {0}".format(self.bucket_name))
  1240. resp = self.__do_bucket('DELETE', params={Bucket.CORS: ''})
  1241. logger.debug("Delete bucket CORS done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1242. return RequestResult(resp)
  1243. def put_bucket_lifecycle(self, input):
  1244. """设置生命周期管理的配置。
  1245. :param input: :class:`BucketLifecycle <oss2.models.BucketLifecycle>` 对象或其他
  1246. """
  1247. data = self.__convert_data(BucketLifecycle, xml_utils.to_put_bucket_lifecycle, input)
  1248. logger.debug("Start to put bucket lifecycle, bucket: {0}, lifecycle: {1}".format(self.bucket_name, data))
  1249. resp = self.__do_bucket('PUT', data=data, params={Bucket.LIFECYCLE: ''})
  1250. logger.debug("Put bucket lifecycle done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1251. return RequestResult(resp)
  1252. def get_bucket_lifecycle(self):
  1253. """获取生命周期管理配置。
  1254. :return: :class:`GetBucketLifecycleResult <oss2.models.GetBucketLifecycleResult>`
  1255. :raises: 如果没有设置Lifecycle,则抛出 :class:`NoSuchLifecycle <oss2.exceptions.NoSuchLifecycle>`
  1256. """
  1257. logger.debug("Start to get bucket lifecycle, bucket: {0}".format(self.bucket_name))
  1258. resp = self.__do_bucket('GET', params={Bucket.LIFECYCLE: ''})
  1259. logger.debug("Get bucket lifecycle done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1260. return self._parse_result(resp, xml_utils.parse_get_bucket_lifecycle, GetBucketLifecycleResult)
  1261. def delete_bucket_lifecycle(self):
  1262. """删除生命周期管理配置。如果Lifecycle没有设置,也返回成功。"""
  1263. logger.debug("Start to delete bucket lifecycle, bucket: {0}".format(self.bucket_name))
  1264. resp = self.__do_bucket('DELETE', params={Bucket.LIFECYCLE: ''})
  1265. logger.debug("Delete bucket lifecycle done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1266. return RequestResult(resp)
  1267. def get_bucket_location(self):
  1268. """获取Bucket的数据中心。
  1269. :return: :class:`GetBucketLocationResult <oss2.models.GetBucketLocationResult>`
  1270. """
  1271. logger.debug("Start to get bucket location, bucket: {0}".format(self.bucket_name))
  1272. resp = self.__do_bucket('GET', params={Bucket.LOCATION: ''})
  1273. logger.debug("Get bucket location done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1274. return self._parse_result(resp, xml_utils.parse_get_bucket_location, GetBucketLocationResult)
  1275. def put_bucket_logging(self, input):
  1276. """设置Bucket的访问日志功能。
  1277. :param input: :class:`BucketLogging <oss2.models.BucketLogging>` 对象或其他
  1278. """
  1279. data = self.__convert_data(BucketLogging, xml_utils.to_put_bucket_logging, input)
  1280. logger.debug("Start to put bucket logging, bucket: {0}, logging: {1}".format(self.bucket_name, data))
  1281. resp = self.__do_bucket('PUT', data=data, params={Bucket.LOGGING: ''})
  1282. logger.debug("Put bucket logging done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1283. return RequestResult(resp)
  1284. def get_bucket_logging(self):
  1285. """获取Bucket的访问日志功能配置。
  1286. :return: :class:`GetBucketLoggingResult <oss2.models.GetBucketLoggingResult>`
  1287. """
  1288. logger.debug("Start to get bucket logging, bucket: {0}".format(self.bucket_name))
  1289. resp = self.__do_bucket('GET', params={Bucket.LOGGING: ''})
  1290. logger.debug("Get bucket logging done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1291. return self._parse_result(resp, xml_utils.parse_get_bucket_logging, GetBucketLoggingResult)
  1292. def delete_bucket_logging(self):
  1293. """关闭Bucket的访问日志功能。"""
  1294. logger.debug("Start to delete bucket loggging, bucket: {0}".format(self.bucket_name))
  1295. resp = self.__do_bucket('DELETE', params={Bucket.LOGGING: ''})
  1296. logger.debug("Put bucket lifecycle done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1297. return RequestResult(resp)
  1298. def put_bucket_referer(self, input):
  1299. """为Bucket设置防盗链。
  1300. :param input: :class:`BucketReferer <oss2.models.BucketReferer>` 对象或其他
  1301. """
  1302. data = self.__convert_data(BucketReferer, xml_utils.to_put_bucket_referer, input)
  1303. logger.debug("Start to put bucket referer, bucket: {0}, referer: {1}".format(self.bucket_name, to_string(data)))
  1304. resp = self.__do_bucket('PUT', data=data, params={Bucket.REFERER: ''})
  1305. logger.debug("Put bucket referer done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1306. return RequestResult(resp)
  1307. def get_bucket_referer(self):
  1308. """获取Bucket的防盗链配置。
  1309. :return: :class:`GetBucketRefererResult <oss2.models.GetBucketRefererResult>`
  1310. """
  1311. logger.debug("Start to get bucket referer, bucket: {0}".format(self.bucket_name))
  1312. resp = self.__do_bucket('GET', params={Bucket.REFERER: ''})
  1313. logger.debug("Get bucket referer done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1314. return self._parse_result(resp, xml_utils.parse_get_bucket_referer, GetBucketRefererResult)
  1315. def get_bucket_stat(self):
  1316. """查看Bucket的状态,目前包括bucket大小,bucket的object数量,bucket正在上传的Multipart Upload事件个数等。
  1317. :return: :class:`GetBucketStatResult <oss2.models.GetBucketStatResult>`
  1318. """
  1319. logger.debug("Start to get bucket stat, bucket: {0}".format(self.bucket_name))
  1320. resp = self.__do_bucket('GET', params={Bucket.STAT: ''})
  1321. logger.debug("Get bucket stat done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1322. return self._parse_result(resp, xml_utils.parse_get_bucket_stat, GetBucketStatResult)
  1323. def get_bucket_info(self):
  1324. """获取bucket相关信息,如创建时间,访问Endpoint,Owner与ACL等。
  1325. :return: :class:`GetBucketInfoResult <oss2.models.GetBucketInfoResult>`
  1326. """
  1327. logger.debug("Start to get bucket info, bucket: {0}".format(self.bucket_name))
  1328. resp = self.__do_bucket('GET', params={Bucket.BUCKET_INFO: ''})
  1329. logger.debug("Get bucket info done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1330. return self._parse_result(resp, xml_utils.parse_get_bucket_info, GetBucketInfoResult)
  1331. def put_bucket_website(self, input):
  1332. """为Bucket配置静态网站托管功能。
  1333. :param input: :class:`BucketWebsite <oss2.models.BucketWebsite>`
  1334. """
  1335. data = self.__convert_data(BucketWebsite, xml_utils.to_put_bucket_website, input)
  1336. headers = http.CaseInsensitiveDict()
  1337. headers['Content-MD5'] = utils.content_md5(data)
  1338. logger.debug("Start to put bucket website, bucket: {0}, website: {1}".format(self.bucket_name, to_string(data)))
  1339. resp = self.__do_bucket('PUT', data=data, params={Bucket.WEBSITE: ''}, headers=headers)
  1340. logger.debug("Put bucket website done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1341. return RequestResult(resp)
  1342. def get_bucket_website(self):
  1343. """获取Bucket的静态网站托管配置。
  1344. :return: :class:`GetBucketWebsiteResult <oss2.models.GetBucketWebsiteResult>`
  1345. :raises: 如果没有设置静态网站托管,那么就抛出 :class:`NoSuchWebsite <oss2.exceptions.NoSuchWebsite>`
  1346. """
  1347. logger.debug("Start to get bucket website, bucket: {0}".format(self.bucket_name))
  1348. resp = self.__do_bucket('GET', params={Bucket.WEBSITE: ''})
  1349. logger.debug("Get bucket website done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1350. return self._parse_result(resp, xml_utils.parse_get_bucket_website, GetBucketWebsiteResult)
  1351. def delete_bucket_website(self):
  1352. """关闭Bucket的静态网站托管功能。"""
  1353. logger.debug("Start to delete bucket website, bucket: {0}".format(self.bucket_name))
  1354. resp = self.__do_bucket('DELETE', params={Bucket.WEBSITE: ''})
  1355. logger.debug("Delete bucket website done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1356. return RequestResult(resp)
  1357. def create_live_channel(self, channel_name, input):
  1358. """创建推流直播频道
  1359. :param str channel_name: 要创建的live channel的名称
  1360. :param input: LiveChannelInfo类型,包含了live channel中的描述信息
  1361. :return: :class:`CreateLiveChannelResult <oss2.models.CreateLiveChannelResult>`
  1362. """
  1363. data = self.__convert_data(LiveChannelInfo, xml_utils.to_create_live_channel, input)
  1364. logger.debug("Start to create live-channel, bucket: {0}, channel_name: {1}, info: {2}".format(
  1365. self.bucket_name, to_string(channel_name), to_string(data)))
  1366. resp = self.__do_object('PUT', channel_name, data=data, params={Bucket.LIVE: ''})
  1367. logger.debug("Create live-channel done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1368. return self._parse_result(resp, xml_utils.parse_create_live_channel, CreateLiveChannelResult)
  1369. def delete_live_channel(self, channel_name):
  1370. """删除推流直播频道
  1371. :param str channel_name: 要删除的live channel的名称
  1372. """
  1373. logger.debug("Start to delete live-channel, bucket: {0}, live_channel: {1}".format(
  1374. self.bucket_name, to_string(channel_name)))
  1375. resp = self.__do_object('DELETE', channel_name, params={Bucket.LIVE: ''})
  1376. logger.debug("Delete live-channel done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1377. return RequestResult(resp)
  1378. def get_live_channel(self, channel_name):
  1379. """获取直播频道配置
  1380. :param str channel_name: 要获取的live channel的名称
  1381. :return: :class:`GetLiveChannelResult <oss2.models.GetLiveChannelResult>`
  1382. """
  1383. logger.debug("Start to get live-channel info: bucket: {0}, live_channel: {1}".format(
  1384. self.bucket_name, to_string(channel_name)))
  1385. resp = self.__do_object('GET', channel_name, params={Bucket.LIVE: ''})
  1386. logger.debug("Get live-channel done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1387. return self._parse_result(resp, xml_utils.parse_get_live_channel, GetLiveChannelResult)
  1388. def list_live_channel(self, prefix='', marker='', max_keys=100):
  1389. """列举出Bucket下所有符合条件的live channel
  1390. param: str prefix: list时channel_id的公共前缀
  1391. param: str marker: list时指定的起始标记
  1392. param: int max_keys: 本次list返回live channel的最大个数
  1393. return: :class:`ListLiveChannelResult <oss2.models.ListLiveChannelResult>`
  1394. """
  1395. logger.debug("Start to list live-channels, bucket: {0}, prefix: {1}, marker: {2}, max_keys: {3}".format(
  1396. self.bucket_name, to_string(prefix), to_string(marker), max_keys))
  1397. resp = self.__do_bucket('GET', params={Bucket.LIVE: '',
  1398. 'prefix': prefix,
  1399. 'marker': marker,
  1400. 'max-keys': str(max_keys)})
  1401. logger.debug("List live-channel done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1402. return self._parse_result(resp, xml_utils.parse_list_live_channel, ListLiveChannelResult)
  1403. def get_live_channel_stat(self, channel_name):
  1404. """获取live channel当前推流的状态
  1405. param str channel_name: 要获取推流状态的live channel的名称
  1406. return: :class:`GetLiveChannelStatResult <oss2.models.GetLiveChannelStatResult>`
  1407. """
  1408. logger.debug("Start to get live-channel stat, bucket: {0}, channel_name: {1}".format(
  1409. self.bucket_name, to_string(channel_name)))
  1410. resp = self.__do_object('GET', channel_name, params={Bucket.LIVE: '', Bucket.COMP: 'stat'})
  1411. logger.debug("Get live-channel stat done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1412. return self._parse_result(resp, xml_utils.parse_live_channel_stat, GetLiveChannelStatResult)
  1413. def put_live_channel_status(self, channel_name, status):
  1414. """更改live channel的status,仅能在“enabled”和“disabled”两种状态中更改
  1415. param str channel_name: 要更改status的live channel的名称
  1416. param str status: live channel的目标status
  1417. """
  1418. logger.debug("Start to put live-channel status, bucket: {0}, channel_name: {1}, status: {2}".format(
  1419. self.bucket_name, to_string(channel_name), status))
  1420. resp = self.__do_object('PUT', channel_name, params={Bucket.LIVE: '', Bucket.STATUS: status})
  1421. logger.debug("Put live-channel status done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1422. return RequestResult(resp)
  1423. def get_live_channel_history(self, channel_name):
  1424. """获取live channel中最近的最多十次的推流记录,记录中包含推流的起止时间和远端的地址
  1425. param str channel_name: 要获取最近推流记录的live channel的名称
  1426. return: :class:`GetLiveChannelHistoryResult <oss2.models.GetLiveChannelHistoryResult>`
  1427. """
  1428. logger.debug("Start to get live-channel history, bucket: {0}, channel_name: {1}".format(
  1429. self.bucket_name, to_string(channel_name)))
  1430. resp = self.__do_object('GET', channel_name, params={Bucket.LIVE: '', Bucket.COMP: 'history'})
  1431. logger.debug(
  1432. "Get live-channel history done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1433. return self._parse_result(resp, xml_utils.parse_live_channel_history, GetLiveChannelHistoryResult)
  1434. def post_vod_playlist(self, channel_name, playlist_name, start_time=0, end_time=0):
  1435. """根据指定的playlist name以及startTime和endTime生成一个点播的播放列表
  1436. param str channel_name: 要生成点播列表的live channel的名称
  1437. param str playlist_name: 要生成点播列表m3u8文件的名称
  1438. param int start_time: 点播的起始时间,Unix Time格式,可以使用int(time.time())获取
  1439. param int end_time: 点播的结束时间,Unix Time格式,可以使用int(time.time())获取
  1440. """
  1441. logger.debug("Start to post vod playlist, bucket: {0}, channel_name: {1}, playlist_name: {2}, start_time: "
  1442. "{3}, end_time: {4}".format(self.bucket_name, to_string(channel_name), playlist_name, start_time,
  1443. end_time))
  1444. key = channel_name + "/" + playlist_name
  1445. resp = self.__do_object('POST', key, params={Bucket.VOD: '', 'startTime': str(start_time),
  1446. 'endTime': str(end_time)})
  1447. logger.debug("Post vod playlist done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1448. return RequestResult(resp)
  1449. def get_vod_playlist(self, channel_name, start_time, end_time):
  1450. """查看指定时间段内的播放列表
  1451. param str channel_name: 要获取点播列表的live channel的名称
  1452. param int start_time: 点播的起始时间,Unix Time格式,可以使用int(time.time())获取
  1453. param int end_time: 点播的结束时间,Unix Time格式,可以使用int(time.time())获取
  1454. """
  1455. logger.debug("Start to get vod playlist, bucket: {0}, channel_name: {1}, start_time: "
  1456. "{2}, end_time: {3}".format(self.bucket_name, to_string(channel_name), start_time, end_time))
  1457. resp = self.__do_object('GET', channel_name, params={Bucket.VOD: '', 'startTime': str(start_time),
  1458. 'endTime': str(end_time)})
  1459. logger.debug("get vod playlist done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1460. result = GetVodPlaylistResult(resp)
  1461. return result
  1462. def process_object(self, key, process, headers=None):
  1463. """处理图片的接口,支持包括调整大小,旋转,裁剪,水印,格式转换等,支持多种方式组合处理。
  1464. :param str key: 处理的图片的对象名称
  1465. :param str process: 处理的字符串,例如"image/resize,w_100|sys/saveas,o_dGVzdC5qcGc,b_dGVzdA"
  1466. :param headers: HTTP头部
  1467. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1468. """
  1469. headers = http.CaseInsensitiveDict(headers)
  1470. logger.debug("Start to process object, bucket: {0}, key: {1}, process: {2}".format(
  1471. self.bucket_name, to_string(key), process))
  1472. process_data = "%s=%s" % (Bucket.PROCESS, process)
  1473. resp = self.__do_object('POST', key, params={Bucket.PROCESS: ''}, headers=headers, data=process_data)
  1474. logger.debug("Process object done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1475. return ProcessObjectResult(resp)
  1476. def put_object_tagging(self, key, tagging, headers=None, params=None):
  1477. """
  1478. :param str key: 上传tagging的对象名称,不能为空。
  1479. :param tagging: tag 标签内容
  1480. :type tagging: :class:`Tagging <oss2.models.Tagging>` 对象
  1481. :param headers: HTTP头部
  1482. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1483. :param dict params: HTTP请求参数
  1484. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1485. """
  1486. logger.debug("Start to put object tagging, bucket: {0}, key: {1}, tagging: {2}".format(
  1487. self.bucket_name, to_string(key), tagging))
  1488. if headers is not None:
  1489. headers = http.CaseInsensitiveDict(headers)
  1490. if params is None:
  1491. params = dict()
  1492. params[Bucket.TAGGING] = ""
  1493. data = self.__convert_data(Tagging, xml_utils.to_put_tagging, tagging)
  1494. resp = self.__do_object('PUT', key, data=data, params=params, headers=headers)
  1495. return RequestResult(resp)
  1496. def get_object_tagging(self, key, params=None, headers=None):
  1497. """
  1498. :param str key: 要获取tagging的对象名称
  1499. :param dict params: 请求参数
  1500. :param headers: HTTP头部
  1501. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1502. :return: :class:`GetTaggingResult <oss2.models.GetTaggingResult>`
  1503. """
  1504. logger.debug("Start to get object tagging, bucket: {0}, key: {1} params: {2}".format(
  1505. self.bucket_name, to_string(key), str(params)))
  1506. headers = http.CaseInsensitiveDict(headers)
  1507. if params is None:
  1508. params = dict()
  1509. params[Bucket.TAGGING] = ""
  1510. resp = self.__do_object('GET', key, params=params, headers=headers)
  1511. return self._parse_result(resp, xml_utils.parse_get_tagging, GetTaggingResult)
  1512. def delete_object_tagging(self, key, params=None, headers=None):
  1513. """
  1514. :param str key: 要删除tagging的对象名称
  1515. :param dict params: 请求参数
  1516. :param headers: HTTP头部
  1517. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1518. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1519. """
  1520. logger.debug("Start to delete object tagging, bucket: {0}, key: {1}".format(
  1521. self.bucket_name, to_string(key)))
  1522. headers = http.CaseInsensitiveDict(headers)
  1523. if params is None:
  1524. params = dict()
  1525. params[Bucket.TAGGING] = ""
  1526. resp = self.__do_object('DELETE', key, params=params, headers=headers)
  1527. logger.debug("Delete object tagging done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1528. return RequestResult(resp)
  1529. def put_bucket_encryption(self, rule):
  1530. """设置bucket加密配置。
  1531. :param rule: :class:` ServerSideEncryptionRule<oss2.models.ServerSideEncryptionRule>` 对象
  1532. """
  1533. data = self.__convert_data(ServerSideEncryptionRule, xml_utils.to_put_bucket_encryption, rule)
  1534. logger.debug("Start to put bucket encryption, bucket: {0}, rule: {1}".format(self.bucket_name, data))
  1535. resp = self.__do_bucket('PUT', data=data, params={Bucket.ENCRYPTION: ""})
  1536. logger.debug("Put bucket encryption done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1537. return RequestResult(resp)
  1538. def get_bucket_encryption(self):
  1539. """获取bucket加密配置。
  1540. :return: :class:`GetServerSideEncryptionResult <oss2.models.GetServerSideEncryptionResult>`
  1541. :raises: 如果没有设置Bucket encryption,则抛出 :class:`NoSuchServerSideEncryptionRule <oss2.exceptions.NoSuchServerSideEncryptionRule>`
  1542. """
  1543. logger.debug("Start to get bucket encryption, bucket: {0}".format(self.bucket_name))
  1544. resp = self.__do_bucket('GET', params={Bucket.ENCRYPTION: ''})
  1545. logger.debug("Get bucket encryption done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1546. return self._parse_result(resp, xml_utils.parse_get_bucket_encryption, GetServerSideEncryptionResult)
  1547. def delete_bucket_encryption(self):
  1548. """删除Bucket加密配置。如果Bucket加密没有设置,也返回成功。"""
  1549. logger.debug("Start to delete bucket encryption, bucket: {0}".format(self.bucket_name))
  1550. resp = self.__do_bucket('DELETE', params={Bucket.ENCRYPTION: ''})
  1551. logger.debug("Delete bucket encryption done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1552. return RequestResult(resp)
  1553. def put_bucket_tagging(self, tagging, headers=None):
  1554. """
  1555. :param str key: 上传tagging的对象名称,不能为空。
  1556. :param tagging: tag 标签内容
  1557. :type tagging: :class:`Tagging <oss2.models.Tagging>` 对象
  1558. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1559. """
  1560. logger.debug("Start to put object tagging, bucket: {0} tagging: {1}".format(
  1561. self.bucket_name, tagging))
  1562. headers = http.CaseInsensitiveDict(headers)
  1563. data = self.__convert_data(Tagging, xml_utils.to_put_tagging, tagging)
  1564. resp = self.__do_bucket('PUT', data=data, params={Bucket.TAGGING: ''}, headers=headers)
  1565. logger.debug("Put bucket tagging done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1566. return RequestResult(resp)
  1567. def get_bucket_tagging(self):
  1568. """
  1569. :param str key: 要获取tagging的对象名称
  1570. :param dict params: 请求参数
  1571. :return: :class:`GetTaggingResult<oss2.models.GetTaggingResult>`
  1572. """
  1573. logger.debug("Start to get bucket tagging, bucket: {0}".format(
  1574. self.bucket_name))
  1575. resp = self.__do_bucket('GET', params={Bucket.TAGGING: ''})
  1576. logger.debug("Get bucket tagging done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1577. return self._parse_result(resp, xml_utils.parse_get_tagging, GetTaggingResult)
  1578. def delete_bucket_tagging(self):
  1579. """
  1580. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1581. """
  1582. logger.debug("Start to delete bucket tagging, bucket: {0}".format(
  1583. self.bucket_name))
  1584. resp = self.__do_bucket('DELETE', params={Bucket.TAGGING: ''})
  1585. logger.debug("Delete bucket tagging done, req_id: {0}, status_code: {1}".format(
  1586. resp.request_id, resp.status))
  1587. return RequestResult(resp)
  1588. def list_object_versions(self, prefix='', delimiter='', key_marker='',
  1589. max_keys=100, versionid_marker='', headers=None):
  1590. """根据前缀罗列Bucket里的文件的版本。
  1591. :param str prefix: 只罗列文件名为该前缀的文件
  1592. :param str delimiter: 分隔符。可以用来模拟目录
  1593. :param str key_marker: 分页标志。首次调用传空串,后续使用返回值的next_marker
  1594. :param int max_keys: 最多返回文件的个数,文件和目录的和不能超过该值
  1595. :param str versionid_marker: 设定结果从key-marker对象的
  1596. versionid-marker之后按新旧版本排序开始返回,该版本不会在返回的结果当中。
  1597. :param headers: HTTP头部
  1598. :type headers: 可以是dict,建议是oss2.CaseInsensitiveDict
  1599. :return: :class:`ListObjectVersionsResult <oss2.models.ListObjectVersionsResult>`
  1600. """
  1601. logger.debug(
  1602. "Start to List object versions, bucket: {0}, prefix: {1}, delimiter: {2},"
  1603. +"key_marker: {3}, versionid_marker: {4}, max-keys: {5}".format(
  1604. self.bucket_name, to_string(prefix), delimiter, to_string(key_marker),
  1605. to_string(versionid_marker), max_keys))
  1606. headers = http.CaseInsensitiveDict(headers)
  1607. resp = self.__do_bucket('GET',
  1608. params={'prefix': prefix,
  1609. 'delimiter': delimiter,
  1610. 'key-marker': key_marker,
  1611. 'version-id-marker': versionid_marker,
  1612. 'max-keys': str(max_keys),
  1613. 'encoding-type': 'url',
  1614. Bucket.VERSIONS: ''},
  1615. headers=headers)
  1616. logger.debug("List object versions done, req_id: {0}, status_code: {1}"
  1617. .format(resp.request_id, resp.status))
  1618. return self._parse_result(resp, xml_utils.parse_list_object_versions, ListObjectVersionsResult)
  1619. def put_bucket_versioning(self, config, headers=None):
  1620. """
  1621. :param str operation: 设置bucket是否开启多版本特性,可取值为:[Enabled,Suspend]
  1622. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1623. """
  1624. logger.debug("Start to put object versioning, bucket: {0}".format(self.bucket_name))
  1625. data = self.__convert_data(BucketVersioningConfig, xml_utils.to_put_bucket_versioning, config)
  1626. headers = http.CaseInsensitiveDict(headers)
  1627. headers['Content-MD5'] = utils.content_md5(data)
  1628. resp = self.__do_bucket('PUT', data=data, params={Bucket.VERSIONING: ''}, headers=headers)
  1629. logger.debug("Put bucket versiong done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1630. return RequestResult(resp)
  1631. def get_bucket_versioning(self):
  1632. """
  1633. :return: :class:`GetBucketVersioningResult<oss2.models.GetBucketVersioningResult>`
  1634. """
  1635. logger.debug("Start to get bucket versioning, bucket: {0}".format(self.bucket_name))
  1636. resp = self.__do_bucket('GET', params={Bucket.VERSIONING: ''})
  1637. logger.debug("Get bucket versiong done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1638. return self._parse_result(resp, xml_utils.parse_get_bucket_versioning, GetBucketVersioningResult)
  1639. def put_bucket_policy(self, policy):
  1640. """设置bucket授权策略, 具体policy书写规则请参考官方文档
  1641. :param str policy: 授权策略
  1642. """
  1643. logger.debug("Start to put bucket policy, bucket: {0}, policy: {1}".format(self.bucket_name, policy))
  1644. resp = self.__do_bucket('PUT', data=policy, params={Bucket.POLICY: ''}, headers={'Content-MD5': utils.content_md5(policy)})
  1645. logger.debug("Put bucket policy done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1646. return RequestResult(resp)
  1647. def get_bucket_policy(self):
  1648. """获取bucket授权策略
  1649. :return: :class:`GetBucketPolicyResult <oss2.models.GetBucketPolicyResult>`
  1650. """
  1651. logger.debug("Start to get bucket policy, bucket: {0}".format(self.bucket_name))
  1652. resp = self.__do_bucket('GET', params={Bucket.POLICY:''})
  1653. logger.debug("Get bucket policy done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1654. return GetBucketPolicyResult(resp)
  1655. def delete_bucket_policy(self):
  1656. """删除bucket授权策略
  1657. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1658. """
  1659. logger.debug("Start to delete bucket policy, bucket: {0}".format(self.bucket_name))
  1660. resp = self.__do_bucket('DELETE', params={Bucket.POLICY: ''})
  1661. logger.debug("Delete bucket policy done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1662. return RequestResult(resp)
  1663. def put_bucket_request_payment(self, payer):
  1664. """设置付费者。
  1665. :param input: :class: str
  1666. """
  1667. data = xml_utils.to_put_bucket_request_payment(payer)
  1668. logger.debug("Start to put bucket request payment, bucket: {0}, payer: {1}".format(self.bucket_name, payer))
  1669. resp = self.__do_bucket('PUT', data=data, params={Bucket.REQUESTPAYMENT: ''}, headers={'Content-MD5': utils.content_md5(data)})
  1670. logger.debug("Put bucket request payment done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1671. return RequestResult(resp)
  1672. def get_bucket_request_payment(self):
  1673. """获取付费者设置。
  1674. :return: :class:`GetBucketRequestPaymentResult <oss2.models.GetBucketRequestPaymentResult>`
  1675. """
  1676. logger.debug("Start to get bucket request payment, bucket: {0}.".format(self.bucket_name))
  1677. resp = self.__do_bucket('GET', params={Bucket.REQUESTPAYMENT: ''})
  1678. logger.debug("Get bucket request payment done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1679. return self._parse_result(resp, xml_utils.parse_get_bucket_request_payment, GetBucketRequestPaymentResult)
  1680. def put_bucket_qos_info(self, bucket_qos_info):
  1681. """配置bucket的QoSInfo
  1682. :param bucket_qos_info :class:`BucketQosInfo <oss2.models.BucketQosInfo>`
  1683. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1684. """
  1685. logger.debug("Start to put bucket qos info, bucket: {0}".format(self.bucket_name))
  1686. data = self.__convert_data(BucketQosInfo, xml_utils.to_put_qos_info, bucket_qos_info)
  1687. headers = http.CaseInsensitiveDict()
  1688. headers['Content-MD5'] = utils.content_md5(data)
  1689. resp = self.__do_bucket('PUT', data=data, params={Bucket.QOS_INFO: ''}, headers=headers)
  1690. logger.debug("Get bucket qos info done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1691. return RequestResult(resp)
  1692. def get_bucket_qos_info(self):
  1693. """获取bucket的QoSInfo
  1694. :return: :class:`GetBucketQosInfoResult <oss2.models.GetBucketQosInfoResult>`
  1695. """
  1696. logger.debug("Start to get bucket qos info, bucket: {0}".format(self.bucket_name))
  1697. resp = self.__do_bucket('GET', params={Bucket.QOS_INFO: ''})
  1698. logger.debug("Get bucket qos info, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1699. return self._parse_result(resp, xml_utils.parse_get_qos_info, GetBucketQosInfoResult)
  1700. def delete_bucket_qos_info(self):
  1701. """删除bucket的QoSInfo
  1702. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1703. """
  1704. logger.debug("Start to delete bucket qos info, bucket: {0}".format(self.bucket_name))
  1705. resp = self.__do_bucket('DELETE', params={Bucket.QOS_INFO: ''})
  1706. logger.debug("Delete bucket qos info done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1707. return RequestResult(resp)
  1708. def set_bucket_storage_capacity(self, user_qos):
  1709. """设置Bucket的容量,单位GB
  1710. :param user_qos :class:`BucketUserQos <oss2.models.BucketUserQos>`
  1711. """
  1712. logger.debug("Start to set bucket storage capacity: {0}".format(self.bucket_name))
  1713. data = xml_utils.to_put_bucket_user_qos(user_qos)
  1714. resp = self.__do_bucket('PUT', data=data, params={Bucket.USER_QOS: ''})
  1715. logger.debug("Set bucket storage capacity done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1716. return RequestResult(resp)
  1717. def get_bucket_storage_capacity(self):
  1718. """获取bucket的容量信息。
  1719. :return: :class:`GetBucketUserQosResult <oss2.models.GetBucketUserQosResult>`
  1720. """
  1721. logger.debug("Start to get bucket storage capacity, bucket:{0}".format(self.bucket_name))
  1722. resp = self._Bucket__do_bucket('GET', params={Bucket.USER_QOS: ''})
  1723. logger.debug("Get bucket storage capacity done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1724. return self._parse_result(resp, xml_utils.parse_get_bucket_user_qos, GetBucketUserQosResult)
  1725. def put_async_fetch_task(self, task_config):
  1726. """创建一个异步获取文件到bucket的任务。
  1727. :param task_config: 任务配置
  1728. :type task_config: class:`AsyncFetchTaskConfiguration <oss2.models.AsyncFetchTaskConfiguration>`
  1729. :return: :class:`PutAsyncFetchTaskResult <oss2.models.PutAsyncFetchTaskResult>`
  1730. """
  1731. logger.debug("Start to put async fetch task, bucket:{0}".format(self.bucket_name))
  1732. data = xml_utils.to_put_async_fetch_task(task_config)
  1733. headers = http.CaseInsensitiveDict()
  1734. headers['Content-MD5'] = utils.content_md5(data)
  1735. resp = self._Bucket__do_bucket('POST', data=data, params={Bucket.ASYNC_FETCH: ''}, headers=headers)
  1736. logger.debug("Put async fetch task done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1737. return self._parse_result(resp, xml_utils.parse_put_async_fetch_task_result, PutAsyncFetchTaskResult)
  1738. def get_async_fetch_task(self, task_id):
  1739. """获取一个异步获取文件到bucket的任务信息。
  1740. :param str task_id: 任务id
  1741. :return: :class:`GetAsyncFetchTaskResult <oss2.models.GetAsyncFetchTaskResult>`
  1742. """
  1743. logger.debug("Start to get async fetch task, bucket:{0}, task_id:{1}".format(self.bucket_name, task_id))
  1744. resp = self._Bucket__do_bucket('GET', headers={OSS_TASK_ID: task_id}, params={Bucket.ASYNC_FETCH: ''})
  1745. logger.debug("Put async fetch task done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1746. return self._parse_result(resp, xml_utils.parse_get_async_fetch_task_result, GetAsyncFetchTaskResult)
  1747. def put_bucket_inventory_configuration(self, inventory_configuration):
  1748. """设置bucket清单配置
  1749. :param inventory_configuration :class:`InventoryConfiguration <oss2.models.InventoryConfiguration>`
  1750. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1751. """
  1752. logger.debug("Start to put bucket inventory configuration, bucket: {0}".format(self.bucket_name))
  1753. data = self.__convert_data(InventoryConfiguration, xml_utils.to_put_inventory_configuration, inventory_configuration)
  1754. headers = http.CaseInsensitiveDict()
  1755. headers['Content-MD5'] = utils.content_md5(data)
  1756. resp = self.__do_bucket('PUT', data=data, params={Bucket.INVENTORY: '', Bucket.INVENTORY_CONFIG_ID:inventory_configuration.inventory_id}, headers=headers)
  1757. logger.debug("Put bucket inventory configuration done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1758. return RequestResult(resp)
  1759. def get_bucket_inventory_configuration(self, inventory_id):
  1760. """获取指定的清单配置。
  1761. :param str inventory_id : 清单配置id
  1762. :return: :class:`GetInventoryConfigurationResult <oss2.models.GetInventoryConfigurationResult>`
  1763. """
  1764. logger.debug("Start to get bucket inventory configuration, bucket: {0}".format(self.bucket_name))
  1765. resp = self.__do_bucket('GET', params={Bucket.INVENTORY: '', Bucket.INVENTORY_CONFIG_ID:inventory_id})
  1766. logger.debug("Get bucket inventory cinfguration done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1767. return self._parse_result(resp, xml_utils.parse_get_bucket_inventory_configuration, GetInventoryConfigurationResult)
  1768. def list_bucket_inventory_configurations(self, continuation_token=None):
  1769. """罗列清单配置,默认单次最大返回100条配置,如果存在超过100条配置,罗列结果将会分页,
  1770. 分页信息保存在 class:`ListInventoryConfigurationResult <oss2.models.ListInventoryConfigurationResult>`中。
  1771. :param str continuation_token: 分页标识, 默认值为None, 如果上次罗列不完整,这里设置为上次罗列结果中的next_continuation_token值。
  1772. :return: :class:`ListInventoryConfigurationResult <oss2.models.ListInventoryConfigurationResult>`
  1773. """
  1774. logger.debug("Start to list bucket inventory configuration, bucket: {0}".format(self.bucket_name))
  1775. params = {Bucket.INVENTORY:''}
  1776. if continuation_token is not None:
  1777. params[Bucket.CONTINUATION_TOKEN] = continuation_token
  1778. resp = self.__do_bucket('GET', params=params)
  1779. logger.debug("List bucket inventory configuration done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1780. return self._parse_result(resp, xml_utils.parse_list_bucket_inventory_configurations, ListInventoryConfigurationsResult)
  1781. def delete_bucket_inventory_configuration(self, inventory_id):
  1782. """删除指定的清单配置
  1783. :param str inventory_id : 清单配置id
  1784. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1785. """
  1786. logger.debug("Start to delete bucket inventory configuration, bucket: {0}, configuration id: {1}.".format(self.bucket_name, inventory_id))
  1787. resp = self.__do_bucket('DELETE', params={Bucket.INVENTORY:'', Bucket.INVENTORY_CONFIG_ID:inventory_id})
  1788. logger.debug("Delete bucket inventory configuration, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1789. return RequestResult(resp)
  1790. def init_bucket_worm(self, retention_period_days=None):
  1791. """创建一条合规保留策略
  1792. :param int retention_period_days : 指定object的保留天数
  1793. :return: :class:`InitBucketWormResult <oss2.models.InitBucketWormResult>`
  1794. """
  1795. logger.debug("Start to init bucket worm, bucket: {0}, retention_period_days: {1}."
  1796. .format(self.bucket_name, retention_period_days))
  1797. data = xml_utils.to_put_init_bucket_worm(retention_period_days)
  1798. headers = http.CaseInsensitiveDict()
  1799. headers['Content-MD5'] = utils.content_md5(data)
  1800. resp = self.__do_bucket('POST', data=data, params={Bucket.WORM: ''}, headers=headers)
  1801. logger.debug("init bucket worm done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1802. result = InitBucketWormResult(resp)
  1803. result.worm_id = resp.headers.get("x-oss-worm-id")
  1804. return result
  1805. def abort_bucket_worm(self):
  1806. """删除一条合规保留策略
  1807. 只有未锁定保留策略的状态下才能删除,一旦锁定bucket数据将处于保护状态。
  1808. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1809. """
  1810. logger.debug("Start to abort bucket worm, bucket: {0}.".format(self.bucket_name))
  1811. resp = self.__do_bucket('DELETE', params={Bucket.WORM: ''})
  1812. logger.debug("abort bucket worm done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1813. return RequestResult(resp)
  1814. def complete_bucket_worm(self, worm_id=None):
  1815. """锁定一条合规保留策略
  1816. :param str worm_id : 合规保留策略的id。
  1817. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1818. """
  1819. logger.debug("Start to complete bucket worm, bucket: {0}, worm_id: {1}.".format(self.bucket_name, worm_id))
  1820. resp = self.__do_bucket('POST', params={Bucket.WORM_ID: worm_id})
  1821. logger.debug("complete bucket worm done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1822. return RequestResult(resp)
  1823. def extend_bucket_worm(self, worm_id=None, retention_period_days=None):
  1824. """延长已经锁定的合规保留策略的object保护天数。
  1825. :param str worm_id : 合规保留策略的id。
  1826. :param int retention_period_days : 指定object的保留天数
  1827. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1828. """
  1829. data = xml_utils.to_put_extend_bucket_worm(retention_period_days)
  1830. headers = http.CaseInsensitiveDict()
  1831. headers['Content-MD5'] = utils.content_md5(data)
  1832. logger.debug("Start to extend bucket worm, bucket: {0}, worm_id: {1}, retention_period_days."
  1833. .format(self.bucket_name, worm_id, retention_period_days))
  1834. resp = self.__do_bucket('POST', data=data, params={Bucket.WORM_ID: worm_id, Bucket.WORM_EXTEND: ''}, headers=headers)
  1835. logger.debug("extend bucket worm done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1836. return RequestResult(resp)
  1837. def get_bucket_worm(self, ):
  1838. """获取合规保留策略
  1839. :return: :class:`GetBucketWormResult <oss2.models.GetBucketWormResult>`
  1840. """
  1841. logger.debug("Start to get bucket worm, bucket: {0}.".format(self.bucket_name))
  1842. resp = self.__do_bucket('GET', params={Bucket.WORM: ''})
  1843. logger.debug("get bucket worm done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1844. return self._parse_result(resp, xml_utils.parse_get_bucket_worm_result, GetBucketWormResult)
  1845. def _get_bucket_config(self, config):
  1846. """获得Bucket某项配置,具体哪种配置由 `config` 指定。该接口直接返回 `RequestResult` 对象。
  1847. 通过read()接口可以获得XML字符串。不建议使用。
  1848. :param str config: 可以是 `Bucket.ACL` 、 `Bucket.LOGGING` 等。
  1849. :return: :class:`RequestResult <oss2.models.RequestResult>`
  1850. """
  1851. logger.debug("Start to get bucket config, bucket: {0}".format(self.bucket_name))
  1852. resp = self.__do_bucket('GET', params={config: ''})
  1853. logger.debug("Get bucket config done, req_id: {0}, status_code: {1}".format(resp.request_id, resp.status))
  1854. return resp
  1855. def __do_object(self, method, key, **kwargs):
  1856. return self._do(method, self.bucket_name, key, **kwargs)
  1857. def __do_bucket(self, method, **kwargs):
  1858. return self._do(method, self.bucket_name, '', **kwargs)
  1859. def __convert_data(self, klass, converter, data):
  1860. if isinstance(data, klass):
  1861. return converter(data)
  1862. else:
  1863. return data
  1864. def _normalize_endpoint(endpoint):
  1865. url = endpoint
  1866. if not endpoint.startswith('http://') and not endpoint.startswith('https://'):
  1867. url = 'http://' + endpoint
  1868. p = urlparse(url)
  1869. if p.port is not None:
  1870. return p.scheme + '://' + p.hostname + ':' + str(p.port)
  1871. else:
  1872. return p.scheme + '://' + p.hostname
  1873. _ENDPOINT_TYPE_ALIYUN = 0
  1874. _ENDPOINT_TYPE_CNAME = 1
  1875. _ENDPOINT_TYPE_IP = 2
  1876. def _make_range_string(range):
  1877. if range is None:
  1878. return ''
  1879. start = range[0]
  1880. last = range[1]
  1881. if start is None and last is None:
  1882. return ''
  1883. return 'bytes=' + _range(start, last)
  1884. def _range(start, last):
  1885. def to_str(pos):
  1886. if pos is None:
  1887. return ''
  1888. else:
  1889. return str(pos)
  1890. return to_str(start) + '-' + to_str(last)
  1891. def _determine_endpoint_type(netloc, is_cname, bucket_name):
  1892. if utils.is_ip_or_localhost(netloc):
  1893. return _ENDPOINT_TYPE_IP
  1894. if is_cname:
  1895. return _ENDPOINT_TYPE_CNAME
  1896. if utils.is_valid_bucket_name(bucket_name):
  1897. return _ENDPOINT_TYPE_ALIYUN
  1898. else:
  1899. return _ENDPOINT_TYPE_IP
  1900. class _UrlMaker(object):
  1901. def __init__(self, endpoint, is_cname):
  1902. p = urlparse(endpoint)
  1903. self.scheme = p.scheme
  1904. self.netloc = p.netloc
  1905. self.is_cname = is_cname
  1906. def __call__(self, bucket_name, key, slash_safe=False):
  1907. self.type = _determine_endpoint_type(self.netloc, self.is_cname, bucket_name)
  1908. safe = '/' if slash_safe is True else ''
  1909. key = urlquote(key, safe=safe)
  1910. if self.type == _ENDPOINT_TYPE_CNAME:
  1911. return '{0}://{1}/{2}'.format(self.scheme, self.netloc, key)
  1912. if self.type == _ENDPOINT_TYPE_IP:
  1913. if bucket_name:
  1914. return '{0}://{1}/{2}/{3}'.format(self.scheme, self.netloc, bucket_name, key)
  1915. else:
  1916. return '{0}://{1}/{2}'.format(self.scheme, self.netloc, key)
  1917. if not bucket_name:
  1918. assert not key
  1919. return '{0}://{1}'.format(self.scheme, self.netloc)
  1920. return '{0}://{1}.{2}/{3}'.format(self.scheme, bucket_name, self.netloc, key)