オブジェクトをダウンロードする条件を1つ以上指定できます。 指定された条件が満たされると、オブジェクトがダウンロードされます。 指定された条件が満たされない場合、エラーが返され、オブジェクトはダウンロードされません。 条件付きダウンロードを使用して、object Storage Service (OSS) からローカルメモリまたはローカルファイルにオブジェクトをダウンロードできます。
使用上の注意
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba CloudサービスからOSSにアクセスする場合は、内部エンドポイントを使用します。 OSSリージョンとエンドポイントの詳細については、「リージョン、エンドポイント、オープンポート」をご参照ください。
このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSecurity Token Service (STS) を使用してOSSClientインスタンスを作成する場合は、「OSSClientインスタンスの作成」をご参照ください。
条件付きダウンロードを実行するには、
oss:GetObject
権限が必要です。 詳細については、「RAMユーザーへのカスタムポリシーのアタッチ」をご参照ください。
条件
次の表は、OSSがサポートする条件を示しており、条件付きダウンロードを使用するときに指定できます。 If-Modified-SinceとIf-Unmodified-Sinceをオブジェクトのダウンロード条件として同時に使用できます。 If-MatchとIf-None-Matchをオブジェクトのダウンロード条件として同時に使用できます。
パラメーター | 説明 | 移動方法 |
If-Modified-Since | 指定された時間後にオブジェクトが変更された場合、オブジェクトをダウンロードできます。 それ以外の場合、エラーコード304 Not Modifiedが返されます。 | OssClient::OSS_IF_MODIFIED_SINCE |
If-Unmodified-Since | 指定された時間の前または時間にオブジェクトが変更された場合、オブジェクトをダウンロードできます。 それ以外の場合、エラーコード412 Precondition Failedが返されます。 | OssClient::OSS_IF_UNMODIFIED_SINCE |
If-Match | 指定された ETag がオブジェクトのものと一致すれば、そのオブジェクトをダウンロードすることができます。 それ以外の場合、Precondition Failed 412エラーが返されます。 説明 $ossClient->getObjectMetaを使用して、オブジェクトのETagを取得できます。 | OssClient::OSS_IF_MATCH |
If-None-Match | 指定された ETag がオブジェクトのものと一致しない場合は、オブジェクトをダウンロードできます。 それ以外の場合、エラーコード304 Not Modifiedが返されます。 | OssClient::OSS_IF_NONE_MATCH |
条件付きダウンロードを使用してローカルメモリにオブジェクトをダウンロードする
次のコードは、条件を指定し、条件に一致するオブジェクトをローカルメモリにダウンロードする方法の例を示しています。
<?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;
// 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 = "http://oss-cn-hangzhou.aliyuncs.com";
// Specify the bucket name.
$bucket= "yourBucketName";
// Specify the object name. The object name is the full path of the object. The path of the object cannot contain the bucket name. Example: exampledir/exampleobject.txt.
$object = "yourObjectName";
try{
$options = array(
OssClient::OSS_HEADERS => array(
// Set If-Modified-Since to 14:47:53 Friday, April 9, 2021 in GMT.
OssClient::OSS_IF_MODIFIED_SINCE => "Fri, 9 Apr 2021 14:47:53 GMT",
// Set If-Unmodified-Since to 14:47:53 Wednesday, October 13, 2021 in GMT.
OssClient::OSS_IF_UNMODIFIED_SINCE => "Fri, 13 Oct 2021 14:47:53 GMT",
// Specify that objects whose ETag values do not match the ETag values that are specified in the requests are downloaded.
OssClient::OSS_IF_NONE_MATCH => '"5B3C1A2E0563E1B002CC607C****"',
// Specify that objects whose ETag values match the ETag values that are specified in the requests are downloaded.
OssClient::OSS_IF_MATCH => '"fba9dede5f27731c9771645a3986****"',
)
);
$config = array(
"provider" => $provider,
"endpoint" => $endpoint,
"signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
"region"=> "cn-hangzhou"
);
$ossClient = new OssClient($config);
// Download the object to your local memory.
$content = $ossClient->getObject($bucket, $object, $options);
} catch(OssException $e) {
printf(__FUNCTION__ . ": FAILED\n");
printf($e->getMessage() . "\n");
return;
}
print ($content);
print(__FUNCTION__ . ": OK" . "\n");
条件付きダウンロードを使用してオブジェクトをローカルファイルにダウンロードする
次のコードは、条件を指定し、条件に一致するオブジェクトをローカルファイルにダウンロードする方法の例を示しています。
<?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;
// 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 = "http://oss-cn-hangzhou.aliyuncs.com";
// Specify the bucket name.
$bucket= "yourBucketName";
// Specify the object name. The object name is the full path of the object. The path of the object cannot contain the bucket name. Example: exampledir/exampleobject.txt.
$object = "yourObjectName";
// Specify the full path of the local object that you want to upload. Example: D:\\localpath\\examplefile.txt.
$localfile = "yourLocalFile";
try{
$options = array(
OssClient::OSS_HEADERS => array(
// Set If-Modified-Since to 14:47:53 Friday, April 9, 2021 in GMT.
OssClient::OSS_IF_MODIFIED_SINCE => "Fri, 9 Apr 2021 14:47:53 GMT",
// Set If-Unmodified-Since to 14:47:53 Wednesday, October 13, 2021 in GMT.
OssClient::OSS_IF_UNMODIFIED_SINCE => "Fri, 13 Oct 2021 14:47:53 GMT",
// Specify that objects whose ETag values do not match the ETag values that are specified in the requests are downloaded.
OssClient::OSS_IF_NONE_MATCH => '"5B3C1A2E0563E1B002CC607C****"',
// Specify that objects whose ETag values match the ETag values that are specified in the requests are downloaded.
OssClient::OSS_IF_MATCH => '"fba9dede5f27731c9771645a3986****"',
OssClient::OSS_FILE_DOWNLOAD => $localfile
)
);
$config = array(
"provider" => $provider,
"endpoint" => $endpoint,
"signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
"region"=> "cn-hangzhou"
);
$ossClient = new OssClient($config);
$ossClient->getObject($bucket, $object, $options);
} catch(OssException $e) {
printf(__FUNCTION__ . ": FAILED\n");
printf($e->getMessage() . "\n");
return;
}