index.d.ts 124 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283
  1. /**
  2. * 腾讯云 COS JavaScript SDK 类型声明
  3. */
  4. /**
  5. * 定义 COS 命名空间,方便导出用到的变量类型给外部引用
  6. */
  7. declare namespace COS {
  8. /** 存储桶的名称,命名规则为 BucketName-APPID,例如 examplebucket-1250000000 */
  9. type Bucket = string;
  10. /** 存储桶所在地域 @see https://cloud.tencent.com/document/product/436/6224 */
  11. type Region = string;
  12. /** 请求的对象键,最前面不带 /,例如 images/1.jpg */
  13. type Key = string;
  14. /** 请求路径,最前面带 /,例如 /images/1.jpg */
  15. type Pathname = string;
  16. /** 对象的版本 ID;当未启用版本控制时,该节点的值为空字符串;当启用版本控制时,启用版本控制之前的对象,其版本 ID 为 null;当暂停版本控制时,新上传的对象其版本 ID 为 null,且同一个对象最多只存在一个版本 ID 为 null 的对象版本 */
  17. type VersionId = string;
  18. /** 前缀匹配,用来规定返回的文件前缀地址 */
  19. type Prefix = string;
  20. /** 分块上传的任务 ID */
  21. type UploadId = string;
  22. /** 标识本次分块上传的编号,范围在1 - 10000 */
  23. type PartNumber = number;
  24. /** 创建的存储桶访问地址,不带 https:// 前缀,例如 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/images/1.jpg */
  25. type Location = string;
  26. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  27. type ETag = string;
  28. /** COS API 使用的时间字符串,为 ISO8601 格式,例如2019-05-24T10:56:40Z */
  29. type IsoDateTime = string;
  30. /** 请求里的 Url Query 参数 */
  31. type Query = Record<string, any>;
  32. /** 请求里的 Header 参数 */
  33. type Headers = Record<string, any>;
  34. /** 请求里的 URL 中对象存储 API 接口名,如 acl、tagging 等 */
  35. type Action = string;
  36. /** 一个字符的分隔符,常用 / 字符,用于对对象键进行分组。所有对象键中从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分将作为 CommonPrefixes 下的一个 Prefix 节点。被分组的对象键不再出现在后续对象列表中 */
  37. type Delimiter = '/' | string;
  38. /** 规定返回值的编码方式,可选值:url,代表返回的对象键为 URL 编码(百分号编码)后的值,例如“腾讯云”将被编码为%E8%85%BE%E8%AE%AF%E4%BA%91 */
  39. type EncodingType = 'url' | string;
  40. /** 上传的文件内容 */
  41. type UploadBody = File | Blob | String | ArrayBuffer;
  42. /** 对象存储类型。枚举值 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING @see https://cloud.tencent.com/document/product/436/33417 */
  43. type StorageClass = 'STANDARD' | 'STANDARD_IA' | 'ARCHIVE' | 'DEEP_ARCHIVE' | 'INTELLIGENT_TIERING' | 'MAZ_STANDARD' | 'MAZ_STANDARD_IA' | 'MAZ_INTELLIGENT_TIERING';
  44. /** 请求方法 */
  45. type Method = 'GET' | 'DELETE' | 'POST' | 'PUT' | 'OPTIONS' | 'get' | 'delete' | 'post' | 'put' | 'options';
  46. /** 权限信息,枚举值:READ | WRITE | READ_ACP | WRITE_ACP | FULL_CONTROL 腾讯云对象存储 COS 在资源 ACL 上支持的操作实际上是一系列的操作集合,对于存储桶和对象 ACL 来说分别代表不同的含义。 */
  47. type Permission = 'READ' | 'WRITE' | 'READ_ACP' | 'WRITE_ACP' | 'FULL_CONTROL';
  48. /** 存储桶的预设 ACL @see https://cloud.tencent.com/document/product/436/30752#.E9.A2.84.E8.AE.BE.E7.9A.84-acl */
  49. type BucketACL = 'private' | 'public-read' | 'public-read-write' | 'authenticated-read';
  50. /** 对象的预设 ACL @see https://cloud.tencent.com/document/product/436/30752#.E9.A2.84.E8.AE.BE.E7.9A.84-acl */
  51. type ObjectACL = 'default' | 'private' | 'public-read' | 'authenticated-read' | 'bucket-owner-read' | 'bucket-owner-full-contro';
  52. /** 二进制值的字符串,'true' | 'false' */
  53. type BooleanString = 'true' | 'false';
  54. /** 所有者的信息 */
  55. type Owner = {
  56. /** 存储桶持有者的完整 ID,格式为 qcs::cam::uin/[OwnerUin]:uin/[OwnerUin],如 qcs::cam::uin/100000000001:uin/100000000001 */
  57. ID: string,
  58. };
  59. /** 所有者的信息 */
  60. type GroupOwner = {
  61. /** 预设用户组,格式为 http://cam.qcloud.com/groups/global/AllUsers (匿名用户组) 或 http://cam.qcloud.com/groups/global/AuthenticatedUsers (认证用户组) 。参见 {@link https://cloud.tencent.com/document/product/436/30752#.E8.BA.AB.E4.BB.BD-grantee| ACL 概述} */
  62. URI: string,
  63. };
  64. /** 上传发起者的信息 */
  65. type Initiator = Owner;
  66. /** 单个授权信息 */
  67. type Grant = string;
  68. /** 被授权者信息与权限信息 */
  69. interface Grants {
  70. /** 所有者的信息 */
  71. Grantee: Owner | GroupOwner,
  72. /** 权限信息,枚举值:READ | WRITE | READ_ACP | WRITE_ACP | FULL_CONTROL 腾讯云对象存储 COS 在资源 ACL 上支持的操作实际上是一系列的操作集合,对于存储桶和对象 ACL 来说分别代表不同的含义。 */
  73. Permission: Permission,
  74. }
  75. /** 存储桶/对象标签信息 */
  76. interface Tag {
  77. /** 标签的 Key,长度不超过128字节, 支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 */
  78. Key: Key,
  79. /** 标签的 Value,长度不超过256字节, 支持英文字母、数字、空格、加号、减号、下划线、等号、点号、冒号、斜线 */
  80. Value: string,
  81. }
  82. /** 用来说明本次分块上传中每个块的信息 */
  83. interface Part {
  84. /** 标识本次分块上传的编号,范围在1 - 10000 */
  85. PartNumber: PartNumber,
  86. /** 使用 Upload Part 请求上传分块成功后返回的 ETag 响应头部的值 */
  87. ETag: ETag,
  88. }
  89. /** 当前需要用凭证的请求,需要的最小权限 */
  90. type Scope = {
  91. /** 需要的权限 */
  92. action: string,
  93. /** 操作的存储桶的名称,命名规则为 BucketName-APPID,例如 examplebucket-1250000000 */
  94. bucket: Bucket,
  95. /** 存储桶所在地域 @see https://cloud.tencent.com/document/product/436/6224 */
  96. region: Region,
  97. /** 前缀匹配,用来规定返回的文件前缀地址,支持 * 结尾 */
  98. prefix: Prefix
  99. }[];
  100. /** onProgress 回调的进度信息 */
  101. interface ProgressInfo {
  102. /** 已上传/下载的字节数,单位 B(字节) */
  103. loaded: number,
  104. /** 要上传/下载的文件的大小,单位 B(字节) */
  105. total: number,
  106. /** 速度,单位 B/s */
  107. speed: number,
  108. /** 进度百分比,范围是 0-1,保留两位小数 */
  109. percent: number,
  110. }
  111. /** 上传/下载的进度回调方法 */
  112. type onProgress = (params: ProgressInfo) => any;
  113. // 实例参数
  114. interface COSOptions {
  115. /** 固定密钥的 SecretId,可从{@link https://console.cloud.tencent.com/cam/capi|API密钥管理}获取 */
  116. SecretId?: string,
  117. /** 固定密钥的 SecretKey,可从{@link https://console.cloud.tencent.com/cam/capi|API密钥管理}获取 */
  118. SecretKey?: string,
  119. /** 如果传入 SecretId、SecretKey 是临时密钥,需要再传入一个临时密钥的 sessionToken */
  120. SecurityToken?: string,
  121. /** 同 SecurityToken,推荐用 SecurityToken */
  122. XCosSecurityToken?: string,
  123. /** 分块上传及分块复制时,出错重试次数,默认值3(加第一次,请求共4次) */
  124. ChunkRetryTimes?: number,
  125. /** 同一个实例下上传的文件并发数,默认值3 */
  126. FileParallelLimit?: number,
  127. /** 同一个上传文件的分块并发数,默认值3 */
  128. ChunkParallelLimit?: number,
  129. /** 分块上传时,每片的字节数大小,默认值1048576(1MB) */
  130. ChunkSize?: number,
  131. /** 使用 uploadFiles 批量上传时,文件大小大于该数值将使用按分块上传,否则将调用简单上传,单位 Byte,默认值1048576(1MB) */
  132. SliceSize?: number,
  133. /** 进行分块复制操作中复制分块上传的并发数,默认值20 */
  134. CopyChunkParallelLimit?: number,
  135. /** 使用 sliceCopyFile 分块复制文件时,每片的大小字节数,默认值10485760(10MB) */
  136. CopyChunkSize?: number,
  137. /** 使用 sliceCopyFile 分块复制文件时,文件大小大于该数值将使用分块复制 ,否则将调用简单复制,默认值10485760(10MB) */
  138. CopySliceSize?: number,
  139. /** 最大分片数,默认 1000,最大 10000,分片上传超大文件时,会根据文件大小和该最大分片数计算合适的的分片大小 */
  140. MaxPartNumber?: number,
  141. /** 上传进度的回调方法 onProgress 的回调频率,单位 ms ,默认值1000 */
  142. ProgressInterval?: number,
  143. /** 上传队列最长大小,超出的任务如果状态不是 waiting、checking、uploading 会被清理,默认10000 */
  144. UploadQueueSize?: number,
  145. /** 上传队列最长大小,超出的任务如果状态不是 waiting、checking、uploading 会被清理,默认10000 */
  146. Domain?: string,
  147. /** 强制使用后缀式模式发请求。后缀式模式中 Bucket 会放在域名后的 pathname 里,并且 Bucket 会加入签名 pathname 计算,默认 false */
  148. ServiceDomain?: string,
  149. /** 强制使用后缀式模式发请求。后缀式模式中 Bucket 会放在域名后的 pathname 里,并且 Bucket 会加入签名 pathname 计算,默认 false */
  150. Protocol?: string,
  151. /** 开启兼容模式,默认 false 不开启,兼容模式下不校验 Region 是否格式有误,在用于私有化 COS 时使用 */
  152. CompatibilityMode?: boolean,
  153. /** 强制使用后缀式模式发请求。后缀式模式中 Bucket 会放在域名后的 pathname 里,并且 Bucket 会加入签名 pathname 计算,默认 false */
  154. ForcePathStyle?: boolean,
  155. /** 是否原样保留 Key 字段的 / 前缀,默认 false 不保留,这时如果 Key 是 / 开头,强制去掉第一个 / */
  156. UseRawKey?: boolean,
  157. /** 请求超时时间,单位 ms(毫秒),透传给 request 或 ajax 或小程序请求库 */
  158. Timeout?: number,
  159. /** 客户端时间是否不准确,默认 false,在第一次请求 COS API 返回时会判断是否偏差大于 30s,如果是会把该值设置为 true,开发者也可以预先判断并设置该参数 */
  160. CorrectClockSkew?: boolean,
  161. /** 校正时间的偏移值,单位 ms(毫秒),计算签名时会用设备当前时间戳加上该偏移值,在设备时间有误时可用于校正签名用的时间参数,在第一次请求 COS API 返回时会判断是否偏差大于 30s,如果是会把该值设置为 true,开发者也可以预先判断并设置该参数。 */
  162. SystemClockOffset?: number,
  163. /** 上传文件时校验 Content-MD5,默认 false。如果开启,上传文件时会对文件内容计算 MD5,大文件耗时较长 */
  164. UploadCheckContentMd5?: boolean,
  165. /** 上传文件时计算文件内容 md5 并设置为文件 x-cos-meta-md5 元数据 Header 字段 */
  166. UploadAddMetaMd5?: boolean,
  167. /** 分片上传缓存的 UploadId 列表大小限制,nodejs-sdk 默认 500 个,js-sdk、小程序 SDK 默认 50 */
  168. UploadIdCacheLimit?: number,
  169. /** 是否使用全球加速域名。开启该配置后仅以下接口支持操作:putObject、getObject、headObject、optionsObject、multipartInit、multipartListPart、multipartUpload、multipartAbort、multipartComplete、multipartList、sliceUploadFile、uploadFiles */
  170. UseAccelerate?: boolean,
  171. /** 获取签名的回调方法,如果没有 SecretId、SecretKey 时,必选 */
  172. getAuthorization?: (
  173. options: GetAuthorizationOptions,
  174. /** callback 获取完签名或临时密钥后,回传给 SDK 的方法 */
  175. callback: (
  176. /** params 回传给 SDK 的签名或获取临时密钥 */
  177. params: GetAuthorizationCallbackParams
  178. ) => void
  179. ) => void,
  180. }
  181. interface Util {
  182. md5: (str: String, encoding?: string) => string,
  183. xml2json: (bodyStr: string) => any,
  184. json2xml: (json: any) => string,
  185. }
  186. interface StaticGetAuthorizationOptions {
  187. /** 计算签名用的密钥 SecretId,必选 */
  188. SecretId: string,
  189. /** 计算签名用的密钥 SecretKey,必选 */
  190. SecretKey: string,
  191. /** 请求方法,可选 */
  192. Method?: Method,
  193. /** 请求路径,最前面带 /,例如 /images/1.jpg,可选 */
  194. Pathname?: Pathname,
  195. /** 请求的对象键,最前面不带 /,例如 images/1.jpg,可选 */
  196. Key?: Key,
  197. /** 要参与签名计算的 Url Query 参数,可选 */
  198. Query?: Query,
  199. /** 要参与签名计算的 Header 参数,可选 */
  200. Headers?: Headers,
  201. /** 签名几秒后失效,默认为900秒,如果传入了 KeyTime,以 KeyTime 为准,可选 */
  202. Expires?: number,
  203. /** 签名有效时间戳区间,如果传入了该参数,会赋值给在签名里的 q-key-time 和 q-sign-time 字段,格式如:1611915436;1611916336 */
  204. KeyTime?: string,
  205. /** 校正时间的偏移值,单位 ms(毫秒),计算签名时会用设备当前时间戳加上该偏移值,在设备时间有误时可用于校正签名用的时间参数。 */
  206. SystemClockOffset?: number,
  207. }
  208. /** 计算签名或获取临时密钥可能需要的参数列表 */
  209. interface GetAuthorizationOptions {
  210. /** 存储桶的名称,格式为<bucketname-appid>,例如examplebucket-1250000000 */
  211. Bucket: Bucket,
  212. /** 存储桶所在地域 @see https://cloud.tencent.com/document/product/436/6224 */
  213. Region: Region,
  214. /** 请求方法 */
  215. Method: Method,
  216. /** 请求路径,最前面带 /,例如 /images/1.jpg,Pathname 和 Key 二选一 */
  217. Pathname: Pathname,
  218. /** 请求的对象键,最前面不带 /,例如 images/1.jpg,如果是存储桶接口,传入空字符串,Key 和 Pathname 二选一,推荐使用 Pathname 参数 */
  219. Key: Key,
  220. /** 请求里的 Url Query 参数,可选 */
  221. Query: Query,
  222. /** 请求里的 Header 参数,可选 */
  223. Headers: Headers,
  224. /** 当前需要用凭证的请求,需要的最小权限 */
  225. Scope: Scope,
  226. /** 校正时间的偏移值,单位 ms(毫秒),计算签名时会用设备当前时间戳加上该偏移值,在设备时间有误时可用于校正签名用的时间参数。 */
  227. SystemClockOffset: number,
  228. }
  229. /** 请求凭证,包含临时密钥信息 */
  230. interface Credentials {
  231. /** 临时密钥 tmpSecretId */
  232. TmpSecretId: string,
  233. /** 临时密钥 tmpSecretKey */
  234. TmpSecretKey: string,
  235. /** 临时密钥 sessonToken */
  236. SecurityToken?: string,
  237. /** 同 SecurityToken,推荐用 SecurityToken */
  238. XCosSecurityToken?: string,
  239. /** 获取临时密钥时,服务端的时间,该时间用于计算签名,可以避免设备时间有偏差导致请求错误 */
  240. StartTime: number,
  241. /** 获取临时密钥的过期时间戳 */
  242. ExpiredTime: number,
  243. /** 该临时密钥是否仅用于相同 Scope 权限范围的请求 */
  244. ScopeLimit?: boolean,
  245. }
  246. /** 用于发请求的签名字符串,会放在请求 Header 里的 Authorization 字段 */
  247. type Authorization = string;
  248. /** SDK 用于请求的凭证,可以是签名,也可以是临时密钥信息 */
  249. type GetAuthorizationCallbackParams = Authorization | Credentials;
  250. /** 一般接口的返回结果 */
  251. interface GeneralResult {
  252. /** 请求返回的 HTTP 状态码 */
  253. statusCode?: number,
  254. /** 请求返回的 header 字段 */
  255. headers?: Headers,
  256. /** 请求的唯一标识 */
  257. RequestId?: string,
  258. }
  259. /** SDK 的错误格式,其中服务端返回错误码可查看 @see https://cloud.tencent.com/document/product/436/7730 */
  260. interface CosSdkError extends GeneralResult {
  261. /** 错误码 */
  262. code: string,
  263. /** 错误信息 */
  264. message: string,
  265. /** 兼容老的错误信息字段,不建议使用,可能是参数错误、客户端出错、或服务端返回的错误 */
  266. error: string | Error | { Code: string, Message: string },
  267. }
  268. /** 回调的错误格式,其中服务端返回错误码可查看 @see https://cloud.tencent.com/document/product/436/7730 */
  269. type CosError = null | CosSdkError;
  270. /** 存储桶操作接口的公共参数 */
  271. interface BucketParams {
  272. /** 存储桶的名称,格式为<bucketname-appid>,例如examplebucket-1250000000 */
  273. Bucket: Bucket,
  274. /** 存储桶所在地域 @see https://cloud.tencent.com/document/product/436/6224 */
  275. Region: Region,
  276. /** 请求时带上的 Header 字段 */
  277. Headers?: Headers,
  278. }
  279. /** 对象操作接口的公共参数 */
  280. interface ObjectParams {
  281. /** 存储桶的名称,格式为<bucketname-appid>,例如examplebucket-1250000000 */
  282. Bucket: Bucket,
  283. /** 存储桶所在地域,如果有传入只返回该地域的存储桶列表 */
  284. Region: Region,
  285. /** 请求的对象键,最前面不带 / */
  286. Key: Key,
  287. /** 发请求时带上的 Header 字段 */
  288. Headers?: Headers,
  289. }
  290. // 所有接口的入参和出参
  291. // getService
  292. interface GetServiceParams {
  293. /** 存储桶所在地域,如果传入只返回该地域的存储桶 */
  294. Region?: Region,
  295. /** 发请求时带上的 Header 字段 */
  296. Headers?: Headers,
  297. }
  298. /** getService 接口返回值 */
  299. interface GetServiceResult extends GeneralResult {
  300. Buckets: {
  301. /** 存储桶的名称,格式为<bucketname-appid>,例如examplebucket-1250000000 */
  302. Name: Bucket,
  303. /** 存储桶所在地域 */
  304. Location: Region,
  305. /** 存储桶创建时间 */
  306. CreationDate: IsoDateTime,
  307. }[],
  308. /** 所有者的信息 */
  309. Owner: Owner,
  310. }
  311. // putBucket
  312. /** putBucket 接口参数 */
  313. interface PutBucketParams extends BucketParams {
  314. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write,可选 */
  315. ACL?: BucketACL,
  316. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  317. GrantRead?: Grant,
  318. /** 赋予被授权者写取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  319. GrantWrite?: Grant,
  320. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  321. GrantReadAcp?: Grant,
  322. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  323. GrantWriteAcp?: Grant,
  324. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  325. GrantFullControl?: Grant,
  326. /** 要创建存储桶的AZ类型,创建多AZ存储桶,传入 'MAZ' */
  327. BucketAZConfig?: 'MAZ' | string,
  328. }
  329. /** putBucket 接口返回值 */
  330. interface PutBucketResult extends GeneralResult {
  331. /** 创建的存储桶访问地址,不带 https:// 前缀,例如 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/ */
  332. Location: Location
  333. }
  334. // headBucket
  335. /** headBucket 接口参数 */
  336. interface HeadBucketParams extends BucketParams {}
  337. /** headBucket 接口返回值 */
  338. interface HeadBucketResult extends GeneralResult {}
  339. // getBucket
  340. /** getBucket 接口参数 */
  341. interface GetBucketParams extends BucketParams {
  342. /** 前缀匹配,用来规定返回的文件前缀地址,可选 */
  343. Prefix?: Prefix,
  344. /** 一个字符的分隔符,常用 / 字符,用于对对象键进行分组。所有对象键中从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分将作为 CommonPrefixes 下的一个 Prefix 节点。被分组的对象键不再出现在后续对象列表中,可选 */
  345. Delimiter?: Delimiter,
  346. /** 默认以UTF-8二进制顺序列出条目,所有列出条目从marker开始,可选 */
  347. Marker?: Key,
  348. /** 单次返回最大的条目数量,默认值为1000,最大为1000,注意:该参数会限制每一次 List 操作返回的最大条目数,COS 在每次 List 操作中将返回不超过 max-keys 所设定数值的条目(即 CommonPrefixes 和 Contents 的总和),如果单次响应中未列出所有对象,COS 会返回 NextMarker 节点,其值作为您下次 List 请求的 marker 参数,以便您列出后续对象,可选 */
  349. MaxKeys?: number,
  350. /** 规定返回值的编码方式,可选值:url,代表返回的对象键为 URL 编码(百分号编码)后的值,例如“腾讯云”将被编码为%E8%85%BE%E8%AE%AF%E4%BA%91 */
  351. EncodingType?: EncodingType,
  352. }
  353. /** 对象信息 */
  354. interface CosObject {
  355. /** 对象键 */
  356. Key: Key,
  357. /** 当前版本的最后修改时间,为 ISO8601 格式,例如2019-05-24T10:56:40Z */
  358. LastModified: IsoDateTime,
  359. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如“8e0b617ca298a564c3331da28dcb50df”,此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  360. ETag: ETag,
  361. /** 对象大小,单位为 Byte */
  362. Size: string,
  363. /** 对象存储类型。枚举值 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING @see https://cloud.tencent.com/document/product/436/33417 */
  364. StorageClass: StorageClass,
  365. /** 当对象存储类型为智能分层存储时,指示对象当前所处的存储层,枚举值:FREQUENT(标准层),INFREQUENT(低频层)。仅当 StorageClass 为 INTELLIGENT_TIERING(智能分层)时才会返回该节点 */
  366. StorageTier?: string,
  367. /** 对象持有者信息 */
  368. Owner: Owner,
  369. }
  370. /** getBucket 接口返回值 */
  371. interface GetBucketResult extends GeneralResult {
  372. /** 对象条目 */
  373. Contents: CosObject[]
  374. /** 从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分,定义为 Common Prefix。仅当请求中指定了 delimiter 参数才有可能返回该节点 */
  375. CommonPrefixes: {
  376. /** 前缀匹配,用来规定返回的文件前缀地址 */
  377. Prefix: Prefix,
  378. }[],
  379. /** 响应条目是否被截断,布尔值,例如 true 或 false,可用于判断是否还需要继续列出文件 */
  380. IsTruncated: BooleanString,
  381. /** 仅当响应条目有截断(IsTruncated 为 true)才会返回该节点,该节点的值为当前响应条目中的最后一个对象键,当需要继续请求后续条目时,将该节点的值作为下一次请求的 marker 参数传入 */
  382. NextMarker?: string,
  383. }
  384. // listObjectVersions
  385. /** listObjectVersions 接口参数 */
  386. interface ListObjectVersionsParams extends BucketParams {
  387. /** 前缀匹配,用来规定返回的文件前缀地址,可选 */
  388. Prefix?: Prefix,
  389. /** 一个字符的分隔符,常用 / 字符,用于对对象键进行分组。所有对象键中从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分将作为 CommonPrefixes 下的一个 Prefix 节点。被分组的对象键不再出现在后续对象列表中,可选 */
  390. Delimiter?: Delimiter,
  391. /** 默认以UTF-8二进制顺序列出条目,所有列出条目从marker开始,可选 */
  392. Marker?: string,
  393. /** 单次返回最大的条目数量,默认值为1000,最大为1000,注意:该参数会限制每一次 List 操作返回的最大条目数,COS 在每次 List 操作中将返回不超过 max-keys 所设定数值的条目(即 CommonPrefixes 和 Contents 的总和),如果单次响应中未列出所有对象,COS 会返回 NextMarker 节点,其值作为您下次 List 请求的 marker 参数,以便您列出后续对象,可选 */
  394. MaxKeys?: string,
  395. /** 起始版本 ID 标记,从该标记之后(不含)返回对象版本条目,对应请求中的 url 参数 version-id-marker */
  396. VersionIdMarker?: string,
  397. /** 规定返回值的编码方式,可选值:url,代表返回的对象键为 URL 编码(百分号编码)后的值,例如“腾讯云”将被编码为%E8%85%BE%E8%AE%AF%E4%BA%91 */
  398. EncodingType?: EncodingType,
  399. }
  400. /** 对象删除标记条目 */
  401. interface DeleteMarker {
  402. /** 对象键 */
  403. Key: Key,
  404. /** 对象的版本 ID;当未启用版本控制时,该节点的值为空字符串;当启用版本控制时,启用版本控制之前的对象,其版本 ID 为 null;当暂停版本控制时,新上传的对象其版本 ID 为 null,且同一个对象最多只存在一个版本 ID 为 null 的对象版本 */
  405. VersionId: VersionId,
  406. /** 当前版本是否为该对象的最新版本 */
  407. IsLatest: string,
  408. /** 当前版本的最后修改时间,为 ISO8601 格式,例如2019-05-24T10:56:40Z */
  409. LastModified: IsoDateTime,
  410. Owner: Owner,
  411. }
  412. interface ObjectVersion {
  413. /** 对象键 */
  414. Key: Key,
  415. /** 对象的删除标记的版本 ID */
  416. VersionId: VersionId,
  417. /** 当前版本是否为该对象的最新版本 */
  418. IsLatest: BooleanString,
  419. /** 当前版本的最后修改时间,为 ISO8601 格式,例如2019-05-24T10:56:40Z */
  420. LastModified: IsoDateTime,
  421. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  422. ETag: ETag,
  423. /** 对象大小,单位为 Byte */
  424. Size: string,
  425. /** 对象大小,单位为 Byte */
  426. Owner: Owner,
  427. /** 对象存储类型。枚举值 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING @see https://cloud.tencent.com/document/product/436/33417 */
  428. StorageClass: StorageClass,
  429. /** 当对象存储类型为智能分层存储时,指示对象当前所处的存储层,枚举值:FREQUENT(标准层),INFREQUENT(低频层)。仅当 StorageClass 为 INTELLIGENT_TIERING(智能分层)时才会返回该节点 */
  430. StorageTier?: string,
  431. }
  432. /** listObjectVersions 接口返回值 */
  433. interface ListObjectVersionsResult extends GeneralResult {
  434. /** 从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分,定义为 Common Prefix。仅当请求中指定了 delimiter 参数才有可能返回该节点 */
  435. CommonPrefixes: {
  436. /** 前缀匹配,用来规定返回的文件前缀地址 */
  437. Prefix: Prefix,
  438. }[],
  439. /** 对象版本条目 */
  440. Versions: ObjectVersion[],
  441. /** 对象删除标记条目 */
  442. DeleteMarkers: DeleteMarker[],
  443. /** 响应条目是否被截断,布尔值,例如 true 或 false,可用于判断是否还需要继续列出文件 */
  444. IsTruncated: BooleanString,
  445. /** 仅当响应条目有截断(IsTruncated 为 true)才会返回该节点,该节点的值为当前响应条目中的最后一个对象键,当需要继续请求后续条目时,将该节点的值作为下一次请求的 marker 参数传入 */
  446. NextMarker?: string,
  447. /** 仅当响应条目有截断(IsTruncated 为 true)才会返回该节点,该节点的值为当前响应条目中的最后一个对象的版本 ID,当需要继续请求后续条目时,将该节点的值作为下一次请求的 version-id-marker 参数传入。该节点的值可能为空,此时下一次请求的 version-id-marker 参数也需要指定为空。 */
  448. NextVersionIdMarker?: string,
  449. }
  450. // deleteBucket
  451. /** deleteBucket 接口参数 */
  452. interface DeleteBucketParams extends BucketParams {}
  453. /** deleteBucket 接口返回值 */
  454. interface DeleteBucketResult extends GeneralResult {}
  455. // putBucketAcl
  456. /** putBucketAcl 接口参数 */
  457. interface PutBucketAclParams extends BucketParams {
  458. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write,可选 */
  459. ACL?: BucketACL,
  460. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  461. GrantRead?: Grant,
  462. /** 赋予被授权者写取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  463. GrantWrite?: Grant,
  464. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  465. GrantReadAcp?: Grant,
  466. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  467. GrantWriteAcp?: Grant,
  468. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  469. GrantFullControl?: Grant,
  470. /** 放在 XML Body 的授权参数 */
  471. AccessControlPolicy?: {
  472. /** 所有者的信息 */
  473. Owner: Owner,
  474. /** 被授权者信息与权限信息 */
  475. Grants: Grants[]
  476. }
  477. }
  478. /** putBucketAcl 接口返回值 */
  479. interface PutBucketAclResult extends GeneralResult {}
  480. // getBucketAcl
  481. /** getBucketAcl 接口参数 */
  482. interface GetBucketAclParams extends BucketParams {}
  483. /** getBucketAcl 接口返回值 */
  484. interface GetBucketAclResult extends GeneralResult {
  485. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write */
  486. ACL: BucketACL,
  487. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  488. GrantRead: Grant,
  489. /** 赋予被授权者写取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  490. GrantWrite: Grant,
  491. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  492. GrantReadAcp: Grant,
  493. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  494. GrantWriteAcp: Grant,
  495. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  496. GrantFullControl: Grant,
  497. /** 存储桶持有者信息 */
  498. Owner: Owner,
  499. /** 被授权者信息与权限信息 */
  500. Grants: Grants[],
  501. }
  502. // putBucketCors
  503. type CORSRule = {
  504. /** 允许的访问来源,单条 CORSRule 可以配置多个 AllowedOrigin。
  505. 配置支持 *,表示全部域名都允许,但不推荐。
  506. 支持单个具体域名,例如 http://www.example.com。
  507. 支持 * 通配符,通配符可出现在任何位置,包括协议、域名和端口,可匹配0个或多个字符,但是只能有一个 *。请谨慎使用通配符,因为可能意外匹配到非预期的来源
  508. 注意不要遗漏协议名 http 或 https,若端口不是默认的80(http)或443(https),还需要带上端口,例如 https://example.com:8443。 */
  509. AllowedOrigin: string[],
  510. /** 允许的 HTTP 操作方法(Method),对应 CORS 请求响应中的 Access-Control-Allow-Methods 头部,单条 CORSRule 可以配置多个 AllowedMethod。枚举值:PUT、GET、POST、DELETE、HEAD。 */
  511. AllowedMethod: string[],
  512. /** 在发送预检(OPTIONS)请求时,浏览器会告知服务端接下来的正式请求将使用的自定义 HTTP 请求头部,此配置用于指定允许浏览器发送 CORS 请求时携带的自定义 HTTP 请求头部,不区分英文大小写,单条 CORSRule 可以配置多个 AllowedHeader。
  513. 可以配置*,代表允许所有头部,为了避免遗漏,推荐配置为*。
  514. 如果不配置为*,那么在预检(OPTIONS)请求中 Access-Control-Request-Headers 头部出现的每个 Header,都必须在 AllowedHeader 中有对应项。 */
  515. AllowedHeader?: string[],
  516. /** 允许浏览器获取的 CORS 请求响应中的头部,不区分大小写,单条 CORSRule 可以配置多个 ExposeHeader。
  517. 默认情况下浏览器只能访问简单响应头部:Cache-Control、Content-Type、Expires、Last-Modified,如果需要访问其他响应头部,需要添加 ExposeHeader 配置。
  518. 不支持配置为 *,必须明确配置具体的 Header。
  519. 根据浏览器的实际需求确定,默认推荐填写 ETag,可参考各 API 文档的响应头部分及 公共响应头部 文档。@see https://cloud.tencent.com/document/product/436/7729 */
  520. ExposeHeader?: string[],
  521. /** 跨域资源共享配置的有效时间,单位为秒,在有效时间内,浏览器无须为同一请求再次发起预检(OPTIONS)请求,对应 CORS 请求响应中的 Access-Control-Max-Age 头部,单条 CORSRule 只能配置一个 MaxAgeSeconds。 */
  522. MaxAgeSeconds?: number,
  523. };
  524. /** putBucketCors 接口参数 */
  525. interface PutBucketCorsParams extends BucketParams {
  526. /** 存储桶跨域资源共享(CORS)访问控制规则 */
  527. CORSRules: CORSRule[]
  528. }
  529. /** putBucketCors 接口返回值 */
  530. interface PutBucketCorsResult extends GeneralResult {
  531. /** 存储桶跨域资源共享(CORS)访问控制规则 */
  532. CORSRules: Record<string, any>,
  533. }
  534. // getBucketCors
  535. /** getBucketCors 接口参数 */
  536. interface GetBucketCorsParams extends BucketParams {}
  537. /** getBucketCors 接口返回值 */
  538. interface GetBucketCorsResult extends GeneralResult {}
  539. // deleteBucketCors
  540. /** deleteBucketCors 接口参数 */
  541. interface DeleteBucketCorsParams extends BucketParams {}
  542. /** deleteBucketCors 接口返回值 */
  543. interface DeleteBucketCorsResult extends GeneralResult {}
  544. // getBucketLocation
  545. interface GetBucketLocationResult {
  546. /** 存储桶所在地域 */
  547. LocationConstraint: Region,
  548. }
  549. /** getBucketLocation 接口参数 */
  550. interface GetBucketLocationParams extends BucketParams {}
  551. // putBucketPolicy
  552. /** putBucketPolicy 接口参数 */
  553. interface PutBucketPolicyParams extends BucketParams {
  554. /** 存储桶的权限策略 @see https://cloud.tencent.com/document/product/436/31923 */
  555. Policy: Record<string, any>,
  556. }
  557. /** putBucketPolicy 接口返回值 */
  558. interface PutBucketPolicyResult extends GeneralResult {}
  559. // getBucketPolicy
  560. /** getBucketPolicy 接口参数 */
  561. interface GetBucketPolicyParams extends BucketParams {}
  562. /** getBucketPolicy 接口返回值 */
  563. interface GetBucketPolicyResult extends GeneralResult {
  564. /** 存储桶的权限策略 @see https://cloud.tencent.com/document/product/436/31923 */
  565. Policy: Record<string, any>
  566. }
  567. // deleteBucketPolicy
  568. /** deleteBucketPolicy 接口参数 */
  569. interface DeleteBucketPolicyParams extends BucketParams {}
  570. /** deleteBucketPolicy 接口返回值 */
  571. interface DeleteBucketPolicyResult extends GeneralResult {}
  572. // putBucketTagging
  573. /** putBucketTagging 接口参数 */
  574. interface PutBucketTaggingParams extends BucketParams {
  575. /** 标签集合,最多支持10个标签 */
  576. Tags: Tag[],
  577. }
  578. /** putBucketTagging 接口返回值 */
  579. interface PutBucketTaggingResult extends GeneralResult {}
  580. // getBucketTagging
  581. /** getBucketTagging 接口参数 */
  582. interface GetBucketTaggingParams extends BucketParams {}
  583. /** getBucketTagging 接口返回值 */
  584. interface GetBucketTaggingResult extends GeneralResult {
  585. /** 标签集合,最多支持10个标签 */
  586. Tags: Tag[]
  587. }
  588. // deleteBucketTagging
  589. /** deleteBucketTagging 接口参数 */
  590. interface DeleteBucketTaggingParams extends BucketParams {}
  591. /** deleteBucketTagging 接口返回值 */
  592. interface DeleteBucketTaggingResult extends GeneralResult {}
  593. // putBucketLifecycle
  594. /** 生命周期配置规则 */
  595. type LifecycleRule = {
  596. /** 用于唯一地标识规则,长度不能超过255个字符,可选 */
  597. ID: string,
  598. /** 指明规则是否启用,枚举值:Enabled,Disabled,必选 */
  599. Status: 'Enabled' | 'Disabled',
  600. /** Filter 用于描述规则影响的 Object 集合,必选 */
  601. Filter?: Record<string, any>,
  602. /** 规则转换属性,对象何时转换为 Standard_IA 或 Archive 等存储类型 */
  603. Transition?: Record<string, any>,
  604. /** 规则过期属性 */
  605. Expiration?: Record<string, any>,
  606. /** 设置允许分片上传保持运行的最长时间 */
  607. AbortIncompleteMultipartUpload?: Record<string, any>,
  608. /** 指明非当前版本对象何时过期 */
  609. NoncurrentVersionExpiration?: Record<string, any>,
  610. /** 指明非当前版本对象何时转换为 STANDARD_IA 或 ARCHIVE 等存储类型 */
  611. NoncurrentVersionTransition?: Record<string, any>,
  612. };
  613. /** putBucketLifecycle 接口参数 */
  614. interface PutBucketLifecycleParams extends BucketParams {
  615. /** 生命周期配置规则列表 */
  616. Rules: LifecycleRule[],
  617. }
  618. /** putBucketLifecycle 接口返回值 */
  619. interface PutBucketLifecycleResult extends GeneralResult {}
  620. // getBucketLifecycle
  621. /** getBucketLifecycle 接口参数 */
  622. interface GetBucketLifecycleParams extends BucketParams {}
  623. /** getBucketLifecycle 接口返回值 */
  624. interface GetBucketLifecycleResult extends GeneralResult {
  625. /** 生命周期配置规则列表 */
  626. Rules: LifecycleRule[]
  627. }
  628. // deleteBucketLifecycle
  629. /** deleteBucketLifecycle 接口参数 */
  630. interface DeleteBucketLifecycleParams extends BucketParams {}
  631. /** deleteBucketLifecycle 接口返回值 */
  632. interface DeleteBucketLifecycleResult extends GeneralResult {}
  633. // putBucketVersioning
  634. /** 存储桶版本控制开关信息 */
  635. interface VersioningConfiguration {
  636. /** 说明版本是否开启,枚举值:Suspended、Enabled */
  637. Status: 'Enabled' | 'Suspended',
  638. }
  639. /** putBucketVersioning 接口参数 */
  640. interface PutBucketVersioningParams extends BucketParams {
  641. /** 存储桶版本控制开关信息 */
  642. VersioningConfiguration: VersioningConfiguration,
  643. }
  644. /** putBucketVersioning 接口返回值 */
  645. interface PutBucketVersioningResult extends GeneralResult {}
  646. // getBucketVersioning
  647. /** getBucketVersioning 接口参数 */
  648. interface GetBucketVersioningParams extends BucketParams {}
  649. /** getBucketVersioning 接口返回值 */
  650. interface GetBucketVersioningResult extends GeneralResult {
  651. /** 存储桶版本控制开关信息 */
  652. VersioningConfiguration: VersioningConfiguration,
  653. }
  654. // putBucketReplication
  655. interface ReplicationRule {
  656. /** 用来标注具体 Rule 的名称 */
  657. ID?: string,
  658. /** 标识 Rule 是否生效,枚举值:Enabled, Disabled */
  659. Status: 'Enabled' | 'Disabled',
  660. /** 前缀匹配,用来规定返回的文件前缀地址 */
  661. Prefix: Prefix,
  662. /** 目标存储桶信息 */
  663. Destination: {
  664. /** 资源标识符:qcs::cos:<region>::<bucketname-appid> */
  665. Bucket: string,
  666. /** 存储类型,枚举值:STANDARD,INTELLIGENT_TIERING,STANDARD_IA 等。默认值:原存储类型 */
  667. StorageClass?: StorageClass,
  668. }
  669. }
  670. /** 说明所有复制配置信息 */
  671. interface ReplicationConfiguration {
  672. /** 发起者身份标示:qcs::cam::uin/&lt;OwnerUin>:uin/&lt;SubUin> */
  673. Role: string,
  674. /** 具体配置信息,最多支持1000个,所有策略只能指向一个目标存储桶 */
  675. Rules: ReplicationRule[]
  676. }
  677. /** putBucketReplication 接口参数 */
  678. interface PutBucketReplicationParams extends BucketParams {
  679. /** 说明所有复制配置信息 */
  680. ReplicationConfiguration: ReplicationConfiguration,
  681. }
  682. /** putBucketReplication 接口返回值 */
  683. interface PutBucketReplicationResult extends GeneralResult {}
  684. // getBucketReplication
  685. /** getBucketReplication 接口参数 */
  686. interface GetBucketReplicationParams extends BucketParams {}
  687. /** getBucketReplication 接口返回值 */
  688. interface GetBucketReplicationResult extends GeneralResult {
  689. /** 说明所有复制配置信息 */
  690. ReplicationConfiguration: ReplicationConfiguration,
  691. }
  692. // deleteBucketReplication
  693. /** deleteBucketReplication 接口参数 */
  694. interface DeleteBucketReplicationParams extends BucketParams {}
  695. /** deleteBucketReplication 接口返回值 */
  696. interface DeleteBucketReplicationResult extends GeneralResult {}
  697. // putBucketWebsite
  698. /** 存储桶配置静态网站配置信息 */
  699. interface WebsiteConfiguration {
  700. /** 索引文档配置 */
  701. IndexDocument: {
  702. /** 指定索引文档的对象键后缀。例如指定为index.html,那么当访问到存储桶的根目录时,会自动返回 index.html 的内容,或者当访问到article/目录时,会自动返回 article/index.html的内容 */
  703. Suffix: string,
  704. },
  705. /** 重定向所有请求配置 */
  706. RedirectAllRequestsTo?: {
  707. /** 指定重定向所有请求的目标协议,只能设置为 https */
  708. Protocol: "https" | string
  709. },
  710. /** 用于配置是否忽略扩展名 */
  711. AutoAddressing?: {
  712. /** 用于配置是否忽略 HTML 拓展名,可选值为 Enabled 或 Disabled,默认为 Disabled */
  713. Status: 'Disabled' | 'Enabled'
  714. },
  715. /** 错误文档配置 */
  716. ErrorDocument?: {
  717. /** 指定通用错误文档的对象键,当发生错误且未命中重定向规则中的错误码重定向时,将返回该对象键的内容 */
  718. Key: Key,
  719. /** 用于配置命中错误文档的 HTTP 状态码,可选值为 Enabled 或 Disabled,默认为 Enabled */
  720. OriginalHttpStatus?: 'Enabled' | 'Disabled'
  721. },
  722. /** 重定向规则配置,最多设置100条 RoutingRule */
  723. RoutingRules?: {
  724. /** 重定向规则的条件配置 */
  725. Condition: {
  726. /** 指定重定向规则的错误码匹配条件,只支持配置4XX返回码,例如403或404,HttpErrorCodeReturnedEquals 与 KeyPrefixEquals 必选其一 */
  727. HttpErrorCodeReturnedEquals?: string | number,
  728. /** 指定重定向规则的对象键前缀匹配条件,HttpErrorCodeReturnedEquals 与 KeyPrefixEquals 必选其一 */
  729. KeyPrefixEquals?: 'Enabled' | 'Disabled',
  730. },
  731. /** 重定向规则的具体重定向目标配置 */
  732. Redirect: {
  733. /** 指定重定向规则的目标协议,只能设置为 https */
  734. Protocol?: 'https' | string,
  735. /** 指定重定向规则的具体重定向目标的对象键,替换方式为替换整个原始请求的对象键,ReplaceKeyWith 与 ReplaceKeyPrefixWith 必选其一 */
  736. ReplaceKeyWith?: string,
  737. /** 指定重定向规则的具体重定向目标的对象键,替换方式为替换原始请求中所匹配到的前缀部分,仅可在 Condition 为 KeyPrefixEquals 时设置,ReplaceKeyWith 与 ReplaceKeyPrefixWith 必选其一 */
  738. ReplaceKeyPrefixWith?: string,
  739. },
  740. }[],
  741. }
  742. /** putBucketWebsite 接口参数 */
  743. interface PutBucketWebsiteParams extends BucketParams {
  744. /** 存储桶配置静态网站配置信息 */
  745. WebsiteConfiguration: WebsiteConfiguration,
  746. }
  747. /** putBucketWebsite 接口返回值 */
  748. interface PutBucketWebsiteResult extends GeneralResult {}
  749. // getBucketWebsite
  750. /** getBucketWebsite 接口参数 */
  751. interface GetBucketWebsiteParams extends BucketParams {}
  752. /** getBucketWebsite 接口返回值 */
  753. interface GetBucketWebsiteResult extends GeneralResult {
  754. /** 存储桶配置静态网站配置信息 */
  755. WebsiteConfiguration: WebsiteConfiguration
  756. }
  757. // deleteBucketWebsite
  758. /** deleteBucketWebsite 接口参数 */
  759. interface DeleteBucketWebsiteParams extends BucketParams {}
  760. /** deleteBucketWebsite 接口返回值 */
  761. interface DeleteBucketWebsiteResult extends GeneralResult {}
  762. // putBucketReferer
  763. /** 防盗链配置信息 */
  764. interface RefererConfiguration {
  765. /** 是否开启防盗链,枚举值:Enabled、Disabled */
  766. Status: 'Enabled' | 'Disabled',
  767. /** 防盗链类型,枚举值:Black-List、White-List */
  768. RefererType: 'Black-List' | 'White-List',
  769. /** 生效域名列表, 支持多个域名且为前缀匹配, 支持带端口的域名和 IP, 支持通配符*,做二级域名或多级域名的通配 */
  770. DomainList: {
  771. /** 生效域名,例如www.qq.com/example,192.168.1.2:8080, *.qq.com */
  772. Domains: string[]
  773. },
  774. /** 是否允许空 Referer 访问,枚举值:Allow、Deny,默认值为 Deny */
  775. EmptyReferConfiguration?: 'Allow' | 'Deny',
  776. }
  777. /** putBucketReferer 接口参数 */
  778. interface PutBucketRefererParams extends BucketParams {
  779. /** 防盗链配置信息 */
  780. RefererConfiguration: RefererConfiguration,
  781. }
  782. /** putBucketReferer 接口返回值 */
  783. interface PutBucketRefererResult extends GeneralResult {}
  784. // getBucketReferer
  785. /** getBucketReferer 接口参数 */
  786. interface GetBucketRefererParams extends BucketParams {}
  787. /** getBucketReferer 接口返回值 */
  788. interface GetBucketRefererResult extends GeneralResult {
  789. /** 防盗链配置信息 */
  790. RefererConfiguration: RefererConfiguration,
  791. }
  792. // putBucketDomain
  793. /** 绑定的域名条目 */
  794. interface DomainRule {
  795. /** 是否启用。枚举值:ENABLED:启用,DISABLED:禁用,必选 */
  796. Status: 'DISABLED' | 'ENABLED',
  797. /** 完整域名,必选 */
  798. Name: string,
  799. /** 源站类型。枚举值:REST:默认源站,WEBSITE:静态源站源站,ACCELERATE:全球加速源站,必选 */
  800. Type: 'REST' | 'WEBSITE' | 'ACCELERATE',
  801. /** 如果指定域名已经作为其他存储桶的自定义域名,那么可以指定该元素强制将该域名作为当前存储桶的自定义域名。当前只支持 CNAME,代表您需要先将该域名的 CNAME 指向当前存储桶的源站域名(根据 Type 元素的不同对应为默认源站、静态网站源站或全球加速源站)后才能通过该接口设置自定义域名。可选 */
  802. ForcedReplacement?: string,
  803. }
  804. /** putBucketDomain 接口参数 */
  805. interface PutBucketDomainParams extends BucketParams {
  806. /** 绑定的域名条目 */
  807. DomainRule: DomainRule[],
  808. }
  809. /** putBucketDomain 接口返回值 */
  810. interface PutBucketDomainResult extends GeneralResult {}
  811. // getBucketDomain
  812. /** getBucketDomain 接口参数 */
  813. interface GetBucketDomainParams extends BucketParams {}
  814. /** getBucketDomain 接口返回值 */
  815. interface GetBucketDomainResult extends GeneralResult {
  816. /** 绑定的域名条目 */
  817. DomainRule: DomainRule[]
  818. }
  819. // deleteBucketDomain
  820. /** deleteBucketDomain 接口参数 */
  821. interface DeleteBucketDomainParams extends BucketParams {}
  822. /** deleteBucketDomain 接口返回值 */
  823. interface DeleteBucketDomainResult extends GeneralResult {}
  824. // putBucketOrigin
  825. /** Origin 回源规则配置 */
  826. interface OriginRule {
  827. /** 通过优先级区分规则执行先后,必选 */
  828. RulePriority: 1
  829. /** 回源类型,支持同步回源(Mirror)和异步回源(Proxy)两种模式。 枚举值:Mirror、Proxy。必选 */
  830. OriginType: 'Mirror' | 'Proxy',
  831. /** 回源配置,配置用户使用的 HTTP 传输协议等信息。必选 */
  832. OriginCondition: {
  833. /** 触发回源的 HTTP 状态码,默认为404。必选 */
  834. HTTPStatusCode: number,
  835. /** 触发回源的文件前缀,默认为空,任意文件均可触发。可选 */
  836. Prefix: Prefix,
  837. },
  838. /** 回源地址相关信息,必选 */
  839. OriginParameter: {
  840. /** 回源使用的协议,枚举值为 HTTP(使用 HTTP 协议),HTTPS(使用 HTTPS 协议)、FOLLOW(跟随用户使用的协议),默认值为 FOLLOW。必选 */
  841. Protocol: 'HTTP' | 'HTTPS' | 'FOLLOW',
  842. /** Proxy 模式下是否需要透传 HTTP 请求串,枚举值:true、false,默认为 true。可选 */
  843. FollowQueryString?: BooleanString,
  844. /** Proxy 模式下是否需要 Http 头部传输配置。可选 */
  845. HttpHeader?: {
  846. /** Proxy 模式下是否传输请求头部,枚举值:true、false,默认为 false。可选 */
  847. FollowHttpHeader?: BooleanString,
  848. /** 设置 Proxy 模式传输的请求头部。可选 */
  849. NewHttpHeader?: {
  850. /** 回源到源站时添加新的自定义头部,默认为空。可选 */
  851. Header?: {
  852. /** 用户设置的头部名称,默认为空。形式如 x-cos、oss、amz-ContentType、CacheControl、ContentDisposition、ContentEncoding、HttpExpiresDate、UserMetaData。可选 */
  853. Key?: string,
  854. /** 用户设置的头部值,默认为空。可选 */
  855. Value?: string
  856. }[]
  857. },
  858. },
  859. /** Proxy 模式下源站 3XX 响应策略,枚举值:true、false,选择 true 时跟随源站 3xx 重定向请求获取到资源,并将资源保存到 COS 上;选择 false 时透传 3XX 响应,不获取资源),默认为 true。可选 */
  860. FollowRedirection: BooleanString,
  861. /** Proxy 模式下的返回码参数,枚举值:301、302,默认为 302。可选 */
  862. HttpRedirectCode: ('301' | '302')[]
  863. },
  864. /** 回源配置,配置用户使用的 HTTP 传输协议等信息。必选 */
  865. OriginInfo: {
  866. /** 源站信息。必选 */
  867. HostInfo: {
  868. /** 源站域名或者源站 IP。必选 */
  869. HostName: string
  870. },
  871. /** 回源文件信息。必选 */
  872. FileInfo: {
  873. /** 回源文件前缀配置信息。可选 */
  874. PrefixConfiguration: {
  875. /** 回源文件的文件前缀,默认为空。可选 */
  876. Prefix: Prefix
  877. },
  878. /** 回源文件后缀配置信息。可选 */
  879. SuffixConfiguration: {
  880. /** 回源文件的文件后缀,默认为空。可选 */
  881. Suffix: string
  882. }
  883. }
  884. },
  885. }
  886. /** putBucketOrigin 接口参数 */
  887. interface PutBucketOriginParams extends BucketParams {
  888. /** Origin 回源规则配置 */
  889. OriginRule: OriginRule[],
  890. }
  891. /** putBucketOrigin 接口返回值 */
  892. interface PutBucketOriginResult extends GeneralResult {}
  893. // getBucketOrigin
  894. /** getBucketOrigin 接口参数 */
  895. interface GetBucketOriginParams extends BucketParams {}
  896. /** getBucketOrigin 接口返回值 */
  897. interface GetBucketOriginResult extends GeneralResult {
  898. /** Origin 回源规则配置 */
  899. OriginRule: OriginRule[],
  900. }
  901. // deleteBucketOrigin
  902. /** deleteBucketOrigin 接口参数 */
  903. interface DeleteBucketOriginParams extends BucketParams {}
  904. /** deleteBucketOrigin 接口返回值 */
  905. interface DeleteBucketOriginResult extends GeneralResult {}
  906. // putBucketLogging
  907. interface BucketLoggingStatus {
  908. /** 存储桶 logging 设置的具体信息,主要是目标存储桶 */
  909. LoggingEnabled?: {
  910. /** 存放日志的目标存储桶,可以是同一个存储桶(但不推荐),或同一账户下、同一地域的存储桶 */
  911. TargetBucket: Bucket,
  912. /** 日志存放在目标存储桶的指定路径 */
  913. TargetPrefix: Prefix,
  914. }
  915. }
  916. /** putBucketLogging 接口参数 */
  917. interface PutBucketLoggingParams extends BucketParams {
  918. /** 说明日志记录配置的状态,如果无子节点信息则意为关闭日志记录 */
  919. BucketLoggingStatus: BucketLoggingStatus,
  920. }
  921. /** putBucketLogging 接口返回值 */
  922. interface PutBucketLoggingResult extends GeneralResult {}
  923. // getBucketLogging
  924. /** getBucketLogging 接口参数 */
  925. interface GetBucketLoggingParams extends BucketParams {}
  926. /** getBucketLogging 接口返回值 */
  927. interface GetBucketLoggingResult extends GeneralResult {
  928. /** 说明日志记录配置的状态,如果无子节点信息则意为关闭日志记录 */
  929. BucketLoggingStatus: BucketLoggingStatus,
  930. }
  931. // putBucketInventory
  932. /** putBucketInventory 接口参数 */
  933. interface InventoryConfiguration {
  934. /** 清单的名称,与请求参数中的 id 对应,可选 */
  935. Id: string,
  936. /** 清单是否启用的标识:如果设置为 true,清单功能将生效,如果设置为 false,将不生成任何清单,必选 */
  937. IsEnabled: BooleanString,
  938. /** 是否在清单中包含对象版本:如果设置为 All,清单中将会包含所有对象版本,并在清单中增加 VersionId,IsLatest,DeleteMarker 这几个字段,如果设置为 Current,则清单中不包含对象版本信息,必选 */
  939. IncludedObjectVersions: 'All' | 'Current',
  940. /** 筛选待分析对象。清单功能将分析符合 Filter 中设置的前缀的对象,可选 */
  941. Filter?: {
  942. /** 筛选待分析对象。清单功能将分析符合 Filter 中设置的前缀的对象,可选 */
  943. Prefix?: Prefix
  944. },
  945. /** 设置清单结果中应包含的分析项目,可选 */
  946. OptionalFields?: string[],
  947. /** 配置清单任务周期,必选 */
  948. Schedule: {
  949. /** 清单任务周期,可选项为按日或者按周,枚举值:Daily、Weekly,必选 */
  950. Frequency: 'Daily' | 'Weekly'
  951. },
  952. /** 描述存放清单结果的信息,必选 */
  953. Destination: {
  954. /** 清单结果导出后存放的存储桶信息,必选 */
  955. COSBucketDestination: {
  956. /** 清单分析结果的存储桶名,如:qcs::cos:ap-guangzhou::bucket-logging-1250000000,必选 */
  957. Bucket: string,
  958. /** 清单分析结果的文件形式,可选项为 CSV 格式,必选 */
  959. Format: 'CSV',
  960. /** 存储桶的所有者 ID,例如100000000001,可选 */
  961. AccountId?: string,
  962. /** 清单分析结果的前缀,可选 */
  963. Prefix?: Prefix,
  964. /** 为清单结果提供服务端加密的选项,可选 */
  965. Encryption?: {
  966. /** COS 托管密钥的加密方式,无需填充,可选 */
  967. SSECOS?: ''
  968. }
  969. }
  970. }
  971. }
  972. interface PutBucketInventoryParams extends BucketParams {
  973. /** 清单的名称,与请求参数中的 id 对应 */
  974. Id: string,
  975. /** 包含清单任务的详细信息 */
  976. InventoryConfiguration: InventoryConfiguration,
  977. }
  978. /** putBucketInventory 接口返回值 */
  979. interface PutBucketInventoryResult extends GeneralResult {}
  980. // getBucketInventory
  981. /** getBucketInventory 接口参数 */
  982. interface GetBucketInventoryParams extends BucketParams {
  983. /** 清单的名称,与请求参数中的 id 对应 */
  984. Id: string,
  985. }
  986. /** getBucketInventory 接口返回值 */
  987. interface GetBucketInventoryResult extends GeneralResult {
  988. /** 包含清单任务的详细信息 */
  989. InventoryConfiguration: InventoryConfiguration
  990. }
  991. // listBucketInventory
  992. /** listBucketInventory 接口参数 */
  993. interface ListBucketInventoryParams extends BucketParams {}
  994. /** listBucketInventory 接口返回值 */
  995. interface ListBucketInventoryResult extends GeneralResult {
  996. /** 包含清单任务的详细信息 */
  997. InventoryConfigurations: Record<string, any>,
  998. /** 当 COS 响应体中 IsTruncated 为 true,且 NextContinuationToken 节点中存在参数值时,您可以将这个参数作为 continuation-token 参数值,以获取下一页的清单任务信息。缺省值:None */
  999. ContinuationToken: string,
  1000. /** 是否已列出所有清单任务信息的标识。如果已经展示完则为 false,否则为 true */
  1001. IsTruncated: BooleanString,
  1002. /** 下一页清单列表的标识。如果该参数中有值,则可将该值作为 continuation-token 参数并发起 GET 请求以获取下一页清单任务信息 */
  1003. NextContinuationToken?: string,
  1004. }
  1005. // deleteBucketInventory
  1006. /** deleteBucketInventory 接口参数 */
  1007. interface DeleteBucketInventoryParams extends BucketParams {
  1008. Id: string,
  1009. }
  1010. /** deleteBucketInventory 接口返回值 */
  1011. interface DeleteBucketInventoryResult extends GeneralResult {}
  1012. // putBucketAccelerate
  1013. /** 全球加速的具体信息 */
  1014. interface AccelerateConfiguration {
  1015. /** 说明全球加速功能是否开启,枚举值:Suspended、Enabled */
  1016. Status: 'Enabled' | 'Suspended',
  1017. }
  1018. /** putBucketAccelerate 接口参数 */
  1019. interface PutBucketAccelerateParams extends BucketParams {
  1020. /** 全球加速的具体信息 */
  1021. AccelerateConfiguration: AccelerateConfiguration,
  1022. }
  1023. /** putBucketAccelerate 接口返回值 */
  1024. interface PutBucketAccelerateResult extends GeneralResult {}
  1025. // getBucketAccelerate
  1026. /** getBucketAccelerate 接口参数 */
  1027. interface GetBucketAccelerateParams extends BucketParams {}
  1028. /** getBucketAccelerate 接口返回值 */
  1029. interface GetBucketAccelerateResult extends GeneralResult {
  1030. /** 全球加速的具体信息 */
  1031. InventoryConfiguration: AccelerateConfiguration,
  1032. }
  1033. // putBucketEncryption
  1034. /** 默认的服务端加密配置规则 */
  1035. interface EncryptionRule {
  1036. /** 服务端加密的默认配置信息 */
  1037. ApplySideEncryptionConfiguration: {
  1038. /** 要使用的服务端加密算法,枚举值:AES256 */
  1039. SSEAlgorithm: 'AES256'
  1040. },
  1041. }
  1042. /** 包含默认加密的配置参数 */
  1043. interface ServerSideEncryptionConfiguration {
  1044. /** 默认的服务端加密配置规则 */
  1045. Rule: EncryptionRule[],
  1046. }
  1047. /** putBucketEncryption 接口参数 */
  1048. interface PutBucketEncryptionParams extends BucketParams {
  1049. /** 包含默认加密的配置参数 */
  1050. ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration,
  1051. }
  1052. /** putBucketEncryption 接口返回值 */
  1053. interface PutBucketEncryptionResult extends GeneralResult {}
  1054. // getBucketAccelerate
  1055. /** getBucketEncryption 接口参数 */
  1056. interface GetBucketEncryptionParams extends BucketParams {}
  1057. /** getBucketEncryption 接口返回值 */
  1058. interface GetBucketEncryptionResult extends GeneralResult {
  1059. /** 默认加密的配置参数 */
  1060. ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration,
  1061. }
  1062. // deleteBucketEncryption
  1063. /** deleteBucketEncryption 接口参数 */
  1064. interface DeleteBucketEncryptionParams extends BucketParams {}
  1065. /** deleteBucketEncryption 接口返回值 */
  1066. interface DeleteBucketEncryptionResult extends GeneralResult {}
  1067. // headObject
  1068. /** headObject 接口参数 */
  1069. interface HeadObjectParams extends ObjectParams {}
  1070. /** headObject 接口返回值 */
  1071. interface HeadObjectResult extends GeneralResult {
  1072. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  1073. ETag: ETag,
  1074. /** 对象的版本 ID */
  1075. VersionId?: string,
  1076. }
  1077. // getObject
  1078. /** getObject 接口参数 */
  1079. interface GetObjectParams extends ObjectParams {
  1080. BodyType?: 'text' | 'blob' | 'arraybuffer',
  1081. /** 请求里的 Url Query 参数,传入该值中的 key/value 将会被 URLEncode */
  1082. Query?: Query,
  1083. /** 请求里的 Url Query 参数。传入该值将直接拼接在 Url 上,不会对其进行 URLEncode */
  1084. QueryString?: string,
  1085. /** 当对象在指定时间后被修改,则返回对象,否则返回 HTTP 状态码为304(Not Modified) */
  1086. IfModifiedSince?: string,
  1087. /** 当对象在指定时间后未被修改,则返回对象,否则返回 HTTP 状态码为412(Precondition Failed) */
  1088. IfUnmodifiedSince?: string,
  1089. /** 当对象的 ETag 与指定的值一致,则返回对象,否则返回 HTTP 状态码为412(Precondition Failed) */
  1090. IfMatch?: string,
  1091. /** 当对象的 ETag 与指定的值不一致,则返回对象,否则返回 HTTP 状态码为304(Not Modified) */
  1092. IfNoneMatch?: string,
  1093. /** 针对本次下载进行流量控制的限速值,必须为数字,单位默认为 bit/s。限速值设置范围为819200 - 838860800,即100KB/s - 100MB/s,如果超出该范围将返回400错误 */
  1094. TrafficLimit?: number,
  1095. /** 设置响应中的 Cache-Control 头部的值 */
  1096. ResponseCacheControl?: string,
  1097. /** 设置响应中的 Content-Disposition 头部的值 */
  1098. ResponseContentDisposition?: string,
  1099. /** 设置响应中的 Content-Encoding 头部的值 */
  1100. ResponseContentEncoding?: string,
  1101. /** 设置响应中的 Content-Language 头部的值 */
  1102. ResponseContentLanguage?: string,
  1103. /** 设置响应中的 Content-Type 头部的值 */
  1104. ResponseExpires?: string,
  1105. /** 设置响应中的 Expires 头部的值 */
  1106. ResponseContentType?: string,
  1107. /** RFC 2616 中定义的字节范围,范围值必须使用 bytes=first-last 格式,first 和 last 都是基于0开始的偏移量。例如 bytes=0-9 表示下载对象的开头10个字节的数据 ,如果不指定,则表示下载整个对象 */
  1108. Range?: string,
  1109. /** 当启用版本控制时,指定要下载的版本 ID,如不指定则下载对象的最新版本 */
  1110. VersionId?: string,
  1111. /** 下载的进度回调方法 */
  1112. onProgress?: onProgress,
  1113. }
  1114. /** getObject 接口返回值 */
  1115. interface GetObjectResult extends GeneralResult {
  1116. /** 对象内容 */
  1117. Body: string,
  1118. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  1119. ETag: ETag,
  1120. /** 对象的版本 ID */
  1121. VersionId?: string,
  1122. }
  1123. // putObject
  1124. /** putObject 接口参数 */
  1125. interface PutObjectParams extends ObjectParams {
  1126. /** 要上传对象内容 */
  1127. Body: UploadBody,
  1128. /** 上传的文件大小,单位 Byte 字节,如果不传且 Body 是流,会走服务端流式上传 */
  1129. ContentLength?: number,
  1130. /** 请求里的 Url Query 参数 */
  1131. Query?: string,
  1132. /** RFC 2616 中定义的缓存指令,将作为对象元数据保存 */
  1133. CacheControl?: string,
  1134. /** RFC 2616 中定义的文件名称,将作为对象元数据保存 */
  1135. ContentDisposition?: string,
  1136. /** RFC 2616 中定义的编码格式,将作为对象元数据保存 */
  1137. ContentEncoding?: string,
  1138. /** RFC 2616 中定义的 HTTP 请求内容类型(MIME),此头部用于描述待上传对象的内容类型,将作为对象元数据保存。例如text/html或image/jpeg */
  1139. ContentType?: string,
  1140. /** RFC 2616 中定义的缓存失效时间,将作为对象元数据保存 */
  1141. Expires?: string,
  1142. /** RFC 2616 中定义的缓存失效时间,将作为对象元数据保存 */
  1143. Expect?: string,
  1144. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write,可选 */
  1145. ACL?: ObjectACL,
  1146. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1147. GrantRead?: Grant,
  1148. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1149. GrantReadAcp?: Grant,
  1150. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1151. GrantWriteAcp?: Grant,
  1152. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1153. GrantFullControl?: Grant,
  1154. /** 对象存储类型。例如 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING。默认值:STANDARD */
  1155. StorageClass?: StorageClass,
  1156. /** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为对象元数据保存,大小限制为2KB,注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
  1157. 'x-cos-meta-*'?: string,
  1158. /** 任务开始上传的回调方法 */
  1159. onTaskReady?: (TaskId: COS.TaskId) => void,
  1160. /** 上传的进度回调方法 */
  1161. onProgress?: onProgress,
  1162. }
  1163. /** putObject 接口返回值 */
  1164. interface PutObjectResult extends GeneralResult {
  1165. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  1166. ETag: ETag,
  1167. /** 创建的存储桶访问地址,不带 https:// 前缀,例如 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/images/1.jpg */
  1168. Location: string,
  1169. /** 对象的版本 ID */
  1170. VersionId?: VersionId,
  1171. }
  1172. /** appendObject 接口参数 */
  1173. interface AppendObjectParams extends PutObjectParams {
  1174. /** 追加操作的起始点 */
  1175. Position: number;
  1176. }
  1177. // deleteObject
  1178. /** deleteObject 接口参数 */
  1179. interface DeleteObjectParams extends ObjectParams {}
  1180. /** deleteObject 接口返回值 */
  1181. interface DeleteObjectResult extends GeneralResult {}
  1182. // deleteMultipleObject
  1183. /** deleteMultipleObject 接口参数 */
  1184. interface DeleteMultipleObjectParams extends BucketParams {
  1185. /** 要删除的对象列表 */
  1186. Objects: {
  1187. /** 要删除的对象键 */
  1188. Key: Key,
  1189. /** 要删除的对象版本 ID */
  1190. VersionId?: string
  1191. }[]
  1192. }
  1193. /** deleteMultipleObject 接口返回值 */
  1194. interface DeleteMultipleObjectResult extends GeneralResult {
  1195. Deleted: {
  1196. /** 删除成功的对象的对象键 */
  1197. Key: Key,
  1198. /** 删除成功的版本 ID,仅当请求中指定了要删除对象的版本 ID 时才返回该元素 */
  1199. VersionId?: VersionId,
  1200. /** 仅当对该对象的删除创建了一个删除标记,或删除的是该对象的一个删除标记时才返回该元素,布尔值,固定为 true */
  1201. DeleteMarker?: BooleanString,
  1202. /** 仅当对该对象的删除创建了一个删除标记,或删除的是该对象的一个删除标记时才返回该元素,值为创建或删除的删除标记的版本 ID */
  1203. DeleteMarkerVersionId?: VersionId,
  1204. }[],
  1205. Error: {
  1206. /** 删除失败的对象的对象键 */
  1207. Key: Key,
  1208. /** 删除失败的版本 ID,仅当请求中指定了要删除对象的版本 ID 时才返回该元素 */
  1209. VersionId?: string,
  1210. /** 删除失败的错误码,用来定位唯一的错误条件和确定错误场景 */
  1211. Code?: string,
  1212. /** 删除失败的具体错误信息 */
  1213. Message?: string,
  1214. }[],
  1215. }
  1216. // getObjectAcl
  1217. /** getObjectAcl 接口参数 */
  1218. interface GetObjectAclParams extends ObjectParams {}
  1219. /** getObjectAcl 接口返回值 */
  1220. interface GetObjectAclResult extends GeneralResult {
  1221. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write */
  1222. ACL: ObjectACL,
  1223. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  1224. GrantRead: Grant,
  1225. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  1226. GrantReadAcp: Grant,
  1227. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  1228. GrantWriteAcp: Grant,
  1229. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者 */
  1230. GrantFullControl: Grant,
  1231. /** 存储桶持有者信息 */
  1232. Owner: Owner,
  1233. /** 被授权者信息与权限信息 */
  1234. Grants: Grants[],
  1235. }
  1236. // putObjectAcl
  1237. /** putObjectAcl 接口参数 */
  1238. interface PutObjectAclParams extends ObjectParams {
  1239. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write,可选 */
  1240. ACL?: ObjectACL,
  1241. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1242. GrantRead?: Grant,
  1243. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1244. GrantReadAcp?: Grant,
  1245. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1246. GrantWriteAcp?: Grant,
  1247. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1248. GrantFullControl?: Grant,
  1249. }
  1250. /** putObjectAcl 接口返回值 */
  1251. interface PutObjectAclResult extends GeneralResult {}
  1252. // optionsObject
  1253. /** optionsObject 接口参数 */
  1254. interface OptionsObjectParams extends ObjectParams {
  1255. /** 发起 CORS 请求所在的页面域名(Origin) */
  1256. Origin: string,
  1257. /** 发起 CORS 请求所用的方法(Method) */
  1258. AccessControlRequestMethod: Method,
  1259. /** 发起 CORS 请求时使用的 HTTP 请求头部,不区分英文大小写,可使用英文逗号(,)分隔多个头部 */
  1260. AccessControlRequestHeaders: string,
  1261. }
  1262. /** optionsObject 接口返回值 */
  1263. interface OptionsObjectResult extends GeneralResult {
  1264. /** 允许发起 CORS 的域名,可能的值有以下两种:
  1265. *:代表允许所有域名
  1266. 请求头 Origin 中指定的域名:代表允许指定域名 */
  1267. AccessControlAllowOrigin: string,
  1268. /** 允许发起 CORS 请求所使用的方法(Method),可使用英文逗号(,)分隔多个方法 */
  1269. AccessControlAllowMethods: string,
  1270. /** 允许发起 CORS 请求带的 HTTP 头部,不区分英文大小写,可使用英文逗号(,)分隔多个头部 */
  1271. AccessControlAllowHeaders: string,
  1272. /** 允许浏览器获取的 CORS 请求中的 HTTP 响应头部,不区分英文大小写,可使用英文逗号(,)分隔多个头部 */
  1273. AccessControlExposeHeaders: string,
  1274. /** CORS 配置的有效时间,单位为秒,在有效时间内,浏览器无须为同一请求再次发起预检请求 */
  1275. AccessControlMaxAge: string
  1276. }
  1277. // restoreObject
  1278. interface RestoreRequest {
  1279. /** 指定恢复出的临时副本的有效时长,单位为“天” */
  1280. Days: number | string,
  1281. /** 恢复工作参数 */
  1282. CASJobParameters: {
  1283. /** 恢复时,Tier 可以指定为支持的恢复模式。
  1284. 对于恢复归档存储类型数据,有三种恢复模式,分别为:
  1285. Expedited:极速模式,恢复任务在1 - 5分钟内可完成。
  1286. Standard:标准模式,恢复任务在3 - 5小时内完成
  1287. Bulk:批量模式,恢复任务在5 - 12小时内完成。
  1288. 对于恢复深度归档存储类型数据,有两种恢复模式,分别为:
  1289. Standard:标准模式,恢复时间为12 - 24小时。
  1290. Bulk:批量模式,恢复时间为24 - 48小时。 */
  1291. Tier: 'Expedited' | 'Standard' | 'Bulk'
  1292. }
  1293. }
  1294. /** restoreObject 接口参数 */
  1295. interface RestoreObjectParams extends ObjectParams {
  1296. /** 包含 POST Object restore 操作的所有请求信息 */
  1297. RestoreRequest: RestoreRequest,
  1298. /** 当启用版本控制时,指定要恢复的版本 ID,如不指定则恢复对象的最新版本 */
  1299. VersionId?: VersionId,
  1300. }
  1301. /** restoreObject 接口返回值 */
  1302. interface RestoreObjectResult extends GeneralResult {}
  1303. // selectObjectContent
  1304. /** selectObjectContent 接口参数 */
  1305. interface SelectObjectContentParams extends ObjectParams {
  1306. /** 接口的版本信息,当前最新版本是 2 */
  1307. SelectType: number,
  1308. /** 检索参数,当前版本支持检索 JSON、CSV 文件内容 */
  1309. SelectRequest: Record<string, any>,
  1310. /** 当启用版本控制时,指定要检索的版本 ID,如不指定则检索对象的最新版本 */
  1311. VersionId?: VersionId,
  1312. }
  1313. /** selectObjectContent 接口返回值 */
  1314. interface SelectObjectContentResult extends GeneralResult {
  1315. /** 查询过程统计信息 */
  1316. Stats: {
  1317. /** 如果文件是压缩文件,该数值代表文件解压前的字节大小;如果文件不是压缩文件,该数值即文件的字节大小 */
  1318. BytesScanned: number,
  1319. /** 如果文件是压缩文件,该数值代表文件解压后的字节大小;如果文件不是压缩文件,该数值即文件的字节大小 */
  1320. BytesProcessed: number,
  1321. /** COS Select 在本次查询中返回的检索结果字节大小 */
  1322. BytesReturned: number,
  1323. },
  1324. /** 查询的结果内容 */
  1325. Payload?: string,
  1326. }
  1327. // putObjectCopy
  1328. /** putObjectCopy 接口参数 */
  1329. interface PutObjectCopyParams extends ObjectParams {
  1330. /** 源对象的 URL,其中对象键需经过 URLEncode,可以通过 versionId 参数指定源对象的版本,例如: sourcebucket-1250000001.cos.ap-shanghai.myqcloud.com/example-%E8%85%BE%E8%AE%AF%E4%BA%91.jpg 或 sourcebucket-1250000001.cos.ap-shanghai.myqcloud.com/example-%E8%85%BE%E8%AE%AF%E4%BA%91.jpg?versionId=MTg0NDUxNzYzMDc0NDMzNDExOTc */
  1331. CopySource: string,
  1332. /** 是否复制源对象的元数据信息,枚举值:Copy,Replaced,默认为 Copy。如果标记为 Copy,则复制源对象的元数据信息;如果标记为 Replaced,则按本次请求的请求头中的元数据信息作为目标对象的元数据信息;当目标对象和源对象为同一对象时,即用户试图修改元数据时,则标记必须为 Replaced */
  1333. MetadataDirective?: 'Copy' | 'Replaced',
  1334. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write,可选 */
  1335. ACL?: ObjectACL,
  1336. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1337. GrantRead?: Grant,
  1338. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1339. GrantReadAcp?: Grant,
  1340. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1341. GrantWriteAcp?: Grant,
  1342. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1343. GrantFullControl?: Grant,
  1344. /** 当对象在指定时间后被修改,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed) */
  1345. CopySourceIfModifiedSince?: string,
  1346. /** 当对象在指定时间后未被修改,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed) */
  1347. CopySourceIfUnmodifiedSince?: string,
  1348. /** 当对象的 ETag 与指定的值一致,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed) */
  1349. CopySourceIfMatch?: string,
  1350. /** 当对象的 ETag 与指定的值不一致,则执行复制操作,否则返回 HTTP 状态码为412(Precondition Failed) */
  1351. CopySourceIfNoneMatch?: string,
  1352. /** 对象存储类型。例如 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING。默认值:STANDARD */
  1353. StorageClass?: StorageClass,
  1354. /** RFC 2616 中定义的缓存指令,将作为目标对象元数据保存 */
  1355. CacheControl?: string,
  1356. /** RFC 2616 中定义的文件名称,将作为目标对象元数据保存 */
  1357. ContentDisposition?: string,
  1358. /** RFC 2616 中定义的编码格式,将作为目标对象元数据保存 */
  1359. ContentEncoding?: string,
  1360. /** RFC 2616 中定义的 HTTP 请求内容类型(MIME),此头部用于描述目标对象的内容类型,将作为目标对象元数据保存。例如 text/html 或 image/jpeg。 */
  1361. ContentType?: string,
  1362. /** RFC 2616 中定义的缓存失效时间,将作为目标对象元数据保存 */
  1363. Expires?: string,
  1364. /** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为目标对象元数据保存,大小限制为2KB。注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
  1365. 'x-cos-meta-*'?: string
  1366. }
  1367. /** putObjectCopy 接口返回值 */
  1368. interface PutObjectCopyResult extends GeneralResult {}
  1369. // putObjectTagging
  1370. /** putObjectTagging 接口参数 */
  1371. interface PutObjectTaggingParams extends ObjectParams {
  1372. /** 标签集合,最多支持10个标签 */
  1373. Tags: Tag[],
  1374. /** 对象的版本 ID;当未启用版本控制时,该节点的值为空字符串;当启用版本控制时,启用版本控制之前的对象,其版本 ID 为 null;当暂停版本控制时,新上传的对象其版本 ID 为 null,且同一个对象最多只存在一个版本 ID 为 null 的对象版本 */
  1375. VersionId?: VersionId,
  1376. }
  1377. /** putObjectTagging 接口返回值 */
  1378. interface PutObjectTaggingResult extends GeneralResult {}
  1379. // getObjectTagging
  1380. /** getObjectTagging 接口参数 */
  1381. interface GetObjectTaggingParams extends ObjectParams {}
  1382. /** getObjectTagging 接口返回值 */
  1383. interface GetObjectTaggingResult extends GeneralResult {
  1384. /** 标签集合,最多支持10个标签 */
  1385. Tags: Tag[],
  1386. }
  1387. // deleteObjectTagging
  1388. /** deleteObjectTagging 接口参数 */
  1389. interface DeleteObjectTaggingParams extends ObjectParams {}
  1390. /** deleteObjectTagging 接口返回值 */
  1391. interface DeleteObjectTaggingResult extends GeneralResult {}
  1392. // multipartInit
  1393. /** multipartInit 接口参数 */
  1394. interface MultipartInitParams extends ObjectParams {
  1395. /** RFC 2616 中定义的缓存指令,将作为对象元数据保存 */
  1396. CacheControl?: string,
  1397. /** RFC 2616 中定义的文件名称,将作为对象元数据保存 */
  1398. ContentDisposition?: string,
  1399. /** RFC 2616 中定义的编码格式,将作为对象元数据保存 */
  1400. ContentEncoding?: string,
  1401. /** RFC 2616 中定义的 HTTP 请求内容类型(MIME),此头部用于描述待上传对象的内容类型,将作为对象元数据保存。例如text/html或 image/jpeg */
  1402. ContentType?: string,
  1403. /** RFC 2616 中定义的缓存失效时间,将作为对象元数据保存 */
  1404. Expires?: string,
  1405. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write,可选 */
  1406. ACL?: ObjectACL,
  1407. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1408. GrantRead?: Grant,
  1409. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1410. GrantReadAcp?: Grant,
  1411. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1412. GrantWriteAcp?: Grant,
  1413. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1414. GrantFullControl?: Grant,
  1415. /** 请求里的 Url Query 参数 */
  1416. Query?: Query,
  1417. /** 对象存储类型。例如 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING。默认值:STANDARD */
  1418. StorageClass?: StorageClass,
  1419. /** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为对象元数据保存,大小限制为2KB。注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
  1420. 'x-cos-meta-*'?: string,
  1421. }
  1422. /** multipartInit 接口返回值 */
  1423. interface MultipartInitResult extends GeneralResult {
  1424. UploadId: string,
  1425. }
  1426. // multipartUpload
  1427. /** multipartUpload 接口参数 */
  1428. interface MultipartUploadParams extends ObjectParams {
  1429. /** 分块上传的任务 ID */
  1430. UploadId: UploadId,
  1431. /** 标识本次分块上传的编号,范围在1 - 10000 */
  1432. PartNumber: PartNumber,
  1433. /** 要上传分片内容 */
  1434. Body: UploadBody,
  1435. /** 要上传分片内容大小 */
  1436. ContentLength?: number,
  1437. /** 服务端加密算法 */
  1438. ServerSideEncryption?: string,
  1439. }
  1440. /** multipartUpload 接口返回值 */
  1441. interface MultipartUploadResult extends GeneralResult {
  1442. /** 返回对象的 MD5 算法校验值,ETag 的值可以用于检查分块的内容是否发生变化 */
  1443. ETag: ETag
  1444. }
  1445. // uploadPartCopy
  1446. /** uploadPartCopy 接口参数 */
  1447. interface UploadPartCopyParams extends ObjectParams {
  1448. /** 源对象 URL 路径,可以通过 versionid 子资源指定历史版本 */
  1449. CopySource: string,
  1450. /** 分块上传的任务 ID */
  1451. UploadId: UploadId,
  1452. /** 标识本次分块上传的编号,范围在1 - 10000 */
  1453. PartNumber: PartNumber,
  1454. /** 源对象的字节范围,范围值必须使用 bytes=first-last 格式,first 和 last 都是基于 0 开始的偏移量。例如 bytes=0-9 表示您希望拷贝源对象的开头10个字节的数据,如果不指定,则表示拷贝整个对象 */
  1455. CopySourceRange?: string,
  1456. /** 当 Object 在指定时间后被修改,则执行操作,否则返回412,可与 x-cos-copy-source-If-None-Match 一起使用,与其他条件联合使用返回冲突 */
  1457. CopySourceIfModifiedSince?: string,
  1458. /** 当 Object 在指定时间后未被修改,则执行操作,否则返回412,可与 x-cos-copy-source-If-Match 一起使用,与其他条件联合使用返回冲突 */
  1459. CopySourceIfUnmodifiedSince?: string,
  1460. /** 当 Object 的 Etag 和给定一致时,则执行操作,否则返回412,可与 x-cos-copy-source-If-Unmodified-Since 一起使用,与其他条件联合使用返回冲突 */
  1461. CopySourceIfMatch?: string,
  1462. /** 当 Object 的 Etag 和给定不一致时,则执行操作,否则返回412,可与 x-cos-copy-source-If-Modified-Since 一起使用,与其他条件联合使用返回冲突 */
  1463. CopySourceIfNoneMatch?: string,
  1464. }
  1465. /** uploadPartCopy 接口返回值 */
  1466. interface UploadPartCopyResult extends GeneralResult {
  1467. /** 返回对象的 MD5 算法校验值,ETag 的值可以用于检查分块的内容是否发生变化 */
  1468. ETag: ETag
  1469. }
  1470. // multipartComplete
  1471. /** multipartComplete 接口参数 */
  1472. interface MultipartCompleteParams extends ObjectParams {
  1473. /** 分块上传的任务 ID */
  1474. UploadId: UploadId,
  1475. /** 用来说明本次分块上传中每个块的信息 */
  1476. Parts: Part[],
  1477. }
  1478. /** multipartComplete 接口返回值 */
  1479. interface MultipartCompleteResult extends GeneralResult {
  1480. /** 使用 Upload Part 请求上传分块成功后返回的 ETag 响应头部的值 */
  1481. ETag: ETag,
  1482. /** 创建的存储桶访问地址,不带 https:// 前缀,例如 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/images/1.jpg */
  1483. Location: Location,
  1484. /** 对象的版本 ID;当未启用版本控制时,该节点的值为空字符串;当启用版本控制时,启用版本控制之前的对象,其版本 ID 为 null;当暂停版本控制时,新上传的对象其版本 ID 为 null,且同一个对象最多只存在一个版本 ID 为 null 的对象版本 */
  1485. VersionId?: VersionId,
  1486. }
  1487. // multipartList
  1488. /** multipartList 接口参数 */
  1489. interface MultipartListParams extends BucketParams {
  1490. /** 限定返回的 Object key 必须以 Prefix 作为前缀。注意使用 prefix 查询时,返回的 key 中仍会包含 Prefix。 */
  1491. Prefix: Prefix,
  1492. /** 一个字符的分隔符,常用 / 字符,用于对对象键进行分组。所有对象键中从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分将作为 CommonPrefixes 下的一个 Prefix 节点。被分组的对象键不再出现在后续对象列表中 */
  1493. Delimiter: Delimiter
  1494. /** 设置最大返回的 multipart 数量,合法取值从1到1000,默认1000 */
  1495. MaxUploads?: number,
  1496. /** 与 upload-id-marker 一起使用:当 upload-id-marker 未被指定时,ObjectName 字母顺序大于 key-marker 的条目将被列出。当 upload-id-marker 被指定时,ObjectName 字母顺序大于 key-marker 的条目被列出,ObjectName 字母顺序等于 key-marker 同时 UploadId 大于 upload-id-marker 的条目将被列出。 */
  1497. KeyMarker?: Key,
  1498. /** 与 key-marker 一起使用:当 key-marker 未被指定时,upload-id-marker 将被忽略。当 key-marker 被指定时,ObjectName字母顺序大于 key-marker 的条目被列出,ObjectName 字母顺序等于 key-marker 同时 UploadId 大于 upload-id-marker 的条目将被列出。 */
  1499. UploadIdMarker?: UploadId,
  1500. /** 规定返回值的编码方式,可选值:url,代表返回的对象键为 URL 编码(百分号编码)后的值,例如“腾讯云”将被编码为%E8%85%BE%E8%AE%AF%E4%BA%91 */
  1501. EncodingType?: EncodingType,
  1502. }
  1503. /** multipartList 接口返回值 */
  1504. interface MultipartListResult extends GeneralResult {
  1505. /** 每个上传任务的信息 */
  1506. Upload: {
  1507. /** 对象键 */
  1508. Key: Key,
  1509. /** 分块上传的任务 ID */
  1510. UploadId: UploadId,
  1511. /** 上传任务发起者的信息 */
  1512. Initiator: Initiator,
  1513. /** 上传任务所有者的信息 */
  1514. Owner: Owner,
  1515. /** 对象存储类型。枚举值 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING @see https://cloud.tencent.com/document/product/436/33417 */
  1516. StorageClass: StorageClass,
  1517. /** UploadId 的创建时间,为 ISO8601 格式,例如2019-05-24T10:56:40Z */
  1518. Initiated: IsoDateTime
  1519. }[],
  1520. /** 仅当响应条目有截断(IsTruncated 为 true)才会返回该节点,该节点的值为当前响应条目中的最后一个对象键,当需要继续请求后续条目时,将该节点的值作为下一次请求的 marker 参数传入 */
  1521. IsTruncated: BooleanString,
  1522. /** 假如返回条目被截断,则返回的 NextKeyMarker 就是下一个条目的起点。 */
  1523. NextKeyMarker: Key,
  1524. /** 假如返回条目被截断,则返回的 UploadId 就是下一个条目的起点。 */
  1525. NextUploadIdMarker: UploadId,
  1526. }
  1527. // multipartListPart
  1528. /** multipartListPart 接口参数 */
  1529. interface MultipartListPartParams extends ObjectParams {
  1530. /** 请求的对象键,最前面不带 /,例如 images/1.jpg */
  1531. Key: Key,
  1532. /** 标识本次分块上传的 ID,使用 Initiate Multipart Upload 接口初始化分块上传时得到的 UploadId */
  1533. UploadId: UploadId,
  1534. /** 单次返回最大的条目数量,默认1000 */
  1535. MaxParts?: number,
  1536. /** 默认以 UTF-8 二进制顺序列出条目,所有列出条目从 marker 开始 */
  1537. PartNumberMarker?: string,
  1538. /** 规定返回值的编码方式,可选值:url,代表返回的对象键为 URL 编码(百分号编码)后的值,例如“腾讯云”将被编码为%E8%85%BE%E8%AE%AF%E4%BA%91 */
  1539. EncodingType?: EncodingType,
  1540. }
  1541. /** multipartListPart 接口返回值 */
  1542. interface MultipartListPartResult extends GeneralResult {
  1543. /** 用来说明本次分块上传中每个块的信息 */
  1544. Part: {
  1545. /** 块的编号 */
  1546. PartNumber: PartNumber,
  1547. /** 说明块最后被修改时间 */
  1548. LastModified: IsoDateTime,
  1549. /** 块的 MD5 算法校验值 */
  1550. ETag: ETag,
  1551. /** 说明块大小,单位是 Byte */
  1552. Size: number,
  1553. }[],
  1554. /** 上传任务所有者的信息 */
  1555. Owner: Owner,
  1556. /** 上传任务发起者的信息 */
  1557. Initiator: Initiator
  1558. /** 假如返回条目被截断,则返回 NextMarker 就是下一个条目的起点 */
  1559. NextPartNumberMarker: number,
  1560. /** 对象存储类型。枚举值 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING @see https://cloud.tencent.com/document/product/436/33417 */
  1561. StorageClass: StorageClass,
  1562. /** 仅当响应条目有截断(IsTruncated 为 true)才会返回该节点,该节点的值为当前响应条目中的最后一个对象键,当需要继续请求后续条目时,将该节点的值作为下一次请求的 marker 参数传入 */
  1563. IsTruncated: BooleanString,
  1564. }
  1565. // multipartAbort
  1566. /** multipartAbort 接口参数 */
  1567. interface MultipartAbortParams extends ObjectParams {
  1568. UploadId: string,
  1569. }
  1570. /** multipartAbort 接口返回值 */
  1571. interface MultipartAbortResult extends GeneralResult {}
  1572. // sliceUploadFile
  1573. /** sliceUploadFile 接口参数 */
  1574. interface SliceUploadFileParams extends ObjectParams {
  1575. /** 要上传的本地文件对象 */
  1576. Body: File | Blob,
  1577. /** 分块上传时,每片的字节数大小,默认值1048576(1MB) */
  1578. ChunkSize?: number,
  1579. /** 请求里的 Url Query 参数 */
  1580. Query?: string,
  1581. /** RFC 2616 中定义的缓存指令,将作为对象元数据保存 */
  1582. CacheControl?: string,
  1583. /** RFC 2616 中定义的文件名称,将作为对象元数据保存 */
  1584. ContentDisposition?: string,
  1585. /** RFC 2616 中定义的编码格式,将作为对象元数据保存 */
  1586. ContentEncoding?: string,
  1587. /** RFC 2616 中定义的 HTTP 请求内容类型(MIME),此头部用于描述待上传对象的内容类型,将作为对象元数据保存。例如text/html或image/jpeg */
  1588. ContentType?: string,
  1589. /** RFC 2616 中定义的缓存失效时间,将作为对象元数据保存 */
  1590. Expires?: string,
  1591. /** RFC 2616 中定义的缓存失效时间,将作为对象元数据保存 */
  1592. Expect?: string,
  1593. /** 允许用户自定义存储桶权限,有效值:private | public-read | public-read-write,可选 */
  1594. ACL?: ObjectACL,
  1595. /** 赋予被授权者读取对象的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1596. GrantRead?: Grant,
  1597. /** 赋予被授权者读取对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1598. GrantReadAcp?: Grant,
  1599. /** 赋予被授权者写入对象的访问控制列表(ACL)的权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1600. GrantWriteAcp?: Grant,
  1601. /** 赋予被授权者操作对象的所有权限,格式:id="[OwnerUin]",可使用半角逗号(,)分隔多组被授权者,可选 */
  1602. GrantFullControl?: Grant,
  1603. /** 对象存储类型。枚举值 STANDARD | STANDARD_IA | ARCHIVE | DEEP_ARCHIVE | INTELLIGENT_TIERING | MAZ_STANDARD | MAZ_STANDARD_IA | MAZ_INTELLIGENT_TIERING @see https://cloud.tencent.com/document/product/436/33417 */
  1604. StorageClass?: StorageClass,
  1605. /** 包括用户自定义元数据头部后缀和用户自定义元数据信息,将作为对象元数据保存,大小限制为2KB,注意:用户自定义元数据信息支持下划线(_),但用户自定义元数据头部后缀不支持下划线,仅支持减号(-) */
  1606. 'x-cos-meta-*'?: string,
  1607. /** 任务开始上传的回调方法 */
  1608. onTaskReady?: (TaskId: COS.TaskId) => void,
  1609. /** 上传的进度回调方法 */
  1610. onProgress?: onProgress,
  1611. /** 续传校验的进度回调方法 */
  1612. onHashProgress?: onProgress,
  1613. }
  1614. /** sliceUploadFile 接口返回值 */
  1615. interface SliceUploadFileResult extends GeneralResult {
  1616. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  1617. ETag: ETag,
  1618. /** 创建的存储桶访问地址,不带 https:// 前缀,例如 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/images/1.jpg */
  1619. Location: string,
  1620. /** 对象的版本 ID */
  1621. VersionId?: VersionId,
  1622. }
  1623. // abortUploadTask
  1624. /** abortUploadTask 接口参数 */
  1625. interface AbortUploadTaskParams extends ObjectParams {
  1626. /** 清理上传任务的级别,枚举值 'task' | 'file' | 'bucket',默认 task */
  1627. Level?: 'task' | 'file' | 'bucket',
  1628. /** 要清理的 UploadId,Level 为 task 时必选 */
  1629. UploadId?: UploadId,
  1630. }
  1631. /** abortUploadTask 接口返回值 */
  1632. interface AbortUploadTaskResult extends GeneralResult {}
  1633. // uploadFiles
  1634. type UploadFileItemParams = (PutObjectParams | SliceUploadFileParams) & {
  1635. /** 要上传的本地文件路径 */
  1636. Body: UploadBody,
  1637. /** 上传的进度回调方法 */
  1638. onProgress?: onProgress,
  1639. /** 上传完成回调方法 */
  1640. onFileFinish?: (err: Error, data?: Record<string, any>) => void,
  1641. }
  1642. /** 要上传的单个文件参数 */
  1643. interface UploadFileItemResult extends GeneralResult {
  1644. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  1645. ETag: ETag,
  1646. /** 创建的存储桶访问地址,不带 https:// 前缀,例如 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/images/1.jpg */
  1647. Location: string,
  1648. /** 对象的版本 ID */
  1649. VersionId?: VersionId,
  1650. }
  1651. interface UploadFilesParams {
  1652. /** 要上传的文件参数列表 */
  1653. files: UploadFileItemParams[],
  1654. /** 使用 uploadFiles 批量上传时,文件大小大于该数值将使用按分块上传,否则将调用简单上传,单位 Byte,默认值1048576(1MB) */
  1655. SliceSize?: number,
  1656. /** 所有文件整体上传进度回调方法 */
  1657. onProgress?: onProgress,
  1658. /** 所有文件上传完成回调方法 */
  1659. onFileFinish?: (err: CosError, data?: Record<string, any>) => void,
  1660. }
  1661. /** uploadFiles 接口返回值 */
  1662. interface UploadFilesResult extends GeneralResult {
  1663. /** 文件列表上传结果 */
  1664. files: {
  1665. /** 单个文件上传参数 */
  1666. options: UploadFileItemParams,
  1667. /** 单个文件上传错误信息 */
  1668. error: Error,
  1669. /** 单个文件上传成功信息 */
  1670. data: UploadFileItemResult,
  1671. }[],
  1672. }
  1673. // uploadFile 高级上传
  1674. interface FileFinishInfo {
  1675. err: Error;
  1676. data: UploadFileItemResult;
  1677. options: UploadFileItemParams;
  1678. }
  1679. type onFileFinish = (err: Error, data: UploadFileItemResult, options: UploadFileItemParams) => void;
  1680. type UploadFileParams = (PutObjectParams | SliceUploadFileParams) & {
  1681. /** 要上传的本地文件路径 */
  1682. Body: UploadBody,
  1683. /** 使用 uploadFile 高级上传时,文件大小大于该数值将使用按分块上传,否则将调用简单上传,单位 Byte,默认值1048576(1MB) */
  1684. SliceSize?: number,
  1685. /** 上传的进度回调方法 */
  1686. onProgress?: onProgress,
  1687. /** 上传完成回调方法 */
  1688. onFileFinish?: onFileFinish,
  1689. };
  1690. /** uploadFiles 接口返回值 */
  1691. interface UploadFileResult extends GeneralResult {
  1692. /** 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化,例如"8e0b617ca298a564c3331da28dcb50df"。此头部并不一定返回对象的 MD5 值,而是根据对象上传和加密方式而有所不同 */
  1693. ETag: ETag,
  1694. /** 创建的存储桶访问地址,不带 https:// 前缀,例如 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/images/1.jpg */
  1695. Location: string,
  1696. /** 对象的版本 ID */
  1697. VersionId?: VersionId,
  1698. }
  1699. // sliceCopyFile
  1700. /** sliceCopyFile 接口参数 */
  1701. interface SliceCopyFileParams extends ObjectParams {
  1702. /** 源对象的 URL,其中对象键需经过 URLEncode,可以通过 versionId 参数指定源对象的版本,例如: sourcebucket-1250000001.cos.ap-shanghai.myqcloud.com/example-%E8%85%BE%E8%AE%AF%E4%BA%91.jpg 或 sourcebucket-1250000001.cos.ap-shanghai.myqcloud.com/example-%E8%85%BE%E8%AE%AF%E4%BA%91.jpg?versionId=MTg0NDUxNzYzMDc0NDMzNDExOTc */
  1703. CopySource: string,
  1704. /** 使用 sliceCopyFile 分块复制文件时,文件大小大于该数值将使用分块复制 ,否则将调用简单复制,默认值10485760(10MB) */
  1705. CopySliceSize?: number,
  1706. /** 使用 sliceCopyFile 分块复制文件时,每片的大小字节数,默认值10485760(10MB) */
  1707. CopyChunkSize?: number,
  1708. /** 分片复制进度回调方法 */
  1709. onProgress: onProgress
  1710. }
  1711. /** sliceCopyFile 接口返回值 */
  1712. interface SliceCopyFileResult extends GeneralResult {}
  1713. // getTaskList
  1714. type TaskId = string
  1715. type Task = {
  1716. /** 上传任务 ID */
  1717. id: TaskId,
  1718. /** 存储桶的名称,格式为<bucketname-appid>,例如examplebucket-1250000000 */
  1719. Bucket: Bucket,
  1720. /** 存储桶所在地域 @see https://cloud.tencent.com/document/product/436/6224 */
  1721. Region: Region,
  1722. /** 请求的对象键,最前面不带 /,例如 images/1.jpg */
  1723. Key: Key,
  1724. /** 上传状态 */
  1725. state: 'waiting' | 'checking' | 'uploading' | 'error' | 'paused' | 'success' | 'canceled',
  1726. /** 上传错误信息 */
  1727. error: string | Error | { Code: string, Message: string },
  1728. /** 已上传内容大小,单位 B(字节) */
  1729. loaded: number,
  1730. /** 上传文件大小,单位 B(字节) */
  1731. size: number,
  1732. /** 上传速递,单位 B/s */
  1733. speed: number,
  1734. /** 上传进度,范围 0-1,保留两位小数 */
  1735. percent: number,
  1736. /** 续传校验进度,范围 0-1,保留两位小数 */
  1737. hashPercent: number,
  1738. }
  1739. /** 上传任务列表 */
  1740. type TaskList = Task[]
  1741. // request
  1742. /** request 接口参数 */
  1743. interface RequestParams extends BucketParams {
  1744. /** 操作方法,如 get,post,delete, head 等 HTTP 方法 */
  1745. Method: string,
  1746. /** 请求的对象键,最前面不带 / */
  1747. Key?: Key,
  1748. /** 请求里的 Url Query 参数 */
  1749. Query?: Query,
  1750. /** 请求里的 Body 参数 */
  1751. Body?: Body,
  1752. /** 请求的 API 动作接口(可理解为不带 = 的 Query 参数),如 acl、tagging、image_process 等 */
  1753. Action: Action
  1754. }
  1755. /** Request 接口返回值 */
  1756. interface RequestResult extends GeneralResult {
  1757. Body?: Buffer,
  1758. }
  1759. // getObjectUrl
  1760. /** getObjectUrl 接口参数 */
  1761. interface GetObjectUrlParams extends ObjectParams {
  1762. /** 获取的 Url 是否计算签名 */
  1763. Sign?: boolean,
  1764. /** 请求方法 */
  1765. Method?: Method,
  1766. /** 请求里的 Url Query 参数,传入该值中的 key/value 将会被 URLEncode */
  1767. Query?: Query,
  1768. /** 请求里的 Url Query 参数。传入该值将直接拼接在 Url 上,不会对其进行 URLEncode */
  1769. QueryString?: string,
  1770. /** 签名几秒后失效,默认为900秒 */
  1771. Expires?: number,
  1772. }
  1773. // request
  1774. /** request 接口参数 */
  1775. interface RequestParams extends BucketParams {
  1776. /** 操作方法,如 get,post,delete, head 等 HTTP 方法 */
  1777. Method: string,
  1778. /** 请求的对象键,最前面不带 / */
  1779. Key?: Key,
  1780. /** 请求里的 Url Query 参数 */
  1781. Query?: Query,
  1782. /** 请求里的 Body 参数 */
  1783. Body?: Body | string,
  1784. /** 请求的 API 动作接口(可理解为不带 = 的 Query 参数),如 acl、tagging、image_process 等 */
  1785. Action?: Action,
  1786. /** 请求url */
  1787. Url?: string,
  1788. /** 返回值body是否不需要解析 */
  1789. RawBody?: boolean,
  1790. }
  1791. /** Request 接口返回值 */
  1792. interface RequestResult extends GeneralResult {
  1793. Body?: Buffer,
  1794. }
  1795. /** getObjectUrl 接口返回值 */
  1796. interface GetObjectUrlResult {
  1797. /** 返回对象 Url */
  1798. Url: string
  1799. }
  1800. // getV4Auth
  1801. interface GetV4AuthParams {
  1802. /** 计算签名用的密钥 SecretId,如果不传会用实例本身的凭证,可选 */
  1803. SecretId?: string,
  1804. /** 计算签名用的密钥 SecretKey,如果不传会用实例本身的凭证,可选 */
  1805. SecretKey?: string,
  1806. /** 存储桶的名称,命名规则为 BucketName-APPID,例如 examplebucket-1250000000 */
  1807. Bucket?: Bucket,
  1808. /** 请求的对象键,最前面不带 /,例如 images/1.jpg */
  1809. Key?: Key,
  1810. /** 签名几秒后失效,默认为900秒 */
  1811. Expires?: number,
  1812. }
  1813. // getAuth
  1814. interface GetAuthParams {
  1815. /** 计算签名用的密钥 SecretId,如果不传会用实例本身的凭证,可选 */
  1816. SecretId?: string,
  1817. /** 计算签名用的密钥 SecretKey,如果不传会用实例本身的凭证,可选 */
  1818. SecretKey?: string,
  1819. /** 请求方法 */
  1820. Method?: Method,
  1821. /** 请求的对象键,最前面不带 /,例如 images/1.jpg */
  1822. Key?: Key,
  1823. /** 签名几秒后失效,默认为900秒 */
  1824. Expires?: number,
  1825. /** 请求里的 Url Query 参数 */
  1826. Query?: Query,
  1827. /** 请求里的 Header 参数 */
  1828. Headers?: Headers,
  1829. }
  1830. }
  1831. /**
  1832. * COS 类,创建该类的实例可用于调用 COS API
  1833. * @see https://cloud.tencent.com/document/product/436/7751
  1834. */
  1835. declare class COS {
  1836. // 构造方法
  1837. constructor(options: COS.COSOptions);
  1838. // 静态属性
  1839. /** 当前 SDK 版本号 */
  1840. static version: string;
  1841. // 静态方法
  1842. /** 计算签名 */
  1843. static getAuthorization: (options: COS.StaticGetAuthorizationOptions) => string;
  1844. /** 工具 */
  1845. static util: COS.Util;
  1846. // 实例方法
  1847. /** 获取用户的 bucket 列表 @see https://cloud.tencent.com/document/product/436/8291 */
  1848. getService(params: COS.GetServiceParams, callback: (err: COS.CosError, data: COS.GetServiceResult) => void): void;
  1849. getService(params: COS.GetServiceParams): Promise<COS.GetServiceResult>;
  1850. /** 创建 Bucket,并初始化访问权限 @see https://cloud.tencent.com/document/product/436/7738 */
  1851. putBucket(params: COS.PutBucketParams, callback: (err: COS.CosError, data: COS.PutBucketResult) => void): void;
  1852. putBucket(params: COS.PutBucketParams): Promise<COS.PutBucketResult>;
  1853. /** 查看是否存在该 Bucket,是否有权限访问 @see https://cloud.tencent.com/document/product/436/7735 */
  1854. headBucket(params: COS.HeadBucketParams, callback: (err: COS.CosError, data: COS.HeadBucketResult) => void): void;
  1855. headBucket(params: COS.HeadBucketParams): Promise<COS.HeadBucketResult>;
  1856. /** 获取 Bucket 下的 Object 列表 @see https://cloud.tencent.com/document/product/436/7734 */
  1857. getBucket(params: COS.GetBucketParams, callback: (err: COS.CosError, data: COS.GetBucketResult) => void): void;
  1858. getBucket(params: COS.GetBucketParams): Promise<COS.GetBucketResult>;
  1859. /** 获取 Bucket 下的 Object 版本列表 @see https://cloud.tencent.com/document/product/436/35521 */
  1860. listObjectVersions(params: COS.ListObjectVersionsParams, callback: (err: COS.CosError, data: COS.ListObjectVersionsResult) => void): void;
  1861. listObjectVersions(params: COS.ListObjectVersionsParams): Promise<COS.ListObjectVersionsResult>;
  1862. /** 删除 Bucket @see https://cloud.tencent.com/document/product/436/7732 */
  1863. deleteBucket(params: COS.DeleteBucketParams, callback: (err: COS.CosError, data: COS.DeleteBucketResult) => void): void;
  1864. deleteBucket(params: COS.DeleteBucketParams): Promise<COS.DeleteBucketResult>;
  1865. /** 设置 Bucket 的 权限列表 @see https://cloud.tencent.com/document/product/436/7737 */
  1866. putBucketAcl(params: COS.PutBucketAclParams, callback: (err: COS.CosError, data: COS.PutBucketAclResult) => void): void;
  1867. putBucketAcl(params: COS.PutBucketAclParams): Promise<COS.PutBucketAclResult>;
  1868. /** 获取 Bucket 的 权限列表 @see https://cloud.tencent.com/document/product/436/7733 */
  1869. getBucketAcl(params: COS.GetBucketAclParams, callback: (err: COS.CosError, data: COS.GetBucketAclResult) => void): void;
  1870. getBucketAcl(params: COS.GetBucketAclParams): Promise<COS.GetBucketAclResult>;
  1871. /** 设置 Bucket 的 跨域设置 @see https://cloud.tencent.com/document/product/436/8279 */
  1872. putBucketCors(params: COS.PutBucketCorsParams, callback: (err: COS.CosError, data: COS.PutBucketCorsResult) => void): void;
  1873. putBucketCors(params: COS.PutBucketCorsParams): Promise<COS.PutBucketCorsResult>;
  1874. /** 获取 Bucket 的 跨域设置 @see https://cloud.tencent.com/document/product/436/8274 */
  1875. getBucketCors(params: COS.GetBucketCorsParams, callback: (err: COS.CosError, data: COS.GetBucketCorsResult) => void): void;
  1876. getBucketCors(params: COS.GetBucketCorsParams): Promise<COS.GetBucketCorsResult>;
  1877. /** 删除 Bucket 的 跨域设置 @see https://cloud.tencent.com/document/product/436/8283 */
  1878. deleteBucketCors(params: COS.DeleteBucketCorsParams, callback: (err: COS.CosError, data: COS.DeleteBucketCorsResult) => void): void;
  1879. deleteBucketCors(params: COS.DeleteBucketCorsParams): Promise<COS.DeleteBucketCorsResult>;
  1880. /** 获取 Bucket 的 地域信息 */
  1881. getBucketLocation(params: COS.GetBucketLocationParams, callback: (err: COS.CosError, data: COS.GetBucketLocationResult) => void): void;
  1882. getBucketLocation(params: COS.GetBucketLocationParams): Promise<COS.GetBucketLocationResult>;
  1883. /** 获取 Bucket 的读取权限策略 @see https://cloud.tencent.com/document/product/436/8282 */
  1884. putBucketPolicy(params: COS.PutBucketPolicyParams, callback: (err: COS.CosError, data: COS.PutBucketPolicyResult) => void): void;
  1885. putBucketPolicy(params: COS.PutBucketPolicyParams): Promise<COS.PutBucketPolicyResult>;
  1886. /** 获取 Bucket 的读取权限策略 @see https://cloud.tencent.com/document/product/436/8276 */
  1887. getBucketPolicy(params: COS.GetBucketPolicyParams, callback: (err: COS.CosError, data: COS.GetBucketPolicyResult) => void): void;
  1888. getBucketPolicy(params: COS.GetBucketPolicyParams): Promise<COS.GetBucketPolicyResult>;
  1889. /** 删除 Bucket 的 跨域设置 @see https://cloud.tencent.com/document/product/436/8285 */
  1890. deleteBucketPolicy(params: COS.DeleteBucketPolicyParams, callback: (err: COS.CosError, data: COS.DeleteBucketPolicyResult) => void): void;
  1891. deleteBucketPolicy(params: COS.DeleteBucketPolicyParams): Promise<COS.DeleteBucketPolicyResult>;
  1892. /** 设置 Bucket 的标签 @see https://cloud.tencent.com/document/product/436/34838 */
  1893. putBucketTagging(params: COS.PutBucketTaggingParams, callback: (err: COS.CosError, data: COS.PutBucketTaggingResult) => void): void;
  1894. putBucketTagging(params: COS.PutBucketTaggingParams): Promise<COS.PutBucketTaggingResult>;
  1895. /** 获取 Bucket 的标签设置 @see https://cloud.tencent.com/document/product/436/34837 */
  1896. getBucketTagging(params: COS.GetBucketTaggingParams, callback: (err: COS.CosError, data: COS.GetBucketTaggingResult) => void): void;
  1897. getBucketTagging(params: COS.GetBucketTaggingParams): Promise<COS.GetBucketTaggingResult>;
  1898. /** 删除 Bucket 的 标签设置 @see https://cloud.tencent.com/document/product/436/34836 */
  1899. deleteBucketTagging(params: COS.DeleteBucketTaggingParams, callback: (err: COS.CosError, data: COS.DeleteBucketTaggingResult) => void): void;
  1900. deleteBucketTagging(params: COS.DeleteBucketTaggingParams): Promise<COS.DeleteBucketTaggingResult>;
  1901. /** 设置 Bucket 生命周期 @see https://cloud.tencent.com/document/product/436/8280 */
  1902. putBucketLifecycle(params: COS.PutBucketLifecycleParams, callback: (err: COS.CosError, data: COS.PutBucketLifecycleResult) => void): void;
  1903. putBucketLifecycle(params: COS.PutBucketLifecycleParams): Promise<COS.PutBucketLifecycleResult>;
  1904. /** 获取 Bucket 生命周期 @see https://cloud.tencent.com/document/product/436/8280 */
  1905. getBucketLifecycle(params: COS.GetBucketLifecycleParams, callback: (err: COS.CosError, data: COS.GetBucketLifecycleResult) => void): void;
  1906. getBucketLifecycle(params: COS.GetBucketLifecycleParams): Promise<COS.GetBucketLifecycleResult>;
  1907. /** 删除 Bucket 生命周期 @see https://cloud.tencent.com/document/product/436/8278 */
  1908. deleteBucketLifecycle(params: COS.DeleteBucketLifecycleParams, callback: (err: COS.CosError, data: COS.DeleteBucketLifecycleResult) => void): void;
  1909. deleteBucketLifecycle(params: COS.DeleteBucketLifecycleParams): Promise<COS.DeleteBucketLifecycleResult>;
  1910. /** 设置 Bucket 版本 @see https://cloud.tencent.com/document/product/436/19889 */
  1911. putBucketVersioning(params: COS.PutBucketVersioningParams, callback: (err: COS.CosError, data: COS.PutBucketVersioningResult) => void): void;
  1912. putBucketVersioning(params: COS.PutBucketVersioningParams): Promise<COS.PutBucketVersioningResult>;
  1913. /** 获取 Bucket 版本 @see https://cloud.tencent.com/document/product/436/19888 */
  1914. getBucketVersioning(params: COS.GetBucketVersioningParams, callback: (err: COS.CosError, data: COS.GetBucketVersioningResult) => void): void;
  1915. getBucketVersioning(params: COS.GetBucketVersioningParams): Promise<COS.GetBucketVersioningResult>;
  1916. /** 设置 Bucket 副本 @see https://cloud.tencent.com/document/product/436/19223 */
  1917. putBucketReplication(params: COS.PutBucketReplicationParams, callback: (err: COS.CosError, data: COS.PutBucketReplicationResult) => void): void;
  1918. putBucketReplication(params: COS.PutBucketReplicationParams): Promise<COS.PutBucketReplicationResult>;
  1919. /** 获取 Bucket 副本 @see https://cloud.tencent.com/document/product/436/19222 */
  1920. getBucketReplication(params: COS.GetBucketReplicationParams, callback: (err: COS.CosError, data: COS.GetBucketReplicationResult) => void): void;
  1921. getBucketReplication(params: COS.GetBucketReplicationParams): Promise<COS.GetBucketReplicationResult>;
  1922. /** 删除 Bucket 副本 @see https://cloud.tencent.com/document/product/436/19221 */
  1923. deleteBucketReplication(params: COS.DeleteBucketReplicationParams, callback: (err: COS.CosError, data: COS.DeleteBucketReplicationResult) => void): void;
  1924. deleteBucketReplication(params: COS.DeleteBucketReplicationParams): Promise<COS.DeleteBucketReplicationResult>;
  1925. /** 设置 Bucket 静态网站配置信息 @see https://cloud.tencent.com/document/product/436/31930 */
  1926. putBucketWebsite(params: COS.PutBucketWebsiteParams, callback: (err: COS.CosError, data: COS.PutBucketWebsiteResult) => void): void;
  1927. putBucketWebsite(params: COS.PutBucketWebsiteParams): Promise<COS.PutBucketWebsiteResult>;
  1928. /** 获取 Bucket 的静态网站配置信息 @see https://cloud.tencent.com/document/product/436/31929 */
  1929. getBucketWebsite(params: COS.GetBucketWebsiteParams, callback: (err: COS.CosError, data: COS.GetBucketWebsiteResult) => void): void;
  1930. getBucketWebsite(params: COS.GetBucketWebsiteParams): Promise<COS.GetBucketWebsiteResult>;
  1931. /** 删除 Bucket 的静态网站配置 @see https://cloud.tencent.com/document/product/436/31928 */
  1932. deleteBucketWebsite(params: COS.DeleteBucketWebsiteParams, callback: (err: COS.CosError, data: COS.DeleteBucketWebsiteResult) => void): void;
  1933. deleteBucketWebsite(params: COS.DeleteBucketWebsiteParams): Promise<COS.DeleteBucketWebsiteResult>;
  1934. /** 设置 Bucket 的防盗链白名单或者黑名单 @see https://cloud.tencent.com/document/product/436/32492 */
  1935. putBucketReferer(params: COS.PutBucketRefererParams, callback: (err: COS.CosError, data: COS.PutBucketRefererResult) => void): void;
  1936. putBucketReferer(params: COS.PutBucketRefererParams): Promise<COS.PutBucketRefererResult>;
  1937. /** 获取 Bucket 的防盗链白名单或者黑名单 @see https://cloud.tencent.com/document/product/436/32493 */
  1938. getBucketReferer(params: COS.GetBucketRefererParams, callback: (err: COS.CosError, data: COS.GetBucketRefererResult) => void): void;
  1939. getBucketReferer(params: COS.GetBucketRefererParams): Promise<COS.GetBucketRefererResult>;
  1940. /** 设置 Bucket 自定义域名 */
  1941. putBucketDomain(params: COS.PutBucketDomainParams, callback: (err: COS.CosError, data: COS.PutBucketDomainResult) => void): void;
  1942. putBucketDomain(params: COS.PutBucketDomainParams): Promise<COS.PutBucketDomainResult>;
  1943. /** 获取 Bucket 的自定义域名 */
  1944. getBucketDomain(params: COS.GetBucketDomainParams, callback: (err: COS.CosError, data: COS.GetBucketDomainResult) => void): void;
  1945. getBucketDomain(params: COS.GetBucketDomainParams): Promise<COS.GetBucketDomainResult>;
  1946. /** 删除 Bucket 自定义域名 */
  1947. deleteBucketDomain(params: COS.DeleteBucketDomainParams, callback: (err: COS.CosError, data: COS.DeleteBucketDomainResult) => void): void;
  1948. deleteBucketDomain(params: COS.DeleteBucketDomainParams): Promise<COS.DeleteBucketDomainResult>;
  1949. /** 设置 Bucket 的回源 */
  1950. putBucketOrigin(params: COS.PutBucketOriginParams, callback: (err: COS.CosError, data: COS.PutBucketOriginResult) => void): void;
  1951. putBucketOrigin(params: COS.PutBucketOriginParams): Promise<COS.PutBucketOriginResult>;
  1952. /** 获取 Bucket 的回源 */
  1953. getBucketOrigin(params: COS.GetBucketOriginParams, callback: (err: COS.CosError, data: COS.GetBucketOriginResult) => void): void;
  1954. getBucketOrigin(params: COS.GetBucketOriginParams): Promise<COS.GetBucketOriginResult>;
  1955. /** 删除 Bucket 的回源 */
  1956. deleteBucketOrigin(params: COS.DeleteBucketOriginParams, callback: (err: COS.CosError, data: COS.DeleteBucketOriginResult) => void): void;
  1957. deleteBucketOrigin(params: COS.DeleteBucketOriginParams): Promise<COS.DeleteBucketOriginResult>;
  1958. /** 设置 Bucket 的日志记录 @see https://cloud.tencent.com/document/product/436/17054 */
  1959. putBucketLogging(params: COS.PutBucketLoggingParams, callback: (err: COS.CosError, data: COS.PutBucketLoggingResult) => void): void;
  1960. putBucketLogging(params: COS.PutBucketLoggingParams): Promise<COS.PutBucketLoggingResult>;
  1961. /** 获取 Bucket 的日志记录 @see https://cloud.tencent.com/document/product/436/17053 */
  1962. getBucketLogging(params: COS.GetBucketLoggingParams, callback: (err: COS.CosError, data: COS.GetBucketLoggingResult) => void): void;
  1963. getBucketLogging(params: COS.GetBucketLoggingParams): Promise<COS.GetBucketLoggingResult>;
  1964. /** 创建/编辑 Bucket 的清单任务 @see https://cloud.tencent.com/document/product/436/33707 */
  1965. putBucketInventory(params: COS.PutBucketInventoryParams, callback: (err: COS.CosError, data: COS.PutBucketInventoryResult) => void): void;
  1966. putBucketInventory(params: COS.PutBucketInventoryParams): Promise<COS.PutBucketInventoryResult>;
  1967. /** 获取 Bucket 的清单任务信息 @see https://cloud.tencent.com/document/product/436/33705 */
  1968. getBucketInventory(params: COS.GetBucketInventoryParams, callback: (err: COS.CosError, data: COS.GetBucketInventoryResult) => void): void;
  1969. getBucketInventory(params: COS.GetBucketInventoryParams): Promise<COS.GetBucketInventoryResult>;
  1970. /** 获取 Bucket 的清单任务信息 @see https://cloud.tencent.com/document/product/436/33706 */
  1971. listBucketInventory(params: COS.ListBucketInventoryParams, callback: (err: COS.CosError, data: COS.ListBucketInventoryResult) => void): void;
  1972. listBucketInventory(params: COS.ListBucketInventoryParams): Promise<COS.ListBucketInventoryResult>;
  1973. /** 删除 Bucket 的清单任务 @see https://cloud.tencent.com/document/product/436/33704 */
  1974. deleteBucketInventory(params: COS.DeleteBucketInventoryParams, callback: (err: COS.CosError, data: COS.DeleteBucketInventoryResult) => void): void;
  1975. deleteBucketInventory(params: COS.DeleteBucketInventoryParams): Promise<COS.DeleteBucketInventoryResult>;
  1976. /** 启用或者暂停存储桶的全球加速功能 @see https://cloud.tencent.com/document/product/436/38869 */
  1977. putBucketAccelerate(params: COS.PutBucketAccelerateParams, callback: (err: COS.CosError, data: COS.PutBucketAccelerateResult) => void): void;
  1978. putBucketAccelerate(params: COS.PutBucketAccelerateParams): Promise<COS.PutBucketAccelerateResult>;
  1979. /** 查询存储桶的全球加速功能配置 @see https://cloud.tencent.com/document/product/436/38868 */
  1980. getBucketAccelerate(params: COS.GetBucketAccelerateParams, callback: (err: COS.CosError, data: COS.GetBucketAccelerateResult) => void): void;
  1981. getBucketAccelerate(params: COS.GetBucketAccelerateParams): Promise<COS.GetBucketAccelerateResult>;
  1982. /** 设置指定存储桶下的默认加密配置 @see https://cloud.tencent.com/document/product/436/40136 */
  1983. putBucketEncryption(params: COS.PutBucketEncryptionParams, callback: (err: COS.CosError, data: COS.PutBucketEncryptionResult) => void): void;
  1984. putBucketEncryption(params: COS.PutBucketEncryptionParams): Promise<COS.PutBucketEncryptionResult>;
  1985. /** 查询指定存储桶下的默认加密配置 @see https://cloud.tencent.com/document/product/436/40137 */
  1986. getBucketEncryption(params: COS.GetBucketEncryptionParams, callback: (err: COS.CosError, data: COS.GetBucketEncryptionResult) => void): void;
  1987. getBucketEncryption(params: COS.GetBucketEncryptionParams): Promise<COS.GetBucketEncryptionResult>;
  1988. /** 删除指定存储桶下的默认加密配置 @see https://cloud.tencent.com/document/product/436/40138 */
  1989. deleteBucketEncryption(params: COS.DeleteBucketEncryptionParams, callback: (err: COS.CosError, data: COS.DeleteBucketEncryptionResult) => void): void;
  1990. deleteBucketEncryption(params: COS.DeleteBucketEncryptionParams): Promise<COS.DeleteBucketEncryptionResult>;
  1991. /** 取回对应对象(Object)的元数据,Head的权限与Get的权限一致 @see https://cloud.tencent.com/document/product/436/7745 */
  1992. headObject(params: COS.HeadObjectParams, callback: (err: COS.CosError, data: COS.HeadObjectResult) => void): void;
  1993. headObject(params: COS.HeadObjectParams): Promise<COS.HeadObjectResult>;
  1994. /** 下载对象(Object) @see https://cloud.tencent.com/document/product/436/7753 */
  1995. getObject(params: COS.GetObjectParams, callback: (err: COS.CosError, data: COS.GetObjectResult) => void): void;
  1996. getObject(params: COS.GetObjectParams): Promise<COS.GetObjectResult>;
  1997. /** 简单上传对象(Object)至指定存储桶 @see https://cloud.tencent.com/document/product/436/7749 */
  1998. putObject(params: COS.PutObjectParams, callback: (err: COS.CosError, data: COS.PutObjectResult) => void): void;
  1999. putObject(params: COS.PutObjectParams): Promise<COS.PutObjectResult>;
  2000. /** 删除一个指定的对象(Object) @see https://cloud.tencent.com/document/product/436/7743 */
  2001. deleteObject(params: COS.DeleteObjectParams, callback: (err: COS.CosError, data: COS.DeleteObjectResult) => void): void;
  2002. deleteObject(params: COS.DeleteObjectParams): Promise<COS.DeleteObjectResult>;
  2003. /** 批量删除指定存储桶中的多个对象(Object) @see https://cloud.tencent.com/document/product/436/8289 */
  2004. deleteMultipleObject(params: COS.DeleteMultipleObjectParams, callback: (err: COS.CosError, data: COS.DeleteMultipleObjectResult) => void): void;
  2005. deleteMultipleObject(params: COS.DeleteMultipleObjectParams): Promise<COS.DeleteMultipleObjectResult>;
  2006. /** 获取 Object 的权限列表 @see https://cloud.tencent.com/document/product/436/7744 */
  2007. getObjectAcl(params: COS.GetObjectAclParams, callback: (err: COS.CosError, data: COS.GetObjectAclResult) => void): void;
  2008. getObjectAcl(params: COS.GetObjectAclParams): Promise<COS.GetObjectAclResult>;
  2009. /** 设置 Object 的权限列表 @see https://cloud.tencent.com/document/product/436/7748 */
  2010. putObjectAcl(params: COS.PutObjectAclParams, callback: (err: COS.CosError, data: COS.PutObjectAclResult) => void): void;
  2011. putObjectAcl(params: COS.PutObjectAclParams): Promise<COS.PutObjectAclResult>;
  2012. /** 跨域资源共享(CORS)的预检(Preflight)请求 @see https://cloud.tencent.com/document/product/436/8288 */
  2013. optionsObject(params: COS.OptionsObjectParams, callback: (err: COS.CosError, data: COS.OptionsObjectResult) => void): void;
  2014. optionsObject(params: COS.OptionsObjectParams): Promise<COS.OptionsObjectResult>;
  2015. /** 恢复归档对象 @see https://cloud.tencent.com/document/product/436/12633 */
  2016. restoreObject(params: COS.RestoreObjectParams, callback: (err: COS.CosError, data: COS.RestoreObjectResult) => void): void;
  2017. restoreObject(params: COS.RestoreObjectParams): Promise<COS.RestoreObjectResult>;
  2018. /** 检索对象内容 @see https://cloud.tencent.com/document/product/436/37641 */
  2019. selectObjectContent(params: COS.SelectObjectContentParams, callback: (err: COS.CosError, data: COS.SelectObjectContentResult) => void): void;
  2020. selectObjectContent(params: COS.SelectObjectContentParams): Promise<COS.SelectObjectContentResult>;
  2021. /** 复制对象 @see https://cloud.tencent.com/document/product/436/10881 */
  2022. putObjectCopy(params: COS.PutObjectCopyParams, callback: (err: COS.CosError, data: COS.PutObjectCopyResult) => void): void;
  2023. putObjectCopy(params: COS.PutObjectCopyParams): Promise<COS.PutObjectCopyResult>;
  2024. /** 设置对象标签 @see https://cloud.tencent.com/document/product/436/42997 */
  2025. putObjectTagging(params: COS.PutObjectTaggingParams, callback: (err: COS.CosError, data: COS.PutObjectTaggingResult) => void): void;
  2026. putObjectTagging(params: COS.PutObjectTaggingParams): Promise<COS.PutObjectTaggingResult>;
  2027. /** 查询对象标签 @see https://cloud.tencent.com/document/product/436/42998 */
  2028. getObjectTagging(params: COS.GetObjectTaggingParams, callback: (err: COS.CosError, data: COS.GetObjectTaggingResult) => void): void;
  2029. getObjectTagging(params: COS.GetObjectTaggingParams): Promise<COS.GetObjectTaggingResult>;
  2030. /** 删除对象标签 @see https://cloud.tencent.com/document/product/436/42999 */
  2031. deleteObjectTagging(params: COS.DeleteObjectTaggingParams, callback: (err: COS.CosError, data: COS.DeleteObjectTaggingResult) => void): void;
  2032. deleteObjectTagging(params: COS.DeleteObjectTaggingParams): Promise<COS.DeleteObjectTaggingResult>;
  2033. /** 初始化分块上传 @see https://cloud.tencent.com/document/product/436/7746 */
  2034. multipartInit(params: COS.MultipartInitParams, callback: (err: COS.CosError, data: COS.MultipartInitResult) => void): void;
  2035. multipartInit(params: COS.MultipartInitParams): Promise<COS.MultipartInitResult>;
  2036. /** 分块上传 @see https://cloud.tencent.com/document/product/436/7750 */
  2037. multipartUpload(params: COS.MultipartUploadParams, callback: (err: COS.CosError, data: COS.MultipartUploadResult) => void): void;
  2038. multipartUpload(params: COS.MultipartUploadParams): Promise<COS.MultipartUploadResult>;
  2039. /** 分块上传 @see https://cloud.tencent.com/document/product/436/8287 */
  2040. uploadPartCopy(params: COS.UploadPartCopyParams, callback: (err: COS.CosError, data: COS.UploadPartCopyResult) => void): void;
  2041. uploadPartCopy(params: COS.UploadPartCopyParams): Promise<COS.UploadPartCopyResult>;
  2042. /** 完成分块上传 @see https://cloud.tencent.com/document/product/436/7742 */
  2043. multipartComplete(params: COS.MultipartCompleteParams, callback: (err: COS.CosError, data: COS.MultipartCompleteResult) => void): void;
  2044. multipartComplete(params: COS.MultipartCompleteParams): Promise<COS.MultipartCompleteResult>;
  2045. /** 分块上传任务列表查询 @see https://cloud.tencent.com/document/product/436/7736 */
  2046. multipartList(params: COS.MultipartListParams, callback: (err: COS.CosError, data: COS.MultipartListResult) => void): void;
  2047. multipartList(params: COS.MultipartListParams): Promise<COS.MultipartListResult>;
  2048. /** 上传的分块列表查询 @see https://cloud.tencent.com/document/product/436/7747 */
  2049. multipartListPart(params: COS.MultipartListPartParams, callback: (err: COS.CosError, data: COS.MultipartListPartResult) => void): void;
  2050. multipartListPart(params: COS.MultipartListPartParams): Promise<COS.MultipartListPartResult>;
  2051. /** 抛弃分块上传 @see https://cloud.tencent.com/document/product/436/7740 */
  2052. multipartAbort(params: COS.MultipartAbortParams, callback: (err: COS.CosError, data: COS.MultipartAbortResult) => void): void;
  2053. multipartAbort(params: COS.MultipartAbortParams): Promise<COS.MultipartAbortResult>;
  2054. /** 分片上传文件,封装好分片上传的多个步骤的上传方法。 */
  2055. sliceUploadFile(params: COS.SliceUploadFileParams, callback: (err: COS.CosError, data: COS.SliceUploadFileResult) => void): void;
  2056. sliceUploadFile(params: COS.SliceUploadFileParams): Promise<COS.SliceUploadFileResult>;
  2057. /** 清理分片上传 UploadId,封装好的清理单个文件或存储桶所有文件未完成的 UploadId。 */
  2058. abortUploadTask(params: COS.AbortUploadTaskParams, callback: (err: COS.CosError, data: COS.AbortUploadTaskResult) => void): void;
  2059. abortUploadTask(params: COS.AbortUploadTaskParams): Promise<COS.AbortUploadTaskResult>;
  2060. /** 高级上传文件 */
  2061. uploadFile(params: COS.UploadFileParams, callback: (err: COS.CosError, data: COS.UploadFileResult) => void): void;
  2062. uploadFile(params: COS.UploadFileParams): Promise<COS.UploadFileResult>;
  2063. /** 批量上传文件 */
  2064. uploadFiles(params: COS.UploadFilesParams, callback: (err: COS.CosError, data: COS.UploadFilesResult) => void): void;
  2065. uploadFiles(params: COS.UploadFilesParams): Promise<COS.UploadFilesResult>;
  2066. /** 分片复制文件 */
  2067. sliceCopyFile(params: COS.SliceCopyFileParams, callback: (err: COS.CosError, data: COS.SliceCopyFileResult) => void): void;
  2068. sliceCopyFile(params: COS.SliceCopyFileParams): Promise<COS.SliceCopyFileResult>;
  2069. /** 获取上传任务列表 */
  2070. getTaskList(): COS.TaskList;
  2071. /** 判断上传队列是否有未完成的任务 */
  2072. pauseTask(taskId: COS.TaskId): void;
  2073. /** 判断上传队列是否有未完成的任务 */
  2074. restartTask(taskId: COS.TaskId): void;
  2075. /** 判断上传队列是否有未完成的任务 */
  2076. cancelTask(taskId: COS.TaskId): void;
  2077. /** 判断上传队列是否有未完成的任务 */
  2078. isUploadRunning(): boolean;
  2079. /** 分片复制文件 */
  2080. request(params: COS.RequestParams, callback: (err: COS.CosError, data: COS.RequestResult) => void): void;
  2081. request(params: COS.RequestParams): Promise<COS.RequestResult>;
  2082. /** 获取文件下载链接 @see https://cloud.tencent.com/document/product/436/35651 */
  2083. getObjectUrl(params: COS.GetObjectUrlParams, callback: (err: COS.CosError, data: COS.GetObjectUrlResult) => void): string;
  2084. /** cos.request */
  2085. request(params: COS.RequestParams, callback: (err: COS.CosError, data: COS.RequestResult) => void): void;
  2086. request(params: COS.RequestParams): Promise<COS.RequestResult>;
  2087. /** 追加上传 @see https://cloud.tencent.com/document/product/436/7741 */
  2088. appendObject(params: COS.AppendObjectParams, callback: (err: COS.CosError, data: COS.GeneralResult) => void): void;
  2089. appendObject(params: COS.AppendObjectParams): Promise<COS.GeneralResult>;
  2090. /** 获取 COS JSON API (v4) 签名 @see https://cloud.tencent.com/document/product/436/6054 */
  2091. getV4Auth(params: COS.GetV4AuthParams): COS.Authorization;
  2092. /** 获取 COS XMl API (v5) 签名 @see https://cloud.tencent.com/document/product/436/7778 */
  2093. getAuth(params: COS.GetAuthParams): COS.Authorization;
  2094. on(action: string, callback: (params?: any) => void): void;
  2095. off(action: string, callback: (params?: any) => void): void;
  2096. emit(action: string, data?: any): void;
  2097. }
  2098. export = COS;