Tags für eine API-Stufe in API Gateway einrichten

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.

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.

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 Gateway-Konsole, das AWS CLI/SDK oder die API Gateway 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.

Richten Sie Tags für eine API-Phase ein, indem Sie AWS CLI

Sie können Tags für eine API-Stufe einrichten, indem Sie den AWS CLI Befehl create-stage oder den Befehl tag-resource verwenden. Sie können einen oder mehrere Tags aus einer API-Stufe mithilfe des Befehls untag-resource löschen.

Mit dem folgenden Befehl create-stage wird beim Erstellen einer Phase ein Tag hinzugefügt: test

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

Der folgende Befehl tag-resource fügt einer Phase ein Tag hinzu: prod

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

Mit dem folgenden Befehl untag-resource wird das Tag aus der Department=Sales Phase entfernt: test

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:

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"
    }
}