DescribeMonitorGroups 操作を呼び出して、アプリケーショングループのリストを照会できます。
操作説明
このトピックでは、アプリケーショングループのリストを照会する方法の例を示します。レスポンスは、testGroup124 と test123 の 2 つのアプリケーショングループが返されることを示しています。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cms:DescribeMonitorGroups |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SelectContactGroups |
boolean |
任意 |
レスポンスにアラート連絡グループを含めるかどうかを指定します。有効な値:
|
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 |
| Type |
string |
任意 |
アプリケーショングループのタイプ。有効な値:
|
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 のキー。N の有効値: 1~5。 |
tagKey1 |
| Value |
string |
任意 |
タグ N の値。N の有効値: 1~5。 |
tagValue1 |
| Types |
string |
任意 |
アプリケーショングループのタイプ。有効な値:
|
custom |
共通パラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスデータ。 |
||
| RequestId |
string |
リクエスト ID。 |
F02B299A-D374-4595-9F55-7534D604F132 |
| Success |
boolean |
操作が成功したかどうかを示します。有効な値:
|
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 |
| GroupFounderTagValue |
string |
動的タグルールを使用して作成されたアプリケーショングループのタグ値。 |
GroupValue1 |
| BindUrl |
string |
ACK クラスターから同期された URL。 |
https://aliyun.com |
| GroupName |
string |
アプリケーショングループの名前。 |
test123 |
| GroupId |
integer |
アプリケーショングループの ID。 |
12345 |
| ServiceId |
string |
Alibaba Cloud サービスの 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 |
例
成功レスポンス
JSONJSON
{
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. | 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 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。