huawei-cloud-api-definitions-CodeArtsBuild 0.1.20240206

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"},"ParameterItem":{"properties":{"name":{"description":"参数名称","example":"codeBranch","type":"string"},"value":{"description":"参数值","example":"master","type":"string"}},"required":["name","value"],"type":"object"},"Parameters":{"description":"自定义参数","items":{"$ref":"#/definitions/ParameterItem"},"type":"array"},"RunJobRequestBody":{"description":"执行任务接口请求体","properties":{"job_id":{"description":"构建任务ID;编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串","example":"f5af662119404ad187437cd272b5099b","type":"string"},"parameter":{"$ref":"#/definitions/Parameters"},"scm":{"$ref":"#/definitions/Scm"}},"required":["job_id"],"type":"object"},"RunJobResponseBody":{"properties":{"actual_build_number":{"description":"实际构建次数","example":"20","type":"string"},"daily_build_number":{"description":"构建每日编号","example":"20200612.20","type":"string"},"octopus_job_name":{"description":"临时任务名称","example":"j_Oaqg3PCN","type":"string"}},"title":"buildjobResponseBody","type":"object"},"Scm":{"description":"代码信息","properties":{"build_commit_id":{"description":"代码提交ID","example":"f5af662119404ad187437cd272b5099b","type":"string"},"build_tag":{"description":"代码Tag","example":"build_tag_test","type":"string"}},"type":"object"}},"description":null,"group_id":"50626d0f704e4af3adfd875e2acffcb6","host":"cloudbuild-ext.cn-north-4.myhuaweicloud.com","id":"6b2201fa94c44ad791666f617d63c683","info_version":"v3","method":"post","name":"RunJob","parameters":{"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/build":{"post":{"deprecated":false,"description":"执行构建任务,可传自定义参数","operationId":"RunJob","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"description":"body","in":"body","name":"RunJobRequestBody","required":true,"schema":{"$ref":"#/definitions/RunJobRequestBody"}}],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"OK","examples":{"application/json":{"actual_build_number":"20","daily_build_number":"20200612.20","octopus_job_name":"j_Oaqg..."}},"schema":{"$ref":"#/definitions/RunJobResponseBody"}},"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-description-1":"执行任务ID为“f9d6c8466d614a9788e9a0acf6c15f46”,代码仓名称为“codeBranch”,代码仓分支为“master”的构建任务","x-request-examples-text-1":"{\n  \"job_id\":\"f9d6c8466d614a9788e9a0acf6c15f46\",\n  \"parameter\":[\n      {\n          \"name\":\"codeBranch\",\n          \"value\":\"master\"\n      }],\n  \"scm\":{\n      \"build_tag\":null,\n      \"build_commit_id\":\"build_commit_id\"\n  }\n}","x-request-examples-url-1":"POST https://{endpoint}/v3/jobs/build","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"}