Management > Service Monitoring > APIガイド

基本情報

API Endpoint: https://api-service-monitoring.cloud.toast.com

バッチモニタリング

データ転送

  • バッチモニタリングサーバーに、検証が必要なデータを転送します。
  • バッチモニタリングに入力した検証情報に基づいたJSONタイプのデータを転送することができ、バッチモニタリングの検証に失敗した場合は障害に登録されます。

[URL]

POST /v1.0/monitoring/batchmon/appkey/{appKey}/scenarios/{scenarioId}
Content-Type: application/json

[Path Variables]

値 タイプ 必須かどうか 説明
appKey String Required サービスアプリケーションキー(サービス管理タブで確認可能)
scenarioId String Required サービスID

[Request Body]

{
    "issueDescription": "This is test message."
}

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pk": {
            "serviceId": "d781dafc-2d5e-3d11-a87e-529b0868ea4f",
            "requestId": "3f136280-9d6a-11e9-83b4-ff39d67ddecf"
        },
        "scenarioId": "b00699c0-96f4-11e9-a68b-a7aaea9ae346",
        "ipaddr": "192.168.0.1",
        "requestTime": "2099-12-31T00:00:00.000",
        "requestData": {
            "body": "{\"issueDescription\": \"This is test message.\"}"
        },
        "serviceCode": 0,
        "status": "beforeValidation"
    }
}
値 タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード(0は正常)
header.resultMessage String 失敗メッセージ
body.pk.serviceId String サービス固有ID
body.pk.requestId String リクエスト固有ID
body.scenarioId String シナリオ固有ID
body.requestData.body Object リクエストデータ
body.ipaddr String リクエスト者のIPアドレス
body.requestTime String リクエスト時刻(ISO 8601フォーマット)
body.serviceCode Integer サービス固有コード
body.status String リクエスト状態

シナリオ作成

データ転送

  • サービスモニタリングサーバーへシナリオ作成をリクエストする時、必要なデータを転送します。

[URL]

POST /open-api/v1.0/appkey/{appKey}/scenarios
Content-Type: application/json

[Path Variables]

値 タイプ 必須か 説明
appKey String Required サービスAppkey(サービス管理タブで確認可能)

[Request Header]

ヘッダ名 ヘッダ値
TOAST_PRODUCT_APPKEY Service Monitoringサービス管理メニューで右上URL & Appkeyを押すと確認できるAppkey

[Request Body]

{
   "url":"http://toast.com",
   "httpMethod":"GET",
   "validation":{
      "textValidation":{
         "textValidationType":"JSON",
         "textValidationInfos":[
            {
               "expression":"$.isSuccess",
               "operator":"EQ",
               "operand":"true"
            }
         ]
      },
      "responseCodes":[
         "200",
         "201"
      ]
   },
   "browserOption":{
      "OPT_LOCALE":"ko"
   },
   "ip":"toast.com",
   "scenarioType":"API",
   "scenarioName":"API test",
   "description":"API test",
   "monitoringRegion":[
      "KOR"
   ],
   "monitoringInterval":30,
   "errorLimitCount":0
}
  • Request Body
値 タイプ 該当するscenarioType 割当可能な値 必須か デフォルト値 説明
url String API httpまたはhttpsで始まるurl Y モニタリングを進行するAPIのURL
headers Map<String、String> API N APIを送る時に使用するヘッダ値
httpMethod String API GET、POST、DELETE、PUT Y APIのhttpMethod
requestBody String API N APIのrequestBody
browserOption Map<String, String> API {"OPT_LOCALE" : "kr"} Y {"OPT_LOCALE" : "kr"}
validation Object API Y APIの検証情報
scenarioType String API API Y シナリオタイプ
scenarioName String API Y シナリオ名
description String API Y シナリオの説明
monitoringRegion Set<String> API KOR、US Y KOR シナリオをモニタリングする地域
monitoringInterval Integer API N(使用しないの場合monitoringCronが必須) モニタリング間隔(秒)
monitoringCron String API 5桁のCron式 N(使用しないの場合monitoringIntervalが必須) モニタリング間隔(Cron式)
errorLimitCount Integer API 0以上の整数 Y 0 連続エラー許容回数
  • validation
値 タイプ 該当するscenarioType 割当可能な値 必須か デフォルト値 説明
validation.textValidation Object API N 文字列検証情報
validation.timeout Integer API 0以上の整数(ms単位) N タイムアウトしきい値
validation.responseCodes Set<String> API HTTP response code N 許可されたresponseCode
validation.avoidingValidationText String API N bodyに含まれる場合、配信を除く文字列
  • textValidation
値 タイプ 該当するscenarioType 割当可能な値 必須か デフォルト値 説明
validation.textValidation.textValidationType String API JSON、HTML、XML N 文字列を検証する時、ベースになるbodyタイプ
validation.textValidation.textValidationInfos List<Object> API N 文字列検証情報
  • textValidationInfo
値 タイプ 該当するscenarioType 割当可能な値 必須か デフォルト値 説明
validation.textValidation.textValidationInfo.operator String API CONTAINS、NOT_CONTAINS、EQ、NE、GT、GTE、LT、LTE Y 文字列演算子
validation.textValidation.textValidationInfo.expression String API Y 検証が必要な文字列
validation.textValidation.textValidationInfo.operand String API Y(N) 期待値

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "scenarioId": "0c96cff0-edc2-11ea-9760-8d94f461e6d4",
        "url": "http://toast.com",
        "httpMethod": "GET",
        "validation": {
            "textValidation": {
                "textValidationType": "JSON",
                "textValidationInfos": [
                    {
                        "operator": "EQ",
                        "expression": "$.isSuccess",
                        "operand": "true"
                    }
                ]
            },
            "responseCodes": [
                "200",
                "201"
            ]
        },
        "browserOption": {
            "OPT_LOCALE": "ko"
        },
        "ip": "toast.com",
        "scenarioType": "API",
        "scenarioName": "API test",
        "description": "API test",
        "monitoringRegion": [
            "KOR"
        ],
        "amendedTime": "2020-09-03T08:49:01.197+0000",
        "monitoringCron": "7 * * * * ? *",
        "status": "temporary",
        "errorLimitCount": 0
    }
}
値 タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード(0は正常)
header.resultMessage String 失敗メッセージ
body.scenarioId String シナリオのID
body.url String モニタリングを進行するAPIのURL
headers Map<String, String> APIを送る時に使用するヘッダ値
body.httpMethod String APIのhttpMethod
body.requestBody String APIのrequestBody
body.browserOption Map<String, String>
body.validation Object APIの検証情報
body.scenarioType String シナリオタイプ
body.scenarioName String シナリオ名
body.description String シナリオの説明
body.monitoringRegion Set<String> シナリオをモニタリングする地域
body.monitoringInterval Integer モニタリング間隔(秒)
body.monitoringCron String モニタリング間隔(Cron式)
body.errorLimitCount Integer 連続エラー許容回数
body.registeredTime String 登録時刻(yyyy-MM-dd'T'HH:mm:ss.SSSz)
body.amendedTime String 修正時刻(yyyy-MM-dd'T'HH:mm:ss.SSSz)
body.status String シナリオの現在状態
  • validation
値 タイプ 説明
body.validation.textValidation Object 文字列検証情報
body.validation.timeout Integer タイムアウトしきい値
body.validation.responseCodes Set<String> 許可されたresponseCode
body.validation.avoidingValidationText String bodyに含まれる場合、配信を除く文字列
  • textValidation
フィールド名(パス名) タイプ 説明
textValidationType String 文字列を検証する時、ベースになるbodyタイプ
body.validation.textValidation.textValidationInfos List<Object> 文字列検証情報
  • textValidationInfo
値 タイプ 説明
body.validation.textValidation.textValidationInfo.operator String 文字列演算子
body.validation.textValidation.textValidationInfo.expression String 検証が必要な文字列
body.validation.textValidation.textValidationInfo.operand String 期待値

登録されたシナリオ照会

[URL]

GET /open-api/v1.0/appkey/{appKey}/scenarios/{ScenarioId}
Content-Type: application/json

[Request Header]

ヘッダ名 ヘッダ値
TOAST_PRODUCT_APPKEY Service Monitoringサービス管理メニューで右上URL & Appkeyを押すと確認できるAppkey

[Path Variables]

値 タイプ 必須か 説明
appKey String Required サービスAppkey(サービス管理タブで確認可能)
scenarioId String Required シナリオID

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "scenarioId": "be50d2a0-e353-11ea-a3c2-ebd9a267dbb2",
        "validation": {
            "timeout": 5000,
            "responseValidation": [
                {
                    "position": 0,
                    "validationText": "Hello World!"
                },
                {
                    "position": 13,
                    "validationText": "It's new world!"
                }
            ],
            "lengthValidation": {
                "ENDIAN": "BIG",
                "POS": "4",
                "TYPE": "INT",
                "BASE": "15"
            }
        },
        "ip": "127.0.0.1",
        "scenarioType": "TCP",
        "scenarioName": "TCP Scenario Test",
        "description": "TCP Scenario Test",
        "monitoringRegion": [
            "KOR"
        ],
        "amendedTime": "2020-09-01T05:54:58.861+0000",
        "monitoringCron": "9 * * * * ? *",
        "status": "temporary",
        "errorLimitCount": 0,
        "request": "Hello World!",
        "port": 8080
    }
}
値 タイプ 該当するscenarioType 説明
header.isSuccessful Boolean - 成否
header.resultCode Integer - 失敗コード(0は正常)
header.resultMessage String - 失敗メッセージ
body.scenarioId String - シナリオのID
body.url String API、WEB、MODULE モニタリングを進行するAPIのURL
body.headers Map<String、String> API、WEB、MODULE APIを送る時に使用するヘッダ値
body.httpMethod String API、WEB、MODULE APIのhttpMethod
body.validation Object - シナリオの検証情報
body.requestBody String API、WEB、MODULE APIのrequestBody
body.browserOption Map<String、String> API、WEB、MODULE
body.ip String - モニタリングを進行する対象のIP
body.scenarioType String - シナリオタイプ
body.scenarioName String - シナリオ名
body.description String - シナリオの説明
body.monitoringRegion Set<String> - シナリオモニタリング地域
body.registeredTime String - 登録時刻(yyyy-MM-dd'T'HH:mm:ss.SSSz)
body.amendedTime String - 修正時刻(yyyy-MM-dd'T'HH:mm:ss.SSSz)
body.monitoringInterval Integer - モニタリング間隔(秒単位)
body.monitoringCron String - モニタリング間隔(Cron式)
body.status String - シナリオの現在状態
body.errorLimitCount Integer - 連続エラー許容回数
body.request String TCP、UDP TCP、UDPリクエスト時のリクエスト文字列
body.port Integer TCP、UDP TCP、UDPリクエスト時のポート番号
  • validation
値 タイプ 該当するscenarioType 説明
body.validation.textValidation Object API、WEB、MODULE 文字列検証情報
body.validation.timeout Integer - タイムアウトしきい値
body.validation.responseCodes Set<String> - 許可されたresponseCode
body.validation.avoidingValidationText String API、WEB、MODULE bodyに含まれる場合、配信を除く文字列
body.validation.imageValidationPaths List<String> API、WEB、MODULE イメージ検証パス
body.validation.responseValidation List<Object> TCP、UDP TCP、UDPリクエスト時、Resoponse検証リスト
body.validation.lengthValidation Map<String、String> TCP、UDP Responseの長さ検証
  • textValidation
値 タイプ 該当するscenarioType 説明
body.validation.textValidation.textValidationType String API, WEB, MODULE 文字列を検証する時、ベースになるbodyタイプ
body.validation.textValidation.textValidationInfos List<Object> API、WEB、MODULE 文字列検証情報
  • textValidationInfo
値 タイプ 該当するscenarioType 説明
body.validation.textValidation.textValidationInfo.operator String API, WEB, MODULE 文字列演算子
body.validation.textValidation.textValidationInfo.expression String API、WEB、MODULE 検証が必要な文字列
body.validation.textValidation.textValidationInfo.operand String API、WEB、MODULE 期待値
  • responseValidation
値 タイプ 該当するscenarioType 説明
body.validation.responseValidation.position Integer TCP、UDP Responseで検証する文字列が始まる位置
body.validation.responseValidation.validationText String TCP、UDP Responseで検証する文字列

登録されたシナリオ削除

[URL]

DELETE /open-api/v1.0/appkey/{appKey}/scenarios/{ScenarioId}
Content-Type: application/json

[Request Header]

ヘッダ名 ヘッダ値
TOAST_PRODUCT_APPKEY Service Monitoringサービス管理メニューで右上URL & Appkeyを押すと確認できるAppkey

[Path Variables]

値 タイプ 必須か 説明
appKey String Required サービスAppkey(サービス管理タブで確認可能)
scenarioId String Required シナリオID

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "scenarioId": "be50d2a0-e353-11ea-a3c2-ebd9a267dbb2",
        "validation": {
            "timeout": 5000,
            "responseValidation": [
                {
                    "position": 0,
                    "validationText": "Hello World!"
                },
                {
                    "position": 13,
                    "validationText": "It's new world!"
                }
            ],
            "lengthValidation": {
                "ENDIAN": "BIG",
                "POS": "4",
                "TYPE": "INT",
                "BASE": "15"
            }
        },
        "ip": "127.0.0.1",
        "scenarioType": "TCP",
        "scenarioName": "TCP Scenario Test",
        "description": "TCP Scenario Test",
        "monitoringRegion": [
            "KOR"
        ],
        "amendedTime": "2020-09-01T05:54:58.861+0000",
        "monitoringCron": "9 * * * * ? *",
        "status": "temporary",
        "errorLimitCount": 0,
        "request": "Hello World!",
        "port": 8080
    }
}
値 タイプ 該当するscenarioType 説明
header.isSuccessful Boolean - 成否
header.resultCode Integer - 失敗コード(0は正常)
header.resultMessage String - 失敗メッセージ
body.scenarioId String - シナリオのID
body.url String API、WEB、MODULE モニタリングを進行するAPIのURL
body.headers Map<String、String> API、WEB、MODULE APIを送る時に使用するヘッダ値
body.httpMethod String API、WEB、MODULE APIのhttpMethod
body.validation Object - シナリオの検証情報
body.requestBody String API、WEB、MODULE APIのrequestBody
body.browserOption Map<String、String> API、WEB、MODULE
body.ip String - モニタリングを進行する対象のIP
body.scenarioType String - シナリオタイプ
body.scenarioName String - シナリオ名
body.description String - シナリオの説明
body.monitoringRegion Set<String> - シナリオモニタリング地域
body.registeredTime String - 登録時刻(yyyy-MM-dd'T'HH:mm:ss.SSSz)
body.amendedTime String - 修正時刻(yyyy-MM-dd'T'HH:mm:ss.SSSz)
body.monitoringInterval Integer - モニタリング間隔(秒単位)
body.monitoringCron String - モニタリング間隔(Cron式)
body.status String - シナリオの現在状態
body.errorLimitCount Integer - 連続エラー許容回数
body.request String TCP、UDP TCP、UDPリクエスト時のリクエスト文字列
body.port Integer TCP、UDP TCP、UDPリクエスト時のポート番号
  • validation
値 タイプ 該当するscenarioType 説明
body.validation.textValidation Object API, WEB, MODULE 文字列検証情報
body.validation.timeout Integer - タイムアウトしきい値
body.validation.responseCodes Set<String> - 許可されたresponseCode
body.validation.avoidingValidationText String API、WEB、MODULE bodyに含まれる場合、配信を除く文字列
body.validation.imageValidationPaths List<String> API、WEB、MODULE イメージ検証パス
body.validation.responseValidation List<Object> TCP、UDP TCP、UDPリクエスト時のResoponse検証リスト
body.validation.lengthValidation Map<String、String> TCP、UDP Responseの長さ検証
  • textValidation
値 タイプ 該当するscenarioType 説明
body.validation.textValidation.textValidationType String API, WEB, MODULE 文字列を検証する時、ベースになるbodyタイプ
body.validation.textValidation.textValidationInfos List<Object> API, WEB, MODULE 文字列検証情報
  • textValidationInfo
値 タイプ 該当するscenarioType 説明
body.validation.textValidation.textValidationInfo.operator String API, WEB, MODULE 文字列演算子
body.validation.textValidation.textValidationInfo.expression String API、WEB、MODULE 検証が必要な文字列
body.validation.textValidation.textValidationInfo.operand String API、WEB、MODULE 期待値
  • responseValidation
値 タイプ 該当するscenarioType 説明
body.validation.responseValidation.position Integer TCP、UDP Responseで検証する文字列が始まる位置
body.validation.responseValidation.validationText String TCP、UDP Responseで検証する文字列

シナリオ修正

データ転送

  • サービスモニタリングサーバーへシナリオの修正をリクエストする時、必要なデータを転送します。

[URL]

PUT /open-api/v1.0/appkey/{appKey}/scenarios/{scenarioId}
Content-Type: application/json

[Path Variables]

値 タイプ 必須かどうか 説明
appKey String Required サービスAppkey(サービス管理タブで確認可能)
scenarioId String Required シナリオID(シナリオ編集ウィンドウで確認可能)

[Request Header]

ヘッダ名前 ヘッダ値
TOAST_PRODUCT_APPKEY Service Monitoring サービス管理メニューで右上URL & Appkeyをクリックすると確認できるAppkey

[Request Body]

{
   "url":"http://toast.com",
   "httpMethod":"GET",
   "validation":{
      "textValidation":{
         "textValidationType":"JSON",
         "textValidationInfos":[
            {
               "expression":"$.isSuccess",
               "operator":"EQ",
               "operand":"true"
            }
         ]
      },
      "responseCodes":[
         "200",
         "201"
      ]
   },
   "browserOption":{
      "OPT_LOCALE":"ko"
   },
   "ip":"toast.com",
   "scenarioType":"API",
   "scenarioName":"API test",
   "description":"API test",
   "monitoringRegion":[
      "KOR"
   ],
   "monitoringInterval":30,
   "errorLimitCount":0
}
  • Request Body
値 タイプ 該当するscenarioType 割り当て可能な値 必須かどうか 基本値 説明
url String API httpまたはhttpsで始まるurl Y モニタリングするAPIのURL
headers Map<String, String> API N APIを送る時に使用するヘッダ値
httpMethod String API GET、POST、DELETE、PUT Y APIのhttpMethod
requestBody String API N APIのrequestBody
browserOption Map<String, String> API {"OPT_LOCALE" : "kr"} Y {"OPT_LOCALE" : "kr"}
validation Object API Y APIの検証情報
scenarioType String API API Y シナリオタイプ
scenarioName String API Y シナリオ名
description String API Y シナリオ説明
monitoringRegion Set<String> API KOR, US Y KOR シナリオをモニタリングする地域
monitoringInterval Integer API N(使わない場合、monitoringCronが必須) モニタリング間隔(秒)
monitoringCron String API 5桁のCron式 N(使わない場合、monitoringIntervalが必須) モニタリング間隔(Cron式)
errorLimitCount Integer API 0以上の整数 Y 0 連続エラー許容回数
  • validation
値 タイプ 該当するscenarioType 割り当て可能な値 必須かどうか 基本値 説明
validation.textValidation Object API N 文字列検証情報
validation.timeout Integer API 0以上の整数(ms単位) N タイムアウトしきい値
validation.responseCodes Set<String> API HTTP response code N 許可されたresponseCode
validation.avoidingValidationText String API N bodyに含まれる場合、配信を除外する文字列
  • textValidation
値 タイプ 該当するscenarioType 割り当て可能な値 必須かどうか 基本値 説明
validation.textValidation.textValidationType String API JSON, HTML, XML N 文字列を検証する時、ベースになるbodyタイプ
validation.textValidation.textValidationInfos List<Object> API N 文字列検証情報
  • textValidationInfo
値 タイプ 該当するscenarioType 割り当て可能な値 必須かどうか 基本値 説明
validation.textValidation.textValidationInfo.operator String API CONTAINS、NOT_CONTAINS、EQ、NE、GT、GTE、LT、LTE Y 文字列演算子
validation.textValidation.textValidationInfo.expression String API Y 検証が必要な文字列
validation.textValidation.textValidationInfo.operand String API Y(N) 期待値

レスポンス

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "scenarioId": "0c96cff0-edc2-11ea-9760-8d94f461e6d4",
        "url": "http://toast.com",
        "httpMethod": "GET",
        "validation": {
            "textValidation": {
                "textValidationType": "JSON",
                "textValidationInfos": [
                    {
                        "operator": "EQ",
                        "expression": "$.isSuccess",
                        "operand": "true"
                    }
                ]
            },
            "responseCodes": [
                "200",
                "201"
            ]
        },
        "browserOption": {
            "OPT_LOCALE": "ko"
        },
        "ip": "toast.com",
        "scenarioType": "API",
        "scenarioName": "API test",
        "description": "API test",
        "monitoringRegion": [
            "KOR"
        ],
        "amendedTime": "2020-09-03T08:49:01.197+0000",
        "monitoringCron": "7 * * * * ? *",
        "status": "temporary",
        "errorLimitCount": 0
    }
}
値 タイプ 説明
header.isSuccessful Boolean 成否
header.resultCode Integer 失敗コード(0は正常)
header.resultMessage String 失敗メッセージ
body.scenarioId String シナリオID
body.url String モニタリングするAPIのURL
headers Map<String, String> APIを送る時に使用するヘッダ値
body.httpMethod String APIのhttpMethod
body.requestBody String APIのrequestBody
body.browserOption Map<String, String>
body.validation Object APIの検証情報
body.scenarioType String シナリオタイプ
body.scenarioName String シナリオ名
body.description String シナリオ説明
body.monitoringRegion Set<String> シナリオをモニタリングする地域
body.monitoringInterval Integer モニタリング間隔(秒)
body.monitoringCron String モニタリング間隔(Cron式)
body.errorLimitCount Integer 連続エラー許容回数
body.registeredTime String 登録時刻(yyyy-MM-dd'T'HH:mm:ss.SSSz)
body.amendedTime String 修正時刻(yyyy-MM-dd'T'HH:mm:ss.SSSz)
body.status String シナリオの現在状態
  • validation
値 タイプ 説明
body.validation.textValidation Object 文字列検証情報
body.validation.timeout Integer タイムアウトしきい値
body.validation.responseCodes Set<String> 許可されたresponseCode
body.validation.avoidingValidationText String bodyに含まれる場合、配信を除く文字列
  • textValidation
フィールド名(パス名) タイプ 説明
textValidationType String 文字列を検証する時、ベースになるbodyタイプ
body.validation.textValidation.textValidationInfos List<Object> 文字列検証情報
  • textValidationInfo
値 タイプ 説明
body.validation.textValidation.textValidationInfo.operator String 文字列演算子
body.validation.textValidation.textValidationInfo.expression String 検証が必要な文字列
body.validation.textValidation.textValidationInfo.operand String 期待値
目次
TOP