简介
查询文档预览开通状态功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于查询文档预览开通状态的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.1.1。
API | 操作描述 |
用于查询已经开通文档预览功能的 Bucket |
查询文档预览开通状态
功能说明
本接口用于查询已经开通文档预览功能的 Bucket
使用示例
function describeDocProcessService() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `docbucket` //const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Query: {// 地域信息,以“,”分隔字符串,支持 All、ap-shanghai、ap-beijing;是否必传:否regions: "",// 存储桶名称,以“,”分隔,支持多个存储桶,精确搜索;是否必传:否bucketNames: "",// 存储桶名称前缀,前缀搜索;是否必传:否bucketName: "",// 第几页;是否必传:否pageNumber: "",// 每页个数;是否必传:否pageSize: "",},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describeDocProcessService()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:docbucket | String | 是 |
Query | 请求参数 | Object | 否 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
regions | 地域信息,以“,”分隔字符串,支持 All、ap-shanghai、ap-beijing | String | 否 |
bucketNames | 存储桶名称,以“,”分隔,支持多个存储桶,精确搜索 | String | 否 |
bucketName | 存储桶名称前缀,前缀搜索 | String | 否 |
pageNumber | 第几页 | String | 否 |
pageSize | 每页个数 | 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 |