How to configure static website hosting and mirroring-based back-to-origin - Object Storage Service: Central de Documentação do Alibaba Cloud

Configure um bucket para hospedagem de site estático e defina regras de redirecionamento (RoutingRule) para back-to-origin baseado em espelhamento. Após ative a hospedagem de site estático, as requisições para o site são equivalentes às requisições para o bucket. Também é possível configure redirecionamentos automáticos para uma página de índice e uma página de erro específicas. As regras de redirecionamento para back-to-origin baseado em espelhamento ajudam a migrar dados para o Object Storage Service (OSS) de forma transparente.

Observações

Neste tópico, o endpoint público da região China (Hangzhou) é utilizado. Para acessar o OSS a partir de outros service da Alibaba Cloud na mesma região, use um endpoint interno. Para obter detalhes sobre as regiões e os endpoints suportados, consulte Regions and endpoints.
Neste tópico, as credenciais de acesso são obtidas a partir de variáveis de ambiente. Para mais informações, consulte 配置访问凭证.
Este tópico demonstra como crie uma instância OSSClient com um endpoint do OSS. Para configurações alternativas, como o uso de um domínio personalizado ou autenticação com credenciais do Security Token Service (STS), consulte Client configuration.
Para configure a hospedagem de site estático ou o back-to-origin baseado em espelhamento, você deve ter a permissão oss:PutBucketWebsite. Para recuperar a configuração da hospedagem de site estático ou do back-to-origin baseado em espelhamento, você deve ter a permissão oss:GetBucketWebsite. Para exclua a configuração da hospedagem de site estático ou do back-to-origin baseado em espelhamento, você deve ter a permissão oss:DeleteBucketWebsite. Para mais informações, consulte Grant custom access policies to RAM users.

Hospedagem de site estático

Configure hospedagem de site estático

O código a seguir mostra como configure a hospedagem de site estático:

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();
            }
        }
    }
}

Visualize a configuração de hospedagem de site estático

O código a seguir mostra como visualize a configuração de hospedagem de site estático:

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();
            }
        }
    }
}

Exclua a configuração de hospedagem de site estático

O código a seguir mostra como exclua a configuração de hospedagem de site estático:

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();
            }
        }
    }
}

Back-to-origin baseado em espelhamento

O back-to-origin baseado em espelhamento é ideal para a migração transparente de dados para o OSS. Por exemplo, seu service pode estar em execução no seu próprio servidor de origem ou em outro product de cloud. Se você quiser migrar o service para o OSS para o desenvolvimento de negócios, é necessário garantir que o service continue em execução durante a migração. Durante a migração, você pode usar regras de back-to-origin baseado em espelhamento para recuperar dados que ainda não foram migrados para o OSS. Isso garante que o seu service funcione conforme o esperado.

Configure back-to-origin baseado em espelhamento

Por exemplo, quando um solicitante acessa um arquivo que não existe no bucket de destino, especifique condições de back-to-origin e uma URL de origem para recuperar o arquivo de objeto do servidor de origem. Suponha que você tenha um bucket chamado examplebucket na região China (Hangzhou). Se um solicitante tentar acessar um arquivo que não existe no diretório examplefolder, localizado no diretório raiz do bucket, e você deseja que o solicitante possa recuperar o arquivo de objeto do diretório examplefolder do site https://www.example.com/.

O código a seguir mostra como configure uma regra de back-to-origin baseado em espelhamento para o cenário 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();
            }
        }
    }
}

Recuperar a configuração de back-to-origin baseado em espelhamento

O código a seguir mostra como recuperar a configuração de back-to-origin baseado em espelhamento:

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();
            }
        }
    }
}

Exclua a configuração de back-to-origin baseado em espelhamento

O código a seguir mostra como exclua a configuração de back-to-origin baseado em espelhamento:

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();
            }
        }
    }
}

Referências

Para obter o código de exemplo completo para hospedagem de site estático e back-to-origin baseado em espelhamento, consulte o exemplo no GitHub.
Para mais informações sobre a operação de API usada para configure a hospedagem de site estático ou o back-to-origin baseado em espelhamento, consulte PutBucketWebsite.
Para mais informações sobre a operação de API usada para recuperar a configuração da hospedagem de site estático ou do back-to-origin baseado em espelhamento, consulte GetBucketWebsite.
Para mais informações sobre a operação de API usada para exclua a configuração da hospedagem de site estático ou do back-to-origin baseado em espelhamento, consulte DeleteBucketWebsite.