ListTimingSyntheticTasks - Application Real-Time Monitoring Service

Mengambil daftar tugas Pemantauan Sintetis yang dijadwalkan.

Deskripsi operasi

Pemantauan Sintetis saat ini hanya menyediakan layanan di wilayah China (Hangzhou). Saat menggunakan SDK atau OpenAPI, pilih titik akhir pendaftaran layanan yang sesuai dengan wilayah China (Hangzhou).

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-hangzhou
Search	object	No	Kata kunci pencarian.
TaskTypes	array	No	Daftar tipe tugas yang akan dikueri.
	integer	No	Tipe tugas. Nilai valid: 1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: pengujian kecepatan situs web. 6: pengunduhan file.	1
TaskIds	array	No	Daftar ID tugas.
	string	No	ID tugas.	181248
Name	string	No	Nama tugas.	拨测
Status	string	No	Status tugas. Nilai valid: CREATING: Tugas sedang dibuat. RUNNING: Tugas sedang berjalan. PARTIAL_RUNNING: Tugas berjalan sebagian. STOP: Tugas dihentikan. LIMIT_STOP: Tugas dihentikan karena batas kuota. EXCEPTION: Tugas tidak normal. DELETE: Tugas dihapus. DELETE_EXCEPTION: Penghapusan tugas tidak normal.	CREATING
OrderField	string	No	Bidang pengurutan. Anda dapat mengurutkan berdasarkan salah satu bidang berikut: gmtCreate, gmtModified, status, atau monitorCount.	status
Order	integer	No	Pesanan pengurutan. Nilai valid: 1: menaik -1: menurun.	1
Page	integer	No	Nomor halaman. Parameter ini wajib diisi.	1
PageSize	integer	No	Jumlah entri per halaman. Parameter ini wajib diisi.	10
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmxyexli2****
Tags	array<object>	No	Tag.
	object	No	Tag.
Key	string	No	Kunci tag.	mark
Value	string	No	Nilai tag.	value1111

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	730E90FE-996A-5638-99F3-4F0F9038CC6C
Code	integer	Kode status. Nilai 200 menunjukkan keberhasilan.	200
Message	string	Paket yang dikembalikan.	success
Data	object	Struktur tanggapan.
Items	array<object>	Daftar informasi tugas.
	array<object>	Informasi tugas.
TaskId	string	The ID of the synthetic monitoring task.	5308a2691f59422c8c3b7aeccec9cd3b
RegionId	string	The region ID.	cn-hangzhou
Name	string	The task name.	拨测任务
TaskType	integer	The type of the task. Valid values: 1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.	1
Url	string	The URL for synthetic monitoring.	https://www.example.com
MonitorCategory	integer	The detection point type. 1: PC. 2: mobile device.	1
Frequency	string	The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.	1m
MonitorNum	string	The number of detection points.	10
Status	string	The task status. CREATING: The task is being created. RUNNING: The task is running. PARTIAL_RUNNING: The task is partially running. STOP: The task is stopped. LIMIT_STOP: The task is stopped due to quota limit. EXCEPTION: The task is abnormal. DELETE: The task is deleted. DELETE_EXCEPTION: An exception occurs while deleting the task.	RUNNING
GmtCreate	string	The time when the task was created.	1671454758000
GmtModified	string	The time when the task was modified.	1673085633000
ResourceGroupId	string	The ID of the resource group.	rg-aekzgwtq5vxxxxx
CommonSetting	object	The general settings.
CustomHost	object	The custom host settings.
Hosts	array<object>	The custom host settings.
	object	The custom host settings.
Domain	string	The destination domain name.	www.aliyun.com
IpType	integer	The IP version. Valid values: 0: A version is automatically selected. 1: IPv4. 2: IPv6.	0
Ips	array	The IP address.
	string	The IP address.	39.104.85.210
SelectType	integer	The selection mode. Valid values: 0: random 1: polling	0
IpType	integer	The IP version. Valid values: 0: A version is automatically selected. 1: IPv4. 2: IPv6.	0
MonitorSamples	integer	Indicates whether monitoring samples are evenly distributed. Valid values: 0: No 1: Yes	0
IsOpenTrace	boolean	Indicates whether tracing is enabled.	false
TraceClientType	integer	The type of the client for tracing. Valid values: 0: ARMS agent 1: OpenTelemetry 2: Jaeger	1
XtraceRegion	string	The region to which trace data is reported.	cn-hangzhou
CustomVPCSetting	object	The information about the virtual private cloud (VPC). If the destination URL is an Alibaba Cloud internal endpoint, you need to configure a VPC.
RegionId	string	The region ID.	cn-zhangjiakou
VpcId	string	The VPC ID.	vpc-2zehbd4dfzahxxxxxxx
VSwitchId	string	The vSwitch ID.	vsw-bp1bcmj81kxxxxxxx
SecureGroupId	string	The ID of the security group to which the client belongs. The security group specifies the inbound and outbound rules of the client for the VPC. You need to allow the security group to which the client belongs to access the security group to which the VPC belongs. Otherwise, the client cannot access resources in the VPC.	sg-xxxxxxxxxxxxxx
CustomPrometheusSetting	object	A reserved field.
PrometheusLabels	object	A reserved field.
	string	A reserved field.	保留字段。
PrometheusClusterId	string	A reserved field.	保留字段。
PrometheusClusterRegion	string	A reserved field.	保留字段。
Tags	array<object>	The tags.
	object
Key	string	The tag key.	key
Value	string	The tag value.	value
Total	integer	Jumlah total tugas dalam hasil yang dikembalikan.	100
Page	integer	Nomor halaman saat ini.	1
PageSize	integer	Jumlah entri per halaman.	10

Contoh

Respons sukses

JSONformat

{
  "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
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
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

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.