CreateInstance
処理概要
DevOpsサーバーを新規作成します。
リクエストURL
POST /v1/instances指定するパラメーター
リクエストボディ
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| instanceId | string |
DevOpsサーバー名 使用可能文字: 30文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止) |
○ |
| instanceType | string |
DevOpsサーバーのサーバータイプ 値:
|
○ |
| firewallGroupName | string |
DevOpsサーバーに適用するファイアウォールグループ名 使用可能文字: 63文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止) |
○ |
| parameterGroupName | string |
DevOpsサーバーに適用するパラメーターグループ名 使用可能文字: 63文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止) |
○ |
| diskSize | integer |
DevOpsサーバーのディスク初期容量[GB] 使用可能文字: 100, 200, 300, 400 |
○ |
| availabilityZone | string |
DevOpsサーバーを作成するゾーン(リージョンとゾーンの対応についてはゾーン別機能対応表を参照) デフォルト値:作成するリージョンに依存(jp-east-1：east-11／jp-east-3：east-31／jp-west-1：west-12／jp-west-2：jp-west-21) 値:
|
|
| description | string |
メモ 使用可能文字: 255文字以内の全角半角 |
|
| initialRootPassword | string |
rootユーザーの初期パスワード 使用可能文字: 8～128文字の半角英数字 |
○ |
| networkConfig | object |
|
|
| ␣networkId | string |
DevOpsサーバーに割り当てるプライベートLANのネットワークID 使用可能文字: プライベートLANのネットワークID(プライベートLANにする場合) |
|
| ␣privateAddress | string |
DevOpsサーバーに割り当てるプライベートLANの固定IPアドレス 使用可能文字: IPアドレス(CIDR表記) |
|
| objectStorageConfig | object |
|
|
| ␣account | string |
DevOpsサーバーのGitLabが使用するオブジェクトストレージのアカウント 使用可能文字: 1～128文字の半角英数字 |
|
| ␣region | string |
DevOpsサーバーのGitLabが使用するオブジェクトストレージのリージョン 値:
|
|
| ␣bucketUseObjects | object |
|
|
| ␣␣lfs | string |
LFSオブジェクトを格納するバケット名。空文字を設定時は指定したリージョンのオブジェクトストレージにLFS用のバケットを作成します。 使用可能文字: 空文字の設定可能、3～32文字の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止) |
|
| ␣␣packages | string |
PackageRegistryオブジェクトを格納するバケット名。空文字を設定時は指定したリージョンのオブジェクトストレージにPackageRegistry用のバケットを作成します。 使用可能文字: 空文字の設定可能、3～32文字の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止) |
|
| ␣␣containerRegistry | string |
ContainerRegistryオブジェクトを格納するバケット名。空文字を設定時は指定したリージョンのオブジェクトストレージにContainerRegistry用のバケットを作成します。 使用可能文字: 空文字の設定可能、3～32文字の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止) |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| instance | object |
|
| ␣region | string |
DevOpsサーバーが稼働しているリージョン名 |
| ␣availabilityZone | string |
DevOpsサーバーが稼働しているゾーン名 |
| ␣description | string |
メモ |
| ␣instanceId | string |
DevOpsサーバー名 |
| ␣diskSize | integer |
DevOpsサーバーのディスク容量 |
| ␣firewallGroupName | string |
DevOpsサーバーに設定されているファイアウォールグループ名 |
| ␣parameterGroupName | string |
DevOpsサーバーに設定されているパラメーターグループ名 |
| ␣gitlabUrl | string |
DevOpsサーバーのGitLab URL |
| ␣gitlabVersion | string |
DevOpsサーバーのGitLab バージョン |
| ␣upgradableGitlabVersions | string[] |
DevOpsサーバーのアップグレード可能なGitLab バージョン |
| ␣registryUrl | string |
DevOpsサーバーのGitLabレジストリ URL |
| ␣instanceType | string |
DevOpsサーバーのサーバータイプ |
| ␣publicIpAddress | string |
DevOpsサーバーのグローバルIPアドレス |
| ␣networkConfig | object |
|
| ␣␣networkId | string |
DevOpsサーバーが属するプライベートLAN |
| ␣␣privateAddress | string |
DevOpsサーバーのプライベートIPアドレス |
| ␣objectStorageConfig | object |
|
| ␣␣account | string |
DevOpsサーバーのGitLabが使用するオブジェクトストレージのアカウント |
| ␣␣region | string |
DevOpsサーバーのGitLabが使用するオブジェクトストレージのリージョン |
| ␣␣bucketUseObjects | object |
|
| ␣␣␣lfs | string |
LFSオブジェクトを格納するバケット名 |
| ␣␣␣packages | string |
PackageRegistryオブジェクトを格納するバケット名 |
| ␣␣␣containerRegistry | string |
ContainerRegistryオブジェクトを格納するバケット名 |
| ␣to | string |
DevOpsサーバーのアラート通知先メールアドレス |
| ␣state | string |
DevOpsサーバーのステータス 値:
|
| ␣status | object |
|
| ␣␣code | integer |
DevOpsサーバーのステータスコード 値:
|
| ␣␣name | string |
DevOpsサーバーのステータス詳細 値:
|
| ␣createTime | string |
DevOpsサーバーの作成日時 |
リクエストサンプル
curl -XPOST https://jp-east-1.devops.api.nifcloud.com/v1/instances
-H 'X-Amz-Date: 20230401T000000Z'
-H 'Authorization: AWS4-HMAC-SHA256 ...'
-H 'content-type:application/json'
-d '
{
"instanceId":"gitlab1",
"instanceType":"e-large",
"firewallGroupName":"gitlab1fw",
"parameterGroupName":"gitlab1pg",
"diskSize":100,
"availabilityZone":"east-11",
"description":"production",
"initialRootPassword":"password12345",
"networkConfig":{
"networkId":"net-abcdefgh",
"privateAddress":"x.x.x.x"
},
"objectStorageConfig":{
"account":"abc12345",
"bucketUseObjects":{
"containerRegistry":"dwg-1256-cr-zlcjmj1vzq2zpff2zczo",
"lfs":"dwg-1256-lf-odyormogfu1tprwmikty",
"packages":"dwg-1256-pr-0ogepmga3xsrrgm2gvvq"
},
"region":"jp-east-1"
}
}'
応答サンプル
{
"instance":{
"region":"jp-east-1",
"availabilityZone":"east-11",
"description":"production",
"instanceId":"gitlab1",
"diskSize":100,
"firewallGroupName":"gitlab1fw",
"parameterGroupName":"gitlab1pg",
"gitlabUrl":"https://gitlab1.jp-east-1.gitlab.devops.nifcloud.com",
"gitlabVersion":"15.2.5-ee.0",
"upgradableGitlabVersions":[],
"registryUrl":"https://registry-gitlab1.jp-east-1.gitlab.devops.nifcloud.com",
"instanceType":"e-large",
"publicIpAddress":"",
"networkConfig":{},
"objectStorageConfig":{
"account":"abc12345",
"bucketUseObjects":{
"containerRegistry":"dwg-1256-cr-zlcjmj1vzq2zpff2zczo",
"lfs":"dwg-1256-lf-odyormogfu1tprwmikty",
"packages":"dwg-1256-pr-0ogepmga3xsrrgm2gvvq"
},
"region":"jp-east-1"
},
"to":"alrt@example.com",
"state":"CREATING",
"status":{
"code":200,
"name":"CREATING"
},
"createTime":"2022-08-01 17:32:28 UTC"
}
}
