简介
本文档提供关于图片样式接口的 API 概览以及 SDK 示例代码。
注意:
COS Node.js SDK 版本需要大于等于 v2.12.6。
增加图片样式
功能说明
用于对某一个存储桶设置样式功能,设置样式后,可以方便地对图片进行统一的处理。
示例代码
function addImageStyle() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var host = config.Bucket + '.pic.' + config.Region + '.myqcloud.com/?style';var url = 'https://' + host;var body = COS.util.json2xml({AddStyle: {StyleName: 'style_name1', // 必须,样式名称StyleBody: 'imageMogr2/thumbnail/!50px', // 必须,样式详情}});cos.request({Method: 'PUT',Url: url,Body: body,ContentType: 'application/xml',},function(err, data){console.log(err || data);});}addImageStyle();
参数说明
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
AddStyle | 无 | 待添加的样式信息 | Container | 是 |
Container 节点 AddStyle 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
StyleName | AddStyle | 样式名称 | string | 是 |
StyleBody | AddStyle | 样式详情 | string | 是 |
返回结果说明
查询图片样式
功能说明
用于查询该 Bucket 下已有的样式。若不使用请求体,则查询该 Bucket 下的全部样式,若使用请求体,则查询请求体中携带的样式名信息。
示例代码
function describeImageStyles() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var host = config.Bucket + '.pic.' + config.Region + '.myqcloud.com/?style';var url = 'https://' + host;cos.request({Method: 'GET',Url: url,Query: {// "style-name": 'style_name', // 非必填,样式名称},},function(err, data){console.log(err || data);});}describeImageStyles();
参数说明
请求参数描述如下:
参数名称 | 描述 | 是否必选 |
style-name | 查询的样式名称 | 否 |
返回结果说明
删除图片样式
功能说明
用于删除某一特定样式。
示例代码
function deleteImageStyle() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var host = config.Bucket + '.pic.' + config.Region + '.myqcloud.com/?style';var url = 'https://' + host;var body = COS.util.json2xml({DeleteStyle: {StyleName: 'style_name1', // 必须,样式名称}});cos.request({Method: 'DELETE',Url: url,Body: body,ContentType: 'application/xml',},function(err, data){console.log(err || data);});}deleteImageStyle();
参数说明
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
DeleteStyle | 无 | 待删除的样式信息 | Container | 是 |
Container 节点 DeleteStyle 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
StyleName | AddStyle | 样式名称 | string | 是 |
返回结果说明