QueryLineChart

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

Network Traffic Monitoringサービスの line chartを照会します。

リクエスト

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

メソッド	URI
POST	/chart/v1/vpc/traffic/chart/lines

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

次のように必須の有無を更新しました:

フィールド	タイプ	必須の有無	説明
`vpcMetricType`	String	Required	トラフィック収集情報 `BYTES_MAX` \| `BYTES_SUM` \| `PACKETS_MAX` \| `PACKETS_SUM` `BYTES_MAX`: 1分間のトラフィックの最大値 `BYTES_SUM`: 1分間のトラフィック合計の平均 `PACKETS_MAX`: 1分間のトラフィックの最大値 `PACKETS_SUM`: 1分間のパケット合計の平均
`directionType`	String	Required	トラフィックの方向 `IN` \| `OUT` \| `ALL`
`trafficType`	String	Required	トラフィックタイプ `INTERNET` \| `PRIVATE`
`period`	String	Required	単位時間 `DAY` \| `HOUR` \| `MINUTE` \| `THIRTY_MINUTE` \| `FIFTEEN_MINUTE`
`groupingType`	String	Required	グループ化タイプ `SERVER` \| `COUNTRY` \| `CITY` \| `REGION` \| `AS` \| `VPC` \| `SUBNET` \| `TYPE`
`startTime`	Integer	Optional	測定開始時間(ミリ秒) Unix Timestamp形式
`endTime`	Integer	Optional	測定終了時間(ミリ秒) Unix Timestamp形式
`asNo`	String	Optional	通信キャリア番号
`cityCode`	String	Optional	都市コード
`countryCode`	String	Optional	国コード
`instanceNo`	String	Optional	インスタンス番号
`regionNo`	String	Optional	リージョン番号
`typeCode`	String	Optional	タイプコード
`vpcNo`	String	Optional	VPC番号
`subnetNo`	String	Optional	Subnet番号
`limit`	Integer	Optional	最大 line数 1~3000 (デフォルト: 10)

リクエスト例

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

curl --location --request POST 'https://vpc-ntm.apigw.ntruss.com/chart/v1/vpc/traffic/chart/lines' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-dmn_cd: PUB' \
--data '{
    "vpcMetricType": "BYTES_MAX",
    "directionType": "ALL",
    "trafficType": "PRIVATE",
    "period": "DAY",
    "groupingType": "REGION"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`charts`	Array	-	line chartの照会結果

`VpcLineChart`

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

フィールド	タイプ	必須の有無	説明
`name`	String	-	`groupingType`名
`no`	String	-	`groupingType`番号
`timeValue`	Array	-	時間別トラフィック
`inTimeValue`	Array	-	時間別インバウンドトラフィック
`outTimeValue`	Array	-	時間別アウトバウンドトラフィック
`totalLineStatistic`	Array	-	トラフィック統計情報
`inLineStatistic`	Array	-	インバウンドトラフィック統計情報
`outLineStatistic`	Array	-	アウトバウンドトラフィック統計情報

`Timevalue`

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

フィールド	タイプ	必須の有無	説明
`time`	Integer	-	時間 Unix Timestamp形式
`value`	Number	-	トラフィック(bps)

`VpcLineStatistic`

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

フィールド	タイプ	必須の有無	説明
`sum`	Number	-	トラフィックの合計(bps)
`avg`	Number	-	トラフィックの平均(bps)
`min`	Number	-	トラフィックの最小値(bps)
`max`	Number	-	トラフィックの最大値(bps)
`last`	Number	-	トラフィックの最終値(bps)

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

Network Traffic Monitoring APIで共通して使用されるレスポンスステータスコードの詳細は、Network Traffic Monitoringのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "charts": [
    {
      "name": "Korea",
      "no": "1",
      "timeValue": [
				{
					"time": 1644205500000,
					"value": 0.0
				},
				{
					"time": 1644206400000,
					"value": 17172.0
				}
			],
      "inTimeValue": [
				{
					"time": 1644205500000,
					"value": 0.0
				},
				{
					"time": 1644206400000,
					"value": 0.0
				}
			],
      "outTimeValue": [
				{
					"time": 1644205500000,
					"value": 0.0
				},
				{
					"time": 1644206400000,
					"value": 17172.0
				}
			],
      "inLineStatistic": {
        "sum": 0.0,
        "avg": 0.0,
        "min": 0.0,
        "max": 0.0,
        "last": 0.0
      },
      "outLineStatistic": {
        "sum": 0.0,
        "avg": 0.0,
        "min": 0.0,
        "max": 0.0,
        "last": 0.0
      },
      "totalLineStatistic": {
        "sum": 0.0,
        "avg": 0.0,
        "min": 0.0,
        "max": 0.0,
        "last": 0.0
      }
    }
  ]
}

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

What's Next

QueryTopsChart

リクエスト
レスポンス

タグ

Network Traffic Monitoring