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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eventbridge:GetAgent

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	エージェント名。	my-agent

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
Message	string	エラーメッセージ。	Agent with name 'xxx' not found for account 1186xxx
RequestId	string	リクエスト ID。	E0FFAB67-XXXXXX-CAD4D37448C4
Data	Agent	返された結果。	true
Code	string	API ステータスまたは POP エラーコード。有効な値: Success: 成功。	Success
Success	boolean	操作が成功した場合に true を返します。	true

例

成功レスポンス

JSONJSON

{
  "Message": "Agent with name 'xxx' not found for account 1186xxx",
  "RequestId": "E0FFAB67-XXXXXX-CAD4D37448C4",
  "Data": {
    "Name": "",
    "Description": "",
    "Prompt": "",
    "Metadata": {
      "Attachments": [
        {
          "MimeType": "inner-resource/event-table",
          "Arn": "acs:eventbridge:cn-hangzhou:12345:eventhouse/system-rocketmq/namespace/rmq-cn-xxx/table/order"
        }
      ]
    },
    "CreatedAt": 0,
    "UpdatedAt": 0
  },
  "Code": "Success",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	ServiceNotEnable	Service not enable

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

変更履歴

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