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

# 使用 API 操作管理金鑰標籤
<a name="manage-tags-api"></a>

您可以使用[AWS 付款密碼編譯 API](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/Welcome.html) 來新增、刪除和列出您管理之金鑰的標籤。以下範例使用 [AWS Command Line Interface (AWS CLI)](https://aws.amazon.com/cli/)，但您可以使用任何支援的程式設計語言。您無法標記 AWS 受管金鑰。

若要新增、編輯、檢視和刪除金鑰的標籤，您必須擁有必要的許可。如需詳細資訊，請參閱[控制對標籤的存取](tag-permissions.md)。

**Topics**
+ [CreateKey：將標籤新增至新金鑰](#tagging-keys-create-key)
+ [TagResource：新增或變更金鑰的標籤](#tagging-keys-tag-resource)
+ [ListResourceTags：取得金鑰的標籤](#tagging-keys-list-resource-tags)
+ [UntagResource：從金鑰刪除標籤](#tagging-keys-untag-resource)

## CreateKey：將標籤新增至新金鑰
<a name="tagging-keys-create-key"></a>

您可以在建立金鑰時新增標籤。若要指定標籤，請使用 [CreateKey](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html) 操作的 `Tags` 參數。

若要在建立金鑰時新增標籤，發起人必須在 IAM 政策中具有`payment-cryptography:TagResource`許可。許可至少必須涵蓋帳戶和區域中的所有金鑰。如需詳細資訊，請參閱[控制對標籤的存取](tag-permissions.md)。

`CreateKey` 的 `Tags` 參數值是區分大小寫的標籤鍵和標籤值對的集合。金鑰上的每個標籤都必須有不同的標籤名稱。標籤值可以為 null 或空字串。

例如，下列 AWS CLI 命令會建立具有 `Project:Alpha` 標籤的對稱加密金鑰。指定多個索引鍵/值組時，請使用空格來分隔每一組。

```
$ aws payment-cryptography create-key --exportable --key-attributes KeyAlgorithm=TDES_2KEY, \
        KeyUsage=TR31_C0_CARD_VERIFICATION_KEY,KeyClass=SYMMETRIC_KEY, \
        KeyModesOfUse='{Generate=true,Verify=true}' \
        --tags '[{"Key":"Project","Value":"Alpha"},{"Key":"BIN","Value":"123456"}]'
```

當此命令成功時，它會傳回包含新金鑰相關資訊的`Key`物件。但是，`Key` 不包含標籤。若要取得標籤，請使用 [ListResourceTags](#tagging-keys-list-resource-tags) 操作。

## TagResource：新增或變更金鑰的標籤
<a name="tagging-keys-tag-resource"></a>

[TagResource](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_TagResource.html) 操作會將一或多個標籤新增至金鑰。您無法使用此操作新增或編輯不同 AWS 帳戶中的標籤。

若要新增標籤，請指定新標籤索引鍵和標籤值。若要編輯標籤，請指定現有標籤索引鍵和新標籤值。金鑰上的每個標籤都必須有不同的標籤金鑰。標籤值可以為 null 或空字串。

例如，下列命令會將 **UseCase**和 **BIN** 標籤新增至範例金鑰。

```
$ aws payment-cryptography tag-resource --resource-arn arn:aws:payment-cryptography:us-east-2:111122223333:key/kwapwa6qaifllw2h --tags '[{"Key":"UseCase","Value":"Acquiring"},{"Key":"BIN","Value":"123456"}]' 
```

當此命令成功時，不會傳回任何輸出。若要檢視金鑰上的標籤，請使用 [ListResourceTags](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html) 操作。

您也可以使用 **TagResource** 來變更現有標籤的標籤值。若要取代標籤值，請使用不同的值來指定相同的標籤索引鍵。未列在修改命令中的標籤不會變更或移除。

例如，這個命令會將 `Project` 標籤的值從 `Alpha` 變更為 `Noe`。

命令將傳回不含內容的 http/200。若要查看您的變更，請使用 `ListTagsForResource`

```
$ aws payment-cryptography tag-resource --resource-arn arn:aws:payment-cryptography:us-east-2:111122223333:key/kwapwa6qaifllw2h \ 
        --tags '[{"Key":"Project","Value":"Noe"}]'
```

## ListResourceTags：取得金鑰的標籤
<a name="tagging-keys-list-resource-tags"></a>

[ListResourceTags](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html) 操作會取得金鑰的標籤。`ResourceArn` (keyArn 或 keyAlias) 參數是必要的。您無法使用此操作來檢視不同 中金鑰上的標籤 AWS 帳戶。

例如，下列命令會取得範例金鑰的標籤。

```
$ aws payment-cryptography list-tags-for-resource --resource-arn arn:aws:payment-cryptography:us-east-2:111122223333:key/kwapwa6qaifllw2h
       
  {
    "Tags": [
        {
            "Key": "BIN",
            "Value": "20151120"
        },
        {
            "Key": "Project",
            "Value": "Production"
        }
    ]
}
```

## UntagResource：從金鑰刪除標籤
<a name="tagging-keys-untag-resource"></a>

[UntagResource](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UntagResource.html) 操作會從金鑰刪除標籤。若要識別要刪除的標籤，請指定標籤索引鍵。您無法使用此操作從不同的索引鍵刪除標籤 AWS 帳戶。

成功時，`UntagResource` 操作不會傳回任何輸出。此外，如果在金鑰上找不到指定的標籤金鑰，則不會擲回例外狀況或傳回回應。若要確認操作已運作，請使用 [ListResourceTags](https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListTagsForResource.html) 操作。

例如，此命令會從指定的金鑰刪除**Purpose**標籤及其值。

```
$ aws payment-cryptography untag-resource \ 
        --resource-arn arn:aws:payment-cryptography:us-east-2:111122223333:key/kwapwa6qaifllw2h --tag-keys Project
```