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

ListInstances

処理概要

DevOpsサーバーの情報一覧を取得します。

リクエストURL

GET /v1/instances

指定するパラメーター

なし

応答フィールド

フィールド (項目)	型	説明
instances[]	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サーバーのステータス 値: 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_SETUPALERT (DevOpsサーバーのアラート設定エラー) FAILED_INSTANCE_INTERNALERROR (予期せぬエラー)
␣createTime	string	DevOpsサーバーの作成日時

リクエストサンプル

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

  

応答サンプル

    {
    "instances":[
        {
            "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":[
                "15.3.5-ee.0"
            ],
            "registryUrl":"https://registry-gitlab1.jp-east-1.gitlab.devops.nifcloud.com",
            "instanceType":"e-large",
            "publicIpAddress":"x.x.x.x",
            "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"
            },
            "to":"alrt@example.com",
            "state":"RUNNING",
            "status":{
                "code":100,
                "name":"RUNNING"
            },
            "createTime":"2022-08-01 17:32:28 UTC"
        }
    ]
}