Term Description
最終更新日：2025-08-19 10:11:18
このセクションでは、API操作で頻繁に使用される用語を紹介します。
バケット（bucket）
バケットはCDNetworks Object Storageにおける仮想ストレージディスクの概念です。各バケットには複数のファイルを保存でき、バケット名がバケットを区別する唯一の手段となります。
APIにおける表記: APIドキュメント内では、バケットをbucketとして表記します。
ファイル名（key）
ファイル名は、CDNetworks Object Storageプラットフォームがリソースを識別するための名称です。ファイル名には以下の要件があります：
- 最大1000バイト。
- 先頭または末尾を/で始めたり終わったりしないこと。
- /…/ や /./ という特殊な文字列を含まないこと。
従来のファイルシステムと異なり、Object Storageはフラットファイルシステムを採用しており、階層型ディレクトリの概念がありません。ただし、ファイル名の工夫により仮想的なパスを表現することができます。これにより、Object Storageのファイル名は従来のファイル名とはやや異なります。
仮想パスを含むファイル名例: book/2.jpg
APIにおける表記: 以下ではファイル名をkeyとして示します。
リソース
リソースはCDNetworks Object Storageに保存されるデータ単位です。各リソースには固有のアクセスパスがあり、バケットに紐付くドメイン名とファイル名を組み合わせてアクセスします。
# アクセスパス例
http://<domain>/{key}
EncodeEntryURI フォーマット
EncodeEntryURIは、バケット名とリソース名を指定します。
# 構文ルール
EntryURI=<bucket>:<key>
EncodeEntryURI=Urlsafe_Base64_Encode(EntryURI)
置換変数
特殊置換変数
特殊置換変数は、CDNetworks Object Storageにより事前定義された変数群です。$(変数名)という形式で記述します。オブジェクトストレージプラットフォームがこの変数を検出すると、実際の値に自動で置換し、結果として返します。
注意： 各特殊置換変数のサポート可否は具体的な利用シーンに依存します。詳細は該当の利用シーンごとのドキュメントをご参照ください。
例
saveKey: $(year)/$(month)/$(hash)
例えば、日付が2016年4月の場合、アップロードされたファイルは2016/04/<file-hash>として保存されます。
特殊変数の説明
| 変数 | 説明 |
|---|---|
$(fname) |
アップロードされたファイルの元のファイル名 |
$(hash) |
リソースのEtag |
$(mimeType) |
リソースのMIMEタイプ（例: JPG画像はimage/jpg） |
$(suffix) |
元ファイル名の拡張子。拡張子がない場合はunknown |
$(uuid) |
ランダムな番号 |
$(year) |
アップロード年月（例: 2015） |
$(month) |
アップロード月（例: 01） |
$(day) |
アップロード日（例: 01） |
$(hour) |
アップロード時（例: 01） |
$(min) |
アップロード分（例: 01） |
$(sec) |
アップロード秒（例: 01） |
カスタム置換変数
カスタム置換変数は、クライアントがアップロードリクエスト内で$(x:変数名)として指定できる変数です。Object Storageプラットフォームはこの変数を検出し、リクエスト内の同名パラメータの値で$(x:変数名)を置換します。
注意: カスタム変数はUTF-8形式で、&（アンパサンド）を含めてはいけません。含めた場合、正しく解析されず文字化けの原因となります。
例として、callbackBodyでカスタム置換変数を次のように指定できます:
position=$(x:position)&message=$(x:message)
ここで、$(x:position)や$(x:message)はカスタム置換変数で、たとえばx:position=4、x:message=uploadの場合、サーバーは元の値をリクエスト内のパラメータ値で置換します。
ドメイン名の説明
アップロードドメイン
アップロードドメインを用いてファイルをアップロードする場合は、CDNetworksコンソールにログインし、「Object Storage Service → Buckets → Overview -> Domain Names」を確認してください。
管理ドメイン
管理ドメインを使用して、ファイルの操作（音声・動画処理、削除など）を行う場合も、CDNetworksコンソールにログインし、「Object Storage Service → Buckets → Overview -> Domain Names」で確認できます。
CNAME用オリジンドメイン
このドメインはCDN加速用ドメインで、ユーザーはこのドメインをObject Storageのバケットにバインドし、該当ドメインを通じてファイルへのアクセスや情報取得を行います。CDNetworksコンソールで「Object Storage Service → Buckets → Overview -> Domain Names」を確認してください。
これら3種類のドメイン取得方法の詳細はObtain Domainsをご参照ください。
スクリプト上の表記
APIドキュメントでは、理解しやすいように以下の表記ルールを設けています。
置換文字:
山カッコ< >で囲まれた文字列は、実際の値に置換が必要です。< >は区別のために使われているだけで、実際の利用時には入力しません。
例： <deadline string> は「deadline」に相当する文字列を入力する必要があることを表します。