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

UpdateRunnerParameter

処理概要

指定したRunnerパラメーターグループのパラメーターを更新します。

リクエストURL

POST /v1/parameterGroups/{ParameterGroupName}:updateParameter

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
ParameterGroupName	string	Runnerパラメータグループ名	○

リクエストボディ

パラメーター	型	説明	必須
dockerParameters	object
␣disableCache	boolean	キャッシュの無効化
␣disableEntrypointOverwrite	boolean	エントリポイントの上書き無効化
␣extraHosts[]	object[]
␣␣hostName	string	ホスト名	○ (プライベートLAN経由でRunner利用時)
␣␣ipAddress	string	IPアドレス	○ (プライベートLAN経由でRunner利用時)
␣image	string	default Docker イメージ名 使用可能文字: 30文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止)
␣oomKillDisable	boolean	OOMキラーの無効化
␣privileged	boolean	特権での実行
␣shmSize	integer	/dev/shmに割り当てる容量
␣tlsVerify	boolean	TLSの検証
␣volumes	string[]	キャッシュストレージパス

応答フィールド

フィールド (項目)	型	説明
parameterGroup	object
␣description	string	メモ
␣parameterGroupName	string	Runnerパラメーターグループ
␣region	string	Runnerが稼働するリージョン名
␣dockerParameters	object
␣␣disableCache	boolean	キャッシュの無効化
␣␣disableEntrypointOverwrite	boolean	エントリポイントの上書き無効化
␣␣extraHosts[]	object[]
␣␣␣hostName	string	ホスト名
␣␣␣ipAddress	string	IPアドレス
␣␣image	string	デフォルトのイメージ
␣␣oomKillDisable	boolean	OOMキラーの無効化
␣␣privileged	boolean	特権での実行
␣␣shmSize	integer	/dev/shmに割り当てる容量
␣␣tlsVerify	boolean	TLSの検証
␣␣volumes	string[]	キャッシュストレージパス
␣createTime	string	Runnerパラメーターグループの作成日時
␣runnerNames	string[]	パラメータに紐づいているRunner

リクエストサンプル

    curl -XPOST https://jp-east-1.devops.api.nifcloud.com/v1/parameterGroups/gitlab1pg:updateParameter
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "dockerParameters":{
        "disableCache":true,
        "disableEntrypointOverwrite":true,
        "extraHosts":[
            {
                "hostName":"example.com",
                "ipAddress":"x.x.x.x"
            }
        ],
        "image":"alpine:latest",
        "oomKillDisable":true,
        "privileged":true,
        "shmSize":0,
        "tlsVerify":true,
        "volumes":[
            "/cache"
        ]
    }
}'

  

応答サンプル

    {
    "parameterGroup":{
        "description":"My Shared Parameter",
        "parameterGroupName":"param1",
        "region":"jp-east-1",
        "dockerParameters":{
            "disableCache":false,
            "disableEntrypointOverwrite":false,
            "extraHosts":[
                {
                    "hostName":"example.com",
                    "ipAddress":"x.x.x.x"
                }
            ],
            "image":"alpine:latest",
            "oomKillDisable":false,
            "privileged":false,
            "shmSize":0,
            "tlsVerify":false,
            "volumes":[
                "/cache"
            ]
        },
        "createTime":"2023-03-15T10:28:13Z",
        "runnerNames":[]
    }
}