指定されたオブジェクトバージョンに対して、保持モードと保持期限日を含むオブジェクト保持ポリシーを設定します。オブジェクトレベルの保持ポリシーは、バケットに設定されているデフォルトの ObjectWorm 保持ポリシーよりも優先されます。
注意事項
この機能は現在、招待プレビュー中です。この機能を使用するには、テクニカルサポートに連絡してアクティベーションを申請してください。この機能は現在、中国 (杭州)、中国 (成都)、中国 (深セン)、中国 (広州)、中国 (青島)、中国 (北京)、中国 (ウランチャブ)、中国 (河源)、中国 (香港)、ドイツ (フランクフルト)、日本 (東京)、韓国 (ソウル)、シンガポール、マレーシア (クアラルンプール)、インドネシア (ジャカルタ)、フィリピン (マニラ)、タイ (バンコク)、サウジアラビア (リヤド)、UAE (ドバイ) の各リージョンでのみサポートされています。
この操作を呼び出す前に、PutBucketObjectWormConfiguration 操作を呼び出して、バケットのオブジェクトレベル保持ポリシー (ObjectWorm) を有効にする必要があります。
この操作を呼び出すには、
oss:PutObjectRetention権限が必要です。コンプライアンスモードでは、
RetainUntilDateの値は延長のみ可能で、短縮はできません。現在の保持期限日より前の日付を設定すると、エラーが返されます。この操作によって設定されたオブジェクトレベルの保持ポリシーは、バケットのデフォルトの ObjectWorm ポリシーをオーバーライドします。
追加可能オブジェクトにオブジェクト保持ポリシーを設定することはできません。
RetainUntilDateの値は、未来の日付である必要があります。
リクエスト構文
PUT /ObjectName?retention HTTP/1.1
Content-MD5: ContentMD5
Content-Length: ContentLength
Content-Type: application/xml
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Date: GMT Date
Authorization: SignatureValueリクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
retention | N/A | はい | N/A | オブジェクト保持ポリシーを設定する操作を指定します。 |
versionId | String | いいえ | CAEQNhiBgMDJgZCA0BYiIDc4MGZj**** | オブジェクトのバージョン ID。このパラメーターを指定しない場合、操作はオブジェクトの最新バージョンに適用されます。 |
リクエストヘッダー
ヘッダー | タイプ | 必須 | 例 | 説明 |
Content-MD5 | String | はい | B2M2Y8AsgTpgAmY7PhC**** | リクエストボディの MD5 ハッシュです。このヘッダーは、データ整合性の検証に使用されます。 |
リクエストボディ要素
要素 | タイプ | 必須 | 例 | 説明 |
Retention | コンテナ | はい | N/A | オブジェクト保持ポリシーのコンテナ。 親：なし 子：Mode、RetainUntilDate |
Mode | String | はい | COMPLIANCE | オブジェクトの保持モード。有効な値：
親：Retention |
RetainUntilDate | String | はい | 2026-10-11T00:00:00.000Z | オブジェクトの保持期限日。値は ISO 8601 形式の日付です。この日付より前は、オブジェクトバージョンを削除または上書きすることはできません。指定する日付は、未来の日付である必要があります。 コンプライアンスモードでは、この日付は延長のみ可能で、短縮はできません。 親：Retention |
レスポンスヘッダー
ヘッダー | 例 | 説明 |
x-oss-version-id | CAEQNhiBgMDJgZCA0BYiIDc4MGZj**** | 保持ポリシーが適用されるオブジェクトのバージョン ID。 |
例
例 1：コンプライアンスモードの保持ポリシーの設定
リクエスト例
PUT /exampleobject?retention&versionId=CAEQNhiBgMDJgZCA0BYiIDc4MGZj**** HTTP/1.1 Date: Thu, 17 Mar 2026 11:18:32 GMT Content-MD5: B2M2Y8AsgTpgAmY7PhC**** Content-Type: application/xml Content-Length: 162 Host: examplebucket.oss-cn-hangzhou.aliyuncs.com Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20260317/cn-hangzhou/oss/aliyun_v4_request,Signature=**** <Retention> <Mode>COMPLIANCE</Mode> <RetainUntilDate>2026-10-11T00:00:00.000Z</RetainUntilDate> </Retention>レスポンス例
HTTP/1.1 200 OK x-oss-request-id: 5374A2880232A65C2300**** x-oss-version-id: CAEQNhiBgMDJgZCA0BYiIDc4MGZj**** Date: Thu, 17 Mar 2026 11:18:32 GMT Content-Length: 0 Server: AliyunOSS
例 2：保持期限日の延長
次の例では、オブジェクトの保持期限日を 2027 年 3 月 11 日に延長します。コンプライアンスモードでは、保持期限日は延長のみ可能で、短縮はできません。
リクエスト例
PUT /exampleobject?retention&versionId=CAEQNhiBgMDJgZCA0BYiIDc4MGZj**** HTTP/1.1 Date: Thu, 17 Mar 2026 11:18:32 GMT Content-MD5: D3N3Z9CtiVqhCnZ9RjE**** Content-Type: application/xml Content-Length: 162 Host: examplebucket.oss-cn-hangzhou.aliyuncs.com Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20260317/cn-hangzhou/oss/aliyun_v4_request,Signature=**** <Retention> <Mode>COMPLIANCE</Mode> <RetainUntilDate>2027-03-11T00:00:00.000Z</RetainUntilDate> </Retention>レスポンス例
HTTP/1.1 200 OK x-oss-request-id: 6485B3990232A65C3400**** x-oss-version-id: CAEQNhiBgMDJgZCA0BYiIDc4MGZj**** Date: Thu, 17 Mar 2026 11:20:15 GMT Content-Length: 0 Server: AliyunOSS
エラーコード
エラーコード | HTTP ステータスコード | 説明 |
InvalidRequest | 400 | バケットに対して ObjectWorm が有効になっていません。オブジェクト保持ポリシーを設定できません。 |
AccessDenied | 403 | コンプライアンスモードでは、保持期限日を短縮することはできません。 |