简介
本文档提供关于极智压缩的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.5.0。
API | 操作描述 |
开通当前存储桶的图片极智压缩功能 | |
该接口用于查询图片极智压缩功能的状态 | |
该接口用于关闭图片极智压缩功能 | |
图片压缩指在图片质量保持不变的情况,尽可能的减小图片大小,以达到节省图片存储空间、减少图片访问流量、提升图片访问速度的效果 |
开通极智压缩
功能说明
开通当前存储桶的图片极智压缩功能
使用示例
function openImageSlim() {// 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({// 极智压缩配置信息ImageSlim: {// 极智压缩的使用模式,包含两种:API:开通极智压缩的 API 使用方式,开通后可在图片下载时通过极智压缩参数对图片进行压缩;Auto:开通极智压缩的自动使用方式,开通后无需携带任何参数,存储桶内指定格式的图片将在访问时自动进行极智压缩。注意:支持同时开通两种模式,多个值通过逗号分隔。SlimMode: "Auto,API",// 当SlimMode的值包含Auto时生效,用于指定需要自动进行压缩的图片格式。Suffixs: {// 需要自动进行压缩的图片格式,可选值:jpg、png。Suffix: "jpg",}}})cos.request({Method: 'PUT', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Action: 'image-slim', // 固定值Body: body, // 请求体参数,必须ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}openImageSlim()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:PUT | String | 是 |
Url | 请求url,固定值 | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南
查询极智压缩状态
功能说明
该接口用于查询图片极智压缩功能的状态
使用示例
function describeImageSlim() {// 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: 'image-slim', // 固定值},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describeImageSlim()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南
关闭极智压缩
功能说明
该接口用于关闭图片极智压缩功能
使用示例
function closeImageSlim() {// 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: 'DELETE', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Action: 'image-slim'// 固定值},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}closeImageSlim()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:DELETE | String | 是 |
Url | 请求url,固定值 | String | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南
通过API使用极智压缩
功能说明
图片压缩指在图片质量保持不变的情况,尽可能的减小图片大小,以达到节省图片存储空间、减少图片访问流量、提升图片访问速度的效果。
使用示例
function imageSlim() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const ObjectKey = "test.jpeg";const key = `${ObjectKey}` // ObjectKey:{ObjectKey};const host = `${config.Bucket}.cos.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Action: 'imageSlim'// 固定值},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}imageSlim()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | {ObjectKey} | String | 是 |
回调函数说明
function(err, data) { ... }
参数名称 | 参数描述 | 类型 |
err | Object | |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
data | 请求成功时返回的对象,如果请求发生错误,则为空 | Object |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
- Response | Object |
相关链接
API 文档
功能指南