すべてのプロダクト
Search
ドキュメントセンター

Cloud Monitor:DescribeSiteMonitorList

最終更新日:Jun 14, 2026

DescribeSiteMonitorList 操作を呼び出して、サイトモニタリングタスクのリストを照会します。

操作説明

この Topic では、現在のアカウントのサイトモニタリングタスクのリストをクエリする例を示します。応答は、現在のアカウントに HanZhou_ECS2 という名前のサイトモニタリングタスクが 1 つあることを示しています。

今すぐお試しください

この 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: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: 法線。

  • 2: 無効。

1

AgentGroup

string

任意

タスクで使用される検出ポイントのタイプ。有効な値:

  • PC: PC ベースの検出ポイント。

  • MOBILE: モバイルベースの検出ポイント。

  • FC: 内部検出ポイント。

PC

共通リクエストパラメーターの詳細については、共通パラメーター を参照してください。

レスポンスフィールド

フィールド

説明

object

なし。

RequestId

string

リクエスト ID。

A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B

Success

string

操作が成功したかどうかを示します。有効な値:

  • true: 成功。

  • false: 失敗した。

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:タスクは有効です。

  • 2:タスクは無効です。

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:16 進数

  • txt:テキスト

hex

response_content

string

HTTP リクエストへの応答。

  • 16 進数フォーマット:リクエスト内容がバイト文字列であり、表示可能文字で表現できない場合、バイト文字列を 16 進数フォーマットの表示可能文字に変換できます。バイト文字列を 16 進数フォーマットの表示可能文字に変換する場合、1 バイトは 2 つの 16 進数文字に変換されます。たとえば、(byte)1 は 01 に変換され、(byte)27 は 1B に変換されます。リクエスト内容が Java フォーマットのバイナリ配列である場合、たとえば {(byte)1, (byte)27} の場合、バイナリ配列を 011b または 011B に変換できます。16 進数文字は、サイトモニタリングタスクでは大文字と小文字を区別しません。リクエスト内容に 011B を入力し、request_format パラメーターを hex に設定できます。

  • テキストフォーマット:一般的なテキストとは、表示可能文字で構成される文字列を指します。

cf0f85

failure_rate

number

パケット損失率。

説明

このパラメーターは、TaskType パラメーターが PING に設定されている場合にのみ返されます。

0.5

time_out

integer

タイムアウト期間。単位:ミリ秒。

3000

header

string

HTTP リクエストのヘッダー。HTTP ヘッダーは、キーと値がコロン (:) で区切られたキーと値のペアです。フォーマットは key1:value1 です。各 HTTP ヘッダーは 1 行を占有します。

testKey:testValue

cookie

string

HTTP リクエストの cookie。

lang=en

port

integer

TCP、UDP、SMTP、または POP3 プロトコルのポート番号。

80

ping_num

integer

PING プロトコルのホップ数。

20

authentication

integer

セキュリティ認証機能が有効かどうかを示します。有効な値:

  • 0:機能は有効です。

  • 1:機能は無効です。

1

http_method

string

HTTP リクエストメソッド。有効な値:

  • get

  • post

  • head

get

match_rule

integer

アラートルールが含まれるかどうかを示します。有効な値:

  • 0:アラートルールが含まれます。

  • 1:アラートルールは含まれません。

0

dns_match_rule

string

期待されるエイリアスまたは IP アドレスのリストと DNS 結果のリストとの関係。有効な値:

  • IN_DNS:期待値のリストは DNS 結果のリストのサブセットです。

  • DNS_IN:DNS 結果のリストは期待値のリストのサブセットです。

  • EQUAL:DNS 結果のリストは期待値のリストと同じです。

  • ANY:DNS 結果のリストは期待値のリストと共通部分を持ちます。

IN_DNS

request_content

string

HTTP リクエストの内容。

cf0f85

username

string

FTP、SMTP、または POP3 プロトコルのユーザー名。

testUser

response_format

string

HTTP 応答のフォーマット。有効な値:

  • hex:16 進数

  • txt:テキスト

hex

dns_type

string

DNS レコードのタイプ。このパラメーターは、TaskType パラメーターが DNS に設定されている場合にのみ返されます。有効な値:

  • A (デフォルト):指定されたホスト名またはドメイン名に関連する IP アドレスを指定するレコード。

  • CNAME:複数のドメイン名を 1 つのドメイン名にマッピングするレコード。

  • NS:ドメイン名を解析するために使用される DNS サーバを指定するレコード。

  • MX:ドメイン名をメールサーバーのアドレスにリンクするレコード。

  • TXT:ホスト名またはドメイン名のテキスト情報を格納するレコード。テキストの長さは 1~512 バイトである必要があります。TXT レコードは、迷惑メール対策のための Sender Policy Framework (SPF) レコードとして機能します。

  • AAAA:ドメイン名を関連する IPv6 アドレスにマッピングするレコード。

A

dns_server

string

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

192.168.XX.XX

enable_operator_dns

boolean

キャリアの DNS サーバが使用されるかどうかを示します。

  • true (デフォルト):キャリアの DNS サーバが使用されます。

  • false:キャリアの DNS サーバは使用されません。デフォルトの DNS サーバまたは指定された DNS サーバが使用されます。

true

attempts

integer

DNS 障害が発生した後のリトライ回数。

3

protocol

string

DNS 検出のプロトコルタイプ。有効な値:

  • udp (デフォルト)

  • tcp

  • tcp-tls

udp

proxy_protocol

boolean

PROXY プロトコルが有効かどうかを示します。有効な値:

  • false (デフォルト):PROXY プロトコルは無効です。

  • true:PROXY プロトコルは有効です。

false

acceptable_response_code

string

許容されるステータスコード。

説明

アサーションを設定することを推奨します。

400

isBase64Encode

string

パスワードが Base64 アルゴリズムを使用してデコードされるかどうかを示します。有効な値:

  • true:パスワードは Base64 アルゴリズムを使用してデコードされます。

  • false (デフォルト):パスワードは Base64 アルゴリズムを使用してデコードされません。

false

cert_verify

boolean

証明書が検証されるかどうかを示します。有効な値:

  • false (デフォルト):証明書は検証されません。

  • true:証明書は検証されます。

false

unfollow_redirect

boolean

ステータスコード 301 または 302 が返された場合にリダイレクトをフォローするかどうかを示します。有効な値:

  • true:リダイレクトはフォローされません。

  • false (デフォルト):リダイレクトはフォローされます。

false

diagnosis_mtr

boolean

タスクが失敗した場合に、MTR を自動的に使用してネットワーク問題を診断するかどうかを示します。有効な値:

  • false (デフォルト):タスクが失敗した場合、MTR を自動的に使用してネットワーク問題を診断しません。

  • true:タスクが失敗した場合、MTR を自動的に使用してネットワーク問題を診断します。

false

diagnosis_ping

boolean

検出タスクが失敗した場合に、ping リクエストを自動的に送信してネットワーク遅延を検出するかどうかを示します。有効な値:

  • false (デフォルト):検出タスクが失敗した場合、ping リクエストを自動的に送信してネットワーク遅延を検出しません。

  • true:検出タスクが失敗した場合、ping リクエストを自動的に送信してネットワーク遅延を検出します。

false

retry_delay

integer

失敗した検出リクエストがリトライされる回数。

1

assertions

object

assertions

array<object>

アサーション。

object

property

string

アサーションの解析パス。

  • アサーションタイプが body_json の場合、パスは json path です。

  • アサーションタイプが body_xml の場合、パスは xml path です。

json path

type

string

アサーションタイプ。有効な値:

  • response_time:応答時間が期待値を満たしているか確認します。

  • status_code:HTTP ステータスコードが期待値を満たしているか確認します。

  • header:応答ヘッダーのフィールドが期待値を満たしているか確認します。

  • body_text:テキストマッチングを使用して、応答本文の内容が期待値を満たしているか確認します。

  • body_json:JSON 解析 (JSONPath) を使用して、応答本文の内容が期待値を満たしているか確認します。

  • body_xml:XML 解析 (XPath) を使用して、応答本文の内容が期待値を満たしているか確認します。

response_time

operator

string

アサーションの比較演算子。有効な値:

  • contains:含む

  • doesNotContain:含まない

  • matches:正規表現に一致する

  • doesNotMatch:正規表現に一致しない

  • is:数値と等しいか、文字と一致する

  • isNot:等しくない

  • lessThan:より小さい

  • moreThan:より大きい

lessThan

target

string

照合に使用される数値または文字。

1000

AgentGroup

string

検出ポイントタイプ。有効な値:

  • PC

  • MOBILE

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

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

変更履歴

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