この操作では、 サイトモニタリングタスクを作成します。

現在、サイトモニタリングでは、HTTP、Ping、TCP、UDP、DNS、SMTP、POP3、FTP のプロトコルがサポートされています。各プロトコルには、OptionsJson パラメーターで指定された特定の拡張オプションがあります。 各プロトコルでサポートされている拡張オプションは下表のとおりです。

HTTP

パラメーター

データ型

説明

http_method

String

HTTP メソッド。 GET、POST、HEAD の HTTP メソッドがサポートされています。 既定値 : GET 。

header

String

ユーザー定義の HTTP ヘッダー。 ヘッダーを改行 ("\n") で区切ります。 各行のヘッダーの形式は、HTTP プロトコルの要件を満たす必要があります (ヘッダーの名前と値をコロン (:) で区切ります) 。

cookie

String

HTTP クッキー。 HTTP リクエスト標準に準拠してこのパラメーターを設定します。

request_content

String

リクエストのコンテンツ。 コンテンツは、JSON 形式またはフォーム形式にすることができます。 このパラメーターが指定されていない場合、本文なしのリクエストになります。

response_content

String

レスポンスにおいて予期されるコンテンツまたは予期されないコンテンツ。 HTTP サーバーから返されるコンテンツの最初の 64 KB は、モニタリングプロセスでチェックされます。

match_rule

String

マッチングルール。 レスポンスに response_content パラメーターで指定されたコンテンツが含まれていない場合、値が 0 であればモニタリングが成功したことを示します。レスポンスに response_content パラメーターで指定されたコンテンツが含まれている場合、値が 1 であればモニタリングが成功したことを示します。

username

String

HTTP リクエストの認証に使用されるユーザー名。 このパラメーターが指定されている場合、HTTP リクエストには基本認証ヘッダーが含まれます。

password

String

HTTP リクエストの認証に使用されるパスワード。

time_out

Integer

タイムアウトの値。 単位 : ミリ秒。 既定値 : 5000 。

max_redirect

Integer

リダイレクトの最大数。 既定値は ECS 検出ポイントの場合は 5、キャリア検出ポイントの場合は 2 になります。リダイレクトを無効化するには、このパラメーターを 0 に設定します。有効値 : 0 ~ 50。

Ping

パラメーター

データ型

説明

failure_rate

Integer

失敗率のしきい値。 失敗率がこの値を超えるとモニタリングは失敗し、エラー 610 (PingAllFail) または 615 (PingPartialFail) が返されます。 既定値: 0.1 。

ping_num

Integer

ターゲット URL またはターゲット IP アドレスが ping された回数。 デフォルト値: 20 。 有効値: 1 ~ 100。

DNS

パラメーター

データ型

説明

dns_server

String

DNS サーバーのドメイン名または IP アドレス。

dns_type

String

照会する DNS レコードの種類。 有効値 : A、NS、CNAME、MX、TXT、ANY。

expect_value

String

期待値のリスト。 期待値は、スペースで区切ります。

match_rule

String

期待値リストと返される DNS レコードリストのリレーションシップ。 2 つのリストが指定されたリレーションシップを満たしていない場合、モニタリングは失敗します。

空の文字列または IN_DNS : 期待値のリストは返された DNS レコードリストのサブセットです。

DNS_IN : 返された DNS レコードリストは期待値リストのサブセットです。

EQUAL : 返された DNS レコードリストは期待値リストと同一です。

ANY : 返された DNS レコードリストは期待値リストと交差します。

FTP

パラメーター

データ型

説明

port

Integer

FTP サーバーのポート番号。 このパラメーターが指定されていない場合、既定のポート番号が使用されます。 既定のポート番号は FTP の場合は 21、FTPS の場合は 990 です。

username

String

FTP サーバーへのログオンに使用されるユーザー名。このパラメーターが指定されていない場合は、匿名ログオンが使用されます。 匿名ログオンの際のユーザー名とパスワードはは、匿名、ftp@example.com になります。

password

String

FTP サーバーへのログオンに使用されるパスワード。

POP3 または SMTP

パラメーター

データ型

説明

port

Integer

POP3 サーバーのポート番号。 既定のポート番号は、POP3 の場合は 110、POP3S の場合は 995 です。

username

String

サーバーへのログオンに使用されるユーザー名。

password

String

サーバーへのログオンに使用されるパスワード。

TCP または UDP

パラメーター

データ型

説明

port

Integer

モニタリングする TCP または UDP ポート番号。

request_content

String

リクエストのコンテンツ。 request_format パラメーターの値が 16 進数の場合、request_content パラメーターの値は 16 進数形式である必要があります。

request_format

String

リクエストコンテンツの形式。 request_format パラメーターの値が16 進数でない場合、request_content パラメーターの値は共通テキストとしてサーバーに送信されます。

response_content

String

予想されるレスポンスコンテンツ。 サーバーのレスポンスに response_content パラメーターで指定されたコンテンツが含まれていない場合、モニタリングは失敗します。 response_format パラメーターの値が 16 進数の場合、response_content パラメーターの値は 16 進数である必要があります。response_format パラメーターの値が 16 進数でない場合、response_content パラメーターの値は共通テキストとして解釈されます。

デバッグ

API の使用を簡単にするため、Alibaba Cloud は OpenAPI Explorer を提供しています。 OpenAPI Explorerを使用して、API の検索、API の呼び出し、および SDK サンプルコードの動的な生成を行うことができます。

リクエストパラメーター

パラメーター データ型 必須/省略可能 説明
Action String 必須 CreateSiteMonitor

実行する操作。 このパラメーターを CreateSiteMonitor に設定します。

Address String 必須 http://www.aliyun.com

サイトモニタリングタスクによってモニタリングされる URL または IP アドレス。

TaskName String 必須 Website monitoring

サイトモニタリングタスクの名前。 名前の長さは 4 ~ 100 文字である必要があります。 名前には、文字、数字、アンダースコアが使用可能です。

TaskType String 必須 HTTP

サイトモニタリングタスクのプロトコル。 現在、サイトモニタリングでは、HTTP、Ping、TCP、UDP、DNS、SMTP、POP3、FTP のプロトコルがサポートされています。

AlertIds String 省略可能 49f7c317-7645-4cc9-94fd-ea42e122****

サイトモニタリングタスクに関連付ける既存のアラートルールの ID 。

Interval String 省略可能 1

サイトモニタリングタスクのモニタリング実行間隔。 単位 : 分。 有効値 : 1、5、15。 既定値: 1 。

IspCities String 省略可能 [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]

JSON 配列内の検出ポイント。 例えば、[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]は、北京、杭州、青島のそれぞれの検出ポイントを示します。

DescribeISPAreaCity を呼び出して、検出ポイント情報を照会できます。 このパラメーターが指定されていない場合、モニタリングの 3 つの検出ポイントがランダムに選択されます。

OptionsJson String 省略可能 {"time_out":5000}

サイトモニタリングタスクのプロトコルの拡張オプション。 オプションはプロトコルによって異なります。

各プロトコルには、OptionsJson パラメーターで指定された特定の拡張オプションがあります。たとえば、OptionsJson パラメーターは、DNS の次の値に設定できます。

{ "dns_server":"8.8.8.8" }

レスポンスパラメーター

パラメーター データ型 説明
AlertRule String [{"alarmActions":["Default alert group"],"metricName":"Availability","expression":"$Availability<96"}]

サイトモニタリングタスクの作成時または変更時に設定されたアラートルール。この値は、次の形式の JSON 配列になります。

[{"alarmActions":["xxx"],"metricName":"Availability","expression":"$Availability<96"}].

alarmActions のフィールドは、アラート通知の送信先アラートグループを示します。 metricName フィールドはメトリックを示します。 metricName フィールドの値は、Availability (使用可能な検出ポイントのパーセンテージ)、または AvailableNumber (使用可能な検出ポイントの数)にすることができます。

Code String 200

HTTP ステータスコード。 値が 200 の場合、呼び出しが成功したことを示します。

Data

サイトモニタリングタスクを作成した結果。

└AttachAlertResult

サイトモニタリングタスクを既存のアラートルールに関連付けた結果。

└Code String 200

HTTP ステータスコード。 値が 200 の場合、サイトモニタリングタスクが既存のアラートルールに関連付けられていることを示します。

└Message String success

サイトモニタリングタスクと既存のアラートルールの関連付けに関するエラーメッセージ。

└RequestId String 32565d-233-1b98-2231-892813f86c71

サイトモニタリングタスクを既存のアラートルールに関連付るリクエストの ID。

└RuleId String ruleId12345

サイトモニタリングタスクに関連付ける既存のアラートルールの ID 。

└Success String true

サイトモニタリングタスクが既存のアラートルールに関連付けられているかを示します。

Message String successful

エラーメッセージ。

RequestId String 68192f5d-0d45-4b98-9724-892813f86c71

リクエストの ID 。

Success String true

呼び出しが成功したかを示します。

リクエストの例


http(s)://[Endpoint]/? Action=CreateSiteMonitor
&Address=http://www.aliyun.com
&TaskName=Website monitoring
&TaskType=HTTP
&<Common request parameters>

通常のレスポンス例

XML形式

<DisableSiteMonitorsResponse>
  <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
  <Success>true</Success>
  <Code>200</Code>
  <Message>successful</Message>
</DisableSiteMonitorsResponse>

JSON 形式

{
	"Message":"successful",
	"Success":true,
	"Code": "200"
}

エラーコード

エラーコードを表示