Wyświetlasz dokumentację Apigee Edge.
Przejdź do
dokumentacji Apigee X. info
Wersja: 1.5.1
Publikowanie wiadomości w temacie w usłudze Google Cloud Pub/Sub.
Te treści zawierają informacje o konfigurowaniu i używaniu tego rozszerzenia.
Wymagania wstępne
Zanim zaczniesz korzystać z rozszerzenia w proxy interfejsu API za pomocą zasady ExtensionCallout, musisz:
Utworzyć temat Cloud Pub/Sub zgodnie z opisem w artykule Krótkie wprowadzenie: korzystanie z konsoli.
Gdy masz już temat, przyznaj uprawnienia do publikowania w temacie Cloud Pub/Sub. Do publikowania w tematach możesz na przykład użyć roli
roles/pubsub.publisher. Więcej informacji o rolach Cloud Pub/Sub znajdziesz w artykule Kontrola dostępu.Podczas dodawania i konfigurowania rozszerzenia za pomocą odwołania do konfiguracji użyć zawartości wynikowego pliku JSON z kluczem.
Informacje o Cloud Pub/Sub
Cloud Pub/Sub zapewnia asynchroniczne przesyłanie wiadomości typu wiele do wielu, które oddziela nadawców i odbiorców. Cloud Pub/Sub zapewnia trwałe przesyłanie wiadomości z małym opóźnieniem, co pomaga deweloperom szybko integrować systemy hostowane w Google Cloud Platform i poza nią.
Jeśli dopiero zaczynasz korzystać z Cloud Pub/Sub, zapoznaj się z krótkimi wprowadzeniami w dokumentacji Cloud Pub/Sub.
Przykłady
Poniższe przykłady pokazują, jak skonfigurować obsługę działań rozszerzenia Cloud Pub/Sub za pomocą zasady ExtensionCallout.
SMS
W tym przykładzie działanie publish publikuje wiadomość jako prosty ciąg znaków w temacie określonym w konfiguracji rozszerzenia configuration. Działanie publish zwraca identyfikator opublikowanej wiadomości w temacie, w którym została opublikowana, i zapisuje go w zmiennej określonej przez tag <Output>:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Publish-Message">
<DisplayName>Publish Message</DisplayName>
<Connector>cloud-pub-sub-extension-example</Connector>
<Action>publish</Action>
<Input><![CDATA[
{
"message" : "My test message."
}
]]></Input>
<Output>topic.message</Output>
</ConnectorCallout>
Poniższa zasada Assign Message używa wartości zmiennej przechowującej odpowiedź rozszerzenia do przypisania ładunku odpowiedzi. Identyfikator wiadomości jest przechowywany we właściwości messageId zmiennej wyjściowej:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Topic-Message-ID">
<DisplayName>Get Topic Message ID</DisplayName>
<AssignTo type="response" createNew="false"/>
<Set>
<Payload contentType="application/json">{topic.message.messageId}</Payload>
</Set>
</AssignMessage>
Dane odpowiedzi są zwracane w formacie JSON:
{"messageId":"165918654986954"}
W związku z tym wartość topic.message.messageId to 165918654986954.
Wiadomość JSON
W tym przykładzie działanie publish publikuje wiadomość jako JSON w temacie określonym w konfiguracji rozszerzenia. Działanie publish zwraca identyfikator opublikowanej wiadomości w temacie, w którym została opublikowana, i zapisuje go w zmiennej określonej przez tag <Output>:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Publish-Message">
<DisplayName>Publish Message</DisplayName>
<Connector>cloud-pub-sub-extension-example</Connector>
<Action>publish</Action>
<Input><![CDATA[
{
"message" : { "info" : "My test message" }
}
]]></Input>
<Output>topic.message</Output>
</ConnectorCallout>
Poniższa zasada Assign Message używa wartości zmiennej przechowującej odpowiedź rozszerzenia do przypisania ładunku odpowiedzi. Identyfikator wiadomości jest przechowywany we właściwości messageId zmiennej wyjściowej:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Get-Topic-Message-ID">
<DisplayName>Get Topic Message ID</DisplayName>
<AssignTo type="response" createNew="false"/>
<Set>
<Payload contentType="application/json">{topic.message.messageId}</Payload>
</Set>
</AssignMessage>
Dane odpowiedzi są zwracane w formacie JSON:
{"messageId":"165918654986954"}
W związku z tym wartość topic.message.messageId to 165918654986954.
Działania
publikowanie
Publikuje wiadomość w temacie określonym w konfiguracji tego rozszerzenia.
Składnia
<Action>publish</Action>
<Input><![CDATA[{
"message" : "message-to-publish" | JSON-structured-data,
"customAttributes": JSON-array
}]]></Input>
Przykład ciągu znaków
<Action>publish</Action>
<Input><![CDATA[
{
"message" : "My test message."
}
]]></Input>
Przykład uporządkowanych danych JSON
<Action>publish</Action>
<Input><![CDATA[
{
"message" : { "info" : "My test message" }
}
]]></Input>
Przykład atrybutów niestandardowych
<Action>publish</Action>
<Input><![CDATA[
{
"message" : { "info" : "My test message" },
"customAttributes": {"attr1": "foo", "attr2": "bar"}
}
]]></Input>
Parametry żądania
| Parametr | Opis | Typ | Domyślny | Wymagane |
|---|---|---|---|---|
| wiadomość | Wiadomość do opublikowania. Możesz użyć prostego ciągu znaków lub utworzyć wiadomość w formacie JSON. | Ciąg znaków lub JSON | Brak | Tak |
| customAttributes | Atrybuty niestandardowe, które mają zostać dodane do wiadomości w postaci: "customAttributes": {"attr1": "foo", "attr2": "bar"}. |
Tablica JSON | Brak | Nie |
Odpowiedź
JSON zawierający identyfikator wiadomości opublikowanej w temacie. Na przykład:
{"messageId":"165918654986954"}
Odwołanie do konfiguracji
Podczas konfigurowania i wdrażania tego rozszerzenia do użytku w proxy interfejsu API użyj tych informacji.
Wspólne właściwości rozszerzenia
Dla każdego rozszerzenia dostępne są poniższe właściwości.
| Usługa | Opis | Domyślnie | Wymagany |
|---|---|---|---|
name |
Nazwa nadana konfiguracji rozszerzenia. | Brak | Tak |
packageName |
Nazwa pakietu rozszerzeń podana przez Apigee Edge. | Brak | Tak |
version |
Numer wersji pakietu rozszerzenia, z którego konfigurujesz rozszerzenie. | Brak | Tak |
configuration |
Wartość konfiguracji specyficzna dla dodawanego rozszerzenia. Zobacz Właściwości tego pakietu rozszerzeń | Brak | Tak |