Configuración de etiquetas para una etapa de API en API Gateway

API Gateway le permite agregar una etiqueta a una etapa de API, quitarla de la etapa o consultarla. Para ello, puede utilizar la consola de API Gateway, la AWS CLI o un SDK o la API REST de API Gateway.

Una etapa también puede heredar etiquetas de su API REST principal. Para obtener más información, consulte Herencia de etiquetas en la API V1 de Amazon API Gateway.

Para obtener más información acerca de las etiquetas para recursos de API Gateway, consulte Etiquetado de recursos de API Gateway.

Configuración de etiquetas para una etapa de API con la consola de API Gateway

En el procedimiento siguiente, se describe cómo configurar etiquetas en una etapa de API.

Configuración de etiquetas para una etapa de API a través de la AWS CLI

Puede configurar etiquetas para una etapa de API con AWS CLI mediante el comando create-stage o el comando tag-resource. Puede eliminar una o varias etiquetas de una etapa de API con el comando untag-resource.

El siguiente comando create-stage permite agregar una etiqueta al crear una etapa test:

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

El siguiente tag-resource permite agregar una etiqueta a una etapa prod:

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

El siguiente comando untag-resource permite eliminar la etiqueta Department=Sales de la etapa test:

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

Configuración de etiquetas para una etapa de API con la API de REST de API Gateway

Puede configurar etiquetas para una etapa de API mediante la API de REST de API Gateway con uno de los siguientes procedimientos:

También puede llamar a tags:get para describir las etiquetas en una etapa de API.

Etiquetado de una etapa de API

Una vez que haya implementado una API (m5zr3vnks7) en una etapa (test), etiquete la etapa llamando a tags:tag. El nombre de recurso de Amazon (ARN) de la etapa correspondiente (arn:aws:apigateway:us-east-1::/restapis/m5zr3vnks7/stages/test) debe estar codificado como 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"
  }
}

También puede utilizar la solicitud anterior para actualizar una etiqueta a un nuevo valor.

Puede agregar etiquetas a una etapa cuando llame a stage:create para crear la etapa:

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

Eliminación del etiquetado de una etapa de API

Para eliminar la etiqueta Department de la etapa, llame a 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: ...

Para eliminar varias etiquetas, utilice una lista separada por comas de claves de etiqueta en la expresión de consulta; por ejemplo, ?tagKeys=Department,Division,….

Descripción de las etiquetas de una etapa de API

Para describir las etiquetas existentes en una determinada etapa, llame a 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 respuesta correcta será similar a la que se muestra a continuación:

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