すべてのプロダクト
Search
ドキュメントセンター

Application Real-Time Monitoring Service:DoInsightsAction

最終更新日:Jun 24, 2026

パラメーターで指定されたモジュールタイプに基づいて、対応する操作を実行します。

今すぐお試しください

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

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Module

string

必須

モジュールタイプ

  • QueryTopo

    トポロジークエリ特徴。トポロジーはエッジとノードで構成されます。各エッジには対応するタイプがあり、各ノードには対応するエンティティがあり、各エンティティにはそのタイプがあります。エッジタイプ、ノードタイプ、クエリ時間範囲、およびその他のフィルターパラメーターを設定することで、必要なトポロジーデータをフィルタリングできます。

  • QueryTopoRed

    トポロジー RED メトリクス(リクエスト数、レイテンシー、エラー数)クエリ。メトリクスクエリオプションを有効にしてトポロジーを照会する場合、トポロジーが large すぎてすべてのメトリクスデータを取得できないことがあります。この特徴により、ユーザーは指定されたノードとエッジのメトリクスデータを能動的に照会できます。

注意: 上記の特徴はカナリアリリース中であり、デフォルトでは有効になっていません。有効にするには、ARMS オンコールサポートに連絡してください。

列挙値:

  • QueryTopoRed :

    トポロジー RED メトリクスクエリ。

  • QueryTopo :

    トポロジークエリ。

QueryTopo

Data

string

必須

クエリパラメーター。クエリパラメーターはモジュールタイプによって異なります。

  • QueryTopo

{
    "regionId": 文字列,  #リージョン ID
    "startTime": 文字列, #開始時刻。フォーマットは yyyy-MM-dd HH:mm:ss
    "endTime": 文字列, #終了時間。フォーマットは yyyy-MM-dd HH:mm:ss
    "edgeFilter": { #エッジフィルター条件
        "includeTypes": [enum], #含めるエッジタイプ
        "excludeTypes": [enum], #除外するエッジタイプ
        "fromNodeFilter": { #ソースノードフィルター条件
            "includeEntityTypes": [enum] #含めるエンティティタイプ
            "excludeEntityTypes": [enum] #除外するエンティティタイプ
        },
        "toNodeFilter": {  #ターゲットノードフィルター条件
            "includeEntityTypes": [enum] #含めるエンティティタイプ
            "excludeEntityTypes": [enum] #除外するエンティティタイプ
        }
    },
    "includeIsolatedNodes": boolean, #孤立ノードを含めるかどうか
    "isolatedNodeFilter": { # 孤立ノードフィルター条件
        "includeEntityTypes": [enum] #含めるエンティティタイプ
        "excludeEntityTypes": [enum] #除外するエンティティタイプ
     },
    "queryMetrics": boolean, # トポロジー照会時に関連する RED メトリクスを同期的に照会するかどうか
    "timeoutSecs": int, # メトリクスクエリのタイムアウト(秒)
	"redOption": { #メトリクスクエリ制御オプション
		"skipRt": boolean,  # RT メトリクスの照会をスキップするかどうか
		"skipCount": boolean, # リクエスト数メトリクスの照会をスキップするかどうか
		"skipError": boolean # エラー数メトリクスの照会をスキップするかどうか
	}
}

  • QueryTopoRed

{
    "regionId": 文字列,  #リージョン ID
    "startTime": 文字列, #開始時刻。フォーマットは yyyy-MM-dd HH:mm:ss
    "endTime": 文字列,   #終了時間。フォーマットは yyyy-MM-dd HH:mm:ss
    "edgeIds": [文字列]  #照会するエッジ ID
    "nodeIds": [文字列]  #照会するノード ID
    "redOption": { #メトリクスクエリ制御オプション
        "skipRt": boolean,  # RT メトリクスの照会をスキップするかどうか
        "skipCount": boolean, # リクエスト数メトリクスの照会をスキップするかどうか
        "skipError": boolean # エラー数メトリクスの照会をスキップするかどうか
    }
}

- QueryTopo { "regionId": "cn-hangzhou", "startTime": "2024-07-23 19:16:00", "endTime": "2024-07-23 20:16:00", # 限定拓扑查询范围为 2024-07-23 19:16:00至2024-07-23 20:16:00 "edgeFilter": { "includeTypes": [ "CALLS" # 限定结果拓扑中仅包含调用关系的边 ], "fromNodeFilter": { "includeEntityTypes": [ # 限定调用边的源节点类型必须为应用类型 "APPLICATION" ] }, "toNodeFilter": { "includeEntityTypes": [ # 限定调用边的目标节点必须为应用类型或者外部服务类型 "APPLICATION", "EXTERNAL_SERVICE" ] } }, "includeIsolatedNodes": false, # 结果拓扑中不包含孤立节点 "queryMetrics": true, # 同步查询RED指标 "timeoutSecs": 20, #最多用20秒来查询指标数据 "redOption": { # 查询的指标包括耗时、请求量,跳过错误数的查询 "skipRt": false, "skipCount": false, "skipError": true } } - QueryTopoRed { "regionId": "cn-hangzhou", "startTime": "2024-07-23 10:00:00", "endTime": "2024-07-23 14:00:00", "edgeIds": [ "097843bd50b06fbe2c6c1d8b761a7e8b" ], "nodeIds": [ "23d973261c6923da1b5b7a571ec1aa8b" ], "redOption": { # 查询的指标包括耗时、请求量,跳过错误数的查询 "skipCount": false, "skipError": true, "skipRt": false } }

RegionId

string

任意

リージョン ID。

cn-hangzhou

トポロジーはエッジとノードで構成されます。各エッジには対応するタイプがあり、各ノードには対応するエンティティがあり、各エンティティにはそのタイプがあります。エッジタイプ、ノードタイプ、クエリ時間範囲、およびその他のパラメーターを設定することで、必要なトポロジーデータをフィルターできます。

  • 孤立ノード。

    孤立ノードとは、他のノードとの関係を持たないノードを指します。

フィールドタイプが enum の場合、そのフィールドの値は列挙型から取得されます。列挙型の定義については補足説明を参照してください。

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ。

RequestId

string

リクエスト ID。

626037F5-FDEB-45B0-804C-B3C92797A64E

Code

integer

状態コード。200 は成功を示し、その他の状態コードは例外を示します。

200

Success

boolean

クエリが成功したかどうか:

  • true: 成功。

  • false: 失敗した。

true

Message

string

呼び出しが失敗した場合に返されるメッセージ。

success

Data

string

戻りパラメーターのタイプは、渡されたモジュール値に関連します。

  • QueryTopo

    {
     "nodes": [Object] #ノードコレクション。戻りパラメーターの補足説明にある Node 定義を参照してください。
     "edges": [Object] #エッジコレクション。戻りパラメーターの補足説明にある Edge 定義を参照してください。
    }
    
  • QueryTopoRed

    {
      "nodeRed": {
      	"nodeId": {
      		"count": double, #クエリ期間中のリクエスト総数
      		"error": double, #クエリ期間中のエラー総数
      		"rt": double, #クエリ期間中の平均レイテンシー(ミリ秒)
      	}
      },
      "edgeRed": {
      	"edgeId": {
      	    "count": double, #クエリ期間中のリクエスト総数
      		"error": double, #クエリ期間中のエラー総数
      		"rt": double, #クエリ期間中の平均レイテンシー(ミリ秒)
      	}
      }
    

}

- QueryTopo { "nodes": [ { "nodeId": "3bfe1a747389273388182760406c079d", "entity": { "regionId": "cn-hangzhou", "appType": "TRACE", "appId": "xxxxxxxxxxxxxxxx", "name": "prometheus-pop-cn-hangzhou", "entityId": "3bfe1a747389273388182760406c079d", "firstSeenTms": 1721733226981, "lastSeenTms": 1721789171614, "type": "APPLICATION" }, "attrs": { "RED": { "count": 643848.0, "error": 0.0, "rt": 172.31701892372112 } } } ], "edges": [ { "from": "98b4184b22e588cf86e9a29aa4179606", "to": "98b4184b22e588cf86e9a29aa4179606", "type": "CALLS", "attrs": { "RED": { "count": 4.0, "error": 0.0, "rt": 37.0 } }, "edgeId": "5d611597e4b0013d0947615c9eca4de6", "firstSeenTms": 1721783795125, "lastSeenTms": 1721787371614 } ] } - QueryTopoRed { "nodeRed": { "361d9f32e58cef316bf2355f3ff05575": { "count": 3258110.0, "error": 74.0, "rt": 167.39844355494878 } }, "edgeRed": {} }

  • Node 定義

     {
     	"nodeId": 文字列, #ノード ID
     	"entity": Object, #エンティティ情報。タイプによってフィールドが異なります。補足説明のエンティティ情報を参照してください。
     	"attrs": { #拡張属性情報 
     		"RED": { # RED メトリクス
     			"count": double, #クエリ期間中のリクエスト総数
     			"error": double, #クエリ期間中のエラー総数
     			"rt": double, # クエリ期間中の平均レイテンシー(ミリ秒)
     		}
     	}
     }
    
  • Edge 定義

     	{
     	"from": 文字列, #ノード ID
     	"to": 文字列,   #ノード ID
     	"type": enum, #補足説明のエッジタイプを参照してください
     	"attrs": { #拡張属性情報
     		"RED": { # RED メトリクス
     			"count": double, #クエリ期間中のリクエスト総数
     			"error": double, #クエリ期間中のエラー総数
     			"rt": double,    #クエリ期間中の平均レイテンシー(ミリ秒)
     		}
     	},
     	"edgeId": 文字列, #エッジ ID
     	"firstSeenTms": long, #エッジが最初に検出されたタイムスタンプ(ミリ秒)
     	"lastSeenTms": long,  #エッジが最後に検出されたタイムスタンプ(ミリ秒)
     }
    
      ```。
    

成功レスポンス

JSONJSON

{
  "RequestId": "626037F5-FDEB-45B0-804C-B3C92797A64E",
  "Code": 200,
  "Success": true,
  "Message": "success",
  "Data": "- QueryTopo\n\n\n\t{\n\t\t\"nodes\": [\n\t\t\t{\n\t\t\t\t\"nodeId\": \"3bfe1a747389273388182760406c079d\",\n\t\t\t\t\"entity\": {\n\t\t\t\t\t\"regionId\": \"cn-hangzhou\",\n\t\t\t\t\t\"appType\": \"TRACE\",\n\t\t\t\t\t\"appId\": \"xxxxxxxxxxxxxxxx\",\n\t\t\t\t\t\"name\": \"prometheus-pop-cn-hangzhou\",\n\t\t\t\t\t\"entityId\": \"3bfe1a747389273388182760406c079d\",\n\t\t\t\t\t\"firstSeenTms\": 1721733226981,\n\t\t\t\t\t\"lastSeenTms\": 1721789171614,\n\t\t\t\t\t\"type\": \"APPLICATION\"\n\t\t\t\t},\n\t\t\t\t\"attrs\": {\n\t\t\t\t\t\"RED\": {\n\t\t\t\t\t\t\"count\": 643848.0,\n\t\t\t\t\t\t\"error\": 0.0,\n\t\t\t\t\t\t\"rt\": 172.31701892372112\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"edges\": [\n\t\t\t{\n\t\t\t\t\"from\": \"98b4184b22e588cf86e9a29aa4179606\",\n\t\t\t\t\"to\": \"98b4184b22e588cf86e9a29aa4179606\",\n\t\t\t\t\"type\": \"CALLS\",\n\t\t\t\t\"attrs\": {\n\t\t\t\t\t\"RED\": {\n\t\t\t\t\t\t\"count\": 4.0,\n\t\t\t\t\t\t\"error\": 0.0,\n\t\t\t\t\t\t\"rt\": 37.0\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"edgeId\": \"5d611597e4b0013d0947615c9eca4de6\",\n\t\t\t\t\"firstSeenTms\": 1721783795125,\n\t\t\t\t\"lastSeenTms\": 1721787371614\n\t\t\t}\n\t\t]\n\t}\n\n\n- QueryTopoRed\n\n\t{\n\t\t\"nodeRed\": {\n\t\t\t\"361d9f32e58cef316bf2355f3ff05575\": {\n\t\t\t\t\"count\": 3258110.0,\n\t\t\t\t\"error\": 74.0,\n\t\t\t\t\"rt\": 167.39844355494878\n\t\t\t}\n\t\t},\n\t\t\"edgeRed\": {}\n\t}\n\n"
}

エラーコード

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

変更履歴

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