Einrichten von Tags für eine API-Stufe in API Gateway - Amazon API Gateway

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Einrichten von Tags für eine API-Stufe in API Gateway

In API Gateway können Sie einer API-Stufe ein Tag hinzufügen, das Tag aus der Stufe entfernen oder das Tag anzeigen. Dazu können Sie die API-Gateway-Konsole, das AWS CLI/SDK oder die API-Gateway-REST-API verwenden.

Eine Stufe kann auch Tags von der übergeordneten REST-API erben. Weitere Informationen finden Sie unter Tag-Vererbung in der Amazon API Gateway V1-API.

Weitere Informationen über das Markieren mit Tags von API Gateway-Ressourcen finden Sie unter API Gateway-Ressourcen taggen.

Einrichten von Tags für eine API-Stufe mit der API-Gateway-Konsole

Die folgende Vorgehensweise beschreibt, wie Sie Tags für eine API-Stufe einrichten.

So richten Sie Tags für eine API-Stufe mithilfe der API Gateway-Konsole ein
  1. Melden Sie sich bei der API Gateway-Konsole an.

  2. Wählen Sie eine vorhandene API aus oder erstellen Sie eine neue API, die Ressourcen, Methoden und die entsprechenden Integrationen enthält.

  3. Wählen Sie eine Stufe aus oder stellen Sie die API in einer neuen Stufe bereit.

  4. Klicken Sie im Hauptnavigationsbereich auf Stages (Stufen).

  5. Wählen Sie die Registerkarte Tags aus. Möglicherweise müssen Sie die rechte Pfeiltaste wählen, um die Registerkarte anzuzeigen.

  6. Wählen Sie Tags verwalten aus.

  7. Klicken Sie im Tag Editor (Tag-Editor) auf Add Tag (Tag hinzufügen). Geben Sie einen Tag-Schlüssel (z. B. Department) in das Feld Schlüssel und einen Tag-Wert (z. B. Sales) in das Feld Wert ein. Wählen Sie Save (Speichern) aus, um das Tag zu speichern.

  8. Wiederholen Sie bei Bedarf Schritt 5, um der API-Stufe weitere Tags hinzuzufügen. Die maximale Anzahl der Tags pro Stufe beträgt 50.

  9. Um ein vorhandenes Tag aus der Stufe zu entfernen, wählen Sie Remove (Entfernen) aus.

  10. Wenn die API zuvor in der API Gateway-Konsole bereitgestellt wurde, müssen Sie sie erneut implementieren, damit die Änderungen wirksam werden.

Einrichten von Tags für eine API-Stufe mithilfe der AWS CLI

Sie können Tags für eine API-Stufe mit AWS CLI dem Befehl create-stage oder dem Befehl tag-resource einrichten. Sie können ein oder mehrere Tags aus einer API-Stufe mit dem Befehl untag-resource löschen.

Im folgenden Beispiel wird beim Erstellen einer test Stufe ein Tag hinzugefügt:

aws apigateway create-stage --rest-api-id abc1234 --stage-name test --description 'Testing stage' --deployment-id efg456 --tag Department=Sales

Im folgenden Beispiel wird einer prod Stufe ein Tag hinzugefügt:

aws apigateway tag-resource --resource-arn arn:aws:apigateway:us-east-2::/restapis/abc123/stages/prod --tags Department=Sales

Im folgenden Beispiel wird das Department=Sales Tag aus der test Stufe entfernt:

aws apigateway untag-resource --resource-arn arn:aws:apigateway:us-east-2::/restapis/abc123/stages/test --tag-keys Department

Einrichten von Tags für eine API-Stufe mit der API-Gateway-REST-API

Sie können Tags für eine API-Stufe mit Hilfe der API Gateway-REST-API einrichten, indem Sie eine der folgenden Aktionen ausführen:

  • Rufen Sie tags:tag auf, um eine API-Stufe mit einem Tag zu versehen.

  • Rufen Sie tags:untag auf, um einen oder mehrere Tags aus einer API-Stufe zu löschen.

  • Rufen Sie stage:create auf, um einen oder mehrere Tags zu einer API-Stufe, die Sie erstellen, hinzuzufügen.

Sie können außerdem tags:get aufrufen, um Tags in einer API-Stufe zu beschreiben.

Tag zu einer API-Stufe hinzufügen

Nach Bereitstellung einer API (m5zr3vnks7) für eine Stufe (test) versehen Sie die Stufe durch Aufruf von tags:tag mit einem Tag. Die erforderliche Amazon-Ressourcenname (ARN) (arn:aws:apigateway:us-east-1::/restapis/m5zr3vnks7/stages/test) der Stufe muss URL-codiert sein (arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftest).

PUT /tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftest { "tags" : { "Department" : "Sales" } }

Sie können auch die vorherige Anforderung verwenden, um einen bestehenden Tag auf einen neuen Wert zu aktualisieren.

Sie können Tags zu einer Stufe hinzufügen, wenn Sie stage:create aufrufen, um die Stufe zu erstellen:

POST /restapis/<restapi_id>/stages { "stageName" : "test", "deploymentId" : "adr134", "description" : "test deployment", "cacheClusterEnabled" : "true", "cacheClusterSize" : "500", "variables" : { "sv1" : "val1" }, "documentationVersion" : "test", "tags" : { "Department" : "Sales", "Division" : "Retail" } }

Tag von einer API-Stufe entfernen

Rufen Sie Department auf, um den tags:untag-Tag von der Stufe zu entfernen:

DELETE /tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftest?tagKeys=Department Host: apigateway.us-east-1.amazonaws.com Authorization: ...

Um mehrere Tags zu entfernen, verwenden Sie eine kommagetrennte Liste mit Tag-Schlüsseln im Abfrageausdruck (zum Beispiel ?tagKeys=Department,Division,…).

Beschreiben von Tags für eine API-Stufe

Um existierende Tags einer bestehenden Stufe zu beschreiben, rufen Sie auf tags:get:

GET /tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftags Host: apigateway.us-east-1.amazonaws.com Authorization: ...

Eine erfolgreiche Antwort ähnelt dem folgenden Beispiel:

200 OK { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-tags-{rel}.html", "name": "tags", "templated": true }, "tags:tag": { "href": "/tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftags" }, "tags:untag": { "href": "/tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftags{?tagKeys}", "templated": true } }, "tags": { "Department": "Sales" } }