文档

Go限定条件下载

更新时间:

从Bucket中下载单个文件(Object)时,可以指定基于文件的最后修改时间或者ETag(文件内容的标识符)的限制条件。满足限定条件则下载,不满足限定条件则返回错误且不会触发下载行为。使用限定条件下载可以减少网络传输和资源消耗,提高下载效率。

注意事项

  • 本文以华东1(杭州)外网Endpoint为例。如果您希望通过与OSS同地域的其他阿里云产品访问OSS,请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系,请参见访问域名和数据中心

  • 本文以从环境变量读取访问凭证为例。如何配置访问凭证,请参见配置访问凭证

  • 本文以OSS域名新建OSSClient为例。如果您希望通过自定义域名、STS等方式新建OSSClient,请参见初始化

  • 要限定条件下载,您必须有oss:GetObject权限。具体操作,请参见为RAM用户授权自定义的权限策略

限定条件

OSS支持的限定条件如下:

说明
  • If-Modified-Since和If-Unmodified-Since可以同时存在。If-Match和If-None-Match也可以同时存在。

  • 您可以通过ossClient.getObjectMeta方法获取ETag。

参数

描述

如何设置

IfModifiedSince

如果指定的时间早于实际修改时间,则正常传输文件,否则返回错误(304 Not modified)。

oss.IfModifiedSince

IfUnmodifiedSince

如果指定的时间等于或者晚于文件实际修改时间,则正常传输文件,否则返回错误(412 Precondition failed)。

oss.IfUnmodifiedSince

IfMatch

如果指定的ETag和OSS文件的ETag匹配,则正常传输文件,否则返回错误(412 Precondition failed)。

oss.IfMatch

IfNoneMatch

如果指定的ETag和OSS文件的ETag不匹配,则正常传输文件,否则返回错误(304 Not modified)。

oss.IfNoneMatch

示例代码

以下代码用于限定条件下载。

package main

import (
    "fmt"
    "os"
    "time"
    "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 {
        fmt.Println("Error:", err)
        os.Exit(-1)
    }

    // 创建OSSClient实例。
    // yourEndpoint填写Bucket对应的Endpoint,以华东1(杭州)为例,填写为https://oss-cn-hangzhou.aliyuncs.com。其它Region请按实际情况填写。
    client, err := oss.New("yourEndpoint", "", "", oss.SetCredentialsProvider(&provider))
    if err != nil {
        fmt.Println("Error:", err)
        os.Exit(-1)
    }

    // yourBucketName填写存储空间名称。
    bucket, err := client.Bucket("yourBucketName")
    if err != nil {
        fmt.Println("Error:", err)
        os.Exit(-1)
    }

    // 假设Object最后修改时间为2023年11月21日18:43:02,则填写的UTC早于该时间时,将满足IfModifiedSince的限定条件,并触发下载行为。
    date := time.Date(2023, time.November, 21, 10, 40, 02, 0, time.UTC)

    // 不满足限定条件,不下载文件。
    // yourObjectName填写不包含Bucket名称在内的Object的完整路径。
    err = bucket.GetObjectToFile("yourObjectName", "LocalFile", oss.IfUnmodifiedSince(date))    
    if err == nil {
        fmt.Println("Error:", err)
        os.Exit(-1)
    }

    // 满足限定条件,下载文件。
    err = bucket.GetObjectToFile("yourObjectName", "LocalFile", oss.IfModifiedSince(date))
    if err != nil {
        fmt.Println("Error:", err)
        os.Exit(-1)
    }
}

相关文档

  • 关于限定条件下载的完整示例代码,请参见GitHub示例

  • 关于限定条件下载的API接口说明,请参见GetObject

  • 本页导读 (1)
文档反馈