アプリ仕様を使用した外部アクセス統合のリクエスト（EAIs）¶

アプリからの外部エンドポイントへのアクセス¶

To access an external endpoint, an app must create a network rule and an EAI, which uses network rules to restrict access to specific external network locations. Network rules define the external endpoints that an app can access.

To configure an app to use an EAI, follow these steps:

• To request privileges from the consumer to create an EAI, use automated granting of privileges.

• Add an EAI to an app.

• アプリケーション仕様 を使用して、コンシューマーに外部エンドポイントへの接続許可をリクエストします。

App specification workflow for an EAI¶

1. Providers configure automated granting of privileges for the app. This allows consumers to give permission to an app to create the EAI.

   注釈

   アプリの仕様ではマニフェストファイルで manifest_version = 2 に設定します。

2. プロバイダーは、マニュフェストファイルに CREATE EXTERNAL ACCESS INTEGRATION 権限 を追加します。

3. Providers add SQL statements to the setup script to create the following objects:

   • ネットワークルール

   • :doc:` 外部アクセス統合 </sql-reference/sql/create-external-access-integration>`

   • ジョブ仕様

   The setup script creates the app specification and other objects when the app is installed or upgraded or at runtime.

4. アプリを構成するとき、コンシューマーはホストポートおよびその他の外部サービスを承認します。コンシューマーがアプリ仕様を表示し、承認する方法については、アプリの仕様を使用した外部リソースへの接続の承認 をご参照ください。

App specification definition for an EAI¶

The app specification definition for an EAI contains the following entries:

• HOST_PORTS:アプリが必要とするネットワークルールで定義されているホストポートのリスト。

• PRIVATE_HOST_PORTS:Snowflake外部のリソースへのプライベート接続を許可するプライベートホストポートのリスト。

マニフェストファイルのバージョンを指定します。¶

• To enable automated granting of privileges for an app, set the version at the beginning of the manifest file, as shown in the following example:

  manifest_version: 2
  

  Copy

マニフェストファイルに CREATEEXTERNALACCESSINTEGRATION に対する権限を追加します¶

The CREATE EXTERNAL ACCESS INTEGRATION privilege allows the app to create an external access integration during installation or upgrade.

• To configure an app to request the CREATE EXTERNAL ACCESS INTEGRATION privilege, add the following code to the privileges section of the manifest file:

  manifest_version: 2
  ...
  privileges:
    - CREATE EXTERNAL ACCESS INTEGRATION:
        description: "Allows the app to create an EAI to connect to an external service."
  ...
  

  Copy

If you set the manifest_version to 2 in the manifest file, Snowflake automatically grants the CREATE EXTERNAL ACCESS INTEGRATION privilege to the app during installation or upgrade.

Add a network rule and an EAI to the setup script¶

EAIs are the Snowflake objects that enable access to specific external network locations and contain a list of network rules that specify the external locations that an app can access.

• アプリのネットワークルールを作成するには、次の例に示すようにセットアップスクリプトに CREATE NETWORK RULE コマンドを追加します。

  CREATE OR REPLACE NETWORK RULE setup.my_network_rule
  TYPE = HOST_PORT
  VALUE_LIST = ( 'example.com' )
  MODE = EGRESS;
  

  Copy

The HOST_PORT and VALUE_LIST properties indicate that the network rule must point to a valid domain, port, or range of ports. When an app is installed or upgraded, consumers grant permission for the app to use these domains or ports.

Create an EAI¶

• To create an EAI for an app, add the CREATE EXTERNAL ACCESS INTEGRATION command to the setup script, as shown in the following example:

  CREATE OR REPLACE EXTERNAL ACCESS INTEGRATION my_app_prefix_eai_rule
    ALLOWED_NETWORK_RULES = (setup.my_network_rule)
    ENABLED = TRUE;
  

  Copy

Creating a user-defined function to access the external endpoint¶

After the EAI is created, the setup script can create user-defined functions and stored procedures that use it to connect to the endpoints defined in the network rule.

The following example shows a user-defined function that uses the my_app_prefix_eai_rule EAI:

CREATE OR REPLACE FUNCTION setup.EXTERNAL_ACCESS_UDF(hostname STRING)
  RETURNS STRING
  LANGUAGE JAVA
  HANDLER='TestHostNameLookup.compute'
  EXTERNAL_ACCESS_INTEGRATIONS = (my_app_prefix_eai_rule)
  AS
  '
      import java.net.InetAddress;
      import java.net.UnknownHostException;
      class TestHostNameLookup {{
          public static String compute(String hostname) throws Exception {{
              InetAddress addr = null;
              try {
                  addr = InetAddress.getByName(hostname);
              } catch(UnknownHostException ex) {
                  return "Hostname lookup failed";
              }
              return "Hostname lookup successful";
          }
      }
';
GRANT USAGE ON FUNCTION setup.EXTERNAL_ACCESS_UDF(STRING)
  TO APPLICATION ROLE app_public;

This function sets the value of the EXTERNAL_ACCESS_INTEGRATIONS to the EAI created previously.

This function uses the InetAddress Java package to look up the hostname passed to the procedure. The hostname provided must match one of the values provided in the VALUE_LIST property of the network rules used by the EAI.

Creating an app specification for an EAI¶

The following example shows how to create an app specification for an EAI:

ALTER APPLICATION SET SPECIFICATION eai_app_spec
  TYPE = EXTERNAL_ACCESS
  LABEL = 'Connection to an external API'
  DESCRIPTION = 'Access an API that exists outside Snowflake'
  HOST_PORTS = ('example.com')

This command creates an app specification named eai_app_spec.

コンシューマーアカウントでアプリ仕様を承認する¶

After the provider configures the app to create the network rule, EAI, and app specification, consumers can view the app specification and approve or decline it as appropriate when configuring the app. For more information, see アプリの仕様を使用した外部リソースへの接続の承認.