ListTimingSyntheticTasks - Application Real-Time Monitoring Service - Alibaba Cloud ドキュメントセンター

スケジュールされた合成監視タスクをクエリします。

操作説明

現在、クラウド監視測定は中国 (杭州) リージョンでのみ利用可能です。SDK または OpenAPI を使用する場合は、中国 (杭州) リージョンに対応するサービスアクセスポイントを選択してください。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
Search	object	任意	検索キーワード。
TaskTypes	array	任意	タスクタイプ。
	integer	任意	タスクタイプ。1: ICMP、2: TCP、3: DNS、4: HTTP、5: ウェブサイトの速度、6: ファイルダウンロード。	1
TaskIds	array	任意	タスク ID。
	string	任意	タスク ID。	181248
Name	string	任意	タスク名。	拨测
Status	string	任意	タスクステータス。CREATING: タスクは作成中です。RUNNING: タスクは実行中です。PARTIAL_RUNNING: タスクは部分的に実行中です。STOP: タスクは停止しています。LIMIT_STOP: クォータ制限によりタスクは停止しています。EXCEPTION: タスクは異常です。DELETE: タスクは削除されています。DELETE_EXCEPTION: タスクの削除中に例外が発生しました。	CREATING
OrderField	string	任意	タスクのソート条件。`gmtCreate`、`gmtModified`、`status`、または `monitorCount` でタスクをソートできます。	status
Order	integer	任意	タスクのソート順。1: 昇順、-1: 降順。	1
Page	integer	任意	ページ番号。このパラメーターは必須です。	1
PageSize	integer	任意	1 ページあたりのエントリ数。このパラメーターは必須です。	10
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmxyexli2****
Tags	array<object>	任意	タグ。
	object	任意
Key	string	任意	タグキー。	mark
Value	string	任意	タグ値。	value1111

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	730E90FE-996A-5638-99F3-4F0F9038CC6C
Code	integer	ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。	200
Message	string	返されたメッセージ。	success
Data	object	返された構造体。
Items	array<object>	クエリされたタスク。
	array<object>	タスクに関する情報。
TaskId	string	合成監視タスクの ID。	5308a2691f59422c8c3b7aeccec9cd3b
RegionId	string	リージョン ID。	cn-hangzhou
Name	string	タスク名。	拨测任务
TaskType	integer	タスクのタイプ。有効値： 1: ICMP、2: TCP、3: DNS、4: HTTP、5: ウェブサイトの速度、6: ファイルダウンロード。	1
Url	string	合成監視用の URL。	https://www.example.com
MonitorCategory	integer	検出ポイントタイプ。1: PC、2: モバイルデバイス。	1
Frequency	string	検出頻度。有効値：1m、5m、10m、15m、20m、30m、1h、2h、3h、4h、6h、8h、12h、24h。	1m
MonitorNum	string	検出ポイント数。	10
Status	string	タスクステータス。CREATING: タスクは作成中です。RUNNING: タスクは実行中です。PARTIAL_RUNNING: タスクは部分的に実行中です。STOP: タスクは停止しています。LIMIT_STOP: クォータ制限によりタスクは停止しています。EXCEPTION: タスクは異常です。DELETE: タスクは削除されています。DELETE_EXCEPTION: タスクの削除中に例外が発生しました。	RUNNING
GmtCreate	string	タスクが作成された時間。	1671454758000
GmtModified	string	タスクが変更された時間。	1673085633000
ResourceGroupId	string	リソースグループの ID。	rg-aekzgwtq5vxxxxx
CommonSetting	object	一般設定。
CustomHost	object	カスタムホスト設定。
Hosts	array<object>	カスタムホスト設定。
	object	カスタムホスト設定。
Domain	string	宛先ドメイン名。	www.aliyun.com
IpType	integer	IP バージョン。有効値： 0: バージョンは自動的に選択されます。 1: IPv4。 2: IPv6。	0
Ips	array	IP アドレス。
	string	IP アドレス。	39.104.85.210
SelectType	integer	選択モード。有効値： 0: ランダム 1: ポーリング	0
IpType	integer	IP バージョン。有効値： 0: バージョンは自動的に選択されます。 1: IPv4。 2: IPv6。	0
MonitorSamples	integer	モニタリングサンプルを均等に分散させるかどうかを示します。有効値： 0: いいえ 1: はい	0
IsOpenTrace	boolean	トレースが有効になっているかどうかを示します。	false
TraceClientType	integer	トレース用のクライアントタイプ。有効値： 0: ARMS エージェント 1: OpenTelemetry 2: Jaeger	1
XtraceRegion	string	トレースデータがレポートされるリージョン。	cn-hangzhou
CustomVPCSetting	object	Virtual Private Cloud (VPC) に関する情報。宛先 URL が Alibaba Cloud 内部エンドポイントである場合、VPC を設定する必要があります。
RegionId	string	リージョン ID。	cn-zhangjiakou
VpcId	string	VPC ID。	vpc-2zehbd4dfzahxxxxxxx
VSwitchId	string	vSwitch ID。	vsw-bp1bcmj81kxxxxxxx
SecureGroupId	string	クライアントが属するセキュリティグループの ID。セキュリティグループは、VPC のクライアントのインバウンドルールとアウトバウンドルールを指定します。クライアントが属するセキュリティグループが VPC が属するセキュリティグループにアクセスできるようにする必要があります。そうしないと、クライアントは VPC 内のリソースにアクセスできません。	sg-xxxxxxxxxxxxxx
CustomPrometheusSetting	object	予約済みフィールド。
PrometheusLabels	object	予約済みフィールド。
	string	予約済みフィールド。	保留字段。
PrometheusClusterId	string	予約済みフィールド。	保留字段。
PrometheusClusterRegion	string	予約済みフィールド。	保留字段。
Tags	array<object>	タグ。
	object
Key	string	タグキー。	key
Value	string	タグ値。	value
Total	integer	タスクの総数。	100
Page	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "730E90FE-996A-5638-99F3-4F0F9038CC6C",
  "Code": 200,
  "Message": "success",
  "Data": {
    "Items": [
      {
        "TaskId": "5308a2691f59422c8c3b7aeccec9cd3b",
        "RegionId": "cn-hangzhou",
        "Name": "拨测任务",
        "TaskType": 1,
        "Url": "https://www.example.com",
        "MonitorCategory": 1,
        "Frequency": "1m",
        "MonitorNum": "10",
        "Status": "RUNNING",
        "GmtCreate": "1671454758000",
        "GmtModified": "1673085633000",
        "ResourceGroupId": "rg-aekzgwtq5vxxxxx",
        "CommonSetting": {
          "CustomHost": {
            "Hosts": [
              {
                "Domain": "www.aliyun.com",
                "IpType": 0,
                "Ips": [
                  "39.104.85.210"
                ]
              }
            ],
            "SelectType": 0
          },
          "IpType": 0,
          "MonitorSamples": 0,
          "IsOpenTrace": false,
          "TraceClientType": 1,
          "XtraceRegion": "cn-hangzhou",
          "CustomVPCSetting": {
            "RegionId": "cn-zhangjiakou",
            "VpcId": "vpc-2zehbd4dfzahxxxxxxx",
            "VSwitchId": "vsw-bp1bcmj81kxxxxxxx",
            "SecureGroupId": "sg-xxxxxxxxxxxxxx"
          },
          "CustomPrometheusSetting": {
            "PrometheusLabels": {
              "key": "保留字段。\n"
            },
            "PrometheusClusterId": "保留字段。\n",
            "PrometheusClusterRegion": "保留字段。"
          }
        },
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ]
      }
    ],
    "Total": 100,
    "Page": 1,
    "PageSize": 10
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ParameterMissing	%s
400	ParameterIllegal	%s
400	TaskQuotaLimit	%s
400	ParameterRegionIllegal	%s
400	DuplicateTagKey	Param tagKey is duplicate.
400	TagNumOUT	the number of tag is out .
400	NoPermissionUSER	user no permission
403	RAMNotAuthorize	%s
403	STSNotAuthorize	%s
403	IllegalUserAccess	%s
403	APINotAuthorize	%s
403	CommercialStatusException	%s
403	SyntheticTrailExpired	%s
403	SyntheticInDebt	%s
403	SyntheticDailyTimesExhausted	%s
403	SyntheticDailyLimit	%s

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

変更履歴

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