ALTER API INTEGRATION

既存の API 統合のプロパティを変更します。

こちらもご参照ください。

CREATE API INTEGRATION 、 DROP INTEGRATION 、 SHOW INTEGRATIONS

構文

ALTER [ API ] INTEGRATION [ IF EXISTS ] <name> SET
  [ API_AWS_ROLE_ARN = '<iam_role>' ]
  [ AZURE_AD_APPLICATION_ID = '<azure_application_id>' ]
  [ API_KEY = '<api_key>' ]
  [ ENABLED = { TRUE | FALSE } ]
  [ API_ALLOWED_PREFIXES = ('<...>') ]
  [ API_BLOCKED_PREFIXES = ('<...>') ]
  [ COMMENT = '<string_literal>' ]

ALTER [ API ] INTEGRATION <name> SET TAG <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' ... ]

ALTER [ API ] INTEGRATION <name> UNSET TAG <tag_name> [ , <tag_name> ... ]

ALTER [ API ] INTEGRATION [ IF EXISTS ] <name>  UNSET {
                                                      API_KEY              |
                                                      ENABLED              |
                                                      API_BLOCKED_PREFIXES |
                                                      COMMENT
                                                      }
                                                      [ , ... ]
Copy

パラメーター

name

変更する統合の識別子。識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

SET ...

API 統合用に設定する1つ以上のプロパティ/パラメーターを指定します（空白、コンマ、または改行で区切られます）。

ENABLED = TRUE | FALSE

統合の操作を開始するか、中断するかを指定します。

  • TRUE は、統合の実行を許可します。

  • FALSE は、メンテナンスのために統合を中断します。Snowflakeとサードパーティサービス間の統合はいずれも機能しません。

API_AWS_ROLE_ARN = '<iam_role>'

iam_role は、クラウドプラットフォームのロールの ARN（Amazonリソースネーム）です。

このパラメーターは、 API_PROVIDER が aws_api_gateway に設定されている場合にのみ適用されます。

AZURE_AD_APPLICATION_ID = '<azure_application_id>'

リモートサービス用Azure AD （Active Directory）アプリの「アプリケーション（クライアント）ID」。

このパラメーターは、 API_PROVIDER が azure_api_management に設定されている場合にのみ適用されます。

API_KEY = '<api_key>'

APIキー （別名「サブスクリプションキー」）。

API_ALLOWED_PREFIXES = ('<...>')

統合を使用して1つ以上の HTTPS プロキシサービスエンドポイント（例：Amazon AWS API Gateway）、およびそれらのプロキシ内のリソースを参照する外部関数を明示的に制限します。プレフィックスとして扱われる URLs のコンマ区切りリストをサポートします（詳細については、以下を参照）。

API_ALLOWED_PREFIXES = (...) の各 URL はプレフィックスとして扱われます。たとえば、次のように指定したとします。

https://xyz.amazonaws.com/production/

つまり、すべてのリソースが

https://xyz.amazonaws.com/production/

許可されています。たとえば、次は許可されています。

https://xyz.amazonaws.com/production/ml1

セキュリティを最大化するには、許可される場所を実用範囲内でできるだけ狭く制限する必要があります。

API_BLOCKED_PREFIXES = ('<...>')

Snowflakeからの呼び出しが許可されていない HTTPS プロキシサービスのエンドポイントとリソースを一覧表示します。

場所の可能な値は、上記の API_ALLOWED_PREFIXES の場合と同じルールに従います。

API_BLOCKED_PREFIXES API_ALLOWED_PREFIXES よりも優先されます。プレフィックスが両方に一致する場合は、ブロックされます。つまりSnowflakeでは、 API_ALLOWED_PREFIXES に一致するすべての値が許可されます。ただし、値が API_BLOCKED_PREFIXES にも一致する場合は 除外 されます。

値が API_ALLOWED_PREFIXES の外にある場合は、明示的にブロックする必要はありません。

TAG tag_name = 'tag_value' [ , tag_name = 'tag_value' , ... ]

タグ の名前とタグ文字列の値を指定します。

タグ値は常に文字列であり、タグ値の最大文字数は256です。

ステートメントでのタグの指定に関する情報については、 オブジェクトおよび列のタグクォータ をご参照ください。

COMMENT = 'string_literal'

統合のコメントを指定する文字列（リテラル）。

UNSET ...

API 統合の設定を解除する1つ以上のプロパティ/パラメーターを指定し、それらをデフォルトにリセットします。

  • ENABLED

  • API_BLOCKED_PREFIXES

  • TAG tag_name [ , tag_name ... ]

  • COMMENT

使用上の注意

  • API_PROVIDER は変更できません。

  • メタデータについて。

    注意

    Snowflakeサービスを使用する場合、お客様は、個人データ（ユーザーオブジェクト向け以外）、機密データ、輸出管理データ、またはその他の規制されたデータがメタデータとして入力されていないことを確認する必要があります。詳細については、 Snowflakeのメタデータフィールド をご参照ください。

例

次の例では、中断された統合の操作を開始します。

ALTER API INTEGRATION myint SET ENABLED = TRUE;
Copy
言語: 日本語