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

GetInstanceMetrics

処理概要

DevOpsサーバーのメトリックス情報を取得します。

リクエストURL

GET /v1/instances/{InstanceId}/metrics/{MetricsName}

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
InstanceId	string	DevOpsサーバー名	○
MetricsName	string	メトリック名 (cpu, memory, disk を指定可能)	○

クエリパラメーター

パラメーター	型	説明	必須
startTime	string	メトリックス取得開始時刻 使用可能文字: rfc3339 形式でミリ秒まで指定	○
endTime	string	メトリックス取得終了時刻 使用可能文字: rfc3339 形式でミリ秒まで指定	○

応答フィールド

フィールド (項目)	型	説明
metrics[]	object[]
␣timestamp	string	メトリックの取得時間、ISO8601形式
␣maxValue	double	メトリックの最大値
␣minValue	double	メトリックの最小値
␣value	double	メトリックの値
␣timezone	string	メトリックの取得時間のタイムゾーン

リクエストサンプル

    curl -XGET https://jp-east-1.devops.api.nifcloud.com/v1/instances/gitlab1/metrics/cpu?startTime=2015-07-01T20:10:30.781Z&endTime=2015-07-02T20:10:30.781Z
    -H 'X-Amz-Date: 20230401T000000Z'
    -H 'Authorization: AWS4-HMAC-SHA256 ...'

  

応答サンプル

    {
    "metrics":[
        {
            "timestamp":"2023-12-19T00:00:00Z",
            "maxValue":1.0,
            "minValue":0,
            "value":0.032114035087720094,
            "timezone":"UTC"
        }
    ]
}