GetMetricsGroup

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

サービス(商品)に対する特定の Rule Template(監視項目グループ)情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/cw_fea/real/cw/api/rule/group/metrics/query/{prodKey}/{id}

リクエストヘッダ

Cloud Insight APIで共通して使用されるヘッダの詳細は、Cloud Insightのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`prodKey`	String	Required	商品キー(cw_key) Cloud Insight指標を参照
`id`	String	Required	Rule Template ID GetMetricsGroupListを参照

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/rule/group/metrics/query/************/**********' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`createTime`	Integer	-	Rule Templateの作成日時(ミリ秒) Unix Timestamp形式
`domainCode`	String	-	NAVERクラウドプラットフォームのドメインコード
`groupDesc`	String	-	Rule Templateの説明
`groupName`	String	-	Rule Template名
`id`	String	-	Rule Template ID
`idDimension`	String	-	Dimension名
`metrics`	Array	-	Metricリスト
`prodKey`	String	Required	商品キー(cw_key) Cloud Insight指標を参照
`prodType`	String	-	商品タイプ
`regionCode`	String	-	リージョンコード
`temporaryGroup`	Boolean	-	Rule Templateを作成するかどうか `true` \| `false` `true`: Rule Templateを作成しないで Event Ruleを作成 `false`: Rule Templateを作成
`updateTime`	Integer	-	Rule Templateの更新日時(ミリ秒) Unix Timestamp形式

`metrics`

metricsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`options`	Object	-	集計方法 `"集計周期": [集計関数]`形式で表示集計周期: `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1` 集計関数: `COUNT` \| `SUM` \| `MAX` \| `MIN` \| `AVG`

参考

Metric Group情報関連フィールドの詳細は、MetricsGroupItemをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Cloud Insight APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "createTime": 1589769312574,
    "domainCode": "PUB",
    "groupDesc": "test-serverに対するメトリックグループです。",
    "groupName": "test-server",
    "id": "***********",
    "idDimension": "instanceNo",
    "metrics": [
        {
            "calculation": "AVG",
            "condition": "EQ",
            "desc": "network send fail packets average",
            "dimensions": [
                {
                    "dim": "type",
                    "val": "svr"
                }
            ],
            "duration": 1,
            "eventLevel": "INFO",
            "metric": "avg_snd_fail_packt_cnt",
            "metricGroupItemId": "metricGroupItemId001",
            "options": {
                "Min1": [
                    "COUNT",
                    "SUM",
                    "MAX",
                    "MIN",
                    "AVG"
                ],
                "Min5": [
                    "COUNT",
                    "SUM",
                    "MAX",
                    "MIN",
                    "AVG"
                ],
                "Min30": [
                    "COUNT",
                    "SUM",
                    "MAX",
                    "MIN",
                    "AVG"
                ],
                "Hour2": [
                    "COUNT",
                    "SUM",
                    "MAX",
                    "MIN",
                    "AVG"
                ],
                "Day1": [
                    "COUNT",
                    "SUM",
                    "MAX",
                    "MIN",
                    "AVG"
                ]
            },
            "threshold": "0"
        }
    ],
    "prodKey": "**********",
    "prodType": "system",
    "regionCode": "KR",
    "temporaryGroup": false,
    "updateTime": 1589770306595
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Cloud Insight