Seznam objektů blob

Operace List Blobs vrátí seznam objektů blob v zadaném kontejneru.

Žádost

Požadavek List Blobs lze zkonstruovat následujícím způsobem. Doporučuje se protokol HTTPS. Nahraďte myaccount názvem vašeho účtu úložiště:

Emulovaný identifikátor URI služby úložiště

Při vytváření požadavku na emulovanou službu úložiště zadejte název hostitele emulátoru a Blob service port jako a za ním 127.0.0.1:10000 emulovaný název účtu úložiště:

Další informace najdete v tématu Použití Azure Storage Emulator pro vývoj a testování.

Parametry identifikátoru URI

V identifikátoru URI je možné zadat následující další parametry.

Hlavičky požadavku

Následující tabulka popisuje povinné a volitelné hlavičky požadavku.

Text požadavku

Žádné

Ukázkový požadavek

Ukázkový požadavek najdete v tématu Vytváření výčtu prostředků objektů blob.

Reakce

Odpověď obsahuje stavový kód HTTP, sadu hlaviček odpovědi a text odpovědi ve formátu XML.

Stavový kód

Úspěšná operace vrátí stavový kód 200 (OK).

Informace o stavových kódech najdete v tématu Stavové a chybové kódy.

Hlavičky odpovědi

Odpověď pro tuto operaci zahrnuje následující hlavičky. Odpověď může obsahovat také další standardní hlavičky PROTOKOLU HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.

Text odpovědi

Formát odpovědi XML je následující.

Všimněte si, že prvky , , a jsou k dispozici pouze v Prefix Marker MaxResults Delimiter případě, že byly zadány v identifikátoru URI požadavku. Element NextMarker má hodnotu pouze v případě, že nejsou výsledky seznamu dokončeny.

Snímky, metadata objektů blob a neposvěcené objekty blob jsou v odpovědi zahrnuty pouze v případě, že jsou zadány pomocí parametru include v identifikátoru URI požadavku.

Ve verzi 2009-09-19 a novější jsou vlastnosti objektu blob zapouzdřeny v Properties elementu .

Počínaje verzí 2009-09-19 vrátí v textu odpovědi následující přejmenované List Blobs prvky:

• Last-Modified (dříve LastModified )

• Content-Length (dříve Size )

• Content-Type (dříve ContentType )

• Content-Encoding (dříve ContentEncoding )

• Content-Language (dříve ContentLanguage )

Element Content-MD5 se zobrazí pro objekty blob vytvořené ve verzi 2009-09-19 a novější. Ve verzi 2012-02-12 a novější vypočítá Blob service hodnotu při nahrání objektu blob pomocí put blob, ale nepočítá to při vytváření objektu blob pomocí funkce Content-MD5 Put Block List. Hodnotu můžete explicitně nastavit při vytváření objektu blob nebo voláním operací Content-MD5 Put Block List nebo Set Blob Properties.

Ve verzích z 19. 9. 2009 a novějších, ale před verzí 2015-02-21 selže volání u kontejneru, který obsahuje doplňovací objekty blob, stavový kód List Blobs 409 (FeatureVersionMismatch), pokud výsledek výpisu obsahuje doplňovací objekt blob.

LeaseState a LeaseDuration se zobrazí pouze ve verzi 12. 2. 2012 a novější.

CopyId, , , , a se zobrazí pouze ve verzi CopyStatus CopySource CopyProgress CopyCompletionTime CopyStatusDescription 2012-02-12 a novější, když tato operace obsahuje include={copy} parametr . Tyto prvky se nezobrazí, pokud tento objekt blob nikdy nebyl cílem v operaci nebo pokud se tento objekt blob po dokončení operace změnil pomocí Copy Blob Copy Blob , nebo Set Blob Properties Put Blob Put Block List . Tyto prvky se také nezobrazí s objektem blob vytvořeným objektem blob copy před verzí 2012-02-12.

Ve verzi 2013-08-15 a novější obsahuje element atribut určující koncový bod objektu blob a pole určující EnumerationResults ServiceEndpoint název ContainerName kontejneru. V předchozích verzích byly tyto dva atributy v poli zkombinovány ContainerName dohromady. Také ve verzi 2013-08-15 a novější byl Url element v části Blob odebrán.

Pro verzi 21. 21. 2015 vrátí objekty blob všech typů List Blobs (objekty blob bloku, stránky a doplňovací objekty blob).

Pro verzi 2015-12-11 a vyšší List Blobs vrátí ServerEncrypted element . Tento element je nastavený na , pokud jsou metadata objektu blob a true aplikace zcela zašifrovaná a false jinak.

Pro verzi 2016-05-31 a vyšší vrátí element pro objekty blob přírůstkové kopie a snímky s hodnotou List Blobs IncrementalCopy nastavenou na true .

Pro verzi 2017-04-17 a vyšší vrátí element , pokud byla explicitně nastavena List Blobs AccessTier úroveň přístupu. Seznam povolených úrovní objektů blob stránky Premium najdete v tématu Vysoce výkonné Premium Storage a spravované disky pro virtuální počítače. Platné hodnoty Storage blob Pro obecné účely účty Hot / Cool / Archive v2. Pokud je objekt blob ve stavu čekání na vyřízení, vrátí se element s jednou z ArchiveStatus platných hodnot rehydrate-pending-to-hot / rehydrate-pending-to-cool . Podrobné informace o vrstvení objektů blob bloku najdete v tématu Horká, studená a archivní úroveň úložiště.

Pro verze 2017-04-17 a vyšší vrátí element u účtů blob Storage nebo List Blobs AccessTierInferred Pro obecné účely v2. Pokud objekt blob bloku nemá nastavenou úroveň přístupu, odvodíme úroveň z vlastností účtu úložiště a tato hodnota se nastaví na true . Tato hlavička je k dispozici pouze v případě, že je vrstva odvozena z vlastnosti účtu. Podrobné informace o vrstvení objektů blob bloku najdete v tématu Horká, studená a archivní úroveň úložiště.

Pro verze 2017-04-17 a vyšší vrátí element u účtů blob Storage nebo List Blobs AccessTierChangeTime Pro obecné účely v2. Tato hodnota se vrátí pouze v případě, že byla nastavena úroveň objektu blob bloku. Formát data následuje RFC 1123. Další informace naleznete v části Representation of Date-Time Values in Headers. Podrobné informace o vrstvení objektů blob bloku najdete v tématu Horká, studená a archivní úroveň úložiště.

Pro verzi 29. 7. 2017 se zobrazí a , když tato operace Deleted DeletedTime obsahuje parametr RemainingRetentionDays include={deleted} . Pokud tento objekt blob nebyl odstraněn, tyto prvky se nezobrazí. Tyto prvky se zobrazí pro objekt blob nebo snímek, které se odstraní pomocí DELETE operace, když byla povolena funkce softwarového odstranění. Deleted Pro objekty blob a snímky, které jsou odstraněny, je nastavená hodnota true. Deleted-Time odpovídá času odstranění objektu blob. RemainingRetentionDays označuje počet dní, po kterém bude služba Blob Service trvale odstraněný objekt blob.

Pro verzi 2017-11-09 a vyšší vrátí čas vytvoření Creation-Time tohoto objektu blob.

Pro verzi 2019-02-02 a vyšší vrátí element , pokud je objekt blob zašifrovaný pomocí List Blobs CustomerProvidedKeySha256 klíče poskytnutého zákazníkem. Hodnota se nastaví na hodnotu hash SHA-256 klíče použitého k zašifrování objektu blob. Kromě toho, pokud operace obsahuje parametr a objekt blob zašifrovaný pomocí klíče poskytnutého zákazníkem obsahuje metadata aplikace, element bude mít atribut , který indikuje, že objekt blob má metadata, která se v rámci operace include={metadata} nešifrují. Metadata Encrypted="true" List Blobs Pokud chcete získat přístup k metadatům těchto objektů blob, volejte get blob properties (Získat vlastnosti objektu blob) nebo Get Blob Metadata (Získat metadata objektu blob) s klíčem poskytnutým zákazníkem.

Pro verzi 2019-02-02 a vyšší vrátí element , pokud je objekt List Blobs blob zašifrovaný EncryptionScope oborem šifrování. Hodnota se nastaví na název oboru šifrování použitého k zašifrování objektu blob. Pokud operace obsahuje parametr , budou metadata aplikace v objektu blob transparentně dešifrována a include={metadata} dostupná v Metadata elementu .

Pro verze 2019-12-12 a vyšší vrátí element u účtů blob Storage nebo List Blobs Pro obecné účely v2, pokud je objekt ve stavu čekání na RehydratePriority vyřízení. Platné hodnoty jsou High / Standard . Podrobné informace o vrstvení objektů blob bloku najdete v tématu Horká, studená a archivní úroveň úložiště.

Pro verzi 2019-12-12 a vyšší vrátí element pro objekty blob a vygenerované verze objektů blob, když je pro účet povolená List Blobs VersionId funkce Versioning.

Pro verzi 2019-12-12 a vyšší vrátí element pro aktuální verzi objektu blob s hodnotou nastavenou na , aby se odlišil od automaticky generovaných verzí jen List Blobs IsCurrentVersion pro true čtení.

Pro verzi 2019-12-12 a vyšší vrátí element pro List Blobs TagCount objekty blob s libovolnými značkami. Prvek Tags se zobrazí pouze v případě, že tato operace obsahuje parametr include={tags} . Tyto prvky se nezobrazí, pokud objekt blob nemá žádné značky.

Pro verzi 2019-12-12 a vyšší vrátí List Blobs Sealed element pro doplňovací objekty blob. Prvek Sealed se zobrazí pouze v případě, že byl objekt blob připojení zapečetěný. Tyto prvky se nezobrazí, pokud doplňovací objekt blob není zapečetěný.

Pro verzi 2020-02-10 a vyšší List Blobs vrátí LastAccessTime element . Prvky ukazují, kdy se data objektu blob naposledy přistupovala podle zásad sledování času posledního přístupu účtu úložiště. Element nebude vrácen, pokud účet úložiště nemá zásady sledování času posledního přístupu nebo pokud je zásada zakázaná. Informace o nastavení zásad sledování času posledního přístupu účtu najdete v tématu Rozhraní API služby Blob Service. Element LastAccessTime nesleduje čas posledního přístupu k metadatům objektu blob.

Pro verzi 2020-06-12 a vyšší vrátí elementy a , pokud tato operace List Blobs ImmutabilityPolicyUntilDate zahrnuje parametr ImmutabilityPolicyMode include={immutabilitypolicy} .

Pro verzi 2020-06-12 a vyšší vrátí element , pokud tato operace List Blobs LegalHold zahrnuje parametr include={legalhold} .

Pro účty s povoleným hierarchickým oborem názvů verze 2020-06-12 a vyšší vrátí element , a , když List Blobs Owner Group Permissions Acl požadavek obsahuje include={permissions} parametr . Všimněte si, že element bude kombinovaný seznam přístupových a výchozích seznamu ACL, které byly Acl nastaveny v souboru nebo adresáři.

Pro účty s povoleným hierarchickým oborem názvů verze 2020-08-04 a vyšší vrátí List Blobs DeletionId element pro odstraněné objekty blob. DeletionId je 64bitový identifikátor bez znaménka, který jednoznačně identifikuje cestu s možností odstranění a odlišuje ji od ostatních odstraněných objektů blob se stejnou cestou.

<?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>
        <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>
      </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>  

Ukázková odpověď

Ukázkovou odpověď najdete v tématu Vytváření výčtu prostředků objektů blob.

Autorizace

Pokud je seznam řízení přístupu (ACL) kontejneru nastavený tak, aby povoll anonymní přístup ke kontejneru, může tuto operaci volat kterýkoli klient. Jinak může tuto operaci volat vlastník účtu a kdokoli, kdo má sdílený přístupový podpis s oprávněním k zobrazení seznamu objektů blob v kontejneru.

Poznámky

Vlastnosti objektu blob v odpovědi

Pokud jste požádali o to, aby byly nepotrzené objekty blob zahrnuty do výčtu, mějte na vědomí, že některé vlastnosti nejsou nastaveny, dokud se objekt blob nepotme, takže některé vlastnosti nemusí být v odpovědi vráceny.

Element x-ms-blob-sequence-number se vrátí pouze pro objekty blob stránky.

Element OrMetadata se vrátí pouze pro objekty blob bloku.

U objektů blob stránky hodnota vrácená v Content-Length elementu odpovídá hodnotě hlavičky objektu x-ms-blob-content-length blob.

Element se zobrazí v textu odpovědi pouze v případě, že byl v objektu blob nastaven pomocí Content-MD5 verze 2009-09-19 nebo novější. Vlastnost můžete nastavit Content-MD5 při vytvoření objektu blob nebo voláním metody Set Blob Properties. Ve verzi 2012-02-12 a novější nastaví hodnotu MD5 objektu blob bloku i v případě, že požadavek neobsahuje hlavičku Put Blob Put Blob MD5.

Metadata v odpovědi

Element Metadata je k dispozici pouze v include=metadata případě, že byl parametr zadán pro identifikátor URI. V Metadata elementu je hodnota každého páru název-hodnota uvedená v elementu, který odpovídá názvu dvojice.

Všimněte si, že metadata požadovaná pomocí tohoto parametru musí být uložená v souladu s omezeními pojmenování uloženými ve verzi z 19. 9. 2009 Blob service. Počínaje touto verzí musí všechny názvy metadat dodržovat zásady vytváření názvů pro identifikátory jazyka C#.

Pokud pár název-hodnota metadat porušuje omezení pojmenování vynucovaná verzí 2009-09-19, text odpovědi indikuje problematický název v rámci elementu, jak je znázorněno v následujícím fragmentu x-ms-invalid-name XML:

  
…  
<Metadata>  
  <MyMetadata1>first value</MyMetadata1>  
  <MyMetadata2>second value</MyMetadata2>  
  <x-ms-invalid-name>invalid-metadata-name</x-ms-invalid-name>  
</Metadata>  
…  
  

Značky v odpovědi

Element je k dispozici pouze v případě, že byl parametr zadán pro identifikátor URI a pokud Tags include=tags objekt blob obsahuje značky. V TagSet elementu se vrátí až 10 prvků, z nichž každý obsahuje značky a uživatelem Tag key value definovaného indexu objektů blob. Řazení značek není v odpovědi zaručeno.

Pokud objekt blob nemá žádné značky, nejsou prvky Tags TagCount a vráceny.

Služba úložiště udržuje silnou konzistenci mezi objektem blob a jeho značkami, ale sekundární index je nakonec konzistentní. Značky mohou být viditelné v odpovědi na seznam objektů blob předtím, než jsou viditelné pro operace Find Blobs by Tags (Najít objekty blob podle značek).

Snímky v odpovědi

Snímky jsou uvedeny v odpovědi pouze v případě, že include=snapshots byl parametr zadán v identifikátoru URI. Snímky uvedené v odpovědi nezahrnují element , protože LeaseStatus snímky nemohou mít aktivní zapůjčení.

Pokud voláte s oddělovačem, nelze do výčtu zahrnout List Blobs také snímky. Požadavek, který obsahuje obojí, vrátí chybu InvalidQueryParameter (stavový kód HTTP 400 – Chybný požadavek).

Nepotrzené objekty blob v odpovědi

Nepotrzené objekty blob jsou uvedené v odpovědi pouze v include=uncommittedblobs případě, že byl parametr zadán v identifikátoru URI. Nepotrzené objekty blob uvedené v odpovědi nezahrnují žádný z následujících prvků:

• Last-Modified

• Etag

• Content-Type

• Content-Encoding

• Content-Language

• Content-MD5

• Cache-Control

• Metadata

Odstraněné objekty blob v odpovědi

Odstraněné objekty blob jsou uvedené v odpovědi pouze v případě, že include=deleted byl parametr zadán v identifikátoru URI. Odstraněné objekty blob uvedené v odpovědi nezahrnují elementy zapůjčení, protože odstraněné objekty blob nemohou mít aktivní zapůjčení.

Odstraněné snímky jsou zahrnuté v odpovědi na seznam, pokud include=deleted,snapshot byl zadán pro identifikátor URI.

Metadata replikace objektů v odpovědi

Element je k dispozici, když byla u objektu blob vyhodnocena zásada replikace objektů a volání objektů blob seznamu bylo provedeno pomocí verze OrMetadata 2019-12-12 nebo novější. V OrMetadata elementu je hodnota každého páru název-hodnota uvedená v elementu, který odpovídá názvu dvojice. Formát name je , kde je identifikátor GUID představující identifikátor zásady replikace objektů v účtu úložiště a je identifikátor, který představuje identifikátor pravidla v or-{policy-id}_{rule-id} {policy-id} {rule-id} kontejneru úložiště. Platné hodnoty jsou 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>  
…  
  

Zásady neměnnosti v odpovědi

Prvky ImmutabilityPolicyUntilDate , jsou k dispozici pouze v ImmutabilityPolicyMode include=immutabilitypolicy případě, že byl parametr zadán na identifikátor URI.

<Properties> 
   <ImmutabilityPolicyUntilDate>date-time-value</ImmutabilityPolicyUntilDate>   
   <ImmutabilityPolicyMode>unlocked | locked </ImmutabilityPolicyMode>  
 </Properties> 

Blokování z právních práv v odpovědi

Element LegalHold je k dispozici pouze v include=legalhold případě, že byl parametr zadán pro identifikátor URI.

 <Properties> 
   <LegalHold>true | false </LegalHold>  
 </Properties> 

Vrácení sad výsledků pomocí hodnoty značky

Pokud zadáte hodnotu parametru a počet objektů blob, které se mají vrátit, tuto hodnotu překročí nebo překročí výchozí hodnotu pro , tělo odpovědi bude obsahovat prvek, který označuje další objekt blob, který se má vrátit při dalším maxresults maxresults NextMarker požadavku. Pokud chcete vrátit další sadu položek, zadejte hodnotu parametru značky v NextMarker identifikátoru URI pro následný požadavek.

Všimněte si, že hodnota NextMarker by měla být považována za neprůhlednou.

Použití oddělovače k přechodu k oboru názvů objektů blob

Parametr umožňuje volajícímu procházet obor názvů objektu blob pomocí uživatelem delimiter nakonfigurovaného oddělovače. Tímto způsobem můžete procházet virtuální hierarchii objektů blob, jako by se jedná o systém souborů. Oddělovačem může být jeden znak nebo řetězec. Pokud požadavek obsahuje tento parametr, operace vrátí BlobPrefix prvek. Element se vrátí místo všech objektů blob, jejichž názvy začínají stejným podřetězci až do vzhledu BlobPrefix znaku oddělovače. Hodnota elementu je BlobPrefix substring+delimiter , kde podřetězec je společný podřetězec, který začíná jedním nebo více názvy objektů blob, a oddělovač je hodnota parametru oddělovače.

Hodnotu můžete použít k dalšímu volání pro zobrazení seznamu objektů blob, které začínají touto předponou, zadáním hodnoty parametru v BlobPrefix BlobPrefix prefix identifikátoru URI požadavku.

Všimněte BlobPrefix si, že každý vrácený prvek se počítá do maximálního výsledku stejně jako každý Blob prvek.

Objekty blob jsou v textu odpovědi uvedené v abecedním pořadí s velkými písmeny.

Chyby kopírování v copyStatusDescription

CopyStatusDescription obsahuje další informace o Copy Blob selhání.

• Pokud pokus o kopírování selže a Blob service operace stále zopakuje, je nastavená na a text popisuje chybu, ke které může dojít při posledním CopyStatus pending CopyStatusDescription pokusu o kopírování.

• Pokud CopyStatus je nastavená failed na , text CopyStatusDescription popisuje chybu, která způsobila selhání operace kopírování.

Následující tabulka popisuje tři pole každé CopyStatusDescription hodnoty.

Následující tabulka popisuje hodnoty CopyStatus CopyStatusDescription a běžných scénářů selhání.

Viz také

Stavové a chybové kódy
Kódy chyb služby Blob Service