google.cloud.gcp_storage_object 模块 – 创建 GCP 对象

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：google.cloud.gcp_storage_object。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。

概要

  • 从 GCS 存储桶上传或下载文件。

要求

执行此模块的主机需要以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

  • google-cloud-storage >= 1.2.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

action

字符串

要对该对象执行的操作。

您可以下载对象、上传对象或删除对象。

选项

  • "download"

  • "upload"

  • "delete"

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

bucket

字符串

存储桶的名称。

dest

路径

文件的目标位置（可能是本地机器或云，取决于操作）。云位置需要进行 URL 编码，包括斜杠。上传和下载都需要。

env_type

字符串

指定您在哪个 Ansible 环境中运行此模块。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。

service_account_email

字符串

如果选择 machineaccount 并且用户不希望使用默认电子邮件，则可以选择的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

src

路径 / 必需

文件的源位置（可能是本地机器或云，取决于操作）。云位置需要进行 URL 编码，包括斜杠。

示例

- name: Download an object
  google.cloud.gcp_storage_object:
    action: download
    bucket: ansible-bucket
    src: modules.zip
    dest: "~/modules.zip"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

bucket

字符串

包含对象的存储桶。

已返回：下载，上传

cache_control

字符串

此对象的 HTTP ‘Cache-Control’ 标头

已返回：下载，上传

chunk_size

字符串

获取 Blob 的默认块大小

已返回：下载，上传

字符串

媒体链接

已返回：下载，上传

字符串

媒体的 self_link。

已返回：下载，上传

storage_class

字符串

对象的存储类。

已返回：下载，上传

作者

  • Google Inc. (@googlecloudplatform)