停止一个智能体实例。
接口说明
- 功能描述:此接口用于停止并终止一个正在运行中的智能体实例,释放相关资源。
- 参数注意:需要提供待停止实例的唯一 ID(InstanceId)作为查询参数。
- 应用场景:当不再需要某个智能体参与通话或任务时,可调用此接口结束其运行。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:StopAIAgentInstance | none | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 智能体实例 ID,用于指定需要停止的智能体实例。 | 39f8e0bc005e4f309379701645f4**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}
错误码
访问错误中心查看更多错误码。