モニタリングリストの照会

Prev Next

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

モニタリングサービスの全リストを照会します。

リクエスト

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

メソッド URI
GET /api/v1/scenarios

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://wms.apigw.ntruss.com/api/v1/scenarios' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
name String - モニタリングサービス名
monitoringType String - モニタリングタイプ
  • URL | SCENARIO
    • URL: モニタリングシナリオステップに URLアクセスのステップだけ追加された場合
    • SCENARIO: モニタリングシナリオステップに URLアクセスを含め2つ以上のステップが追加された場合
interval Integer - モニタリング実行周期(分)
  • 1 | 5 | 10
requestTimeout Integer - モニタリングのリクエスト待ち時間(ミリ秒)
  • 5000 | 10000 | 30000
runTimeout Integer - モニタリングのシナリオ実行待ち時間(ミリ秒)
  • 30000 | 40000 | 50000 | 60000
serviceType String - モニタリングのサービスタイプ
  • PC | MOBILE
serviceYn Boolean - モニタリングの状態
  • true | false
    • true: 開始
    • false: 一時停止
methodType String - モニタリングのリクエストタイプ
  • GET | POST | DELETE | PUT
url String - Webサービスの URL
  • モニタリング対象
historyId String - 履歴管理 ID
scenarioId Integer - シナリオ ID

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

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

レスポンス例

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

[
    {
        "name": "ncloud_test",
        "monitoringType": "SCENARIO",
        "interval": 1,
        "requestTimeout": 5000,
        "runTimeout": 30000,
        "serviceType": "PC",
        "serviceYn": true,
        "methodType": "GET",
        "url": "https://www.ncloud.com",
        "historyId": 1,
        "scenarioId": 7488
    },
    {
        "name": "example_test",
        "monitoringType": "URL",
        "interval": 1,
        "requestTimeout": 5000,
        "runTimeout": 30000,
        "serviceType": "PC",
        "serviceYn": true,
        "methodType": "GET",
        "url": "http://www.example.com",
        "historyId": 1,
        "scenarioId": 7479
    }
]