DescribeMetricRuleTemplateList API によるアラートテンプレートの一覧取得 - CMS

アラートテンプレートをクエリします。

操作説明

このトピックでは、アラートテンプレートをクエリする方法の例を説明します。この例では、応答で次のアラートテンプレートが返されます： ECS_Template1 と ECS_Template2。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeMetricRuleTemplateList

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	任意	アラートテンプレートの名前。	ECS_Template1
Keyword	string	任意	アラートテンプレート名のキーワード。	ECS
TemplateId	integer	任意	アラートテンプレートの ID。	70****
PageNumber	integer	任意	ページ番号。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。	10
History	boolean	任意	アラートテンプレートをアプリケーショングループに適用した履歴を表示するかどうかを指定します。有効な値： true false (デフォルト)	false
Order	boolean	任意	ソート順。有効な値： true (デフォルト)：昇順 false：降順	true
OrderBy	string	任意	ソート基準。有効な値： gmtMotified：アラートテンプレートを変更時間でソートします gmtCreate (デフォルト)：アラートテンプレートを作成時間でソートします	gmtCreate

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object
Code	integer	状態コード。説明状態コード 200 は、リクエストが成功したことを示します。	200
Message	string	エラーメッセージ。	The Request is not authorization.
RequestId	string	リクエスト ID。	659401C0-6214-5C02-972A-CFA929D717B7
Total	integer	返されたエントリの総数。	2
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true
Templates	object
Template	array<object>	クエリされたアラートテンプレート。
	array<object>	なし
Description	string	アラートテンプレートの説明。	ECS的CPU使用率
GmtCreate	integer	アラートテンプレートが作成されたときのタイムスタンプ。単位：ミリ秒。	1646018798000
Name	string	アラートテンプレートの名前。	ECS_Template1
RestVersion	integer	アラートテンプレートのバージョン。デフォルト値：0。	0
GmtModified	integer	アラートテンプレートが変更されたときのタイムスタンプ。単位：ミリ秒。	1646054798000
TemplateId	integer	アラートテンプレートの ID。	70****
ApplyHistories	object
ApplyHistory	array<object>	アラートテンプレートをアプリケーショングループに適用した履歴。
	object	なし
GroupId	integer	アプリケーショングループの ID。	3607****
GroupName	string	アプリケーショングループの名前。	ECS_Group
ApplyTime	integer	アラートテンプレートがアプリケーショングループに適用されたときのタイムスタンプ。単位：ミリ秒。	1646055898000

例

成功レスポンス

JSONJSON

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "659401C0-6214-5C02-972A-CFA929D717B7",
  "Total": 2,
  "Success": true,
  "Templates": {
    "Template": [
      {
        "Description": "ECS的CPU使用率",
        "GmtCreate": 1646018798000,
        "Name": "ECS_Template1",
        "RestVersion": 0,
        "GmtModified": 1646054798000,
        "TemplateId": 0,
        "ApplyHistories": {
          "ApplyHistory": [
            {
              "GroupId": 0,
              "GroupName": "ECS_Group",
              "ApplyTime": 1646055898000
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。