查询文件处理服务

最近更新时间:2024-11-06 15:18:22

我的收藏

功能描述

本接口用于查询已经开通文件处理功能的存储桶。


授权说明

授权策略中 action 设置为 ci:DescribeFileProcessBucket 。查看所有 action

服务开通

使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶
使用该功能需提前通过控制台或接口开通文件处理服务 。详情请参见 开通文件处理服务

使用限制

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

请求

请求示例

GET /file_bucket HTTP/1.1
Host: ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
说明:
Authorization: Auth String(详情请参见 请求签名 文档)。
通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

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

请求体

该请求的请求体为空。

请求参数

名称
描述
默认值
是否必填
regions
地域信息,例如 ap-shanghai、ap-beijing,若查询多个地域以“,”分隔字符串,详情请参见 地域与域名
bucketNames
存储桶名称,以“,”分隔,支持多个存储桶,精确搜索
bucketName
存储桶名称前缀,前缀搜索
pageNumber
第几页
1
pageSize
每页个数,大于0且小于等于100的整数
10

响应

响应头

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

响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<TotalCount>2</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<FileBucketList>
<BucketId>examplebucket-1250000000</BucketId>
<Name>examplebucket-1250000000</Name>
<Region>ap-beijing</Region>
<CreateTime>2019-11-15T12:12:12+0800</CreateTime>
</FileBucketList>
<FileBucketList>
<BucketId>examplebucket-1-1250000000</BucketId>
<Name>examplebucket-1-1250000000</Name>
<Region>ap-chongqing</Region>
<CreateTime>2020-11-16T14:13:15+0800</CreateTime>
</FileBucketList>
</Response>
具体的数据内容如下:
节点名称(关键字)
父节点
描述
类型
Response
保存结果的容器
Container
Container 节点 Response 的内容:
节点名称(关键字)
父节点
描述
类型
RequestId
Response
请求的唯一 ID
String
TotalCount
Response
开通文件处理的 Bucket 总数
Int
PageNumber
Response
当前页数,同请求中的 pageNumber
Int
PageSize
Response
每页个数,同请求中的 pageSize
Int
FileBucketList
Response
文件处理 Bucket 详情
Container 数组
Container 节点 FileBucketList 的内容:
节点名称(关键字)
父节点
描述
类型
BucketId
Response.FileBucketList
存储桶 ID
String
Name
Response.FileBucketList
存储桶名称,同 BucketId
String
Region
Response.FileBucketList
所在的地域
String
CreateTime
Response.FileBucketList
创建时间
String

错误码

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

实际案例

请求

GET /file_bucket HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=*****************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************************
Host: ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 15 Jun 2021 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<TotalCount>2</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<FileBucketList>
<BucketId>examplebucket-1250000000</BucketId>
<Name>examplebucket-1250000000</Name>
<Region>ap-beijing</Region>
<CreateTime>2019-11-15T12:12:12+0800</CreateTime>
</FileBucketList>
<FileBucketList>
<BucketId>examplebucket-1-1250000000</BucketId>
<Name>examplebucket-1-1250000000</Name>
<Region>ap-chongqing</Region>
<CreateTime>2020-11-16T14:13:15+0800</CreateTime>
</FileBucketList>
</Response>