すべてのプロダクト
Search

このプロダクト

    :GetChatFlowMetric

    ドキュメントセンター

    :GetChatFlowMetric

    最終更新日:Jul 07, 2026

    ChatFlow のランタイムデータを取得します。

    操作説明

    • この操作を呼び出す前に、作成したフローがオンラインであり、トリガー済みであることを確認してください。

    • フローがオンラインでない場合は、フローエディター コンソールページに移動し、フロー名をクリックしてキャンバスを開き、手動でフローをオンラインにしてください。または、 OnlineFlowVersion 操作を呼び出してフローをオンラインにすることもできます。

    • トリガータイプが手動のフローの場合、 TriggerChatFlow 操作を呼び出してフローをトリガーするか、マーケティングアクティビティ管理 コンソールページに移動し、キャンペーンに関連付けてフローをトリガーしてください。

    • トリガータイプが手動以外のフローの場合、手動でフローをトリガーする必要はありません。バインドされたビジネスアカウントにメッセージが送信されると、フローは自動的にトリガーされます。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cams:GetChatFlowMetric

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BizCode

    string

    任意

    ビジネステナントコード。デフォルト値: ALICOM_OPAAS。

    列挙値:

    • ALICOM_OPAAS :

      ALICOM_OPAAS

    ALICOM_OPAAS
    BizExtend

    object

    任意

    ビジネス拡張情報。デフォルト値: 空のコレクション。

    {}
    From

    integer

    任意

    開始時刻。この値は UNIX タイムスタンプです。単位: 秒。

    1751299200
    To

    integer

    任意

    終了時刻。この値は UNIX タイムスタンプです。単位: 秒。

    1751385599
    FlowCode

    string

    任意

    フローコード。フローコードは フローエディター コンソールページで確認できます。

    9ccc41**************************
    FlowVersion

    string

    任意

    フローバージョン。フローエディター コンソールページでフロー名をクリックしてキャンバスを開き、フローバージョンを確認できます。

    1
    MetricName

    string

    必須

    メトリック名。有効な値:

    • nodeUsageStatistics: ノード使用量統計。

    • nodeErrorDetails: ノードエラーの詳細。

    列挙値:

    • nodeUsageStatistics :

      nodeUsageStatistics

    nodeUsageStatistics
    MetricParam

    object

    任意

    メトリッククエリの拡張パラメーター。MetricName が nodeErrorDetails にセットされている場合、JSON 文字列を渡します。JSON フィールドの有効な値:

    • pageNo: 現在のページ番号。

    • pageSize: ページサイズ。

    • nodeId: ノード ID。フローエディター コンソールページでフロー名をクリックしてキャンバスを開き、ノード ID をコピーできます。

    { "pageNo": 1, "pageSize": 20, "nodeId": "SendWhatsAppMessage#H7fKq5rM" }

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    AccessDeniedDetail

    string

    アクセス拒否の詳細。

    None
    Message

    string

    エラーメッセージ。

    None
    RequestId

    string

    リクエスト ID。

    90E63D28-E31D-1EB2-8939-A94866411B2O
    Data

    object

    返されるデータオブジェクト。

    Code

    string

    エラーコード。詳細については、「エラーコード」を参照してください。

    OK
    Success

    boolean

    操作が成功したかどうかを示します。有効な値:

    • true: 操作が成功しました。

    • false: 操作が失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

    エラーコード

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

    変更履歴

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