API の概要 - Object Storage Service - Alibaba Cloud ドキュメントセンター

このトピックでは、Object Storage Service (OSS) の API の概要を説明します。OSS の基本概念とリソースモデルを理解し、必要な API を素早く見つけるのに役立ちます。カスタム開発の場合、本番環境ではソフトウェア開発キット (SDK) を使用してください。SDK は、署名、リトライ、同時実行数などの複雑なロジックをカプセル化しています。このトピックは、SDK の基盤となる実装のリファレンスとして機能し、高度なカスタマイズや通信メカニズムの理解に役立ちます。

開始する前に、次の点にご注意ください。

API 呼び出しは、制限事項に準拠する必要があります。
API を使用する前に、OSS の課金方法を理解していることを確認してください。料金の詳細については、「OSS 料金」をご参照ください。

クイックスタート：最初の API の呼び出し

このセクションでは、バケットの作成 (PutBucket) を例に、API 呼び出しを行う完全なプロセスを説明します。

1. 事前準備

開始する前に、次の情報を取得してください。

AccessKey：セキュリティのため、匿名アクセスリクエストを除くすべての OSS API リクエストは、認証のために署名される必要があります。OSS は、AccessKey ID と AccessKey Secret から構成される AccessKey ペアに基づく署名メカニズムを使用してリクエストを検証します。署名情報は、HTTP リクエストヘッダーの Authorization フィールドに含める必要があります。署名の計算方法の詳細については、「署名バージョン 4 (推奨)」をご参照ください。
エンドポイント：API リクエストは、宛先バケットが配置されているリージョンのエンドポイントに送信する必要があります。エンドポイントは、OSS サービスのアクセスアドレスです。さまざまなリージョンのエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。

2. リクエストの構築と送信

PUT / HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Thu, 17 Apr 2025 03:15:40 GMT
x-oss-acl: private
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
<?xml version="1.0" encoding="UTF-8"?>
<CreateBucketConfiguration>
    <StorageClass>Standard</StorageClass>
    <DataRedundancyType>LRS</DataRedundancyType>    
</CreateBucketConfiguration>

3. レスポンスの理解

成功レスポンス：リクエストが成功した場合、サーバーは 2xx ステータスコードを返します。コンテンツを返す操作の場合、レスポンスボディは XML 形式です。
```
HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Fri, 24 Feb 2017 03:15:40 GMT
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS
Location: /oss-example
```
エラー処理：リクエストが失敗した場合、サーバーは 4xx または 5xx ステータスコードを返します。レスポンスボディも XML 形式で、特定のエラーコード (Code) とエラーメッセージ (Message) が含まれています。詳細については、「エラーコード」を参照して問題をトラブルシューティングしてください。

API リスト

サービス操作

API	説明
ListBuckets (GetService)	リクエスタが所有するすべてのバケットを返します。
ListUserDataRedundancyTransition	リクエスタのすべてのデータ冗長性移行タスクをリストします。

リージョン操作

API	説明
DescribeRegions	サポートされているすべてのリージョンまたは指定されたリージョンのエンドポイントを照会します。

バケット操作

分類	API	説明
基本操作	PutBucket	バケットを作成します。
	DeleteBucket	バケットを削除します。
	ListObjects (GetBucket)	バケット内のすべてのオブジェクトに関する情報をリストします。
	ListObjectsV2 (GetBucketV2)	バケット内のすべてのオブジェクトに関する情報をリストします。
	GetBucketInfo	バケット情報を照会します。
	GetBucketLocation	バケットの場所を照会します。
	GetBucketStat	バケットのストレージ使用量とオブジェクト数を照会します。
保持ポリシー	InitiateBucketWorm	保持ポリシーを作成します。
	AbortBucketWorm	ロックされていない保持ポリシーを削除します。
	CompleteBucketWorm	保持ポリシーをロックします。
	ExtendBucketWorm	保持ポリシーがロックされているバケット内のオブジェクトの保持期間を延長します。
	GetBucketWorm	バケットの保持ポリシーを照会します。
アクセス制御	PutBucketAcl	バケットのアクセス権限を設定します。
アクセス制御	GetBucketAcl	バケットのアクセス権限を照会します。
ライフサイクル	PutBucketLifecycle	バケット内のオブジェクトのライフサイクルルールを設定します。
	GetBucketLifecycle	バケット内のオブジェクトのライフサイクルルールを照会します。
	DeleteBucketLifecycle	バケット内のオブジェクトのライフサイクルルールを削除します。
転送アクセラレーション	PutBucketTransferAcceleration	バケットの転送アクセラレーションを設定します。
転送アクセラレーション	GetBucketTransferAcceleration	バケットの転送アクセラレーション設定を照会します。
バージョン管理	PutBucketVersioning	バケットのバージョン管理状態を設定します。
	GetBucketVersioning	バケットのバージョン管理状態を照会します。
	ListObjectVersions (GetBucketVersions)	バケット内のすべてのオブジェクトのバージョンをリストします。
クロスリージョンレプリケーション	PutBucketReplication	バケットのデータレプリケーションルールを設定します。
	PutBucketRTC	既存のクロスリージョンレプリケーションルールに対してレプリケーション時間制御 (RTC) を有効または無効にします。
	GetBucketReplication	バケットに設定されているデータレプリケーションルールを照会します。
	GetBucketReplicationLocation	データをレプリケーションできる宛先リージョンを照会します。
	GetBucketReplicationProgress	バケットのデータレプリケーションの進捗を照会します。
	DeleteBucketReplication	データレプリケーションタスクを停止し、バケットのレプリケーション設定を削除します。
認可ポリシー	PutBucketPolicy	バケットポリシーを設定します。
	GetBucketPolicy	バケットポリシーを照会します。
	GetBucketPolicyStatus	現在のバケットポリシーがパブリックアクセスを許可しているかどうかを確認します。
	DeleteBucketPolicy	バケットポリシーを削除します。
インベントリ	PutBucketInventory	バケットのインベントリルールを設定します。
	GetBucketInventory	バケット内の指定されたインベントリタスクを照会します。
	ListBucketInventory	バケット内のすべてのインベントリタスクを照会します。
	DeleteBucketInventory	バケットから指定されたインベントリタスクを削除します。
ログ管理	PutBucketLogging	バケットのアクセスログ記録機能を有効にします。
	GetBucketLogging	バケットのアクセスログ設定を照会します。
	DeleteBucketLogging	バケットのアクセスログ記録機能を無効にします。
	PutUserDefinedLogFieldsConfig	バケットのリアルタイムログの `user_defined_log_fields` フィールドを設定します。
	GetUserDefinedLogFieldsConfig	バケットのリアルタイムログの `user_defined_log_fields` フィールドの設定を照会します。
	DeleteUserDefinedLogFieldsConfig	バケットのリアルタイムログの `user_defined_log_fields` フィールドの設定を削除します。
静的 Web サイト	PutBucketWebsite	バケットを静的 Web サイトホスティングモードに設定します。
	GetBucketWebsite	バケットの静的 Web サイトホスティング状態を照会します。
	DeleteBucketWebsite	バケットの静的 Web サイトホスティングモードを無効にします。
ホットリンク保護	PutBucketReferer	バケットのホットリンク保護ルールを設定します。
ホットリンク保護	GetBucketReferer	バケットのホットリンク保護ルールを照会します。
タグ	PutBucketTags	バケットタグを追加または変更します。
	GetBucketTags	バケットタグを照会します。
	DeleteBucketTags	バケットタグを削除します。
暗号化	PutBucketEncryption	バケットの暗号化ルールを設定します。
	GetBucketEncryption	バケットの暗号化ルールを照会します。
	DeleteBucketEncryption	バケットの暗号化ルールを削除します。
リクエスタ支払い	PutBucketRequestPayment	バケットをリクエスタ支払いモードに設定します。
リクエスタ支払い	GetBucketRequestPayment	バケットのリクエスタ支払い設定を照会します。
オリジン間リソース共有 (CORS)	PutBucketCors	指定されたバケットのオリジン間リソース共有 (CORS) ルールを設定します。
	GetBucketCors	指定されたバケットの現在の CORS ルールを照会します。
	DeleteBucketCors	指定されたバケットの CORS 機能を無効にし、すべての CORS ルールをクリアします。
	Options	ブラウザがクロスオリジンリクエストを送信する前に、ソースオリジン、HTTP メソッド、ヘッダーなどの情報を含むプリフライトリクエスト (OPTIONS) を OSS に送信し、実際のリクエストを送信するかどうかを決定します。
アクセス追跡	PutBucketAccessMonitor	バケットのアクセス追跡状態を設定します。
アクセス追跡	GetBucketAccessMonitor	バケットのアクセス追跡状態を照会します。
データインデックス	OpenMetaQuery	バケットのメタデータ管理機能を有効にします。
	GetMetaQueryStatus	指定されたバケットのメタデータインデックスライブラリを照会します。
	DoMetaQuery	指定された条件を満たすオブジェクトを照会し、指定されたフィールドとソート方法に基づいてオブジェクト情報をリストします。
	CloseMetaQuery	バケットのメタデータ管理機能を無効にします。
DDoS 防御	InitUserAntiDDosInfo	Anti-DDoS for OSS インスタンスを作成します。
	UpdateUserAntiDDosInfo	Anti-DDoS for OSS インスタンスのステータスを変更します。
	GetUserAntiDDosInfo	指定されたアカウントに属する Anti-DDoS for OSS インスタンスに関する情報を照会します。
	InitBucketAntiDDosInfo	バケットの保護を初期化します。
	UpdateBucketAntiDDosInfo	バケットの保護ステータスを更新します。
	ListBucketAntiDDosInfo	バケットの保護情報のリストを照会します。
リソースグループ	PutBucketResourceGroup	バケットのリソースグループを設定します。
リソースグループ	GetBucketResourceGroup	バケットが属するリソースグループの ID を照会します。
カスタムドメイン名	CreateCnameToken	ドメイン名の所有権を検証するために必要な CNAME トークンを作成します。
	GetCnameToken	作成された CNAME トークンを照会します。
	PutCname	CNAME レコードをバケットにバインドします。
	ListCname	バケットにバインドされているすべての CNAME レコードのリストを照会します。
	DeleteCname	バインドされた CNAME レコードを削除します。
イメージスタイル	PutStyle	イメージスタイルを追加します。
	GetStyle	バケット内の指定されたイメージスタイルに関する情報を照会します。
	ListStyle	バケットに作成されたすべてのイメージスタイルを照会します。
	DeleteStyle	バケットから指定されたイメージスタイルを削除します。
トランスポート層セキュリティ	PutBucketHttpsConfig	バケットの TLS バージョン設定を有効または無効にします。
トランスポート層セキュリティ	GetBucketHttpsConfig	バケットの TLS バージョン設定を照会します。
冗長性移行	CreateBucketDataRedundancyTransition	データ冗長性移行タスクを作成します。
	GetBucketDataRedundancyTransition	データ冗長性移行タスクを照会します。
	DeleteBucketDataRedundancyTransition	データ冗長性移行タスクを削除します。
	ListUserDataRedundancyTransition	リクエスタのすべてのデータ冗長性移行タスクをリストします。
	ListBucketDataRedundancyTransition	バケット内のすべてのデータ冗長性移行タスクをリストします。
アクセスポイント	CreateAccessPoint	アクセスポイントを作成します。
	GetAccessPoint	アクセスポイントに関する情報を照会します。
	DeleteAccessPoint	アクセスポイントを削除します。
	ListAccessPoints	ユーザーレベルまたはバケットレベルのアクセスポイントに関する情報を照会します。
	PutAccessPointPolicy	アクセスポイントポリシーを設定します。
	GetAccessPointPolicy	アクセスポイントポリシーの設定を照会します。
	DeleteAccessPointPolicy	アクセスポイントポリシーを削除します。
Object FC アクセスポイント	CreateAccessPointForObjectProcess	Object FC アクセスポイントを作成します。
	GetAccessPointForObjectProcess	Object FC アクセスポイントの基本情報を照会します。
	DeleteAccessPointForObjectProcess	Object FC アクセスポイントを削除します。
	ListAccessPointsForObjectProcess	ユーザーレベルの Object FC アクセスポイントに関する情報を照会します。
	PutAccessPointConfigForObjectProcess	Object FC アクセスポイントの設定を変更します。
	GetAccessPointConfigForObjectProcess	Object FC アクセスポイントの設定を照会します。
	PutAccessPointPolicyForObjectProcess	Object FC アクセスポイントのアクセスポリシーを設定します。
	GetAccessPointPolicyForObjectProcess	Object FC アクセスポイントのアクセスポリシー設定を照会します。
	DeleteAccessPointPolicyForObjectProcess	Object FC アクセスポイントのアクセスポリシーを削除します。
	WriteGetObjectResponse	返されるデータとレスポンスヘッダーをカスタマイズします。
パブリックアクセスブロック	PutPublicAccessBlock	OSS のパブリックアクセスブロックをグローバルに有効にします。
	GetPublicAccessBlock	OSS のグローバルなパブリックアクセスブロック設定を照会します。
	DeletePublicAccessBlock	OSS のグローバルなパブリックアクセスブロック設定を削除します。
	PutBucketPublicAccessBlock	バケットのパブリックアクセスブロックを有効にします。
	GetBucketPublicAccessBlock	指定されたバケットのパブリックアクセスブロック設定を照会します。
	DeleteBucketPublicAccessBlock	指定されたバケットのパブリックアクセスブロック設定を削除します。
	PutAccessPointPublicAccessBlock	アクセスポイントのパブリックアクセスブロックを有効にします。
	GetAccessPointPublicAccessBlock	指定されたアクセスポイントのパブリックアクセスブロック設定を照会します。
	DeleteAccessPointPublicAccessBlock	指定されたアクセスポイントのパブリックアクセスブロック設定を削除します。
アーカイブオブジェクトのリアルタイムアクセス	PutBucketArchiveDirectRead	アーカイブオブジェクトのリアルタイムアクセスを有効または無効にします。
アーカイブオブジェクトのリアルタイムアクセス	GetBucketArchiveDirectRead	アーカイブオブジェクトのリアルタイムアクセスが有効になっているかどうかを照会します。
OSS アクセラレータ	PutBucketDataAccelerator	OSS アクセラレータを作成するか、その設定を変更します。
	GetBucketDataAccelerator	OSS アクセラレータに関する情報を照会します。
	DeleteBucketDataAccelerator	OSS アクセラレータを削除します。

オブジェクト操作

分類	API	説明
基本操作	PutObject	オブジェクトをアップロードします。
	GetObject	オブジェクトを照会します。
	CopyObject	オブジェクトをコピーします。
	AppendObject	追加アップロードを使用してオブジェクトをアップロードします。
	SealAppendObject	追加可能オブジェクトへのデータの追加を防ぎます。
	DeleteObject	単一のオブジェクトを削除します。
	DeleteMultipleObjects	複数のオブジェクトを削除します。
	HeadObject	オブジェクトのメタデータのみを返し、オブジェクトのコンテンツは返しません。
	GetObjectMeta	オブジェクトの ETag、サイズ、最終更新日時などの基本メタデータを返しますが、オブジェクトのコンテンツは返しません。
	PostObject	HTML フォームを使用してオブジェクトをアップロードします。
	Callback	OSS に送信するリクエストにコールバックパラメーターを含めることで、コールバックを実装できます。
	RestoreObject	アーカイブストレージ、コールドアーカイブストレージ、またはディープコールドアーカイブストレージオブジェクトを復元します。
	CleanRestoredObject	オブジェクトの復元状態を事前に終了します。
	SelectObject	オブジェクトファイルに対して SQL ステートメントを実行し、実行結果を返します。
	CreateSelectObjectMeta	オブジェクトファイルの総行数、総列数 (CSV ファイルの場合)、および分割数を照会します。
フォルダ管理	CreateDirectory	フォルダを作成します。
	Rename	フォルダまたはオブジェクトの名前を変更します。
	DeleteDirectory	フォルダを削除します。
マルチパートアップロード	InitiateMultipartUpload	マルチパートアップロードイベントを開始します。
	UploadPart	指定されたオブジェクト名とアップロード ID に基づいてデータをパート単位でアップロードします。
	UploadPartCopy	UploadPartCopy 操作を呼び出して、既存のオブジェクトからデータをコピーし、x-oss-copy-source リクエストヘッダーを UploadPart リクエストに追加してパートをアップロードします。
	CompleteMultipartUpload	ファイルのすべてのパートがアップロードされた後、CompleteMultipartUpload 操作を呼び出してファイルのマルチパートアップロードを完了する必要があります。
	AbortMultipartUpload	マルチパートアップロードイベントをキャンセルし、アップロードされたパートを削除します。
	ListMultipartUploads	進行中のすべてのマルチパートアップロードイベントをリストします。進行中のマルチパートアップロードイベントとは、開始されたが完了または中止されていないマルチパートアップロードイベントのことです。
	ListParts	指定されたアップロード ID に属する、正常にアップロードされたすべてのパートをリストします。
アクセス制御	PutObjectACL	オブジェクトのアクセス権限を変更します。
アクセス制御	GetObjectACL	オブジェクトのアクセス権限を照会します。
シンボリックリンク	PutSymlink	シンボリックリンクを作成します。
シンボリックリンク	GetSymlink	シンボリックリンクを照会します。
タギング	PutObjectTagging	オブジェクトタグを設定または更新します。
	GetObjectTagging	オブジェクトタグを照会します。
	DeleteObjectTagging	指定されたオブジェクトタグを削除します。

ベクターバケット操作

分類	API	説明
ベクターバケット	PutVectorBucket	ベクターバケットを作成します。
	GetVectorBucket	ベクターバケットの詳細を照会します。
	ListVectorBuckets	現在のアカウントに属するすべてのベクターバケットをリストします。
	DeleteVectorBucket	ベクターバケットを削除します。
インデックス	PutVectorIndex	ベクターバケットにベクターインデックスを作成します。
	GetVectorIndex	ベクターインデックスの詳細を照会します。
	ListVectorIndexes	ベクターバケット内のすべてのベクターインデックスをリストします。
	DeleteVectorIndex	すべてのデータパーツをアップロードした後、CompleteMultipartUpload API を呼び出して、マルチパートアップロードを完了させる必要があります。
ベクター	PutVectors	インデックスにベクトルデータを書き込みます。
	GetVectors	指定されたベクトルデータを照会します。
	ListVectors	ベクターインデックス内のすべてのベクトルデータをリストします。
	DeleteVectors	ベクターインデックスから指定されたベクトルデータを削除します。
	QueryVectors	ベクトル類似性検索を実行します。

リソースグループ QoS 操作

API	説明
PutBucketQoSInfo	リソースプール内のバケットのスロットリングを設定します。
GetBucketQoSInfo	リソースプール内のバケットのスロットリング設定を照会します。
DeleteBucketQosInfo	リソースプール内の指定されたバケットのスロットリング設定を削除します。
PutBucketRequesterQoSInfo	リクエスタのバケットレベルのスロットリングを設定します。
GetBucketRequesterQoSInfo	指定されたリクエスタのバケットレベルのスロットリング設定を照会します。
ListBucketRequesterQoSInfos	すべてのリクエスタのバケットレベルのスロットリング設定を照会します。
DeleteBucketRequesterQoSInfo	バケットに対するリクエスタのスロットリング設定を削除します。
ListResourcePools	現在のアカウントに属するすべてのリソースプールに関する情報を照会します。
GetResourcePoolInfo	指定されたリソースプールのスロットリング設定を照会します。
ListResourcePoolBuckets	指定されたリソースプールに含まれるバケットのリストを照会します。
PutResourcePoolRequesterQoSInfo	リソースプールのリクエスタのスロットリングを設定します。
GetResourcePoolRequesterQoSInfo	リソースプールの指定されたリクエスタのスロットリング設定を照会します。
ListResourcePoolRequesterQoSInfos	リソースプールのすべてのリクエスタのスロットリング設定を照会します。
DeleteResourcePoolRequesterQoSInfo	リソースプールの指定されたリクエスタのスロットリング設定を削除します。
PutBucketResourcePoolBucketGroup	リソースプール内のバケットをバケットグループに追加します。
ListResourcePoolBucketGroups	指定されたリソースプール内のバケットグループをリストします。
PutResourcePoolBucketGroupQoSInfo	リソースプール内のバケットグループのスロットリング設定を構成または変更します。
GetResourcePoolBucketGroupQoSInfo	リソースプール内のバケットグループのスロットリング設定を照会します。
ListResourcePoolBucketGroupQoSInfos	リソースプール内のバケットグループのスロットリング設定をリストします。
DeleteResourcePoolBucketGroupQoSInfo	リソースプール内のバケットグループのスロットリング設定を削除します。

LiveChannel 操作

API	説明
PutLiveChannelStatus	LiveChannel のステータスを切り替えます。
PutLiveChannel	LiveChannel を作成します。
GetVodPlaylist	プレイリストを照会します。
PostVodPlaylist	プレイリストを生成します。
GetLiveChannelStat	LiveChannel のストリーム取り込みステータスを照会します。
GetLiveChannelInfo	LiveChannel の設定を照会します。
GetLiveChannelHistory	LiveChannel のストリーム取り込み記録を照会します。
ListLiveChannel	LiveChannel をリストします。
DeleteLiveChannel	LiveChannel を削除します。

Object Storage Service:API の概要