CopyPlaybook - 复制剧本

剧本复制。

接口说明

请确保在使用该接口前,已充分了解响应编排产品(即威胁分析与响应日志接入流量)的收费方式和价格

调试

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

授权信息

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

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

请求参数

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

剧本展示名称。

playbook_xxx
Descriptionstring

剧本的描述。

playbook description
SourcePlaybookUuidstring

要复制的剧本 UUID。

说明 调用 DescribePlaybooks 接口可以获取该参数。
94bc318c-****-4cba-****-801ccb0d739f
ReleaseVersionstring

要复制剧本的发布版本,默认为 0。 取值:

  • -1:代表正在编辑中的版本。

  • 0:当前剧本的线上最新发布版本。

0
Langstring

请求和接收消息的语言类型。取值:

  • zh:(默认):中文。

  • en:英文。

zh
RoleTypestring

视图类型。取值:

  • 0(默认):当前账号视图。

  • 1:全局账号视图。

0
RoleForlong

管理员切换成其他成员视角的用户 ID。

137602*****718726

返回参数

名称类型描述示例值
object

SophonResult

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

2EC05B06-****-5F3E-****-3B1FAD76087A
Dataobject

返回结果信息。

DisplayNamestring

复制后的剧本名称。

11111
PlaybookUuidstring

复制后剧本的 UUID。

9e38111e-9794-4784-9ca8-xxxxxxx
OwnTypestring

剧本的类型。取值:

  • preset:预定义剧本。

  • user:自定义剧本。

user
Activeinteger

剧本的启用状态。取值:

  • 1:剧本已启用。

  • 0:剧本未启用。

1
LastRuntimelong

剧本的最后执行时间。格式:13 位的时间戳。

1725258397847
Permissioninteger

剧本的操作权限。取值:

  • 1:不可编辑,可查看

  • 2:可编辑

1
GmtCreatelong

剧本创建时间。格式:13 位的时间戳。

1655951601000
GmtModifiedlong

剧本修改时间。格式:13 位的时间戳。

1638270967000
HistoryMd5integer

剧本历史版本数。

1
SuccNuminteger

剧本执行成功数。

1
FailNuminteger

剧本执行失败数。

1
FailRatedouble

剧本执行失败率。

0.5
InputParamsstring

剧本的入参。

[{\"name\":\"1\",\"dataType\":\"String\",\"required\":false,\"isArray\":false,\"example\":\"\",\"description\":\"\",\"id\":0,\"typeName\":\"String\",\"dataClass\":\"normal\"}]
OutputParamsstring

剧本的出参。

[]
Descriptionstring

剧本描述。

This is a action of processing for WAF
LogicReleaseTaskflowMd5string

剧本的线上版本 MD5。

037046****1b00c4717963818ccbf2xx
PlaybookStatusinteger

剧本状态。

1
TenantIdstring

剧本所属的用户 ID。

13760*****8718726
Pageobject

分页查询信息。

TotalCountinteger

总条数。

100
PageNumberinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页显示的条目数量。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "2EC05B06-****-5F3E-****-3B1FAD76087A",
  "Data": {
    "DisplayName": 11111,
    "PlaybookUuid": "9e38111e-9794-4784-9ca8-xxxxxxx",
    "OwnType": "user",
    "Active": 1,
    "LastRuntime": 1725258397847,
    "Permission": 1,
    "GmtCreate": 1655951601000,
    "GmtModified": 1638270967000,
    "HistoryMd5": 1,
    "SuccNum": 1,
    "FailNum": 1,
    "FailRate": 0.5,
    "InputParams": "[{\\\"name\\\":\\\"1\\\",\\\"dataType\\\":\\\"String\\\",\\\"required\\\":false,\\\"isArray\\\":false,\\\"example\\\":\\\"\\\",\\\"description\\\":\\\"\\\",\\\"id\\\":0,\\\"typeName\\\":\\\"String\\\",\\\"dataClass\\\":\\\"normal\\\"}]",
    "OutputParams": [],
    "Description": "This is a action of processing for WAF",
    "LogicReleaseTaskflowMd5": "037046****1b00c4717963818ccbf2xx",
    "PlaybookStatus": 1,
    "TenantId": "13760*****8718726"
  },
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

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