本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/devops/api/GetRunner.htmへ移行しました。 今後は新ページをご参照ください。

GetRunner

処理概要

指定されたRunnerの情報を返却します。

リクエストURL

GET /v1/runners/{RunnerName}

指定するパラメーター

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

応答フィールド

フィールド (項目) 説明
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アップグレードエラー)
systemId string RunnerのシステムID

リクエストサンプル

    curl -XGET https://jp-east-1.runner.devops.api.nifcloud.com/v1/runners/shared-runner
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'

  

応答サンプル

    {
    "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":100,
            "name":"RUNNING"
        },
        "systemId":"r_0123456789ab"
    }
}
  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

推奨画面サイズ 1024×768 以上