Categories:

System functions (System Information)

SYSTEM$GET_PRIVATELINK_CONFIG

返回必要 Snowflake 账户信息的 JSON 表示形式，这些信息有助于以自助方式配置与 Snowflake 服务或 Snowflake 内部暂存区的专用连接。

语法

SYSTEM$GET_PRIVATELINK_CONFIG()

实参

无。

返回

该函数根据 Snowflake 账户所在的云平台返回一个包含以下名称/值对的 JSON 对象：

AWS

{
  "regionless-snowsight-privatelink-url": "<privatelink_org_snowsight_url>",
  "privatelink-account-name": "<account_identifier>",
  "privatelink-connection-ocsp-urls": "<client_redirect_ocsp_url_list>",
  "snowsight-privatelink-url": "<privatelink_region_snowsight_url>",
  "privatelink-internal-stage": "<privatelink_stage_endpoint>",
  "privatelink-account-url": "<privatelink_account_url>",
  "privatelink-connection-urls": "<privatelink_connection_url_list>",
  "regionless-privatelink-account-url": "<privatelink_org_account_url>",
  "privatelink-ocsp-url": "<privatelink_ocsp_url>",
  "privatelink-vpce-id": "<aws_vpce_id>",
  "privatelink-account-principal": "<aws_principal_arn>",
  "regionless-privatelink-ocsp-url": "<privatelink_org_ocsp_url>",
  "app-service-privatelink-url": "<privatelink_streamlit_url>",
  "privatelink-dashed-urls-for-duo": "<privatelink_duo_url_list>"
}

Microsoft Azure

{
  "regionless-snowsight-privatelink-url": "<privatelink_org_snowsight_url>",
  "privatelink-account-name": "<account_identifier>",
  "privatelink-connection-ocsp-urls": "<client_redirect_ocsp_url_list>",
  "snowsight-privatelink-url": "<privatelink_region_snowsight_url>",
  "privatelink-internal-stage": "<privatelink_stage_endpoint>",
  "privatelink-snowflake-managed-storage-volume-nfs": "<privatelink_volume_nfs_endpoint>",
  "privatelink-snowflake-managed-storage-volume-fs": "<privatelink_volume_fs_endpoint>",
  "privatelink-account-url":"<privatelink_account_url>",
  "privatelink-connection-urls": "<privatelink_connection_url_list>",
  "regionless-privatelink-account-url": "<privatelink_org_account_url>",
  "privatelink-ocsp-url": "<privatelink_ocsp_url>",
  "privatelink-pls-id": "<azure_privatelink_service_id>",
  "regionless-privatelink-ocsp-url": "<privatelink_org_ocsp_url>",
  "privatelink-dashed-urls-for-duo": "<privatelink_duo_url_list>"
}

Google Cloud Platform

{
  "regionless-snowsight-privatelink-url": "<privatelink_org_snowsight_url>",
  "privatelink-account-name": "<account_identifier>",
  "privatelink-connection-ocsp-urls": "<client_redirect_ocsp_url_list>",
  "snowsight-privatelink-url": "<privatelink_region_snowsight_url>",
  "privatelink-account-url": "<privatelink_account_url>",
  "privatelink-connection-urls": "<privatelink_connection_url_list>",
  "regionless-privatelink-account-url": "<privatelink_org_account_url>",
  "privatelink-ocsp-url": "<privatelink_ocsp_url>",
  "privatelink-gcp-service-attachment": "<snowflake_service_endpoint>",
  "regionless-privatelink-ocsp-url": "<privatelink_org_ocsp_url>",
  "privatelink-dashed-urls-for-duo": "<privatelink_duo_url_list>"
}

其中：

regionless-snowsight-privatelink-url

The URL for your organization to access Snowsight using private connectivity to the Snowflake service.

Use this URL to create a canonical name (i.e. CNAME) for DNS resolution. This URL should match the output for the SNOWSIGHT_DEPLOYMENT_REGIONLESS (i.e. TYPE) from the SYSTEM$ALLOWLIST_PRIVATELINK function.

For more information, see Account identifiers and Snowsight: The Snowflake web interface.

privatelink-account-name

Snowflake 账户的标识符。

Use this value with clients for Applications and tools for connecting to Snowflake.

For more information, see Account identifiers.

privatelink-connection-ocsp-urls

The list of OCSP URLs for use with Redirecting client connections.

The list of values should match the output for OCSP_CLIENT_FAILOVER from the SYSTEM$ALLOWLIST_PRIVATELINK function.

snowsight-privatelink-url

The URL containing the cloud region to access Snowsight and the Snowflake Marketplace using private connectivity to the Snowflake service.

Use this URL to create a canonical name (i.e. CNAME) for DNS resolution. This URL should match the output for the SNOWSIGHT_DEPLOYMENT (i.e. TYPE) from the SYSTEM$ALLOWLIST_PRIVATELINK function.

For more information, see Account identifiers and Snowsight: The Snowflake web interface.

privatelink-internal-stage

使用 AWS PrivateLink 或 Azure 专用链接连接到 Snowflake 内部暂存区的端点。

将此值与 Snowflake 内部暂存区的专用连接结合使用。

The visibility of this key and the corresponding value in the query result depends on the ENABLE_INTERNAL_STAGES_PRIVATELINK parameter setting. The default setting for this parameter is FALSE. You must set this parameter to TRUE prior to executing this system function to obtain the internal stage endpoint in the query result.

privatelink-snowflake-managed-storage-volume-nfs

The endpoint to connect to your non failsafe Snowflake-managed storage volume using Azure Private Link.

Use this value with private connectivity to Snowflake-managed storage volumes for Apache Iceberg tables.

The visibility of this key and the corresponding value in the query result depends on the ENABLE_SNOWFLAKE_MANAGED_STORAGE_VOLUME_PRIVATELINK parameter setting. The default setting for this parameter is FALSE. You must set this parameter to TRUE prior to executing this system function to obtain the endpoint in the query result.

privatelink-snowflake-managed-storage-volume-fs

The endpoint to connect to your failsafe Snowflake-managed storage volume using Azure Private Link.

Use this value with private connectivity to Snowflake-managed storage volumes for Apache Iceberg tables.

The visibility of this key and the corresponding value in the query result depends on the ENABLE_SNOWFLAKE_MANAGED_STORAGE_VOLUME_PRIVATELINK parameter setting. The default setting for this parameter is FALSE. You must set this parameter to TRUE prior to executing this system function to obtain the endpoint in the query result.

privatelink-account-url

使用 AWS PrivateLink、Azure 专用链接或 Google Cloud Private Service Connect 连接到 Snowflake 账户的 URL。

Use this value to create a canonical name (i.e. CNAME) for DNS resolution. This URL should match the output from SYSTEM$ALLOWLIST_PRIVATELINK.

For more information on URL formats, see Account identifiers.

privatelink-connection-urls

The list of connection URLs for Client Redirect.

Use these URLs to create a canonical name (i.e. CNAME) for DNS resolution. These URL should match the output for CLIENT_FAILOVER (i.e. TYPE) from the SYSTEM$ALLOWLIST_PRIVATELINK function.

regionless-privatelink-account-url

专用连接 URL，其中包括您的组织名称和账户名称。

This value matches the output value of SNOWFLAKE_DEPLOYMENT_REGIONLESS in the SYSTEM$ALLOWLIST_PRIVATELINK function.

privatelink-ocsp-url

与使用 AWS PrivateLink、Microsoft Azure 专用链接或 Google Cloud Private Service Connect 的 Snowflake 账户标识符对应的 OCSP URL。

使用此值为 DNS 解决方案创建规范名称（即 CNAME）。

privatelink-vpce-id

账户标识符的 AWS VPCE ID。

使用此值创建一个 AWS VPC 端点（即 VPCE）。

privatelink-account-principal

允许到 VPC 端点服务的出站专用连接的 AWS 主体 ARN。

Use this value to set the allowed principal (https://docs.aws.amazon.com/vpc/latest/privatelink/configure-endpoint-service.html#add-remove-permissions) of your endpoint service, which allows Snowflake to connect to your endpoint service via AWS PrivateLink.

privatelink-pls-id

以别名格式表示的账户标识符的 Microsoft Azure 专用链接服务 ID。例如：

sf-pvlinksvc-azurecentralus.<unique_identifier>.centralus.azure.privatelinkservice

Where the <unique_identifier> is in GUID/UUID format.

Use this value to create an Azure Private Link private endpoint. If you receive an error while creating the private endpoint, contact Snowflake Support and ask for the resource ID that is associated with this alias value.

privatelink-gcp-service-attachment

使用 Google Cloud Private Service Connect 时，Snowflake 服务的端点。

创建转发规则以将 VPC 中的 Private Service Connect 端点路由到 Snowflake 服务时使用此值。

"regionless-privatelink-ocsp-url

The OCSP URL for your account identifier.

该值记录如下：

"ocsp.org_name-account_name.privatelink.snowflakecomputing.cn"

其中：

  • org_name is the name of your Snowflake organization.
  • account_name is the unique name of your account within your organization.
app-service-privatelink-url

PrivateLink 端点 URL，用于将流量路由到 Snowflake 托管的应用程序服务（例如 Streamlit 或笔记本）。

privatelink-dashed-urls-for-duo

仅当主机名包含下划线时，才会显示虚线变体 URLs 列表。URLs 用于 Duo 多重身份验证。

使用说明

  • 只有账户管理员（即具有 ACCOUNTADMIN 角色的用户）可执行此函数。
  • For Snowflake accounts on Microsoft Azure, if you call the function and the query time is greater than one minute, please contact Snowflake Support.

示例

检索 AWS 上 Snowflake 账户的 JSON 信息。

SELECT SYSTEM$GET_PRIVATELINK_CONFIG();

您可以选择运行以下命令来扁平化 JSON 输出。以下输出是 Microsoft Azure 上 Snowflake 账户的示例：

select key, value from table(flatten(input=>parse_json(SYSTEM$GET_PRIVATELINK_CONFIG())));

+--------------------------------------+--------------------------------------+
| KEY                                  | VALUE                                |
+--------------------------------------+--------------------------------------+
| regionless-snowsight-privatelink-url | "<privatelink_org_snowsight_url>"    |
|--------------------------------------+--------------------------------------|
| privatelink-account-name             | "<account_identifier>"               |
|--------------------------------------+--------------------------------------|
| privatelink-connection-ocsp-urls     | "<client_redirect_ocsp_url_list>"    |
|--------------------------------------+--------------------------------------|
| snowsight-privatelink-url            | "<privatelink_region_snowsight_url>" |
|--------------------------------------+--------------------------------------|
| privatelink-internal-stage           | "<privatelink_stage_endpoint>"       |
|--------------------------------------+--------------------------------------|
| privatelink-snowflake-managed-       | "<privatelink_volume_nfs_endpoint>"  |
| storage-volume-nfs                   |                                      |
|--------------------------------------+--------------------------------------|
| privatelink-snowflake-managed-       | "<privatelink_volume_fs_endpoint>"   |
| storage-volume-fs                    |                                      |
|--------------------------------------+--------------------------------------|
| privatelink-account-url              | "<privatelink_account_url>"          |
|--------------------------------------+--------------------------------------|
| privatelink-connection-urls          | "<privatelink_connection_url_list>"  |
|--------------------------------------+--------------------------------------|
| privatelink-pls-id                   | "<azure_private_link_service_id>"    |
|--------------------------------------+--------------------------------------|
| regionless-privatelink-account-url   | "<privatelink_org_account_url>"      |
|--------------------------------------+--------------------------------------|
| privatelink-ocsp-url                 | "<privatelink_ocsp_url>"             |
|--------------------------------------+--------------------------------------|
| regionless-privatelink-ocsp-url      | "<privatelink_org_ocsp_url>"         |
+--------------------------------------+--------------------------------------+