Object Storage Service:オブジェクトの削除, オブジェクトの削除

使用上の注意

• このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba CloudサービスからOSSにアクセスする場合は、内部エンドポイントを使用します。 OSSリージョンとエンドポイントの詳細については、「リージョン、エンドポイント、オープンポート」をご参照ください。

• このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSecurity Token Service (STS) を使用してOSSClientインスタンスを作成する場合は、「OSSClientインスタンスの作成」をご参照ください。

• オブジェクトを削除するには、oss:DeleteObject権限が必要です。 詳細については、「RAMユーザーへのカスタムポリシーのアタッチ」をご参照ください。

バージョン管理されたバケット内のオブジェクトに対する削除操作

• バージョンIDを指定せずにオブジェクトを削除する (一時削除)

  デフォルトでは、リクエストで削除するオブジェクトのバージョンIDを指定しない場合、OSSはオブジェクトの現在のバージョンを削除せず、新しい現在のバージョンとしてオブジェクトに削除マーカーを追加します。 オブジェクトに対してGetObject操作を実行すると、OSSはオブジェクトの現在のバージョンを削除マーカーとして識別し、404 Not Foundを返します。 また、レスポンスには、header:x-oss-delete-marker = trueと、削除マーカーのバージョンidを示すx-oss-version-IDが含まれています。

• バージョンIDを指定してオブジェクトを削除する (永久削除)

  リクエストで削除するオブジェクトのバージョンIDを指定すると、paramsで指定されたversionIdパラメーターに基づいて、指定されたバージョンのオブジェクトが完全に削除されます。 バージョンIDがnullのオブジェクトバージョンを削除するには、リクエストのparamsにparams['versionId'] = "null" を含めます。 OSSは、削除するバージョンのIDとして文字列 "null" を識別し、IDがnullのバージョンを削除します。

一度にオブジェクトを削除する

次の例では、バージョン化されたバケットから1つのオブジェクトを永続的または一時的に削除する方法について説明します。

• 永久削除

  次のサンプルコードは、バージョン管理されたバケットから指定されたバージョンIDを持つオブジェクトを完全に削除する方法の例を示しています。

  <?php
  if (is_file(__DIR__ . '/../autoload.php')) {
      require_once __DIR__ . '/../autoload.php';
  }
  if (is_file(__DIR__ . '/../vendor/autoload.php')) {
      require_once __DIR__ . '/../vendor/autoload.php';
  }
  
  use OSS\Credentials\EnvironmentVariableCredentialsProvider;
  use OSS\OssClient;
  use OSS\CoreOssException;
  
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  $provider = new EnvironmentVariableCredentialsProvider();
  // In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
  $endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
  $bucket= "<yourBucketName>";
  // Specify the full path of the object. Do not include the bucket name in the full path. Example: example/test.txt. 
  $object = "<yourObjectName>";
  $versionId = "<yourObjectVersionId>";
  
  $config = array(
          "provider" => $provider,
          "endpoint" => $endpoint,
          "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
          "region"=> "cn-hangzhou"
      );
      $ossClient = new OssClient($config);
  
  try{
      // Delete the specified version of the object. 
      $ossClient->deleteObject($bucket, $object, array(OssClient::OSS_VERSION_ID => $versionId));
  } catch(OssException $e) {
      printf(__FUNCTION__ . ": FAILED\n");
      printf($e->getMessage() . "\n");
      return;
  }
  
  print(__FUNCTION__ . ": OK" . "\n");        

• 一時削除

  次のサンプルコードは、バージョンIDが指定されていないリクエストを送信して、バージョン管理されたバケットからオブジェクトを一時的に削除する方法の例を示しています。

  <?php
  if (is_file(__DIR__ . '/../autoload.php')) {
      require_once __DIR__ . '/../autoload.php';
  }
  if (is_file(__DIR__ . '/../vendor/autoload.php')) {
      require_once __DIR__ . '/../vendor/autoload.php';
  }
  
  use OSS\Credentials\EnvironmentVariableCredentialsProvider;
  use OSS\OssClient;
  use OSS\CoreOssException;
  
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  $provider = new EnvironmentVariableCredentialsProvider();
  // In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
  $endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
  $bucket= "<yourBucketName>";
  $object = "<yourObjectName>";
  
  $config = array(
          "provider" => $provider,
          "endpoint" => $endpoint,
          "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
          "region"=> "cn-hangzhou"
      );
      $ossClient = new OssClient($config);
  
  try{
      // Temporarily delete an object without specifying its version ID. A delete marker is added to the object. 
      $ret = $ossClient->deleteObject($bucket, $object);
      print("delete marker:" .$ret['x-oss-delete-marker'] ."\n");
      print("version id:" .$ret['x-oss-version-id']);
  } catch(OssException $e) {
      printf(__FUNCTION__ . ": FAILED\n");
      printf($e->getMessage() . "\n");
      return;
  }
  
  print(__FUNCTION__ . ": OK" . "\n");    

一度にオブジェクトを削除する方法の詳細については、「DeleteObject」をご参照ください。

一度に複数のオブジェクトを削除する

次の例では、バージョン管理されたバケットから一度に複数のオブジェクトを永続的または一時的に削除する方法について説明します。

• 永久削除

  次のサンプルコードは、バージョン管理されたバケットから指定されたバージョンIDを持つ複数のオブジェクトを完全に削除する方法の例を示します。

  <?php
  if (is_file(__DIR__ . '/../autoload.php')) {
      require_once __DIR__ . '/../autoload.php';
  }
  if (is_file(__DIR__ . '/../vendor/autoload.php')) {
      require_once __DIR__ . '/../vendor/autoload.php';
  }
  
  use OSS\Credentials\EnvironmentVariableCredentialsProvider;
  use OSS\OssClient;
  use OSS\CoreOssException;
  use OSS\Model\DeleteObjectInfo;
  
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  $provider = new EnvironmentVariableCredentialsProvider();
  // In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
  $endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
  $bucket= "<yourBucketName>";
  
  $config = array(
          "provider" => $provider,
          "endpoint" => $endpoint,
          "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
          "region"=> "cn-hangzhou"
      );
      $ossClient = new OssClient($config);
  
  try{
      // Delete the objects with the specified version IDs. 
      $objects = array(); 
      $objects[] = new DeleteObjectInfo("<yourObject1Name>", "<object1VersionId>");
      $objects[] = new DeleteObjectInfo("<yourObject2Name>", "<object2VersionId>");
      
      $deletedObjectList = $ossClient->deleteObjectVersions($bucket, $objects);
  
      // Display the deleted objects. 
      if (!empty($deletedObjectList)) {
            print("deletedObjectList:\n");
            foreach ($deletedObjectList as $deletedObjectInfo) {
              print($deletedObjectInfo->getKey() . ",");
              print($deletedObjectInfo->getVersionId() . ",");
              print($deletedObjectInfo->getDeleteMarker() . ",");
              print($deletedObjectInfo->getDeleteMarkerVersionId() . "\n");
            }
      }
  } catch(OssException $e) {
      printf(__FUNCTION__ . ": FAILED\n");
      printf($e->getMessage() . "\n");
      return;
  }
  
  print(__FUNCTION__ . ": OK" . "\n");

• 一時削除

  次のサンプルコードでは、バージョンIDが指定されていないリクエストを送信して、バージョン管理されたバケットから複数のオブジェクトを一時的に削除する方法の例を示します。

  <?php
  if (is_file(__DIR__ . '/../autoload.php')) {
      require_once __DIR__ . '/../autoload.php';
  }
  if (is_file(__DIR__ . '/../vendor/autoload.php')) {
      require_once __DIR__ . '/../vendor/autoload.php';
  }
  
  use OSS\Credentials\EnvironmentVariableCredentialsProvider;
  use OSS\OssClient;
  use OSS\CoreOssException;
  use OSS\Model\DeleteObjectInfo;
  
  // Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
  $provider = new EnvironmentVariableCredentialsProvider();
  // In this example, the endpoint of the China (Hangzhou) region is used. Specify your actual endpoint. 
  $endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
  $bucket= "<yourBucketName>";
  
  $config = array(
          "provider" => $provider,
          "endpoint" => $endpoint,
          "signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
          "region"=> "cn-hangzhou"
      );
      $ossClient = new OssClient($config);
  
  try{
      // Temporarily delete multiple objects without specifying their version IDs. Delete markers are added to the objects. 
          $objects = array(); 
      $objects[] = new DeleteObjectInfo("<yourObject1Name>");
      $objects[] = new DeleteObjectInfo("<yourObject2Name>");
      
      $deletedObjectList = $ossClient->deleteObjectVersions($bucket, $objects);
  
      // Display the deleted objects. 
      if (!empty($deletedObjectList)) {
            print("deletedObjectList:\n");
            foreach ($deletedObjectList as $deletedObjectInfo) {
              print($deletedObjectInfo->getKey() . ",");
              print($deletedObjectInfo->getVersionId() . ",");
              print($deletedObjectInfo->getDeleteMarker() . ",");
              print($deletedObjectInfo->getDeleteMarkerVersionId() . "\n");
            }
      }
  } catch(OssException $e) {
      printf(__FUNCTION__ . ": FAILED\n");
      printf($e->getMessage() . "\n");
      return;
  }
  
  print(__FUNCTION__ . ": OK" . "\n");

一度に複数のオブジェクトを削除する方法の詳細については、「DeleteMultipleObjects」をご参照ください。