調用DescribeMonitorGroups查詢應用分組列表-CloudMonitor-阿里雲

調用DescribeMonitorGroups介面查詢應用分組列表。

介面說明

本文將提供一個樣本，查詢當前帳號的應用分組列表。返回結果顯示當前帳號存在兩個應用分組testGroup124和test123。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:DescribeMonitorGroups

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
SelectContactGroups	boolean	否	返回結果中是否需要包含警示聯絡組。取值： true：是。 false：否。	true
PageNumber	integer	否	頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁時每頁顯示的資料行數。起始值：1。預設值：30。	30
Keyword	string	否	搜尋索引鍵。	test
InstanceId	string	否	資源執行個體 ID。該參數用於查詢指定執行個體所在的應用分組。	i-abcdefgh12****
GroupName	string	否	應用分組名稱。	testGroup124
IncludeTemplateHistory	boolean	否	返回結果是否包含已應用到應用分組的警示模板歷史。取值： true：是。 false：否。	true
Type	string	否	應用分組類型。取值： custom：自建的應用分組。 ehpc_cluster：從 EHPC 叢集同步的應用分組。 kubernetes：從Container Service Kubernetes 版同步的應用分組。	custom
DynamicTagRuleId	string	否	智能標籤規則 ID。	6b882d9a-5117-42e2-9d0c-4749a0c6****
GroupFounderTagKey	string	否	通過智能標籤建立應用分組的標籤鍵。	GroupKey1
GroupFounderTagValue	string	否	通過智能標籤建立應用分組的標籤值。	GroupValue1
GroupId	string	否	應用分組 ID。多個應用分組 ID 之間用半形逗號（,）分隔。	92****
Tag	array<object>	否	應用分組的標籤。
	object	否	應用分組的標籤。
Key	string	否	應用分組的標籤鍵。N 的取值範圍：1~5。	tagKey1
Value	string	否	應用分組的標籤值。N 的取值範圍：1~5。	tagValue1
Types	string	否	應用分組類型。取值： custom：自建的應用分組。 ehpc_cluster：從 EHPC 叢集同步的應用分組。 kubernetes：從Container Service Kubernetes 版同步的應用分組。 tag：通過標籤自動建立的應用分組。 resMgr：通過資源群組建立的應用分組。 ess：從Auto Scaling ESS 同步的應用分組。	custom

關於公用請求參數的詳情，請參見公用參數。

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	F02B299A-D374-4595-9F55-7534D604F132
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
Code	integer	狀態代碼。說明 200 表示成功。	200
Message	string	錯誤資訊。	The specified resource is not found.
PageNumber	integer	頁碼。	1
PageSize	integer	分頁時每頁顯示的資料行數。	30
Total	integer	總記錄條數。	10
Resources	object
Resource	array<object>	關聯資源。
	array<object>	關聯資源。
Type	string	應用分組類型。取值： custom：自建的應用分組。 ehpc_cluster：從 EHPC 叢集同步的應用分組。 kubernetes：從Container Service Kubernetes 版同步的應用分組。	custom
GroupFounderTagValue	string	通過智能標籤建立應用分組的標籤值。	GroupValue1
BindUrl	string	從Container Service Kubernetes 版同步過來的 URL 地址。	https://aliyun.com
GroupName	string	應用分組名稱。	test123
GroupId	integer	應用分組 ID。	12345
ServiceId	string	阿里雲服務 ID。	49****
DynamicTagRuleId	string	智能標籤規則 ID。	6b882d9a-5117-42e2-9d0c-4749a0c6****
GmtCreate	integer	建立應用分組的時間戳記。單位：毫秒。	1603181891000
GroupFounderTagKey	string	通過智能標籤建立應用分組的標籤鍵。	GroupKey1
GmtModified	integer	修改應用分組的時間戳記。單位：毫秒。	1603181891000
ContactGroups	object
ContactGroup	array<object>	警示聯絡組。
	object	警示聯絡組
Name	string	警示聯絡組名稱。	CloudMonitor
Tags	object
Tag	array<object>	應用分組綁定的標籤列表。
	object	應用分組綁定的標籤列表。
Key	string	應用分組的標籤鍵。	tagKey1
Value	string	應用分組的標籤值。	tagValue1
TemplateIds	object
TemplateId	array	模板 ID。
	string	應用分組應用過的警示模板。	92****
ResourceGroupId	string	資源 ID。	rg-aek2hopjh*******
TemplateInfos	object
TemplateInfo	array<object>	模版資訊。
	object	模版資訊。
EffectTime	integer	生效時間	1603181891000
TemplateId	string	模板 ID。	123***
Ver	string	版本。	0

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。