SearchTraceAppByPage - Application Real-Time Monitoring Service - Alibaba Cloud ドキュメントセンター

アプリケーションモニタリングタスクをページ単位で照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

arms:SearchTraceAppByPage

none

*TraceApp

acs:arms:{#regionId}:{#accountId}:traceapp/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TraceAppName	string	任意	アプリケーションの名前です。	test-app
PageNumber	integer	任意	返されるページ番号です。デフォルト値は `1` です。	1
PageSize	integer	任意	1 ページあたりに返すエントリ数です。デフォルト値は `10` です。	10
RegionId	string	必須	リージョン ID です。	cn-hangzhou
ResourceGroupId	string	任意	リソースグループ ID です。	rg-acfmxyexli2****
Tags	array<object>	任意	タグのリストです。
	object	任意
Key	string	任意	タグキーです。	TestKey
Value	string	任意	タグ値です。	TestValue

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	4B446DF2-3DDD-4B5B-8E3F-D5225120****
PageBean	object	配列オブジェクトに関する情報です。
PageNumber	integer	返されたページのページ番号です。	1
PageSize	integer	1ページあたりに返されるエントリ数です。	10
TotalCount	integer	返されたエントリの総数です。	3
TraceApps	array<object>	モニタリングタスクに関する情報です。
	array<object>
Type	string	モニタリングタスクのタイプです。有効な値： `TRACE` ：アプリケーションモニタリング `RETCODE` ：ブラウザモニタリング	TRACE
AppName	string	アプリケーション名です。	test-app
UpdateTime	integer	タスク情報の更新時に生成されたタイムスタンプです。	1531291867000
Show	boolean	アプリケーションが Application Real-Time Monitoring Service (ARMS) コンソールに表示されるかどうかを示します。有効な値： `true` ：はい `false` ：いいえ	true
CreateTime	integer	タスクの作成時に生成されたタイムスタンプです。	1531291867000
Pid	string	アプリケーションを識別するための ID (PID) です。	atc889zkcf@d8deedfa9bf****
AppId	integer	アプリケーション ID です。	123
UserId	string	ユーザー ID です。	113197164949****
RegionId	string	リージョン ID です。	cn-hangzhou
Labels	array	アプリケーションのエイリアスのリストです。
	string	アプリケーションのエイリアスです。	prod
Tags	array<object>	タグのリストです。
	object
Key	string	タグキーです。	TestKey
Value	string	タグ値です。	TestValue
ResourceGroupId	string	リソースグループ ID です。	rg-acfmxyexli2****

例

成功レスポンス

JSONJSON

{
  "RequestId": "4B446DF2-3DDD-4B5B-8E3F-D5225120****",
  "PageBean": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 3,
    "TraceApps": [
      {
        "Type": "TRACE",
        "AppName": "test-app",
        "UpdateTime": 1531291867000,
        "Show": true,
        "CreateTime": 1531291867000,
        "Pid": "atc889zkcf@d8deedfa9bf****",
        "AppId": 123,
        "UserId": "113197164949****",
        "RegionId": "cn-hangzhou",
        "Labels": [
          "prod"
        ],
        "Tags": [
          {
            "Key": "TestKey",
            "Value": "TestValue"
          }
        ],
        "ResourceGroupId": "rg-acfmxyexli2****"
      }
    ]
  }
}

エラーコード

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

変更履歴

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