GetAgent - 获取Agent元数据 - 事件总线EventBridge

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:GetAgent

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	Agent 名称	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	接口状态或 POP 错误码。取值说明如下：Success：成功。	Success
Success	boolean	操作成功返回 true。	true

示例

正常返回示例

JSON格式

{
  "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 status code	错误码	错误信息	描述
403	ServiceNotEnable	Service not enable

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。