Liste Tanıtıcıları
List Handles
işlemi, bir dizin veya dosyadaki açık tanıtıcıların listesini döndürür. İsteğe bağlı olarak, dizinlerde ve dosyalarda açık tanıtıcıları yinelemeli olarak numaralandırabilir. Bu API, 2018-11-09 sürümünden itibaren kullanılabilir.
Protokol kullanılabilirliği
Etkin dosya paylaşımı protokolü | Mevcut |
---|---|
SMB |
![]() |
NFS |
![]() |
İstek
List Handles
isteği aşağıdaki gibi oluşturulur. HTTPS kullanmanızı öneririz.
Yöntem | İstek URI'si | HTTP sürümü |
---|---|---|
AL | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfileordirectory?comp=listhandles |
HTTP/1.1 |
İstek URI'sinde gösterilen yol bileşenlerini aşağıdaki gibi kendinizle değiştirin:
Yol bileşeni | Açıklama |
---|---|
myaccount |
Depolama hesabınızın adı. |
myshare |
Dosya paylaşımınızın adı. |
mydirectorypath |
Opsiyonel. Dizinin yolu. |
myfileordirectory |
Dosyanın veya dizinin adı. |
Yol adlandırma kısıtlamaları hakkında ayrıntılı bilgi için bkz. Paylaşımları, dizinleri, dosyaları ve meta verileriadlandırma ve başvurma.
URI parametreleri
URI'de aşağıdaki ek parametreleri belirtebilirsiniz.
Parametre | Açıklama |
---|---|
marker |
Opsiyonel. Sonraki List Handles işlemiyle döndürülecek listenin bölümünü tanımlayan dize değeri. Döndürülen liste tamamlanmadıysa, işlem yanıt gövdesinde bir işaretçi değeri döndürür. Daha sonra sonraki bir çağrıda işaretleyici değerini kullanarak bir sonraki liste öğesi kümesini isteyebilirsiniz.İşaretçi değeri istemciye göre opaktır. |
maxresults |
Opsiyonel. Döndürülecek dosya veya dizinlerde alınan en fazla tanıtıcı sayısını belirtir. maxresults sıfırdan küçük veya sıfıra eşit bir değere ayarlanması hata yanıt kodu 400 (Hatalı İstek) ile sonuçlanır. |
timeout |
Opsiyonel.
timeout parametresi saniye cinsinden ifade edilir. Daha fazla bilgi için bkz. Azure Dosyalar işlemleri için zaman aşımlarını ayarlama. |
sharesnapshot |
Opsiyonel.
sharesnapshot parametresi, mevcut olduğunda tanıtıcı listesini sorgulayan paylaşım anlık görüntüsünü belirten opak bir DateTime değeridir. |
İstek üst bilgileri
Aşağıdaki tabloda gerekli ve isteğe bağlı istek üst bilgileri açıklanmaktadır.
İstek üst bilgisi | Açıklama |
---|---|
Authorization |
Gerekli. Yetkilendirme düzenini, hesap adını ve imzayı belirtir. Daha fazla bilgi için bkz. azure depolama istekleri yetkilendirme. |
Date veya x-ms-date |
Gerekli. İstek için Eşgüdümlü Evrensel Saati (UTC) belirtir. Daha fazla bilgi için bkz. azure depolama istekleri yetkilendirme. |
x-ms-version |
Anonim istekler için isteğe bağlı olarak tüm yetkili istekler için gereklidir. Bu istek için kullanılacak işlemin sürümünü belirtir. Daha fazla bilgi için bkz. Azure Depolama hizmetleri için sürüm oluşturma. |
x-ms-client-request-id |
Opsiyonel. Günlüğe kaydetme yapılandırıldığında günlüklere kaydedilen 1 kibibayt (KiB) karakter sınırıyla istemci tarafından oluşturulan, opak bir değer sağlar. İstemci tarafı etkinlikleriyle sunucunun aldığı istekler arasında bağıntı sağlamak için bu üst bilgiyi kullanmanızı kesinlikle öneririz. Daha fazla bilgi için bkz. azure dosyaları izleme. |
x-ms-recursive |
Opsiyonel. İşlemin URI'de belirtilen dizinin dosyalarına ve alt dizinlerine de uygulanıp uygulanacağını belirten boole değeri. |
x-ms-file-request-intent |
Authorization üst bilgisi bir OAuth belirteci belirtiyorsa gereklidir. Kabul edilebilir değer backup . Bu üst bilgi, Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action veya Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action , Authorization üst bilgisi kullanılarak yetkilendirilmiş kimliğe atanan RBAC ilkesine eklenmişse verilmesi gerektiğini belirtir. Sürüm 2022-11-02 ve üzeri için kullanılabilir. |
x-ms-allow-trailing-dot: { <Boolean> } |
Opsiyonel. Sürüm 2022-11-02 ve üzeri. Boole değeri, istek URL'sinde bulunan sondaki bir noktanın kırpılıp kırpılmaması gerektiğini belirtir. Daha fazla bilgi için bkz. Paylaşımları, dizinleri, dosyaları ve meta verileriadlandırma ve başvurma. |
İstek gövdesi
Hiç kimse.
Yanıt
Yanıt bir HTTP durum kodu, yanıt üst bilgileri kümesi ve XML biçiminde bir yanıt gövdesi içerir.
Durum kodu
Başarılı bir işlem 200 durum kodunu döndürür (Tamam). Durum kodları hakkında bilgi için bkz. Durum ve hata kodları.
Yanıt üst bilgileri
Bu işlemin yanıtı aşağıdaki tabloda yer alan üst bilgileri içerir. Yanıt, ek standart HTTP üst bilgileri de içerebilir. Tüm standart üst bilgiler HTTP/1.1 protokol belirtimine uygundur.
Ortak üst bilgiler
Yanıt üst bilgisi | Açıklama |
---|---|
Content-Type |
Sonuçların döndürüldiği biçimi belirtir. Şu anda bu değer application/xml . |
x-ms-request-id |
Bu üst bilgi, yapılan isteği benzersiz olarak tanımlar ve isteğin sorunlarını gidermek için kullanılabilir. Daha fazla bilgi için bkz. API işlemleriyle ilgili sorunları giderme. |
x-ms-version |
İsteği çalıştırmak için kullanılan Azure Dosyalar sürümünü gösterir. |
Date |
Yanıtın başlatıldığı saati gösteren UTC tarih/saat değeri. Hizmet bu değeri oluşturur. |
x-ms-client-request-id |
İstekler ve karşılık gelen yanıtlarla ilgili sorunları gidermek için bu üst bilgiyi kullanabilirsiniz. bu üst bilginin değeri, istekte varsa x-ms-client-request-id üst bilgisinin değerine eşittir. Değer en fazla 1024 görünür ASCII karakterdir. İstekte x-ms-client-request-id üst bilgisi yoksa, yanıtta bu üst bilgi bulunmaz. |
Yanıt gövdesi
XML yanıtının biçimi aşağıdaki gibidir.
Marker
, ShareSnapshot
ve MaxResults
öğelerinin yalnızca istek URI'sinde belirttiğinizde mevcut olduğunu unutmayın.
NextMarker
öğesi yalnızca liste sonuçları tamamlanmazsa bir değere sahiptir.
yanıt olarak ClientName
alanı isteğe bağlıdır ve yalnızca hizmet tarafından kullanılabilir olduğunda döndürülür.
<?xml version="1.0" encoding="utf-8"?>
<EnumerationResults>
<HandleList>
<Handle>
<HandleId>handle-id</HandleId>
<Path>file-or-directory-name-including-full-path</Path>
<FileId>file-id</FileId>
<ParentId>parent-file-id</ParentId>
<SessionId>session-id</SessionId>
<ClientIp>client-ip</ClientIp>
<ClientName>client-name</ClientName>
<OpenTime>opened-time</OpenTime>
<LastReconnectTime>lastreconnect-time</LastReconnectTime>
<AccessRightList>
<AccessRight>Read</AccessRight>
<AccessRight>Write</AccessRight>
<AccessRight>Delete</AccessRight>
</AccessRightList>
</Handle>
...
</HandleList>
<NextMarker>next-marker</NextMarker>
</EnumerationResults>
Aşağıdaki tabloda yanıt gövdesinin alanları açıklanmaktadır:
Alan | Açıklama | Amaç |
---|---|---|
HandleId |
XSMB hizmet tanıtıcı kimliği, UINT64. | Tanıtıcıyı tanımlamak için kullanılır. |
Path |
Paylaşım kökünden başlayarak tam yol da dahil olmak üzere dosya adı. Dizgi. | Tanıtıcının açık olduğu nesnenin adını tanımlamak için kullanılır. |
ClientIp |
Tanıtıcıyı açan istemci IP'si. Dizgi. | Tutamacın sızdırılmış olup olmadığını belirlemek için kullanılır. |
ClientName |
İsteğe bağlı alan. 2024-02-04 ve üzeri sürümleri desteklenir. tanıtıcıyı açan İstemci Adı (İş İstasyonu veya İşletim Sistemi Kullanıcı Adı). Dizgi. | Tutamacın sızdırılmış olup olmadığını belirlemek için kullanılır. |
OpenTime |
Zaman tanıtıcısı açıldı (UTC). Dize olarak DateTime . |
Tanıtıcının sızdırılıp sızdırılmış olabileceğine karar vermek için kullanılır. Sızdırılan tutamaçlar genellikle uzun süredir açıktır. |
LastReconnectTime |
Zaman tanıtıcısı açıldı (UTC). Dize olarak DateTime . |
Ağ veya diğer hatalar nedeniyle bir istemci/sunucu bağlantısı kesildikten sonra tanıtıcının yeniden açılıp açılmayeceğine karar vermek için kullanılır. Bu alan yanıt gövdesine yalnızca bağlantı kesme olayı oluştuğunda ve tanıtıcı yeniden açıldığında eklenir. |
FileId |
Dosya Kimliği, UINT64. |
FileId dosyayı benzersiz olarak tanımlar.
FileId değişmediğinden, yeniden adlandırmalar sırasında kullanışlıdır. |
ParentId |
Üst Dosya Kimliği, UINT64. |
ParentId dizini benzersiz olarak tanımlar. Bu, ParentId değişmediğinden yeniden adlandırmalar sırasında kullanışlıdır. |
SessionId |
Dosya tanıtıcısının açıldığı bağlamı belirten SMB oturum kimliği. UINT64. |
SessionId , oturumların bağlantısı zorla kesildiğinde olay görüntüleyicisi günlüklerine eklenir. Belirli bir grup sızdırılmış tanıtıcıyı belirli bir ağ olayıyla ilişkilendirmenizi sağlar. |
AccessRightList |
Dosya veya dizindeki açık tanıtıcıya verilen erişim izinleri. | Hizmet sürümü 2023-01-03 ve sonraki sürümlerde kullanılabilir. Bir dosya veya dizinde tutulan erişim izinlerini çeşitli açık tanıtıcılarla sorgulamak için kullanılır. Olası değerler READ, WRITE ve DELETE değerleridir veya bu değerlerin bir bileşimidir. |
NextMarker |
Listelenecek sonraki tanıtıcıyı açıklayan bir dize. İsteği tamamlamak için daha fazla tanıtıcının listelenmesi gerektiğinde döndürülür. | Dize, kalan tanıtıcıları listelemek için sonraki isteklerde kullanılır.
NextMarker olmaması, tüm ilgili tanıtıcıların listelendiğini gösterir. |
2021-12-02 ve daha yeni sürümlerde List Handles
, XML'de geçersiz karakterler (özellikle U+FFFE veya U+FFFF) içeren tüm Path
öğe değerlerini yüzde kodlar (RFC 2396 başına). Kodlanırsa, Path
öğesi bir Encoded=true
özniteliği içerir. Bunun yanıttaki kalan Path
öğeleri için değil yalnızca XML'de geçersiz karakterleri içeren Path
öğesi değerleri için gerçekleşeceğini unutmayın.
ClientName
2024-02-04 ve sonraki sürümlerde desteklenir.
İzin
Bu işlemi yalnızca hesap sahibi çağırabilir.
Açıklamalar
HandleId
, istemci tanıtıcı kimliğinden ayrı bir hizmet tarafı tanıtıcı kimliğidir. İstemcide ikisi arasında eşleme yapılabilir.