CopyPlaybook - Security Center - Alibaba Cloud Documentation Center

Copies a playbook.

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing of response orchestration. The service is billed based on the log traffic generated by Threat Analysis and Response.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:CopyPlaybook

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DisplayName	string	Yes	The display name of the playbook.	playbook_xxx
Description	string	No	The description of the playbook.	playbook description
SourcePlaybookUuid	string	Yes	The UUID of the playbook to copy. Note You can call the DescribePlaybooks operation to obtain this parameter.	94bc318c-**-4cba-**-801ccb0d739f
ReleaseVersion	string	No	The published version of the playbook to copy. The default value is 0. Valid values: -1: the version that is being edited. 0: the latest published version.	0
Lang	string	No	The language of the content within the request and response. Valid values: zh (default): Chinese. en: English.	zh
RoleType	string	No	The view type. Valid values: 0 (default): the view of the current account. 1: the view of the global account.	0
RoleFor	integer	No	The UID of the member. This parameter is used when an administrator switches to the context of a member account.	137602*****718726

Response elements

Element	Type	Description	Example
	object	SophonResult
RequestId	string	The ID of the request. This ID is generated by Alibaba Cloud for each request and is used for troubleshooting.	2EC05B06-**-5F3E-**-3B1FAD76087A
Data	object	The data returned.
DisplayName	string	The name of the new playbook.	11111
PlaybookUuid	string	The UUID of the new playbook.	9e38111e-9794-4784-9ca8-xxxxxxx
OwnType	string	The type of the playbook. Valid values: preset: a predefined playbook. user: a custom playbook.	user
Active	integer	The status of the playbook. Valid values: 1: enabled. 0: disabled.	1
LastRuntime	integer	The last running time of the playbook. This value is a 13-digit timestamp.	1725258397847
Permission	integer	The permissions on the playbook. Valid values: 1: read-only. 2: read and write.	1
GmtCreate	integer	The time when the playbook was created. This value is a 13-digit timestamp.	1655951601000
GmtModified	integer	The time when the playbook was last modified. This value is a 13-digit timestamp.	1638270967000
HistoryMd5	integer	The number of historical versions of the playbook.	1
SuccNum	integer	The number of successful runs.	1
FailNum	integer	The number of failed runs.	1
FailRate	number	The failure rate.	0.5
InputParams	string	The input parameters of the playbook.	[{\"name\":\"1\",\"dataType\":\"String\",\"required\":false,\"isArray\":false,\"example\":\"\",\"description\":\"\",\"id\":0,\"typeName\":\"String\",\"dataClass\":\"normal\"}]
OutputParams	string	The output parameters of the playbook.	[]
Description	string	The description of the playbook.	This is a action of processing for WAF
LogicReleaseTaskflowMd5	string	The MD5 hash of the published version of the playbook.	037046****1b00c4717963818ccbf2xx
PlaybookStatus	integer	The status of the playbook.	1
TenantId	string	The UID of the user who owns the playbook.	13760*****8718726
Page	object	The pagination information.
TotalCount	integer	The total number of entries.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "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
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.