Hosting de sitios web estáticos (recuperación en origen basada en espejo) (OSS SDK for Java 1.0) - Object Storage Service

Puede configurar un bucket para el hosting de sitios web estáticos y establecer reglas de redirección (RoutingRule) para la recuperación en origen basada en espejo. Una vez que habilite esta función, las solicitudes al sitio web equivaldrán a solicitudes directas al bucket. También es posible configurar redirecciones automáticas hacia una página de índice y una página de error específicas. Las reglas de redirección para la recuperación en origen basada en espejo le permiten migrar datos a Object Storage Service (OSS) sin interrupciones.

Notas

En este tema se utiliza el endpoint público de la región China (Hangzhou). Para acceder a OSS desde otros servicios de Alibaba Cloud en la misma región, use un endpoint interno. Consulte Regions and endpoints para obtener más información sobre las regiones y los endpoints compatibles.
Las credenciales de acceso de este tema se obtienen de variables de entorno. Consulte 配置访问凭证 para obtener más información.
Este tema muestra cómo crear una instancia de OSSClient con un endpoint de OSS. Consulte Client configuration para conocer configuraciones alternativas, como usar un dominio personalizado o autenticarse con credenciales de Security Token Service (STS).
Para configurar el hosting de sitios web estáticos o la recuperación en origen basada en espejo, necesita el permiso oss:PutBucketWebsite. Para consultar la configuración correspondiente, requiere el permiso oss:GetBucketWebsite. Si desea eliminar dicha configuración, debe contar con el permiso oss:DeleteBucketWebsite. Consulte Grant custom access policies to RAM users para obtener más información.

Hosting de sitios web estáticos

Configure el hosting de sitios web estáticos

A continuación se muestra cómo configurar el hosting de sitios web estáticos:

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.SetBucketWebsiteRequest;

public class Demo {

    public static void main(String[] args) throws Exception {
        // The China (Hangzhou) Endpoint is used as an example. Specify the actual Endpoint.
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // Obtain access credentials from environment variables. Before you run this sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Specify the bucket name. For example, examplebucket.
        String bucketName = "examplebucket";
        // Specify the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the region to cn-hangzhou.
        String region = "cn-hangzhou";

        // Create an OSSClient instance.
        // When the OSSClient instance is no longer needed, call the shutdown method to release its resources.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            // Specify the bucket name.
            SetBucketWebsiteRequest request = new SetBucketWebsiteRequest(bucketName);
            // Set the default homepage for static website hosting.
            request.setIndexDocument("index.html");
            // Set the default 404 page for static website hosting.
            request.setErrorDocument("error.html");
            ossClient.setBucketWebsite(request);
        } 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();
            }
        }
    }
}

Consulte la configuración del hosting de sitios web estáticos

A continuación se muestra cómo consultar la configuración del hosting de sitios web estáticos:

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.BucketWebsiteResult;

public class Demo {

    public static void main(String[] args) throws Exception {
        // The China (Hangzhou) Endpoint is used as an example. Specify the actual Endpoint.
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // Obtain access credentials from environment variables. Before you run this sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Specify the bucket name. For example, examplebucket.
        String bucketName = "examplebucket";
        // Specify the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the region to cn-hangzhou.
        String region = "cn-hangzhou";

        // Create an OSSClient instance.
        // When the OSSClient instance is no longer needed, call the shutdown method to release its resources.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            // Specify the bucket name.
            BucketWebsiteResult result = ossClient.getBucketWebsite(bucketName);
            // View the default homepage and default 404 page of the static website hosting configuration.
            System.out.println(result.getIndexDocument());
            System.out.println(result.getErrorDocument());
        } 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();
            }
        }
    }
}

Elimine la configuración del hosting de sitios web estáticos

A continuación se muestra cómo eliminar la configuración del hosting de sitios web estáticos:

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;

public class Demo {

    public static void main(String[] args) throws Exception {
        // The China (Hangzhou) Endpoint is used as an example. Specify the actual Endpoint.
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // Obtain access credentials from environment variables. Before you run this sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Specify the bucket name. For example, examplebucket.
        String bucketName = "examplebucket";
        // Specify the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the region to cn-hangzhou.
        String region = "cn-hangzhou";

        // Create an OSSClient instance.
        // When the OSSClient instance is no longer needed, call the shutdown method to release its resources.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            // Specify the bucket name.
            ossClient.deleteBucketWebsite(bucketName);
        } 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();
            }
        }
    }
}

Recuperación en origen basada en espejo

La recuperación en origen basada en espejo se usa principalmente para migrar datos a OSS sin interrupciones. Por ejemplo, su servicio podría ejecutarse en su propio servidor de origen o en otro producto de la nube. Si desea migrarlo a OSS para impulsar el desarrollo de su negocio, asegúrese de que el servicio siga funcionando durante la migración. En ese proceso, utilice reglas de recuperación en origen basada en espejo para obtener los datos que aún no se han migrado a OSS. De este modo garantiza que el servicio funcione según lo esperado.

Configure la recuperación en origen basada en espejo

Por ejemplo, cuando un solicitante accede a un archivo que no existe en el bucket de destino, puede especificar condiciones de recuperación en origen y una URL de origen para obtener el objeto desde el servidor de origen. Suponga que tiene un bucket llamado examplebucket en la región China (Hangzhou). Si alguien intenta acceder a un archivo inexistente dentro del directorio examplefolder, ubicado en la raíz del bucket, es posible permitir que el archivo se recupere desde el directorio examplefolder del sitio https://www.example.com/.

A continuación se muestra cómo configurar una regla de recuperación en origen basada en espejo para el escenario anterior:

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.RoutingRule;
import com.aliyun.oss.model.SetBucketWebsiteRequest;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class Demo {

    public static void main(String[] args) throws Exception {
        // The China (Hangzhou) Endpoint is used as an example. Specify the actual Endpoint.
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // Obtain access credentials from environment variables. Before you run this sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Specify the bucket name. For example, examplebucket.
        String bucketName = "examplebucket";
        // Specify the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the region to cn-hangzhou.
        String region = "cn-hangzhou";

        // Create an OSSClient instance.
        // When the OSSClient instance is no longer needed, call the shutdown method to release its resources.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            SetBucketWebsiteRequest request = new SetBucketWebsiteRequest(bucketName);
            // The behavior when an object that does not exist and whose name does not end with a forward slash (/) is accessed. This takes effect after a default homepage is set.
            //request.setSubDirType(null);
            // Specifies whether to redirect to the default homepage of a subdirectory when the subdirectory is accessed.
            //request.setSupportSubDir(false);

            List<RoutingRule> routingRules = new ArrayList<RoutingRule>();

            RoutingRule rule = new RoutingRule();
            rule.setNumber(1);
            // Only objects with this prefix can match this rule.
            rule.getCondition().setKeyPrefixEquals("examplebucket");
            // The rule is matched only if an HTTP status code of 404 is returned for a request to the specified object.
            rule.getCondition().setHttpErrorCodeReturnedEquals(404);
            // Specify the redirect type.
            rule.getRedirect().setRedirectType(RoutingRule.RedirectType.Mirror);
            // Specify the origin URL for mirroring-based back-to-origin. For example, https://www.example.com/.
            rule.getRedirect().setMirrorURL("<yourMirrorURL>");
            //rule.getRedirect().setMirrorRole("AliyunOSSMirrorDefaultRole");
            // Specifies whether to include request parameters when a redirection or mirroring-based back-to-origin rule is executed.
            rule.getRedirect().setPassQueryString(true);
            // This parameter has the same function as PassQueryString but has a higher priority. This parameter takes effect only when RedirectType is set to Mirror.
            rule.getRedirect().setMirrorPassQueryString(true);
            // Specify the status code to return for the redirection. This parameter takes effect only when RedirectType is set to External or AliCDN.
            //rule.getRedirect().setHttpRedirectCode(302);
            // Specify the domain name for the redirection. The domain name must be compliant with domain name specifications.
            //rule.getRedirect().setHostName("oss.aliyuncs.com");
            // Specify the protocol for the redirection. This parameter takes effect only when RedirectType is set to External or AliCDN.
            //rule.getRedirect().setProtocol(RoutingRule.Protocol.Https);
            // During redirection, the object name is replaced with the value of ReplaceKeyWith. ReplaceKeyWith supports variables.
            //rule.getRedirect().setReplaceKeyWith("${key}.jpg");
            // If this parameter is set to true, the prefix of the object name is replaced with the value of ReplaceKeyPrefixWith.
            rule.getRedirect().setEnableReplacePrefix(true);
            // During redirection, the prefix of the object name is replaced with this value.
            rule.getRedirect().setReplaceKeyPrefixWith("examplebucket");
            // Specifies whether to check the MD5 hash of the back-to-origin body. This parameter takes effect only when RedirectType is set to Mirror.
            rule.getRedirect().setMirrorCheckMd5(true);

            RoutingRule.MirrorHeaders mirrorHeaders = new RoutingRule.MirrorHeaders();
            // Specifies whether to pass through headers other than the following to the origin server. This parameter takes effect only when RedirectType is set to Mirror.
            mirrorHeaders.setPassAll(false);
            List passes = new ArrayList<String>();
            passes.add("cache-control");
            // Pass through the specified headers to the origin server. This parameter takes effect only when RedirectType is set to Mirror.
            mirrorHeaders.setPass(passes);
            List removes = new ArrayList<String>();
            removes.add("content-type");
            // Prohibit the pass-through of specified headers to the origin server. This parameter takes effect only when RedirectType is set to Mirror.
            mirrorHeaders.setRemove(removes);
            List sets = new ArrayList<Map<String, String>>();
            Map header1 = new HashMap<String, String>();
            header1.put("Key", "key1");
            header1.put("Value", "value1");
            Map header2 = new HashMap<String, String>();
            header2.put("Key", "key2");
            header2.put("Value", "value2");
            sets.add(header1);
            sets.add(header2);
            // Set the headers to pass to the origin server. These headers are set for back-to-origin requests, regardless of whether they are included in the original request.
            mirrorHeaders.setSet(sets);
            // Specify the headers to include in back-to-origin requests. This parameter takes effect only when RedirectType is set to Mirror.
            rule.getRedirect().setMirrorHeaders(mirrorHeaders);

            routingRules.add(rule);
            request.setRoutingRules(routingRules);
            ossClient.setBucketWebsite(request);
        } 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();
            }
        }
    }
}

Obtenga la configuración de recuperación en origen basada en espejo

A continuación se muestra cómo obtener la configuración de recuperación en origen basada en espejo:

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.BucketWebsiteResult;

public class Demo {

    public static void main(String[] args) throws Exception {
        // The China (Hangzhou) Endpoint is used as an example. Specify the actual Endpoint.
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // Obtain access credentials from environment variables. Before you run this sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Specify the bucket name. For example, examplebucket.
        String bucketName = "examplebucket";
        // Specify the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the region to cn-hangzhou.
        String region = "cn-hangzhou";

        // Create an OSSClient instance.
        // When the OSSClient instance is no longer needed, call the shutdown method to release its resources.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            BucketWebsiteResult result = ossClient.getBucketWebsite(bucketName);
            result.getSubDirType();
            // Get the ordinal number of the redirection or mirroring-based back-to-origin rule that is matched and executed.
            System.out.println(result.getRoutingRules().get(0).getNumber());
            // Get the prefix that the rule matches.
            System.out.println(result.getRoutingRules().get(0).getCondition().getKeyPrefixEquals());
            // Get the HTTP status code.
            System.out.println(result.getRoutingRules().get(0).getCondition().getHttpErrorCodeReturnedEquals());
            // Get the suffix that the rule matches.
            System.out.println(result.getRoutingRules().get(0).getCondition().getKeySuffixEquals());
            // Get the redirect type.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getRedirectType());
            // Get the carried request parameters.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getMirrorPassQueryString());
            // Get the origin URL for mirroring-based back-to-origin.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getMirrorURL());
            // Get the status code returned for the redirection.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getHttpRedirectCode());
            // Get the specified headers to pass through.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getMirrorHeaders().getPass().get(0));
            // Get the specified headers that are prohibited from being passed through.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getMirrorHeaders().getRemove().get(0));
            // Get the protocol for the redirection.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getProtocol());
            // Get the domain name for the redirection.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getHostName());
            // Get the value to replace the prefix of the object name during redirection. If the prefix is empty, this string is inserted at the beginning of the object name.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getReplaceKeyPrefixWith());
            // Get the replacement value for the object name specified by ReplaceKeyWith during redirection. ReplaceKeyWith supports variables.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getReplaceKeyWith());
            // Get the status code returned for the redirection.
            System.out.println(result.getRoutingRules().get(0).getRedirect().getHttpRedirectCode());
        } 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();
            }
        }
    }
}

Elimine la configuración de recuperación en origen basada en espejo

A continuación se muestra cómo eliminar la configuración de recuperación en origen basada en espejo:

import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;

public class Demo {

    public static void main(String[] args) throws Exception {
        // The China (Hangzhou) Endpoint is used as an example. Specify the actual Endpoint.
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // Obtain access credentials from environment variables. Before you run this sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are set.
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Specify the bucket name. For example, examplebucket.
        String bucketName = "examplebucket";        
        // Specify the region where the bucket is located. For example, if the bucket is in the China (Hangzhou) region, set the region to cn-hangzhou.
        String region = "cn-hangzhou";

        // Create an OSSClient instance.
        // When the OSSClient instance is no longer needed, call the shutdown method to release its resources.
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            // Specify the bucket name.
            ossClient.deleteBucketWebsite(bucketName);
        } 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();
            }
        }
    }
}

Referencias

Consulte el ejemplo de GitHub para ver el código de ejemplo completo del hosting de sitios web estáticos y la recuperación en origen basada en espejo.
Consulte PutBucketWebsite para obtener más información sobre la operación de API que permite configurar el hosting de sitios web estáticos o la recuperación en origen basada en espejo.
Consulte GetBucketWebsite para obtener más información sobre la operación de API que permite consultar la configuración del hosting de sitios web estáticos o de la recuperación en origen basada en espejo.
Consulte DeleteBucketWebsite para obtener más información sobre la operación de API que permite eliminar la configuración del hosting de sitios web estáticos o de la recuperación en origen basada en espejo.