腾讯云代码分析腾讯云代码分析
指南
API
  • 其他

    • 问题忽略方式
立即体验
  • 服务协议
  • 隐私协议
  • 简体中文
  • English
Github
指南
API
  • 其他

    • 问题忽略方式
立即体验
  • 服务协议
  • 隐私协议
  • 简体中文
  • English
Github
  • API

    • 接口调用说明
    • 主要字段说明
    • 项目管理模块
    • 任务管理模块
    • 分析概览管理
    • 代码检查数据管理
    • 代码度量数据管理

任务管理模块

启动分析项目分析任务

POST /server/main/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/<project_id>/scans/create/

参数列表:

参数类型描述
incr_scanbool增量扫描标志,true表示增量,false表示全量
revisionstr指定版本号
scm_timedatatime版本号对应时间戳
created_fromstr扫描渠道
ignore_branch_issuestr过滤指定分支引入的问题
co_datajson渠道数据,记录上游触发事件、责任人
co_urlstr合作平台的任务链接
client_flagbool是否客户端本地或者ci流水线中创建任务
force_createbool强制启动标志,true表示强制启动,不等待上一个任务结束

返回结果:

{
    "data": {
        "job": {
            "id": 1587
        },
        "scan": {
            "id": 1587
        }
    },
    "code": 0,
    "msg": "请求成功",
    "status_code": 200
}

获取分析项目分析任务列表

GET /server/main/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/<project_id>/jobs/

参数列表:

参数类型描述
create_time_gtedatetime最小任务启动时间
create_time_ltedatetime最大任务启动时间
result_code_gteint最小错误码值
result_code_lteint最大错误码值
result_msgstr结果信息
stateint任务状态, 0为等待中,1为执行中,2为关闭,3为入库中,可多选,格式为1,2,3
created_fromstr创建来源
creatorstr创建用户

返回结果:

{
    "data": {
        "count": 1,
        "next": null,
        "previous": null,
        "results": [
            {
                "id": 1589,
                "state": 2,
                "result_code": 120,
                "result_msg": "xxxxxx",
                "code_line_num": null,
                "comment_line_num": null,
                "blank_line_num": null,
                "total_line_num": null,
                "efficient_comment_line_num": null,
                "filtered_efficient_comment_line_num": null,
                "scan_type": 2,
                "normal_job_id": 0
            }
        ]
    },
    "code": 0,
    "msg": "请求成功",
    "status_code": 200
}

获取分析项目分析任务详情

GET /server/main/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/<project_id>/jobs/<job_id>/detail/

返回结果:

{
    "data": {
        "id": 1585,
        "scan_id": 1585,
        "create_time": "2025-02-25T14:04:44.468912+08:00",
        "waiting_time": "0.6649",
        "start_time": null,
        "execute_time": null,
        "save_time": "0.0",
        "project": {
            "id": 206,
            "branch": "main",
            "repo_id": 149,
            "scan_scheme": 201,
            "repo_scm_url": "xxxx",
            "organization": {
                "org_sid": "xxxxx",
                "name": "xxxxx",
                "certificated": false,
                "status": 1,
                "level": 3
            },
            "project_team": {
                "name": "name",
                "display_name": "display_name",
                "status": 1,
                "org_sid": "xxxxx",
                "is_demo": false,
                "description": null
            },
            "deleted_time": null,
            "is_deleted": false,
            "status": 1,
            "scheme_name": "test-scheme",
            "refer_scheme_id": null
        },
        "end_time": "2025-02-25T14:04:45.133812+08:00",
        "expire_time": "2025-02-25T14:04:45.133812+08:00",
        "task_num": 0,
        "task_done": 0,
        "tasks": [],
        "context_path": "http://xxxx/job_context.json",
        "state": 2,
        "result_code": 120,
        "result_code_msg": "result_code_msg",
        "result_msg": "xxxxx",
        "result_path": null,
        "remarks": null,
        "remarked_by": null,
        "code_line_num": null,
        "comment_line_num": null,
        "blank_line_num": null,
        "total_line_num": null,
        "efficient_comment_line_num": null,
        "filtered_efficient_comment_line_num": null,
        "created_from": "CODING-WEB",
        "creator": "creator",
        "scan_type": 1,
        "normal_job_id": 0,
        "co_job_urls": []
    },
    "code": 0,
    "msg": "请求成功",
    "status_code": 200
}
最近更新时间: 2025/3/13 11:48
贡献者: nickctang, faberihe, bruccezhang
上一页
项目管理模块
下一页
分析概览管理