SHOW EXTERNAL AGENTS

列出您具有访问权限的外部代理。在 Snowflake 中，外部代理代表生成式 AI 应用程序，用于 AI 可观察性。

输出返回对象元数据和属性，根据数据库、模式和外部代理名称按字典顺序排序（有关输出列的说明，请参阅本主题中的 输出）。

另请参阅：

CREATE EXTERNAL AGENT、ALTER EXTERNAL AGENT、DROP EXTERNAL AGENT、DESCRIBE EXTERNAL AGENT

语法

SHOW EXTERNAL AGENTS [ LIKE '<pattern>' ]
                     [ IN { ACCOUNT | DATABASE [ <db_name> ] | SCHEMA [ <schema_name> ] } ]

参数

LIKE 'pattern'

（可选）按对象名称筛选命令输出。筛选器使用 不区分大小写 的模式匹配，并支持 SQL 通配符（% 和 _）。

例如，以下模式返回 相同的 结果：

... LIKE '%testing%' ...
... LIKE '%TESTING%' ...

. 默认：无值（不对输出应用筛选）。

IN ACCOUNT | DATABASE [ db_name ] | SCHEMA [ schema_name ]

（可选）指定命令的范围，该范围确定命令是仅列出当前/指定数据库还是模式中的外部代理。

如果您指定关键字 ACCOUNT，则该命令将检索当前账户的所有数据库中所有架构的记录。

如果您指定关键字 DATABASE，那么：

  • 如果指定 db_name，则该命令将检索指定数据库的所有架构的记录。

  • 如果没有指定 db_name，那么：

    • 如果存在当前数据库，则该命令将检索当前数据库中所有架构的记录。

    • 如果当前没有数据库，则该命令将检索账户中所有数据库和架构的记录。

如果您指定关键字 SCHEMA，那么：

  • 如果指定了限定架构名称（例如，my_database.my_schema），则该命令将检索指定数据库和架构的记录。

  • 如果您指定了未限定的 schema_name，那么：

    • 如果存在当前数据库，则该命令将检索当前数据库中指定架构的记录。

    • 如果当前没有数据库，则该命令会显示错误 SQL compilation error: Object does not exist, or operation cannot be performed。

  • 如果没有指定 schema_name，那么：

    • 如果当前有数据库，那么：

      • 如果当前存在架构，则该命令将检索当前数据库中当前架构的记录。

      • 如果不存在当前架构，则该命令将检索当前数据库中所有架构的记录。

    • 如果当前没有数据库，则该命令将检索账户中所有数据库和所有架构的记录。

默认：取决于会话当前是否正在使用数据库：

  • 数据库：DATABASE 是默认值（即该命令返回您有权在当前数据库中查看的外部代理）。

  • 无数据库：账户范围是默认值（即，该命令返回您在账户中有权查看的外部代理）。

输出

命令输出在以下列中提供外部代理属性和元数据：

列

描述

created_on

创建外部代理时的时间戳。

name

外部代理的名称。

database_name

包含外部代理的数据库。

schema_name

包含外部代理的模式。

owner

拥有外部代理的角色。

comment

对外部代理进行注释。

versions

列出外部代理版本的 JSON 数组。

default_version_name

外部代理的默认版本。

访问控制要求

用于执行此 SQL 命令的 角色 必须至少具有以下 一项 权限：

权限

对象

备注

以下任何一项权限：OWNERSHIP、USAGE

External Agent

对架构中的对象进行操作至少需要父数据库的一项权限和父架构的一项权限。

有关创建具有指定权限集的自定义角色的说明，请参阅 创建自定义角色。

有关对 安全对象 执行 SQL 操作的相应角色和权限授予的一般信息，请参阅 访问控制概述。

使用说明

  • 该命令不需要正在运行的仓库即可执行。

  • 该命令仅返回当前用户的当前角色已获授至少一项访问权限的对象。

  • MANAGE GRANTS 访问权限隐式允许其持有者查看账户中的每个对象。默认情况下，只有账户管理员（具有 ACCOUNTADMIN 角色的用户）和安全管理员（具有 SECURITYADMIN 角色的用户）才具有 MANAGE GRANTS 权限。

  • 要对该命令的输出进行后处理，可以使用 管道运算符 (->>) 或 RESULT_SCAN 函数。这两种构造都将输出视为可以查询的结果集。

    例如，您可使用管道操作符或 RESULT_SCAN 函数，从 SHOW 命令输出中选择特定列或筛选行数据。

    引用输出列时，为列名使用 双引号标识符。例如，选择输出列 type，指定 SELECT "type"。

    必须使用双引号标识符，因为 SHOW 命令的输出列名均为小写格式。双引号确保 SELECT 列表或 WHERE 子句中的列名，与已扫描的 SHOW 命令输出中的列名完全匹配。

示例

列出当前模式中的所有外部代理：

SHOW EXTERNAL AGENTS;

列出特定模式中的外部代理：

SHOW EXTERNAL AGENTS IN SCHEMA mydb.myschema;

列出特定数据库中的外部代理：

SHOW EXTERNAL AGENTS IN DATABASE mydb;

列出账户中的所有外部代理：

SHOW EXTERNAL AGENTS IN ACCOUNT;

列出名称与模式匹配的外部代理：

SHOW EXTERNAL AGENTS LIKE 'my_rag%';