Azure-Devops REST API - paginacja i limit szybkości
Próbuję pobrać dane jednostek Azure-Devops (zespoły, projekty, repozytoria, członkowie itp.) I przetwarzać te dane lokalnie. Nie mogę znaleźć żadnej dokumentacji dotyczącej ograniczania szybkości i paginacji, czy ktoś ma z tym jakieś doświadczenie?
Istnieje dokumentacja dotycząca paginacji w interfejsie API członków:
https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/members/get?view=azure-devops-rest-6.0
Ale to jedyne, nie mogłem znaleźć żadnej dokumentacji dla żadnego z podmiotów git,
np. Repozytoriów.
https://docs.microsoft.com/en-us/rest/api/azure/devops/git/repositories/list?view=azure-devops-rest-6.0
Gdyby ktoś mógł wskazać mi odpowiednią dokumentację, lub rzucić trochę światła na te tematy, byłoby wspaniale.
Dzięki.
Odpowiedzi
Nie mogę znaleźć żadnej dokumentacji dotyczącej ograniczania stawek i paginacji, czy ktoś ma z tym jakieś doświadczenie?
Istnieje dokument o limitach usług i limitach stawek , który wprowadził limity usług i limity cenowe , którym podlegają wszystkie projekty i organizacje.
W przypadku ograniczenia kursu:
Usługi Azure DevOps, podobnie jak wiele rozwiązań typu oprogramowanie jako usługa, korzystają z wielu dzierżawców w celu obniżenia kosztów oraz zwiększenia skalowalności i wydajności. To sprawia, że użytkownicy są narażeni na problemy z wydajnością, a nawet przestoje, gdy inni użytkownicy ich współdzielonych zasobów mają gwałtowne wzrosty ich zużycia. Aby zwalczyć te problemy, usługi Azure DevOps Services ograniczają zasoby, które poszczególne osoby mogą zużywać, oraz liczbę żądań, które mogą wysyłać do określonych poleceń. Po przekroczeniu tych limitów kolejne żądania mogą zostać opóźnione lub zablokowane.
Szczegółowe informacje można znaleźć w dokumentacji limitów stawek
W przypadku paginacji na ogół REST API będzie miał odpowiedź z podziałem na strony, a ADO REST API zwykle ma limity 100/200 (w zależności od API) na stronę w każdej odpowiedzi. Sposobem na pobranie informacji o następnej stronie jest odwołanie się do nagłówka odpowiedzi x-ms-continuationtokeni użycie go dla następnego parametru żądania jako continuationToken.
Ale Microsoft nie dokumentuje tego zbyt dobrze - należało o tym wspomnieć w każdym wywołaniu API, które obsługuje tokeny kontynuacji :
Budynki - Lista:
GET https://dev.azure.com/{organization}/{project}/_apis/build/builds?definitions={definitions}&continuationToken={continuationToken}&maxBuildsPerDefinition={maxBuildsPerDefinition}&deletedFilter={deletedFilter}&queryOrder={queryOrder}&branchName={branchName}&buildIds={buildIds}&repositoryId={repositoryId}&repositoryType={repositoryType}&api-version=5.1
Jeśli użyję powyższego interfejsu API REST z $top=50, zgodnie z oczekiwaniami, otrzymam 50 z powrotem i nagłówek o nazwie „ x-ms-continuationtoken”, wówczas możemy zapętlić wynik za pomocą continuationtoken:
Możesz sprawdzić ten podobny wątek, aby uzyskać więcej informacji.
Myślę, że dla większości API masz parametr zapytania jako $top/$skip.Możesz użyć tego parametru do paginacji. Powiedzmy, że domyślny przebieg daje 200 dokumentów w odpowiedzi. W następnym uruchomieniu pomiń te 200, podając $ skip = 200 w parametrze zapytania żądania, aby uzyskać następne 200 elementów. Możesz kontynuować iterację, aż atrybut count odpowiedzi zmieni się na 0.
W przypadku tych interfejsów API, jeśli nie masz tych parametrów, możesz użyć tokena kontynuacji, o czym wspomniał Leo Liu-MSFT.
Wygląda na to, że możesz przekazać $topi continuationTokenwyświetlić referencje Azure Git.
Dokumentacja jest tutaj:
https://docs.microsoft.com/en-us/rest/api/azure/devops/git/refs/list?view=azure-devops-rest-6.0