

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 标记 X-Ray 采样规则和组
标记

标签是可用于识别和组织 Amazon 资源的单词或短语。您可以向每个资源添加多个标签。每个标签都包含您所定义的一个键和可选值。例如，标签键可能是 **domain**，标签值可能是 **example.com**。您可以根据添加的标签搜索和筛选您的资源。有关标签使用方法的更多信息，请参阅 *Amazon 一般参考*中的[标记 Amazon 资源](https://docs.amazonaws.cn/general/latest/gr/aws_tagging.html)。

您可以使用标签对 CloudFront 分配强制执行基于标签的权限。有关更多信息，请参阅[使用资源标签控制对 Amazon 资源的访问](https://docs.amazonaws.cn/IAM/latest/UserGuide/access_tags.html)。

**注意**  
[标签编辑器](https://docs.amazonaws.cn/ARG/latest/userguide/tag-editor.html)和 [Amazon 资源组](https://docs.amazonaws.cn/ARG/latest/userguide/welcome.html)目前不支持 X-Ray 资源。您可以使用 Amazon X-Ray 控制台或 API 添加和管理标签。

您可以使用 X-Ray 控制台、API、 Amazon CLI SDKs、和对资源应用标签 Amazon Tools for Windows PowerShell。有关更多信息，请参阅以下文档：
+ X-Ray API — 请参阅 *Amazon X-Ray API 参考*中介绍的以下操作：
  + [ListTagsForResource](https://docs.amazonaws.cn/xray/latest/api/API_ListTagsForResource.html) 
  + [CreateSamplingRule](https://docs.amazonaws.cn/xray/latest/api/API_CreateSamplingRule.html) 
  + [CreateGroup](https://docs.amazonaws.cn/xray/latest/api/API_CreateGroup.html) 
  + [TagResource](https://docs.amazonaws.cn/xray/latest/api/API_TagResource.html) 
  + [UntagResource](https://docs.amazonaws.cn/xray/latest/api/API_UntagResource.html) 
+ Amazon CLI — 参见《*Amazon CLI 命令*参考》中的 [xray](https://docs.amazonaws.cn/cli/latest/reference/xray/index.html)
+ SDKs — 参见 “文档” 页面上相应的 SDK [Amazon 文档](https://docs.amazonaws.cn/)

**注意**  
如果您无法在 X-Ray 资源上添加或更改标签，或者无法添加具有特定标签的资源，则可能没有权限执行此操作。要申请访问权限，请联系企业中拥有 X-Ray **管理员**权限的 Amazon 用户。

**Topics**
+ [

## 标签限制
](#xray-tagging-restrictions)
+ [

## 在控制台中管理标签
](#xray-tagging-manage)
+ [

## 管理中的标签 Amazon CLI
](#xray-tagging-manage-cli)
+ [

## 基于标签控制对 X-Ray 资源的访问
](#xray-tagging-policy)

## 标签限制


以下限制适用于标签。
+ 每个资源的标签数上限：50
+ 最大密钥长度 – 128 个 Unicode 字符
+ 最大值长度 – 256 个 Unicode 字符
+ 键和值的有效值 – a-z、A-Z、0-9、空格和以下字符：\$1 . : / = \$1 - 和 @
+ 标签键和值区分大小写。
+ 请不要使用 `aws:` 作为键的前缀；它保留为供 Amazon 使用。

**注意**  
无法编辑或删除系统标签。

## 在控制台中管理标签


您可以在创建 X-Ray 组或采样规则时添加可选标签。稍后也可以在控制台中更改或删除标签。

以下过程介绍了如何在 X-Ray 控制台中为集群和采样规则添加、编辑和删除标签。

**Topics**
+ [

### 向新组添加标签（控制台）
](#xray-tagging-add-group-console)
+ [

### 向新采样规则添加标签（控制台）
](#xray-tagging-add-rule-console)
+ [

### 编辑或删除某个组的标签（控制台）
](#xray-tagging-change-group-console)
+ [

### 编辑或删除采样规则标签（控制台）
](#xray-tagging-change-rule-console)

### 向新组添加标签（控制台）


创建新的 X-Ray 组时，可以在**创建组**页面上添加可选标签。

1. 登录 Amazon Web Services 管理控制台 并在[https://console.aws.amazon.com/xray/家](https://console.amazonaws.cn/xray/home)中打开 X-Ray 控制台。

1. 在导航窗格中，展开**配置**，然后选择**组**。

1. 选择**创建群组**。

1. 在**创建组**页面上，为组指定名称和筛选表达式。有关这些属性的更多信息，请参阅[配置组](xray-console-groups.md)。

1. 在**标签**中，输入一个标签键和可选的标签值。例如，可以输入标签键“**Stage**”和标签值“**Production**”以指示该组用于生产。添加标签时会出现一个新行，供您根据需要添加另一个标签。请参阅本主题中的 [标签限制](#xray-tagging-restrictions)，了解标签的限制。

1. 在添加完标签后，请选择**创建组**。

### 向新采样规则添加标签（控制台）


创建新的 X-Ray 采样规则时，可以在**创建采样规则**页面上添加标签。

1. 登录 Amazon Web Services 管理控制台 并在[https://console.aws.amazon.com/xray/家](https://console.amazonaws.cn/xray/home)中打开 X-Ray 控制台。

1. 在导航窗格中，展开**配置**，然后选择**采样**。

1. 选择**创建采样规则**。

1. 在**创建采样规则**页面上，指定名称、优先级、限制、匹配标准和匹配属性。有关这些属性的更多信息，请参阅[配置采样规则](xray-console-sampling.md)。

1. 在**标签**中，输入一个标签键和可选的标签值。例如，可以输入标签键“**Stage**”和标签值“**Production**”以指示采购规则用于生产。添加标签时会出现一个新行，供您根据需要添加另一个标签。请参阅本主题中的 [标签限制](#xray-tagging-restrictions)，了解标签的限制。

1. 在添加完标签后，请选择**创建采样规则**。

### 编辑或删除某个组的标签（控制台）


您可以在**编辑组**页面上更改或删除应用于某个 X-Ray 组的标签。

1. 登录 Amazon Web Services 管理控制台 并在[https://console.aws.amazon.com/xray/家](https://console.amazonaws.cn/xray/home)中打开 X-Ray 控制台。

1. 在导航窗格中，展开**配置**，然后选择**组**。

1. 在**组**表中，选择相应组的名称。

1. 在**编辑组**页面的**标签**中，编辑标签键和值。标签键不得重复。标签值是选填，如果需要可以删除。有关**编辑组**页面上其他属性的更多信息，请参阅 [配置组](xray-console-groups.md)。请参阅本主题中的 [标签限制](#xray-tagging-restrictions)，了解标签的限制。

1. 若要删除标签，请选择标签右侧的 **X**。

1. 编辑或删除完标签后，请选择**更新组**。

### 编辑或删除采样规则标签（控制台）


您可以在**编辑采样规则**页面上更改或删除应用于 X-Ray 采样规则的标签。

1. 登录 Amazon Web Services 管理控制台 并在[https://console.aws.amazon.com/xray/家](https://console.amazonaws.cn/xray/home)中打开 X-Ray 控制台。

1. 在导航窗格中，展开**配置**，然后选择**采样**。

1. 在**采样规则**表中，选择采样规则的名称。

1. 在**标签**中，编辑标签键和值。标签键不得重复。标签值是选填，如果需要可以删除。有关**编辑采样规则**页面上其他属性的更多信息，请参阅 [配置采样规则](xray-console-sampling.md)。请参阅本主题中的 [标签限制](#xray-tagging-restrictions)，了解标签的限制。

1. 若要删除标签，请选择标签右侧的 **X**。

1. 编辑或删除完标签后，选择**更新采样规则**。

## 管理中的标签 Amazon CLI


您可以在创建 X-Ray 组或采样规则时添加标签。您也可以使用 Amazon CLI 来创建和管理标签。要更新现有群组或采样规则上的标签，请使用 Amazon X-Ray 控制台[TagResource](https://docs.amazonaws.cn/xray/latest/api/API_TagResource.html)或或[UntagResource](https://docs.amazonaws.cn/xray/latest/api/API_UntagResource.html) APIs。

**Topics**
+ [

### 向新的 X-Ray 组或采样规则添加标签 (CLI)
](#xray-tagging-cli-create)
+ [

### 向现有资源添加标签 (CLI)
](#xray-tagging-cli-add)
+ [

### 列出资源上的标签 (CLI)
](#xray-tagging-cli-list)
+ [

### 从资源中删除标签 (CLI)
](#xray-tagging-cli-delete)

### 向新的 X-Ray 组或采样规则添加标签 (CLI)


请使用以下命令之一，在创建新的 X-Ray 组或采样规则时添加可选标签。
+ 要向新组添加标签，请运行以下命令，*group\$1name*替换为您的组名称、*mydomain.com*服务的终端节点、*key\$1name*标签密钥以及可选*value*的标签值。有关如何创建组的更多信息，请参阅[组](xray-api-configuration.md#xray-api-configuration-groups)。

  ```
  aws xray create-group \
     --group-name "group_name" \
     --filter-expression "service(\"mydomain.com\") {fault OR error}" \
     --tags [{"Key": "key_name","Value": "value"},{"Key": "key_name","Value": "value"}]
  ```

  示例如下：

  ```
  aws xray create-group \
     --group-name "AdminGroup" \
     --filter-expression "service(\"mydomain.com\") {fault OR error}" \
     --tags [{"Key": "Stage","Value": "Prod"},{"Key": "Department","Value": "QA"}]
  ```
+ 要向新的采样规则添加标签，请运行以下命令，*key\$1name*替换为标签键，也可以*value*替换为标签值。此命令将 `--sampling-rule` 参数中的值指定为 JSON 文件。有关如何创建采样规则的更多信息，请参阅[采样规则](xray-api-configuration.md#xray-api-configuration-sampling)。

  ```
  aws xray create-sampling-rule \
     --cli-input-json file://file_name.json
  ```

  以下是`--cli-input-json`参数指定的 JSON 文件的*file\$1name.json*内容。

  ```
  {
      "SamplingRule": {
          "RuleName": "rule_name",
          "RuleARN": "string",
          "ResourceARN": "string",
          "Priority": integer,
          "FixedRate": double,
          "ReservoirSize": integer,
          "ServiceName": "string",
          "ServiceType": "string",
          "Host": "string",
          "HTTPMethod": "string",
          "URLPath": "string",
          "Version": integer,
          "Attributes": {"attribute_name": "value","attribute_name": "value"...}
      }
      "Tags": [
             {
                 "Key":"key_name",
                 "Value":"value"
             },
             {
                 "Key":"key_name",
                 "Value":"value"
             }
            ]
  }
  ```

  以下命令是一个示例。

  ```
  aws xray create-sampling-rule \
     --cli-input-json file://9000-base-scorekeep.json
  ```

  以上是由 `--cli-input-json` 参数指定的示例 `9000-base-scorekeep.json` 文件的内容。

  ```
  {
      "SamplingRule": {
          "RuleName": "base-scorekeep",
          "ResourceARN": "*",
          "Priority": 9000,
          "FixedRate": 0.1,
          "ReservoirSize": 5,
          "ServiceName": "Scorekeep",
          "ServiceType": "*",
          "Host": "*",
          "HTTPMethod": "*",
          "URLPath": "*",
          "Version": 1
      }
      "Tags": [
             {
                 "Key":"Stage",
                 "Value":"Prod"
             },
             {
                 "Key":"Department",
                 "Value":"QA"
             }
            ]
  }
  ```

### 向现有资源添加标签 (CLI)


可以运行 `tag-resource` 命令向现有 X-Ray 组或采样规则添加标签。此方法可能比通过运行 `update-group` 或 `update-sampling-rule` 来添加标签更简单。

若要向组或采样规则添加标签，请运行以下命令，将 ARN 替换为资源的 ARN，并指定想要添加的标签的键和可选值。

```
aws xray tag-resource \
   --resource-arn "ARN" \
   --tag-keys [{"Key":"key_name","Value":"value"}, {"Key":"key_name","Value":"value"}]
```

示例如下：

```
aws xray tag-resource \
   --resource-arn "arn:aws:xray:us-east-2:01234567890:group/AdminGroup" \
   --tag-keys [{"Key": "Stage","Value": "Prod"},{"Key": "Department","Value": "QA"}]
```

### 列出资源上的标签 (CLI)


可以运行 `list-tags-for-resource` 命令列出 X-Ray 组或采样规则上的标签。

若要列出与某个组或采样规则关联的标签，请运行以下命令，将 ARN 替换为资源的 ARN。

```
aws xray list-tags-for-resource \
   --resource-arn "ARN"
```

示例如下：

```
aws xray list-tags-for-resource \
   --resource-arn "arn:aws:xray:us-east-2:01234567890:group/AdminGroup"
```

### 从资源中删除标签 (CLI)


可以运行 `untag-resource` 命令删除 X-Ray 组或采样规则上的标签。

若要删除组或采样规则上的标签，请运行以下命令，将 ARN 替换为资源的 ARN，并指定想要添加的标签的键。

可以使用 `untag-resource` 命令仅删除整个标签。若要删除标签值，请使用 X-Ray 控制台，或删除标签再添加具有相同键但值不同或为空的新标签。

```
aws xray untag-resource \
   --resource-arn "ARN" \
   --tag-keys ["key_name","key_name"]
```

示例如下：

```
aws xray untag-resource \
   --resource-arn "arn:aws:xray:us-east-2:01234567890:group/group_name" \
   --tag-keys ["Stage","Department"]
```

## 基于标签控制对 X-Ray 资源的访问


您可以将标签附加到 X-Ray 组或采样规则，或在发给 X-Ray 请求中传递标签。要基于标签控制访问，您需要使用 `xray:ResourceTag/key-name``aws:RequestTag/key-name` 或 `aws:TagKeys` 条件键在策略的[条件元素](https://docs.amazonaws.cn/IAM/latest/UserGuide/reference_policies_elements_condition.html)中提供标签信息。要了解有关这些条件键的更多信息，请参阅[使用 Amazon 资源标签控制对资源的访问权限](https://docs.amazonaws.cn/IAM/latest/UserGuide/access_tags.html)。

要查看基于身份的策略（用于根据资源上的标签来限制对该资源的访问）的示例，请参阅 [根据标签管理对 X-Ray 组和采样规则的访问权限](security_iam_id-based-policy-examples.md#security_iam_id-based-policy-examples-manage-sampling-tags)。