为 API Gateway 中的 API 阶段设置标签

在 API Gateway 中，您可以将标签添加到 API 阶段、从阶段中删除标签或者查看标签。为此，您可以使用 API Gateway 控制台、AWS CLI/开发工具包或 API Gateway REST API。

阶段还可以从其父 REST API 继承标签。有关更多信息，请参阅 Amazon API Gateway V1 API 中的标签继承。

有关标记 API Gateway 资源的更多信息，请参阅 为 API Gateway 资源添加标签。

使用 API Gateway 控制台为 API 阶段设置标签

以下过程将介绍如何为 API 阶段设置标签。

使用 AWS CLI 为 API 阶段设置标签

您可以使用 AWS CLI，通过 create-stage 命令或 tag-resource 命令为 API 阶段设置标签。您可以使用 untag-resource 命令从 API 阶段中删除一个或多个标签。

使用以下 create-stage 命令在创建 test 阶段时添加一个标签：

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

使用以下 tag-resource 命令将标签添加到 prod 阶段中：

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

使用以下 untag-resource 命令从 test 阶段中删除 Department=Sales 标签：

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

使用 API Gateway REST API 为 API 阶段设置标签

您可以执行以下操作之一，使用 API Gateway REST API 为 API 阶段设置标签：

您还可以调用 tags:get 以描述 API 阶段中的标签。

为 API 阶段添加标签

将 API (m5zr3vnks7) 部署到阶段 (test) 之后，通过调用 tags:tag 为阶段添加标签。所需的阶段 Amazon Resource Name (ARN) (arn:aws:apigateway:us-east-1::/restapis/m5zr3vnks7/stages/test) 必须为 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"
  }
}

您还可以使用之前的请求，将现有标签更新为新值。

在调用 stage:create 创建阶段时，您可以将标签添加到阶段。

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

取消 API 阶段的标签

要从阶段中删除 Department 标签，请调用 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: ...

要删除多个标签，请在查询表达式中使用逗号分隔的标签键列表，例如 ?tagKeys=Department,Division,…。

描述 API 阶段的标签

要描述指定阶段上的现有标签，请调用 tags:get：

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

成功响应的形式与下方类似：

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