healthcare1-beta1 命令行界面 (CLI) 允许您从终端舒适地使用Google Cloud Healthcare服务的几乎所有功能。

默认情况下，所有输出都会打印到标准输出，但可以通过标志将其直接重定向到文件，而不依赖于您的shell功能。错误将打印到标准错误，并导致程序退出代码非零。

如果请求数据结构，这些将以格式化的JSON返回，以便作为其他工具的输入。

有关Cloud Healthcare API的所有其他信息，请参阅 官方文档站点。

安装和源代码

使用cargo安装命令行界面：

cargo install google-healthcare1_beta1-cli

在 GitHub上找到源代码。

用法

本文档是根据修订版 20240228 中的Cloud Healthcare API生成的。CLI版本为 5.0.4。

healthcare1-beta1 [options]
        projects
                locations-datasets-annotation-stores-annotations-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-annotations-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-annotations-get <name> [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-annotations-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-annotations-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-evaluate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-get <name> [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-import <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-annotation-stores-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-attribute-definitions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-attribute-definitions-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-attribute-definitions-get <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-attribute-definitions-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-attribute-definitions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-check-data-access <consent-store> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consent-artifacts-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consent-artifacts-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consent-artifacts-get <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consent-artifacts-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-activate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-delete-revision <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-get <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-list-revisions <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-reject <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-consents-revoke <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-evaluate-user-consents <consent-store> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-get <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-query-accessible-data <consent-store> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-user-data-mappings-archive <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-user-data-mappings-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-user-data-mappings-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-user-data-mappings-get <name> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-user-data-mappings-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-consent-stores-user-data-mappings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-data-mapper-workspaces-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-datasets-data-mapper-workspaces-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-data-mapper-workspaces-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-deidentify <source-dataset> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-deidentify <source-store> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-dicom-web-studies-get-study-metrics <study> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-dicom-web-studies-series-get-series-metrics <series> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-dicom-web-studies-series-instances-get-storage-info <resource> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-dicom-web-studies-set-blob-storage-settings <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-get <name> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-get-dicom-store-metrics <name> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-import <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-search-for-instances <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-search-for-series <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-search-for-studies <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-set-blob-storage-settings <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-store-instances <parent> <dicom-web-path> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-delete <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-retrieve-metadata <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-retrieve-study <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-search-for-instances <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-search-for-series <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-delete <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-instances-bulkdata-retrieve-bulkdata <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-instances-delete <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-instances-frames-retrieve-frames <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-instances-frames-retrieve-rendered <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-instances-retrieve-instance <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-instances-retrieve-metadata <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-instances-retrieve-rendered <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-retrieve-metadata <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-retrieve-series <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-series-search-for-instances <parent> <dicom-web-path> [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-studies-store-instances <parent> <dicom-web-path> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-dicom-stores-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-apply-admin-consents <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-apply-consents <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-configure-search <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-deidentify <source-store> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-explain-data-access <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--concept-map-search-translate <parent> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--concept-map-translate <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--consent-enforcement-status <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--observation-lastn <parent> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--patient-consent-enforcement-status <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--patient-everything <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--resource-incoming-references <parent> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--resource-purge <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir--resource-validate <parent> <type> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-capabilities <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-conditional-delete <parent> <type> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-conditional-patch <parent> <type> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-conditional-update <parent> <type> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-create <parent> <type> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-execute-bundle <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-history <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-read <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-search <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-search-type <parent> <resource-type> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-fhir-vread <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-get <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-get-fhir-store-metrics <name> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-import <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-rollback <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-fhir-stores-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-get <name> [-p <v>]... [-o <out>]
                locations-datasets-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-get <name> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-get-hl7v2-store-metrics <name> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-import <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-messages-batch-get <parent> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-messages-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-messages-delete <name> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-messages-get <name> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-messages-ingest <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-messages-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-messages-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-hl7-v2-stores-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-list <parent> [-p <v>]... [-o <out>]
                locations-datasets-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-operations-get <name> [-p <v>]... [-o <out>]
                locations-datasets-operations-list <name> [-p <v>]... [-o <out>]
                locations-datasets-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-datasets-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-services-nlp-analyze-entities <nlp-service> (-r <kv>)... [-p <v>]... [-o <out>]
  healthcare1-beta1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在 ~/.google-service-cli 目录中的 JSON 文件中，文件名以 healthcare1-beta1- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数API需要用户对任何请求进行身份验证。如果是这样，范围 确定了授予的权限集合。这些权限的粒度通常不超过 只读 或 完全访问。

如果未设置，系统将自动选择最小的可行范围，例如，当调用只读方法时，它将只请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用的范围都在相应方法的 CLI 文档中进行了说明。

第一次使用范围时，用户会被要求授权。按照 CLI 的指示授权或拒绝。

如果用户认证了某个范围，相关的信息将以 JSON 格式存储在配置目录中，例如 ~/.google-service-cli/healthcare1-beta1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用 Google 服务，它需要使用Google 开发者控制台进行注册。然后逐一启用该应用程序可能使用的 API。大多数 API 都可以免费使用，并且有每日配额。

为了在不强迫任何人注册自己的应用程序的情况下更方便地使用 CLI，CLI 配备了一个默认的应用程序密钥，并相应地进行配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放置在此位置来解决这个问题： ~/.google-service-cli/healthcare1-beta1-secret.json，假设已为它启用了所需的 healthcare API。此类密钥文件可以从 Google 开发者控制台 在 APIs & auth -> Credentials -> Download JSON 下载并直接使用。

有关如何设置 Google 项目和启用 API 的更多信息，请参阅官方文档。

调试

尽管 CLI 尽力提供可用的错误消息，但有时可能需要知道导致特定问题的确切原因。这通过允许所有客户端-服务器通信以 原样 输出到标准错误来实现。

--debug 标志将以 Debug 表示形式将错误打印到标准错误。

您可以考虑将标准错误重定向到文件以方便使用，例如 healthcare1-beta1 --debug <resource> <method> [options] 2>debug.txt。