Run build - Create a tag

Run build

post

Execute the build with a new tag image for the specified build.

Path parameters

buildSeqinteger · int32Required

Query parameters

tagNamestringOptional

descriptionstringOptional

callbackUrlstringOptional

callback URL

Responses

200

OK

*/*

Build execution model

useYnstringOptional

Usage status (Enabled: Y, Disabled: N)

Example: Y

createdstringOptional

creation time

Example: 2022-12-02 08:42:46

updatedstringOptional

update time

Example: 2022-12-02 08:42:46

buildNamestringOptionalExample: build-test

buildDescstringOptionalExample: build-test

registryNamestringOptionalExample: dev

imageNamestringOptionalExample: build-api-test-gradle

accountSeqintegerOptional

Account number (system's account number)

Example: 1

registryProjectIdintegerOptionalExample: 27

externalRegistrySeqintegerOptionalExample: 0

buildServerHoststringOptional

Build server host (information about the server host where actual build steps are executed and images are generated)

Example: topic:build-20230623-ws-namespace-thingcluster

buildServerTlsVerifystringOptional

Whether TLS is used on the server where the actual build is executed (Enabled: Y, Disabled: N)

Example: N

buildServerCacrtstringOptional

TLS CA for the build execution server (CA value for TLS integration on the server where the actual build is executed)

buildServerClientCertstringOptional

Client certificate for the build execution server(Client certificate for TLS integration on the server where the actual build is executed.)

buildServerClientKeystringOptional

Client key for the build execution server.(Client key for TLS integration on the server where the actual build is executed.)

buildRunSeqintegerOptionalExample: 1

buildSeqintegerOptionalExample: 1

buildNointegerOptionalExample: 1

runTypestringOptional

Build run type('BUILD' or 'CANCEL' or 'REMOVE')

Example: BUILD

runDescstringOptional

Build run type

Example: Build run test

runStatestringOptional

build run state('CREATED' or 'RUNNING' or 'DONE' or 'ERROR')

Example: DONE

autotagUseYnstringOptional

Automatic tagging usage status (Enabled: Y, Disabled: N)

Example: N

autotagPrefixstringOptionalExample: test

autotagSeqTypestringOptional

autotag sequence number type('DATETIME' or 'SEQUENCE')

Example: DATETIME

tagNamestringOptional

Image tag name (tag name of the image to be built)

Example: 8u292-rmsoft

callbackUrlstringOptional

callback URL

Example: http://dashboard:3000/callback

imageUrlstringOptional

Image URL (URL of the image registered in the registry)

Example: dev.cocktailcloud.io/ops/build-api-test-gradle

imageSizeintegerOptional

Image size (bytes) (saved only if the build is successful)

Example: 133745493

imageDigeststringOptional

Image Digest(saved only if the build is successful)

Example: sha256:30c1930cbee0c55a2ab23708866b8b9c6f555b17382df716d1e675eefbf5083b

pipelineSeqintegerOptionalExample: 0

beginTimestringOptional

begintime(format : data-time)

Example: 2022-12-02T08:42:43.000+00:00

endTimestring · date-timeOptional

endtime(format : data-time)

Example: 2022-12-02T08:43:40.000+00:00

runTimeBySecintegerOptional

runtime(unit : seconds)(endTime - beginTime)

Example: 57

possibleActionsstring[]Optional

List of possible actions('VIEW', 'BUILD', 'LOG', 'REMOVE', 'CANCEL')

Example: ["VIEW","BUILD","LOG","REMOVE"]

post

/v1/build/run/{buildSeq}

HTTPcURLJavaScriptPython

POST /v1/build/run/{buildSeq} HTTP/1.1
Accept: */*

200

OK

[
  {
    "useYn": "Y",
    "created": "2022-12-02 08:42:46",
    "updated": "2022-12-02 08:42:46",
    "buildName": "build-test",
    "buildDesc": "build-test",
    "registryName": "dev",
    "imageName": "build-api-test-gradle",
    "accountSeq": 1,
    "registryProjectId": 27,
    "externalRegistrySeq": 0,
    "buildServerHost": "topic:build-20230623-ws-namespace-thingcluster",
    "buildServerTlsVerify": "N",
    "buildServerCacrt": "",
    "buildServerClientCert": "",
    "buildServerClientKey": "",
    "buildRunSeq": 1,
    "buildSeq": 1,
    "buildNo": 1,
    "runType": "BUILD",
    "runDesc": "Build run test",
    "runState": "DONE",
    "autotagUseYn": "N",
    "autotagPrefix": "test",
    "autotagSeqType": "DATETIME",
    "tagName": "8u292-rmsoft",
    "callbackUrl": "http://dashboard:3000/callback",
    "imageUrl": "dev.cocktailcloud.io/ops/build-api-test-gradle",
    "imageSize": 133745493,
    "imageDigest": "sha256:30c1930cbee0c55a2ab23708866b8b9c6f555b17382df716d1e675eefbf5083b",
    "pipelineSeq": 0,
    "relatedPipelineInfo": {
      "pipelineContainerSeq": 0,
      "pipelineWorkloadSeq": 0,
      "namespaceName": "cocktail-system",
      "workloadName": "cocktail-api",
      "containerName": "api",
      "componentSeq": 0,
      "useYn": "Y",
      "accountSeq": 1,
      "serviceSeq": 0,
      "appmapSeq": 0,
      "clusterId": "thingcluster"
    },
    "beginTime": "2022-12-02T08:42:43.000+00:00",
    "endTime": "2022-12-02T08:43:40.000+00:00",
    "runTimeBySec": 57,
    "buildStepRuns": [
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "CODE_DOWN",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 1,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "CODE_DOWN",
          "repositoryType": "GIT",
          "stepTitle": "code repository task",
          "repositoryUrl": "github.com/gradle-sample-app.git",
          "branchName": "master",
          "codeSaveDir": "repo",
          "commonType": "COMMON",
          "protocolType": "https"
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "USER_TASK",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 2,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "USER_TASK",
          "stepTitle": "user task",
          "cmd": [
            "mvn",
            "clean",
            "install"
          ],
          "workingDir": "/build",
          "imageName": "build-api-test-gradle",
          "imageTag": "8u292-rmsoft",
          "dockerVolumeMountVOList": [
            {
              "containerPath": "/build",
              "hostPath": "$PWD/repo"
            }
          ]
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "FTP",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 3,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "FTP",
          "stepTitle": "file(FTP) task",
          "url": "test-ftp.gradle-sample-test",
          "ftpType": "SFTP",
          "username": "runapps",
          "sourceFiles": "/data/dataset",
          "remoteDirectory": "data/gradle-sample-dataset",
          "ftpExecType": "DIR_FTP_DOWN"
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "HTTP",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 4,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "HTTP",
          "stepTitle": "REST call task",
          "url": "https://priv-regi.cocktailcloud.io/api/gradle-sample-dataset",
          "httpMode": "GET",
          "ignoreSslErrors": false,
          "username": "admin",
          "timeout": 5,
          "validResponseCodes": "200",
          "outputFile": "project-list.txt",
          "consoleLogResponseBody": false
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "SHELL",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 5,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "SHELL",
          "stepTitle": "script task",
          "shellType": "SCRIPT",
          "command": "echo \">>> move app source\"\ncd repo\n\necho \">>> node_modules compression\"\ntar -cf node_modules.tar node_modules/\n\nls -al"
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "CREATE_IMAGE",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 6,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "CREATE_IMAGE",
          "buildStepSeq": 5,
          "exitCode": "0",
          "dockerFileType": "CONTENTS",
          "stepTitle": "image build task",
          "dockerFile": "FROM gradle:6.9.2-jdk8",
          "severity": "",
          "registryId": 27,
          "registryName": "dev",
          "imageTag": "8u292-rmsoft",
          "imageName": "build-api-test-gradle"
        }
      }
    ],
    "possibleActions": [
      "VIEW",
      "BUILD",
      "LOG",
      "REMOVE"
    ]
  }
]