ニフクラAPI (DevOps with Gitlab: RegisterRunner)

RegisterRunner

処理概要

指定したRunnerをGitLabに登録します。

リクエストURL

POST /v1/runners/{RunnerName}/registrations

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
RunnerName	string	Runner名	○

リクエストボディ

パラメーター	型	説明	必須
authenticationToken	string	GitLabのWeb画面で予め作成した認証トークンを入力します。	○
parameterGroupName	string	Runnerパラメーターグループ Runnerパラメーターグループを指定した場合はdefault_docker_imageとprivileged, extraHostsは無視されます。 使用可能文字: 63文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止)
defaultDockerImage	string	デフォルトで使用されるDockerイメージ
extraHosts[]	object[]
␣hostName	string	ホスト名	○ (プライベートLAN経由でRunner利用時)
␣ipAddress	string	IPアドレス	○ (プライベートLAN経由でRunner利用時)
gitlabUrl	string	登録対象のGitLabインスタンスのURL	○
privileged	boolean	特権コンテナでジョブを実行します Default: False

応答フィールド

フィールド (項目)	型	説明
runner	object
␣availabilityZone	string	Runnerが稼働するゾーン名
␣concurrent	integer	ジョブの並列実行数
␣createTime	string	Runnerの作成日時
␣description	string	メモ
␣instanceType	string	Runnerのサーバータイプ
␣networkConfig	object
␣␣networkId	string	Runnerが属するプライベートLAN
␣␣privateAddress	string	RunnerのプライベートIPアドレス
␣publicIpAddress	string	RunnerのグローバルIPアドレス
␣region	string	Runnerが稼働するリージョン名
␣runnerName	string	Runner名
␣runnerVersion	string	Runnerバージョン
␣status	object
␣␣code	integer	Runnerのステータスコード 値: 100 (稼働中/RUNNING) 200 (処理中/PROCESSING) 300 (警告/WARNING) 400 (エラー/FAILED)
␣␣name	string	Runnerのステータス詳細 値: CREATING (Runner作成中) RUNNING (Runner稼働中) PROCESSING (Runner処理中) REGISTERING (Runner登録中) UNREGISTERING (Runner登録解除中) UPGRADING (Runnerアップグレード中) FAILED_RUNNER_CREATE (Runner作成エラー) FAILED_RUNNER_DELETE (Runner削除エラー) FAILED_RUNNER_OPTOUT (Runner解約時削除エラー) FAILED_RUNNER_REGISTER (Runner登録エラー) FAILED_RUNNER_UNREGISTER (Runner登録解除エラー) FAILED_RUNNER_UPDATESPEC (Runnerスペック変更エラー) FAILED_RUNNER_UPGRADE (Runnerアップグレードエラー) FAILED_RUNNER_UPDATEPARAM (Runnerパラメーター更新エラー)
␣systemId	string	RunnerのシステムID
␣to	string	アラートメールの宛先アドレス

リクエストサンプル

    curl -XPOST https://jp-east-1.runner.devops.api.nifcloud.com/v1/runners/shared-runner/registrations
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "defaultDockerImage":"alpine:latest",
    "extraHosts":[
        {
            "hostName":"extrahost.jp-east-1.gitlab.devops.nifcloud.com",
            "ipAddress":"x.x.x.x"
        }
    ],
    "gitlabUrl":"https://gitlab1.jp-east-1.gitlab.devops.nifcloud.com",
    "privileged":false
}'

  

応答サンプル

    {
    "runner":{
        "availabilityZone":"east-11",
        "concurrent":1,
        "createTime":"2022-01-26T00:00:00Z",
        "description":"My Shared Runner",
        "instanceType":"c-medium",
        "networkConfig":{
            "networkId":"net-abcdefgh",
            "privateAddress":"x.x.x.x"
        },
        "publicIpAddress":"x.x.x.x",
        "region":"jp-east-1",
        "runnerName":"shared-runner",
        "runnerVersion":"16.0.0",
        "status":{
            "code":200,
            "name":"REGISTERING"
        },
        "systemId":"r_0123456789ab",
        "to":"alert@example.com"
    }
}