函数说明
describebucket(bucket=None, offset=0, limit=10, header=None, projectid=None)
获取空间的信息
Parameters
- bucketname – string类型, 空间名称，如果为空，则获取当前项目下所有的bucket信息
- offset – integer类型, 起始空间编码，当提供空间名时无效
- limit – integer类型，获取空间数量，当提供具体空间名时无效
- projectid – string类型，项目ID。不填写则为默认项目，若指定的BucketName在子帐号下则必须填写。 请参考GetProjectList接口
- header – dict类型，http 请求header，键值对类型分别为string，比如{'User-Agent': 'Google Chrome'}
Returns
-
ret: 如果http状态码为[200, 204, 206]之一则返回None，否则如果服务器返回json信息则返回dict类型，键值对类型分别为string, unicode string类型，否则返回空的dict
-
ResponseInfo: 响应的具体信息，UCloud UFile 服务器返回信息或者网络链接异常
ResponseInfo Elements
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | int | 返回状态码，为 0 则为成功返回，非 0 为失败 | Yes |
| Action | string | 操作指令名称 | Yes |
| Message | string | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 |
No |
| DataSet | array[UFileBucketSet] | Bucket的描述信息 参数见 UFileBucketSet | No |
UFileBucketSet
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Region | string | Bucket所属地域 | No |
| BucketName | string | Bucket名称 | No |
| BucketId | string | Bucket的ID | No |
| Domain | UFileDomainSet | Bucket的域名集合 参数见 UFileDomainSet | No |
| CdnDomainId | array[string] | 与Bucket关联的CND加速域名的ID列表 | No |
| Type | string | Bucket访问类型 | No |
| CreateTime | int | Bucket的创建时间 | No |
| ModifyTime | int | Bucket的修改时间 | No |
| Biz | string | Bucket所属业务, general或vod或udb general: 普通业务； vod: 视频云业务; udb: 云数据库业务 | No |
| Tag | string | 所属业务组 | No |
| HasUserDomain | int | 是否存在自定义域名。0不存在，1存在，2错误 | No |
UFileDomainSet
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Src | array[string] | 源站域名 | No |
| Cdn | array[string] | UCDN加速域名 | No |
| CustomSrc | array[string] | 用户自定义源站域名 | No |
| CustomCdn | array[string] | 用户自定义CDN加速域名 | No |
代码示例
1
2
3
4
5
6
7
8
9
10
11
12
public_key = '' #账户公钥
private_key = '' #账户私钥
from ufile import bucketmanager
bucketmanager_handler = bucketmanager.BucketManager(public_key, private_key)
# 获取bucket信息
bucketname = '' # 待查询的空间名称
ret, resp = bucketmanager_handler.describebucket(bucketname)
print(ret)