All Products
Search
Document Center

Alibaba Cloud DNS:ListCloudGtmMonitorTemplates

Last Updated:Jun 10, 2026

Mengkueri template pemeriksaan kesehatan berdasarkan parameter yang ditentukan.

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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

  • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

  • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

  • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

  • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

    • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

    • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

  • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

  • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

alidns:ListCloudGtmMonitorTemplates

list

*All Resource

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

AcceptLanguage

string

No

Bahasa respons. Nilai yang valid:

  • zh-CN: Bahasa Tionghoa.

  • en-US (default): Bahasa Inggris.

zh-CN

PageNumber

integer

Yes

Nomor halaman. Nilainya dimulai dari 1. Nilai default adalah 1.

1

PageSize

integer

Yes

Jumlah entri yang dikembalikan pada setiap halaman. Nilai maksimum: 100. Nilai default: 20.

20

Name

string

No

Nama template pemeriksaan kesehatan. Beri nama template dengan cara yang membantu Anda membedakan antara protokol pemeriksaan kesehatan yang berbeda.

IPv4-Ping

IpVersion

string

No

Versi IP titik deteksi.

  • IPv4: Alamat tujuan adalah alamat IPv4.

  • IPv6: Alamat tujuan adalah alamat IPv6.

IPv4

Protocol

string

No

Protokol yang digunakan untuk pemeriksaan kesehatan.

  • ping

  • tcp

  • http

  • https

ping

Elemen respons

Element

Type

Description

Example

object

RequestId

string

ID permintaan unik.

75446CC1-FC9A-4595-8D96-089D73D7A63D

TotalPages

integer

Jumlah total halaman yang dikembalikan.

2

TotalItems

integer

Jumlah total template pemeriksaan kesehatan.

30

PageSize

integer

Jumlah entri yang dikembalikan pada setiap halaman. Nilai maksimum: 100. Nilai default: 20.

20

PageNumber

integer

Nomor halaman yang dikembalikan. Halaman dimulai dari 1. Nilai default: 1.

1

Templates

object

Template

array<object>

Daftar template pemeriksaan kesehatan.

array<object>

Detail template pemeriksaan kesehatan.

TemplateId

string

The unique ID of the health check template.

mtp-89518052425100****

CreateTime

string

The time when the health check template was created.

2024-03-23T13:09Z

CreateTimestamp

integer

The timestamp that indicates when the health check template was created.

1527690629357

UpdateTime

string

The time when the health check template was last modified.

2024-03-29T13:20Z

UpdateTimestamp

integer

The timestamp that indicates when the health check template was last modified.

1527690629357

Name

string

The name of the health check template.

IPv4-Ping

IpVersion

string

The IP version of the detection points.

  • IPv4: The destination address is an IPv4 address.

  • IPv6: The destination address is an IPv6 address.

IPv4

Protocol

string

The protocol used for the health check.

  • ping

  • tcp

  • http

  • https

ping

Interval

integer

The health check interval, in seconds. The default value is 60. The minimum interval of 15 seconds is available only for Ultimate Edition instances.

60

Timeout

integer

The timeout period for a health check, in milliseconds. If a response is not received within this period, the health check is considered to have timed out. Valid values:

  • 2000

  • 3000

  • 5000

  • 10000

5000

EvaluationCount

integer

The number of consecutive times a health check must fail before the system declares the service unhealthy. This helps prevent false alarms caused by network jitter. Valid values:

  • 1

  • 2

  • 3

2

FailureRate

integer

The failure rate threshold. If the percentage of unhealthy detection points exceeds this threshold, the system declares the endpoint unhealthy. Valid values:

  • 20

  • 50

  • 80

  • 100

50

ExtendInfo

string

Extended information in a JSON string. The available parameters vary based on the protocol:

  • For HTTP and HTTPS:

    host: The value of the Host field in the HTTP or HTTPS request header. This field specifies the website to access. The default value is the primary domain name. Modify this parameter if the destination website has specific host requirements.

    path: The path for the HTTP or HTTPS health check. The default path is /.

    code: The HTTP status code threshold. During an HTTP or HTTPS health check, the system checks the returned status code. If the code is greater than the specified value, the application service is considered unhealthy.

    • 400: Bad Request. A web server returns a status code greater than 400 if a request contains incorrect parameters. If you set the threshold to 400, make sure to specify the correct URL path parameters.

    • 500: Server Error. A web server returns a status code greater than 500 if a server-side exception occurs. By default, the system uses 500 as the threshold.

    sni: Specifies whether to enable Server Name Indication (SNI). This parameter applies only to the HTTPS protocol. SNI is an extension to the Transport Layer Security (TLS) protocol. It allows a client to specify the hostname it wants to connect to at the start of the TLS handshake. This lets the server present the correct certificate for the requested service.

    • true: enabled

    • false: disabled

    followRedirect: Specifies whether to follow 3xx redirections.

    • true: The system follows the redirection if the status code returned by the detection point is 3xx (301, 302, 303, 307, or 308).

    • false: The system does not follow the redirection.

  • For ping:

    packetNum: The number of Internet Control Message Protocol (ICMP) packets to send for each ping health check. Valid values: 20, 50, and 100.

    packetLossRate: The packet loss rate threshold that triggers an alarm. The system calculates the packet loss rate for each ping health check. Packet loss rate = (Number of lost packets / Total number of sent ICMP packets) × 100%. An alarm is triggered if the packet loss rate reaches the specified threshold. Valid values: 10, 30, 40, 80, 90, and 100.

{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}

IspCityNodes

object

IspCityNode

array<object>

A list of detection points. For more information, see ListCloudGtmMonitorNodes.

object

The detection point.

CountryCode

string

The country code.

001

CountryName

string

The country name.

中国

CityCode

string

The city code.

503

CityName

string

The city name.

张家口市

GroupType

string

The type of the detection point group.

  • BGP: BGP nodes

  • OVERSEAS: international nodes

  • ISP: carrier nodes

BGP

GroupName

string

The name of the detection point group.

BGP节点

IspCode

string

The carrier code.

465

IspName

string

The carrier name.

阿里巴巴

Remark

string

The remarks on the health check template.

test

Contoh

Respons sukses

JSONformat

{
  "RequestId": "75446CC1-FC9A-4595-8D96-089D73D7A63D",
  "TotalPages": 2,
  "TotalItems": 30,
  "PageSize": 20,
  "PageNumber": 1,
  "Templates": {
    "Template": [
      {
        "TemplateId": "mtp-89518052425100****",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "IPv4-Ping",
        "IpVersion": "IPv4",
        "Protocol": "ping",
        "Interval": 60,
        "Timeout": 5000,
        "EvaluationCount": 2,
        "FailureRate": 50,
        "ExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}\n",
        "IspCityNodes": {
          "IspCityNode": [
            {
              "CountryCode": "001",
              "CountryName": "中国",
              "CityCode": "503",
              "CityName": "张家口市",
              "GroupType": "BGP",
              "GroupName": "BGP节点",
              "IspCode": "465",
              "IspName": "阿里巴巴"
            }
          ]
        },
        "Remark": "test"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.