DESCRIBE SERVICE

描述 Snowpark Container Services 服务 (包括作业服务)。将此命令用于服务和像作业一样运行的服务。

DESCRIBE 可以缩写为 DESC。

另请参阅:

CREATE SERVICEALTER SERVICEDROP SERVICESHOW SERVICES

语法

DESC[RIBE] SERVICE <name>
Copy

参数

name

指定要描述的服务的标识符。

如果标识符包含空格或特殊字符,则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。

有关更多信息,请参阅 标识符要求

输出

命令输出在以下列中提供服务属性和元数据:

描述

name

Snowpark Container Services 服务名称。

status

以下各值之一,表示服务的当前状态:

  • PENDING

  • RUNNING

  • FAILED

  • DONE

  • SUSPENDING

  • SUSPENDED

  • DELETING

  • DELETED

  • INTERNAL_ERROR

database_name

在其中创建服务的数据库。

schema_name

在其中创建服务的架构。

owner

拥有服务的角色。

compute_pool

Snowflake 在其中运行服务的计算池的名称。

spec

服务规范文件。仅当您在执行命令时使用服务的所有者角色时,输出才包含此列。

dns_name

Snowflake 为服务分配的 DNS 名称,格式如下:service-name.unique-id.svc.spcs.internal

unique-id 是一个 4-8 个字符长的字母数字标识符,唯一对应于数据库架构的特定实例。要查找架构的唯一 ID,请调用 SYSTEM$GET_SERVICE_DNS_DOMAIN 函数。例如:

SELECT SYSTEM$GET_SERVICE_DNS_DOMAIN('mydb.myschema');
Copy

请注意以下事项:

  • 如果您重命名一个架构,标识符保持不变。

  • 如果您删除并重新创建一个具有相同名称的架构,标识符将会改变。

DNS 名称支持服务到服务的通信(请参阅 教程 3)。

current_instances

服务的当前实例数。

target_instances

Snowflake 确定的应运行的服务实例的目标数量。

current_instances 值与 target_instances 值不相等时,Snowflake 正在关闭或启动服务实例。

例如:

  • 假设您创建了一个服务,其中 MIN_INSTANCES = 1,MAX_INSTANCES = 3。在服务运行时,Snowflake 可能确定一个实例是不够的。在这种情况下,target_instances 的值将增加,表明 Snowflake 正在启动其他实例。

    target_instances 值也可能小于 current_instances 值,这表明 Snowflake 正在减少运行实例的数量。

  • 如果您创建服务,但计算池没有容量来满足您请求的最小实例数,则 target_instances 的值将等于 min_instances 的值。current_instances 的值将小于 target_instances 的值。

min_instances

Snowflake 应该运行的最小服务实例数。

max_instances

Snowflake 在需要时可以扩展的最大服务实例数。

auto_resume

如果为 true,则在调用服务函数或收到传入请求 (ingres) 时,Snowflake 会自动恢复已暂停的服务(请参阅 使用服务)。

external_access_integrations

与服务相关联的外部访问集成的列表。有关更多信息,请参阅 配置网络出口

created_on

服务的创建时间戳。

updated_on

服务的上次更新时间戳。

resumed_on

服务的上次恢复时间戳。

comment

服务的相关注释。

owner_role_type

拥有对象的角色类型是 ROLE 或 DATABASE_ROLE。

query_warehouse

当服务容器连接到 Snowflake 以执行查询,但未显式指定要使用的仓库时,Snowflake 默认使用该仓库。

is_job

如果服务是作业服务,则为 true,否则为 false

spec_digest

代表服务规范内容的唯一且不可变的标识符。

为了观察 spec_digest 列的值随时间的变化,服务用户可能会定期执行 SHOW SERVICES 命令。如果服务用户注意到值发生变化,则可以推断服务已升级。

is_upgrading

如果 Snowflake 正在升级服务,则为 TRUE。

managing_object_domain

管理对象的域(例如,管理服务的笔记本的域)。如果服务不受 Snowflake 实体管理,则为 NULL。

managing_object_name

管理对象的名称(例如,管理服务的笔记本的名称)。如果服务不受 Snowflake 实体管理,则为 NULL。

访问控制要求

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

权限

对象

备注

MONITOR

服务

请注意,对架构中的对象进行操作还需要对父数据库和架构具有 USAGE 权限。

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

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

使用说明

  • 若要对此命令的输出进行后处理,可以使用 RESULT_SCAN 函数,该函数会将输出视为可查询的表。

示例

以下示例描述名为 my_service_with_ebs_volume 的服务:

DESCRIBE SERVICE my_service_with_ebs_volume;
Copy
+--------------+---------+---------------+-------------+-----------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-------------------+------------------+---------------+---------------+-------------+------------------------------+-------------------------------+-------------------------------+------------+---------+-----------------+-----------------+--------+------------------------------------------------------------------+--------------+------------------------+----------------------+
| name         | status  | database_name | schema_name | owner     | compute_pool          | spec                                                                                                                                                            | dns_name                            | current_instances | target_instances | min_instances | max_instances | auto_resume | external_access_integrations | created_on                    | updated_on                    | resumed_on | comment | owner_role_type | query_warehouse | is_job | spec_digest                                                      | is_upgrading | managing_object_domain | managing_object_name |
|--------------+---------+---------------+-------------+-----------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-------------------+------------------+---------------+---------------+-------------+------------------------------+-------------------------------+-------------------------------+------------+---------+-----------------+-----------------+--------+------------------------------------------------------------------+--------------+------------------------+----------------------|
| ECHO_SERVICE | RUNNING | TUTORIAL_DB   | DATA_SCHEMA | TEST_ROLE | TUTORIAL_COMPUTE_POOL | ---                                                                                                                                                             | echo-service.fsvv.svc.spcs.internal |                 1 |                1 |             1 |             1 | true        | NULL                         | 2024-08-16 19:05:45.537 -0700 | 2024-08-16 19:05:46.354 -0700 | NULL       | NULL    | ROLE            | NULL            | false  | 58447f146a9591df5a69668f73ea35be9aa1b2829ace05d1c97c6f999246ac31 | false        | NULL                   | NULL                 |
|              |         |               |             |           |                       | spec:                                                                                                                                                           |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   containers:                                                                                                                                                   |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   - name: "echo"                                                                                                                                                |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     image: "preprod8-spcsdocs1.awsuswest2preprod8.registry-dev.snowflakecomputing.cn/tutorial_db/data_schema/tutorial_repository/my_echo_service_image:latest" |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     sha256: "@sha256:e79089e8862f9b90d9114857a38c6954db4701a973e931277900617fcbecd099"                                                                          |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     env:                                                                                                                                                        |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       SERVER_PORT: "8000"                                                                                                                                       |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       CHARACTER_NAME: "Bob"                                                                                                                                     |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     readinessProbe:                                                                                                                                             |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       port: 8000                                                                                                                                                |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       path: "/healthcheck"                                                                                                                                      |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     resources:                                                                                                                                                  |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       limits:                                                                                                                                                   |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |         memory: "6Gi"                                                                                                                                           |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |         cpu: "1"                                                                                                                                                |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |       requests:                                                                                                                                                 |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |         memory: "0.5Gi"                                                                                                                                         |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |         cpu: "0.5"                                                                                                                                              |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   endpoints:                                                                                                                                                    |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |   - name: "echoendpoint"                                                                                                                                        |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     port: 8000                                                                                                                                                  |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |     public: true                                                                                                                                                |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
|              |         |               |             |           |                       |                                                                                                                                                                 |                                     |                   |                  |               |               |             |                              |                               |                               |            |         |                 |                 |        |                                                                  |              |                        |                      |
+--------------+---------+---------------+-------------+-----------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+-------------------+------------------+---------------+---------------+-------------+------------------------------+-------------------------------+-------------------------------+------------+---------+-----------------+-----------------+--------+------------------------------------------------------------------+--------------+------------------------+----------------------+
语言: 中文