ModifyMetricRuleBlackList API でブラックリストポリシーを修改 - CMS

ブラックリストポリシーを変更します。

今すぐお試しください

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

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	string	必須	ブラックリストポリシーの ID。ブラックリストポリシーの ID を取得する方法については、「DescribeMetricRuleBlackList」をご参照ください。	93514c96-ceb8-47d8-8ee3-93b6d98b****
Name	string	必須	ブラックリストポリシーの名前。	Blacklist-02
Namespace	string	必須	クラウドサービスの名前空間。クラウドサービスの名前空間の詳細については、「付録1：メトリック」をご参照ください。	acs_ecs_dashboard
Category	string	必須	クラウドサービスのカテゴリ。たとえば、ApsaraDB for Redis は、標準アーキテクチャ、クラスタアーキテクチャ、読み書き分離アーキテクチャをサポートしています。この場合、ApsaraDB for Redis のこのパラメーターの有効な値は、`kvstore_standard`、`kvstore_sharding`、`kvstore_splitrw` です。	ecs
ScopeType	string	任意	ブラックリストポリシーの有効範囲。有効な値： USER：ブラックリストポリシーは、現在の Alibaba Cloud アカウント内でのみ有効になります。 GROUP (デフォルト)：ブラックリストポリシーは、指定されたアプリケーショングループ内でのみ有効になります。アプリケーショングループの ID を取得する方法については、「DescribeMonitorGroups」をご参照ください。	USER
ScopeValue	string	任意	アプリケーショングループの ID。説明 `ScopeType` が `GROUP` に設定されている場合にのみ、このパラメーターは必須です。	["67**","78**"]
EnableStartTime	string	任意	ブラックリストポリシーが有効になるタイムスタンプ。単位：ミリ秒。	1640237400000
EnableEndTime	string	任意	ブラックリストポリシーの有効期限が切れるタイムスタンプ。単位：ミリ秒。	1640608200000
EffectiveTime	string	任意	ブラックリストポリシーが有効な時間範囲。次の情報にご注意ください：このパラメーターを設定しない場合、ブラックリストポリシーは永続的に有効になります。このパラメーターを設定した場合、ブラックリストポリシーは指定された時間範囲内でのみ有効になります。例： `03:00-04:59`：ブラックリストポリシーは、ローカルタイムの 03:00 から 05:00 まで有効です。ローカルタイムの 05:00 は除外されます。 `03:00-04:59 UTC+0700`：ブラックリストポリシーは、03:00 から 05:00 (UTC+7) まで有効です。05:00 (UTC+7) は除外されます。	03:00-04:59
Instances	array	必須	指定されたクラウドサービスに属するインスタンスの ID。
	string	任意	指定されたクラウドサービスに属するインスタンスの ID。 N の有効値：1～100。	{"instancceId":"i-bp1ew0zfkjblsuwx****"}
Metrics	array<object>	任意	インスタンスのメトリック。このパラメーターを設定しない場合、ブラックリストポリシーは指定されたクラウドサービスのすべてのメトリックに適用されます。このパラメーターを設定した場合、ブラックリストポリシーは現在のメトリックにのみ適用されます。
	object	任意	なし。
MetricName	string	必須	メトリックの名前。 N の有効値：1～10。	disk_utilization
Resource	string	任意	インスタンスの拡張ディメンション。たとえば、`{"device":"C:"}` は、ブラックリストポリシーが指定された Elastic Compute Service (ECS) インスタンスのすべての C ディスクに適用されることを指定します。 N の有効値：1～10。	{"device":"C:"}

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

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
Code	string	エラーコード。説明ステータスコード 200 は、リクエストが成功したことを示します。	200
Message	string	エラーメッセージ。	The specified resource is not found.
RequestId	string	リクエスト ID。	008773AE-1D86-3231-90F9-1AF7F808F9CE
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true
Count	string	変更されたブラックリストポリシーの数。	1

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "008773AE-1D86-3231-90F9-1AF7F808F9CE",
  "Success": true,
  "Count": "1"
}

エラーコード

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.

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

変更履歴

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