Invoke-WebRequest含特殊字符URI致API调用异常的解决方法咨询

你遇到的问题核心是URI中的特殊字符未正确编码。HTTP协议对URI的查询参数有严格的字符规则，像+（会被解析为空格）、&（作为参数分隔符）这类特殊字符直接出现在URI中时，会破坏请求的结构，导致Sophos XG API无法正确解析你的登录凭证或IP主机名称。

我们需要对所有可能包含特殊字符的变量进行URL编码，同时优化CSV读取和API请求的构建方式，确保请求格式完全符合HTTP规范：

1. 对敏感变量进行URL编码 #

使用PowerShell内置的[Uri]::EscapeDataString()方法，将包含特殊字符的变量（如API密码、IP主机名称）转换为URI安全的格式，避免这些字符被HTTP服务器错误解析：

# 编码可能含特殊字符的变量
$encodedPassword = [Uri]::EscapeDataString($_CONTRASEÑA_API)
$encodedHostName = [Uri]::EscapeDataString($_NOMBRE_IP)

2. 重构API请求的XML与URL构建 #

先构建完整的XML请求内容，再将整个XML字符串作为reqxml参数的值进行编码，这样既处理了XML标签的特殊字符，也保证了变量中的特殊字符不会干扰URI结构：

# 构建XML请求体
$xmlRequest = @"
<Request>
  <Login>
    <UserName>$_USUARIO_API</UserName>
    <Password>$encodedPassword</Password>
  </Login>
  <Set>
    <IPHost>
      <Name>$encodedHostName</Name>
      <IPFamily>IPv4</IPFamily>
      <HostType>IP</HostType>
      <IPAddress>$_DIRECCION_IP</IPAddress>
    </IPHost>
  </Set>
</Request>
"@

# 编码整个XML请求作为查询参数值
$encodedXml = [Uri]::EscapeDataString($xmlRequest)

# 构建最终的API URL
$_URL_API = "https://$_IP_FIREWALL:$_PUERTO_FIREWALL/webconsole/APIController?reqxml=$encodedXml"

3. 优化CSV读取方式（可选但推荐） #

原代码用-split ','读取CSV，无法处理字段包含逗号或引号的情况。改用Import-Csv可以更可靠地解析CSV文件，避免因字段格式问题导致的参数错误：

# 读取CSV文件（假设CSV第一行是列名，若没有则添加-Header参数指定列名，例如-Header "NombreIP", "DireccionIP", "Mascara"）
$csvData = Import-Csv -Path "$_RUTA_TRABAJO$_NOMBRE_ARCHIVO_CSV"

foreach ($linea in $csvData) {
    $_NOMBRE_IP = $linea.NombreIP  # 替换为你的CSV实际列名
    $_DIRECCION_IP = $linea.DireccionIP
    # ... 后续编码和API请求逻辑
}

# --------------------- # Creacion IP Host - XG # ---------------------
# Versiones
# 1.0 - Version original
# 1.1 - 修复特殊字符编码问题，优化CSV读取与错误处理
# ---------------------
# Declaracion variables globales
# ------------------------------
$_IP_FIREWALL = "190.80.80.80"
$_PUERTO_FIREWALL = "4444"
$_USUARIO_API = "admin"
$_CONTRASEÑA_API = "SecurePassword+"
$_RUTA_TRABAJO = "c:\Workfolder\IPHostCSV\"
$_NOMBRE_ARCHIVO_CSV = "test.csv"

# Permitir conexiones SSL
# -----------------------
add-type @"
using System.Net;
using System.Security.Cryptography.X509Certificates;
public class TrustAllCertsPolicy : ICertificatePolicy {
    public bool CheckValidationResult(
        ServicePoint srvPoint, X509Certificate certificate,
        WebRequest request, int certificateProblem) {
        return true;
    }
}
"@
[System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy

# Bucle principal
# ---------------
# 使用Import-Csv读取CSV（假设CSV有列名：NombreIP, DireccionIP, Mascara）
$csvData = Import-Csv -Path "$_RUTA_TRABAJO$_NOMBRE_ARCHIVO_CSV"

foreach($linea in $csvData) {
    # Obtencion Parametros CSV
    # ------------------------
    $_NOMBRE_IP = $linea.NombreIP
    $_DIRECCION_IP = $linea.DireccionIP
    $_MASCARA = $linea.Mascara  # 保留供后续扩展使用

    # 编码特殊字符变量
    $encodedPassword = [Uri]::EscapeDataString($_CONTRASEÑA_API)
    $encodedHostName = [Uri]::EscapeDataString($_NOMBRE_IP)

    # 构建XML请求
    $xmlRequest = @"
<Request>
  <Login>
    <UserName>$_USUARIO_API</UserName>
    <Password>$encodedPassword</Password>
  </Login>
  <Set>
    <IPHost>
      <Name>$encodedHostName</Name>
      <IPFamily>IPv4</IPFamily>
      <HostType>IP</HostType>
      <IPAddress>$_DIRECCION_IP</IPAddress>
    </IPHost>
  </Set>
</Request>
"@

    # 编码XML为URI安全格式
    $encodedXml = [Uri]::EscapeDataString($xmlRequest)

    # Consulta API
    # ------------
    echo "[INFO] Procesando Host: $($_NOMBRE_IP) IP: $($_DIRECCION_IP)"
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
    $_URL_API = "https://$_IP_FIREWALL:$_PUERTO_FIREWALL/webconsole/APIController?reqxml=$encodedXml"
    
    try {
        $_RESULTADO_API = Invoke-WebRequest -Uri "$_URL_API"
        [xml] $_CODIGO_XML = $_RESULTADO_API.Content

        # Revision Resultados
        # -------------------
        if($_CODIGO_XML.Response.IPHost.Status.code -eq 200) {
            echo "[ OK ] CODIGO: $($_CODIGO_XML.Response.IPHost.Status.code) - Procesado OK"
            $_NOMBRE_IP | Out-File -Append -Encoding utf8 -FilePath "$($_RUTA_TRABAJO)OK.txt"
        } else {
            echo "[WARN] CODIGO: $($_CODIGO_XML.Response.IPHost.Status.code) - Problema en la ejecuccion $($_CODIGO_XML.Response.IPHost.Status.'#text')"
            $_NOMBRE_IP | Out-File -Append -Encoding utf8 -FilePath "$($_RUTA_TRABAJO)NO_OK.txt"
        }
    } catch {
        echo "[ERROR] Fallo en la llamada API para $_NOMBRE_IP : $($_.Exception.Message)"
        $_NOMBRE_IP | Out-File -Append -Encoding utf8 -FilePath "$($_RUTA_TRABAJO)NO_OK.txt"
    }
}

• [Uri]::EscapeDataString()会将所有非URI安全字符转换为%XX格式的编码（比如+→%2B，&→%26），确保HTTP服务器能正确解析这些字符的原始含义。
• 先构建XML再编码整个请求体，避免了XML标签（如<、>）和变量特殊字符的双重干扰，保证请求结构完全符合Sophos XG API的要求。

内容的提问来源于stack exchange，提问作者Antonio Cienfuegos