获取目录文件列表

SDK 提供ListObjects方法用于获取目录文件列表,完整代码详见Github

ListObjects方法请求的 US3 API 为 ListObjects,具体详见ListObjects API文档

参数说明

参数名 类型 说明
Prefix string 返回以Prefix作为前缀的目录文件列表, 为""时默认全匹配
Marker string 返回以字母排序后,大于Marker的目录文件列表
MaxKeys int 指定返回目录文件列表的最大数量,默认值为100,不超过1000
Delimiter string 目录分隔符,当前只支持"/"和"",当Delimiter设置为"/"时,非递归列举,Prefix需以"/"结尾;当Delimiter设置为""时,递归列举所有文件

非递归获取指定前缀的所有文件

示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
package main

import (
	ufsdk "github.com/ufilesdk-dev/ufile-gosdk"
	"log"
)

const (
	ConfigFile = "config.json"
	Prefix = "prefix/"
)

func main() {

	// 加载配置,创建请求
	config, err := ufsdk.LoadConfig(ConfigFile)
	if err != nil {
		panic(err.Error())
	}
	req, err := ufsdk.NewFileRequest(config, nil)
	if err != nil {
		panic(err.Error())
	}


	// fileList 存储列举的全部目录文件信息
	var fileList ufsdk.ListObjectsResponse
	Marker := ""
	for ;; {
		list, err := req.ListObjects(Prefix, Marker , "/", 0)
		if err != nil {
			log.Fatalf("获取目录文件列表失败,错误信息为:%s", err.Error())
		}
		fileList.Contents = append(fileList.Contents, list.Contents...)
		// 列举完成后返回的list.NextMarker为空, list.Contents 为此次列举返回的文件信息
		if len(list.Contents) == 0 || len(list.NextMarker) <= 0{
			break
		}
		Marker = list.NextMarker
	}
	log.Printf("获取目录文件列表成功, 文件列表长度为 %d", len(fileList.Contents))
}

递归获取指定前缀的所有文件

示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package main

import (
	ufsdk "github.com/ufilesdk-dev/ufile-gosdk"
	"log"
)

const (
	ConfigFile = "config.json"
	Prefix = "unzip/data/"
)

func main() {

	// 加载配置,创建请求
	config, err := ufsdk.LoadConfig(ConfigFile)
	if err != nil {
		panic(err.Error())
	}
	req, err := ufsdk.NewFileRequest(config, nil)
	if err != nil {
		panic(err.Error())
	}

	
	// fileList 存储列举的全部文件信息
	var fileList ufsdk.ListObjectsResponse
	Marker := ""
	for ;; {
		list, err := req.ListObjects(Prefix, Marker, "", 0)
		if err != nil {
			log.Fatalf("获取文件列表失败,错误信息为:%s", err.Error())
		}
		log.Printf("获取文件列表成功, 文件列表长度为 %d", len(list.Contents))
		log.Printf("获取文件列表成功, list.NextMarker %s", list.NextMarker)
		fileList.Contents = append(fileList.Contents, list.Contents...)
		if len(list.Contents) == 0 || len(list.NextMarker) <= 0{
			break
		}
		Marker = list.NextMarker
	}
	log.Printf("获取文件列表成功, 文件列表长度为 %d", len(fileList.Contents))
}

递归列举指定最大数量的文件列表

示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package main

import (
	ufsdk "github.com/ufilesdk-dev/ufile-gosdk"
	"log"
)

const (
	ConfigFile = "config.json"
	Prefix = ""
	MaxKeys = 1500
)

func main() {

	// 加载配置,创建请求
	config, err := ufsdk.LoadConfig(ConfigFile)
	if err != nil {
		panic(err.Error())
	}
	req, err := ufsdk.NewFileRequest(config, nil)
	if err != nil {
		panic(err.Error())
	}
	
	// fileList 存储列举的全部文件信息
	var fileList ufsdk.ListObjectsResponse
	Marker := ""
	for {
		list, err := req.ListObjects("", Marker, "", 0)
		if err != nil {
			log.Fatalf("获取文件列表失败,错误信息为:%s", err.Error())
		}
		if len(list.Contents) >= MaxKeys {
			fileList.Contents = append(fileList.Contents, list.Contents[:MaxKeys]...)
			break
		}
		fileList.Contents = append(fileList.Contents, list.Contents...)
		MaxKeys = MaxKeys - len(list.Contents)
		if len(list.NextMarker) <= 0 {
			break
		}
		Marker = list.NextMarker
	}
	log.Printf("获取文件列表成功, 文件列表长度为 %d", len(fileList.Contents))
}

递归列举指定Marker之后的所有文件

示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
package main

import (
	ufsdk "github.com/ufilesdk-dev/ufile-gosdk"
	"log"
)

const (
	ConfigFile = "config.json"
	Marker = "" 
)

func main() {

	// 加载配置,创建请求
	config, err := ufsdk.LoadConfig(ConfigFile)
	if err != nil {
		panic(err.Error())
	}
	req, err := ufsdk.NewFileRequest(config, nil)
	if err != nil {
		panic(err.Error())
	}
	
	// fileList 存储列举的全部文件信息
	var fileList ufsdk.ListObjectsResponse
	curMarker := Marker
	for ;; {
		list, err := req.ListObjects("", curMarker, "", 0)
		if err != nil {
			log.Fatalf("获取文件列表失败,错误信息为:%s", err.Error())
		}
		fileList.Contents = append(fileList.Contents, list.Contents...)
		if len(list.NextMarker) <= 0{
			break
		}
		curMarker = list.NextMarker
	}
	log.Printf("获取文件列表成功, 文件列表长度为 %d", len(fileList.Contents))
}

列举指定前缀、指定Marker之后、指定递归方式、指定最大数量的文件列表

示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package main

import (
	ufsdk "github.com/ufilesdk-dev/ufile-gosdk"
	"log"
)

const (
	ConfigFile = "config.json"
	Prefix = ""
	Marker = ""
	Delimiter = ""
	MaxKeys = 1000
)

func main() {

	// 加载配置,创建请求
	config, err := ufsdk.LoadConfig(ConfigFile)
	if err != nil {
		panic(err.Error())
	}
	req, err := ufsdk.NewFileRequest(config, nil)
	if err != nil {
		panic(err.Error())
	}
	
	// fileList 存储列举的全部目录文件信息
	var fileList ufsdk.ListObjectsResponse 
	curMarker := Marker
	curMaxKeys := MaxKeys
	for ;; {
	list, err := req.ListObjects(Prefix, curMarker, Delimiter, curMaxKeys)
		if err != nil {
			log.Fatalf("获取目录文件列表失败,错误信息为:%s", err.Error())
		}
		fileList.Contents = append(fileList.Contents, list.Contents...)
		if len(list.NextMarker) <= 0 || curMaxKeys <= 0{
			break
		}
		curMarker = list.NextMarker
		curMaxKeys = curMaxKeys - len(list.Contents)
	}
	log.Printf("获取目录文件列表成功, 文件列表长度为 %d", len(fileList.Contents))
}

错误码

HTTP 状态码 RetCode ErrMsg 描述
400 -148653 bucket not exists 存储空间不存在
400 -15036 check md5 failed MD5校验失败
401 -148643 no authorization found 上传凭证错误
403 -148643 invalid signature API公私钥错误
404 -148654 file not exist 文件不存在
400 -15005 invalid delimiter:xxx delimiter 取值为 "" 或 "/"
400 -15005 invalid maxkeys:xxx maxkeys 取值范围 [0, 1000]