接口文档

说明：

关于文章中出现的 SecretId、SecretKey、Bucket 等名称的含义和获取方式请参考：COS 术语信息

Bucket操作

Head Bucket

功能说明

Head Bucket 请求可以确认是否存在该 Bucket，是否有权限访问，Head 的权限与 Read 一致。

操作方法原型

调用 Head Bucket 操作：

var params = {
    Bucket : 'STRING_VALUE',    /* 必须 */
    Region : 'STRING_VALUE'        /* 必须 */
};

cos.headBucket(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Get Bucket

功能说明

Get Bucket 请求等同于 List Object 请求，可以列出该 Bucekt 下部分或者所有 Object，发起该请求需要拥有 Read 权限。

操作方法原型

调用 Get Bucket 操作：

var params = {
    Bucket : 'STRING_VALUE',    /* 必须 */
    Region : 'STRING_VALUE',    /* 必须 */
    Prefix : 'STRING_VALUE',    /* 非必须 */
    Delimiter : 'STRING_VALUE', /* 非必须 */
    Marker : 'STRING_VALUE',    /* 非必须 */
    MaxKeys : 'STRING_VALUE',    /* 非必须 */
    EncodingType : 'STRING_VALUE',    /* 非必须 */
};

cos.getBucket(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Put Bucket

功能说明

Put Bucket 请求可以在指定账号下创建一个 Bucket。

操作方法原型

调用 Put Bucket 操作：

var params = {
    Bucket : 'STRING_VALUE',    /* 必须 */
    Region : 'STRING_VALUE',    /* 必须 */
    ACL : 'STRING_VALUE',    /* 非必须 */
    GrantRead : 'STRING_VALUE', /* 非必须 */
    GrantWrite : 'STRING_VALUE',    /* 非必须 */
    GrantFullControl : 'STRING_VALUE'    /* 非必须 */
};

cos.putBucket(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Delete Bucket

功能说明

Delete Bucket 请求可以在指定账号下删除 Bucket，删除之前要求 Bucket为空。

操作方法原型

调用 Delete Bucket 操作：

var params = {
    Bucket : 'STRING_VALUE',    /* 必须 */
    Region : 'STRING_VALUE'        /* 必须 */
};

cos.deleteBucket(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Get Bucket ACL

功能说明

使用 API 读取 Bucket 的 ACL 表，只有所有者有权操作。

操作方法原型

调用 Get Bucket ACL 操作：

var params = {
    Bucket : 'STRING_VALUE',    /* 必须 */
    Region : 'STRING_VALUE'        /* 必须 */
};

cos.getBucketAcl(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Put Bucket ACL

功能说明

使用 API 写入 Bucket 的 ACL 表，Put Bucket ACL 是一个覆盖操作，传入新的 ACL 将覆盖原有 ACL。只有所有者有权操作。

操作方法原型

调用 Put Bucket ACL 操作：

var params = {
    Bucket : 'STRING_VALUE',            /* 必须 */
    Region : 'STRING_VALUE',            /* 必须 */
    ACL : 'STRING_VALUE',                /* 非必须 */
    GrantRead : 'STRING_VALUE',         /* 非必须 */
    GrantWrite : 'STRING_VALUE',        /* 非必须 */
    GrantFullControl : 'STRING_VALUE'    /* 非必须 */
};

cos.putBucketAcl(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Get Bucket CORS

功能说明

Get Bucket CORS 实现跨域访问读取。

操作方法原型

• 调用 Get Bucket CORS 操作

var params = {
    Bucket : 'STRING_VALUE',    /* 必须 */
    Region : 'STRING_VALUE'        /* 必须 */
};

cos.getBucketCors(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Put Bucket CORS

功能说明

Put Bucket CORS 实现跨域访问读写。

操作方法原型

调用 Put Bucket CORS 操作：

var params = {
    Bucket : 'STRING_VALUE',        /* 必须 */
    Region : 'STRING_VALUE',        /* 必须 */
    CORSRules : [
        {
            ID : 'STRING_VALUE',    /* 非必须 */
            AllowedMethods: [         /* 必须 */
              'STRING_VALUE',
              ...
            ],
            AllowedOrigins: [         /* 必须 */
              'STRING_VALUE',
              ...
            ],
            AllowedHeaders: [        /* 非必须 */
              'STRING_VALUE',
              ...
            ],
            ExposeHeaders: [        /* 非必须 */
                'STRING_VALUE',
                ...
            ],
            MaxAgeSeconds: 'STRING_VALUE'    /* 非必须 */
          },
          ....
    ]
};

cos.putBucketCors(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Delete Bucket CORS

功能说明

Delete Bucket CORS 实现跨域访问读取。

操作方法原型

调用 Delete Bucket CORS 操作：

var params = {
    Bucket : 'STRING_VALUE',        /* 必须 */
    Region : 'STRING_VALUE'            /* 必须 */
};

cos.deleteBucketCors(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Get Bucket Location

功能说明

Get Bucket Location 接口获取 Bucket 所在地域信息，只有 Bucket 所有者有权限读取信息。

操作方法原型

调用 Get Bucket Location 操作：

var params = {
    Bucket : 'STRING_VALUE',        /* 必须 */
    Region : 'STRING_VALUE'            /* 必须 */
};

cos.getBucketLocation(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Object操作

Head Object

功能说明

Head Object 请求可以取回对应 Object 的元数据，Head的权限与 Get 的权限一致。

操作方法原型

调用 Head Object 操作：

var params = {
    Bucket : 'STRING_VALUE',        /* 必须 */
    Region : 'STRING_VALUE',        /* 必须 */
    Key : 'STRING_VALUE',            /* 必须 */
    IfModifiedSince : 'STRING_VALUE'    /* 非必须 */
};

cos.headObject(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Get Object

功能说明

Get Object 请求可以将一个文件（Object）下载至本地。该操作需要对目标 Object 具有读权限或目标 Object 对所有人都开放了读权限（公有读）。

操作方法原型

调用 Get Object 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE',                            /* 必须 */
    ResponseContentType : 'STRING_VALUE',            /* 非必须 */
    ResponseContentLanguage : 'STRING_VALUE',        /* 非必须 */
    ResponseExpires : 'STRING_VALUE',                /* 非必须 */
    ResponseCacheControl : 'STRING_VALUE',            /* 非必须 */
    ResponseContentDisposition : 'STRING_VALUE',    /* 非必须 */
    ResponseContentEncoding : 'STRING_VALUE',        /* 非必须 */
    Range : 'STRING_VALUE',                            /* 非必须 */
    IfModifiedSince : 'STRING_VALUE',                /* 非必须 */
    Output : 'STRING_VALUE' || 'WRITE_STRING'        /* 必须 */
};

cos.getObject(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Put Object

功能说明

Put Object 请求可以将一个文件（Oject）上传至指定 Bucket。

注意：

Key（文件名）不能以 / 结尾，否则会被识别为文件夹 。

操作方法原型

调用 Put Object 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE',                            /* 必须 */
    CacheControl : 'STRING_VALUE',                    /* 非必须 */
    ContentDisposition : 'STRING_VALUE',            /* 非必须 */
    ContentEncoding : 'STRING_VALUE',                /* 非必须 */
    ContentLength : 'STRING_VALUE',                    /* 必须 */
    ContentType : 'STRING_VALUE',                    /* 非必须 */
    Expect : 'STRING_VALUE',                        /* 非必须 */
    Expires : 'STRING_VALUE',                        /* 非必须 */
    ContentSha1 : 'STRING_VALUE',                    /* 非必须 */
    ACL : 'STRING_VALUE',                            /* 非必须 */
    GrantRead : 'STRING_VALUE',                        /* 非必须 */
    GrantWrite : 'STRING_VALUE',                    /* 非必须 */
    GrantFullControl : 'STRING_VALUE',                /* 非必须 */
    'x-cos-meta-*' : 'STRING_VALUE',                /* 非必须 */
    Body: fs.createReadStream('./a.zip'),           /* 必须 */
    onProgress: function (progressData) {
        console.log(progressData);
    },
};
cos.putObject(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Delete Object

功能说明

Delete Object 请求可以将一个文件（Object）删除。

操作方法原型

调用 Delete Object 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE'                            /* 必须 */
};

cos.deleteObject(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Options Object

功能说明

Options Object 请求实现跨域访问的预请求。即发出一个 OPTIONS 请求给服务器以确认是否可以进行跨域操作。

操作方法原型

调用 Options Object 操作：

var params = {
    Bucket : 'STRING_VALUE',        /* 必须 */
    Region : 'STRING_VALUE',        /* 必须 */
    Key : 'STRING_VALUE',            /* 必须 */
    Origin : 'STRING_VALUE',         /* 必须 */
    AccessControlRequestMethod : 'STRING_VALUE',         /* 必须 */
    AccessControlRequestHeaders : 'STRING_VALUE'        /* 非必须 */
};

cos.optionsObject(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Get Object ACL

功能说明

Get Object ACL 接口实现使用 API 读取 Object 的 ACL 表，只有所有者有权操作。

操作方法原型

调用 Get Object ACL 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE'                            /* 必须 */
};

cos.getObjectAcl(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Put Object ACL

功能说明

Put Object ACL使用 API 写入 Object 的 ACL 表。

操作方法原型

调用 Put Object ACL 操作：

var params = {
    Bucket : 'STRING_VALUE',            /* 必须 */
    Region : 'STRING_VALUE',            /* 必须 */
    Key : 'STRING_VALUE',                /* 必须 */
    ACL : 'STRING_VALUE',                /* 非必须 */
    GrantRead : 'STRING_VALUE',         /* 非必须 */
    GrantWrite : 'STRING_VALUE',        /* 非必须 */
    GrantFullControl : 'STRING_VALUE'    /* 非必须 */
};

cos.putObjectAcl(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Delete Multiple Object

功能说明

Delete Multiple Object 请求实现批量删除文件，最大支持单次删除 1000 个文件。对于返回结果，COS 提供 Verbose 和 Quiet 两种结果模式。Verbose 模式将返回每个 Object 的删除结果；Quiet 模式只返回报错的 Object 信息。

操作方法原型

调用 Delete Multiple Object 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Quiet : 'BOOLEAN_VALUE',                        /* 非必须 */
    Objects :  [
        {
            Key : 'STRING_VALUE'                    /* 必须 */
        }
    ]
};

cos.deleteMultipleObject(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

分块上传操作

Initiate Multipart Upload

功能说明

Initiate Multipart Upload 请求实现初始化分片上传，成功执行此请求以后会返回 Upload ID 用于后续的 Upload Part 请求。

操作方法原型

调用 Initiate Multipart Upload 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE',                            /* 必须 */
    CacheControl : 'STRING_VALUE',                    /* 非必须 */
    ContentDisposition : 'STRING_VALUE',            /* 非必须 */
    ContentEncoding : 'STRING_VALUE',                /* 非必须 */
    ContentType : 'STRING_VALUE',                    /* 非必须 */
    Expires : 'STRING_VALUE',                        /* 非必须 */
    ACL : 'STRING_VALUE',                            /* 非必须 */
    GrantRead : 'STRING_VALUE',                        /* 非必须 */
    GrantWrite : 'STRING_VALUE',                    /* 非必须 */
    GrantFullControl : 'STRING_VALUE',                /* 非必须 */
    StorageClass : 'STRING_VALUE',                    /* 非必须 */
    'x-cos-meta-*' : 'STRING_VALUE'                    /* 非必须 */
};

cos.multipartInit(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Upload Part

功能说明

Upload Part 请求实现在初始化以后的分块上传，支持的块的数量为 1 到 10000，块的大小为 1 MB 到 5 GB。在每次请求Upload Part 时候，需要携带 partNumber 和 uploadID，partNumber 为块的编号，支持乱序上传。

操作方法原型

调用 Upload Part 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE',                            /* 必须 */
    ContentLength : 'STRING_VALUE',                    /* 必须 */
    Expect : 'STRING_VALUE',                        /* 非必须 */
    ContentSha1 : 'STRING_VALUE',                    /* 非必须 */
    PartNumber : 'STRING_VALUE',                    /* 必须 */
    UploadId : 'STRING_VALUE',                        /* 必须 */
};

cos.multipartUpload(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Complete Multipart Upload

功能说明

Complete Multipart Upload 用来实现完成整个分块上传。当您已经使用 Upload Parts 上传所有块以后，你可以用该 API 完成上传。在使用该 API 时，您必须在 Body 中给出每一个块的 PartNumber 和 ETag，用来校验块的准确性。

操作方法原型

调用 Complete Multipart Upload 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE',                            /* 必须 */
    UploadId : 'STRING_VALUE',                        /* 必须 */
    Parts : [
        {
            PartNumber : 'STRING_VALUE',            /* 必须 */
            ETag : 'STRING_VALUE'                    /* 必须 */
        },
        ...
    ]
};

cos.multipartComplete(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

List Parts

功能说明

List Parts用来查询特定分块上传中的已上传的块

操作方法原型

调用 List Parts 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE',                            /* 必须 */
    UploadId : 'STRING_VALUE',                        /* 必须 */
    EncodingType : 'STRING_VALUE',                    /* 非必须 */
    MaxParts : 'STRING_VALUE',                        /* 非必须 */
    PartNumberMarker : 'STRING_VALUE'                /* 非必须 */
};

cos.multipartListPart(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Abort Multipart Upload

功能说明

Abort Multipart Upload 用来实现舍弃一个分块上传并删除已上传的块。当您调用 Abort Multipart Upload 时，如果有正在使用这个 Upload Parts 上传块的请求，则 Upload Parts 会返回失败。

操作方法原型

调用 Abort Multipart Upload 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Key : 'STRING_VALUE',                            /* 必须 */
    UploadId : 'STRING_VALUE'                        /* 必须 */
};

cos.multipartAbort(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

List Multipart Uploads

功能说明

List Multiparts Uploads 用来查询正在进行中的分块上传。单次最多列出 1000 个正在进行中的分块上传。

操作方法原型

调用 List Multipart Uploads 操作：

var params = {
    Bucket : 'STRING_VALUE',                        /* 必须 */
    Region : 'STRING_VALUE',                        /* 必须 */
    Delimiter : 'STRING_VALUE',                        /* 非必须 */
    EncodingType : 'STRING_VALUE',                    /* 非必须 */
    Prefix : 'STRING_VALUE',                        /* 非必须 */
    MaxUploads : 'STRING_VALUE',                    /* 非必须 */
    KeyMarker : 'STRING_VALUE',                        /* 非必须 */
    UploadIdMarker : 'STRING_VALUE'                    /* 非必须 */
};

cos.multipartList(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

Slice Upload File

功能说明

Slice Upload File 可用于实现文件的分块上传。

操作方法原型

调用 Slice Upload File 操作：

var params = {
    Bucket: 'STRING_VALUE',    /* 必须 */
    Region: 'STRING_VALUE',    /* 必须 */
    Key: 'STRING_VALUE',    /* 必须 */
    FilePath: 'STRING_VALUE',    /* 必须 */
    SliceSize: 'STRING_VALUE',    /* 非必须 */
    AsyncLimit: 'NUMBER_VALUE',    /* 非必须 */
    onHashProgress: function (progressData) {
        console.log(JSON.stringify(progressData));
    },
    onProgress: function (progressData) {
        console.log(JSON.stringify(progressData));
    },
};

cos.sliceUploadFile(params, function(err, data) {
    if(err) {
        console.log(err);
    } else {
        console.log(data);
    }
});

操作参数说明

回调函数说明

function(err, data) { ... }

回调参数说明

进度回调参数