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

CreateRunner

処理概要

Runnerを新規作成します。

リクエストURL

POST /v1/runners

指定するパラメーター

リクエストボディ

パラメーター	型	説明	必須
availabilityZone	string	Runnerが稼働するゾーン(リージョンとゾーンの対応についてはゾーン別機能対応表を参照) デフォルト値:作成するリージョンに依存(jp-east-1：east-11／jp-east-3：east-31／jp-west-1：west-12／jp-west-2：jp-west-21) 値: east-11 east-12 east-13 east-14 east-31 west-11 west-12 west-13 jp-west-21
concurrent	integer	ジョブの並列実行数 Default: 1
description	string	メモ 使用可能文字: 255文字以内の全角半角
instanceType	string	Runnerのサーバータイプ 値: c-small c-small2 c-small4 c-medium c-medium4 c-medium8 c-large c-large8 e-small e-small2 e-small4 e-small8 e-small16 e-medium e-medium4 e-medium8 e-medium16 e-medium24 e-large e-large8 e-large16 e-large24 e-extra-large8 e-extra-large16 e-extra-large24 e-double-large16 e-double-large24 h2-small h2-small2 h2-small4 h2-small8 h2-small16 h2-medium h2-medium4 h2-medium8 h2-medium16 h2-medium24 h2-large h2-large8 h2-large16 h2-large24 h2-extra-large8 h2-extra-large16 h2-extra-large24 h2-double-large16 h2-double-large24	○
networkConfig	object
␣networkId	string	Runnerが属するプライベートLANのネットワークID 使用可能文字: プライベートLANのネットワークID	○ (プライベートLAN利用時)
␣privateAddress	string	Runnerが属するプライベートLANの固定IPアドレス 使用可能文字: IPアドレス(CIDR表記)	○ (プライベートLAN利用時)
runnerName	string	Runner名 使用可能文字: 30文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止)	○

応答フィールド

フィールド (項目)	型	説明
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
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "availabilityZone":"east-11",
    "concurrent":1,
    "description":"My Shared Runner",
    "instanceType":"c-medium",
    "networkConfig":{
        "networkId":"net-abcdefgh",
        "privateAddress":"x.x.x.x"
    },
    "region":"jp-east-1",
    "runnerName":"shared-runner"
}'

  

応答サンプル

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