Menyiapkan tag untuk tahap API di API Gateway

Di API Gateway, Anda dapat menambahkan tag ke tahap API, menghapus tag dari tahap, atau melihat tag. Untuk melakukannya, Anda dapat menggunakan konsol API Gateway, AWS CLI/SDK, atau API Gateway REST API.

Sebuah panggung juga dapat mewarisi tag dari REST API induknya. Untuk informasi selengkapnya, lihat Warisan tag di Amazon API Gateway V1.

Untuk informasi selengkapnya tentang menandai resource API Gateway, lihatMenandai sumber daya API Gateway Anda.

Menyiapkan tag untuk tahap API menggunakan konsol API Gateway

Prosedur berikut menjelaskan cara menyiapkan tag untuk tahap API.

Untuk menyiapkan tag untuk tahap API dengan menggunakan konsol API Gateway

1. Masuk ke konsol API Gateway.

2. Pilih API yang sudah ada, atau buat API baru yang menyertakan sumber daya, metode, dan integrasi terkait.

3. Pilih tahapan atau terapkan API ke tahap baru.

4. Di panel navigasi utama, pilih Tahapan.

5. Pilih tab Tanda. Anda mungkin perlu memilih tombol panah kanan untuk menampilkan tab.

6. Pilih Kelola tanda.

7. Di Editor Tag, pilih Tambahkan tag. Masukkan kunci tag (misalnya,Department) di bidang Kunci, dan masukkan nilai tag (misalnya,Sales) di bidang Nilai. Pilih Simpan untuk menyimpan tag.

8. Jika perlu, ulangi langkah 5 untuk menambahkan lebih banyak tag ke tahap API. Jumlah maksimum tag per tahap adalah 50.

9. Untuk menghapus tag yang ada dari panggung, pilih Hapus.

10. Jika API telah digunakan sebelumnya di konsol API Gateway, Anda perlu menerapkannya kembali agar perubahan diterapkan.

Menyiapkan tag untuk tahap API menggunakan AWS CLI

Anda dapat mengatur tag untuk tahap API menggunakan perintah menggunakan perintah create-stage atau perintah tag-resource. AWS CLI Anda dapat menghapus satu atau beberapa tag dari tahap API menggunakan perintah untag-resource.

Contoh berikut menambahkan tag saat membuat test panggung:

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

Contoh berikut menambahkan tag ke prod panggung:

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

Contoh berikut menghapus Department=Sales tag dari test panggung:

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

Menyiapkan tag untuk tahap API menggunakan API Gateway REST API

Anda dapat menyiapkan tag untuk tahap API menggunakan API Gateway REST API dengan melakukan salah satu hal berikut:

• Panggilan tags:taguntuk menandai tahap API.

• Panggilan tags:untaguntuk menghapus satu atau beberapa tag dari tahap API.

• Panggil stage:createuntuk menambahkan satu atau beberapa tag ke tahap API yang Anda buat.

Anda juga dapat menelepon tags:getuntuk mendeskripsikan tag dalam tahap API.

Menandai tahap API

Setelah Anda menerapkan API (m5zr3vnks7) ke stage (test), beri tag stage dengan memanggil tags:tag. Tahap yang diperlukan Nama Sumber Daya Amazon (ARN) (arn:aws:apigateway:us-east-1::/restapis/m5zr3vnks7/stages/test) harus dikodekan 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"
  }
}

Anda juga dapat menggunakan permintaan sebelumnya untuk memperbarui tag yang ada ke nilai baru.

Anda dapat menambahkan tag ke panggung saat memanggil stage:createuntuk membuat panggung:

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

Membatalkan tag tahap API

Untuk menghapus Department tag dari panggung, hubungi 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: ...

Untuk menghapus lebih dari satu tag, gunakan daftar kunci tag yang dipisahkan koma dalam ekspresi kueri—misalnya,. ?tagKeys=Department,Division,…

Jelaskan tag untuk tahap API

Untuk mendeskripsikan tag yang ada pada tahap tertentu, panggil tags:get:

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

Respons yang berhasil mirip dengan yang berikut:

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