BLOBs の一覧
この操作は List Blobs
、指定されたコンテナーの下にある BLOB の一覧を返します。
要求
List Blobs
要求の構成は次のとおりです。 HTTPS が推奨されます。 myaccount をストレージ アカウントの名前に置き換えます。
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET |
https://myaccount.blob.core.windows.net/mycontainer?restype=container&comp=list |
HTTP/1.1 |
エミュレートされたストレージ サービス URI
エミューレートされたストレージ サービスに対する要求では、エミュレーターのホスト名と BLOB Service ポートを 127.0.0.1:10000
と指定し、その後にエミューレートされたストレージ アカウント名を指定します。
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET |
http://127.0.0.1:10000/devstoreaccount1/mycontainer?restype=container&comp=list |
HTTP/1.1 |
詳細については、「開発とテストにAzure Storage Emulatorを使用する」を参照してください。
URI パラメーター
次の追加パラメーターを URI で指定できます。
パラメーター | 説明 |
---|---|
prefix |
省略可能。 結果をフィルター処理し、名前が指定されたプレフィックスで始まる BLOB のみを返します。 |
delimiter |
省略可能。 要求にこのパラメーターが含まれる場合、操作は、応答の本文で BlobPrefix 要素を返します。この要素は、区切り文字が出現するまで同じサブ文字列で名前が始まるすべての BLOB に対するプレースホルダーとして機能します。 区切り記号には単一文字または文字列を使用できます。 |
marker |
省略可能。 次の一覧操作で返される一覧の部分を識別する文字列値です。 返される一覧が完全ではなかった場合、操作では応答本文にマーカー値が返されます。 マーカー値を後続の呼び出しで使用して、一覧項目の次のセットを要求できます。 マーカー値はクライアントに対して非透過的です。 |
maxresults |
省略可能。 すべての BlobPrefix 要素も含め、返される BLOB の最大数を指定します。 要求で maxresults が指定されていないか、5,000 を超える値が指定されている場合、サーバーは最大 5,000 項目を返します。 返す追加の結果がある場合、サービスは応答要素で継続トークンを NextMarker 返します。 場合によっては、サービスから返される結果が指定された maxresults 結果よりも少なく、継続トークンも返される場合があります。maxresults をゼロ以下の値に設定すると、エラー応答コード 400 (Bad Request) が発生します。 |
include={snapshots,metadata,uncommittedblobs,copy,deleted,tags,versions, deletedwithversions,immutabilitypolicy,legalhold,permissions} |
省略可能。 応答に含める 1 つ以上のデータセットを指定します。 - snapshots : スナップショットを列挙に含める必要があることを指定します。 応答では、スナップショットは古いものから新しいものの順に列挙されます。- metadata : 応答で BLOB メタデータを返すように指定します。- uncommittedblobs : ブロックがアップロードされたが、 Put Block List を使用してコミットされていない BLOB を応答に含めることを指定します。- copy : バージョン 2012-02-12 以降。 現在または以前の Copy Blob 操作に関連するメタデータを応答に含めるように指定します。- deleted : バージョン 2017-07-29 以降。 論理的に削除された BLOB を応答に含める必要があることを指定します。 - tags : バージョン 2019-12-12 以降。 ユーザー定義の BLOB インデックス タグを応答に含める必要があることを指定します。 - versions : バージョン 2019-12-12 以降。 BLOB のバージョンを列挙に含める必要があることを指定します。- deletedwithversions : バージョン 2020-10-02 以降。 任意のバージョン (アクティブまたは削除済み) を持つ削除済み BLOB を、HasVersionsOnly タグ<と値 true を持つ応答に>含める必要があることを指定します。- immutabilitypolicy : バージョン 2020-06-12 以降。 BLOB の日付までの不変ポリシーと不変ポリシー モードを列挙に含める必要があることを指定します。- legalhold : バージョン 2020-06-12 以降。 BLOB の訴訟ホールドを列挙に含める必要があることを指定します。- permissions : バージョン 2020-06-12 以降。 階層型名前空間が有効になっているアカウントでのみサポートされます。 要求にこのパラメーターが含まれている場合は、一覧表示された BLOB またはディレクトリの所有者、グループ、アクセス許可、Access Controlリストが列挙に含まれます。 複数のオプションを URI で指定するには、URL エンコードのコンマ ("%82") で各オプションを区切る必要があります。 |
showonly={deleted,files,directories} |
省略可能。 応答で返されるデータセットのいずれかを指定します。 - deleted : 省略可能。 バージョン 2020-08-04 以降。 階層型名前空間が有効になっているアカウントに対してのみ。 要求にこのパラメーターが含まれている場合、一覧には論理的に削除された BLOB のみが含まれます。 include=deleted も指定すると、要求は無効な要求 (400) で失敗します。- files : 省略可能。 バージョン 2020-12-06 以降。 階層型名前空間が有効になっているアカウントに対してのみ。 要求にこのパラメーターが含まれている場合、リストにはファイルのみが含まれます。 - directories : 省略可能。 バージョン 2020-12-06 以降。 階層型名前空間が有効になっているアカウントに対してのみ。 要求にこのパラメーターが含まれている場合、リストにはディレクトリのみが含まれます。 |
timeout |
省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「 Blob Service 操作のタイムアウトの設定」を参照してください。 |
要求ヘッダー
必須要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。
要求ヘッダー | 説明 |
---|---|
Authorization |
必須。 承認スキーム、アカウント名、および署名を指定します。 詳細については、「Azure Storage要求を承認する」を参照してください。 |
Date または x-ms-date |
必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage要求を承認する」を参照してください。 |
x-ms-version |
すべての承認された要求に必要です。匿名要求の場合は省略可能です。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。 |
x-ms-client-request-id |
省略可能。 ストレージ分析ログが有効になっているときに分析ログに記録される 1 KiB 文字制限を持つ、クライアントによって生成された不透明な値を提供します。 クライアント側のアクティビティをサーバーが受信した要求と関連付けるには、このヘッダーを使用することが強く推奨されます。 詳細については、「Storage Analyticsログと Azure ログ: ログを使用したStorage要求の追跡」を参照してください。 |
x-ms-upn |
省略可能。 階層型名前空間がアカウントに対して有効になっていて、要求に include=permissions が指定されている場合にのみ有効です。 true の場合、所有者>、グループ>、<および <Acl> フィールドで<返されるユーザー ID 値は、Azure Active Directoryオブジェクト ID からユーザー プリンシパル名に変換されます。 false の場合、値は Azure Active Directory オブジェクト ID として返されます。 既定値は false です。 グループおよびアプリケーション オブジェクト ID は、一意のフレンドリ名を持たないため、変換されないことに注意してください。 |
要求本文
[なし] :
要求のサンプル
サンプル要求の BLOB リソースの列挙 を参照してください。
[応答]
応答には HTTP ステータス コード、一連の応答ヘッダー、および応答の本文が XML 形式で含まれます。
状態コード
操作に成功すると、状態コード 200 (OK) が返されます。
状態コードの詳細については、「 状態コードとエラー コード」を参照してください。
レスポンス ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。
応答ヘッダー | 説明 |
---|---|
Content-Type |
返される結果の形式を指定します。 現在、この値は application/xml です。 |
x-ms-request-id |
このヘッダーは要求を一意に識別するので、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用する BLOB サービスのバージョンを示します。 このヘッダーはバージョン 2009-09-19 以降を使用して行った要求に対して返されます。 このヘッダーは、コンテナーが BLOB サービスの 2009-09-19 バージョンを使用するパブリック アクセス用にマークされている場合は、バージョン指定のない匿名要求に対しても返されます。 |
Date |
サービスによって生成される、応答の開始時刻を示す UTC 日付/時刻値。 |
x-ms-client-request-id |
このヘッダーは、要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、値が最大 1024 の ASCII 文字で表示される場合、ヘッダーの値 x-ms-client-request-id と等しくなります。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、このヘッダーは応答に存在しません。 |
応答本文
XML 応答の形式は次のとおりです。
Prefix
、Marker
、MaxResults
、Delimiter
の各要素は、要求 URI で指定された場合にのみ存在します。 NextMarker
要素は、一覧結果が不完全な場合にのみ値を持ちます。
スナップショット、BLOB メタデータ、およびコミットされていない BLOB は、要求の URI の include
パラメーターで指定されている場合にのみ、応答に含まれます。
バージョン 2009-09-19 以降では、BLOB のプロパティは Properties
要素内にカプセル化されています。
バージョン 2009-09-19 以降、List Blobs
の応答本文で返される要素の名前は以下のように変更されています。
Last-Modified
(旧称LastModified
)Content-Length
(旧称Size
)Content-Type
(旧称ContentType
)Content-Encoding
(旧称ContentEncoding
)Content-Language
(旧称ContentLanguage
)
Content-MD5
要素は、バージョン 2009-09-19 以降で作成された BLOB に対して表示されます。 バージョン 2012-02-12 以降では、Put BLOB を使用して BLOB をアップロードすると BLOB サービスによって値が計算Content-MD5
されますが、Put Block List を使用して BLOB を作成する場合は計算されません。 BLOB を作成するとき、または Put Block List または Set BLOB Properties 操作を呼び出すことで、値を明示的にContent-MD5
設定できます。
2009-09-19 以降のバージョンの場合、バージョン 2015-02-21 より前のバージョンでは、追加 BLOB を含むコンテナーを呼び出すと List Blobs
、リストの結果に追加 BLOB が含まれている場合、状態コード 409 (FeatureVersionMismatch) で失敗します。
LeaseState
バージョン LeaseDuration
2012-02-12 以降でのみ表示されます。
CopyId
、CopyStatus
、CopySource
、CopyProgress
、CopyCompletionTime
、および CopyStatusDescription
が含まれるのは、バージョン 2012-02-12 以降で、この操作に include={copy}
パラメーターが含まれている場合に限られます。 Copy Blob
操作でこの BLOB がコピー先になったことがない場合、あるいは Copy Blob
、Set Blob Properties
、または Put Blob
を使用した Put Block List
操作の完了後にこの BLOB が変更された場合には、これらの要素は表示されません。 これらの要素は、バージョン 2012-02-12 より前に Blob のコピー によって作成された BLOB には表示されません。
バージョン 2013-08-15 以降では、EnumerationResults
要素には、BLOB エンドポイントを指定する ServiceEndpoint
属性と、コンテナーの名前を指定する ContainerName
フィールドがあります。 以前のバージョンでは、この 2 つの属性は ContainerName
フィールドにまとめられていました。 また、バージョン 2013-08-15 以降では、Url
の Blob
要素が削除されました。
バージョン 2015-02-21 以降では、 List Blobs
すべての型 (ブロック、ページ、追加 BLOB) の BLOB を返します。
バージョン 2015-12-11 以降では、 List Blobs
要素を ServerEncrypted
返します。 この要素は、BLOB とアプリケーションのメタデータが完全に暗号化されている場合に設定されfalse
、それ以外の場合は設定true
されます。
バージョン 2016-05-31 以降では、増分コピー BLOB とスナップショットの要素を返IncrementalCopy
し、List Blobs
値true
を .
バージョン 2017-04-17 以降では、 List Blobs
アクセス層が AccessTier
明示的に設定されている場合は、要素を返します。 許可される Premium ページ BLOB 層の一覧については、VM の高パフォーマンスのPremium Storageとマネージド ディスクに関するページを参照してください。 BLOB Storageまたは General Purpose v2 アカウントの場合、有効な値は Hot
Archive
/Cool
/. BLOB がリハイドレート保留中の状態の場合は、 ArchiveStatus
有効な値 rehydrate-pending-to-hot
/rehydrate-pending-to-cool
の 1 つで要素が返されます。 ブロック BLOB 階層化の詳細については、「 ホット、クール、アーカイブ ストレージ層」を参照してください。
バージョン 2017-04-17 以降の場合は、 List Blobs
BLOB Storage または v2 アカウントGeneral Purposeの要素を返AccessTierInferred
します。 ブロック BLOB にアクセス層が設定されていない場合は、ストレージ アカウントのプロパティから層を推測し、この値は true
. このヘッダーは、層が account プロパティから推論された場合にのみ存在します。 ブロック BLOB 階層化の詳細については、「 ホット、クール、アーカイブ ストレージ層」を参照してください。
バージョン 2017-04-17 以降の場合は、 List Blobs
BLOB Storage または v2 アカウントGeneral Purposeの要素を返AccessTierChangeTime
します。 これは、ブロック BLOB の階層が設定された場合にのみ返されます。 日付形式は RFC 1123 に従います。 詳細については、「 ヘッダー内のDate-Time値の表現」を参照してください。 ブロック BLOB 階層化の詳細については、「 ホット、クール、アーカイブ ストレージ層」を参照してください。
バージョン 2017-07-29 以降の場合は、 Deleted
DeletedTime
RemainingRetentionDays
この操作にパラメーターが含まれている場合にinclude={deleted}
表示されます。 この BLOB が削除されていない場合、これらの要素は表示されません。 これらの要素は、論理的な削除機能が有効になっているときに操作で DELETE
削除される BLOB またはスナップショットに対して表示されます。 Deleted
要素は、論理的に削除された BLOB とスナップショットに対して true に設定されます。 Deleted-Time
は、BLOB が削除された時刻に対応します。 RemainingRetentionDays
は、論理的に削除された BLOB が BLOB サービスによって完全に削除されるまでの日数を示します。
バージョン 2017-11-09 以降では、 Creation-Time
この BLOB が作成された時刻を返します。
バージョン 2019-02-02 以降では、 List Blobs
BLOB が顧客指定の CustomerProvidedKeySha256
キーで暗号化されている場合は、要素を返します。 値は、BLOB の暗号化に使用されるキーの SHA-256 ハッシュに設定されます。 さらに、操作にパラメーターが含まれておりinclude={metadata}
、顧客が指定したキーで暗号化された BLOB にアプリケーション メタデータが存在する場合、要素にはEncrypted="true"
、Metadata
操作のList Blobs
一部として復号化できないメタデータが BLOB にあることを示す属性が含まれます。 これらの BLOB のメタデータにアクセスするには、顧客が指定したキーを使用して BLOB プロパティの取得または BLOB メタデータの取得を呼び出します。
バージョン 2019-02-02 以降では、 List Blobs
BLOB が暗号化スコープで暗号化されている場合は、要素を返します EncryptionScope
。 値は、BLOB の暗号化に使用される暗号化スコープの名前に設定されます。 操作にパラメーターが include={metadata}
含まれている場合、BLOB 上のアプリケーション メタデータは透過的に復号化され、要素で Metadata
使用できるようになります。
バージョン 2019-12-12 以降の場合は、BLOB Storage上の要素を返RehydratePriority
すか、List Blobs
オブジェクトがリハイドレート保留中の状態にある場合は v2 アカウントをGeneral Purposeします。 有効な値は High
/Standard
. ブロック BLOB 階層化の詳細については、「 ホット、クール、アーカイブ ストレージ層」を参照してください。
バージョン 2019-12-12 以降の場合、アカウントでバージョン管理が有効になっている場合は、 List Blobs
BLOB の要素と生成された BLOB バージョンを返 VersionId
します。
バージョン 2019-12-12 以降では、 List Blobs
値が IsCurrentVersion
設定 true
されている BLOB の現在のバージョンの要素を返し、読み取り専用の自動生成されたバージョンとは区別します。
バージョン 2019-12-12 以降では、 List Blobs
任意のタグを TagCount
持つ BLOB の要素を返します。 この Tags
操作にパラメーターが含まれている場合にのみ、要素が include={tags}
表示されます。 BLOB にタグがない場合、これらの要素は表示されません。
バージョン 2019-12-12 以降の場合は、 List Blobs
追加 BLOB の要素を Sealed
返します。 この要素は Sealed
、追加 BLOB がシールされている場合にのみ表示されます。 追加 BLOB がシールされていない場合、これらの要素は表示されません。
バージョン 2020-02-10 以降では、 List Blobs
要素を LastAccessTime
返します。 この要素は、ストレージ アカウントの最終アクセス時間追跡ポリシーに従って BLOB のデータが最後にアクセスされた日時を示します。 ストレージ アカウントに最終アクセス時間追跡ポリシーがない場合、またはポリシーが無効になっている場合、要素は返されません。 アカウントの最終アクセス時間追跡ポリシーの設定については、「 Blob Service API」を参照してください。 この要素は LastAccessTime
、BLOB のメタデータにアクセスした最後の時刻を追跡しません。
バージョン 2020-06-12 以降では、List Blobs
この操作にパラメーターが含まれている場合に and ImmutabilityPolicyMode
要素をinclude={immutabilitypolicy}
返ImmutabilityPolicyUntilDate
します。
バージョン 2020-06-12 以降では、 List Blobs
この操作にパラメーターが LegalHold
含まれている場合に要素を include={legalhold}
返します。
バージョン 2020-06-12 以降の場合、階層型名前空間が有効になっているアカウントの場合、要求にパラメーターが含まれている場合は 、List Blobs
要素がAcl
Group
Permissions
返Owner
されます。include={permissions}
Acl
要素は、ファイル/ディレクトリに設定された Access と既定の ACL の組み合わせリストであることに注意してください。
バージョン 2020-06-12 以降の場合、階層型名前空間が有効になっているアカウントの場合、区切り記号を使用すると、List Blobs
ディレクトリのプロパティに対応する要素が要素に返Properties
BlobPrefix
されます。
バージョン 2020-08-04 以降では、階層型名前空間が有効なアカウントの場合、 List Blobs
削除された BLOB の要素が DeletionId
返されます。 DeletionId
は、同じパスを持つ他の削除された BLOB と区別するために、論理的に削除されたパスを一意に識別する符号なし 64 ビット識別子です。
バージョン 2020-10-02 以降では、階層型名前空間が有効なアカウントの場合、 List Blobs
パスの ResourceType
プロパティ要素を返します。これはどちらか file
/directory
になります。
バージョン 2021-02-12 以降では、 List Blobs
XML で無効な文字 (具体的には U+FFFE または U+FFFF) を含むすべての Blob
Name
値または BlobPrefix
Name
要素値がパーセントエンコードされます (RFC 2396)。 エンコードされた場合、 Name
要素には属性が Encoded=true
含まれます。 これは、応答の Name
残りの Name
要素ではなく、XML で無効な文字を含む要素値に対してのみ発生することに注意してください。
バージョン 2021-06-08 以降では、階層型名前空間が有効なアカウントの場合、削除された BLOB を区切り記号で一覧表示するときに、List Blobs
プレースホルダー ディレクトリの要素の BlobPrefix
properties 要素を返Placeholder
します。 これらのプレースホルダー ディレクトリは、論理的に削除された BLOB に移動するためにのみ存在します。
バージョン 2020-02-10 以降では、階層型名前空間が有効なアカウントの場合、 List Blobs
削除された BLOB の要素が Expiry-Time
返されます。 Expiry-Time
は、ファイルの有効期限が切れ、有効期限が同じに設定されている場合にファイルに対して返される時刻です。
<?xml version="1.0" encoding="utf-8"?>
<EnumerationResults ServiceEndpoint="http://myaccount.blob.core.windows.net/" ContainerName="mycontainer">
<Prefix>string-value</Prefix>
<Marker>string-value</Marker>
<MaxResults>int-value</MaxResults>
<Delimiter>string-value</Delimiter>
<Blobs>
<Blob>
<Name>blob-name</name>
<Snapshot>date-time-value</Snapshot>
<VersionId>date-time-vlue</VersionId>
<IsCurrentVersion>true</IsCurrentVersion>
<Deleted>true</Deleted>
<Properties>
<Creation-Time>date-time-value</Creation-Time>
<Last-Modified>date-time-value</Last-Modified>
<Etag>etag</Etag>
<Owner>owner user id</Owner>
<Group>owning group id</Group>
<Permissions>permission string</Permissions>
<Acl>access control list</Acl>
<ResourceType>file | directory</ResourceType>
<Placeholder>true</Placeholder>
<Content-Length>size-in-bytes</Content-Length>
<Content-Type>blob-content-type</Content-Type>
<Content-Encoding />
<Content-Language />
<Content-MD5 />
<Cache-Control />
<x-ms-blob-sequence-number>sequence-number</x-ms-blob-sequence-number>
<BlobType>BlockBlob|PageBlob|AppendBlob</BlobType>
<AccessTier>tier</AccessTier>
<LeaseStatus>locked|unlocked</LeaseStatus>
<LeaseState>available | leased | expired | breaking | broken</LeaseState>
<LeaseDuration>infinite | fixed</LeaseDuration>
<CopyId>id</CopyId>
<CopyStatus>pending | success | aborted | failed </CopyStatus>
<CopySource>source url</CopySource>
<CopyProgress>bytes copied/bytes total</CopyProgress>
<CopyCompletionTime>datetime</CopyCompletionTime>
<CopyStatusDescription>error string</CopyStatusDescription>
<ServerEncrypted>true</ServerEncrypted>
<CustomerProvidedKeySha256>encryption-key-sha256</CustomerProvidedKeySha256>
<EncryptionScope>encryption-scope-name</EncryptionScope>
<IncrementalCopy>true</IncrementalCopy>
<AccessTierInferred>true</AccessTierInferred>
<AccessTierChangeTime>datetime</AccessTierChangeTime>
<DeletedTime>datetime</DeletedTime>
<RemainingRetentionDays>no-of-days</RemainingRetentionDays>
<TagCount>number of tags between 1 to 10</TagCount>
<RehydratePriority>rehydrate priority</RehydratePriority>
<Expiry-Time>date-time-value</Expiry-Time>
</Properties>
<Metadata>
<Name>value</Name>
</Metadata>
<Tags>
<TagSet>
<Tag>
<Key>TagName</Key>
<Value>TagValue</Value>
</Tag>
</TagSet>
</Tags>
<OrMetadata />
</Blob>
<BlobPrefix>
<Name>blob-prefix</Name>
</BlobPrefix>
</Blobs>
<NextMarker />
</EnumerationResults>
応答のサンプル
サンプル応答については、 BLOB リソースの列挙 を参照してください。
承認
コンテナーのアクセス制御リスト (ACL: Access Control List) がコンテナーへの匿名アクセスを許可するように設定されている場合、クライアントはこの操作を呼び出して BLOB のコンテンツを読み取ることができます。 それ以外の場合、この操作は、アカウント所有者と、コンテナー内の BLOB を一覧表示するためのアクセス許可がある共有アクセス署名を持つ任意のユーザーが呼び出すことができます。
注釈
応答での BLOB のプロパティ
コミットされていない BLOB を列挙に含めるように要求した場合、一部のプロパティは BLOB がコミットされるまで設定されないため、一部のプロパティが応答で返されない場合があることに注意してください。
x-ms-blob-sequence-number
要素は、ページ BLOB に対してのみ返されます。
要素は OrMetadata
、ブロック BLOB に対してのみ返されます。
ページ BLOB の場合、Content-Length
要素で返される値は、BLOB の x-ms-blob-content-length
ヘッダーの値に対応します。
Content-MD5
要素は、2009-09-19 以降のバージョンを使用して BLOB に設定された場合にのみ、応答の本文に含まれます。 BLOB の作成時に Content-MD5
、または Set Blob Properties を呼び出して 、プロパティを設定できます。 バージョン 2012-02-12 以降では、Put Blob
要求に MD5 ヘッダーが含まれていない場合でも、Put Blob
でブロック BLOB の MD5 値が設定されます。
応答でのメタデータ
Metadata
要素は、include=metadata
パラメーターが URI に指定された場合にのみ存在します。 Metadata
要素内では、名前と値の各ペアの値が、ペアの名前に対応する要素内に一覧表示されます。
このパラメーターで要求されたメタデータは、2009-09-19 バージョンの BLOB Service で設定されている名前付けの制約に従って格納する必要があります。 このバージョン以降、すべてのメタデータ名は 、C# 識別子の名前付け規則に従う必要があります。
メタデータの名前と値のペアが 2009-09-19 バージョンで設定されている名前付けの制約に違反する場合、次の XML フラグメントに示すように、応答本文は x-ms-invalid-name
要素内に問題のある名前を示します。
…
<Metadata>
<MyMetadata1>first value</MyMetadata1>
<MyMetadata2>second value</MyMetadata2>
<x-ms-invalid-name>invalid-metadata-name</x-ms-invalid-name>
</Metadata>
…
応答のタグ
この要素は Tags
、パラメーターが include=tags
URI で指定され、BLOB にタグがある場合にのみ存在します。 TagSet
要素内では、最大 10 Tag
個の要素が返され、それぞれにユーザー定義 BLOB インデックス タグとvalue
ユーザー定義 BLOB インデックス タグが含まれますkey
。 タグの順序は、応答では保証されません。
Tags
BLOB にタグがない場合、およびTagCount
要素は返されません。
ストレージ サービスは BLOB とそのタグの間で強力な一貫性を維持しますが、セカンダリ インデックスは最終的に一貫性があります。 タグは、タグによる BLOB の検索操作に表示される前に、リスト BLOB への応答で表示される場合があります。
応答でのスナップショット
スナップショットは、URI で include=snapshots
パラメーターが指定されていた場合にのみ、応答の一覧に含まれます。 スナップショットはアクティブなリースを持つことができないので、応答の一覧のスナップショットには LeaseStatus
要素は含まれません。
区切り文字を指定して List Blobs
を呼び出す場合、列挙にスナップショットも含めることはできません。 要求に両方が含まれる場合は、InvalidQueryParameter エラー (HTTP ステータス コード 400 – Bad Request) が返されます。
応答でのコミットされていない BLOB
コミットされていない BLOB は、include=uncommittedblobs
パラメーターが URI で指定されている場合にのみ、応答の一覧に含まれます。 応答の一覧のコミットされていない BLOB には、次の要素は含まれません。
Last-Modified
Etag
Content-Type
Content-Encoding
Content-Language
Content-MD5
Cache-Control
Metadata
応答で削除された BLOB
URI にパラメーターが指定されている場合にのみ、 include=deleted
削除された BLOB が応答に一覧表示されます。 削除された BLOB はアクティブなリースを持つことができないため、応答に一覧表示されている削除された BLOB には Lease 要素は含まれません。
URI で指定されている場合 include=deleted,snapshot
、削除されたスナップショットはリスト応答に含まれます。
応答のオブジェクト レプリケーション メタデータ
この要素は OrMetadata
、BLOB でオブジェクト レプリケーション ポリシーが評価され、バージョン 2019-12-12 以降を使用して BLOB の一覧表示呼び出しが行われた場合に存在します。 OrMetadata
要素内では、名前と値の各ペアの値が、ペアの名前に対応する要素内に一覧表示されます。 名前の形式は or-{policy-id}_{rule-id}
、 {policy-id}
ストレージ アカウントのオブジェクト レプリケーション ポリシー識別子を表す guid で、 {rule-id}
ストレージ コンテナーのルール識別子を表す guid です。 有効な値は complete
/failed
.
…
<OrMetadata>
<or-e524bba7-4323-4b93-91f8-d09d5d0b7057_d86c51de-ef02-4264-bdcf-dcd389a6c7ac>complete</or-e524bba7-4323-4b93-91f8-d09d5d0b7057_d86c51de-ef02-4264-bdcf-dcd389a6c7ac>
<or-2b302b5d-fcd5-44d6-a5ed-455bf27e17ea_4a398ff5-2a89-4090-879b-10248f23428e>failed</or-2b302b5d-fcd5-44d6-a5ed-455bf27e17ea_4a398ff5-2a89-4090-879b-10248f23428e>
</OrMetadata>
…
応答の不変ポリシー
要素ImmutabilityPolicyMode
はImmutabilityPolicyUntilDate
、パラメーターが include=immutabilitypolicy
URI で指定された場合にのみ存在します。
<Properties>
<ImmutabilityPolicyUntilDate>date-time-value</ImmutabilityPolicyUntilDate>
<ImmutabilityPolicyMode>unlocked | locked </ImmutabilityPolicyMode>
</Properties>
対応における訴訟ホールド
LegalHold
要素は、include=legalhold
パラメーターが URI に指定された場合にのみ存在します。
<Properties>
<LegalHold>true | false </LegalHold>
</Properties>
マーカー値を使用して結果セットを返す場合
maxresults
パラメーターの値を指定し、返す BLOB の数がこの値を超えた場合、または maxresults
の既定値を超えた場合、応答本文には、後続の要求で返す次の BLOB を示す NextMarker
要素が含まれます。 場合によっては、返される結果の数が NextMarker
〘 の値 maxresults
より少ない場合でも、サービスから要素が返されることがあります。
次の項目セットを返すには、後続の要求の URI で NextMarker
の値をマーカー パラメーターとして指定します。 NextMarker
の値は非透過的に扱う必要があります。
BLOB の名前空間をスキャンするための区切り文字の使用
delimiter
パラメーターは、呼び出し元がユーザー定義の区切り記号を使用して BLOB 名前空間をスキャンできるようにします。 この方法で、BLOB の仮想階層をファイル システムと同様にスキャンできます。 区切り記号には単一文字または文字列を使用できます。 要求にこのパラメーターが含まれている場合、この操作によって BlobPrefix
要素が返されます。 区切り文字が出現するまで、同じサブ文字列で名前が始まるすべての BLOB の代わりに BlobPrefix
要素が返されます。 要素の BlobPrefix
値は substring+delimiter で、 部分文字列 は 1 つ以上の BLOB 名を始める共通部分文字列で、 区切り記号 は 区切り記号 パラメーターの値です。
要求 URI の prefix
パラメーターの BlobPrefix
の値を指定することで、このプレフィックスで始まる BLOB 一覧の後続の呼び出しに BlobPrefix
の値を使用できます。
返される各 BlobPrefix
要素が、各 Blob
要素と同じように、結果の最大件数に加算されることに注意してください。
BLOB は、応答本文でアルファベット順に一覧表示されます (大文字が最初に表示されます)。
CopyStatusDescription のコピーのエラー
CopyStatusDescription
には、Copy Blob
のエラーに関する詳細情報が含まれます。
コピーの試行が失敗し、BLOB Service が引き続き操作を再試行している場合、
CopyStatus
はpending
に設定され、CopyStatusDescription
のテキストでは、最後にコピーしようとしたときに発生した可能性のあるエラーについて説明されます。CopyStatus
がfailed
に設定されている場合、CopyStatusDescription
のテキストでは、コピー操作を失敗させたエラーについて説明されます。
各 CopyStatusDescription
値の 3 つのフィールドの説明を次の表に示します。
コンポーネント | 説明 |
---|---|
HTTP 状態コード | エラーを示す標準の 3 桁の整数。 |
エラー コード | ErrorCode> 要素で Azure によって提供されるエラーを記述する<キーワード。 ErrorCode> 要素が表示されない<場合は、HTTP 仕様の 3 桁の HTTP 状態コードに関連付けられた標準エラー テキストを含むキーワードが使用されます。 一般的な REST API エラー コードを参照してください。 |
Information | 引用符で囲まれたエラーの詳しい説明。 |
一般的なエラー シナリオの CopyStatus
と CopyStatusDescription
の値を次の表に示します。
重要
ここで示す説明テキストは、バージョン変更が行われなくても、警告なしに変更される可能性があるため、このテキストと厳密に一致しない場合があることに注意してください。
シナリオ | CopyStatus 値 | CopyStatusDescription 値 |
---|---|---|
コピー操作が正常に完了した。 | success | empty |
コピー操作が完了する前にユーザーが操作を中止した。 | aborted | empty |
コピー操作の実行中、コピー元 BLOB からの読み取り時にエラーが発生したが、操作が再試行される。 | pending | 502 BadGateway "コピー元の読み取り時に再試行可能なエラーが発生しました。 再試行します。 失敗時刻: <時間>" |
コピー操作でコピー先 BLOB への書き込み時にエラーが発生したが、操作が再試行される。 | pending | 500 InternalServerError "再試行可能なエラーが発生しました。 再試行します。 失敗時刻: <時間>" |
コピー操作でコピー元 BLOB からの読み取り時に回復不能なエラーが発生した。 | 失敗 | 404 ResourceNotFound "ソースの読み取り時にコピーに失敗しました。メモ:この基になるエラーを報告すると、Azure は ErrorCode> 要素を<返しますResourceNotFound 。 応答に ErrorCode> 要素が表示されない<場合は、HTTP 状態の標準文字列表現がNotFound 表示されます。 |
すべてのコピー操作を制限するタイムアウト期間が経過した (現在、タイムアウト期間は 2 週間です)。 | 失敗 | 500 OperationCancelled "コピーの最大許容時間を超えました。" |
コピー元からの読み取り時にコピー操作が何度も失敗しており、試行の最小成功率に達していなかった (このタイムアウトにより、失敗まで 2 週間にわたって状態の良くないコピー元に対して再試行が繰り返されるのを防ぎます)。 | 失敗 | 500 OperationCancelled "コピー元の読み取り時にコピーに失敗しました。" |