このトピックでは、バージョン管理が有効なバケットでシンボリックリンクを管理する方法について説明します。
使用上の注意
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用しています。 OSS と同じリージョン内の他の Alibaba Cloud サービスを使用して Object Storage Service (OSS) にアクセスする場合は、内部エンドポイントを使用します。 OSS でサポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、環境変数からアクセス認証情報を取得します。 アクセス認証情報を設定する方法の詳細については、「アクセス認証情報を設定する」をご参照ください。
このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスを作成します。 カスタムドメイン名または Security Token Service (STS) を使用して OSSClient インスタンスを作成する場合は、「一般的なシナリオの設定例」をご参照ください。
シンボリックリンクを作成するには、
oss:PutObject
権限が必要です。 シンボリックリンクを照会するには、oss:GetObject
権限が必要です。 詳細については、「RAM ユーザーにカスタムポリシーをアタッチする」をご参照ください。
シンボリックリンクの作成
オブジェクトの現在のバージョンを指すシンボリックリンクを作成できます。
バージョン管理が有効なバケットでは、削除マーカーのシンボリックリンクを作成することはできません。
シンボリックリンクは複数のバージョンを持つことができます。 PutSymlink 操作を呼び出して、シンボリックリンクの各バージョンを異なるオブジェクトにポイントできます。 この場合、バージョンの ID は OSS によって生成され、x-oss-version-id ヘッダーの値として応答に含まれます。
次のサンプルコードは、シンボリックリンクを作成する例を示しています。
import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.*;
public class Demo {
public static void main(String[] args) throws Exception {
// この例では、中国 (杭州) リージョンのエンドポイントを使用しています。 実際のエンドポイントを指定してください。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 環境変数からアクセス認証情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// バケットの名前を指定します。 例: examplebucket。
String bucketName = "examplebucket";
// シンボリックリンクの名前を指定します。
String symLink = "yourSymLink";
// オブジェクトの完全なパスを指定します。 完全なパスにバケット名を含めないでください。
String destinationObjectName = "exampledir/object";
// バケットが配置されているリージョンを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合は、リージョンを cn-hangzhou に設定します。
String region = "cn-hangzhou";
// OSSClient インスタンスを作成します。
// OSSClient が不要になったら、shutdown メソッドを呼び出してリソースを解放します。
ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.clientConfiguration(clientBuilderConfiguration)
.region(region)
.build();
try {
// アップロードするオブジェクトのメタデータを作成します。
ObjectMetadata metadata = new ObjectMetadata();
metadata.setContentType("text/plain");
// property パラメーターを property-value に設定します。
metadata.addUserMetadata("property", "property-value");
// CreateSymlinkRequest オブジェクトを作成します。
CreateSymlinkRequest createSymlinkRequest = new CreateSymlinkRequest(bucketName, symLink, destinationObjectName);
// メタデータを構成します。
createSymlinkRequest.setMetadata(metadata);
// オブジェクトのバージョン ID を指定します。
createSymlinkRequest.setVersionId("CAEQFhiCgID3rZDy3hgiIGQxOTIxOWU0M2NlYzQ2ODdhMTQwOGRlZGQxMzEx****");
// シンボリックリンクを作成します。
ossClient.createSymlink(createSymlinkRequest);
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
}
}
シンボリックリンクの照会
デフォルトでは、GetSymlink 操作はシンボリックリンクの現在のバージョンをクエリします。リクエストでバージョン ID を指定して、シンボリックリンクの特定バージョンをクエリできます。シンボリックリンクの現在のバージョンが削除マーカーの場合、OSS は 404 Not Found を返し、レスポンスに x-oss-delete-marker = true と x-oss-version-id を含めます。
シンボリックリンクを照会するには、シンボリックリンクに対する読み取り権限が必要です。
次のサンプルコードは、シンボリックリンクを照会する例を示しています。
import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.*;
public class Demo {
public static void main(String[] args) throws Exception {
// この例では、中国 (杭州) リージョンのエンドポイントを使用しています。 実際のエンドポイントを指定してください。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 環境変数からアクセス認証情報を取得します。 サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// ソースバケットの名前を指定します。 例: examplebucket。
String bucketName = "examplebucket";
// シンボリックリンクの名前を指定します。
String symLink = "yourSymLink";
// 照会するシンボリックリンクのバージョン ID を指定します。
String versionId = "CAEQMxiBgICAof2D0BYiIDJhMGE3N2M1YTI1NDQzOGY5NTkyNTI3MGYyMzJm****";
// バケットが配置されているリージョンを指定します。 たとえば、バケットが中国 (杭州) リージョンにある場合は、リージョンを cn-hangzhou に設定します。
String region = "cn-hangzhou";
// OSSClient インスタンスを作成します。
// OSSClient が不要になったら、shutdown メソッドを呼び出してリソースを解放します。
ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.clientConfiguration(clientBuilderConfiguration)
.region(region)
.build();
try {
GenericRequest genericRequest = new GenericRequest(bucketName, symLink, versionId);
OSSSymlink symbolicLink = ossClient.getSymlink(genericRequest);
// シンボリックリンクの名前を表示します。
System.out.println(symbolicLink.getSymlink());
// シンボリックリンクが指すオブジェクトの名前を出力します。
System.out.println(symbolicLink.getTarget());
System.out.println(symbolicLink.getRequestId());
// シンボリックリンクのバージョン ID を表示します。
System.out.println(symbolicLink.getMetadata().getVersionId());
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (ClientException ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
}
}
関連情報
シンボリックリンクを作成するために呼び出すことができる API 操作の詳細については、「PutSymlink」をご参照ください。
シンボリックリンクを照会するために呼び出すことができる API 操作の詳細については、「GetSymlink」をご参照ください。