QueryTopsChart
    • PDF

    QueryTopsChart

    • PDF

    記事の要約

    VPC環境で利用できます。

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

    リクエスト

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

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

    リクエストヘッダ

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

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    vpcMetricTypeStringRequiredトラフィック収集情報
    • BYTES_MAX | BYTES_SUM | PACKETS_MAX | PACKETS_SUM
      • BYTES_MAX: 1分間のトラフィックの最大値
      • BYTES_SUM: 1分間のトラフィック合計の平均
      • PACKETS_MAX: 1分間のトラフィックの最大値
      • PACKETS_SUM: 1分間のパケット合計の平均
    directionTypeStringRequiredトラフィックの方向
    • IN | OUT | ALL
    trafficTypeStringRequiredトラフィックタイプ
    • INTERNET | PRIVATE
    periodStringRequired単位時間
    • DAY | HOUR | MINUTE | THIRTY_MINUTE | FIFTEEN_MINUTE
    groupingTypeStringRequiredグループ化タイプ
    • SERVER | COUNTRY | CITY | REGION | AS | VPC | SUBNET | TYPE
    startTimeIntegerOptional測定開始時間(ミリ秒)
    • Unix Timestamp形式
    endTimeIntegerOptional測定終了時間(ミリ秒)
    • Unix Timestamp形式
    asNoStringOptional通信キャリア番号
    cityCodeStringOptional都市コード
    countryCodeStringOptional国コード
    instanceNoStringOptionalインスタンス番号
    regionNoStringOptionalリージョン番号
    typeCodeStringOptionalタイプコード
    vpcNoStringOptionalVPC番号
    subnetNoStringOptionalSubnet番号
    limitIntegerOptional最大 line数
    • 1~3000 (デフォルト: 10)

    リクエスト例

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

    curl --location --request POST 'https://vpc-ntm.apigw.ntruss.com/chart/v1/vpc/traffic/chart/tops' \
    --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"
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    topValuesArray-Top-N chartの照会結果

    TopValue

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

    フィールドタイプ必須の有無説明
    nameString-groupingType
    noString-groupingType番号
    valueInteger-トラフィック(bps)
    inValueInteger-インバウンドトラフィック(bps)
    outValueInteger-アウトバウンドトラフィック(bps)

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

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

    レスポンス例

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

    {
    	"topValues": [
    		{
    			"no": "1",
    			"name": "Korea",
    			"value": 41997,
    			"inValue": 41997,
    			"outValue": 0
    		}
    	]
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.