调用ListBucketSpaces接口列举Bucket Space

更新时间:
复制 MD 格式

调用ListBucketSpaces接口列举指定Agentic Bucket 名下的所有Bucket Space。

注意事项

  • 本接口使用Bucket级别Host,Host必须填写Agentic Bucket 完整名称,即{prefix}-{uid}-{region}-ab-apsr.oss-{region}.aliyuncs.com。

  • 实际返回的Bucket Space数量可能少于max-keys,客户端应根据IsTruncated判断是否需要继续翻页。

  • 如果Query中同时存在continuation-token与start-after,start-after不生效。

请求语法

GET /?agenticBucket&bucketSpace HTTP/1.1
Host: {prefix}-{uid}-{region}-ab-apsr.oss-{region}.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

请求头

此接口仅包含公共请求头。更多信息,请参见公共HTTP头定义。

请求参数

名称

类型

是否必选

示例值

描述

prefix

字符串

否

mybs

按Bucket Space名称前缀过滤列举结果。

continuation-token

字符串

否

不涉及

分页标记。首次请求不携带,后续请求携带上一页返回的NextContinuationToken。

start-after

字符串

否

mybs-a

指定从该名称之后按字母排序开始返回。如果continuation-token存在,该参数不生效。

max-keys

整数

否

100

限定此次返回Bucket Space的最大数量。默认值为100。

响应元素

名称

类型

示例值

描述

ListBucketSpacesResult

容器

不涉及

保存列举结果的容器。

父节点:无

子节点:Owner、BucketSpaces、Prefix、MaxKeys、ContinuationToken、NextContinuationToken、IsTruncated

Owner

容器

不涉及

Bucket拥有者信息的容器。

父节点:ListBucketSpacesResult

子节点:ID、DisplayName

ID

字符串

1234567890123456

Bucket拥有者的阿里云账号UID。

父节点:Owner

子节点:无

DisplayName

字符串

user

Bucket拥有者的名称(目前与UID一致)。

父节点:Owner

子节点:无

BucketSpaces

容器

不涉及

保存Bucket Space列表的容器。

父节点:ListBucketSpacesResult

子节点:BucketSpace

BucketSpace

容器

不涉及

保存单个Bucket Space信息的容器。

父节点:BucketSpaces

子节点:Name、Location、CreationDate、StorageClass

Name

字符串

my-agent-1234567890123456-cn-hangzhou-bs-apsr

Bucket Space完整名称。

父节点:BucketSpace

子节点:无

Location

字符串

oss-cn-hangzhou

Bucket Space所在地域。

父节点:BucketSpace

子节点:无

CreationDate

字符串

2026-06-18T08:00:00.000Z

创建时间(ISO8601格式)。

父节点:BucketSpace

子节点:无

StorageClass

字符串

Standard

存储类型,继承自Agentic Bucket 的默认配置。

父节点:BucketSpace

子节点:无

Prefix

字符串

mybs

本次查询使用的前缀过滤参数。

父节点:ListBucketSpacesResult

子节点:无

MaxKeys

整数

100

本次查询使用的每页最大返回数。

父节点:ListBucketSpacesResult

子节点:无

ContinuationToken

字符串

不涉及

本次请求携带的分页标记。

父节点:ListBucketSpacesResult

子节点:无

NextContinuationToken

字符串

不涉及

下一页的分页标记。仅当IsTruncated为true时返回。

父节点:ListBucketSpacesResult

子节点:无

IsTruncated

布尔型

false

是否有更多Bucket Space未返回。true表示后续还有数据,需继续翻页。

父节点:ListBucketSpacesResult

子节点:无

示例

  • 请求示例

    GET /?agenticBucket&bucketSpace HTTP/1.1
    Host: my-uid-region-ab-apsr.oss-cn-hangzhou.aliyuncs.com
    Date: Thu, 17 Apr 2025 15:39:12 GMT
    Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
  • 返回示例

    HTTP/1.1 200 OK
    x-oss-request-id: 5C1B138A109F4E405B2D
    Date: Mon, 26 Jul 2021 13:08:38 GMT
    Content-Type: application/xml
    Content-Length: 486
    Connection: keep-alive
    Server: AliyunOSS
    
    <?xml version="1.0" encoding="UTF-8"?>
    <ListBucketSpacesResult>
        <Owner>
            <ID>1234567890123456</ID>
            <DisplayName>user</DisplayName>
        </Owner>
        <BucketSpaces>
            <BucketSpace>
                <Name>my-agent-1234567890123456-cn-hangzhou-bs-apsr</Name>
                <Location>oss-cn-hangzhou</Location>
                <CreationDate>2026-06-18T08:00:00.000Z</CreationDate>
                <StorageClass>Standard</StorageClass>
            </BucketSpace>
        </BucketSpaces>
        <Prefix></Prefix>
        <MaxKeys>100</MaxKeys>
        <ContinuationToken></ContinuationToken>
        <NextContinuationToken></NextContinuationToken>
        <IsTruncated>false</IsTruncated>
    </ListBucketSpacesResult>

错误码

错误码

HTTP状态码

描述

AgenticBucketNotFound

404

Agentic Bucket 不存在。

AccessDenied

403

没有权限查看该Agentic Bucket 下的Bucket Space。