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

SetupAlert

処理概要

指定したDevOpsサーバーのアラート設定を変更します。
空文字を設定した場合はアラート設定を解除します。

リクエストURL

POST /v1/instances/{InstanceId}:setupAlert

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
InstanceId	string	DevOpsサーバー名	○

リクエストボディ

パラメーター	型	説明	必須
to	string	アラート通知先メールアドレス 使用可能文字: 320文字以下のメールアドレスフォーマット、空文字を設定した場合はアラート設定を解除	○

応答フィールド

フィールド (項目)	型	説明
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サーバーのステータス 値: 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 -XPOST https://jp-east-1.devops.api.nifcloud.com/v1/instances/gitlab1:setupAlert
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'
    -H 'content-type:application/json'
    -d '
{
    "to":"alert@example.com"
}'

  

応答サンプル

    {
    "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":"x.x.x.x",
        "networkConfig":{},
        "objectStorageConfig":{},
        "to":"alrt@example.com",
        "state":"PROCESSING",
        "status":{
            "code":200,
            "name":"PROCESSING"
        },
        "createTime":"2022-08-01 17:32:28 UTC"
    }
}