文档首页/ 对象存储服务 OBS/ SDK参考/ Go/ 并行文件系统相关接口(Go SDK)/ 列举并行文件系统(Go SDK)
更新时间：2024-06-21 GMT+08:00
查看PDF
分享

列举并行文件系统(Go SDK)

功能介绍

OBS并行文件系统是对象的容器，您上传的文件都存放在并行文件系统中。调用获取并行文件系统列表接口，可列举当前账号所有地域下符合指定条件的并行文件系统。返回结果以并行文件系统名的字典序排序。

接口约束

  • 您必须拥有obs:bucket:ListAllMyBuckets权限，才能获取并行文件系统列表。建议使用IAM进行授权，配置方式详见使用IAM自定义策略。

方法定义

func (obsClient ObsClient) ListBuckets(input *ListBucketsInput) (output *ListBucketsOutput, err error)

请求参数说明

表1 请求参数列表

参数名称

参数类型

是否必选

描述

input

*ListBucketsInput

可选

参数解释：

获取并行文件系统列表入参，详情参考ListBucketsInput。
表2 ListBucketsInput

参数名称

参数类型

是否必选

描述

QueryLocation

bool

可选

参数解释：

是否同时查询并行文件系统的区域位置。

取值范围：

  • true：同时查询并行文件系统的区域位置
  • false：不查询并行文件系统的区域位置

默认取值：

false

BucketType

BucketType

可选

参数解释：

列举指定类型的并行文件系统。

取值范围：

并行文件系统类型取值可参见BucketType。

默认取值：

如果不赋值则默认获取所有桶和并行文件系统列表。
表3 BucketType

常量名

原始值

说明

OBJECT

OBJECT

对应类型为对象存储桶。

POSIX

POSIX

对应类型为并行文件系统（POSIX）。

返回结果说明

表4 返回结果列表

参数名称

参数类型

描述

output

*ListBucketsOutput

参数解释：

接口返回信息，详情参见ListBucketsOutput。

err

error

参数解释：

接口返回错误信息。
表5 ListBucketsOutput

参数名称

参数类型

描述

StatusCode

int

参数解释：

HTTP状态码。

取值范围：

状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态。完整的状态码列表请参见状态码。

默认取值：

无

RequestId

string

参数解释：

OBS服务端返回的请求ID。

默认取值：

无

ResponseHeaders

map[string][]string

参数解释：

HTTP响应头信息。

默认取值：

无

Owner

Owner

参数解释：

并行文件系统的所有者。

取值范围：

并行文件系统所有者取值参见Owner。

Buckets

[]Bucket

参数解释：

并行文件系统信息列表。

取值范围：

并行文件系统信息取值参见Bucket。
表6 Owner

参数名称

参数类型

是否必选

描述

ID

string

作为请求参数时必选

参数解释：

所有者的账号ID，即domain_id。

取值范围：

如何获取账号ID请参见如何获取账号ID和用户ID?

默认取值：

无
表7 Bucket

参数名称

参数类型

描述

Name

string

参数解释：

桶名。

约束限制：

  • 桶的名字需全局唯一，不能与已有的任何桶名称重复，包括其他用户创建的桶。
  • 桶命名规则如下：
    • 3～63个字符，数字或字母开头，支持小写字母、数字、“-”、“.”。
    • 禁止使用类IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻（如：“my..bucket”）。
    • 禁止“.”和“-”相邻（如：“my-.bucket”和“my.-bucket”）。

默认取值：

无

CreationDate

time.Time

参数解释：

桶的创建时间。

默认取值：

无

Location

string

参数解释：

桶所在的区域。

约束限制：

该参数定义了桶将会被创建在哪个区域，如果使用的终端节点是obs.myhuaweicloud.com，可以不携带此参数；如果使用的终端节点不是obs.myhuaweicloud.com，则必须携带此参数。

取值范围：

当前有效的OBS区域和终端节点的更多信息，请参考地区和终端节点。终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以向企业管理员获取区域和终端节点信息。

默认取值：

终端节点为obs.myhuaweicloud.com且用户未设定区域时，默认为华北-北京一（cn-north-1）。

BucketType

string

参数解释：

桶类型。

取值范围：

  • 对象桶：OBJECT
  • 并行文件系统：POSIX。

默认取值：

无

代码示例

本示例用于列举所有并行文件系统列表

 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 (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //推荐通过环境变量获取AKSK，这里也可以使用其他外部引入方式传入，如果使用硬编码可能会存在泄露风险。
    //您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html。
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。
    // securityToken := os.Getenv("SecurityToken")
    // endpoint填写Bucket对应的Endpoint, 这里以中国-香港为例，其他地区请按实际情况填写。
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // 创建obsClient实例
    // 如果使用临时AKSK和SecurityToken访问OBS，需要在创建实例时通过obs.WithSecurityToken方法指定securityToken值。
    obsClient, err := obs.New(ak, sk, endPoint/*, obs.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.ListBucketsInput{}
    // 指定桶列表中是否存在Location字段，此处以true为例，默认是false
    input.QueryLocation = true
    // 指定桶类型，此处以为obs.POSIX为例，即获取所有并行文件系统，默认不设置则获取所有桶和并行文件系统列表
    input.BucketType = obs.POSIX
    // 列举并行文件系统列表
    output, err := obsClient.ListBuckets(input)
    if err == nil {
        fmt.Printf("List buckets successful!\n")
        fmt.Printf("RequestId:%s\n", output.RequestId)
        for index, val := range output.Buckets {
            fmt.Printf("Bucket[%d]-Name:%s,CreationDate:%s\n", index, val.Name, val.CreationDate)
        }
        return
    }
    fmt.Printf("List buckets fail!\n")
    if obsError, ok := err.(obs.ObsError); ok {
        fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
        fmt.Println(obsError.Error())
    } else {
        fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
        fmt.Println(err)
    }
}