DescribeMetricRuleBlackList API でブラックリストポリシーをクエリ - CMS - Alibaba Cloud - Cloud Monitor

アラートブラックリストポリシーのリストを照会します。

今すぐお試しください

この 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:DescribeMetricRuleBlackList

list

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Namespace	string	任意	Alibaba Cloud サービスの名前空間。 Alibaba Cloud サービスの名前空間の詳細については、「クラウドサービスのメトリクス」をご参照ください。	acs_ecs_dashboard。
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。	100
Order	integer	任意	クエリ結果を時間順に並べ替える順序。有効な値: 0: 昇順 (ASC)。 1: 降順 (DESC)。これがデフォルト値です。	1
Category	string	任意	Alibaba Cloud サービスのカテゴリ。たとえば、ApsaraDB for Redis には `kvstore_standard` (Standard Edition)、`kvstore_sharding` (Cluster Edition)、`kvstore_splitrw` (読み取り/書き込み分離エディション) があります。	ecs。
Ids	array	任意	アラートブラックリストポリシーの ID。
	string	任意	アラートブラックリストポリシーの ID。	a9ad2ac2-3ed9-11ed-b878-0242ac12****
Name	string	任意	アラートブラックリストポリシーの名前。このパラメーターはあいまい一致をサポートしています。	Blacklist-01
ScopeType	string	任意	アラートブラックリストポリシーの効果が及ぶ範囲。有効な値: USER: アラートブラックリストポリシーは現在の Alibaba Cloud アカウント内でのみ効果があります。 GROUP: アラートブラックリストポリシーは指定されたアプリケーショングループで効果があります。	USER。
IsEnable	boolean	任意	アラートブラックリストポリシーのステータス。有効な値: true: 有効。 false: 無効。	true。
InstanceIds	array	任意	アラートブラックリストポリシー内のインスタンス ID リスト。 N の有効な値: 0～10。
	string	任意	アラートブラックリストポリシー内のインスタンスの ID。	i-2ze2d6j5uhg20x47****

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

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
Code	string	状態コード。説明値 200 は成功を示します。	200
Message	string	エラーメッセージ。	The Request is not authorization.
RequestId	string	リクエスト ID。	D63E76CB-29AA-5B9F-88CE-400A6F28D428
Total	integer	アラートブラックリストポリシーの総数。	1
Success	boolean	操作が成功したかどうかを示します。有効な値: true: 成功。 false: 失敗。	true。
DescribeMetricRuleBlackList	array<object>	アラートブラックリストポリシーのリスト。
	array<object>	アラートブラックリストポリシーのリスト。
EffectiveTime	string	アラートブラックリストポリシーの有効期間。値は HH:mm-HH:mm フォーマット (24 時間時計) です。デフォルトのタイムゾーンは協定世界時 (UTC)+8 です。たとえば、「00:00-23:59」はポリシーが終日効果があることを示します。	00:00-23:59
UpdateTime	string	アラートブラックリストポリシーが最後に変更済みの時間。単位: ミリ秒。	1665718373000
CreateTime	string	アラートブラックリストポリシーが作成された時間のタイムスタンプ。単位: ミリ秒。	1665714561000
ScopeType	string	アラートブラックリストポリシーの効果が及ぶ範囲。有効な値: USER: アラートブラックリストポリシーは現在の Alibaba Cloud アカウント内でのみ効果があります。 GROUP: アラートブラックリストポリシーは指定されたアプリケーショングループで効果があります。	USER。
IsEnable	boolean	アラートブラックリストポリシーのステータス。有効な値: true: 有効。 false: 無効。	true。
Namespace	string	Alibaba Cloud サービスの名前空間。	acs_ecs_dashboard。
Category	string	Alibaba Cloud サービスのカテゴリ。たとえば、ApsaraDB for Redis には `kvstore_standard` (Standard Edition)、`kvstore_sharding` (Cluster Edition)、`kvstore_splitrw` (読み取り/書き込み分離エディション) があります。	ecs。
EnableEndTime	integer	アラートブラックリストポリシーの開始時間のタイムスタンプ。単位: ミリ秒。	1640608200000
Name	string	アラートブラックリストポリシーの名前。	Blacklist リスト-01
EnableStartTime	integer	アラートブラックリストポリシーの終了時間のタイムスタンプ。単位: ミリ秒。	1640237400000
Id	string	アラートブラックリストポリシーの ID。	93514c96-ceb8-47d8-8ee3-93b6d98b****
Metrics	array<object>	インスタンスの監視メトリクス。
	object	インスタンスの監視メトリクス。
Resource	string	インスタンスの拡張ディメンション情報。たとえば、`{"device":"C:"}` というフォーマットは、アラートブラックリストポリシーが Alibaba Cloud サービス配下の ECS インスタンスのすべての C デバイスに適用されることを示します。	[{"device":"C:"}]
MetricName	string	監視メトリクス名。	disk_utilization
Instances	array	アラートブラックリストポリシー内の指定された Alibaba Cloud サービスのインスタンス。
	string	アラートブラックリストポリシー内の指定された Alibaba Cloud サービスのインスタンス。	i-rj99xc6cptkk64ml****
ScopeValue	array	アプリケーショングループの ID。
	string	アプリケーショングループの ID。値は JSON Array フォーマットです。説明このパラメーターは、`ScopeType` が `GROUP` に設定されている場合にのみ返されます。	["67**","78**"]

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "D63E76CB-29AA-5B9F-88CE-400A6F28D428",
  "Total": 1,
  "Success": true,
  "DescribeMetricRuleBlackList": [
    {
      "EffectiveTime": "00:00-23:59",
      "UpdateTime": "1665718373000",
      "CreateTime": "1665714561000",
      "ScopeType": "USER",
      "IsEnable": true,
      "Namespace": "acs_ecs_dashboard",
      "Category": "ecs",
      "EnableEndTime": 1640608200000,
      "Name": "Blacklist-01",
      "EnableStartTime": 1640237400000,
      "Id": "93514c96-ceb8-47d8-8ee3-93b6d98b****",
      "Metrics": [
        {
          "Resource": "[{\"device\":\"C:\"}]",
          "MetricName": "disk_utilization"
        }
      ],
      "Instances": [
        "i-rj99xc6cptkk64ml****"
      ],
      "ScopeValue": [
        "[\"67****\",\"78****\"]"
      ]
    }
  ]
}

エラーコード

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.
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

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

変更履歴

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