接口介绍
用于查看存储空间（Bucket）的相关信息。
接口约束
无。
请求URI
GET /v1/bucketInfo/{bucket}
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名称 | testBucket |
Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bucketInfo | 是 | String | 固定参数 | - | - |
注意：如果query中的参数为固定参数，不需要带值value。
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| BucketInfo | 是 | Array of Objects | 保存Bucket信息的容器。 | BucketInfo |
表 BucketInfo
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Bucket | 是 | Array of Objects | 保存Bucket信息的容器。 | Bucket |
表 Bucket
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| CreationDate | 是 | String | Bucket的创建时间，格式为UTC时间。 | 2013-07-31T10:56:21.000Z | |
| ExtranetEndpoint | 是 | String | Bucket的外网域名。 | oss-cn-shanghai.ctyun.1com | |
| Name | 是 | String | Bucket名称。 | example | |
| Owner | 是 | Array of Objects | 存放Bucket拥有者信息的容器。 | Owner | |
| AccessControlList | 是 | Array of Objects | Bucket读写权限（ACL）信息的容器。 | AccessControlList |
表 Owner
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ID | 是 | String | Bucket拥有者的用户ID。 | 11111 | ｜ |
| DisplayName | 是 | String | Bucket拥有者的名称（目前和用户ID一致）。 | username |
表 AccessControlList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Grant | 是 | String | Bucket的ACL权限。 | private |
请求示例
GET /v1/testBucket?bucketInfo HTTP/1.1
请求头header
无
请求体body
无
响应示例
HTTP/1.1 200
x-oss-request-id: 534B371674E88A4D8906****
Date: Sat, 12 Sep 2015 07:51:28 GMT
Connection: keep-alive
Content-Length: 531
<?xml version="1.0" encoding="UTF-8"?>
<BucketInfo>
<Bucket>
<CreationDate>2023-04-12T04:38:15.689Z</CreationDate>
<ExtranetEndpoint>xxx.ctyun.1store</ExtranetEndpoint>
<Name>new_bucket_test</Name>
<Owner>
<ID>test</ID>
<DisplayName>test</DisplayName>
</Owner>
<AccessControlList>
<Grant>private</Grant>
</AccessControlList>
</Bucket>
</BucketInfo>
状态码
| 状态码 | 错误码 | 描述 |
|---|---|---|
| 200 | 操作成功。 | |
| 403 | AccessDenied | 用户没有权限执行操作。 |
| 404 | NoSuchBucket | 操作指定的桶不存在。 |
