文档服务 查询文档处理开通状态

该文档描述了腾讯云数据万象服务中用于查询已开通文档预览功能的存储桶列表的接口。内容包括接口功能、授权要求、服务开通步骤、使用限制、请求与响应的详细格式说明,以及实际案例演示。功能描述:接口用于查询已开通文档预览功能的Bucket列表。授权说明:子账号需添加ci:DescribeDocProcessBucket权限,相关操作接口参考CI action文档。服务开通:需先绑定存储桶并开通数据万象服务,解绑后将无法使用该功。

相关产品
文档服务 产品页,含版本规格、价格与购买入口。

一、功能描述

该接口用于查询已经开通文档预览功能的 Bucket列表。

二、授权说明

通过子账号使用时,需要在 授权策略 的 action 中添加 ci:DescribeDocProcessBucket 权限。数据万象支持的所有操作接口请参见 CI action。

三、服务开通

使用该功能需提前 绑定存储桶,开通数据万象服务。

注意:数据万象绑定后,如果你手动对存储桶进行数据万象的解绑操作,将无法继续使用该功能。

四、使用限制

使用该接口时,请先确认相关限制条件。详情请参见 使用限制。

五、请求示例

GET /docbucket?pageNumber=1&pageSize=2 HTTP/1.1Host: ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>

注意:说明:

注意:Authorization: Auth String,详情请参见 请求签名 文档。

六、请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

七、请求体

该请求的请求体为空。

八、请求参数

名称 描述 类型 是否必选
regions 地域信息,以,分隔字符串,例如:ap-shanghai,ap-beijing string 否
bucketNames 存储桶名称,以,分隔,支持多个存储桶,精确搜索 string 否
bucketName 存储桶名称前缀,前缀搜索 string 否
pageNumber 第几页(默认第一页) string 否
pageSize 每页个数(默认十条) string 否

九、响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

十、响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:

<Response> <TotalCount>2</TotalCount> <RequestId>RequestId</RequestId> <PageNumber>1</PageNumber> <PageSize>2</PageSize> <DocBucketList> <Name>BucketName-APPID</Name> <CreateTime>Time</CreateTime> <Region>Region</Region> <AliasBucketId/> <BucketId>BucketName-APPID</BucketId> </DocBucketList></Response>

具体的数据内容如下:

节点名称(关键字) 父节点 描述 类型
Response 无 保存结果的容器 Container

Container 节点 Response 的内容:

节点名称(关键字) 父节点 描述 类型
RequestId Response 请求的唯一 ID String
TotalCount Response 文档预览 Bucket 总数 Int
PageNumber Response 当前页数,同请求中的 pageNumber Int
PageSize Response 每页个数,同请求中的 pageSize Int
DocBucketList Response 文档预览 Bucket 列表 Container

Container 节点 DocBucketList 的内容:

节点名称(关键字) 父节点 描述 类型
BucketId Response.DocBucketList 存储桶 ID String
Name Response.DocBucketList 存储桶名称,同 BucketId String
Region Response.DocBucketList 所在的地域 String
CreateTime Response.DocBucketList 创建时间 String
AliasBucketId Response.DocBucketList 存储桶别名 String

十一、错误码

该请求无特有错误信息,常见的错误信息请参见 错误码 文档。

十二、请求

GET /docbucket?regions=ap-chongqing HTTP/1.1Connection: keep-aliveAccept-Encoding: gzip, deflateAccept: */*User-Agent: cos-python-sdk-v5.3.2Host: ci.ap-chongqing.myqcloud.comContent-Type: application/xmlAuthorization: Authorization

十三、响应

HTTP/1.1 200 OKDate: Mon, 27 Jul 2020 07:00:43 GMTContent-Type: application/xmlContent-Length: 843Connection: keep-aliveServer: tencent-cix-ci-request-id: NWYxZTdiOWJfYzc2OTQzNjRfM2Qz****<?xml version="1.0" encoding="utf-8"?><Response> <TotalCount>2</TotalCount> <RequestId>NWYxZTdiOWJfYzc2OTQzNjRfM2Qz****</RequestId> <PageNumber>1</PageNumber> <PageSize>10</PageSize> <DocBucketList> <Name>examplebucket-1250000000</Name> <CreateTime>2020-07-27T10:54:42+0800</CreateTime> <Region>ap-chongqing</Region> <AliasBucketId/> <BucketId>examplebucket-1250000000</BucketId> </DocBucketList> <DocBucketList> <Name>examplebucket-1250000000</Name> <CreateTime>2020-07-24T22:42:26+0800</CreateTime> <Region>ap-chongqing</Region> <AliasBucketId/> <BucketId>examplebucket-1250000000</BucketId> </DocBucketList></Response>

赞 (0)
上一篇 5天前
下一篇 5天前