简介
本文档提供关于图片样式的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.5.0。
增加样式
功能说明
该接口用于对某一个存储桶设置样式功能,设置样式后,可以方便地对图片进行统一的处理。
使用示例
function addImageStyle() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `` //const host = `${config.Bucket}.pic.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({AddStyle: {// 样式名称;是否必传:是StyleName: "test",// 样式详情;是否必传:是StyleBody: "imageMogr2/thumbnail/!50px",}});cos.request({Method: 'PUT', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Action: 'style', // 固定值Body: body,ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}addImageStyle()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:PUT | String | 是 |
Url | 请求url,固定值 | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
function(err, data) { ... }
相关链接
查询样式
功能说明
用于查询该 Bucket 下已有的图片样式。若不使用请求体,则查询该 Bucket 下的全部图片样式,若使用请求体,则查询请求体中指定的图片样式。
使用示例
function describeImageStyles() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `` //const host = `${config.Bucket}.pic.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Action: 'style', // 固定值Query: {GetStyle: {// 查询的图片样式名称。;是否必传:否StyleName: "test",}},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describeImageStyles()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Query | 请求参数 | Object | 否 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
GetStyle | 查询图片样式名称的容器 | Object | 否 |
GetStyle 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
StyleName | 查询的图片样式名称 | String | 否 |
回调函数说明
function(err, data) { ... }
相关链接
删除样式
功能说明
用于删除指定的图片样式
使用示例
function deleteImageStyle() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `` //const host = `${config.Bucket}.pic.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({DeleteStyle: {// 样式名称;是否必传:是StyleName: "test",}});cos.request({Method: 'DELETE', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Action: 'style', // 固定值Body: body,ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}deleteImageStyle()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:DELETE | String | 是 |
Url | 请求url,固定值 | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
function(err, data) { ... }
相关链接