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

ListRunnerRegistrations

処理概要

指定したRunnerが登録されているGitLabの情報を取得します。

リクエストURL

GET /v1/runners/{RunnerName}/registrations

指定するパラメーター

パスパラメーター

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

応答フィールド

フィールド (項目)	型	説明
registrations[]	object[]
␣gitlabUrl	string	登録対象のGitLabインスタンスのURL
␣parameterGroupName	string	Runnerパラメーターグループ
␣registrationId	string	登録ID
␣status	object
␣␣code	integer	Runner登録状況のステータスコード 値: 100 (ALIVE) 400 (REMOVED/FAILED/ERROR)
␣␣name	string	Runner登録状況のステータス詳細 値: ALIVE (Runner登録済) REMOVED (Runner無効) FAILED (Runner検証エラー) ERROR (その他のエラー)
␣token	string	トークン（頭9文字）

リクエストサンプル

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

  

応答サンプル

    {
    "registrations":[
        {
            "gitlabUrl":"https://gitlab1.jp-east-1.gitlab.devops.nifcloud.com",
            "parameterGroupName":"param1",
            "registrationId":"shared-runner-abcde",
            "status":{
                "code":100,
                "name":"ALIVE"
            },
            "token":"Abcde0123"
        }
    ]
}