Связаться с намиПодключиться

Управление метками бакета

Статья создана
Улучшена
Обновлена 30 октября 2024 г.

Метки бакетов — это пары ключ-значение для логической маркировки бакетов.

Примечание

В терминологии Yandex Cloud для логической маркировки ресурсов используется понятие метка (label). Object Storage поддерживает совместимость с Amazon S3 API, поэтому в командах для AWS CLI и в параметрах API применяется термин AWS — тег (tag).

Добавить или изменить метки

  1. В консоли управления в списке сервисов выберите Object Storage и перейдите в бакет, в котором нужно добавить или изменить меткаи.
  2. На панели слева выберите Настройки.
  3. Выберите вкладку Основные.
  4. Нажмите кнопку Добавить метку.
  5. Введите метку в формате ключ: значение. Чтобы изменить существующую метку, введите ее ключ и новое значение.
  6. Нажмите Enter.
  7. Нажмите кнопку Сохранить.

Важно

В результате изменения настроек бакета существующий набор меток будет полностью перезаписан новым набором меток.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

  1. Посмотрите описание команды CLI для изменения настроек бакета:

    yc storage bucket update --help

  2. Получите список бакетов в каталоге по умолчанию:

    yc storage bucket list

    Результат:

    +------------------+----------------------+----------+-----------------------+---------------------+
|       NAME       |      FOLDER ID       | MAX SIZE | DEFAULT STORAGE CLASS |     CREATED AT      |
+------------------+----------------------+----------+-----------------------+---------------------+
| my-bucket        | b1gmit33ngp3******** | 10       | STANDARD              | 2022-12-16 13:58:18 |
+------------------+----------------------+----------+-----------------------+---------------------+

  3. Добавьте метки, указав имя нужного бакета:

    yc storage bucket update <имя_бакета> \
  --tags <ключ_метки_1>=<значение_метки_1>,<ключ_метки_2>=<значение_метки_2>,...,<ключ_метки_n>=<значение_метки_n>

    Где --tags — флаг для перечисления меток бакета в формате ключ=значение.

    Результат:

    name: my-bucket
folder_id: b1gmit33ngp3********
default_storage_class: STANDARD
versioning: VERSIONING_ENABLED
acl: {}
created_at: "2023-04-24T14:15:28.240705Z"
tags:
  - key: key-tag
    value: key-value

Важно

В результате изменения настроек бакета существующий набор меток будет полностью перезаписан новым набором меток.

Если у вас еще нет интерфейса командной строки AWS CLI, установите и сконфигурируйте его.

В терминале выполните команду:

aws s3api put-bucket-tagging \
  --bucket <имя_бакета> \
  --tagging 'TagSet=[{Key=<ключ_метки>,Value=<значение_метки>},{Key=<ключ_метки>,Value=<значение_метки>}]' \
  --endpoint-url=https://storage.yandexcloud.net

Где:

  • --bucket — имя бакета.
  • --tagging — массив меток бакета, где:
    • Key — ключ метки, тип: string.
    • Value — значение метки, тип: string.
  • --endpoint-url — эндпоинт Object Storage.

Важно

В результате изменения настроек бакета существующий набор меток будет полностью перезаписан новым набором меток.

Примечание

Terraform взаимодействует с Object Storage от имени сервисного аккаунта. Назначьте сервисному аккаунту нужную роль, например storage.admin, на каталог, в котором будут создаваться ресурсы.

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform или в зеркале.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

  1. Откройте файл конфигурации Terraform и добавьте блок tags во фрагмент с описанием бакета:

    resource "yandex_storage_bucket" "test-bucket" {
  bucket           = "<имя_бакета>"
  ...
  tags             = {
    <ключ_метки_1> = "<значение_метки_1>"
    <ключ_метки_2> = "<значение_метки_2>"
  }
  ...
}

    Где tags — массив меток бакета в формате <ключ> = "<значение>".

    Более подробную информацию о параметрах ресурса yandex_storage_bucket в Terraform, см. в документации провайдера.

  2. Примените изменения:

    1. В терминале перейдите в папку, где вы отредактировали конфигурационный файл.

    2. Проверьте корректность конфигурационного файла с помощью команды:

      terraform validate

      Если конфигурация является корректной, появится сообщение:

      Success! The configuration is valid.

    3. Выполните команду:

      terraform plan

      В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

    4. Примените изменения конфигурации:

      terraform apply

    5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.

После этого к бакету будут добавлены метки. Проверить появление меток и настройки бакета можно в консоли управления или с помощью команды CLI:

yc storage bucket get <имя_бакета> --full

Важно

В результате изменения настроек бакета существующий набор меток будет полностью перезаписан новым набором меток.

Чтобы добавить или изменить метки бакета, воспользуйтесь методом REST API update для ресурса Bucket, вызовом gRPC API BucketService/Update или методом S3 API putBucketTagging.

Пример вызова gRPC API

export IAM_TOKEN="<IAM-токен>"
grpcurl \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -d '{"name": "test-bucket", "update_mask": {"paths": ["tags"]}, "tags": [{"key": "test-key", "value": "test-value"}]}' \
  storage.api.cloud.yandex.net:443 \
  yandex.cloud.storage.v1.BucketService/Update

Где:

  • IAM_TOKEN — IAM-токен.
  • name — имя бакета.
  • update_mask — перечень параметров бакета, которые вы хотите изменить.
  • tags — перечень меток бакета.
  • key — ключ метки.
  • value — значение метки.

Результат:

{
  "id": "e3e5fsr6076bo*******",
  "description": "update bucket",
  "createdAt": "2023-04-27T12:01:03.636597Z",
  "createdBy": "ajelcjkv67arb*******",
  "modifiedAt": "2023-04-27T12:01:03.636597Z",
  "done": true,
  "metadata": {"@type":"type.googleapis.com/yandex.cloud.storage.v1.UpdateBucketMetadata","name":"test-bucket"},
  "response": {"@type":"type.googleapis.com/yandex.cloud.storage.v1.Bucket","acl":{},"createdAt":"2023-03-27T08:23:26.890770Z","defaultStorageClass":"STANDARD","folderId":"b1gsm0k26v1l2*******","maxSize":"53687091200","name":"test-bucket","tags":[{"key":"test-key","value":"test-value"}],"versioning":"VERSIONING_DISABLED"}
}

Посмотреть метки

  1. В консоли управления в списке сервисов выберите Object Storage и перейдите в нужный бакет.
  2. На панели слева выберите Настройки.
  3. Выберите вкладку Основные.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

  1. Посмотрите описание команды CLI для получения информации о бакете:

    yc storage bucket get --help

  2. Получите список бакетов в каталоге по умолчанию:

    yc storage bucket list

    Результат:

     +------------------+----------------------+----------+-----------------------+---------------------+
 |       NAME       |      FOLDER ID       | MAX SIZE | DEFAULT STORAGE CLASS |     CREATED AT      |
 +------------------+----------------------+----------+-----------------------+---------------------+
 | my-bucket        | b1gmit33ngp3******** | 10       | STANDARD              | 2022-12-16 13:58:18 |
 +------------------+----------------------+----------+-----------------------+---------------------+

  3. Получите информацию о метках, указав имя нужного бакета:

    yc storage bucket get <имя_бакета> --full

    Результат:

    name: my-bucket
folder_id: b1gmit33ngp3********
default_storage_class: STANDARD
...
tags:
  - key: key-tag
    value: key-value
...

Если у вас еще нет интерфейса командной строки AWS CLI, установите и сконфигурируйте его.

В терминале выполните команду:

aws s3api get-bucket-tagging \
  --bucket <имя_бакета> \
  --endpoint-url=https://storage.yandexcloud.net

Где:

  • --bucket — имя бакета.
  • --endpoint-url — эндпоинт Object Storage.

Результат:

{
    "TagSet": [
        {
            "Key": "test-key-1",
            "Value": "test-value-1"
        },
        {
            "Key": "test-key-2",
            "Value": "test-value-2"
        }
    ]
}

Чтобы посмотреть метки бакета, воспользуйтесь методом REST API get для ресурса Bucket, вызовом gRPC API BucketService/Get или методом S3 API getBucketTagging.

Пример вызова gRPC API

export IAM_TOKEN="<IAM-токен>"
grpcurl \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -d '{"name": "test-bucket", "view": "VIEW_FULL"}' \
  storage.api.cloud.yandex.net:443 \
  yandex.cloud.storage.v1.BucketService/Get

Где:

  • IAM_TOKEN — IAM-токен.
  • name — имя бакета.
  • view — объем предоставляемой информации, VIEW_FULL — полная информация о бакете.

Результат:

{
  "name": "test-bucket",
  "folderId": "b1gsm0k26v1l2*******",
  "anonymousAccessFlags": {
    "read": true,
    "list": true,
    "configRead": true
  },
  "defaultStorageClass": "STANDARD",
  "versioning": "VERSIONING_DISABLED",
  "maxSize": "53687091200",
  "acl": {

  },
  "createdAt": "2023-03-27T08:23:26.890770Z",
  "websiteSettings": {
    "redirectAllRequests": {

    }
  },
  "tags": [
    {
      "key": "test-key",
      "value": "test-value"
    }
  ]
}

Удалить метки

  1. В консоли управления в списке сервисов выберите Object Storage и перейдите в нужный бакет.
  2. На панели слева выберите Настройки.
  3. Выберите вкладку Основные.
  4. Напротив нужной метки нажмите значок .
  5. Нажмите кнопку Сохранить.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

  1. Посмотрите описание команды CLI для изменения настроек бакета:

    yc storage bucket update --help

  2. Получите список бакетов в каталоге по умолчанию:

    yc storage bucket list

    Результат:

    +------------------+----------------------+----------+-----------------------+---------------------+
|       NAME       |      FOLDER ID       | MAX SIZE | DEFAULT STORAGE CLASS |     CREATED AT      |
+------------------+----------------------+----------+-----------------------+---------------------+
| my-bucket        | b1gmit33ngp3******** | 10       | STANDARD              | 2022-12-16 13:58:18 |
+------------------+----------------------+----------+-----------------------+---------------------+

  3. Удалите метки, указав имя нужного бакета:

    yc storage bucket update <имя_бакета> \
  --remove-tags

    Результат:

    name: my-bucket
folder_id: b1gmit33ngp3********
default_storage_class: STANDARD
versioning: VERSIONING_ENABLED
acl: {}
created_at: "2023-04-24T14:15:28.240705Z"

Если у вас еще нет интерфейса командной строки AWS CLI, установите и сконфигурируйте его.

В терминале выполните команду:

aws s3api delete-bucket-tagging \
  --bucket <имя_бакета> \
  --endpoint-url=https://storage.yandexcloud.net

Где:

  • --bucket — имя бакета.
  • --endpoint-url — эндпоинт Object Storage.

Примечание

Terraform взаимодействует с Object Storage от имени сервисного аккаунта. Назначьте сервисному аккаунту нужную роль, например storage.admin, на каталог, в котором будут создаваться ресурсы.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

  1. Откройте файл конфигурации Terraform и удалите блок tags из фрагмента с описанием бакета.

    Пример описания тегов бакета в конфигурации Terraform
    resource "yandex_storage_bucket" "test-bucket" {
  bucket           = "<имя_бакета>"
  ...
  tags             = {
    <ключ_метки_1> = "<значение_метки_1>"
    <ключ_метки_2> = "<значение_метки_2>"
  }
  ...
}

  2. Примените изменения:

    1. В терминале перейдите в папку, где вы отредактировали конфигурационный файл.

    2. Проверьте корректность конфигурационного файла с помощью команды:

      terraform validate

      Если конфигурация является корректной, появится сообщение:

      Success! The configuration is valid.

    3. Выполните команду:

      terraform plan

      В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.

    4. Примените изменения конфигурации:

      terraform apply

    5. Подтвердите изменения: введите в терминале слово yes и нажмите Enter.

После этого метки бакета будут удалены. Проверить удаление меток и настройки бакета можно в консоли управления или с помощью команды CLI:

yc storage bucket get <имя_бакета> --full

Чтобы удалить метки бакета, воспользуйтесь методом REST API update для ресурса Bucket, вызовом gRPC API BucketService/Update или методом S3 API deleteBucketTagging.

Пример вызова gRPC API

export IAM_TOKEN="<IAM-токен>"
grpcurl \
  -H "Authorization: Bearer $IAM_TOKEN" \
  -d '{"name": "test-bucket", "update_mask": {"paths": ["tags"]}, "tags": []}' \
  storage.api.cloud.yandex.net:443 \
  yandex.cloud.storage.v1.BucketService/Update

Где:

  • IAM_TOKEN — IAM-токен.
  • name — имя бакета.
  • update_mask — перечень параметров бакета, которые вы хотите изменить.
  • tags — перечень меток бакета.

Результат:

{
  "id": "e3epc33apcche*******",
  "description": "update bucket",
  "createdAt": "2023-04-27T12:18:18.885391Z",
  "createdBy": "ajelcjkv67arb*******",
  "modifiedAt": "2023-04-27T12:18:18.885391Z",
  "done": true,
  "metadata": {"@type":"type.googleapis.com/yandex.cloud.storage.v1.UpdateBucketMetadata","name":"test-bucket-777"},
  "response": {"@type":"type.googleapis.com/yandex.cloud.storage.v1.Bucket","acl":{},"createdAt":"2023-03-27T08:23:26.890770Z","defaultStorageClass":"STANDARD","folderId":"b1gsm0k26v1l2*******","maxSize":"53687091200","name":"test-bucket-777","versioning":"VERSIONING_DISABLED"}
}
Предыдущая
Управление блокировками версий объектов
Следующая
Получение информации и статистики о бакете