jayeshmahajan/cloud-devops-api

Devops API：TCP与HTTP/HTTPS连接测试镜像

镜像概述

本镜像提供一个基于Flask的API服务，用于检查TCP和HTTP/HTTPS协议的网络连接。它能执行DNS解析、尝试建立连接，并以JSON格式返回详细结果，适用于DevOps环境中的网络连通性测试与故障排查。

核心功能和特性

• TCP连接检查：验证与指定域名和端口建立TCP连接的能力
• HTTP/HTTPS连接检查：验证与指定域名建立HTTP/HTTPS连接的能力
• DNS解析：提供包含CNAME和所有解析IP地址的详细DNS信息
• 格式化JSON响应：以可读的JSON格式返回结果
• SSL错误处理：捕获并返回详细的SSL错误信息
• 速率限制：通过速率限制防止应用服务器因意外过载受到***

使用场景

• DevOps环境中的服务连通性验证
• 自动化部署流程中的网络前置检查
• 微服务架构下跨服务通信测试
• 网络故障排查时的连接诊断工具
• CI/CD管道中的网络可用性检测

使用方法

基本用法

启动服务后，通过HTTP GET请求调用API端点进行连接检查。

TCP连接检查

端点：/check_connection
方法：GET
参数：

• domain：目标域名（必填）
• port：目标端口（必填）
• timeout：连接超时时间（可选，默认10秒）

示例请求：

bash
curl 'http://127.0.0.1:8080/check_connection?port=80&domain=example.com'

成功响应：

json
{
    "message": "TCP connection successful",
    "dns_result": {
        "cname": null,
        "ips": [
            "93.184.215.14"
        ]
    }
}

HTTP/HTTPS连接检查

端点：/check_http_connection
方法：GET
参数：

• domain：目标域名（必填）
• protocol：协议类型（可选，http/https，默认https）
• timeout：连接超时时间（可选，默认10秒）

示例请求：

bash
curl 'http://127.0.0.1:8080/check_http_connection?domain=www.google.com'

成功响应：

json
{
    "message": "HTTP connection successful",
    "dns_result": {
        "cname": null,
        "ips": [
            "142.250.81.238"
        ]
    }
}

错误处理

API会处理各类错误并返回详细信息，常见错误类型包括：

• DNS解析错误：DNS解析失败时返回
• TCP连接错误：无法建立TCP连接时返回
• HTTP/HTTPS连接错误：HTTP/HTTPS连接失败（含SSL错误）时返回

错误响应示例：

json
{
    "error": "DNS resolution failed: A DNS label is empty."
}

Docker部署示例

基本部署

bash
docker run -d -p 8080:8080 --name devops-connection-api [镜像名称]

Docker Compose配置

yaml
version: '3'
services:
  connection-api:
    image: [镜像名称]
    ports:
      - "8080:8080"
    restart: always
    environment:
      - RATE_LIMIT=100  # 可选，设置速率限制（请求/分钟）