查询文档预览开通状态

最近更新时间:2024-07-26 11:33:42

我的收藏

简介

本文档提供关于查询文档预览开通状态的 API 概览以及 SDK 示例代码。
API
说明
用于查询存储桶是否已开通文档预览功能

查询文档预览开通状态

功能说明

用于查询存储桶是否已开通文档预览功能。

示例代码

function describeDocProcessBuckets() {
var config = {
// 需要替换成您自己的存储桶信息
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
var host = 'ci.' + config.Region + '.myqcloud.com/docbucket';
var url = 'https://' + host;
cos.request({
Method: 'GET',
Key: 'docbucket',
Url: url,
Query: {
// regions: '', /* 非必须,地域信息,以“,”分隔字符串,支持 All、ap-shanghai、ap-beijing */
// bucketNames: '', /* 非必须,存储桶名称,以“,”分隔,支持多个存储桶,精确搜索 */
// bucketName: '', /* 非必须,存储桶名称前缀,前缀搜索 */
// pageNumber: '1', /* 非必须,第几页 */
// pageSize: '20', /* 非必须,每页个数 */
},
},
function(err, data){
console.log(err || data);
});
}
describeDocProcessBuckets();

参数说明

参数名称
描述
类型
regions
地域信息,例如 ap-shanghai、ap-beijing,若查询多个地域以“,”分隔字符串,支持中国大陆地域,详情请参见 地域与域名
string
bucketNames
存储桶名称,以“,”分隔,支持多个存储桶,精确搜索
string
bucketName
存储桶名称前缀,前缀搜索
string
pageNumber
第几页
int
pageSize
每页个数
int

返回结果说明

参数名称
描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Response
-
Object
- - RequestId
请求的唯一 ID
string
- - TotalCount
文档预览 Bucket 总数
string
- - PageNumber
当前页数,同请求中的 pageNumber
string
- - PageSize
每页个数,同请求中的 pageSize
string
- - DocBucketList
文档预览 Bucket 列表
Array
- - - BucketId
存储桶 ID
string
- - - Name
存储桶名称,同 BucketId
string
- - - Region
所在的地域
string
- - - CreateTime
创建时间
string
- - - AliasBucketId
存储桶别名
string