ドキュメントセンター
edit-icon download-icon

オブジェクトの一覧表示

最終更新日: Jul 10, 2018

この機能を使用して、バケットにアップロードされたオブジェクトを表示することができます。選択したバケットで最大1,000オブジェクトが一度に表示することができます。次の4つのパラメータが拡張された機能をユーザーに提供します。

名前 機能
Delimiter オブジェクト名の文字をグループ化するために使用されます。指定したプレフィックスから最初の Delimiter までの名前を持つオブジェクトはすべて要素のグループ (CommonPrefixes) として機能します。
Marker アルファベット順で marker 後の最初のエントリから結果を返すように設定します。
MaxKeys 1 件のリクエストに対して返されるオブジェクトの最大数を制限します。指定されていない場合のデフォルト値は 100 です。MaxKeys の値は 1,000 以下にする必要があります。
Prefix 指定されたプレフィックスが Keys に含まれているオブジェクトだけが返されることを示します。プレフィックスを使用するクエリから返されるキーにはそのプレフィックスも含まれることに注意してください。

フォルダーのシミュレーション

OSS サービスでは、フォルダーを使用しません。すべての要素はオブジェクトとして格納されます。シミュレーションフォルダーを作成することは、サイズが 0 のオブジェクトを作成することを意味します。このオブジェクトはアップロードおよびダウンロードできます。コンソールには、”/“ で終わるオブジェクトがフォルダーとして表示されるため、 この方法でシミュレーションフォルダーを作成できます。

Delimiter と Prefix を組み合わせて、フォルダー機能をシミュレートできます。Delimiter と Prefix の組み合わせは、次の目的で使用されます。

  • フォルダーの名前を Prefix として設定すると、そのプレフィックスで始まるファイルが列挙されて、そのフォルダーのすべてのファイルとサブフォルダー (ディレクトリ) が再帰的に返されます。ファイル名は Contents として示されます。
  • Delimiter を “/“ に設定すると、返される値にはフォルダー内のファイルが列挙され、サブフォルダー (ディレクトリ) は CommonPrefixes セクションで返されます。サブフォルダー内のファイルとフォルダーは再帰的に表示されません。
  1. 例:
  2. この例では、oss-sample という OSS バケットに以下のオブジェクトが含まれています。
  4. File D
  5. Directory A/File C
  6. Directory A/File D
  7. Directory A/Directory B/File B
  8. Directory A/Directory B/Directory C/File A
  9. Directory A/Directory C/File A
  10. Directory A/Directory D/File B
  11. Directory B/File A
  13. 1. 第 1 レベルのディレクトリおよびファイルをリストします。
  14. API リクエストの規則に基づいて、Prefix を "" に、Delimiter を "/" に設定します。
  15. 返される結果は次のとおりです。
  16. <?xml version="1.0" encoding="UTF-8"?>
  17. <ListBucketResult>
  18.   <Name>oss-sample</Name>
  19.   <Prefix></Prefix>
  20.   <Marker></Marker>
  21.   <MaxKeys>1000</MaxKeys>
  22.   <Delimiter>/</Delimiter>
  23.   <IsTruncated>false</IsTruncated>
  24.   <Contents>
  25.     <Key>File D</Key>
  26.     <LastModified>2015-11-06T10:07:11.000Z</LastModified>
  27.     <ETag>"8110930DA5E04B1ED5D84D6CC4DC9080"</ETag>
  28.     <Type>Normal</Type>
  29.     <Size>3340</Size>
  30.     <StorageClass>Standard</StorageClass>
  31.     <Owner>
  32.       <ID>oss</ID>
  33.       <DisplayName>oss</DisplayName>
  34.     </Owner>
  35.   </Contents>
  36.   <CommonPrefixes>
  37.     <Prefix>Directory A/</Prefix>
  38.   </CommonPrefixes>
  39.   <CommonPrefixes>
  40.     <Prefix>Directory B/</Prefix>
  41.   </CommonPrefixes>
  42. </ListBucketResult>
  44. 次のことがわかります。
  45. Contents は第 1 レベルのファイル "File D" を返します。
  46. CommonPrefixes は第 1 レベルのディレクトリ "Directory A/" と "Directory B/" を返しますが、その中のファイルは示されません。
  48. 2. Directory A 内の第 2 レベルのディレクトリとファイルをリストします。
  49. API リクエストの規則に基づいて、Prefix を "Directory A" に、Delimiter を "/" に設定します。
  50. 返される結果は次のとおりです。
  52. <?xml version="1.0" encoding="UTF-8"?>
  53. <ListBucketResult>
  54.   <Name>oss-sample</Name>
  55.   <Prefix>Directory A/</Prefix>
  56.   <Marker></Marker>
  57.   <MaxKeys>1000</MaxKeys>
  58.   <Delimiter>/</Delimiter>
  59.   <IsTruncated>false</IsTruncated>
  60.   <Contents>
  61.     <Key>Directory A/File C</Key>
  62.     <LastModified>2015-11-06T09:36:00.000Z</LastModified>
  63.     <ETag>"B026324C6904B2A9CB4B88D6D61C81D1"</ETag>
  64.     <Type>Normal</Type>
  65.     <Size>2</Size>
  66.     <StorageClass>Standard</StorageClass>
  67.     <Owner>
  68.       <ID>oss</ID>
  69.       <DisplayName>oss</DisplayName>
  70.     </Owner>
  71.   </Contents>
  72.   <Contents>
  73.     <Key>Directory A/File D</Key>
  74.     <LastModified>2015-11-06T09:36:00.000Z</LastModified>
  75.     <ETag>"B026324C6904B2A9CB4B88D6D61C81D1"</ETag>
  76.     <Type>Normal</Type>
  77.     <Size>2</Size>
  78.     <StorageClass>Standard</StorageClass>
  79.     <Owner>
  80.       <ID>oss</ID>
  81.       <DisplayName>oss</DisplayName>
  82.     </Owner>
  83.   </Contents>
  84.   <CommonPrefixes>
  85.     <Prefix>Directory A/Directory B/</Prefix>
  86.   </CommonPrefixes>
  87.   <CommonPrefixes>
  88.     <Prefix>Directory A/Directory C/</Prefix>
  89.   </CommonPrefixes>
  90.   <CommonPrefixes>
  91.     <Prefix>Directory A/Directory D/</Prefix>
  92.   </CommonPrefixes>
  93. </ListBucketResult>
  95. 次のことがわかります。
  96. Contents は、第 2 レベルのファイル "Directory A/File C" と "Directory A/File D" を返します。
  97. CommonPrefixes は第 2 レベルのディレクトリ "Directory A/Directory B/"、"Directory A/Directory C/"、"Directory A/Directory D/" を返します。これらのディレクトリ内のファイルの名前は示されません。

関数を使用する際のリファレンス:

アカウント登録 コンソール