ListVectorBuckets API 呼び出しによるベクトルバケットの一覧表示 - OSS - Alibaba Cloud - Object Storage Service

権限

デフォルトでは、Alibaba Cloud アカウントはそのリソースに対する完全な権限を持ちます。RAM ユーザーおよび RAM ロールは、デフォルトでは権限を持ちません。RAM ユーザーまたは RAM ロールがこの API を呼び出せるようにするには、Alibaba Cloud アカウントまたは RAM 管理者が、RAM ポリシーまたはバケットポリシーを使用して、RAM ユーザーまたは RAM ロールに必要な権限を付与する必要があります。

API	アクション	説明
ListVectorBuckets	`oss:ListVectorBuckets`	ベクターバケットを一覧表示します。

リクエスト構文

GET / HTTP/1.1
Host: cn-hangzhou-internal.oss-vectors.aliyuncs.com
Date: GMT Date
Authorization: SignatureValue

リクエストヘッダー

この API は、共通のリクエストヘッダーのみを使用します。詳細については、「共通HTTPヘッダー」をご参照ください。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
prefix	文字列	いいえ	my	返されるベクターバケット名の先頭に必要なプレフィックスを指定します。
marker	文字列	いいえ	mybucket	結果セットの開始位置を指定します。クエリにより、指定されたマーカーの直後のエントリーから、アルファベット順にベクターバケットが返されます。
max-keys	数値	いいえ	100	返されるベクターバケットの最大数を指定します。有効な値： 1～1000。デフォルト値： 100。

レスポンスヘッダー

この API は、共通のレスポンスヘッダーのみを使用します。詳細については、「共通HTTPヘッダー」をご参照ください。

レスポンス要素

説明

ListVectorBuckets API を呼び出すとき、すべてのバケットが返される場合、レスポンスには Prefix、Marker、MaxKeys、IsTruncated、および NextMarker のレスポンス要素は含まれません。

パラメーター	タイプ	例	説明
ListAllMyBucketsResult	コンテナー	該当なし	ListVectorBuckets リクエストの結果を格納するコンテナーです。
Prefix	文字列	my	リクエストで指定されたプレフィックスです。親ノード：ListAllMyBucketsResult
Marker	文字列	mybucket	ListVectorBuckets クエリの開始位置です。親ノード：ListAllMyBucketsResult
MaxKeys	数値	10	レスポンスで返されるベクターバケットの最大数です。親ノード：ListAllMyBucketsResult
IsTruncated	ブール値	true	クエリのすべてのベクターバケットが返されたかどうかを示します。有効な値： true：すべてのベクターバケットが返されたわけではありません。 false：すべてのベクターバケットが返されます。親ノード：ListAllMyBucketsResult
NextMarker	文字列	mybucket10	IsTruncated が true の場合、この要素はベクターバケットの次のページのマーカーを示します。後続のListVectorBuckets リクエストでこの値を`marker` パラメーターに使用して、次のページを取得します。親ノード：ListAllMyBucketsResult
Buckets	コンテナー	該当なし	複数のベクターバケットに関する情報を格納するコンテナーです。親ノード：ListAllMyBucketsResult
Name	文字列	acs:ossvector:cn-shanghai:103735**********:test-bucket-3	ベクターバケットの識別子です。バケットの ARN が返されます。親ノード：Buckets
CreationDate	文字列	2014-02-07T18:12:43.000Z	ベクターバケットが作成された時刻です。親ノード：Buckets
ExtranetEndpoint	文字列	cn-shanghai.oss-vectors.aliyuncs.com	ベクターバケットのパブリックエンドポイントです。親ノード：Buckets
IntranetEndpoint	文字列	cn-shanghai-internal.oss-vectors.aliyuncs.com	ベクターバケットの内部エンドポイントです。親ノード：Buckets
Location	文字列	oss-cn-shanghai	OSS 固有のリージョン ID です。親ノード：Buckets
Region	文字列	cn-shanghai	汎用の Alibaba Cloud リージョン ID です。親ノード：Buckets

例

リクエストの例

GET /?prefix=my&marker=mybucket&max-keys=10 HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: cn-hangzhou-internal.oss-vectors.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

レスポンスの例

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-type: application/json
Content-Length: 545
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****

{
  "ListAllMyBucketsResult": {
    "Prefix": "my",
    "Marker": "mybucket",
    "MaxKeys": 10,
    "IsTruncated": true,
    "NextMarker": "mybucket10",
    "Buckets": [
        {
          "CreationDate": "2014-02-07T18:12:43.000Z",
          "ExtranetEndpoint": "cn-shanghai.oss-vectors.aliyuncs.com",
          "IntranetEndpoint": "cn-shanghai-internal.oss-vectors.aliyuncs.com",
          "Location": "oss-cn-shanghai",
          "Name": "acs:ossvector:cn-shanghai:103735**********:test-bucket-3",
          "Region": "cn-shanghai"
        },
        {
          "CreationDate": "2014-02-05T11:21:04.000Z",
          "ExtranetEndpoint": "cn-shanghai.oss-vectors.aliyuncs.com",
          "IntranetEndpoint": "cn-shanghai-internal.oss-vectors.aliyuncs.com",
          "Location": "oss-cn-shanghai",
          "Name": "acs:ossvector:cn-shanghai:103735**********:test-bucket-4",
          "Region": "cn-shanghai"
        }
    ]
  }
}

SDK

ListVectorBuckets API は、次のSDKを使用して呼び出すことができます。

ossutil コマンドラインツール

ListVectorBuckets API に対応するossutilコマンドの詳細については、「list-vector-buckets」をご参照ください。

エラーコード

エラーコード	HTTP ステータスコード	説明
AccessDenied	403	リクエストにユーザー認証情報がないため、匿名リクエストとして扱われます。