Konfigurowanie hostów wirtualnych

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Klient Cloud z płatnym kontem i wszystkimi klientami Edge dla Private Cloud może utworzyć hosta wirtualnego w organizacji. Użytkownik tworzący hosta wirtualnego musi mieć rolę administratora organizacji lub rolę niestandardową z uprawnieniami do modyfikowania hosta wirtualnego. Użytkownicy z innymi rolami nie mają uprawnień do tworzenia hostów wirtualnych.

Tworzenie hosta wirtualnego

Aby utworzyć hosta wirtualnego, wykonaj poniższe podstawowe czynności. Dokładna procedura zależy od tego, czy korzystasz z Cloud czy Private Cloud, i od tego, czy włączasz TLS:

1. Utwórz wpis DNS i rekord CNAME dla swojej domeny dostępnej publicznie.
2. Jeśli włączysz TLS na hoście wirtualnym:
1. Utwórz i skonfiguruj magazyn kluczy, wykonując czynności opisane w tym artykule: magazyny kluczy i magazyny zaufania.
2. Prześlij certyfikat i klucz do magazynu kluczy. Upewnij się, że nazwa domeny określona w certyfikacie jest zgodna z aliasem hosta, którego chcesz używać w przypadku hosta wirtualnego.
3. Utwórz odwołanie do magazynu kluczy za pomocą interfejsu użytkownika Edge lub interfejsu API. Odwołanie określa nazwę magazynu kluczy i typ odwołania jako KeyStore. Więcej informacji o tworzeniu i modyfikowaniu plików referencyjnych znajdziesz w artykule o pracy z plikami referencyjnymi.
4. Jeśli korzystasz z dwukierunkowego protokołu TLS, utwórz magazyn zaufania, prześlij certyfikat i utwórz odniesienie do tego magazynu. Utwórz magazyn zaufania, wykonując czynności opisane tutaj: magazyny kluczy i magazyny zaufania.
3. Utwórz hosta wirtualnego za pomocą interfejsu API Create a Virtual Host (Utwórz hosta wirtualnego). Jeśli włączysz TLS, pamiętaj, aby określić poprawne odwołanie do magazynu kluczy, odwołanie do magazynu zaufanych certyfikatów i określenie aliasu klucza.
4. Jeśli masz już serwery proxy interfejsu API, dodaj hosta wirtualny do punktu ProxyEndpoint. Host wirtualny jest automatycznie dodawany do wszystkich nowych serwerów proxy interfejsu API. Przeczytaj artykuł o konfigurowaniu serwera proxy interfejsu API pod kątem używania hosta wirtualnego.
   

Po zaktualizowaniu serwera proxy interfejsu API w celu używania hosta wirtualnego oraz utworzeniu wpisu DNS i rekordu CNAME dla aliasu hosta możesz uzyskać dostęp do serwera proxy interfejsu API w następujący sposób:

https://api.myCompany.com/v1/project-base-path/resource-path

Na przykład:

https://api.myCompany.com/v1/weather/forecastrss?w=12797282

Tworzenie hosta wirtualnego za pomocą interfejsu API lub interfejsu użytkownika

Hosta wirtualnego możesz utworzyć za pomocą interfejsu Edge API lub interfejsu Edge.

Większość z poniższych przykładów korzysta z interfejsu Edge API. Aby uzyskać dostęp do interfejsu użytkownika umożliwiającego tworzenie, modyfikowanie i usuwanie hostów wirtualnych w interfejsie Edge:

1. Zaloguj się na stronie apigee.com/edge.

   Klienci Edge dla Private Cloud używają środowiska http://ms-ip:9000 (lokalnego), gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania.

2. Na pasku nawigacyjnym po lewej stronie wybierz Administracja > Hosty wirtualne.
3. Wybierz środowisko, na przykład prod lub test.
   Wyświetlane są hosty wirtualne zdefiniowane dla środowiska.
4. Wybierz + Host wirtualny, aby utworzyć hosta wirtualnego, lub wybierz nazwę istniejącego hosta wirtualnego, aby go edytować.

Tworzenie hosta wirtualnego dla HTTP

Edge dla klientów Private Cloud może utworzyć hosta wirtualnego za pomocą HTTP.

Aby utworzyć hosta wirtualnego, który nie obsługuje TLS, utwórz obiekt XML określający hosta wirtualnego. Na przykład ten obiekt XML definiuje hosta wirtualnego, który używa protokołu HTTP:

<VirtualHost name="myVHost">
   <HostAliases>
     <HostAlias>api.myCompany.com</HostAlias>
   </HostAliases>
   <Interfaces/>
   <Port>80</Port>
</VirtualHost>

Zgodnie z tą definicją:

• W polu name (nazwa) wpisz myVHost. Użyj nazwy, aby odwoływać się do hosta wirtualnego w serwerze proxy interfejsu API lub w wywołaniu interfejsu API.
• Określ alias hosta jako api.myCompany.com. Jest to domena dostępna publicznie, która służy do uzyskiwania dostępu do interfejsów API zgodnie z definicją DNS i rekordem CNAME.
• Podaj numer portu jako 80. Jeśli go pominiesz, domyślnie zostanie ustawiony port 443.

• Na hoście wirtualnym można ustawić dodatkowe właściwości. Informacje o wszystkich właściwościach znajdziesz w dokumentacji właściwości hosta wirtualnego.

Jeśli masz istniejące serwery proxy interfejsu API, dodaj hosta wirtualnego do elementu <HTTPConnection> w punkcie końcowym serwera proxy. Host wirtualny jest automatycznie dodawany do wszystkich nowych serwerów proxy interfejsu API. Zobacz Konfigurowanie serwera proxy interfejsu API do korzystania z hosta wirtualnego. Jeśli utworzysz nowy serwer proxy interfejsu API, który nie powinien być dostępny przez konkretny host wirtualny, musisz zmodyfikować serwer proxy interfejsu API, aby usunąć tego hosta wirtualny z punktu ProxyEndpoint.

Za pośrednictwem tego hosta wirtualnego możesz uzyskać dostęp do serwera proxy interfejsu API, wysyłając żądanie do:

http://api.myCompany.com/proxy-base-path/resource-path
https://api.myCompany.com/proxy-base-path/resource-path

Utwórz hosta wirtualnego za pomocą interfejsu API Create a Virtual Host (Utwórz hosta wirtualnego):

curl -X POST -H "Content-Type:application/xml" \
  http://ms-IP:8080/v1/o/org_name/environments/env_name/virtualhosts \
  -d '<VirtualHost name="myVHost">
        <HostAliases>
            <HostAlias>api.myCompany.com</HostAlias>
        </HostAliases>
        <Interfaces/>
        <Port>80</Port>
    </VirtualHost>' \
  -u sysAdminEmail:password

Tworzenie hosta wirtualnego dla jednokierunkowego protokołu TLS

Poniższy obiekt XML definiuje hosta wirtualnego dla jednokierunkowego protokołu TLS:

<VirtualHost name="myTLSVHost">
    <HostAliases>
        <HostAlias>api.myCompany.com</HostAlias>
    </HostAliases>
    <Port>443</Port>
    <SSLInfo>
        <Enabled>true</Enabled>
        <ClientAuthEnabled>false</ClientAuthEnabled>
        <KeyStore>ref://myTestKeystoreRef</KeyStore>
        <KeyAlias>myKeyAlias</KeyAlias>
    </SSLInfo>
</VirtualHost>

W tej definicji włączasz TLS, ustawiając dla elementu <Enable> wartość true oraz używając elementów <KeyStore> i <KeyAliase> do określania magazynu kluczy i aliasu klucza wykorzystywanego przez połączenie TLS.

Więcej informacji o korzystaniu z TLS znajdziesz w sekcji TLS/SSL.

Określam, jak określić nazwę magazynu kluczy i magazynu zaufanych certyfikatów na hoście wirtualnym

Konfigurując host wirtualny do obsługi protokołu TLS, musisz podać magazyn kluczy w odwołaniu. Odwołanie to zmienna zawierająca nazwę magazynu kluczy lub zaufanego magazynu, zamiast wskazywać bezpośrednio nazwę magazynu kluczy lub zaufania, jak w przykładzie poniżej:

    <SSLInfo>
        <Enabled>true</Enabled>
        <ClientAuthEnabled>false</ClientAuthEnabled>
        <KeyStore>ref://myTestKeystoreRef</KeyStore>
        <KeyAlias>myKeyAlias</KeyAlias>
    </SSLInfo>

Zaletą korzystania z pliku referencyjnego jest to, że możesz zmienić jego wartość, aby zmienić magazyn kluczy używany przez hosta wirtualnego. Zwykle dlatego, że certyfikat w bieżącym magazynie kluczy wkrótce wygaśnie. Zmiana wartości odwołania nie wymaga ponownego uruchomienia routera brzegowego. Więcej informacji o tworzeniu i modyfikowaniu plików referencyjnych znajdziesz w artykule Praca z plikami referencyjnymi.

Możesz używać tylko odwołania do magazynu kluczy i magazynu zaufania. Nie możesz użyć odwołania do aliasu. Gdy zmienisz odwołanie na magazyn kluczy, upewnij się, że alias nazwy certyfikatu jest taki sam jak w starym magazynie kluczy.

Ograniczenia korzystania z odwołań do magazynów kluczy i magazynu zaufania

Gdy używasz odwołań do magazynów kluczy i magazynów zaufania, musisz wziąć pod uwagę te ograniczenia:

• Odwołań do magazynu kluczy i magazynu zaufania możesz używać tylko na hostach wirtualnych, jeśli obsługujesz SNI i wyłączysz SSL na routerach Apigee.
• Jeśli masz system równoważenia obciążenia przed routerami Apigee i wyłączysz protokół TLS w systemie równoważenia obciążenia, nie możesz używać odwołań do magazynu kluczy ani magazynu zaufanych certyfikatów na hostach wirtualnych.

Tworzenie hosta wirtualnego dla dwukierunkowego protokołu TLS

Aby włączyć dwukierunkowe protokół TLS, ustaw element <ClientAuthEnabled> na true i wskaż magazyn zaufania za pomocą pliku referencyjnego z elementem <TrustStore>. Magazyn zaufania zawiera wydawcę certyfikatu klienta i łańcuch urzędów certyfikacji, co jest wymagane. Klient musi też być prawidłowo skonfigurowany pod kątem dwukierunkowego protokołu TLS.

Aby utworzyć hosta wirtualnego dla dwukierunkowego protokołu TLS, utwórz obiekt XML definiujący hosta wirtualnego:

<VirtualHost name="myTLSVHost">
    <HostAliases>
        <HostAlias>api.myCompany.com</HostAlias>
    </HostAliases>
    <Port>443</Port>
    <SSLInfo>
        <Enabled>true</Enabled>
        <ClientAuthEnabled>true</ClientAuthEnabled>
        <KeyStore>ref://myTestKeystoreRef</KeyStore>
        <KeyAlias>myKeyAlias</KeyAlias>
        <TrustStore>ref://myTestTruststoreRef</TrustStore>
    </SSLInfo>
</VirtualHost>

Zgodnie z tą definicją:

• Włącz dwukierunkowe szyfrowanie TLS, ustawiając dla zasady <ClientAuthEnabled> wartość prawda.
• Określ odwołanie do magazynu zaufania za pomocą elementu <TrustStore>. Magazyn zaufania zawiera wydawcę certyfikatu klienta i łańcuch urzędów certyfikacji, co jest wymagane.

Więcej informacji o korzystaniu z TLS znajdziesz w sekcji TLS/SSL.

Modyfikowanie hosta wirtualnego

Klient Cloud z płatnym kontem i wszystkimi klientami Edge for Private Cloud może aktualizować hosta wirtualnego za pomocą interfejsu Update a Virtual Host API. Ten interfejs API umożliwia ustawienie wszystkich właściwości hosta wirtualnego opisanego w dokumentacji właściwości hosta wirtualnego.

Zaktualizuj hosta wirtualnego za pomocą interfejsu Update a Virtual Host API. Podczas korzystania z interfejsu API musisz określić w treści żądania pełną definicję hosta wirtualnego, a nie tylko elementy, które chcesz zmienić.

W tym przykładzie ustawisz wartość właściwości proxy_read_timeout:

curl -X PUT -H "Content-Type:application/xml" \
    https://api.enterprise.apigee.com/v1/o/org_name/e/env_name/virtualhosts/vhost_name \
    -d '<VirtualHost  name="myTLSVHost">
         <HostAliases>
           <HostAlias>api.myCompany.com</HostAlias>
         </HostAliases>
         <Port>443</Port>
         <SSLInfo>
           <Enabled>true</Enabled>
           <ClientAuthEnabled>false</ClientAuthEnabled>
           <KeyStore>ref://myTestKeystoreRef</KeyStore>
           <KeyAlias>myKeyAlias</KeyAlias>
         </SSLInfo>
         <Properties>
           <Property name="proxy_read_timeout">50</Property>
         </Properties>
     </VirtualHost>' \
    -u orgAdminEmail:password

Usuwanie hosta wirtualnego

Przed usunięciem hosta wirtualnego ze środowiska musisz zaktualizować wszystkie serwery proxy interfejsu API, które się do niego odwołują, aby usunąć te odniesienia. Przeczytaj artykuł o konfigurowaniu serwera proxy interfejsu API pod kątem użycia hosta wirtualnego.

Usuń hosta wirtualnego za pomocą interfejsu API Delete a Virtual Host (Usuń hosta wirtualnego):

curl -X DELETE \
  https://api.enterprise.apigee.com/v1/o/org_name/e/env_name/virtualhosts/vhost_name \
  -u orgAdminEmail:password

Wyświetlanie informacji o hoście wirtualnym

Wyświetl informacje o hostach wirtualnych zdefiniowanych w środowisku zgodnie z opisem poniżej.

Wyświetlanie hosta wirtualnego za pomocą interfejsu Edge API

Informacje o hostach wirtualnych możesz też wyświetlać za pomocą interfejsów API Edge. Na przykład interfejs API List Virtual Hosts (Wyświetl listę hostów wirtualnych) zwraca listę wszystkich hostów wirtualnych:

curl -X GET -H "accept:application/xml" \
    https://api.enterprise.apigee.com/v1/o/org_name/environments/env_name/virtualhosts \
    -u orgAdminEmail:pWord

Gdzie orgAdminEmail:pWord to nazwa użytkownika i hasło administratora organizacji, a org_name/env_name to organizacja i środowisko zawierające hosta wirtualnego. Przykładowa odpowiedź:

[
 "default",
 "secure"
]

Aby wyświetlić informacje o konkretnym hoście wirtualnym, użyj interfejsu Get Virtual Host API:

curl -X GET -H "accept:application/xml" \
    https://api.enterprise.apigee.com/v1/o/org_name/environments/env_name/virtualhosts/vhost_name \
    -u orgAdminEmail:pWord

Gdzie vhost_name to nazwa hosta wirtualnego. Możesz na przykład określić vhost_name jako „bezpieczny”, aby zobaczyć konfigurację domyślnego bezpiecznego hosta wirtualnego utworzonego przez Apigee:

<VirtualHost name="secure">
    <HostAliases>
        <HostAlias>api.myCompany.com</HostAlias>
    </HostAliases>
    <Port>443</Port>
    <Properties/>
    <Interfaces/>
    <RetryOptions/>
    <SSLInfo>
        <ClientAuthEnabled>false</ClientAuthEnabled>
        <Enabled>true</Enabled>
        <KeyAlias>freetrial</KeyAlias>
        <KeyStore>ref://freetrial</KeyStore>
        <IgnoreValidationErrors>false</IgnoreValidationErrors>
    </SSLInfo>
</VirtualHost>

Konfigurowanie serwera proxy interfejsu API do korzystania z hosta wirtualnego

Gdy tworzysz nowy serwer proxy interfejsu API, Edge automatycznie konfiguruje go w taki sposób, aby używał wszystkich dostępnych hostów wirtualnych w organizacji. Żądanie do serwera proxy interfejsu API za pośrednictwem hosta wirtualnego ma następujący format:

https://host-alias/proxy-base-path/resource-path

Gdzie:

• host-alias to zwykle nazwa DNS hosta wirtualnego.
• proxy-base-path jest definiowana podczas tworzenia serwera proxy interfejsu API i jest niepowtarzalna dla każdego serwera proxy interfejsu API.
• resource-path ścieżkę do zasobu dostępnego przez serwer proxy interfejsu API.

Kontrolowanie hostów wirtualnych używanych przez serwer proxy interfejsu API

W konfiguracji XML serwera proxy interfejsu API używasz tagu virtualhost do określenia nazwy hosta wirtualnego powiązanego z serwerem proxy interfejsu API:

<HTTPProxyConnection>
  <BasePath>/v1/my/proxy/basepath</BasePath>
  <VirtualHost>secure</VirtualHost>
  <VirtualHost>default</VirtualHost>
</HTTPProxyConnection>

Na przykład <VirtualHost>secure</VirtualHost> oznacza, że klient może wywoływać serwer proxy interfejsu API, korzystając z aliasu hosta „bezpiecznego” hosta wirtualnego.

Zwykle zmienia się hosty wirtualne powiązane z serwerem proxy interfejsu API, gdy:

• Tworzysz nowego hosta wirtualnego i masz istniejące serwery proxy interfejsu API. Aby dodać nowego hosta wirtualnego, musisz zmodyfikować istniejące serwery proxy interfejsu API.
• Tworzysz nowy serwer proxy interfejsu API, który nie powinien być dostępny przez określonego hosta wirtualnego. Musisz zmodyfikować serwer proxy interfejsu API, aby usunąć hosta wirtualnego z jego definicji.

Aby zmodyfikować hosty wirtualne powiązane z serwerem proxy interfejsu API:

1. Otwórz edytor proxy interfejsu API w sposób opisany poniżej.

   Edge

   Aby uzyskać dostęp do edytora proxy interfejsu API za pomocą interfejsu Edge:

   1. Zaloguj się na stronie apigee.com/edge.

      Klienci Edge dla Private Cloud używają środowiska http://ms-ip:9000 (lokalnego), gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania.

   2. Na pasku nawigacyjnym po lewej stronie wybierz Programowanie > Proxy interfejsów API.
   3. Wybierz na liście serwer proxy interfejsu API, który chcesz edytować.

   Klasyczna wersja Edge (Private Cloud)

   Aby uzyskać dostęp do edytora proxy interfejsu API za pomocą klasycznego interfejsu użytkownika Edge:

   1. Zaloguj się w http://ms-ip:9000, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania.
   2. Na górnym pasku nawigacyjnym wybierz Interfejsy API > Proxy interfejsów API.
   3. Wybierz na liście serwer proxy interfejsu API, który chcesz edytować.
2. Kliknij kartę Programowanie.
3. W sekcji Punkty końcowe serwera proxy wybierz default.
4. W obszarze kodu:
   1. Usuń wszystkie elementy <VirtualHost> z hostów wirtualnych nieobsługiwanych przez serwer proxy interfejsu API.
   2. Dodaj nowy element <VirtualHost> z nazwą nowego hosta wirtualnego. Jeśli na przykład nowy host wirtualny ma nazwę MyVirtualHost, dodaj ten tag:
      

      <HTTPProxyConnection>
        <BasePath>/v1/my/proxy/basepath</BasePath>
        <VirtualHost>default</VirtualHost>
        <VirtualHost>secure</VirtualHost>
        <VirtualHost>MyVirtualHost</VirtualHost>
      </HTTPProxyConnection>

5. Zapisz serwer proxy interfejsu API. Jeśli serwer proxy interfejsu API został wdrożony, zapisanie go spowoduje ponowne wdrożenie z nowym ustawieniem.

Ustawianie podstawowego adresu URL wyświetlanego w interfejsie Edge dla serwera proxy interfejsu API

Interfejs Edge wyświetla adres URL serwera proxy interfejsu API na podstawie ustawień hosta wirtualnego, w którym został wdrożony serwer proxy. Ten obraz może zawierać numer portu routera hosta wirtualnego.

W większości przypadków adres URL wyświetlany w interfejsie użytkownika Edge to prawidłowy adres URL do wysyłania żądań zewnętrznych do serwera proxy. Jednak w niektórych konfiguracjach wyświetlany URL jest nieprawidłowy. Na przykład dowolna z tych konfiguracji może spowodować, że wyświetlany URL nie będzie odpowiadać faktycznemu adresowi URL używanemu do wysyłania zewnętrznych żądań do serwera proxy:

• zakończenie SSL ma miejsce w systemie równoważenia obciążenia,
• Mapowanie portów zachodzi między systemem równoważenia obciążenia a routerami Apigee
• System równoważenia obciążenia ze skonfigurowanym przepisywaniem ścieżek

Edge obsługuje atrybut na hoście wirtualnym o nazwie <BaseUrl>, który umożliwia zastąpienie adresu URL wyświetlanego w interfejsie Edge. Oto przykład, który przedstawia obiekt hosta wirtualnego z atrybutem <BaseUrl>. W tym przykładzie wartość „http://myCo.com” pojawi się w interfejsie użytkownika Edge:

<VirtualHost name="myTLSVHost">
  <HostAliases>
    <HostAlias>api.myCompany.com</HostAlias>
  </HostAliases>
  <BaseUrl>http://myCo.com</BaseUrl>
  <Port>443</Port>
  <SSLInfo>
    <Enabled>true</Enabled>
    <ClientAuthEnabled>false</ClientAuthEnabled>
    <KeyStore>ref://myTestKeystoreRef</KeyStore>
    <KeyAlias>myKeyAlias</KeyAlias>
  </SSLInfo>
</VirtualHost>

Pamiętaj, że wartość <BaseUrl> musi zawierać protokół (np. „http://” lub „https://”).

Jeśli <BaseUrl> nie jest ustawiony, domyślny URL renderowany w interfejsie Edge będzie wyświetlany jako „api.myCompany.com”, a rzeczywisty alias hosta to „http://myCo.com”.