Parâmetros de consulta padrão

É possível usar os parâmetros de consulta a seguir com todos os métodos e recursos da Google Cloud Deployment Manager V2 API.

Os parâmetros de consulta aplicáveis a todas as operações da Google Cloud Deployment Manager V2 API são mostrados na tabela abaixo.

Observações sobre chaves de API e tokens de autenticação:

  1. O parâmetro key é obrigatório em todas as solicitações, a menos que você forneça um token do OAuth 2.0 com a solicitação.
  2. É obrigatório enviar um token de autorização com as solicitações que exigem um escopo do OAuth. O OAuth 2.0 é o único protocolo de autorização aceito.
  3. Há duas maneiras de fornecer um token do OAuth 2.0 com uma solicitação:
    • usando o parâmetro de consulta access_token assim: ?access_token=oauth2-token
    • usando o cabeçalho HTTP Authorization assim: Authorization: Bearer oauth2-token

Todos os parâmetros são opcionais, exceto onde indicado de outra forma.

Parâmetro Significado Observações
access_token O token do OAuth 2.0 para o usuário atual.
callback Função de retorno de chamada.
  • Nome da função de retorno de chamada do JavaScript usado para processar a resposta.
  • Parâmetro usado nas solicitações JSON-P do JavaScript.
fields Seletor que especifica um subconjunto de campos a ser incluído na resposta.
  • Para mais informações, consulte a documentação sobre resposta parcial.
  • Para mais desempenho, use esse parâmetro.
key Chave de API. (OBRIGATÓRIO*)
  • *Esse parâmetro é obrigatório a menos que você forneça um token do OAuth 2.0.
  • A Chave de API é usada para identificar o projeto, além de fornecer cotas, relatórios e acesso à API.
  • Encontre a Chave de API do projeto no Console do Google Cloud Platform.
prettyPrint

Retorna uma resposta com recuos e quebras de linha.
  • A resposta é retornada em um formato legível se o parâmetro está configurado como true.
  • Valor padrão: true.
  • Quando o parâmetro está configurado como false, o tamanho do payload da resposta pode ser reduzido, melhorando o desempenho em alguns ambientes.
quotaUser Alternativa para userIp.
  • Com esse parâmetro, force cotas por usuário de um aplicativo no servidor mesmo quando o endereço IP do usuário não é conhecido. Isso pode ocorrer, por exemplo, com aplicativos que executam cron jobs no App Engine em nome de um usuário.
  • Escolha qualquer string arbitrária que identifique um usuário de maneira exclusiva e tenha até 40 caracteres.
  • Substitui userIp se ambos são fornecidos.
  • Saiba mais sobre como Limitar a utilização da API.
userIp Endereço IP do usuário final para o qual a chamada de API está sendo feita.