StopSandbox - 停止 Sandbox

停止 Sandbox。

接口说明

停止指定的沙箱实例。停止后,沙箱将进入 TERMINATED 状态。

调试

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

授权信息

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

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

请求语法

POST /2025-09-10/sandboxes/{sandboxId}/stop HTTP/1.1

请求参数

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

沙箱 ID

sb-1234567890abcdef

返回参数

名称类型描述示例值
StopSandboxResult

返回删除结构体的结果

示例

正常返回示例

JSON格式

{
  "code": "",
  "requestId": "",
  "data": {
    "sandboxId": "",
    "templateId": "",
    "templateName": "",
    "status": "",
    "createdAt": "",
    "lastUpdatedAt": "",
    "sandboxIdleTimeoutSeconds": 0,
    "endedAt": "",
    "sandboxArn": "",
    "sandboxIdleTTLInSeconds": 0,
    "metadata": {
      "test": "test",
      "test2": 1
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-11-23OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情
2025-11-20新增 OpenAPI查看变更详情