DescribeLogMonitorList を使用したログ監視メトリクスのクエリ - 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:DescribeLogMonitorList

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：10。	10
SearchValue	string	任意	ログ監視メトリックの検索に使用されるキーワード。あいまい一致がサポートされています。	test
GroupId	integer	任意	アプリケーショングループの ID。	123456

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	01E90080-4300-4FAA-B9AE-161956BC350D
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true
Code	string	ステータスコード。説明ステータスコード 200 は、リクエストが成功したことを示します。	200
Message	string	返されたメッセージ。	successful
PageSize	integer	1 ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
Total	integer	返されたエントリの総数。	15
LogMonitorList	array<object>	ログ監視メトリック。
	array<object>
ValueFilterRelation	string	ログフィルター条件の間で使用される論理演算子。ValueFilter パラメーターと ValueFilterRelation パラメーターはペアで使用されます。有効な値： and or	and
SlsLogstore	string	Simple Log Service (SLS) の Logstore の名前。	testSlS****
MetricName	string	メトリック名。詳細については、「付録 1：メトリック」をご参照ください。	cpu_total
GroupId	integer	アプリケーショングループの ID。	12345
LogId	integer	ログ監視メトリックの ID。	12345
SlsRegionId	string	SLS Logstore が存在するリージョンの ID。	cn-hangzhou
GmtCreate	integer	ログ監視メトリックが作成された時間。この値は、協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数を表す UNIX タイムスタンプです。	1577766395000
SlsProject	string	SLS プロジェクトの名前。	sls-project-test****
ValueFilter	array<object>	ログのフィルターに使用される条件。ValueFilter パラメーターと ValueFilterRelation パラメーターはペアで使用されます。フィルター条件は、SQL 文の WHERE 句に相当します。フィルター条件が指定されていない場合、すべてのログが処理されます。たとえば、ログに Level フィールドと Error フィールドが含まれているとします。Error レベルのログが 1 分あたりに出現する回数を計算する必要がある場合、フィルター条件を Level=Error に設定し、この条件を満たすログの数をカウントできます。
	object
Key	string	フィルター条件での照合に使用されるログフィールドの名前。	hostName
Value	string	フィルター条件で照合されるフィールド値。	portal
Operator	string	フィールド値を照合するために使用されるメソッド。有効な値： contain：含む notContain：含まない `>`：より大きい `<`：より小さい `>=`：以上 `<=`：以下	contain

例

成功レスポンス

JSONJSON

{
  "RequestId": "01E90080-4300-4FAA-B9AE-161956BC350D",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Total": 15,
  "LogMonitorList": [
    {
      "ValueFilterRelation": "and",
      "SlsLogstore": "testSlS****",
      "MetricName": "cpu_total",
      "GroupId": 12345,
      "LogId": 12345,
      "SlsRegionId": "cn-hangzhou",
      "GmtCreate": 1577766395000,
      "SlsProject": "sls-project-test****",
      "ValueFilter": [
        {
          "Key": "hostName",
          "Value": "portal",
          "Operator": "contain"
        }
      ]
    }
  ]
}

エラーコード

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.

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

変更履歴

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