標記 Amazon OpenSearch 服務域 - Amazon OpenSearch 服務

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

標記 Amazon OpenSearch 服務域

標籤可讓您將任意資訊指派給 Amazon OpenSearch 服務網域,以便對該資訊進行分類和篩選。標籤是您定義並與 OpenSearch 服務網域產生關聯的索引鍵值配對。您可以使用這些標籤來追蹤成本,方法是將相似標記資源的費用分組。 AWS 不對您的標籤應用任何語義含義。標籤會嚴格解譯為字元字串。所有標籤均包含以下元素:

標籤元素 描述 必要
標籤鍵

標籤金鑰是標籤名稱。金鑰必須是它們所附加的 OpenSearch 服務網域唯一的。如需標籤鍵和標籤值各項基本限制的清單,請參閱使用者定義的標籤限制

標籤值

標籤值即為標籤的字串值。標籤值可以是 null,並且在標籤集內不必具有唯一性。例如,在 project/Trinity 及 cost-center/Trinity 標籤集中,均能擁有一個索引鍵/值組。如需標籤鍵和標籤值各項基本限制的清單,請參閱使用者定義的標籤限制

每個 OpenSearch 服務網域都有一個標籤組,其中包含指派給該 OpenSearch 服務網域的所有標籤。 AWS 不會自動將任何標籤指派給 OpenSearch 服務網域。標籤集可以包含 0 到 50 個標籤。如果您對網域新增標籤,而該標籤與現有標籤具有相同的鍵,則新值會覆寫舊值。

標記範例

您可以使用鍵來定義類別,其值可為該類別中的某個項目。例如,您可以定義的標籤索引鍵project和標籤值Salix,表示 OpenSearch 服務網域已指派給 Salix 專案。您也可以使用標籤,透過使用或之類的金鑰,將 OpenSearch Service 網域指定為用於測試environment=test或生產環境environment=production。嘗試使用一組一致的標籤金鑰,以便更輕鬆地追蹤與 OpenSearch 服務網域相關聯的中繼資料。

您也可以使用標籤來組織帳 AWS 單,以反映您自己的成本結構。為此,請註冊以獲取包含標籤鍵值的 AWS 帳戶 帳單。接著,根據具有相同標籤鍵值的資源來整理您的帳單資訊,以便查看合併資源的成本。例如,您可以使用索引鍵值配對標記多個 OpenSearch Service 網域,然後整理帳單資訊,以查看多個服務中每個網域的總費用。如需詳細資訊,請參閱 https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html 帳單與成本管理文件中的AWS 使用成本分配標記

注意

標籤是快取用於授權之用。因此, OpenSearch 服務網域上的標籤新增和更新可能需要幾分鐘的時間才能使用。

處理標籤 (主控台)

主控台是標記網域的最簡單方法。

建立標籤 (主控台)
  1. 前往 https://aws.amazon.com,然後選擇 Sign In to the Console (登入主控台)

  2. 分析下,選擇 Amazon OpenSearch 服務

  3. 選取您要新增標籤的目標網域,然後前往 Tags (標籤) 索引標籤。

  4. 選擇 Manage (管理) 和 Add new tag (新增標籤)。

  5. 輸入標籤索引鍵和選用的值。

  6. 選擇 儲存

若要刪除標籤,請按照同樣的步驟進行,然後在 Manage tags (管理標籤) 頁面上選擇 Remove (移除)。

如需使用主控台處理標籤的詳細資訊,請參閱 《AWS 管理主控台入門指南》中的標籤編輯器

處理標籤 (AWS CLI)

您可以使用 AWS CLI 與--add-tags指令建立資源標籤。

語法

add-tags --arn=<domain_arn> --tag-list Key=<key>,Value=<value>

參數 描述
--arn 附加標籤之 OpenSearch 服務網域的 Amazon 資源名稱。
--tag-list 以空格分隔且格式如下的一系列鍵值組:Key=<key>,Value=<value>

範例

以下範例為 logs 網域建立兩個標籤:

aws opensearch add-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs --tag-list Key=service,Value=OpenSearch Key=instances,Value=m3.2xlarge

您可以使用--remove-tags命令從 OpenSearch 服務網域移除標記。

語法

remove-tags --arn=<domain_arn> --tag-keys Key=<key>,Value=<value>

參數 描述
--arn 附加標籤的 OpenSearch 服務網域的 Amazon 資源名稱 (ARN)。
--tag-keys 一組要從 OpenSearch 服務域中刪除的空格分隔的鍵-值對。

範例

以下範例會將上述範例所建立的兩個標籤從 logs 網域移除:

aws opensearch remove-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs --tag-keys service instances

您可以使用以下--list-tags命令檢視 OpenSearch 服務網域的現有標記:

語法

list-tags --arn=<domain_arn>

參數 描述
--arn 標籤所附加之 OpenSearch 服務網域的 Amazon 資源名稱 (ARN)。

範例

以下範例會列出 logs 網域的所有資源標籤:

aws opensearch list-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs

使用標籤 (AWS SDK)

開 AWS 發套件 (Android 和 iOS 開發套件除外) 支援 Amazon OpenSearch 服務 API 參考中定義的所有動作,包括AddTagsListTags、和RemoveTags操作。如需有關安裝和使用 AWS SDK 的詳細資訊,請參閱AWS 軟體開發套件。

Python

此範例使用適用於 Python (Bodo) 的 AWS 開發套件中的OpenSearchService低階 Python 用戶端,將標籤新增至網域、列出附加至網域的標籤,以及從網域移除標籤。您必須提供 DOMAIN_ARNTAG_KEYTAG_VALUE 的值。

import boto3 from botocore.config import Config # import configuration DOMAIN_ARN = '' # ARN for the domain. i.e "arn:aws:es:us-east-1:123456789012:domain/my-domain TAG_KEY = '' # The name of the tag key. i.e 'Smileyface' TAG_VALUE = '' # The value assigned to the tag. i.e 'Practicetag' # defines the configurations parameters such as region my_config = Config(region_name='us-east-1') client = boto3.client('opensearch', config=my_config) # defines the client variable def addTags(): """Adds tags to the domain""" response = client.add_tags(ARN=DOMAIN_ARN, TagList=[{'Key': TAG_KEY, 'Value': TAG_VALUE}]) print(response) def listTags(): """List tags that have been added to the domain""" response = client.list_tags(ARN=DOMAIN_ARN) print(response) def removeTags(): """Remove tags that have been added to the domain""" response = client.remove_tags(ARN=DOMAIN_ARN, TagKeys=[TAG_KEY]) print('Tag removed') return response