DescribeSiteMonitorList 操作を呼び出して、サイトモニタリングタスクのリストを照会します。
操作説明
この Topic では、現在のアカウントのサイトモニタリングタスクのリストをクエリする例を示します。応答は、現在のアカウントに HanZhou_ECS2 という名前のサイトモニタリングタスクが 1 つあることを示しています。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cms:DescribeSiteMonitorList |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| TaskId |
string |
任意 |
サイトモニタリングタスクの ID。 |
a1ecd34a-8157-44d9-b060-14950837**** |
| TaskType |
string |
任意 |
サイトモニタリングタスクのタイプ。CloudMonitor は次のタイプをサポートしています: HTTP、PING、TCP、UDP、DNS、SMTP、POP3、FTP。 |
HTTP |
| Keyword |
string |
任意 |
サイトモニタリングタスクを検索するために使用するキーワード。 説明
タスク名またはタスクアドレスに基づくあいまい一致がサポートされています。 |
site |
| Page |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。デフォルト値: 10。 |
10 |
| TaskState |
string |
任意 |
タスクのステータス。有効な値:
|
1 |
| AgentGroup |
string |
任意 |
タスクで使用される検出ポイントのタイプ。有効な値:
|
PC |
共通リクエストパラメーターの詳細については、共通パラメーター を参照してください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
なし。 |
||
| RequestId |
string |
リクエスト ID。 |
A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B |
| Success |
string |
操作が成功したかどうかを示します。有効な値:
|
true |
| Code |
string |
HTTP 状態コード。 説明
値 200 は成功を示します。 |
200 |
| Message |
string |
返されたメッセージ。 |
successful |
| PageNumber |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。 |
10 |
| TotalCount |
integer |
エントリの総数。 |
1 |
| SiteMonitors |
object |
||
| SiteMonitor |
array<object> |
サイトモニタリングタスクのリスト。 |
|
|
array<object> |
なし。 |
||
| TaskType |
string |
サイトモニタリングタスクで使用されるプロトコル。有効な値:HTTP、PING、TCP、UDP、DNS、SMTP、POP3、FTP。 |
TCP |
| UpdateTime |
string |
サイトモニタリングタスクが更新された時刻。 |
2022-03-08 17:14:31 |
| Interval |
string |
検出リクエストが送信される間隔。単位:分。 |
1 |
| TaskState |
string |
タスクのステータス。有効な値:
|
1 |
| CreateTime |
string |
サイトモニタリングタスクが作成された時刻。 |
2021-11-01 11:05:18 |
| TaskName |
string |
サイトモニタリングタスクの名前。 |
New monitoring task |
| Address |
string |
サイトモニタリングタスクによってモニターされる URL または IP アドレス。 |
https://aliyun.com |
| TaskId |
string |
サイトモニタリングタスクの ID。 |
f5783760-1b39-4b6b-80e8-453d962a**** |
| OptionsJson |
object |
サイトモニタリングタスクの拡張オプション。オプションは指定されたプロトコルによって異なります。詳細については、「 CreateSiteMonitor 」をご参照ください。 |
|
| password |
string |
SMTP、POP3、または FTP プロトコルのパスワード。 |
123**** |
| request_format |
string |
HTTP リクエストのフォーマット。有効な値:
|
hex |
| response_content |
string |
HTTP リクエストへの応答。
|
cf0f85 |
| failure_rate |
number |
パケット損失率。 説明
このパラメーターは、TaskType パラメーターが PING に設定されている場合にのみ返されます。 |
0.5 |
| time_out |
integer |
タイムアウト期間。単位:ミリ秒。 |
3000 |
| header |
string |
HTTP リクエストのヘッダー。HTTP ヘッダーは、キーと値がコロン (:) で区切られたキーと値のペアです。フォーマットは |
testKey:testValue |
| cookie |
string |
HTTP リクエストの cookie。 |
lang=en |
| port |
integer |
TCP、UDP、SMTP、または POP3 プロトコルのポート番号。 |
80 |
| ping_num |
integer |
PING プロトコルのホップ数。 |
20 |
| authentication |
integer |
セキュリティ認証機能が有効かどうかを示します。有効な値:
|
1 |
| http_method |
string |
HTTP リクエストメソッド。有効な値:
|
get |
| match_rule |
integer |
アラートルールが含まれるかどうかを示します。有効な値:
|
0 |
| dns_match_rule |
string |
期待されるエイリアスまたは IP アドレスのリストと DNS 結果のリストとの関係。有効な値:
|
IN_DNS |
| request_content |
string |
HTTP リクエストの内容。 |
cf0f85 |
| username |
string |
FTP、SMTP、または POP3 プロトコルのユーザー名。 |
testUser |
| response_format |
string |
HTTP 応答のフォーマット。有効な値:
|
hex |
| dns_type |
string |
DNS レコードのタイプ。このパラメーターは、TaskType パラメーターが DNS に設定されている場合にのみ返されます。有効な値:
|
A |
| dns_server |
string |
DNS サーバのドメイン名または IP アドレス。 |
192.168.XX.XX |
| enable_operator_dns |
boolean |
キャリアの DNS サーバが使用されるかどうかを示します。
|
true |
| attempts |
integer |
DNS 障害が発生した後のリトライ回数。 |
3 |
| protocol |
string |
DNS 検出のプロトコルタイプ。有効な値:
|
udp |
| proxy_protocol |
boolean |
PROXY プロトコルが有効かどうかを示します。有効な値:
|
false |
| acceptable_response_code |
string |
許容されるステータスコード。 説明
アサーションを設定することを推奨します。 |
400 |
| isBase64Encode |
string |
パスワードが Base64 アルゴリズムを使用してデコードされるかどうかを示します。有効な値:
|
false |
| cert_verify |
boolean |
証明書が検証されるかどうかを示します。有効な値:
|
false |
| unfollow_redirect |
boolean |
ステータスコード 301 または 302 が返された場合にリダイレクトをフォローするかどうかを示します。有効な値:
|
false |
| diagnosis_mtr |
boolean |
タスクが失敗した場合に、MTR を自動的に使用してネットワーク問題を診断するかどうかを示します。有効な値:
|
false |
| diagnosis_ping |
boolean |
検出タスクが失敗した場合に、ping リクエストを自動的に送信してネットワーク遅延を検出するかどうかを示します。有効な値:
|
false |
| retry_delay |
integer |
失敗した検出リクエストがリトライされる回数。 |
1 |
| assertions |
object |
||
| assertions |
array<object> |
アサーション。 |
|
|
object |
|||
| property |
string |
アサーションの解析パス。
|
json path |
| type |
string |
アサーションタイプ。有効な値:
|
response_time |
| operator |
string |
アサーションの比較演算子。有効な値:
|
lessThan |
| target |
string |
照合に使用される数値または文字。 |
1000 |
| AgentGroup |
string |
検出ポイントタイプ。有効な値:
|
PC |
例
成功レスポンス
JSONJSON
{
"RequestId": "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
"Success": "true",
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"SiteMonitors": {
"SiteMonitor": [
{
"TaskType": "TCP",
"UpdateTime": "2022-03-08 17:14:31",
"Interval": "1",
"TaskState": "1",
"CreateTime": "2021-11-01 11:05:18",
"TaskName": "New monitoring task",
"Address": "https://aliyun.com",
"TaskId": "f5783760-1b39-4b6b-80e8-453d962a****",
"OptionsJson": {
"password": "123****",
"request_format": "hex",
"response_content": "cf0f85",
"failure_rate": 0.5,
"time_out": 3000,
"header": "testKey:testValue",
"cookie": "lang=en",
"port": 80,
"ping_num": 20,
"authentication": 1,
"http_method": "get",
"match_rule": 0,
"dns_match_rule": "IN_DNS",
"request_content": "cf0f85",
"username": "testUser",
"response_format": "hex",
"dns_type": "A",
"dns_server": "192.168.XX.XX",
"enable_operator_dns": true,
"attempts": 3,
"protocol": "udp",
"proxy_protocol": false,
"acceptable_response_code": "400",
"isBase64Encode": "false",
"cert_verify": false,
"unfollow_redirect": false,
"diagnosis_mtr": false,
"diagnosis_ping": false,
"retry_delay": 1,
"assertions": {
"assertions": [
{
"property": "json path",
"type": "response_time",
"operator": "lessThan",
"target": "1000"
}
]
}
},
"AgentGroup": "PC"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidQueryParameter | %s | |
| 401 | AccessDeniedException | You donot have sufficient access to perform this action. | |
| 500 | %s | %s | |
| 500 | InternalError | %s | |
| 402 | LimitExceeded | The quota for this customer had been reached. | |
| 403 | Forbidden | You are not authorized to operate the specified resource. | |
| 503 | %s | %s | |
| 406 | ExceedingQuota | Exceeding quota limits. | |
| 429 | ThrottlingException | The request was denied due to request throttling. | |
| 409 | %s | %s |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。