rclone/vendor/github.com/yunify/qingstor-sdk-go/v3/README.md

2.7 KiB

QingStor SDK for Go

Build Status Go Report Card API Reference License

The official QingStor SDK for the Go programming language.

Getting Started

Installation

Refer to the Installation Guide, and have this SDK installed.

Preparation

Before your start, please go to QingCloud Console to create a pair of QingCloud API AccessKey.

API AccessKey Example:

access_key_id: 'ACCESS_KEY_ID_EXAMPLE'
secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE'

Usage

Now you are ready to code. You can read the detailed guides in the list below to have a clear understanding or just take the quick start code example.

Checkout our releases and change log for information about the latest features, bug fixes and new ideas.

Quick Start Code Example:

package main

import (
	"fmt"

	"github.com/yunify/qingstor-sdk-go/v3/config"
	qs "github.com/yunify/qingstor-sdk-go/v3/service"
)

func main() {
	conf, _ := config.New("ACCESS_KEY_ID", "SECRET_ACCESS_KEY")

	// Initialize service object for QingStor.
	qsService, _ := qs.Init(conf)

	// List all buckets.
	qsOutput, _ := qsService.ListBuckets(&qs.ListBucketsInput{})

	// Print HTTP status code.
	fmt.Println(qs.IntValue(qsOutput.StatusCode))

	// Print the count of buckets.
	fmt.Println(qs.IntValue(qsOutput.Count))

	// Print the first bucket name.
	fmt.Println(qs.StringValue(qsOutput.Buckets[0].Name))
}

Reference Documentations

Contributing

  1. Fork it ( https://github.com/yunify/qingstor-sdk-go/fork )
  2. Create your feature branch (git checkout -b new-feature)
  3. Commit your changes (git commit -asm 'Add some feature')
  4. Push to the branch (git push origin new-feature)
  5. Create a new Pull Request

LICENSE

The Apache License (Version 2.0, January 2004).