- 类别:
:doc:`/sql-reference/functions-system`(系统信息)
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>", "regionless-privatelink-ocsp-url": "<privatelink_org_ocsp_url>" }
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-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>" }
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>" }
其中:
regionless-snowsight-privatelink-url
您的 组织 使用与 Snowflake 服务的专用连接来访问 Snowsight 的 URL。
使用此 URL 为 DNS 解决方案创建规范名称(即 CNAME)。此 URL 应与来自 SYSTEM$ALLOWLIST_PRIVATELINK 函数
SNOWSIGHT_DEPLOYMENT_REGIONLESS`(即 :code:`TYPE
)的输出相匹配。有关更多信息,请参阅 账户标识符 和 Snowsight:Snowflake Web 界面。
privatelink-account-name
Snowflake 账户的标识符。
将此值与客户端一起使用以 连接到 Snowflake。
有关更多信息,请参阅 账户标识符。
privatelink-connection-ocsp-urls
用于 重定向客户端连接 的 OCSP URLs 列表。
值列表应与来自 SYSTEM$ALLOWLIST_PRIVATELINK 函数的
OCSP_CLIENT_FAILOVER
的输出相匹配。snowsight-privatelink-url
包含使用 Snowflake 服务专用连接访问 Snowsight 和 Snowflake Marketplace 的 云区域 的 URL。
使用此 URL 为 DNS 解决方案创建规范名称(即 CNAME)。此 URL 应与来自 SYSTEM$ALLOWLIST_PRIVATELINK 函数
SNOWSIGHT_DEPLOYMENT`(即 :code:`TYPE
)的输出相匹配。有关更多信息,请参阅 账户标识符 和 Snowsight:Snowflake Web 界面。
privatelink-internal-stage
使用 AWS PrivateLink 或 Azure 专用链接连接到 Snowflake 内部暂存区的端点。
将此值与 Snowflake 内部暂存区的专用连接结合使用。
此键及其相应值在查询结果中的可见性取决于 ENABLE_INTERNAL_STAGES_PRIVATELINK 参数的设置。此参数的默认设置为
FALSE
。在执行该系统函数之前必须将此参数设置为TRUE
,以获取查询结果中的内部暂存区端点。privatelink-account-url
使用 AWS PrivateLink、Azure 专用链接或 Google Cloud Private Service Connect 连接到 Snowflake 账户的 URL。
使用此值为 DNS 解决方案创建规范名称(即 CNAME)。此 URL 应与 SYSTEM$ALLOWLIST_PRIVATELINK 的的输出相匹配。
有关 URL 格式的更多信息,参见 账户标识符。
privatelink-connection-urls
Client Redirect 的连接 URLs 列表。
使用这些 URLs 创建一个规范名称(即 CNAME),用于 DNS 解析。这些 URL 应与来自 SYSTEM$ALLOWLIST_PRIVATELINK 函数的
CLIENT_FAILOVER`(即 :code:`TYPE
)的输出相匹配。regionless-privatelink-account-url
专用连接 URL,其中包括您的组织名称和账户名称。
此值与 SYSTEM$ALLOWLIST_PRIVATELINK 函数中
SNOWFLAKE_DEPLOYMENT_REGIONLESS
的输出值相匹配。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-pls-id
以别名格式表示的账户标识符的 Microsoft Azure 专用链接服务 ID。例如:
sf-pvlinksvc-azurecentralus.<unique_identifier>.centralus.azure.privatelinkservice
其中
<unique_identifier>
为 GUID/UUID 格式。使用此值创建 Azure 专用链接专用端点。如果在创建专用端点时收到错误,请联系 Snowflake 支持部门 (https://community.snowflake.com/s/article/How-To-Submit-a-Support-Case-in-Snowflake-Lodge),并询问与此别名值关联的资源 ID。
privatelink-gcp-service-attachment
使用 Google Cloud Private Service Connect 时,Snowflake 服务的端点。
创建转发规则以将 VPC 中的 Private Service Connect 端点路由到 Snowflake 服务时使用此值。
"regionless-privatelink-ocsp-url
:doc:`账户标识符 </user-guide/admin-account-identifier>`的 OCSP URL。
该值记录如下:
"ocsp.org_name-account_name.privatelink.snowflakecomputing.cn"
其中:
org_name
是 Snowflake 组织的名称。
account_name
是您的账户在组织中的唯一名称。
使用说明¶
只有账户管理员(即具有 ACCOUNTADMIN 角色的用户)可执行此函数。
对于 Microsoft Azure 上的 Snowflake 账户,如果调用该函数且查询时间大于一分钟,请联系 Snowflake 支持部门 (https://community.snowflake.com/s/article/How-To-Submit-a-Support-Case-in-Snowflake-Lodge)。
示例¶
Retrieve 检索 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-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>" | +--------------------------------------+--------------------------------------+