DESCRIBE INTEGRATION¶
描述集成的属性。
DESCRIBE 可以缩写为 DESC。
- API 集成:
- 目录集成:
- 外部访问集成:
ALTER EXTERNAL ACCESS INTEGRATION、CREATE EXTERNAL ACCESS INTEGRATION
- 通知集成:
ALTER NOTIFICATION INTEGRATION、CREATE NOTIFICATION INTEGRATION
- 安全集成:
- 存储集成:
语法¶
{ DESC | DESCRIBE } [ { API | CATALOG | EXTERNAL ACCESS | NOTIFICATION | SECURITY | STORAGE } ] INTEGRATION <name>
参数¶
{ API | CATALOG | EXTERNAL ACCESS | NOTIFICATION | SECURITY | STORAGE }
描述指定类型的集成。
有关其中部分类型的详细信息,请参阅以下主题:
name
指定要描述的集成的标识符。
如果标识符包含空格或特殊字符,则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。
有关更多信息,请参阅 标识符要求。
使用说明¶
To post-process the output of this command, you can use the pipe operator (
->>
) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is
type
, then specify"type"
for the identifier.
如果集成是 API 集成,则输出包含 API_KEY 列。如果输入了 API 密钥,则 API_KEY 显示掩码值。(这既不会显示未加密的原始密钥,也不会显示密钥的加密版本。)
如果安全集成的
TYPE
属性设置为OAUTH
(即 Snowflake OAuth),则 Snowflake 在查询结果中返回两个额外的安全集成属性,无法使用 CREATE SECURITY INTEGRATION 或 ALTER SECURITY INTEGRATION 命令设置:OAUTH_ALLOWED_AUTHORIZATION_ENDPOINTS
客户端应用程序用于接收来自 Snowflake 的授权代码的所有受支持端点的列表。
OAUTH_ALLOWED_TOKEN_ENDPOINTS
客户端应用程序用于交换访问令牌的授权代码或获取刷新令牌的所有受支持端点的列表。
示例¶
描述名为 my_int
的集成的属性:
DESC INTEGRATION my_int;