Listing Parallel File Systems (SDK for Go)

Updated on 2024-06-21 GMT+08:00

View PDF

Function

Parallel file systems (PFSs) are containers for storing objects in OBS. Files uploaded to OBS are stored as objects in PFSs. This API returns a list of all PFSs that meet the specified conditions in all regions of the current account. Returned PFSs are listed in alphabetical order by PFS name.

Restrictions

To list PFSs, you must have the obs:bucket:ListAllMyBuckets permission. IAM is recommended for granting permissions. For details, see IAM Custom Policies.

The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

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

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Mandatory (Yes/No)	Description
input	*ListBucketsInput	No	Explanation: Input parameters for listing PFSs. For details, see Table 2.

**Table 2** ListBucketsInput
Parameter	Type	Mandatory (Yes/No)	Description
QueryLocation	bool	No	Explanation: Whether to query the PFS location. Value range: true: The PFS location is queried. false: The PFS location is not queried. Default value: false
BucketType	BucketType	No	Explanation: Type of the buckets to be listed. Value range: See Table 3. Default value: If this parameter is not specified, all buckets and parallel file systems are listed.

**Table 3** BucketType
Constant	Default Value	Description
OBJECT	OBJECT	An object bucket
POSIX	POSIX	A parallel POSIX-compatible file bucket

Responses

**Table 4** List of returned results
Parameter	Type	Description
output	*ListBucketsOutput	Explanation: Returned results. For details, see Table 5.
err	error	Explanation: Error messages returned by the API

**Table 5** ListBucketsOutput
Parameter	Type	Description
StatusCode	int	Explanation: HTTP status code Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None
RequestId	string	Explanation: Request ID returned by the OBS server Default value: None
ResponseHeaders	map[string][]string	Explanation: HTTP response headers Default value: None
Owner	Owner	Explanation: PFS owner. Value range: See Table 6.
Buckets	[]Bucket	Explanation: PFS list. Value range: See Table 7.

**Table 6** Owner
Parameter	Type	Mandatory (Yes/No)	Description
ID	string	Yes if used as a request parameter	Explanation: Account (domain) ID of the owner Value range: To obtain the account ID, see How Do I Get My Account ID and User ID? Default value: None

**Table 7** Bucket
Parameter	Type	Description
Name	string	Explanation: Bucket name Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket. Default value: None
CreationDate	time.Time	Explanation: Time when the bucket was created Default value: None
Location	string	Explanation: Region where a bucket is located Restrictions: If the used endpoint is obs.myhuaweicloud.com, this parameter is not required. If any other endpoint is used, this parameter is required. Value range: To learn about valid regions and endpoints, see Regions and Endpoints. An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise administrator. Default value: If obs.myhuaweicloud.com is used as the endpoint and no region is specified, cn-north-1 (the CN North-Beijing1 region) is used by default.
BucketType	string	Explanation: Bucket type Value range: Object bucket: OBJECT Parallel file system: POSIX Default value: None

Code Examples

This example lists all PFSs.

    
     
       
       package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
    // securityToken := os.Getenv("SecurityToken")
    // Enter the endpoint corresponding to the region where the bucket is located. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // Create an obsClient instance.
    // If you use a temporary AK/SK pair and a security token to access OBS, use the obs.WithSecurityToken method to specify a security token when creating an instance.
    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{}
    // Specify whether to query the PFS location in the listing. The default value is false. true is used as an example.
    input.QueryLocation = true
    // Specify the type of the buckets to list. By default, all buckets and PFSs are listed. obs.POSIX is used as an example, indicating that all PFSs are listed.
    input.BucketType = obs.POSIX
    // List PFSs.
    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)
    }
}

      

    
   

Parent topic: Parallel File System APIs (SDK for Go)

Previous topic: Creating a Parallel File System (SDK for Go)

Next topic: Listing Objects in a Parallel File System (SDK for Go)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot