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

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

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

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

代码检查数据管理

获取分析项目问题列表

GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/<project_id>/codelint/issues/

参数:

参数类型描述
statestr问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3
severitystr严重程度, 1为严重,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4
resolutionstr解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除
authorstr问题责任人
scan_openint发现问题的扫描编号
scan_fixint修复问题的扫描编号
ci_time_gtestr修复问题的起始时间,格式为"2021-01-01 00:00:00"
ci_time_ltestr修复问题的结束时间
file_pathstr文件路径
checkrule_display_namestr检查规则名
checkpackageint问题所属的规则包

返回结果:

{
    "data": {
        "count": 1,
        "next": null,
        "previous": null,
        "results": [
            {
                "id": "1",
                "file_path": "file/job.py",
                "project": 45,
                "repo_id": 3,
                "checkrule_real_name": "checkrule_real_name",
                "checkrule_display_name": "checkrule_display_name",
                "checktool_name": "pylint",
                "msg": "msg",
                "state": 1,
                "resolution": null,
                "author": "jerolin",
                "severity": 3,
                "revision": "xxxxx",
                "ci_time": "2020-07-03T01:30:19+08:00",
                "scan_open": 261,
                "scan_fix": null,
                "fixed_time": null,
                "language": "python",
                "file_owners": null,
                "is_external": false,
                "scm_url": "",
                "real_file_path": "",
                "tapd_ws_id": null,
                "tapd_bug_id": null,
                "tapd_url": null,
                "tapd_bug_error": null,
                "created_time": "2022-11-21T21:18:32.294718+08:00",
                "modified_time": "2022-11-21T21:18:32.294761+08:00",
                "url": "xxxx",
                "category": 7,
                "source": null
            }
        ]
    },
    "code": 0,
    "msg": "请求成功",
    "status_code": 200
}

获取分析项目问题详情

GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/<project_id>/codelint/issues/<issue_id>/

返回结果:

{
    "data": {
        "id": "1",
        "issue_details": [
            {
                "id": "445",
                "issue_refers": [],
                "creator": null,
                "modifier": null,
                "deleted_time": null,
                "deleter": null,
                "issuedetail_uuid": "xxxx",
                "checkrule_real_name": "checkrule_real_name",
                "checktool_name": "pylint",
                "author": "author",
                "author_email": null,
                "line": 14,
                "column": 0,
                "scan_revision": "xxxxx",
                "revision": "xxxxx",
                "ci_time": "2020-05-29T22:24:00+08:00",
                "real_revision": "",
                "created_time": "2022-11-21T21:18:32.295139+08:00",
                "modified_time": "2022-11-21T21:18:32.295143+08:00",
                "issue": null,
                "project": 45
            }
        ],
        "issue_detail_overview": {
            "num": 1,
            "line_info": {
                "14": 1
            }
        },
        "is_external": false,
        "tapd_url": null,
        "repo": 3,
        "url": "xxxxx",
        "msg": "msg",
        "created_time": "2022-11-21T21:18:32.295159+08:00",
        "creator": null,
        "modifier": null,
        "deleted_time": null,
        "deleter": null,
        "repo_id": null,
        "file_path": "file/job.py",
        "scm_url": "",
        "real_file_path": "",
        "checkrule_gid": 3223,
        "checkrule_real_name": "checkrule_real_name",
        "checkrule_display_name": "checkrule_display_name",
        "checkrule_rule_title": "xxx",
        "checktool_name": "pylint",
        "category": 7,
        "state": 1,
        "resolution": null,
        "author": "author",
        "author_email": null,
        "origin_author": null,
        "scan_revision": "xxxx",
        "severity": 2,
        "language": "python",
        "revision": "xxxx",
        "ci_time": "2020-05-29T22:24:00+08:00",
        "file_owners": null,
        "fixed_time": null,
        "modified_time": "2022-11-21T21:18:32.295204+08:00",
        "tapd_ws_id": null,
        "tapd_bug_id": null,
        "ext_field": null,
        "project": 45,
        "scan_open": 261,
        "scan_fix": null
    },
    "code": 0,
    "msg": "msg",
    "status_code": 200
}

获取分析项目日常分析问题列表

GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/<project_id>/codelint/scans/<scan_id>/issues/

参数:

参数类型描述
statestr问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3
severitystr严重程度, 1为严重,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4
resolutionstr解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除
authorstr问题责任人
scan_open_idint发现问题的扫描编号
scan_fix_idint修复问题的扫描编号
ci_time_gtestr修复问题的起始时间
ci_time_ltestr修复问题的结束时间
file_pathstr文件路径
checkrule_display_namestr检查规则名
checkpackageint问题所属的规则包

返回结果:

{
    "data": {
        "count": 1,
        "next": null,
        "previous": null,
        "results": [
            {
                "id": 1,
                "repo_id": 1,
                "project_id": 1,
                "scan_time": "2021-03-11T20:46:44.171607+08:00",
                "file_path": "test/demo.py",
                "scm_url": "",
                "real_file_path": "",
                "line": 21,
                "column": 68,
                "checkrule_gid": 1,
                "checkrule_real_name": "xxx",
                "checkrule_display_name": "xxx",
                "checkrule_rule_title": "xxx",
                "checktool_name": "xxx",
                "category": 7,
                "msg": "xxx",
                "state": 1,
                "resolution": null,
                "author": "author",
                "scan_open_id": 1,
                "scan_fix_id": null,
                "issuedetail_uuid": "26d7ba88-8268-11eb-a304-5254005e71ca",
                "scan_revision": "scan_revision",
                "real_revision": "",
                "severity": 2,
                "language": "python",
                "revision": "revision",
                "ci_time": "2019-07-01T10:28:19+08:00",
                "file_owners": null,
                "created_time": "2021-03-11T20:49:00.539537+08:00",
                "fixed_time": null
            }
        ]
    },
    "code": 0,
    "msg": "xxx",
    "status_code": 200
}

获取分析项目 CR 分析问题列表

GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/<project_id>/codelint/crscans/<scan_id>/issues/

参数:

参数类型描述
statestr问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3
severitystr严重程度, 1为严重,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4
resolutionstr解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除
authorstr问题责任人
scan_open_idint发现问题的扫描编号
scan_fix_idint修复问题的扫描编号
ci_time_gtestr修复问题的起始时间
ci_time_ltestr修复问题的结束时间
file_pathstr文件路径
checkrule_display_namestr检查规则名
checkpackageint问题所属的规则包

返回结果:

{
    "data": {
        "count": 1,
        "next": null,
        "previous": null,
        "results": [
            {
                "id": 1,
                "repo_id": 1,
                "project_id": 1,
                "scan_time": "2021-03-11T20:46:44.171607+08:00",
                "file_path": "test/demo.py",
                "scm_url": "",
                "real_file_path": "",
                "line": 21,
                "column": 68,
                "checkrule_gid": 1,
                "checkrule_real_name": "xxx",
                "checkrule_display_name": "xxx",
                "checkrule_rule_title": "xxx",
                "checktool_name": "xxx",
                "category": 7,
                "msg": "xxx",
                "state": 1,
                "resolution": null,
                "author": "author",
                "scan_open_id": 1,
                "scan_fix_id": null,
                "issuedetail_uuid": "26d7ba88-8268-11eb-a304-5254005e71ca",
                "scan_revision": "scan_revision",
                "real_revision": "",
                "severity": 2,
                "language": "python",
                "revision": "revision",
                "ci_time": "2019-07-01T10:28:19+08:00",
                "file_owners": null,
                "created_time": "2021-03-11T20:49:00.539537+08:00",
                "fixed_time": null
            }
        ]
    },
    "code": 0,
    "msg": "xxx",
    "status_code": 200
}
最近更新时间: 2025/3/13 11:48
贡献者: nickctang, faberihe, bruccezhang
上一页
分析概览管理
下一页
代码度量数据管理