Configurazione dei tag per una fase API in Gateway API

In API Gateway è possibile aggiungere un tag a una fase API, rimuoverlo o visualizzarlo. A tale scopo, puoi utilizzare la console API Gateway, AWS CLI/SDK o l'API REST di API Gateway.

Una fase può anche ereditare i tag dalla sua API REST padre. Per ulteriori informazioni, consulta Eredità dei tag nell'API di Amazon API Gateway V1.

Per ulteriori informazioni sull'assegnazione di tag alle risorse dell'API Gateway, consulta Tagging delle risorse API Gateway.

Configurare i tag per una fase API utilizzando la console si API Gateway

La procedura seguente descrive come configurare i tag per una fase API.

Per configurare i tag per una fase API mediante la console API Gateway

1. Accedere alla console API Gateway.

2. Seleziona un'API esistente o crea una nuova API che includa risorse, metodi e le integrazioni corrispondenti.

3. Seleziona una fase o distribuisci l'API in una nuova fase.

4. Nel riquadro di navigazione principale scegli Fasi.

5. Seleziona la scheda Tags (Tag). Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.

6. Scegliere Gestisci tag.

7. In Editor di tag scegli Aggiungi nuovo tag. Immetti una chiave di tag (ad esempio, Department) nella colonna Key (Chiave), quindi immetti un valore di tag (ad esempio, Sales) nella colonna Value (Valore). Per salvare il tag scegli Salva.

8. Se necessario, ripeti la fase 5 per aggiungere altri tag alla fase API. Il numero massimo di tag per ogni fase è 50.

9. Per rimuovere un tag esistente dalla fase scegli Rimuovi.

10. Se l'API è stata implementata in precedenza nella console API Gateway, sarà necessario ridistribuirla per rendere effettive le modifiche.

Configura i tag per una fase dell'API utilizzando il AWS CLI

È possibile impostare i tag per uno stadio API AWS CLI utilizzando il comando create-stage o il comando tag-resource. È possibile eliminare uno o più tag da una fase API eseguendo il comando untag-resource.

Il seguente comando create-stage aggiunge un tag durante la creazione di uno stage: test

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

Il seguente comando tag-resource aggiunge un tag a uno stage: prod

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

Il seguente comando untag-resource rimuove il tag dallo Department=Sales stage: test

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

Impostare i tag per una fase API utilizzando l'API REST di API Gateway

È possibile configurare i tag per una fase API utilizzando l'API REST di API Gateway con una delle operazioni seguenti:

• Richiamare tags:tag per aggiungere tag a una fase API.

• Richiamare tags:untag per eliminare uno o più tag da una fase API.

• Richiamare stage:create per aggiungere uno o più tag a una fase API in fase di creazione.

È anche possibile richiamare tags:get per descrivere i tag in una fase API.

Aggiunta di tag a una fase API

Dopo avere distribuito un'API (m5zr3vnks7) in una fase (test), è possibile aggiungere tag alla fase richiamando tags:tag. L'Amazon Resource Name (ARN) richiesto della fase (arn:aws:apigateway:us-east-1::/restapis/m5zr3vnks7/stages/test) deve avere codifica URL (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"
  }
}

Puoi anche usare la richiesta precedente per aggiornare un tag esistente in un nuovo valore.

È possibile aggiungere tag a una fase richiamando stage:create per la relativa creazione:

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

Rimozione di tag da una fase API

Per rimuovere il tag Department dalla fase, richiamare tags:untag:

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

Per rimuovere più di un tag, usare un elenco di chiavi di tag separate da virgole nell'espressione di query, ad esempio ?tagKeys=Department,Division,….

Descrizione dei tag per una fase API

Per descrivere i tag esistenti per una fase specifica, richiamare tags:get:

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

La risposta con esito positivo è simile a quella riportata di seguito.

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