文件(Object)上传至存储空间(Bucket)后,OSS 会自动生成文件的 URL,您可以直接通过该 URL(即 Bucket 的外网访问域名)访问文件。如果您希望使用自定义域名访问这些 Object,需要添加 CNAME 记录将自定义域名绑定到 Object 所在的 Bucket。
注意事项
本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见OSS访问域名、数据中心、开放端口。
本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见配置访问凭证。
本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见初始化。
示例代码
创建CnameToken
以下代码用于创建CnameToken。
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
// yourRegion填写Bucket所在地域,以华东1(杭州)为例,填写为cn-hangzhou。其它Region请按实际情况填写。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 设置签名版本
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 填写自定义域名。
cname := "www.example.com"
// 创建CNAME Token
cbResult, err := client.CreateBucketCnameToken(bucketName, cname)
if err != nil {
log.Fatalf("Failed to create CNAME token: %v", err)
}
// 输出CNAME Token信息
log.Printf("Cname: %s", cbResult.Cname)
log.Printf("Token: %s", cbResult.Token)
log.Printf("ExpireTime: %s", cbResult.ExpireTime)
}
获取CnameToken
以下代码用于获取CnameToken。
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
// yourRegion填写Bucket所在地域,以华东1(杭州)为例,填写为cn-hangzhou。其它Region请按实际情况填写。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 设置签名版本
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 填写自定义域名。
cname := "www.example.com"
// 获取CnameToken
cbResult, err := client.GetBucketCnameToken(bucketName, cname)
if err != nil {
log.Fatalf("Failed to get CNAME token: %v", err)
}
// 输出CnameToken信息
log.Printf("Cname: %s", cbResult.Cname)
log.Printf("Token: %s", cbResult.Token)
log.Printf("ExpireTime: %s", cbResult.ExpireTime)
}
添加CNAME记录
绑定自定义域名
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
// yourRegion填写Bucket所在地域,以华东1(杭州)为例,填写为cn-hangzhou。其它Region请按实际情况填写。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 设置签名版本
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 填写自定义域名。
cname := "www.example.com"
// 绑定自定义域名到Bucket
err = client.PutBucketCname(bucketName, cname)
if err != nil {
log.Fatalf("Failed to put bucket CNAME: %v", err)
}
// 输出成功信息
log.Println("Put Bucket Cname Success!")
}
绑定自定义域名和证书
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
// yourRegion填写Bucket所在地域,以华东1(杭州)为例,填写为cn-hangzhou。其它Region请按实际情况填写。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 设置签名版本
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 配置CNAME和证书
putCnameConfig := oss.PutBucketCname{
Cname: "www.example.com",
CertificateConfiguration: &oss.CertificateConfiguration{
CertId: "92******-cn-hangzhou",
Certificate: "-----BEGIN CERTIFICATE-----MIIGeDCCBOCgAwIBAgIRAPj4FWpW5XN6kwgU7*******-----END CERTIFICATE-----",
PrivateKey: "-----BEGIN CERTIFICATE-----MIIFBzCCA++gT2H2hT6Wb3nwxjpLIfXmSVcV*****-----END CERTIFICATE-----",
Force: true,
},
}
// 绑定自定义域名和证书
err = client.PutBucketCnameWithCertificate(bucketName, putCnameConfig)
if err != nil {
log.Fatalf("Failed to bind CNAME and certificate: %v", err)
}
// 输出成功信息
log.Println("Bind Certificate Success!")
}
解除证书
如果您不希望该域名继续使用该证书,可以执行解绑证书的操作。
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
// yourRegion填写Bucket所在地域,以华东1(杭州)为例,填写为cn-hangzhou。其它Region请按实际情况填写。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 设置签名版本
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Failed to create OSS client: %v", err)
}
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 配置CNAME和删除证书
putCnameConfig := oss.PutBucketCname{
Cname: "www.example.com",
CertificateConfiguration: &oss.CertificateConfiguration{
DeleteCertificate: true,
},
}
// 绑定自定义域名并删除证书
err = client.PutBucketCnameWithCertificate(bucketName, putCnameConfig)
if err != nil {
log.Fatalf("Failed to unbind CNAME and delete certificate: %v", err)
}
// 输出成功信息
log.Println("Unbind Certificate Success!")
}
查看CNAME记录
以下代码用于查看CNAME记录。
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Error: %v", err)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
// yourRegion填写Bucket所在地域,以华东1(杭州)为例,填写为cn-hangzhou。其它Region请按实际情况填写。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 设置签名版本
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Error: %v", err)
}
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 查看CNAME记录。
cnResult, err := client.ListBucketCname(bucketName)
if err != nil {
log.Fatalf("Error: %v", err)
}
var certificate oss.Certificate
log.Printf("Bucket: %s", cnResult.Bucket)
log.Printf("Owner: %s", cnResult.Owner)
if len(cnResult.Cname) > 0 {
for _, cnameInfo := range cnResult.Cname {
// 打印自定义域名。
log.Printf("Domain: %s", cnameInfo.Domain)
// 打印绑定自定义域名的时间。
log.Printf("LastModified: %s", cnameInfo.LastModified)
// 打印域名所处状态。
log.Printf("Status: %s", cnameInfo.Status)
if cnameInfo.Certificate != certificate {
// 打印证书来源。
log.Printf("Type: %s", cnameInfo.Certificate.Type)
// 打印证书ID。
log.Printf("CertId: %s", cnameInfo.Certificate.CertId)
// 打印证书状态。
log.Printf("Status: %s", cnameInfo.Certificate.Status)
// 打印证书绑定时间。
log.Printf("CreationDate: %s", cnameInfo.Certificate.CreationDate)
// 打印证书签名。
log.Printf("Fingerprint: %s", cnameInfo.Certificate.Fingerprint)
// 打印证书有效期起始时间。
log.Printf("ValidStartDate: %s", cnameInfo.Certificate.ValidStartDate)
// 打印证书有效期终止时间。
log.Printf("ValidEndDate: %s", cnameInfo.Certificate.ValidEndDate)
}
}
}
}
删除CNAME记录
以下代码用于删除CNAME记录。
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 从环境变量中获取访问凭证。运行本代码示例之前,请确保已设置环境变量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Error: %v", err)
}
// 创建OSSClient实例。
// yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
// yourRegion填写Bucket所在地域,以华东1(杭州)为例,填写为cn-hangzhou。其它Region请按实际情况填写。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 设置签名版本
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Error: %v", err)
}
// 填写Bucket名称,例如examplebucket。
bucketName := "examplebucket"
// 填写自定义域名。
cname := "www.example.com"
// 删除CNAME记录
err = client.DeleteBucketCname(bucketName, cname)
if err != nil {
log.Fatalf("Error: %v", err)
}
// 输出成功信息
log.Println("Delete Bucket Cname Success!")
}
相关文档
关于创建域名所有权验证所需的CnameToken的API接口说明,请参见CreateBucketCnameToken。
关于获取CnameToken的API接口说明,请参见GetBucketCnameToken。
关于添加CNAME记录的API接口说明,请参见PutBucketCname。
关于查看CNAME记录的API接口说明,请参见ListBucketCname。
关于删除CNAME记录的API接口说明,请参见DeleteBucketCname。
文档内容是否对您有帮助?