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

ListRunners

処理概要

Runnerの情報一覧を取得します。

リクエストURL

GET /v1/runners

指定するパラメーター

なし

応答フィールド

フィールド (項目)	型	説明
runners[]	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 -XGET https://jp-east-1.runner.devops.api.nifcloud.com/v1/runners
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'

  

応答サンプル

    {
    "runners":[
        {
            "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":100,
                "name":"RUNNING"
            },
            "systemId":"r_0123456789ab",
            "to":"alert@example.com"
        }
    ]
}