ModifySiteMonitor によるサイトモニタリングタスクの修正 - CMS - Alibaba Cloud - Cloud Monitor

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

今すぐお試しください

この 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:ModifySiteMonitor

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Address	string	任意	モニタリングタスクの URL または IP アドレス。	http://www.aliyun.com
TaskId	string	必須	モニタリングタスクの ID。	2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskName	string	任意	モニタリングタスクの名前。名前は 4～100 文字で、英字、数字、アンダースコア（_）、および中国語文字を含めることができます。	HanZhou_ECS2
Interval	string	任意	モニタリング周波数。有効な値: 1、5、15。単位: 分。デフォルト値: 1。	1
IspCities	string	任意	検出ポイント情報。値は JSONArray フォーマットです。例: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`。ここで `city` はそれぞれシンガポール、クアラルンプール、ジャカルタに対応します。説明 DescribeSiteMonitorISPCityList 操作を呼び出して検出ポイント情報をクエリできます。詳細については、 DescribeSiteMonitorISPCityList を参照してください。このパラメーターが空の場合、システムはランダムに 3 つの検出ポイントを選択します。	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	任意	モニタリングタスクのプロトコルの種類に対する高度な拡張オプション。プロトコルの種類によって、対応する拡張オプションが異なります。	{"time_out":5000}
AlertIds	string	任意	アラートルールの ID。CloudMonitor の既存のアラートルールの ID です。DescribeMetricRuleList 操作を呼び出してアラートルール ID をクエリできます。詳細については、 DescribeMetricRuleList を参照してください。ID のフォーマットについては、関連ドキュメントを参照してください。	49f7c317-7645-4cc9-94fd-ea42e122****
IntervalUnit	string	任意	監視メトリクスの単位。単位: ミリ秒（ms）。	ms
CustomSchedule	string	任意	カスタム監視スケジュール。月曜日から日曜日までの特定の時間帯を選択してモニタリングできます。	{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}

サイトモニタリングは以下の 8 つのタスクタイプをサポートしています。各タスクタイプの拡張オプション（OptionsJson）については、以下の表で説明します。

HTTP。

名前	タイプ	説明
http_method	String	HTTP リクエストメソッド。有効な値: GET、POST、HEAD。デフォルト値: GET。
header	String	改行（\n）で区切られたカスタム HTTP ヘッダー。各ヘッダーは HTTP プロトコルフォーマット（コロンで区切られたキーと値のペア）に準拠する必要があります。
cookie	String	標準の HTTP リクエストフォーマットに従った cookie。
request_content	String	リクエストコンテンツ。JSON とフォームの 2 つのフォーマットがサポートされています。このパラメーターを指定しない場合、リクエストにはボディが含まれません。
response_content	String	期待されるレスポンスコンテンツ。モニタリング中、HTTP サーバーから返された最初の 64 バイトがチェックされます。
match_rule	String	0: レスポンスに response_content が含まれていない場合、モニタリングは成功です。 1: レスポンスに response_content が含まれている場合、モニタリングは成功です。
username	String	ユーザー名が指定された場合、HTTP リクエストに BasicAuth ヘッダーが含まれます。
password	String	HTTP リクエスト認証のパスワード。
time_out	int	タイムアウト期間。単位: ミリ秒。デフォルト値: 5。
max_redirect	int	最大リダイレクト回数。デフォルト値は ECS 検出ポイントの場合は 5、キャリア検出ポイントの場合は 2 です。リダイレクトを無効にするには、このパラメーターを 0 に設定します。有効な値: 0～50。

PING。

名前	タイプ	説明
failure_rate	int	PING 失敗率がこの値を超えると、モニタリングが失敗し、610（PingAllFail）または 615（PingPartialFail）を返します。デフォルト値: 0.1。
ping_num	int	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 リストの関係。指定されたルールが満たされない場合、モニタリングは失敗します。空文字列または IN_DNS: 期待値リストは DNS リストのサブセットです。 DNS_IN: DNS リストは期待値リストのサブセットです。 EQUAL: DNS リストは期待値リストと等しいです。 ANY: DNS リストと期待値リストに空でない共通部分があります。

FTP。

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

POP3/SMTP。

名前	タイプ	説明
port	int	POP3 サーバーのポート番号。POP3 のデフォルト値: 110。POP3s のデフォルト値: 995。
username	string	POP3/SMTP のユーザー名。
password	string	POP3/SMTP のパスワード。

TCP/UDP。

名前	タイプ	説明
port	int	TCP/UDP サーバーのポート。
request_content	string	リクエストコンテンツ。request_format が hex に設定されている場合、request_content の値は 16 進数コンパクトフォーマットです。
request_format	string	request_format がその他の値に設定されている場合、request_content はプレーン文字列として TCP/UDP サーバーに送信されます。
response_content	string	レスポンスコンテンツ。TCP/UDP サーバーから返されたコンテンツに response_content が含まれていない場合、モニタリングは失敗します。 response_format が hex に設定されている場合、response_content の値は 16 進数コンパクトフォーマットです。 response_content がその他の値に設定されている場合、response_content はプレーン文字列です。

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	状態コード。説明値 200 は成功を示します。	200
Message	string	返されたメッセージ。	successful
RequestId	string	リクエスト ID。	68192f5d-0d45-4b98-9724-892813f86c71
Success	string	操作が成功したかどうかを示します。有効な値: true: 操作が成功しました。 false: 操作が失敗しました。	true
Data	object	ノードタスク結果の詳細。
count	integer	モニタリングタスクの数。	1

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
  "Success": "true",
  "Data": {
    "count": 1
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidQueryParameter	%s
400	IllegalAddress	Illegal HTTP address
400	OperationError	Operation failed
400	TaskNotExists	Task does not exist
400	OperatorInvalid	%s
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	%s
500	InternetServerError	System internal error.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.
403	RestrictedUser	The user's operation is restricted, please register NAAM product code.
403	UnauthorizedTasks	You are not permitted to operate the specified tasks.
404	TaskNotExist	The specified task does not exist.
406	ExceedingQuota	Exceeding quota limits.
429	ThrottlingException	The request was denied due to request throttling.
409	%s	%s

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

変更履歴

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