QingCloud 文档 – SDK - kaiyun官方网站下载手机网页

Storage: Python SDK

Fri, 28 Feb 2020 10:08:56 +0900

QingStor 对象存储的新版 Python SDK，已在 GitHub 开源。本文为简要使用文档，更多详细信息请参见 GitHub 项目和 Python SDK API 文档。

Python SDK 使用 Snips 工具生成，各接口的调用均与 QingStor 对象存储的 API 相对应。其返回码、请求头、错误码等规定请参照具体的 Qingstor Restful API 文档。

使用 SDK 之前请先在管理控制台申请 Access key。

安装

qingstor-sdk 自 v2.3.0 后，仅支持 python v3.6 及以上的版本。

故，安装 qingstor-sdk 时，需确认当前环境中的 python 版本是否满足要求。若 python 版本低于 v3.6，则在使用该 SDK 的过程中，会出错。

使用 Pip 安装:

> pip install qingstor-sdk

初始化服务

发起请求前需要初始化服务。以下代码初始化了一个 QingStor Service。

from qingstor.sdk.service.qingstor import QingStor
from qingstor.sdk.config import Config

config = Config('ACCESS_KEY_ID_EXAMPLE', 'SECRET_ACCESS_KEY_EXAMPLE')
qingstor = QingStor(config)

代码示例

获取账户下的 Bucket 列表

# List all buckets.
output = qingstor.list_buckets()

# Print HTTP status code.
print(output.status_code)

# Print the buckets.
print(output['buckets'])

创建 Bucket

初始化并创建 Bucket, 需要指定 Bucket 名称和所在 Zone:

bucket = qingstor.Bucket('test-bucket', 'pek3a')
output = bucket.put()

获取 Bucket 中存储的 Object 列表

output = bucket.list_objects()

# Print the HTTP status code.
# Example: 200
print(output.status_code)

# Print the key count.
# Example: 7
print(output['keys'])

创建一个 Object

上传一个文件:

with open('/tmp/sdk_bin', 'rb') as f:
    output = bucket.put_object(
        'example_key', body=f
    )

# Print the HTTP status code.
# Example: 201
print(output.status_code)

删除一个 Object

output = bucket.delete_object('example_key')

# Print the HTTP status code.
# Example: 204
print(output.status_code)

设置 Bucket ACL

output = bucket.put_acl(acl=[
    {
        'grantee': {
            'type': 'group',
            'name': 'QS_ALL_USERS'
        },
        'permission': 'FULL_CONTROL'
    }
])

# Print the HTTP status code.
# Example: 200
print(output.status_code)

Storage: Go SDK

Wed, 25 Nov 2020 10:08:56 +0900

QingStor 对象存储的 Go SDK 已在 GitHub 开源，本文为简要使用文档。更多详细信息请参见 GitHub 项目和 Godoc。

使用 SDK 之前请先在管理控制台申请 Access key。

安装

可以直接访问 GitHub 的 release 页面下载压缩包进行安装，也可通过如下步骤进行安装：

执行如下命令行，使用 go get 安装:

> go get -u github.com/qingstor/qingstor-sdk-go

安装完成后，可执行如下命令行查看相关文档

> godoc github.com/qingstor/qingstor-sdk-go

备注：

要求使用 Go 1.5 或以上的 Go 版本。
若版本为 1.5 还需设置 GO15VENDOREXPERIMENT=1。
从 Go SDK v3.0 版本起，Go SDK 也支持 go module 引入，可以在项目中的 go.mod 文件中引入指定版本的 SDK 即可。

初始化服务

发起请求前需要初始化服务。以下代码初始化了一个 QingStor Service。

import (
    "github.com/qingstor/qingstor-sdk-go/config"
    qs "github.com/qingstor/qingstor-sdk-go/service"
    qsErrors "github.com/qingstor/qingstor-sdk-go/request/errors"
)

configuration, _ := config.New("ACCESS_KEY_ID", "SECRET_ACCESS_KEY")
qsService, _ := qs.Init(configuration)

代码示例

获取账户下的 Bucket 列表

qsOutput, _ := qsService.ListBuckets(nil)

// Print the HTTP status code.
// Example: 200
fmt.Println(qs.IntValue(qsOutput.StatusCode))

// Print the bucket count.
// Example: 5
fmt.Println(qs.IntValue(qsOutput.Count))

创建 Bucket

初始化并创建 Bucket, 需要指定 Bucket 名称和所在 Zone:

bucket, _ := qsService.Bucket("test-bucket", "pek3a")
putBucketOutput, _ := bucket.Put()

取 Bucket 中存储的 Object 列表

bOutput, err := bucket.ListObjects(nil)

// Print the HTTP status code.
// Example: 200
fmt.Println(qs.IntValue(bOutput.StatusCode))

// Print the key count.
// Example: 0
fmt.Println(len(bOutput.Keys))

创建一个 Object

例如上传一张屏幕截图:

// Open file
if file, err := os.Open("/tmp/Screenshot.jpg"); err != nil {
    panic(err)
}
defer file.Close()

// Put object
oOutput, err := bucket.PutObject("Screenshot.jpg", &service.PutObjectInput{Body: file})

// 所有 >= 400 的 HTTP 返回码都被视作错误
if err != nil {
    // Example: QingStor Error: StatusCode 403, Code "permission_denied"...
    fmt.Println(err)
} else {
    // Print the HTTP status code.
    // Example: 201
    fmt.Println(qs.IntValue(oOutput.StatusCode))
}

下载一个文件

getOutput, err := bucket.GetObject(
        "Screenshot.jpg",
        &service.GetObjectInput{},
)

if err != nil {
        // Example: QingStor Error: StatusCode 404, Code "object_not_exists"...
        fmt.Println(err)
        if qsErr, ok := err.(*qsErrors.QingStorError); ok {
                println(qsErr.StatusCode, qsErr.Code)
        }
} else {
        defer getOutput.Close() // 一定记得关闭GetObjectOutput, 否则容易造成链接泄漏
        f, err := os.OpenFile("download_screenshot.jpg", os.O_CREATE|os.O_WRONLY, 0600)
        if err != nil {
            panic(err)
        }
        defer f.Close()
        // Download with 32k temporary buffer
        err = io.CopyBuffer(f, getOutput.Body, make([]byte, 32*1024))
        if err != nil {
            panic(err)
        }
}

删除一个 Object

oOutput, _ := bucket.DeleteObject("Screenshot.jpg")

// Print the HTTP status code.
// Example: 204
fmt.Println(qs.IntValue(oOutput.StatusCode))

设置 Bucket ACL

bACLOutput, _ := bucket.PutACL(&service.PutBucketACLInput{
    ACL: []*service.ACLType{
        {
            Grantee: &service.GranteeType{
                Type: qs.String("user"),
                ID:   qs.String("usr-xxxxxxxx"),
            },
            Permission: qs.String("FULL_CONTROL"),
        },
    },
})

// Print the HTTP status code.
// Example: 200
fmt.Println(qs.IntValue(bACLOutput.StatusCode))

分段上传

初始化分段上传

initOutput, err := bucket.InitiateMultipartUpload(
    "QingCloudInsight.mov",
    &service.InitiateMultipartUploadInput{
        ContentType: qs.String("video/quicktime"),
    },
)

// Print the HTTP status code.
// Example: 200
fmt.Println(qs.IntValue(initOutput.StatusCode))

// Print the upload ID.
// Example: "9d37dd6ccee643075ca4e597ad65655c"
fmt.Println(qs.StringValue(initOutput.UploadID))

上传两个分段

uploadOutput, err := bucket.UploadMultipart(
    "QingCloudInsight.mov",
    &service.UploadMultipartInput{
        UploadID:   qs.String(initOutput.UploadID),
        PartNumber: qs.Int(0),
        ContentMD5: qs.String(md5String0),
        Body:       file0,
    },
)

// Print the HTTP status code.
// Example: 201
fmt.Println(qs.IntValue(uploadOutput.StatusCode))

uploadOutput, err = bucket.UploadMultipart(
    "QingCloudInsight.mov",
    &service.UploadMultipartInput{
        UploadID:   qs.String(initOutput.UploadID),
        PartNumber: qs.Int(1),
        ContentMD5: qs.String(md5String1),
        Body:        file1,
    },
)

完成分段上传

completeOutput, err := bucket.CompleteMultipartUpload(
    "QingCloudInsight.mov",
    &service.CompleteMultipartUploadInput{
        UploadID:    qs.String(initOutput.UploadID),
        ObjectParts: []*service.ObjectPart{
            {PartNumber: qs.Int(0)},
            {PartNumber: qs.Int(1)},
        },
    },
)

// Print the HTTP status code.
// Example: 200
fmt.Println(qs.IntValue(completeOutput.StatusCode))

取消分段上传

abrtOutput, err := bucket.AbortMultipartUpload(
    "QingCloudInsight.mov"
    &service.AbortMultipartUploadInput{
        UploadID:  qs.String(initOutput.UploadID),
    },
)

// Print the error message.
// Example: QingStor Error: StatusCode 400, Code...
fmt.Println(err)

Storage: Ruby SDK

Wed, 25 Nov 2020 10:08:56 +0900

QingStor 对象存储的 Ruby SDK 已在 GitHub 开源，本文为简要使用文档。更多详细信息请参见 GitHub 项目。

使用 SDK 之前请先在管理控制台申请 Access key。

安装

QingStor 对象存储提供两个安装方式，用户可根据需求选用。

方式一： 直接 Ruby Gem 安装:

> gem install qingstor-sdk

方式二： 从源码安装:

> git clone git@github.com:qingstor/qingstor-sdk-ruby.git
> cd qingstor-sdk-ruby
> bundle install
> bundle exec rake install

初始化服务

发起请求前需要初始化服务。以下代码初始化了一个 QingStor Service。

require 'qingstor/sdk'

config = QingStor::SDK::Config.init 'ACCESS_KEY_ID', 'SECRET_ACCESS_KEY'
qs_service = QingStor::SDK::Service.new config

代码示例

获取账户下的 Bucket 列表

result = qs_service.list_buckets

# Print HTTP status code
puts result[:status_code]

# Print bucket count
puts result[:buckets].length

创建 Bucket

初始化并创建 Bucket, 需要指定 Bucket 名称和所在 Zone:

bucket = qs_service.bucket 'test-bucket', 'pek3a'
putBucketOutput = bucket.put

获取 Bucket 中存储的 Object 列表

result = bucket.list_objects

# Print HTTP status code
puts result[:status_code]

# Print keys count
puts result[:keys].length

创建一个 Object

例如上传一张屏幕截图:

file_path = File.expand_path '~/Desktop/Screenshot.jpg'
result = bucket.put_object 'Screenshot.jpg', body: File.open(file_path)

# Print HTTP status code.
puts result[:status_code]

Storage: C/C++ SDK

Mon, 01 Jan 0001 00:00:00 +0000

QingStor 对象存储的 C/C++ SDK 已在 GitHub 开源，本文为简要使用文档。更多详细信息请参见 GitHub 项目。

本 SDK 使用 Snips 工具生成，各接口的调用均与 QingStor 对象存储的 API 相对应。其返回码、请求头、错误码等规定请参照具体的 Qingstor Restful API 文档。

本SDK提供了 C 和 C++ 两套接口，这两套接口在使用上方式上有所差别，请您阅读相应的使用说明文档，了解具体细节。

安装

本 SDK 目前仅支持源码编译安装方式，详细操作如下：

安装依赖

需在本地安装 Visual Studio 2013 或更高版本，或者 GCC 编译器 4.1.2 或更高版本。
若用户使用 Linux 平台进行编译，还需安装 SDK 依赖的第三方库：libcurl 和 libopenssl。可以参照以下操作步骤：

在 Debian/Ubuntu 系列系统请使用一下命令安装
```
> sudo apt-get install libcurl4-openssl-dev libssl-dev
```
在 Redhat/Fedora 系列系统请使用一下命令安装
```
> sudo yum install libcurl-devel openssl-devel
```

获取源码

qingstor-sdk 目前正在 GitHub 上活跃开发中，代码开源在此处。您也可以 Clone 这个公开的仓库:

> git clone https://github.com/yunify/qingstor-sdk-cpp.git

编译步骤

安装 CMake 工具。若您当前使用的 CMake 工具版本低于 2.8，请参照 CMake 的官方安装指导下载安装最新版本, 或通过源码编译安装。
创建 build 目录：

> cd BUILD_DIR
> cmake <path-to-root-of-this-source-code>

若用户需要编译 Release 版本，请执行以下 CMake 命令：

> cmake -DCMAKE_BUILD_TYPE=Release  <path-to-root-of-this-source-code>
> make
> sudo make install

编译标准C接口

SDK 默认编译不生成标准 C 接口，若用户希望编译包含标准 C 接口的 SDK，请执行以下 CMake 命令：

> cmake -DBUILD_C_STYLE_INTERFACE=ON  <path-to-root-of-this-source-code>

快速开始

Storage: Java SDK

Mon, 01 Jan 0001 00:00:00 +0000

QingStor 对象存储的 Java SDK 已在 GitHub 开源，本文为简要使用文档。更多详细信息请参见 GitHub 项目和 Java SDK API 文档。

Java SDK 使用 Snips 工具生成，各接口调用的均与 QingStor 对象存储的 API 相对应。其返回码、请求头、错误码等规定请参照具体的 Qingstor Restful API 文档。

SDK 示例请参见 SDK Example。

使用 SDK 之前请先在管理控制台申请 Access key。

安装

可以直接访问 GitHub 的 Release 页面下载压缩包，也可以执行如下命令行下载源码:

> git clone git@github.com:qingstor/qingstor-sdk-java.git

在 gradle/maven 中将版本替换为您需要的版本，QingStor 对象存储推荐使用最新的版本。

Gradle:

dependencies {
  implementation 'com.yunify:qingstor.sdk.java:2.5.1'
}

Maven:

<dependency>
  <groupId>com.yunify</groupId>
  <artifactId>qingstor.sdk.java</artifactId>
  <version>2.5.1</version>
</dependency>

初始化服务

发起请求前需要初始化服务。以下代码初始化了一个 QingStor Service。

import com.qingstor.sdk.config.EnvContext;
import com.qingstor.sdk.service.*;

EvnContext env = new EnvContext("ACCESS_KEY_ID", "SECRET_ACCESS_KEY");
QingStor stor = new QingStor(env);

说明：

代码行中的 env 承载了用户的认证信息及 SDK 配置；
代码行中的 stor 用于操作 QingStor 对象存储服务，如调用 Service 级别的 API 或创建指定的 Bucket 对象来调用 Bucket 和 Object 级别的 API。

代码示例

获取账户下的 Bucket 列表

ListBucketsOutput listOutput = stor.listBuckets(null);

创建 Bucket

初始化并创建 Bucket，需要指定 Bucket 名称和所在 Zone:

// 您要在哪个 zone 创建/操作 bucket.
String zoneName = "pek3b";
Bucket bucket = stor.getBucket("您的 bucket 名字", zoneName);
Bucket.PutBucketOutput output = bucket.put();
if (output.getStatueCode() == 201) {
    // Created
    System.out.println("Put Bucket: Created.");
}

获取 Bucket 中存储的 Object 列表

Bucket.ListjavaObjectsOutput listObjectsOutput = Bucket.listObjects(null);
List<KeyModel> objectKeys = listObjectsOutput.getKeys();

创建一个 Object

上传一个文件

String objKey = "object_name";
Bucket.PutObjectInput input = new Bucket.PutObjectInput();
// input 可以设置 File, Stream 等作为要上传的内容.
File f = new File("test_file.txt");
input.setBodyInputFile(f);
// 可选设置.
input.setContentType("text/plain");
input.setContentLength(f.length());
Bucket.PutObjectOutput putObjectOutput = bucket.putObject(objKey, input);

上传一个流式文件

流式上传前计算流的 MD5 值，详细内容如下：

    private void put(String key, InputStream body) throws QSException {
        Bucket.PutObjectInput input = new Bucket.PutObjectInput();
        try {
            MessageDigest md5 = MessageDigest.getInstance("MD5");
            // 这里只起示例作用, 如果 body size 有可能非常大, 按一定 size 做拆分以分段
            // 上传形式来分 part 计算 md5 上传才是比较经济的方式.
            byte[] data = body.readAllBytes();
            String contentMD5 = Base64.getEncoder().encodeToString(md5.digest(data));
            input.setContentMD5(contentMD5);
            // 此时 stream 已经被 consume 掉, 但对象存储 server side 也需要读取 body 内容,
            //  所以在 setBodyInputStream 之前,  可以通过:
            //  1. 流已经读取为 bytes array, 直接构造 ByteArrayInputStream 即可;
            // body = new ByteArrayInputStream(data);
            //  2. 如果流支持 markSupported(), 可以重设到流的开始.
            //  下面是方式 2 的示例:
            body.reset();
            input.setBodyInputStream(body);
        } catch (NoSuchAlgorithmException | IOException e) {
            throw new QSException("");
        }
        Bucket.PutObjectOutput output = bucket.putObject(key, input);
        System.out.println(output.getStatueCode());
        if (output.getStatueCode() == 201) {
            System.out.println(output.getETag());
        } else {
            System.out.println(output.getCode());
            System.out.println(output.getMessage());
        }
        System.out.println(output.getRequestId());
    }

删除一个 Object

Bucket.DeleteObjectOutput deleteObjectOutput = bucket.deleteObject("test_file");

本地时间和网络时间不同步

如果用户本地时间与网络时间不同步会因签名原因造成请求失败。用户还需要从服务端获取网络时间。

获取服务端时间：

Calendar instance = Calendar.getInstance(TimeZone.getTimeZone("Asia/Beijing"));
String gmtTime = QSSignatureUtil.formatGmtDate(instance.getTime());
return gmtTime;

将获取到的服务端时间设置到 SDK 中：

reqHandler.getBuilder().setHeader(QSConstant.HEADER_PARAM_KEY_DATE, gmtTime);
reqHandler.sendAsync();

使用服务端签名

以上传文件为例：

public static void javaSdkSendDemo() {
    try {
        //引入jar包后先把相关导入按照IDE提示一一导入
        //创建EvnContext
        EnvContext env = new EnvContext("your_access_key", "your_secret_key");

        //你的bucket所在的zone,比如pek3a
        String zoneName = "pek3a";

        //bucket名称，如果没有创建先从控制台或者api创建bucket
        String bucketName = "demo_bucket";
        Bucket bucket = new Bucket(env, zoneName, bucketName);

        //最终上传到对象存储的文件显示的文件名称
        String objectKey = "myfile";
        Bucket.PutObjectInput input = new Bucket.PutObjectInput();

        //要上传的本地文件的路径
        File f = new File("/your_file_path.txt");
        input.setBodyInputFile(f);
        input.setContentLength(f.length());
        RequestHandler reqHandler = bucket.putObjectAsyncRequest(objectKey, input,
                new ResponseCallBack<Bucket.PutObjectOutput>() {
                    public void onAPIResponse(Bucket.PutObjectOutput output) {
                        if (output.getStatueCode() != 201) {
                            System.out.println("Message = " + output.getMessage());
                            System.out.println("RequestId = " + output.getRequestId());
                            System.out.println("Code = " + output.getCode());
                            System.out.println("StatueCode = " + output.getStatueCode());
                            System.out.println("Url = " + output.getUrl());
                        }
                        System.exit(0);
                    }
                });
        Calendar instance = Calendar.getInstance(TimeZone.getTimeZone("Asia/Shanghai"));
        String gmtTime = QSSignatureUtil.formatGmtDate(instance.getTime());

        //验证需要这个Date header
        reqHandler.getBuilder().setHeader(QSConstant.HEADER_PARAM_KEY_DATE, gmtTime);
        String strToSignature = reqHandler.getStringToSignature();
        String serverAuthorization = QSSignatureUtil.generateSignature(env.getAccessSecret(),
                strToSignature);
        reqHandler.setSignature(env.getAccessKey(), serverAuthorization);
        //异步发送
        reqHandler.sendAsync();

    }catch (QSException e) {
        e.printStackTrace();
    }
}

Storage: JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

QingStor 对象存储的 JavaScript SDK 已在 GitHub 开源，本文为简要使用文档。更多详细信息请参见 GitHub 项目。

安装

QingStor 对象存储提供若干安装方式，用户可根据需求进行选用。

方式一： 使用 npm 安装 SDK：

npm install qingstor-sdk

方式二： 使用 yarn 安装 SDK：

yarn add qingstor-sdk

方式三： 也可以请前往 Release 页面下载打包好的 SDK 文件，然后在 HTML 中加上如下格式的 Script 标签引入 SDK，QingStor 对象存储建议用户在开发时使用未压缩的版本，方便调试，在生产环境中使用 qingstor-sdk.min.js 版本。

<script src="https://example.com/path/to/qingstor-sdk.js"></script>
<script>
  // reference sdk by a global variable: qingstor_sdk
  console.log(qingstor_sdk.version);
  console.log(qingstor_sdk.QingStor);
  console.log(qingstor_sdk.Config);
</script>

快速开始

QingStor SDK 使用 ES6 的语法编写，所以使用前请确保你配置了合适的构建环境。

浏览器环境

如果您是在浏览器中使用 SDK，推荐使用 Babel 对代码进行编译，使用 Webpack 打包代码。详细操作步骤如下：

安装 Babel:

npm install --save-dev @babel/core @babel/cli @babel/preset-env

安装完成之后，在项目的根目录下新建 babel.config.js 文件，其内容如下:

const presets = [
  [
    "@babel/env",
    {
      targets: {
        edge: "17",
        firefox: "60",
        chrome: "67",
        safari: "11.1",
      },
      useBuiltIns: "usage",
    },
  ],
];

module.exports = { presets };

安装 webpack:

npm install --save-dev webpack webpack-cli

安装完成之后，在项目的根目录下新建 webpack.config.js 文件，其内容如下:

module.exports = {
  mode: 'development',

  // 项目的启动文件, 你可以在这里 import { QingStor } from 'qingstor-sdk'
  entry: './index.js',

  output: {
    filename: 'dist.js',
    libraryTarget: 'umd',
  },

  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  }
}

在终端输入如下命令行进行开发，关于 Babel 和 Webpack 配置与使用的更多细节，请参考其官方文档。

./node_module/.bin/webpack -w

Node 环境

如果您是在 Node 环境中使用 SDK，推荐使用 esm 来作为 module loader。操作步骤如下：

安装 esm:

npm install esm

使用 esm:

node -r esm index.js

请求签名

发往 QingStor 对象存储的请求需要使用 Access Key 和 Secret Key 对请求签名，请前往开·云app官方版下载控制台创建和下载。下载到的密钥文件格式如下，请妥善保存你的密钥:

access_key_id: 'ACCESS_KEY_ID_EXAMPLE'
secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE'

如果在 Node.js 环境中使用 SDK，在初始化配置 Config 对象时，可以直接采用如下方式:

import { Config } from 'qingstor-sdk';

const config = new Config({
  access_key_id: 'ACCESS_KEY_ID_EXAMPLE',
  secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE',
});

如果在浏览器 Browser 环境中使用 SDK，QingStor 对象存储强烈建议用户部署一个签名服务器，专门用来对请求做签名，这样的好处是不会将 access_key_id 和 secret_access_key 暴露在客户端。

签名服务器的代码非常简单，请参考 Express 示例。签名服务器部署好之后，请采用如下方式初始化 Config 对象:

import { Config } from 'qingstor-sdk';

const config = new Config({
  signature_server: 'https://your.signserver.com/some_path',
});

备注： 如果签名服务器的域名和用户当前所在域名不同，需要配置相应的 CORS 规则。

获取 Bucket 列表

在项目中根目录下新建一个 index.js 文件，复制以下内容到文件中:

// index.js

import { QingStor, Config } from 'qingstor-sdk';

// 修改这里的 ACCESS_KEY_ID_EXAMPLE 和 SECRET_ACCESS_KEY_EXAMPLE 为前
// 一步中得到的 access_key_id 和 secret_access_key
const config = new Config({
  access_key_id: 'ACCESS_KEY_ID_EXAMPLE',
  secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE',
});
// or
const config = new Config({
  signature_server: 'https://your.signserver.com/some_path',
});

const qingstor = new QingStor(config);

function listBuckets() {
  qingstor.listBuckets().then((response) => {
    console.log(response.data);
    // 得到如下格式的结果
    // {
    //   "count": 2,
    //   "buckets": [
    //     {
    //       "name": "mybucket",
    //       "location": "pek3a",
    //       "url": "https://mybucket.pek3a.qingstor.com",
    //       "created": "2015-07-11T04:45:57Z"
    //     },
    //     {
    //       "name": "myphotos",
    //       "location": "pek3a",
    //       "url": "https://myphotos.pek3a.qingstor.com",
    //       "created": "2015-07-12T09:40:32Z"
    //     }
    //   ]
    // }
  });
}

listBuckets();

新建 Bucket


import { QingStor, Config } from 'qingstor-sdk';

// 修改这里的 ACCESS_KEY_ID_EXAMPLE 和 SECRET_ACCESS_KEY_EXAMPLE 为前
// 一步中得到的 access_key_id 和 secret_access_key
const config = new Config({
  access_key_id: 'ACCESS_KEY_ID_EXAMPLE',
  secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE',
});
// or
const config = new Config({
  signature_server: 'https://your.signserver.com/some_path',
});

const qingstor = new QingStor(config);

function createBucket() {
  qingstor.Bucket('example-bucket', 'sh1a').put().then(({ status }) => {
    // bucket 创建成功，status 应该为 201
    console.log(status);
  }).catch((error) => {
    // bucket 创建失败，打印返回结果
    console.log(error.response.data);
  });
}

createBucket();

获取 Bucket 中的文件列表


import { QingStor, Config } from 'qingstor-sdk';

// 修改这里的 ACCESS_KEY_ID_EXAMPLE 和 SECRET_ACCESS_KEY_EXAMPLE 为前
// 一步中得到的 access_key_id 和 secret_access_key
const config = new Config({
  access_key_id: 'ACCESS_KEY_ID_EXAMPLE',
  secret_access_key: 'SECRET_ACCESS_KEY_EXAMPLE',
});
// or
const config = new Config({
  signature_server: 'https://your.signserver.com/some_path',
});

const bucket = new QingStor(config).Bucket('example-bucket', 'sh1a');

function listObjects() {
  // list objects under perfix '/images'
  bucket.listObjects({
    limit: 10,
    prefix: '/images',
  }).then((response) => {
    console.log(response.data);
  }).catch((error) => {
    console.log(error.response.data);
  });
}

listObjects();

请求返回格式说明

QingStor 对象存储的 SDK 使用 axios 作为 HTTP 客户端，所有请求的返回都是一个 Promise。axios 的 Response 结构如下:

// copied from https://github.com/axios/axios/blob/master/README.md
{
  // `data` is the response that was provided by the server
  data: {},

  // `status` is the HTTP status code from the server response
  status: 200,

  // `statusText` is the HTTP status message from the server response
  statusText: 'OK',

  // `headers` the headers that the server responded with
  // All header names are lower cased
  headers: {},

  // `config` is the config that was provided to `axios` for the request
  config: {},

  // `request` is the request that generated this response
  // It is the last ClientRequest instance in node.js (in redirects)
  // and an XMLHttpRequest instance in the browser
  request: {}
}

Storage: PHP SDK

Mon, 01 Jan 0001 00:00:00 +0000

QingStor 对象存储的 PHP SDK 已在 GitHub 开源，本文为简要使用文档。更多详细信息请参见 GitHub 项目。

使用 SDK 之前请先在管理控制台申请 Access key。

安装

使用 Composer 安装:

> composer require yunify/qingstor-sdk

初始化服务

发起请求前需要初始化服务。以下代码初始化了一个 QingStor Service。

use QingStor\SDK\Service\QingStor;
use QingStor\SDK\Config;

$config = new Config("ACCESS_KEY_ID", "SECRET_ACCESS_KEY");
$service = new QingStor($config);

代码示例

获取账户下的 Bucket 列表

$response = $test_service->listBuckets();

// Print the response statusCode.
echo $response->statusCode;

// Print the buckets.
var_dump($response->buckets);

创建 Bucket

初始化并创建 Bucket, 需要指定 Bucket 名称和所在 Zone:

$test_bucket = $test_service->Bucket("test-bucket", "pek3a")
$response = $test_bucket.put()

获取 Bucket 中存储的 Object 列表

$response = bucket.listObjects()

// Print the response statusCode.
echo $response->statusCode;

// Print the objects keys.
var_dump($response->keys);

创建一个 Object

上传一个文件:

// Put object
$response = $test_bucket->putObject(
    "test_file",
    array(
        'body' => file_get_contents('/tmp/test_file'),
    )
)

// Print the response statusCode.
echo $response->statusCode;

删除一个 Object

// Delete object
$response = $test_bucket->deleteObject("test_object");

// Print the response statusCode.
echo $response->statusCode;

设置 Bucket ACL

$response = $test_bucket->putACL(
    array(
        "acl => array(
            "grantee" => array(
                "type" => "user",
                "ID" => "usr-xxxxxxxx"
            ),
            "permission" => "FULL_CONTROL"
        )
    )
);

// Print the response statusCode.
echo $response->statusCode;