API 통합 수정하기

API 통합 수정하기 (ALTER API INTEGRATION)

기존 API 통합의 속성을 수정해요.

출처: 문서

본문

Syntax

ALTER [ API ] INTEGRATION [ IF EXISTS ]  SET
  [ API_AWS_ROLE_ARN = '' ]
  [ AZURE_AD_APPLICATION_ID = '' ]
  [ API_KEY = '' ]
  [ ENABLED = { TRUE | FALSE } ]
  [ API_ALLOWED_PREFIXES = ('') ]
  [ API_BLOCKED_PREFIXES = ('') ]
  [ ALLOWED_AUTHENTICATION_SECRETS = ( {  [, , ... ] } ) | all | none ]
  [ COMMENT = '' ]

ALTER [ API ] INTEGRATION  SET TAG  = '' [ ,  = '' ... ]

ALTER [ API ] INTEGRATION  UNSET TAG  [ ,  ... ]

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

Parameters

name

변경할 통합의 식별자예요. 식별자에 공백이나 특수 문자가 포함되어 있으면 전체 문자열을 큰따옴표로 묶어야 해요. 큰따옴표로 묶인 식별자는 대소문자를 구분해요.

SET ...

API 통합에 설정할 하나 이상의 속성/파라미터를 지정해요(공백, 쉼표, 또는 새 줄로 구분해요):

ENABLED = { TRUE | FALSE }

통합의 작동을 시작할지 아니면 일시 중지할지 지정해요.

TRUE는 통합이 실행되도록 허용해요.
FALSE는 유지 관리를 위해 통합을 일시 중지해요. Snowflake와 타사 서비스 간의 모든 통합이 작동하지 않게 돼요.

ALLOWED_AUTHENTICATION_SECRETS = { [, ... ] | all | none }

UDF 또는 프로시저 핸들러 코드가 API_ALLOWED_PREFIXES 값에 있는 Git 리포지토리에 액세스할 때 사용할 수 있는 시크릿을 지정해요. Git 자격 증명을 GIT_CREDENTIALS parameter로 지정할 때 이 목록에서 시크릿을 지정해요.

이 파라미터의 값은 다음 중 하나여야 해요:

나열된 시크릿 중 하나를 허용하려면 하나 이상의 정규화된 Snowflake 시크릿 이름을 사용해요.
(기본값) 모든 시크릿을 허용하려면 all을 사용해요.
시크릿을 허용하지 않으려면 none을 사용해요.

시크릿에 대한 참조 정보는 CREATE SECRET을 참조해요.

API_AWS_ROLE_ARN = ''

iam_role은 클라우드 플랫폼 역할의 ARN(Amazon 리소스 이름)이에요.

이 파라미터는 API_PROVIDER가 aws_api_gateway로 설정된 경우에만 적용돼요.

AZURE_AD_APPLICATION_ID = ''

원격 서비스용 Azure AD(Active Directory) 앱의 "Application (client) id"예요.

이 파라미터는 API_PROVIDER가 azure_api_management로 설정된 경우에만 적용돼요.

API_KEY = ''

API key("subscription key"라고도 불려요).

API_ALLOWED_PREFIXES = ('')

통합을 사용하는 외부 함수가 하나 이상의 HTTPS 프록시 서비스 엔드포인트(예: Amazon AWS API Gateway)와 해당 프록시 내의 리소스를 참조하도록 명시적으로 제한해요. 쉼표로 구분된 URL 목록을 지원하며, 각 URL은 접두사로 처리돼요(자세한 내용은 아래를 참조해요).

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'

통합(integration)에 대한 주석을 지정하는 문자열(리터럴)이에요.

UNSET ...

API 통합에서 설정 해제할 하나 이상의 속성/파라미터를 지정해요. 이렇게 하면 기본값으로 다시 설정돼요:

ENABLED
API_BLOCKED_PREFIXES
TAG tag_name [ , tag_name ... ]
COMMENT

사용 참고 사항

API_PROVIDER는 변경할 수 없어요.
메타데이터 관련:

고객은 Snowflake 서비스를 사용할 때 메타데이터로 개인 데이터(User 객체의 경우 제외), 민감한 데이터, 수출 통제 데이터 또는 기타 규제 대상 데이터를 입력하지 않도록 해야 해요. 자세한 내용은 Snowflake의 메타데이터 필드를 참조해요.

예제

다음 예제는 일시 중지된 통합의 작동을 시작해요:

ALTER API INTEGRATION myint SET ENABLED = TRUE;

API 통합 수정하기