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

RestoreInstance

処理概要

DevOpsサーバーをバックアップファイルから作成します。

リクエストURL

POST /v1/instances:restore

指定するパラメーター

リクエストボディ

パラメーター	型	説明	必須
backupId	string	バックアップID 使用可能文字: 各バックアップに振られた32文字のID (半角英数小文字)	○
instanceId	string	DevOpsサーバー名 使用可能文字: 30文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止)	○
instanceType	string	DevOpsサーバーのサーバータイプ 値: c-large c-large8 e-large e-large8 e-large16 e-large24 e-large32 e-extra-large8 e-extra-large16 e-extra-large24 e-extra-large32 e-extra-large48 e-double-large16 e-double-large24 e-double-large32 e-double-large48 e-double-large64 e-double-large96 h2-large h2-large8 h2-large16 h2-large24 h2-large32 h2-extra-large8 h2-extra-large16 h2-extra-large24 h2-extra-large32 h2-extra-large48 h2-double-large16 h2-double-large24 h2-double-large32 h2-double-large48 h2-double-large64 h2-double-large96 Default: e-large	○
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) 値: east-11 east-12 east-13 east-14 east-31 west-12 west-13 jp-west-21
description	string	メモ 使用可能文字: 255文字以内の全角半角
networkConfig	object
␣networkId	string	DevOpsサーバーに割り当てるプライベートLANのネットワークID 使用可能文字: プライベートLANのネットワークID(プライベートLANにする場合)
␣privateAddress	string	DevOpsサーバーに割り当てるプライベートLANの固定IPアドレス 使用可能文字: IPアドレス(CIDR表記)

応答フィールド

フィールド (項目)	型	説明
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アドレス
␣state	string	DevOpsサーバーのステータス 値: RUNNING (稼働中) FAILED (エラー) CREATING (作成中) DELETEING (削除中) PROCESSING (処理中) UPGRADING (アップグレード中) BACKING-UP (バックアップ中)
␣status	object
␣␣code	integer	DevOpsサーバーのステータスコード 値: 100 (稼働中/RUNNING) 200 (処理中/PROCESSING) 300 (警告/WARNING) 400 (エラー/FAILED)
␣␣name	string	DevOpsサーバーのステータス詳細 値: CREATING (DevOpsサーバー作成中) RESTORING (DevOpsサーバーリストア中) PROCESSING (DevOpsサーバー処理中) UPGRADING (DevOpsサーバーアップグレード中) BACKING-UP (DevOpsサーバーバックアップ中) DELETING (DevOpsサーバー削除中) RUNNING (DevOpsサーバー正常状態) FAILED_INSTANCE_CREATE (DevOpsサーバー作成エラー) FAILED_INSTANCE_DELETE (DevOpsサーバー削除エラー) FAILED_INSTANCE_REBOOT (DevOpsサーバー再起動エラー) FAILED_INSTANCE_BACKUP (DevOpsサーバーのバックアップエラー) FAILED_INSTANCE_UPGRADE (DevOpsサーバーのアップグレードエラー) FAILED_INSTANCE_OPTOUT (解約時のDevOpsサーバー削除エラー) FAILED_INSTANCE_EXTENDDISK (DevOpsサーバーのディスク拡張エラー) FAILED_INSTANCE_RESTORE (DevOpsサーバーのリストアエラー) FAILED_INSTANCE_CONFIGNETWORK (DevOpsサーバーのネットワーク変更エラー) FAILED_INSTANCE_SYSTEM (DevOpsサーバーのチェックエラー) FAILED_INSTANCE_UPDATEMETA (DevOpsサーバーのメタ情報更新エラー) FAILED_INSTANCE_UPDATESPEC (DevOpsサーバーのスペック変更エラー) FAILED_INSTANCE_UPDATEPARAM (DevOpsサーバーのパラメータ適用エラー) FAILED_INSTANCE_INITROOTPASSWORD (DevOpsサーバーのrootパスワード登録エラー) WARNING_INSTANCE_CONFIGNETWORK (DevOpsサーバー内のネットワーク変更エラー) FAILED_INSTANCE_INTERNALERROR (予期せぬエラー)
␣createTime	string	DevOpsサーバーの作成日時

リクエストサンプル

    curl -XPOST https://jp-east-1.devops.api.nifcloud.com/v1/instances:restore
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "backupId":"BackUPID1234567890abcdefghijklnm",
    "instanceId":"gitlab1",
    "instanceType":"e-large",
    "firewallGroupName":"gitlab1fw",
    "parameterGroupName":"gitlab1pg",
    "diskSize":100,
    "availabilityZone":"east-11",
    "description":"production",
    "networkConfig":{
        "networkId":"net-abcdefgh",
        "privateAddress":"x.x.x.x"
    }
}'

  

応答サンプル

    {
    "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":{},
        "state":"RESTORING",
        "status":{
            "code":200,
            "name":"RESTORING"
        },
        "createTime":"2022-08-01 17:32:28 UTC"
    }
}