Ambil Grup Aplikasi via API DescribeMonitorGroups - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Anda dapat memanggil operasi DescribeMonitorGroups untuk mengkueri daftar kelompok aplikasi.

Deskripsi operasi

This topic provides an example of how to query a list of application groups. The response shows that two application groups are returned: testGroup124 and test123.

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

cms:DescribeMonitorGroups

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SelectContactGroups	boolean	No	Apakah akan menyertakan kelompok kontak peringatan dalam tanggapan. Nilai valid: true false.	true
PageNumber	integer	No	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Halaman dimulai dari halaman 1. Nilai default: 30.	30
Keyword	string	No	Kata kunci untuk pencarian.	test
InstanceId	string	No	ID instans. Parameter ini digunakan untuk mengkueri kelompok aplikasi tempat instans tertentu berada.	i-abcdefgh12****
GroupName	string	No	Nama kelompok aplikasi.	testGroup124
IncludeTemplateHistory	boolean	No	Apakah akan menyertakan riwayat templat peringatan yang diterapkan pada kelompok aplikasi dalam tanggapan. Nilai valid: true false.	true
Type	string	No	Tipe kelompok aplikasi. Nilai valid: custom: kelompok aplikasi kustom. ehpc_cluster: kelompok aplikasi yang disinkronkan dari kluster E-HPC. kubernetes: kelompok aplikasi yang disinkronkan dari kluster Container Service for Kubernetes (ACK).	custom
DynamicTagRuleId	string	No	ID aturan tag dinamis.	6b882d9a-5117-42e2-9d0c-4749a0c6****
GroupFounderTagKey	string	No	Kunci tag kelompok aplikasi yang dibuat menggunakan aturan tag dinamis.	GroupKey1
GroupFounderTagValue	string	No	Nilai tag kelompok aplikasi yang dibuat menggunakan aturan tag dinamis.	GroupValue1
GroupId	string	No	ID kelompok aplikasi. Pisahkan beberapa ID dengan koma (,).	92****
Tag	array<object>	No	Tag kelompok aplikasi.
	object	No	The tags of the application group.
Key	string	No	The key of tag N. Valid values of N: 1 to 5.	tagKey1
Value	string	No	The value of tag N. Valid values of N: 1 to 5.	tagValue1
Types	string	No	Tipe kelompok aplikasi. Nilai valid: custom: kelompok aplikasi kustom. ehpc_cluster: kelompok aplikasi yang disinkronkan dari kluster E-HPC. kubernetes: kelompok aplikasi yang disinkronkan dari kluster Container Service for Kubernetes (ACK). tag: kelompok aplikasi yang dibuat secara otomatis berdasarkan tag. resMgr: kelompok aplikasi yang dibuat berdasarkan kelompok sumber daya. ess: kelompok aplikasi yang disinkronkan dari Penyesuaian Skala Otomatis (ESS).	custom

Untuk informasi selengkapnya tentang parameter umum, lihat Parameter umum.

Elemen respons

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	F02B299A-D374-4595-9F55-7534D604F132
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Code	integer	The status code. Catatan A value of 200 indicates that the operation was successful.	200
Message	string	The error message.	The specified resource is not found.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	30
Total	integer	The total number of entries.	10
Resources	object
Resource	array<object>	The resources that are associated with the monitor group.
	array<object>	The details of the linked instance.
Type	string	The type of the application group. Valid values: custom: a custom application group. ehpc_cluster: an application group that is synchronized from an E-HPC cluster. kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster.	custom
GroupFounderTagValue	string	The tag value of the application group that is created using a dynamic tag rule.	GroupValue1
BindUrl	string	The URL that is synchronized from the ACK cluster.	https://aliyun.com
GroupName	string	The name of the application group.	test123
GroupId	integer	The ID of the application group.	12345
ServiceId	string	The ID of the Alibaba Cloud service.	49****
DynamicTagRuleId	string	The ID of the dynamic tag rule.	6b882d9a-5117-42e2-9d0c-4749a0c6****
GmtCreate	integer	The timestamp when the application group was created. Unit: milliseconds.	1603181891000
GroupFounderTagKey	string	The tag key of the application group that is created using a dynamic tag rule.	GroupKey1
GmtModified	integer	The timestamp when the application group was modified. Unit: milliseconds.	1603181891000
ContactGroups	object
ContactGroup	array<object>	The alert contact groups.
	object	An alert contact group.
Name	string	The name of the alert contact group.	CloudMonitor
Tags	object
Tag	array<object>	The tags that are attached to the application group.
	object	A tag that is attached to the application group.
Key	string	The tag key of the application group.	tagKey1
Value	string	The tag value of the application group.	tagValue1
TemplateIds	object
TemplateId	array	The IDs of the alert templates.
	string	The alert template applied to the application group.	92****
ResourceGroupId	string	The ID of the resource group.	rg-aek2hopjh*******
TemplateInfos	object
TemplateInfo	array<object>	The information about the alert templates.
	object	The information about an alert template.
EffectTime	integer	The effective period.	1603181891000
TemplateId	string	The ID of the alert template.	123***
Ver	string	The version of the alert template.	0

Contoh

Respons sukses

JSONformat

{
  "RequestId": "F02B299A-D374-4595-9F55-7534D604F132",
  "Success": true,
  "Code": 200,
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "PageSize": 30,
  "Total": 10,
  "Resources": {
    "Resource": [
      {
        "Type": "custom",
        "GroupFounderTagValue": "GroupValue1",
        "BindUrl": "https://aliyun.com",
        "GroupName": "test123",
        "GroupId": 12345,
        "ServiceId": "49****",
        "DynamicTagRuleId": "6b882d9a-5117-42e2-9d0c-4749a0c6****",
        "GmtCreate": 1603181891000,
        "GroupFounderTagKey": "GroupKey1",
        "GmtModified": 1603181891000,
        "ContactGroups": {
          "ContactGroup": [
            {
              "Name": "CloudMonitor"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "tagKey1",
              "Value": "tagValue1"
            }
          ]
        },
        "TemplateIds": {
          "TemplateId": [
            "92****"
          ]
        },
        "ResourceGroupId": "rg-aek2hopjh*******",
        "TemplateInfos": {
          "TemplateInfo": [
            {
              "EffectTime": 1603181891000,
              "TemplateId": "123***",
              "Ver": "0"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	ParameterInvalid	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	AccessForbidden	The X.509 certificate or cms access key ID provided does not exist in our records.
206	%s	%s
404	ResourceNotFound	The specified resource is not found.
503	%s	%s
406	%s	%s
429	Throttli∂ngException	The request was denied due to request throttling.
409	%s	%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.