RegisterRunner
処理概要
指定したRunnerをGitLabに登録します。
リクエストURL
POST /v1/runners/{RunnerName}/registrations指定するパラメーター
パスパラメーター
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| RunnerName | string |
Runner名 |
○ |
リクエストボディ
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| accessLevel | string |
保護されたブランチでのみ実行するように設定できます GitLabのWeb画面から変更が可能です 値:
|
|
| authenticationToken | string |
GitLabのWeb画面で予め作成した認証トークンを入力します Runner認証トークンを指定した場合はregistrationTokenとaccessLevel, locked, maximumTimeout, paused, runUntagged, tagsは無視されます。 |
|
| 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 |
○ |
| locked | boolean |
登録したRunnerを他のプロジェクトで使用できないようにします GitLabのWeb画面から変更が可能です Default: True |
|
| maximumTimeout | integer |
ジョブがタイムアウトするまでの時間 GitLabのWeb画面から変更が可能です |
|
| paused | boolean |
新しいジョブを受け付けない状態でRunner登録を行います GitLabのWeb画面から変更が可能です |
|
| privileged | boolean |
特権コンテナでジョブを実行します |
|
| registrationToken | string |
GitLabのWeb画面から取得した登録トークンを入力します |
|
| runUntagged | boolean |
タグのついているジョブのみを実行する場合はタグの設定が必須です GitLabのWeb画面から変更が可能です Default: True |
|
| tags | string[] |
タグを設定することができます GitLabのWeb画面から変更が可能です |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| 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のステータスコード 値:
|
| ␣␣name | string |
Runnerのステータス詳細 値:
|
| ␣systemId | string |
RunnerのシステムID |
リクエストサンプル
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 '
{
"accessLevel":"not_protected",
"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",
"locked":true,
"maximumTimeout":600,
"paused":false,
"privileged":false,
"registrationToken":"GRAbcdefghijklmnopq0123456789",
"runUntagged":true,
"tags":[
"tag1"
]
}'
応答サンプル
{
"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"
}
}
