KDDIクラウドプラットフォームサービス ナレッジサイト

  • HOME
  • サービス
  • オブジェクトストレージ・ファイルサーバー
  • KCPSオブジェクトストレージ
  • 提供機能

提供機能

REST API

  • バケットやオブジェクトの操作が可能なAPIで、Admin Consoleとは別に、バケットやオブジェクトの管理/ステータス参照などの操作を外部プログラムから実行するための方法としてAPIを提供します。
  • Amazon S3との互換性の高いREST APIを提供しており、お客さまのアプリケーションに組み込んで利用することができます。
分類 API 内容
サービス操作 GET Service (List Buckets) リクエストしたアカウントが持つすべてのバケットリスト(情報)を返します
バケット操作 GET Bucket(List Objects) バケット内のオブジェクトリスト情報を返します
HEAD Bucket バケットの存在と、それに対するアクセス権の有無を取得します
List Multipart Uploads バケットに対する進行中のマルチパートアップロード状態の一覧を取得します
オブジェクト操作 GET Object 指定したオブジェクトを返します
GET Object ACL オブジェクトの読み込み/書き込み権状態を取得します。
PUT Object ACL オブジェクトに対して、読み込み/書き込み権状態を設定します。
POST Object ブラウザベースのオブジェクトを格納します
PUT Object バケットにオブジェクトを格納(作成)します
PUT Object(copy) 指定したオブジェクトをコピーします
HEAD Object 指定したオブジェクトのメタデータ(ヘッダー情報)を取得します
DELETE Object 指定したオブジェクトを削除します
DELETE Multiple Object 複数のオブジェクトを一括削除
Initiate Multipart Upload マルチパートアップロードを開始し、アップロードIDを取得します
Upload Part マルチパートアップロードのパートをアップロードします
Upload Part (Copy) アップロードしたパートをコピーします
Complete Mulitpart Upload マルチパートアップロードを完了し、アップロードされたパートを組み立てます
Abort Multipart Upload マルチパートアップロードを中止します
List Parts マルチパートアップロードされたパートの一覧を表示します

※Maneger機能となる「サービス操作」「バケットの操作」については、APIの開放は行いません(KCPS Admin Console管理画面でのご提供)
※AWS S3 APIとの互換性を保証するものではありません。
※詳細は開発者ガイドブック>APIリファレンス>オブジェクトストレージをご参照ください。

ソフトウエア開発キット(SDK)

  1. 「AWS SDK for Java」を使用し、KCPSオブジェクトストレージのJava APIを利用することで、ソフトウエア開発をより簡単に実行することができます。
    ひとつのパッケージに、AWS Java ライブラリ、コードサンプルおよびドキュメントが含まれます。
    ※AWSとの違いやサンプルコードの詳細は開発者ガイドブック>SDK>オブジェクトストレージご参照ください。
  2. 開発ツール(Eclipse※)に開発キット(AWS SDK for Java)をインストールすることで、お客さま開発アプリケーションにAPIキー、エンドポイントを指定し、自社アプリケーションを開発することもできます。
    ※オープンソースの開発環境

※KCPSオブジェクトストレージを利用するには、WindowsOS等のOSが持っているファイルシステムとは違い、アプリケーションから直接編集はできず、データの保管取り出しにはHTTPのREST/SOAP(AmazonS3互換API))により行います。
そのため、お客様はKCPSオブジェクトストレージを利用するためのアプリケーションをAWS SDK for Javaを利用して作成いただく必要があります。

フリーツールのご紹介

KCPSオブジェクトストレージを簡易にご利用いただくためのフリーツールです。
それぞれの簡易利用手引きがございますので、内容(注意事項含む)をご確認の上ご利用ください。

Windows向け
・CloudBerryExplorer  ツールの設定方法
・S3Browser   ツールの設定方法

Linux向け
・S3cmd   ツールの設定方法

バックアップ/アーカイブとして利用したい

・バックアップサーバを利用していない場合
・OSがLinuxの場合

 

ご利用にあたって


本コマンドは、KCPSオブジェクトストレージのバージョンなどにより正常に動作しない場合があります。
また、フリーツールとしてご提供している関係上、ご使用に当たり、データの復元などなどの問題が発生した際の保証などはございませんので、ご理解の程、よろしくお願い致します。
実行方法および出力形式については、できる限りAWS CLIと同様に開発しておりますが、KCPSオブジェクトストレージの仕様により一部異なる場合がございます。
本ツールを利用し、バックアップ機能を開発したいなどのご要望がある場合は、別途、以下ご相談先までご連絡ください。

■ご相談先 :

無題

株式会社アウトソーシングテクノロジー ビジネスソリューション課

Mail: bs-ml@ostechnology.co.jp

コマンドラインツール利用シーン


・Cloud_Berry_Backupのようなライセンス費用が掛かるソフトウエアを利用したくない
・世代管理など、自動で行う必要がない
・Linuxサーバ(CentOS)から、KCPSオブジェクトストレージを直接利用したい
・AWS CLIと同じように利用したい

のようなシーンを想定しています。

—メリット—
・ライセンス費用が不要
・コマンドとして、Linuxから実行可能
・JSON結果出力を利用したShellなどに組み込みが可能

—デメリット—
・サポート/保証がない

インストールおよび、定義ファイル配置


(1)ファイルをダウンロードし、ダウンロードしたファイルを解凍する

(2)ダウンロードはこちら:実行ファイルとディレクトリを以下のように配置する

配置例
/home/USER/.kcps/ :ディレクトリ名 .kcpsとする
k/home/USER/kcps-cli :実行ファイル

(3)定義ファイル(credentials)を作成する

ファイルの作成
vi /home/USER/.kcps/credentials
kcps_access_key_id = “XXXXXXXXXXXXXXXXXXXX”
kcps_secret_access_key = “XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”
endpoint =

kcps_access_key_id、secret_access_key、endpointは、KCPS オブジェクトストレージのAdminConsole利用契約をご参照ください。
kcps_secret_access_keyはAPIキーを払い出した際に表示されます。
AdminConsoleの機能・操作
APIキー払い出し
エンドポイント表示

コマンド実行方法


基本操作(help表示方法)

[root@hostname~]# ./kcps-cli help

NAME:

kcps-cli – Universal Command Line Interface for KDDI Cloud Platform Service

USAGE:

kcps-cli [global options] command [command options] [arguments…]

VERSION:

0.0.0

COMMANDS:

list-objects

put-object

get-object

delete-object

help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:

–help, -h show help

–version, -v print the version

バケット内リスト取得方法(list-objects)

[root@hostname ~]# ./kcps-cli list-objects -h
NAME:
kcps-cli list-objects –

USAGE:
kcps-cli list-objects [command options] [arguments…]

DESCRIPTION:
Returns some or all (up to 1000) of the objects in a bucket.

OPTIONS:
–bucket value Name of the bucket.

 

——-実際の実行例——
[root@hostname ~]# ./kcps-cli list-objects –bucket /osttest
{“ListBucketResult”: {“Marker”: “”, “MaxKeys”: “1000”, “Delimiter”: “”, “IsTruncated”: “false”, “Contents”: {“Key”: “test.txt”, “LastModified”: “YYYY-MM-DDThh:mm:ss.sssZ”, “ETag”: “”xxxxxxxxxxxxxxxxxxxxxxxxxxxx””, “Size”: “62”, “Owner”: {“ID”: “xxxxxxxxxxxxx-xxxx-xxxx-xxxxxxxxxxx”, “DisplayName”: “kosXX@XXXXXXXXX”}, “StorageClass”: “STANDARD”}, “-xmlns”: “http://s3.amazonaws.com/doc/2006-03-01/”, “Name”: “test”, “Prefix”: “”}}
出力されるJSON形式(各カラム)については、レスポンスボディを参照してください。

ファイルアップロード(put-object)

[root@hostname ~]# ./kcps-cli put-object -hNAME:kcps-cli put-object -USAGE:kcps-cli put-object [command options] [arguments…]DESCRIPTION:Adds an object to a bucket.OPTIONS:–bucket value  Name of the bucket to which the PUT operation was initiated.–key value Object key for which the PUT operation was initiated.–body value Object data.

 

——-実際の実行例——

[root@hostname ~]# ./kcps-cli put-object –bucket /test –key test.txt –body test.txt出力されるJSON形式(各カラム)は、なし

レスポンスボディを参照してください。

ファイルダウンロード(get-objetct)

[root@hostname ~]# ./kcps-cli get-object -hNAME:kcps-cli get-object -USAGE:kcps-cli get-object [command options] [arguments…]DESCRIPTION:Retrieves objects from ObjectStrage.OPTIONS:–bucket value–key value–outfile value

 

——-実際の実行例——

[root@hostname ~]# ./kcps-cli get-object –bucket /test –key test.txt –outfile /tmp/test.txt出力されるJSON形式(各カラム)は、なし

レスポンスボディを参照してください。

オブジェクト削除(delete-object)

[root@hostname ~]# ./kcps-cli delete-object -h

NAME:

kcps-cli delete-object –

USAGE:

kcps-cli delete-object [command options] [arguments…]

DESCRIPTION:

Delete objects from ObjectStrage.

OPTIONS:

–bucket value

–key value

 

——-実際の実行例——

[root@hostname ~]# ./kcps-cli delete-object –bucket /test –key test.txt

出力されるJSON形式(各カラム)は、なし

レスポンスボディを参照してください。

サービス

2020/02/10 2020/02/10