Skip to content

Commit c4faf4a

Browse files
carsonxucarsonxu
committed
add error doc
1 parent 53fec6e commit c4faf4a

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

‎src/base.js

+22-22
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ var util = require('./util');
1010
* @param {String} params.Bucket Bucket名称，必须
1111
* @param {String} params.Region 地域名称，必须
1212
* @param {Function} callback 回调函数，必须
13-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
13+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
1414
* @return {Object} data 返回的数据
1515
* @return {Boolean} data.BucketExist Bucket是否存在
1616
* @return {Boolean} data.BucketAuth 是否有 Bucket 的访问权限
@@ -37,7 +37,7 @@ function headBucket(params, callback) {
3737
* @param {String} params.MaxKeys 单次返回最大的条目数量，默认1000，非必须
3838
* @param {String} params.EncodingType 规定返回值的编码方式，非必须
3939
* @param {Function} callback 回调函数，必须
40-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
40+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
4141
* @return {Object} data 返回的数据
4242
* @return {Object} data.ListBucketResult 返回的 object 列表信息
4343
*/
@@ -84,7 +84,7 @@ function getBucket(params, callback) {
8484
* @param {String} params.Bucket Bucket名称，必须
8585
* @param {String} params.Region 地域名称，必须
8686
* @param {Function} callback 回调函数，必须
87-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
87+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
8888
* @return {Object} data 返回的数据
8989
* @return {String} data.Location 操作地址
9090
*/
@@ -113,7 +113,7 @@ function deleteBucket(params, callback) {
113113
* @param {String} params.Bucket Bucket名称，必须
114114
* @param {String} params.Region 地域名称，必须
115115
* @param {Function} callback 回调函数，必须
116-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
116+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
117117
* @return {Object} data 返回的数据
118118
* @return {Object} data.AccessControlPolicy 访问权限信息
119119
*/
@@ -156,7 +156,7 @@ function getBucketAcl(params, callback) {
156156
* @param {String} params.GrantWrite 赋予被授权者写的权限，格式x-cos-grant-write: uin=" ",uin=" "，非必须
157157
* @param {String} params.GrantFullControl 赋予被授权者读写权限，格式x-cos-grant-full-control: uin=" ",uin=" "，非必须
158158
* @param {Function} callback 回调函数，必须
159-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
159+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
160160
* @return {Object} data 返回的数据
161161
*/
162162
function putBucketAcl(params, callback) {
@@ -207,7 +207,7 @@ function putBucketAcl(params, callback) {
207207
* @param {String} params.Bucket Bucket名称，必须
208208
* @param {String} params.Region 地域名称，必须
209209
* @param {Function} callback 回调函数，必须
210-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
210+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
211211
* @return {Object} data 返回的数据
212212
* @return {Object} data.CORSRules Bucket的跨域设置
213213
*/
@@ -261,7 +261,7 @@ function getBucketCors(params, callback) {
261261
* @param {Object} params.CORSConfiguration 相关的跨域设置，必须
262262
* @param {Array} params.CORSConfiguration.CORSRules 对应的跨域规则
263263
* @param {Function} callback 回调函数，必须
264-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
264+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
265265
* @return {Object} data 返回的数据
266266
*/
267267
function putBucketCors(params, callback) {
@@ -308,7 +308,7 @@ function putBucketCors(params, callback) {
308308
* @param {String} params.Bucket Bucket名称，必须
309309
* @param {String} params.Region 地域名称，必须
310310
* @param {Function} callback 回调函数，必须
311-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
311+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
312312
* @return {Object} data 返回的数据
313313
*/
314314
function deleteBucketCors(params, callback) {
@@ -375,7 +375,7 @@ function putBucketPolicy(params, callback) {
375375
* @param {String} params.Bucket Bucket名称，必须
376376
* @param {String} params.Region 地域名称，必须
377377
* @param {Function} callback 回调函数，必须
378-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
378+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
379379
* @return {Object} data 返回数据，包含地域信息 LocationConstraint
380380
*/
381381
function getBucketLocation(params, callback) {
@@ -399,7 +399,7 @@ function getBucketLocation(params, callback) {
399399
* @param {String} params.Bucket Bucket名称，必须
400400
* @param {String} params.Region 地域名称，必须
401401
* @param {Function} callback 回调函数，必须
402-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
402+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
403403
* @return {Object} data 返回数据
404404
*/
405405
function getBucketPolicy(params, callback) {
@@ -442,7 +442,7 @@ function getBucketPolicy(params, callback) {
442442
* @param {String} params.Bucket Bucket名称，必须
443443
* @param {String} params.Region 地域名称，必须
444444
* @param {Function} callback 回调函数，必须
445-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
445+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
446446
* @return {Object} data 返回数据
447447
*/
448448
function getBucketTagging(params, callback) {
@@ -487,7 +487,7 @@ function getBucketTagging(params, callback) {
487487
* @param {String} params.Region 地域名称，必须
488488
* @param {Array} params.TagSet 标签设置，必须
489489
* @param {Function} callback 回调函数，必须
490-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
490+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
491491
* @return {Object} data 返回数据
492492
*/
493493
function putBucketTagging(params, callback) {
@@ -528,7 +528,7 @@ function putBucketTagging(params, callback) {
528528
* @param {String} params.Bucket Bucket名称，必须
529529
* @param {String} params.Region 地域名称，必须
530530
* @param {Function} callback 回调函数，必须
531-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
531+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
532532
* @return {Object} data 返回的数据
533533
*/
534534
function deleteBucketTagging(params, callback) {
@@ -775,7 +775,7 @@ function deleteBucketReplication(params, callback) {
775775
* @param {String} params.Key 文件名称，必须
776776
* @param {String} params.IfModifiedSince 当Object在指定时间后被修改，则返回对应Object元信息，否则返回304，非必须
777777
* @param {Function} callback 回调函数，必须
778-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
778+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
779779
* @return {Object} data 为指定 object 的元数据，如果设置了 IfModifiedSince ，且文件未修改，则返回一个对象，NotModified 属性为 true
780780
* @return {Boolean} data.NotModified 是否在 IfModifiedSince 时间点之后未修改该 object，则为 true
781781
*/
@@ -929,7 +929,7 @@ function getObject(params, callback) {
929929
* @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密，格式 x-cos-server-side-encryption: "AES256"，非必须
930930
* @param {Function} params.onProgress 上传进度回调函数
931931
* @param {Function} callback 回调函数，必须
932-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
932+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
933933
* @return {Object} data 为对应的 object 数据
934934
* @return {String} data.ETag 为对应上传文件的 ETag 值
935935
*/
@@ -1016,7 +1016,7 @@ function deleteObject(params, callback) {
10161016
* @param {String} params.Region 地域名称，必须
10171017
* @param {String} params.Key object名称，必须
10181018
* @param {Function} callback 回调函数，必须
1019-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
1019+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
10201020
* @return {Object} data 返回的数据
10211021
* @return {Object} data.AccessControlPolicy 权限列表
10221022
*/
@@ -1058,7 +1058,7 @@ function getObjectAcl(params, callback) {
10581058
* @param {String} params.Region 地域名称，必须
10591059
* @param {String} params.Key object名称，必须
10601060
* @param {Function} callback 回调函数，必须
1061-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
1061+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
10621062
* @return {Object} data 返回的数据
10631063
*/
10641064
function putObjectAcl(params, callback) {
@@ -1111,7 +1111,7 @@ function putObjectAcl(params, callback) {
11111111
* @param {String} params.Region 地域名称，必须
11121112
* @param {String} params.Key object名称，必须
11131113
* @param {Function} callback 回调函数，必须
1114-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
1114+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
11151115
* @return {Object} data 返回的数据
11161116
*/
11171117
function optionsObject(params, callback) {
@@ -1313,7 +1313,7 @@ function restoreObject(params, callback) {
13131313
* @param {String} params.StorageClass 设置Object的存储级别，枚举值：Standard，Standard_IA，Nearline，非必须
13141314
* @param {String} params.ServerSideEncryption 支持按照指定的加密算法进行服务端数据加密，格式 x-cos-server-side-encryption: "AES256"，非必须
13151315
* @param {Function} callback 回调函数，必须
1316-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
1316+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
13171317
* @return {Object} data 返回的数据
13181318
*/
13191319
function multipartInit(params, callback) {
@@ -1397,7 +1397,7 @@ function multipartUpload(params, callback) {
13971397
* @param {String} params.Parts[i].PartNumber 块编号，必须
13981398
* @param {String} params.Parts[i].ETag 分块的 sha1 校验值
13991399
* @param {Function} callback 回调函数，必须
1400-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
1400+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
14011401
* @return {Object} data 返回的数据
14021402
* @return {Object} data.CompleteMultipartUpload 完成分块上传后的文件信息，包括Location, Bucket, Key 和 ETag
14031403
*/
@@ -1465,7 +1465,7 @@ function multipartComplete(params, callback) {
14651465
* @param {String} params.KeyMarker 与upload-id-marker一起使用 </Br>当upload-id-marker未被指定时，ObjectName字母顺序大于key-marker的条目将被列出 </Br>当upload-id-marker被指定时，ObjectName字母顺序大于key-marker的条目被列出，ObjectName字母顺序等于key-marker同时UploadId大于upload-id-marker的条目将被列出，非必须
14661466
* @param {String} params.UploadIdMarker 与key-marker一起使用 </Br>当key-marker未被指定时，upload-id-marker将被忽略 </Br>当key-marker被指定时，ObjectName字母顺序大于key-marker的条目被列出，ObjectName字母顺序等于key-marker同时UploadId大于upload-id-marker的条目将被列出，非必须
14671467
* @param {Function} callback 回调函数，必须
1468-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
1468+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
14691469
* @return {Object} data 返回的数据
14701470
* @return {Object} data.ListMultipartUploadsResult 分块上传任务信息
14711471
*/
@@ -1526,7 +1526,7 @@ function multipartList(params, callback) {
15261526
* @param {String} params.MaxParts 单次返回最大的条目数量，默认1000，非必须
15271527
* @param {String} params.PartNumberMarker 默认以UTF-8二进制顺序列出条目，所有列出条目从marker开始，非必须
15281528
* @param {Function} callback 回调函数，必须
1529-
* @return {Object} err 请求失败的错误，如果请求成功，则为空。
1529+
* @return {Object} err 请求失败的错误，如果请求成功，则为空。https://cloud.tencent.com/document/product/436/7730
15301530
* @return {Object} data 返回的数据
15311531
* @return {Object} data.ListMultipartUploadsResult 分块信息
15321532
*/

0 commit comments

Comments
 (0)