🚀 Netskope API 文档

本 API 文档提供了 Netskope 系统中各类资源的管理、监控、搜索等功能的接口说明，涵盖用户、发布商、策略等多个方面，方便开发者进行系统集成和功能扩展。

📚 详细文档

用户管理

listUsers

• 描述：列出所有用户
• 请求方法：GET
• 路径：/users
• 参数：
  • fields：可选的逗号分隔字段列表（如 name, email, role）
• 响应：

{
    "status": "success",
    "data": {
        "users": [
            {
                "id": "string",
                "name": "string",
                "email": "string",
                "role": "string"
            }
        ],
        "pagination": {
            "page": integer,
            "pageSize": integer,
            "totalPages": integer,
            "totalItems": integer
        }
    }
}

createUser

• 描述：创建新用户
• 请求方法：POST
• 路径：/users
• 请求体：

{
    "name": "string",
    "email": "string",
    "role": "string"
}

updateUser

• 描述：更新现有用户
• 请求方法：PUT
• 路径：/users/{userId}
• 请求体：

{
    "name": "string",
    "email": "string",
    "role": "string"
}

deleteUser

• 描述：删除用户
• 请求方法：DELETE
• 路径：/users/{userId}

发布商管理

listPublishers

• 描述：列出所有发布商
• 请求方法：GET
• 路径：/publishers
• 参数：
  • fields：可选的逗号分隔字段列表（如 name, status, region）
• 响应：

{
    "status": "success",
    "data": {
        "publishers": [
            {
                "id": "string",
                "name": "string",
                "status": "active" | "inactive",
                "region": "string"
            }
        ],
        "pagination": {
            "page": integer,
            "pageSize": integer,
            "totalPages": integer,
            "totalItems": integer
        }
    }
}

createPublisher

• 描述：创建新发布商
• 请求方法：POST
• 路径：/publishers
• 请求体：

{
    "name": "string",
    "status": "active" | "inactive",
    "region": "string"
}

updatePublisher

• 描述：更新现有发布商
• 请求方法：PUT
• 路径：/publishers/{publisherId}
• 请求体：

{
    "name": "string",
    "status": "active" | "inactive",
    "region": "string"
}

deletePublisher

• 描述：删除发布商
• 请求方法：DELETE
• 路径：/publishers/{publisherId}

策略管理

listPolicies

• 描述：列出所有策略
• 请求方法：GET
• 路径：/policies
• 参数：
  • fields：可选的逗号分隔字段列表（如 name, type, status）
• 响应：

{
    "status": "success",
    "data": {
        "policies": [
            {
                "id": "string",
                "name": "string",
                "type": "firewall" | "vpn" | "auth",
                "status": "active" | "inactive"
            }
        ],
        "pagination": {
            "page": integer,
            "pageSize": integer,
            "totalPages": integer,
            "totalItems": integer
        }
    }
}

createPolicy

• 描述：创建新策略
• 请求方法：POST
• 路径：/policies
• 请求体：

{
    "name": "string",
    "type": "firewall" | "vpn" | "auth",
    "status": "active" | "inactive"
}

updatePolicy

• 描述：更新现有策略
• 请求方法：PUT
• 路径：/policies/{policyId}
• 请求体：

{
    "name": "string",
    "type": "firewall" | "vpn" | "auth",
    "status": "active" | "inactive"
}

deletePolicy

• 描述：删除策略
• 请求方法：DELETE
• 路径：/policies/{policyId}

监控与诊断

getUsageStats

• 描述：获取使用统计信息
• 请求方法：GET
• 路径：/monitoring/usage
• 参数：
  • timeRange：时间范围（如 "last_hour", "today"）
• 响应：

{
    "status": "success",
    "data": {
        "stats": [
            {
                "timestamp": "string",
                "usage": integer,
                "peakUsage": integer
            }
        ]
    }
}

getLogs

• 描述：获取日志
• 请求方法：GET
• 路径：/monitoring/logs
• 参数：
  • level：日志级别（如 "info", "warning", "error"）
• 响应：

{
    "status": "success",
    "data": {
        "logs": [
            {
                "timestamp": "string",
                "level": "info" | "warning" | "error",
                "message": "string"
            }
        ],
        "pagination": {
            "page": integer,
            "pageSize": integer,
            "totalPages": integer,
            "totalItems": integer
        }
    }
}

升级与维护

checkUpdates

• 描述：检查可用更新
• 请求方法：GET
• 路径：/maintenance/updates
• 响应：

{
    "status": "success",
    "data": {
        "updates": [
            {
                "version": "string",
                "releaseDate": "string",
                "notes": "string"
            }
        ]
    }
}

applyUpdate

• 描述：应用更新
• 请求方法：POST
• 路径：/maintenance/updates/{updateVersion}
• 响应：

{
    "status": "success",
    "message": "string"
}

验证工具

validateName

• 描述：验证名称是否有效
• 请求方法：POST
• 路径：/validation/username
• 请求体：

{
    "name": "string"
}

• 响应：

{
    "status": "success",
    "isValid": boolean
}

validateResource

• 描述：验证资源是否存在
• 请求方法：GET
• 路径：/validation/resource/{resourceId}
• 响应：

{
    "status": "success",
    "exists": boolean
}

搜索工具

searchUsers

• 描述：搜索用户
• 请求方法：GET
• 路径：/search/users
• 参数：
  • query：搜索关键字（如 name, email）
• 响应：

{
    "status": "success",
    "results": [
        {
            "id": "string",
            "name": "string",
            "email": "string"
        }
    ],
    "pagination": {
        "page": integer,
        "pageSize": integer,
        "totalPages": integer,
        "totalItems": integer
    }
}

searchResources

• 描述：搜索资源
• 请求方法：GET
• 路径：/search/resources
• 参数：
  • query：搜索关键字（如 name, type）
• 响应：

{
    "status": "success",
    "results": [
        {
            "id": "string",
            "name": "string",
            "type": "string"
        }
    ],
    "pagination": {
        "page": integer,
        "pageSize": integer,
        "totalPages": integer,
        "totalItems": integer
    }
}

示例请求与响应

获取策略列表

请求：

GET /policies HTTP/1.1
Content-Type: application/json

响应：

{
    "status": "success",
    "data": {
        "policies": [
            {
                "id": "policy_001",
                "name": "Firewall Policy 1",
                "type": "firewall",
                "status": "active"
            },
            {
                "id": "policy_002",
                "name": "VPN Policy 2",
                "type": "vpn",
                "status": "inactive"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 10,
            "totalPages": 2,
            "totalItems": 15
        }
    }
}

检查更新

请求：

GET /maintenance/updates HTTP/1.1
Content-Type: application/json

响应：

{
    "status": "success",
    "data": {
        "updates": [
            {
                "version": "2.5.0",
                "releaseDate": "2023-10-01",
                "notes": "New features and bug fixes"
            },
            {
                "version": "2.4.1",
                "releaseDate": "2023-09-15",
                "notes": "Security patches"
            }
        ]
    }
}

验证名称

请求：

POST /validation/username HTTP/1.1
Content-Type: application/json

{
    "name": "admin_user_123"
}

响应：

{
    "status": "success",
    "isValid": true
}

搜索用户

请求：

GET /search/users?query=admin HTTP/1.1
Content-Type: application/json

响应：

{
    "status": "success",
    "results": [
        {
            "id": "user_001",
            "name": "Admin User 1",
            "email": "admin@company.com"
        },
        {
            "id": "user_002",
            "name": "Admin User 2",
            "email": "admin2@company.com"
        }
    ],
    "pagination": {
        "page": 1,
        "pageSize": 10,
        "totalPages": 2,
        "totalItems": 15
    }
}

⚠️ 注意事项

⚠️ 重要提示

1. 认证与授权：所有请求需要有效的认证令牌，具体请参考相关文档。
2. 错误处理：如返回状态码为非2xx，需根据响应体中的error字段处理错误。
3. 速率限制：高频率调用可能触发速率限制，请合理控制请求次数。
4. 日志与监控：建议开启详细日志记录以便排查问题和监控系统状态。

如需进一步了解每个接口的具体参数和使用场景，建议查阅完整的 API 文档或联系技术支持。