ALTER API INTEGRATION

Modifica as propriedades de uma integração de API existente.

Consulte também:

CREATE API INTEGRATION , DROP INTEGRATION , SHOW INTEGRATIONS

Sintaxe

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

Parâmetros

name

O identificador da integração a ser alterada. Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

SET ...

Especifica uma ou mais propriedades/parâmetros a serem definidos para integração de API (separados por espaços em branco, vírgulas ou novas linhas):

ENABLED = TRUE | FALSE

Especifica se deve iniciar a operação da integração ou suspendê-la.

  • TRUE permite que a integração seja executada.

  • FALSE suspende a integração para manutenção. Qualquer integração entre o Snowflake e um serviço de terceiro não funciona.

API_AWS_ROLE_ARN = '<iam_role>'

O iam_role é o ARN (nome do recurso da Amazon) de uma função de plataforma em nuvem.

Este parâmetro se aplica somente se o API_PROVIDER estiver definido como aws_api_gateway.

AZURE_AD_APPLICATION_ID = '<azure_application_id>'

A “ID do aplicativo (cliente)” do aplicativo Azure AD (Active Directory) para seu serviço remoto.

Este parâmetro se aplica somente se o API_PROVIDER estiver definido como azure_api_management.

API_KEY = '<api_key>'

A chave API (também chamada de «chave de assinatura»).

API_ALLOWED_PREFIXES = ('<...>')

Limita explicitamente as funções externas que utilizam a integração para referenciar um ou mais pontos de extremidade do serviço de proxy HTTPS (por exemplo, Amazon AWS API Gateway) e recursos dentro desses proxies. Oferece suporte a uma lista de URLs separada por vírgulas, que são tratados como prefixos (para detalhes, consulte abaixo).

Cada URL em API_ALLOWED_PREFIXES = (...) é tratado como um prefixo. Por exemplo, se você especificar:

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

isso significa que todos os recursos em

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

são permitidos. Por exemplo, é permitido o seguinte:

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

Para maximizar a segurança, você deve restringir os locais permitidos de maneira mais precisa e prática possível.

API_BLOCKED_PREFIXES = ('<...>')

Lista os pontos de extremidade e recursos no serviço de proxy HTTPS que não podem ser chamados do Snowflake.

Os valores possíveis para locais seguem as mesmas regras de API_ALLOWED_PREFIXES acima.

API_BLOCKED_PREFIXES tem precedência sobre API_ALLOWED_PREFIXES. Se um prefixo corresponder a ambos, então ele é bloqueado. Em outras palavras, o Snowflake permite todos os valores que correspondem a API_ALLOWED_PREFIXES exceto valores que também correspondem a API_BLOCKED_PREFIXES.

Se um valor estiver fora de API_ALLOWED_PREFIXES, você não precisa bloqueá-lo explicitamente.

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

Especifica o nome da tag e o valor da cadeia de caracteres dela.

O valor de tag é sempre uma cadeia de caracteres, e o número máximo de caracteres do valor da tag é 256.

Para obter detalhes sobre como especificar tags em uma instrução, consulte Cotas de tags para objetos e colunas.

COMMENT = 'string_literal'

Cadeia de caracteres (literal) que especifica um comentário da integração.

UNSET ...

Especifica uma ou mais propriedades/parâmetros a serem desativados para a integração API, o que os restaura aos seus padrões:

  • ENABLED

  • API_BLOCKED_PREFIXES

  • TAG tag_name [ , tag_name ... ]

  • COMMENT

Notas de uso

  • O API_PROVIDER não pode ser alterado.

  • Em relação aos metadados:

    Atenção

    Os clientes devem garantir que nenhum dado pessoal (exceto para um objeto do usuário), dados sensíveis, dados controlados por exportação ou outros dados regulamentados sejam inseridos como metadados ao usar o serviço Snowflake. Para obter mais informações, consulte Campos de metadados no Snowflake.

Exemplos

O exemplo a seguir inicia a operação de uma integração suspensa:

ALTER API INTEGRATION myint SET ENABLED = TRUE;
Copy