GetMetaServer

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

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

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

VPC環境で利用できます。

Network Traffic Monitoringサービスで使用可能な Server情報を照会します。

リクエスト

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

メソッド	URI
GET	/meta/v1/server

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`page`	Integer	Required	ページ番号 0~N
`size`	Integer	Required	ページ表示数 1~100
`privateIp`	String	Optional	Private IP
`publicIp`	Integer	Optional	Public IP
`regionCode`	String	Optional	リージョンコード KR (デフォルト)
`serverName`	Integer	Optional	Server名

リクエスト例

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

curl --location --request GET 'https://vpc-ntm.apigw.ntruss.com/meta/v1/server?regionCode=KR' \
--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' \

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`serverList`	Array	-	Serverリスト
`total`	Integer	-	レスポンス結果数

`serverList`

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

フィールド	タイプ	必須の有無	説明
`networkTrafficMonitoringInstanceNo`	Integer	-	Network Traffic Monitoringインスタンス番号
`subscribed`	Boolean	-	Network Traffic Monitoringは利用中かどうか `true` \| `false` `true`: 利用中 `false`: 利用中ではない

参考

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

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

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

レスポンス例

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

{
  "total": 7,
  "serverList": [
    {
      "instanceNo": 1777948,
      "serverName": "test-code003",
      "regionNo": 1,
      "regionCode": "KR",
      "regionName": "Korea",
      "privateIpList": [
        "***.***.***.***"
      ],
      "publicIp": null,
      "instanceStatusCode": "NSTOP",
      "instanceStatusName": "stopped",
      "networkTrafficMonitoringInstanceNo": 2094117,
      "subscribed": true
    },
    {
      "instanceNo": 1777945,
      "serverName": "test-code002",
      "regionNo": 1,
      "regionCode": "KR",
      "regionName": "Korea",
      "privateIpList": [
        "***.***.***.***"
      ],
      "publicIp": null,
      "instanceStatusCode": "RUN",
      "instanceStatusName": "running",
      "networkTrafficMonitoringInstanceNo": 1808470,
      "subscribed": true
    }
  ]
}

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

リクエスト

タグ

Network Traffic Monitoring