機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

エージェント・グループのステータスの取得

get

/ic/api/integration/v1/monitoring/agentgroups

現在の可用性ステータスを含むすべてのエージェント・グループのモニタリング・データを取得します。

リクエスト

問合せパラメータ

• integrationInstance(required): string
  これはサービス・インスタンスの名前です。 この値は、サービス・インスタンス・フィールドで指定した情報ページから取得できます。
• orderBy: string

  名前または最終更新時間による結果の順序付け。

  例:

  /agentgroups?orderBy=time

  /agentgroups?orderBy=name

• q: string

  エージェント・グループ名で結果をフィルタします。

  例:

  {name:'Execution Agents Group'}

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json; charset=utf-8

200レスポンス

操作の成功

本文()

ルート・スキーマ : AgentGroupsMonitoringRs

型: object

ソースを表示

• has-more: boolean
  さらに
• items: array items
  エージェント・グループのリスト
• limit: integer (int32)
  制限
• total-results: integer (int32)
  結果合計

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Agent Group",
            "items":{
                "$ref":"#/components/schemas/AgentGroupMonitoringRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "description":"Limit",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Has More"
        }
    }
}

ネストされたスキーマ: items

型: array

エージェント・グループのリスト

ソースを表示

• Array of: object AgentGroupMonitoringRs

{
    "type":"array",
    "description":"List of Agent Group",
    "items":{
        "$ref":"#/components/schemas/AgentGroupMonitoringRs"
    }
}

ネストされたスキーマ : AgentGroupMonitoringRs

型: object

ソースを表示

• agents: array agents
  エージェントのリスト
• created-by: string
  作成者
• created-date: string (date-time)
  作成日
• description: string
  説明
• display-status: string
  ステータスの表示
• last-updated-by: string
  最終更新者
• last-updated-date: string (date-time)
  最終更新日
• name: string
  名前
• status: string
  許容値: [ "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE" ]
• type: string
  許容値: [ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
• version: string
  バージョン

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version"
        },
        "name":{
            "type":"string",
            "description":"Name"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "created-date":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "last-updated-date":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "type":{
            "$ref":"#/components/schemas/AgentType"
        },
        "status":{
            "$ref":"#/components/schemas/AgentGroupStatus"
        },
        "display-status":{
            "type":"string",
            "description":"Display Status"
        },
        "agents":{
            "type":"array",
            "description":"List of Agents",
            "items":{
                "$ref":"#/components/schemas/AgentMonitoringRs"
            }
        }
    }
}

ネストされたスキーマ : agents

型: array

エージェントのリスト

ソースを表示

• Array of: object AgentMonitoringRs

{
    "type":"array",
    "description":"List of Agents",
    "items":{
        "$ref":"#/components/schemas/AgentMonitoringRs"
    }
}

ネストされたスキーマ : AgentMonitoringRs

型: object

ソースを表示

• agent-group-code: string
  代理人グループ・コード
• created-by: string
  作成者
• created-date: string (date-time)
  作成日
• description: string
  説明
• display-status: string
  ステータスの表示
• last-locked-by: string
  最終ロック者
• last-locked-date: string (date-time)
  最終ロック日
• last-updated-by: string
  最終更新者
• last-updated-date: string (date-time)
  最終更新日
• name: string
  名前
• status: string
  許容値: [ "REGISTERED", "ACTIVE", "UNAVAILABLE" ]
• type: string
  許容値: [ "ADAPTER_AGENT", "EXECUTION_AGENT" ]
• version: string
  バージョン

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version"
        },
        "name":{
            "type":"string",
            "description":"Name"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "created-date":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "last-updated-date":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-locked-date":{
            "type":"string",
            "description":"Last Locked Date",
            "format":"date-time"
        },
        "last-locked-by":{
            "type":"string",
            "description":"Last Locked By"
        },
        "agent-group-code":{
            "type":"string",
            "description":"Agent Group Code"
        },
        "type":{
            "$ref":"#/components/schemas/AgentType"
        },
        "status":{
            "$ref":"#/components/schemas/AgentStatus"
        },
        "display-status":{
            "type":"string",
            "description":"Display Status"
        }
    }
}

400レスポンス

パラメータの形式が正しくありません

500レスポンス

サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、エージェント・グループのステータスを取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。 エンドポイントURLの構造の詳細は、「リクエストの送信」を参照してください。

例: エージェント・グループのステータスの取得

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @runIntegration.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/agentgroups?integrationInstance=service-instance

先頭に戻る