red · Referencia de comando

`qzx checkUrlStatus`

Qué hace

Consulta una URL HTTP y devuelve código de estado, tiempo de respuesta y cabeceras básicas.

Comando canónico: checkUrlStatus

Alias aceptados: Ninguno

Distingue mayúsculas: no

Incluido en el paquete publicado

Disponible en PyPI 0.2.2.0.2. La documentación corresponde al checkout alpha 0.2.2.0.2.

Seguridad y efectos

Solo lectura según la clasificación actual

Sin parámetro dry-run documentado

No invoca programas nativos según la clasificación

Puede usar la red

No requiere elevación de forma inherente

Esta clasificación de seguridad se revisó contra el digest de implementación sha256:135d95179bbfe6e9a2d631b8e025b864689e4aeded2ee385e8ce06ebb67070e0 el 2026-07-24.

Sintaxis exacta

qzx checkUrlStatus <url> [timeout] --json

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
url	str	Sí	No declarado	Target URL to check (e.g., https://api.github.com)
timeout	float	No	5	Request timeout in seconds (default: 5.0)

Ejemplos de entrada

qzx checkUrlStatus https://api.github.com

Verify if GitHub API is accessible and check response times

qzx checkUrlStatus https://httpbin.org/status/404 3.0

Check a URL with a custom 3-second timeout

Para obtener la carga estructurada completa, añade --json: qzx checkUrlStatus <url> [timeout] --json

Ejemplo de salida representativa

Este JSON ilustrativo deriva del contrato de resultado respaldado por la implementación actual. Muestra lo que el comando puede devolver sin afirmar que es una ejecución grabada; los valores varían según entradas, equipo, permisos y herramientas opcionales.

Comando del ejemplo: qzx checkUrlStatus https://api.github.com --json

{
    "success": true,
    "message": "Pings an HTTP URL, returning its status code, response time, and basic headers. In this illustrative example, the command completed successfully.",
    "headers": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "is_online": true,
    "reason": "Example value",
    "response_time_ms": [
        {
            "name": "example",
            "status": "ok"
        }
    ],
    "status_code": "Example value",
    "url": "https://example.com"
}

Ver el contrato de resultado JSON

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "error": {
            "type": "string"
        },
        "headers": [],
        "is_online": [],
        "reason": [],
        "response_time_ms": [],
        "status_code": [],
        "url": []
    },
    "additionalProperties": true
}

Errores y límites

El contrato público exige success=false y un message descriptivo en fallos. Este catálogo aún no declara una taxonomía de errores específica para cada comando; revisa el resultado y no infieras códigos inexistentes.

QZX está en alpha. Dependencias opcionales, permisos y capacidades del host pueden cambiar el resultado.

Flujo de evidencia: requiere un endpoint autorizado o una fixture revisada.

Evidencia y procedencia

Implementación: src/qzx/commands/network/check_url_status.py
Pruebas: tests/test_network_commands/test_check_url_status.py
Canal de documentación: Documentación de desarrollo 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Disponibilidad: 0.2.2.0.2 o anterior

Sigue explorando

Estos comandos también pertenecen a la categoría de red. Compáralos para elegir la operación que mejor resuelva tu tarea.

Explorar todos los comandos de QZX