更新时间:2025-07-04 GMT+08:00

删除剧本

功能介绍

删除剧本

调用方法

请参见如何调用API

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

workspace_id

String

工作空间ID

playbook_id

String

ID of playbook

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

content-type

String

application/json;charset=UTF-8

响应参数

状态码:200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表4 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息

data

PlaybookInfo object

剧本详情信息

表5 PlaybookInfo

参数

参数类型

描述

id

String

剧本ID

name

String

剧本名称

description

String

描述信息

create_time

String

剧本创建时间

update_time

String

剧本更新时间

project_id

String

项目ID

version_id

String

剧本版本ID

enabled

Boolean

是否启用

workspace_id

String

工作空间ID

approve_role

String

审核用户角色

user_role

String

用户角色

edit_role

String

编辑用户角色

owner_id

String

所有者ID

version

String

版本号

dataclass_name

String

数据类名称

dataclass_id

String

数据类ID

unaudited_version_id

String

待审核剧本版本ID

reject_version_id

String

已驳回剧本版本ID

状态码:400

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表7 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

响应示例

状态码:200

请求成功响应信息

{
  "code" : 0,
  "message" : "Error message",
  "data" : {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "MyXXX",
    "description" : "This my XXXX",
    "create_time" : "2021-01-30T23:00:00Z+0800",
    "update_time" : "2021-01-30T23:00:00Z+0800",
    "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "enabled" : true,
    "workspace_id" : "string",
    "approve_role" : "approve",
    "user_role" : "string",
    "edit_role" : "editor",
    "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version" : "v1.1.1",
    "dataclass_name" : "string",
    "dataclass_id" : "string",
    "unaudited_version_id" : "string",
    "reject_version_id" : "string"
  }
}

状态码

状态码

描述

200

请求成功响应信息

400

请求失败响应信息

错误码

请参见错误码