huawei-cloud-api-definitions-CodeArtsBuild 0.1.20240119

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码","example":"CB.00060200","type":"string"},"error_msg":{"description":"错误描述","example":"Invalid param","type":"string"}},"type":"object"},"PeriodHistoryRecords":{"properties":{"history_records":{"description":"构建历史列表","items":{"properties":{"branch":{"description":"代码分支","type":"string"},"build_number":{"description":"构建编号","format":"int32","type":"integer"},"commit_id":{"description":"代码提交的commit id","type":"string"},"commit_message":{"description":"代码提交时用户输入的提交信息,只有使用codehub仓库时有值","type":"string"},"end_time":{"description":"构建结束时间","type":"string"},"executor":{"description":"执行构建任务的用户的用户名","type":"string"},"job_id":{"description":"任务id","type":"string"},"record_id":{"description":"构建记录id--唯一key","type":"string"},"result":{"description":"构建结果","type":"string"},"start_time":{"description":"构建开始时间","type":"string"},"trigger_type":{"description":"触发方式,可选值:手工触发,定时触发,代码更新触发,流水线触发","type":"string"}},"title":"HistoryRecord","type":"object"},"type":"array"},"total":{"description":"记录总数","type":"integer"}},"title":"PeriodHistoryRecords","type":"object"}},"description":null,"group_id":"50626d0f704e4af3adfd875e2acffcb6","host":"cloudbuild-ext.cn-north-4.myhuaweicloud.com","id":"6e043b7f3fb84121a81711b06787fb4d","info_version":"v3","method":"get","name":"ShowListPeriodHistory","parameters":{"Job_Id":{"description":"构建的任务ID;\n编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串。","in":"path","name":"job_id","pattern":"^[0-9a-z]{32}$","required":true,"type":"string","x-example":"901878212b1a49be9c1a1054c272762a"},"Limit":{"default":10,"description":"每页显示的条目数量,limit小于等于100","format":"int32","in":"query","maximum":100,"minimum":0,"name":"limit","required":true,"type":"integer"},"Offset":{"default":0,"description":"分页页码, 表示从此页开始查询, offset大于等于0","format":"int32","in":"query","minimum":0,"name":"offset","required":true,"type":"integer"},"X-Auth-Token":{"description":"用户Token。\n通过调用IAM服务接口获取\n(响应消息头中X-Subject-Token的值)。\n不支持租户全局token,请使用scope为project的region级token。","in":"header","maxLength":100000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX..."}},"paths":{"/v3/jobs/{job_id}/period-history":{"get":{"deprecated":false,"description":"根据开始时间和结束时间查看构建任务的构建历史列表","operationId":"ShowListPeriodHistory","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/Job_Id"},{"$ref":"#/parameters/Offset"},{"$ref":"#/parameters/Limit"},{"default":"2021-01-04","description":"区间开始时间,格式yyyy-MM-dd。\n开始时间和结束时间间隔不能超过30天","in":"query","name":"start_time","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","required":true,"type":"string"},{"default":"2021-02-03","description":"区间结束时间,格式yyyy-MM-dd。\n开始时间和结束时间间隔不能超过30天","in":"query","name":"end_time","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","required":true,"type":"string"}],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"OK","examples":{"application/json":{"history_records":{"branch":"master","build_number":55,"commit_id":"2f37dd494927d2c6259417c58e5faeb72bfe7150","commit_message":"test","end_time":"2020-12-30T17:33:27+08:00","executor":"test","job_id":"f9d6c8466d614a9788e9a0acf6c15f46","record_id":"20201230.1","result":"FAILURE","start_time":"2020-12-30T17:33:11+08:00","trigger_type":"手工触发"},"total":1}},"schema":{"$ref":"#/definitions/PeriodHistoryRecords"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorResponseBody"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResponseBody"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResponseBody"}},"404":{"description":"Not Found","schema":{"$ref":"#/definitions/ErrorResponseBody"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"security":[{"apig-auth-iam":[]}],"summary":"根据开始时间和结束时间查看构建任务的构建历史列表","tags":["CodeArtsBuild"],"x-api-type":"open-api","x-apigateway-ratelimit":"cloudbuild_ext","x-internel":"false","x-is-registered":"Y","x-request-examples-url-1":"GET https://{endpoint}/v3/jobs/{job_id}/period-history?start_time=2021-01-04&end_time=2021-01-14&offset=0&limit=10","x-support-sdk":"Y"}}},"product_short":"CodeArtsBuild","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"APP":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-app-optional":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-opt":{"access-auth-type":"optional"},"x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-none":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM_NONE"}},"summary":"根据开始时间和结束时间查看构建任务的构建历史列表","tags":"编译构建","uri":null,"version":"2.0"}