Come faccio ad avere il corpo di una richiesta Web che ha restituito 400 Bad Request da Invoke-RestMethod

Question

Quando eseguo la seguente dichiarazione

Invoke-RestMethod "https://api.mysite.com/the/endpoint" ` 
    -Body (ConvertTo-Json $data) ` 
    -ContentType "application/json" ` 
    -Headers $DefaultHttpHeaders ` 
    -Method Post 

l'endpoint restituisce 400 Bad Request, che provoca PowerShell per mostrare la seguente non-così messaggio -helpful:

Invoke-WebRequest : The remote server returned an error: (400) Bad Request. 
At line:1 char:1 
+ Invoke-WebRequest "https://api.mysite.com/the/endpoint" -Body ... 
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    + CategoryInfo   : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-WebRequest], WebException 
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeWebRequestCommand

Come faccio ad avere il corpo della risposta, che mi potrebbe dire cosa non andava con la richiesta che ho inviato?

Answer 1

In base alla documentazione Invoke-RestMethod, il cmdlet può restituire diversi tipi a seconda del contenuto ricevuto. Assegnare l'output del cmdlet a una variabile ($resp = Invoke-RestMethod (...)) e quindi verificare se il tipo è HtmlWebResponseObject ($resp.gettype()). Quindi avrai a disposizione molte proprietà, come BaseResponse, Content e StatusCode.

Se $resp è un altro tipo (stringa, psobject e molto probabilmente null in questo caso), sembra che il messaggio di errore The remote server returned an error: (400) Bad Request sia il corpo della risposta, solo rimosso da html (l'ho provato su alcuni dei miei metodi), forse persino troncato. Se desideri estrarlo, esegui il cmdlet utilizzando il parametro comune per archiviare il messaggio di errore: Invoke-RestMethod (...) -ErrorVariable RespErr e lo avrai nella variabile $RespErr.

EDIT:

Ok, ho capito ed era abbastanza ovvio :). Invoke-RestMethod genera un errore, così lascia solo prenderlo:

try{$restp=Invoke-RestMethod (...)} catch {$err=$_.Exception} 
$err | Get-Member -MemberType Property 

    TypeName: System.Net.WebException 

    Name   MemberType Definition 
    ----   ---------- ---------- 
    Message  Property string Message {get;} 
    Response  Property System.Net.WebResponse Response {get;} 
    Status   Property System.Net.WebExceptionStatus Status {get;} 

Ecco tutto ciò che serve, soprattutto in oggetto WebResponse. Ho elencato 3 proprietà che catturano l'attenzione, c'è di più. Inoltre, se si memorizza $_ anziché $_.Exception, è possibile che alcune proprietà PowerShell siano già state estratte per l'utente, ma non mi aspetto nulla di più significativo rispetto a .Exception.Response.

Answer 2

C'è un problema noto con PowerShell Invoke-WebRequest e Invoke-RestMethod in cui la shell mangia il corpo della risposta quando il codice di stato è un errore (4xx o 5xx). Sembra che il contenuto JSON che stai cercando stia evaporando proprio in questo modo. È possibile recuperare il corpo della risposta nel blocco catch utilizzando $_.Exception.Response.GetResponseStream()

try { 
    Invoke-RestMethod "https://api.mysite.com/the/endpoint" ` 
     -Body (ConvertTo-Json $data) ` 
     -ContentType "application/json" ` 
     -Headers $DefaultHttpHeaders ` 
     -Method Post 
    } 
    catch { 
     $streamReader = [System.IO.StreamReader]::new($_.Exception.Response.GetResponseStream()) 
     $ErrResp = $streamReader.ReadToEnd() | ConvertFrom-Json 
     $streamReader.Close() 
    } 

    $ErrResp 

Answer 3

$ RespErr avrà i maggiori dettagli sulla BadRequest nel mio caso la sua

$responce = Invoke-RestMethod -Uri https://localhost:44377/explore/v2/Content -Method Post -Body $PostData -Headers $header -ErrorVariable RespErr; 

$ RespErr;

{ "error":{ "code":"","message":"The FavoriteName field is required." } } 

Sembra che funzioni solo in localhost, ho provato con il mio server attuale che non ha funzionato.

un altro modo per provare è questo

try{ 
$response = "" 
$response = Invoke-WebRequest -Uri https://contentserverint-mhdev.azurewebsites.net/apis/explore/v2/Content?overwrite=true -Method Post -Body $PostData -Headers $header -ErrorVariable RespErr 
#$response = Invoke-RestMethod -Uri https://localhost:44377/explore/v2/Content?overwrite=true -Method Post -Body $PostData -Headers $header -ErrorVariable RespErr 
Write-Host "Content created with url="$response.value[0] 

} 
catch [System.Net.WebException] { 
     $respStream = $_.Exception.Response.GetResponseStream() 
     $reader = New-Object System.IO.StreamReader($respStream) 
     $respBody = $reader.ReadToEnd() | ConvertFrom-Json 
     $respBody; 
}