How to configure custom domain names and SSL certificates - Drive and Photo Service

After activating the Drive and Photo Service (PDS) Developer Edition, you can configure a custom enterprise domain name used to access the enterprise drive. You can also configure a custom data access domain name, API domain name, and logon authentication domain name. After a custom domain name is configured, the limit of 500 shares allowed to be created per day no longer applies.

Usage notes

To increase the number of shares allowed to be created per day and the number of allowed accesses to shares per day to above 500 and remove the restriction of not being able to download APK and IPA files in externally-faced shares, you must configure both a custom enterprise domain name and a custom data access domain name.
You can provide BasicUI for external users as your official drive application in your business operations, or you can use BasicUI as an application that is available only to internal users. In either case, if the number of times that users log on to BasicUI exceeds 1,000 daily, you must configure a custom domain name.
If you want to configure a custom API domain name or a logon authentication domain name, contact us to enable them for you.

Prerequisites

A PDS Developer Edition domain is created.
Only a super administrator or drive administrator can enable this feature.
You have enabled BasicUI.
You have registered a domain name.
If your service is deployed in a Chinese mainland region, ensure that you have completed ICP filing for the domain name.
A Secure Sockets Layer (SSL) certificate is prepared. If not, purchase one from Alibaba Cloud Certificate Management Service. For more information, see Purchase a commercial certificate and Apply for a certificate.

Important

If the ICP filing is not completed through the Alibaba Cloud ICP Filing system, the ICP filing status may not be found, which may cause the domain name mapping or access to fail.

Scenarios

Enterprise domain name

An enterprise domain name is a website address that should be easy to remember and reflects the enterprise identity.

Data access domain name

A data access domain name is used to access file data or used for transcoding and playback.

File transfer

This type of data access domain name is mainly used for transmission of files in the drive and external links. For example, configure a data access domain name for file uploads and downloads.

Value-added services

This type of data access domain name is mainly used for value-added services such as audio and video transcoding and playback. For example, configure a data access domain name for online video playback and package downloads.

API domain name

An API domain name is a domain name for API requests. Configure it so that your enterprise can use simpler and more intuitive API URLs.

Logon authentication domain name

A logon authentication domain name is a domain name used for logon authentication.

Procedure

Step 1: Configure DNS records

Obtain DNS record values.
Important
This section includes the steps to obtain DNS record values of different types of domain names. Follow these steps based on your business requirements.
Enterprise domain name
Perform the following steps to obtain the DNS record value of an enterprise domain name:
1. Log on to BasicUI and go to the admin console.
2. In the left-side navigation pane, choose Enterprise Settings > Standard Customization.
3. Record the Default Domain in the Enterprise Domain section. Example: example.apps.aliyunpds.com.
Data access domain name
Perform the following steps to obtain the DNS record value of a data access domain name:
1. Log on to BasicUI and go to the admin console.
2. In the left-side navigation pane, choose Enterprise Settings > Standard Customization.
3. Record the Default Domain in the Data Access Domain Name section.
  Important
  You need to configure two CNAME records for a domain name of each service type: one is used to resolve the custom domain name and the other is used to verify the ownership of the domain name. For more information, see Example of configuring DNS records for a data access domain name.
  www.example.com is an example of a custom data access domain name.
  example2.data.aliyunpds.com is an example of a default domain.
  1. Resolve the custom data access domain name:
    Hostname: www.example.com
    Record value: example2.data.aliyunpds.com
  2. Verify the ownership:
    Hostname: _dnsauth.www.example.com
    Record value: _dnsauth.www.example.com.example2.data.aliyunpds.com
4. Check the Default Domain fields under File transfer and Value-added service as needed.
API domain name
Perform the following steps to obtain the DNS record value of an API domain name:
1. Log on to BasicUI and go to the admin console.
2. In the left-side navigation pane, choose Enterprise Settings > Standard Customization.
3. Record the Default Domain in the API CNAME section. Example: example.api.aliyunpds.com.
Logon authentication domain name
Perform the following steps to obtain the DNS record value of a logon authentication domain name:
1. Log on to BasicUI and go to the admin console.
2. In the left-side navigation pane, choose Enterprise Settings > Standard Customization.
3. Record the Default Domain in the Auth CNAME section. Example: example.auth.aliyunpds.com.

Based on the service provider and account that owns the domain name, follow the corresponding steps to resolve the domain name to PDS.

Resolve a domain name registered with Alibaba Cloud DNS

Perform the following steps to map a domain name registered with Alibaba Cloud to PDS:

Log on to the Alibaba Cloud DNS console.
In the left-side navigation pane, choose Public DNS Resolution > Authoritative DNS Resolution. In the authoritative domain name list, find the target domain name and click DNS Settings in the Actions column.
On the page that appears, click Add DNS Record and fill in the information based on the following table.

Parameter	Description	Example
Record Type	Select CNAME.	CNAME
Hostname	Fill in the actual hostname that you want to use to access PDS.	www
DNS Request Source	The DNS line that is used to resolve the domain name. We recommend that you select Default. This way, the system will automatically select the optimal line.	Default
Record Value	Enter the default domain for your enterprise.	example.apps.aliyunpds.com
TTL Period	The update interval of the record. The minimum TTL value is 1 second. Note There is a certain delay before the TTL setting takes effect.	10 minutes

Resolve a domain name not registered with Alibaba Cloud DNS

Perform the following steps to map a domain name registered with another DNS provider (not Alibaba Cloud DNS) to PDS:

On the platform of your DNS provider, use the settings shown in the following table to add a CNAME record.

Parameter	Description	Example
Record Type	Select CNAME.	CNAME
Host Record	Fill in the actual hostname that you want to use to access PDS.	www
DNS Request Source	The DNS line that is used to resolve the domain name. We recommend that you select Default. This way, the system will automatically select the optimal line.	Default
Record Value	Enter the default domain for your enterprise.	example.apps.aliyunpds.com
TTL Period	The update interval of the record. The minimum TTL value is 1 second. Note There is a certain delay before the TTL setting takes effect.	10 minutes

Verify whether the DNS record takes effect.
After mapping the custom domain name, use the Alibaba Cloud Network Probing Tool to check the CNAME resolution results.
If the domain name resolution result shows the default enterprise domain, the CNAME record has taken effect.

Step 2: Configure the custom domain name

Important

Before you configure the custom domain name,

Ensure that the DNS record has taken effect.
Download an SSL certificate with the service type set to Other. The certificate includes two files: example.key and example.pem.

Log on to BasicUI and go to the admin console.
In the left-side navigation pane, choose Enterprise Settings > Standard Customization.

Click Configure Domain Name.

Parameter	Description	Example
Custom Domain	The domain name for which you have configured DNS records.	www.example.com
Certificate Name	The certificate name.	cert_xxxxx
Certificate Content	The entire content in the example.pem file of the SSL certificate. Note If the certificate is issued by an intermediate provider, the certificate content consists two parts: content of your downloaded certificate and content of an intermediate certificate issued by the intermediate provider.	-----BEGIN CERTIFICATE----- example -----END CERTIFICATE-----
Certificate Private Key	The entire content in the example.key file of the SSL certificate.	-----BEGIN RSA PRIVATE KEY----- example -----END RSA PRIVATE KEY-----

Click Set Now to complete the configuration.

Appendix

Example of configuring DNS records for a data access domain name

Note

The following domain names used are examples. Replace them with your actual domain names.

Assume that your domain name is aliyundoc.com.

You want to use the following custom domain name for file transfer: data.aliyundoc.com.
The default domain used for file transfer is 5b3ede2bf7464bcd8a76eed52975****.data.aliyunpds.com.

Configure a DNS record that is used to resolve the custom data access domain name.
- DNS record configuration:
  Parameter
  Example
  Record Type
  CNAME
  Hostname
  data
  DNS Request Source
  Default
  Record Value
  5b3ede2bf7464bcd8a76eed52975****.data.aliyunpds.com
  TTL Period
  10 minutes
- Example:
Configure a DNS record that is used to verify the ownership of the domain name.
- DNS record configuration:
  Parameter
  Example
  Record Type
  CNAME
  Hostname
  _dnsauth.data
  DNS Request Source
  Default
  Record Value
  _dnsauth.data.aliyundoc.com.5b3ede2bf7464bcd8a76eed52975****.data.aliyunpds.com
  TTL Period
  10 minutes
- Example:

FAQ

After I map a custom domain name, can I still use the default domain?

Yes.

How do I unmap a custom domain name?

If you no longer need to use a custom domain name, perform the following steps to unmap it:

Unmap the custom domain name.
1. Log on to BasicUI and go to the admin console.
2. In the left-side navigation pane, choose Enterprise Settings > Standard Customization.
3. On the Standard Customization page, find the domain name you want to unmap and click Delete Configuration.
Delete the DNS records.
After unmapping the custom domain name, you need to manually delete the DNS records that you configured. For more information, see Delete a DNS record.

What if the error message "Failed to add the certificate. Please try again." appears when I configure a custom domain name?

If the error occurs when you configure a custom domain name, check whether the certificate is correctly configured or has expired. Take note of the following items:

Certificate content: The entire content that starts with "-----BEGIN CERTIFICATE-----".

Certificate private key: The entire content that starts with "-----BEGIN RSA PRIVATE KEY-----".

Why does the custom domain name not take effect after mapping?

There is a certain delay after you configure DNS records. Wait for about 10 minutes and try again.