Windows interfejs API REST usługi Azure Pack Websites
Dotyczy: Windows Azure Pack
W tej dokumentacji opisano sposób wykonywania typowych zadań w witrynach internetowych przy użyciu interfejsu API REST zarządzania witrynami sieci Web Windows Azure Pack.
Omówienie
Interfejs API zarządzania witrynami sieci Web Windows Azure Pack udostępnia zestaw usług internetowych resTful, które współdziałają z usługą Windows Witryn sieci Web pakietu Azure Pack do zarządzania witrynami internetowymi. Interfejs API zawiera jednostki, które przechwytują relację między użytkownikiem końcowym a usługą Windows Witryn sieci Web pakietu Azure Pack.
Interfejs API zarządzania witrynami sieci Web umożliwia podstawowy zestaw scenariuszy administrowania witrynami:
Tworzenie, usuwanie i konfigurowanie witryn internetowych.
Wykonywanie zapytań dotyczących stanu witryn internetowych.
Wykonywanie zapytań dotyczących metryk, takich jak użycie zasobów, limity przydziału i limity.
Pobieranie metadanych, takich jak profile publikowania.
Skonfiguruj skalę witryn internetowych.
Użytkownicy końcowi
Istnieją dwie główne kategorie użytkowników końcowych Windows interfejsu API REST zarządzania witrynami sieci Web pakietu Azure:
Administrator witryny sieci Web tworzy witryny i zasoby uzupełniające oraz zarządza nimi w witrynach sieci Web Windows Azure Pack. Ta rola odpowiada administratorowi lub współadministratorowi subskrypcji Windows Azure Pack.
Publisher uzyskuje dostęp do zawartości witryny i publikuje zawartość przy użyciu protokołu, takiego jak FTP lub WebDeploy. Z punktu widzenia dostawcy hostingu wydawca jest użytkownikiem FTP. Wydawca nie może wykonywać akcji zarządzania w witrynie.
Zasoby
Interfejs API REST witryn internetowych platformy Azure Windows uwidacznia następującą hierarchię zasobów do zarządzania usługami i wdrożeniami:
/subscriptions
/WebSpaces
/sites
/config
/publishxml
/usages
/metrics
/repository
/ServerFarm
W poniższej tabeli opisano powyższe zasoby.
Zasób |
Opis |
|---|---|
Subskrypcje |
Subskrypcja Windows Azure Pack wymagana do korzystania z witryn sieci Web platformy Azure Windows. |
Przestrzenie internetowe |
Przestrzeń internetowa, która jest jednostką logiczną skojarzona z subskrypcją użytkownika w danym regionie geograficznym. Wszystkie witryny w danym regionie są skojarzeniami danej przestrzeni internetowej. |
Witryny |
Witryna, która jest podstawową jednostką zasobów oferowaną przez usługę Windows Azure Web Sites. |
Config |
Zasób zawierający właściwości konfiguracji lokacji, takie jak AppSettings, ConnectionStrings, ErrorLogging i FrameworkVersions. |
Publikowaniexml |
Plik w formacie XML zawierający ustawienia użytkownika służące do publikowania aplikacji internetowej w celu Windows witryn internetowych platformy Azure. Ten plik można zaimportować i użyć z Microsoft Visual Studio lub macierzy sieci Web. |
Zwyczaje |
Zasób zawierający informacje o bieżącym użyciu witryny internetowej. |
Metryki |
Zasób zawierający historyczne informacje w raportach o użyciu. |
Repozytorium |
Repozytorium zarządzania kontrolą źródła, które jest skojarzone z lokacją. |
Serwerfarm |
Zestaw komputerów zarezerwowanych do hostowania witryn dla określonej dzierżawy w danym regionie. Obecnie obsługiwana jest tylko jedna farma serwerów na centrum danych. |
Operacje na zasobach
Tworzenie zasobu
Nowe zasoby są tworzone za pomocą czasownika HTTP POST. Nazwa zasobu jest przekazywana w treści żądania. Jeśli zasób zostanie utworzony pomyślnie, zostanie zwrócony kod stanu HTTP 201, a serializowany obiekt zasobu zostanie uwzględniony w treści odpowiedzi. Jeśli klient próbuje utworzyć zasób, który już istnieje, zwracany jest kod stanu konfliktu HTTP 409.
Odczytywanie zasobu
Aby odczytać bieżący stan istniejącego zasobu, jest używane czasownik HTTP GET. Jeśli zasób istnieje, kod stanu odpowiedzi to 200, a treść odpowiedzi zawiera obiekt serializowany. Jeśli zasób nie istnieje, kod stanu odpowiedzi to 404, zasób nie został znaleziony.
Aktualizowanie zasobu
Istniejące zasoby są aktualizowane za pomocą czasownika HTTP PUT. Nazwa obiektu jest przekazywana w ciągu adresu URL, a nowy stan obiektu jest przekazywany w treści żądania. Jeśli zasób zostanie pomyślnie zaktualizowany, zostanie zwrócony kod stanu HTTP 200. Jeśli zasób do zaktualizowania nie istnieje, zwracany jest kod stanu HTTP 404 (nie znaleziono).
Usuwanie zasobu
Istniejący zasób jest usuwany z czasownikiem HTTP DELETE. Nazwa obiektu jest przekazywana w ciągu adresu URL. Jeśli zasób zostanie pomyślnie usunięty, zostanie zwrócony kod stanu HTTP 200. Jeśli obiekt został już usunięty lub nie istnieje, zwracany jest błąd HTTP 404.
Przechowywanie wersji interfejsu API
Podobnie jak Windows usług platformy Azure, Windows witryny internetowe pakietu Azure Pack są zgodne z wersją interfejsu API REST platformy Azure Windows. Operacje udostępniane przez interfejs API REST witryn sieci Web Windows Azure Pack mają wiele wersji. Musisz określić wersję operacji, której chcesz użyć, ustawiając nagłówek żądania x-ms-version. Żądania bez nagłówka x-ms-version są odrzucane i zwracają odpowiedź na nieprawidłowe żądanie (400). Jeśli usługa wywołuje poprzednią wersję operacji i istnieje nowsza wersja, możesz kontynuować wywoływanie poprzedniej wersji lub kontynuować modyfikowanie kodu w celu wywołania nowszej wersji.
Uwaga
Mimo że wersje interfejsu API mogą ulec zmianie, Windows witryny sieci Web pakietu Azure Pack obsługują zarówno nowszą wersję interfejsu API, jak i bezpośrednio poprzednią wersję.
Wartość nagłówka żądania x-ms-version musi być określona w formacie RRRR-MM-DD. Przykładowy kod przedstawia wymagany format.
Nagłówki żądań:
x-ms-version: 2012-10-10