Snowflake REST APIs 教程的常见设置

简介

本主题提供了本文档中所有 Snowflake REST APIs 教程所需的常见设置说明。

Snowflake REST APIs 概述

在开始设置之前,请先看一下 Snowflake REST APIs。

Snowflake REST APIs 通过相应的 APIs 支持以下资源。APIs 支持相应资源的 CREATE OR ALTER 操作。

有关 APIs 及其端点的参考信息,请参阅 Snowflake REST APIs 参考

小技巧

如果您更喜欢编写 Python 应用程序,可以使用 Snowflake Python APIs 来管理 Snowflake 对象。有关更多信息,请参阅 Snowflake Python APIs:使用 Python 管理 Snowflake 对象

导入 Snowflake REST APIs 集合

本教程将引导您完成从 Postman 导入 Snowflake REST APIs 集合的过程。

  1. 从 Git 存储库 (https://github.com/snowflakedb/snowflake-rest-api-specs/tree/main/releases/8.40/collections) 将 API 集合下载到文件夹。

    ../../../_images/api-collections-git.png
  2. 打开 Postman 应用程序,并在必要时创建账户。

  3. 在 Postman 中,打开所需的工作区。

    ../../../_images/postman-workspace.png
  4. 选择 Import

    ../../../_images/postman-import-workspace.png
  5. 选择 folders

    ../../../_images/postman-download-collections.png
  6. 在对话框中,选择您提取集合的文件夹,然后选择 Open

    ../../../_images/postman-import-elements.png
  7. 验证所有项目是否已被选中,然后选择 Import

    您应该在左侧面板中看到列出的集合,如下所示:

    ../../../_images/postman-verify-import.png

在 Postman 中指定持有者令牌

REST 请求需要在请求标头中包含 JWT 令牌以对请求进行身份验证。如果您没有 JWT 令牌,请参阅 生成 JWT 令牌

在 Postman 中,您可以将 JWT 令牌复制到 bearerToken 标头属性中,如下所示。

../../../_images/postman-bearer-token.png

您可以在每个请求标头中将 x-snowflake-authorization-token-type 键设置为 KEYPAIR_JWT,如下所示:

../../../_images/postman-set-header.png

备注

如教程 先决条件 中所述,您必须定义 AUTHENTICATION POLICY。如果您收到类似于 { "code": "390202", "message": "Authentication attempt rejected by the current authentication policy." } 的错误消息,您可以运行以下 SQL 命令来定义策略:

SHOW AUTHENTICATION POLICIES; alter AUTHENTICATION POLICY <your authentication policy> set AUTHENTICATION_METHODS = ('KEYPAIR', 'PASSWORD', 'OAUTH');
Copy

在 Postman 环境中设置环境变量

您可以在 Postman 环境中设置环境变量。然后,您可以在 Postman 中以 {{variable_name}} 的形式使用这些变量。

所有端点 URLs 均以 baseURL 开头,用于标识 Snowflake 账户。baseURL 的形式为:<account_locator>.snowflakecomputing.cn,其中 <account_locator> 是 Snowflake 账户名称。

要在 Postman 中设置 baseURL 变量以及其他任何变量,请启用每个参数并设置其值,如下所示:

../../../_images/postman-env-vars.png

对于您设置的每个值,您必须选择 Save 以保存新值。

下一步是什么?

恭喜!在本教程中,您学习了使用 Snowflake REST APIs 管理 Snowflake 数据库、架构和表资源的基本知识。

摘要

在此过程中,您完成了以下步骤:

  • 导入 Snowflake REST APIs 集合。

  • 在 Postman 中指定持有者令牌。

  • 在 Postman 环境中设置环境变量。

下一个教程

您现在可以继续进行 教程 1:创建和管理数据库、架构和表,该部分向您展示如何创建和管理 Snowflake 数据库、架构和表。

语言: 中文