Uri

4 min

Resumo

Interage com serviços da web.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
url - required	string		URL HTTP ou HTTPS no formato (http\|https)://host.domain[:porta]/caminho
dest	path		Um caminho de onde baixar um arquivo (se desejado). Se (dest) for um diretório, o nome de base do arquivo no servidor remoto será usado.
url_username	string		Um nome de usuário para o módulo a ser usado para autenticação Digest, Basic ou WSSE.
url_password	string		Uma senha para o módulo usar para autenticação Digest, Basic ou WSSE.
body	raw		O corpo da solicitação/resposta http para o serviço da web. Se (body_format) for definido como 'json', ele pegará uma string JSON já formatada ou converterá uma estrutura de dados em JSON. Se (body_format) for definido como 'form-urlencoded', ele converterá um dicionário ou lista de tuplas em uma string 'application / x-www-form-urlencoded'.
body_format	raw	Escolhas: - form-urlencoded - json - raw (default)	O formato de serialização do corpo. Quando definido como (json) ou (form-urlencoded), codifica o argumento do corpo, se necessário, e define automaticamente o cabeçalho Content-Type de acordo. É possível sobrescrever o cabeçalho Content-Type, quando definido como (json) ou (form-urlencoded) por meio da opção (headers).
method	string	- GET (default)	O método HTTP da solicitação ou resposta. Em versões mais recentes, não restringimos mais o método no nível do módulo, mas ainda deve ser um método válido aceito pelo serviço que trata da solicitação.
return_content	boolean	Escolhas: - false (default) - true	Se deve ou não retornar o corpo da resposta como uma chave de "conteúdo" no resultado do dicionário. Independentemente desta opção, se o tipo de conteúdo relatado for "application/json", o JSON será sempre carregado em uma chave chamada (json) nos resultados do dicionário.
force_basic_auth	boolean	Escolhas: - false (default) - true	Força o envio do cabeçalho de autenticação básica na solicitação inicial. A biblioteca usada pelo módulo uri só envia informações de autenticação quando um serviço da web responde a uma solicitação inicial com um status 401. Como alguns serviços básicos de autenticação não enviam corretamente um 401, os logins falharão.
follow_redirects	string	Escolhas: - all - none - safe (default) - urllib2	Se o módulo URI deve ou não seguir os redirecionamentos. All seguirá todos os redirecionamentos. Safe seguirá apenas redirecionamentos "seguros", onde "seguro" significa que o cliente está apenas fazendo um GET ou HEAD no URI para o qual está sendo redirecionado. None não seguirá nenhum redirecionamento.
creates	path		Um nome de arquivo, quando já existe, esta etapa não será executada.
removes	path		Um nome de arquivo, quando não existe, esta etapa não será executada.
status_code	list	- [ 200 ] (default)	Uma lista de códigos de status HTTP numéricos válidos que indicam o sucesso da solicitação.
timeout	integer	- 30 (default)	O tempo limite do nível de soquete em segundos.
headers	dictionary		Adicione cabeçalhos HTTP personalizados a uma solicitação no formato de um hash YAML. Fornecendo (Content-Type) aqui irá substituir o cabeçalho gerado fornecendo (json) ou (form-urlencoded) para (body_format).
validate_certs	boolean	Escolhas: - false - true (default)	Se false, os certificados SSL não serão validados. Só deve ser definido como false usado em sites controlados pessoalmente que usam certificados autoassinados.
client_cert	path		Arquivo de cadeia de certificados formatado PEM a ser usado para autenticação de cliente SSL. Este arquivo também pode incluir a chave, e se a chave estiver incluída, client_key não é necessário
client_key	path		Arquivo formatado PEM que contém sua chave privada a ser usada para autenticação de cliente SSL. Se client_cert contém o certificado e a chave, esta opção não é necessária.
src	path		Caminho para o arquivo a ser enviado ao servidor remoto. Não pode ser usado com body.
remote_src	boolean	Escolhas: - false (default) - true	Se false, o módulo pesquisará por src na máquina de origem/mestre. Se true, o módulo usará o caminho src na máquina remota/de destino.
force aliases: thirsty	boolean	Escolhas: - false (default) - true	Se true, não obtenha uma cópia em cache.
use_proxy	boolean	Escolhas: - false - true (default)	Se false, ele não usará um proxy, mesmo se houver um definido em uma variável de ambiente nos hosts de destino.
unix_socket	path		Caminho para o soquete do domínio Unix a ser usado para conexão
http_agent	string	- atmosphere-httpget (default)	Cabeçalho para identificar como geralmente aparece nos logs do servidor da web.

Extende fragmentos da documentação da raíz files

Exemplos

# Exemplo: Obtenha json, esperando o código de status 200 e uma resposta json
- uri:
    url: https://my-json-server.typicode.com/typicode/demo/posts
    method: GET
    return_content: yes

# Exemplo: Obtenha o user-agent de solicitação, esperando o código de status 200 e a resposta json
- uri:
    url: https://httpbin.org/user-agent
    method: GET
    return_content: yes
    headers:
      Content-Type: application/json
      
# Exemplo: Dados POST e, em seguida, retorne-os
- uri:
    url: https://httpbin.org/anything
    method: POST
    return_content: yes
    headers:
      Content-Type: application/json
    body_format: form-urlencoded
    body:
      data: some_data
      params: some_params
      enter: sign_in
      
# Exemplo: Teste de autenticação de URL
- uri:
    url: https://username.carto.com/endpoint/
    method: POST
    force_basic_auth: yes
    body_format: raw
    url_username: username
    url_password: 1234567890123456789012345678901234567890
    status_code: [200, 302]

Valores retornados

Chave	Tipo	Retornado quando	Descrição
elapsed	integer	Sucesso	O número de segundos decorridos durante a realização do download.
msg	string	Sempre	A mensagem HTTP da solicitação.
redirected	boolean	Sucesso	Se a solicitação foi redirecionada.
status	integer	Sempre	O código de status HTTP da solicitação.
url	string	Sempre	O URL real usado para a solicitação.