GetAgent - 查询智能体状态

GetAgent。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。仅支持传单个 ID,您可以在控制台创建和查询。

aec****
ChannelIdstring

频道 id

1234
TaskIdstring

任务 id

yourTaskId

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

6159ba01-6687-4fb2-a831-f0cd8d188648
StartTimestring

创建时间戳,Unix 时间,单位为毫秒

1751513144838
StopTimestring

结束时间戳,Unix 时间,单位为毫秒

1751513144838
Statusstring

智能体状态, 0-未启动,1-正在启动,2-正在运行,3-正在停止,4-已经结束,5-运行失败

1
Messagestring

状态描述信息

Success

示例

正常返回示例

JSON格式

{
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d188648",
  "StartTime": 1751513144838,
  "StopTime": 1751513144838,
  "Status": 1,
  "Message": "Success"
}

错误码

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