CreateSiteMonitor を使用したサイト監視タスクの作成 - CMS

サイトモニタリングタスクを作成します。

操作説明

このトピックでは、サイトモニタリングタスクを作成する方法について説明します。この例では、Tokyo_ECS1 という名前のタスクを作成し、HTTPS 経由で URL https://www.aliyun.com をモニターします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:CreateSiteMonitor

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Address	string	必須	モニターする URL または IP アドレス。	https://www.aliyun.com
TaskType	string	必須	モニタリングタスクのタイプ。有効なプロトコルは、HTTP(S)、PING、TCP、UDP、DNS、SMTP、POP3、FTP、WEBSOCKET です。	HTTP
TaskName	string	必須	モニタリングタスクの名前。名前は 4～100 文字である必要があり、文字、数字、アンダースコア (_)、および漢字を含めることができます。	HanZhou_ECS1
Interval	string	任意	モニタリング周波数 (分)。有効値：1、5、15、30、60。デフォルト：1。	1
IspCities	string	任意	検出ポイント。このパラメーターを指定しない場合、システムは異なるインターネットサービスプロバイダー (ISP) から 3 つの検出ポイントをランダムに選択します。値は JSON 配列である必要があります。例：`[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`。値は、北京、杭州、青島に対応します。詳細については、「DescribeSiteMonitorISPCityList」をご参照ください。	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	任意	指定されたプロトコルの詳細オプション。利用可能なオプションは、プロトコルタイプによって異なります。	{"time_out":5000}
AlertIds	string	任意	アラートルールの ID。詳細については、「DescribeMetricRuleList」をご参照ください。	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
AgentGroup	string	任意	接続テストタスクの検出ポイントのグループ。 `PC` は PC 上の検出ポイントを示します。 `MOBILE` はモバイルデバイス上の検出ポイントを示します。 `FC` は VPC 内の検出ポイントを示します。デフォルト値は `PC` です。	PC
CustomSchedule	string	任意	カスタム検出スケジュール。検出する期間と曜日を指定します。	{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}
VpcConfig	string	任意	VPC で接続テストタスクを作成するために必要なネットワーク情報。これは、`vpcId`、`vswitchId`、`securityGroupId`、および `region` フィールドを含む JSON オブジェクトである必要があります。	{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}

次の表に、HTTP(S)、PING、TCP、UDP、DNS、WEBSOCKET、SMTP、POP3、および FTP タスクタイプの詳細パラメーターを示します。

HTTP(S)

パラメーター	タイプ	説明
http_method	String	HTTP または HTTPS リクエストメソッド。有効値：GET、POST、HEAD。デフォルト：GET。
header	String	カスタム HTTP ヘッダー。複数のヘッダーは改行 (\n) で区切ります。各ヘッダーは `key:value` 形式で、HTTP プロトコルに従う必要があります。
cookie	String	標準の HTTP リクエストクッキーとしてフォーマットされたクッキー。
request_content	String	リクエストコンテンツ (JSON またはフォーム形式)。このパラメーターを指定しない場合、リクエストボディは空になります。
response_content	String	期待される応答コンテンツ。システムはサーバーの応答の最初の 64 バイトをチェックします。
match_rule	String	0：応答に response_content の値が含まれていない場合、検出は成功です。 1：応答に response_content の値が含まれている場合、検出は成功です。
username	String	Basic 認証のユーザー名。指定した場合、`BasicAuth` ヘッダーが HTTP リクエストに含まれます。
password	String	Basic 認証のパスワード。
time_out	int	タイムアウト期間 (ミリ秒)。デフォルト：5000。
max_redirect	int	リダイレクトの最大数。デフォルト：ECS 検出ポイントの場合は 5、キャリア検出ポイントの場合は 2。リダイレクトを無効にするには 0 に設定します。有効値：0～50。

PING

パラメーター	タイプ	説明
failure_rate	Text	失敗率のしきい値。 ping の失敗率がこの値を超えると、検出は失敗し、エラーコード 610 (PingAllFail) または 615 (PingPartialFail) が返されます。デフォルト：0.1。
ping_num	int	送信する ping パケットの数。デフォルト：10。有効値：1～100。

パラメーター	タイプ	説明
dns_server	string	DNS サーバーのアドレス。ドメイン名または IP アドレスを指定できます。
dns_type	string	DNS クエリタイプ。有効値：A、NS、CNAME、MX、TXT、ANY、AAAA。
expect_value	string	スペースで区切られた期待値のリスト。
match_rule	string	期待値と DNS クエリ結果との間のマッチングルール。このルールが満たされない場合、検出は失敗します。 `IN_DNS `または空の文字列：期待値は DNS 結果のサブセットである必要があります。<br/>`DNS_IN`：DNS 結果は期待値のサブセットである必要があります。<br/>`EQUAL`：DNS 結果は期待値と同一である必要があります。<br/>`ANY`：DNS 結果と期待値には、少なくとも 1 つの共通の値が必要です。

パラメーター	タイプ	説明
port	int	FTP サーバーポート。デフォルト：FTP の場合は 21、FTPS の場合は 990。
username	string	FTP ログインのユーザー名。指定しない場合、匿名ログインが使用されます。
password	string	FTP ログインのパスワード。

POP3 または SMTP

パラメーター	タイプ	説明
port	int	サーバーポート。デフォルト：POP3 の場合は 110、POP3S の場合は 995、SMTP の場合は 25。
username	string	POP3 または SMTP ログインのユーザー名。ユーザー名とパスワードの両方が必要です。
password	string	POP3 または SMTP ログインのパスワード。ユーザー名とパスワードの両方が必要です。

TCP または UDP

パラメーター	タイプ	説明
port	int	TCP または UDP サーバーポート。
request_content	string	リクエストコンテンツ。 `request_format` が `hex` の場合、この値はコンパクトな 16 進数形式である必要があります。
request_format	string	リクエストコンテンツのフォーマット。これが `hex` でない場合、`request_content` は通常の文字列として送信されます。
response_content	string	期待される応答コンテンツ。サーバーの応答にこの値が含まれていない場合、検出は失敗します。 `request_format` が `hex` の場合、この値はコンパクトな 16 進数形式である必要があります。それ以外の場合は、通常の文字列として扱われます。

WEBSOCKET

パラメーター	タイプ	説明
request_content	string	送信するメッセージコンテンツ。
empty_message	boolean	サーバーからの空のメッセージまたはメッセージなしを成功と見なすかどうかを指定します。

レスポンスフィールド

フィールド	型	説明	例
	object	N/A.
Code	string	操作のステータスコード。説明 `200` の値は成功を示します。	200
Message	string	リクエストに対して返されたメッセージ。	Successful
RequestId	string	リクエストの ID。	68192f5d-0d45-4b98-9724-892813f86c71
Success	string	リクエストが成功したかどうかを示します。有効値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
Data	object	モニタリングタスクの結果。
AttachAlertResult	object
Contact	array<object>	アラートルールを関連付けた結果。
	object	単一のアラートルール関連付けの結果。
Code	string	関連付け操作のステータスコード。説明 `200` の値は成功を示します。	200
Message	string	関連付け操作に対して返されたメッセージ。	successful
RequestId	string	関連付け操作のリクエスト ID。	5dd33455-4f65-4b0c-9200-33d66f3f340b
Success	string	アラートルールが正常に関連付けられたかどうかを示します。有効値： true：関連付けは成功しました。 false：関連付けは失敗しました。	true
RuleId	string	アラートルールの ID。	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
CreateResultList	object
CreateResultList	array<object>	作成された各タスクの結果のリスト。これは、タスクの作成が成功した場合にのみ返されます。
	object	作成された単一タスクの結果。これは、タスクの作成が成功した場合にのみ返されます。
TaskId	string	作成されたモニタリングタスクの ID。	2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskName	string	作成されたモニタリングタスクの名前。	HanZhou_ECS1

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
  "Success": "true",
  "Data": {
    "AttachAlertResult": {
      "Contact": [
        {
          "Code": "200",
          "Message": "successful",
          "RequestId": "5dd33455-4f65-4b0c-9200-33d66f3f340b",
          "Success": "true",
          "RuleId": "SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent"
        }
      ]
    }
  },
  "CreateResultList": {
    "CreateResultList": [
      {
        "TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
        "TaskName": "HanZhou_ECS1"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidQueryParameter	%s
400	IllegalAddress	Illegal HTTP address
400	OperationError	Operation failed
400	TaskNotExists	Task does not exist
400	OperatorInvalid	Operator invalid
400	NameRepeat	Task name repeat
400	CreateAlarmError	Create alarm error
400	NameNotExists	Task name not exists
400	OperatorCityInvalid	Invalid Isp.
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	%s
403	RestrictedUser	The user's operation is restricted, please register NAAM product code
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.
409	%s	%s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。