diff options
Diffstat (limited to 'data/en_us/sophonsoar')
| -rw-r--r-- | data/en_us/sophonsoar/2022-07-28/api-docs.php | 10406 | ||||
| -rw-r--r-- | data/en_us/sophonsoar/2025-09-03/api-docs.php | 2529 |
2 files changed, 5257 insertions, 7678 deletions
diff --git a/data/en_us/sophonsoar/2022-07-28/api-docs.php b/data/en_us/sophonsoar/2022-07-28/api-docs.php index 9643567..9fc31f2 100644 --- a/data/en_us/sophonsoar/2022-07-28/api-docs.php +++ b/data/en_us/sophonsoar/2022-07-28/api-docs.php @@ -1,394 +1,183 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'sophonsoar', - 'version' => '2022-07-28', - ], + 'info' => ['style' => 'RPC', 'product' => 'sophonsoar', 'version' => '2022-07-28'], 'directories' => [ [ - 'id' => 349146, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'CopyPlaybook', - 'ConvertPlaybook', - 'RunPython3Script', - 'ComparePlaybooks', - 'CreatePlaybook', - 'DebugPlaybook', - 'DeleteComponentAsset', - 'DeletePlaybook', - 'DescribeComponentAssetForm', - 'DescribeComponentAssets', - 'DescribeComponentList', - 'DescribeComponentPlaybook', - 'DescribeComponentsJs', - 'DescribeDistinctReleases', - 'DescribeEnumItems', - 'DescribeExecutePlaybooks', - 'DescribeField', - 'DescribeLatestRecordSchema', - 'DescribeNodeParamTags', - 'DescribePlaybook', - 'DescribePlaybookInputOutput', - 'DescribePlaybookMetrics', - 'DescribePlaybookNodesOutput', - 'DescribePlaybookNumberMetrics', - 'DescribePlaybookReleases', - 'DescribePlaybooks', - 'DescribePopApi', - 'DescribeSoarRecordActionOutputList', - 'DescribeSoarRecordInOutput', - 'DescribeSoarRecords', - 'DescribeSoarTaskAndActions', - 'DescriberPython3ScriptLogs', - 'ModifyComponentAsset', - 'ModifyPlaybook', - 'ModifyPlaybookInputOutput', - 'PublishPlaybook', - 'QueryTreeData', - 'RevertPlaybookRelease', - 'TriggerPlaybook', - 'TriggerSophonPlaybook', - 'VerifyPlaybook', - 'VerifyPythonFile', + 'BatchModifyInstanceStatus', 'RunPython3Script', 'ComparePlaybooks', 'CreatePlaybook', 'DebugPlaybook', 'DeleteComponentAsset', 'DeletePlaybook', 'DescribeComponentAssetForm', 'DescribeComponentAssets', 'DescribeComponentList', 'DescribeComponentPlaybook', 'DescribeComponentsJs', 'DescribeDistinctReleases', 'DescribeEnumItems', 'DescribeExecutePlaybooks', 'DescribeField', 'DescribeLatestRecordSchema', 'DescribeNodeParamTags', 'DescribeNodeUsedInfos', 'DescribePlaybook', + 'DescribePlaybookInputOutput', 'DescribePlaybookMetrics', 'DescribePlaybookNodesOutput', 'DescribePlaybookNumberMetrics', 'DescribePlaybookReleases', 'DescribePlaybooks', 'DescribePopApi', 'DescribeSoarRecordActionOutputList', 'DescribeSoarRecordInOutput', 'DescribeSoarRecords', 'DescribeSoarTaskAndActions', 'DescriberPython3ScriptLogs', 'ModifyComponentAsset', 'ModifyPlaybook', 'ModifyPlaybookInputOutput', 'ModifyPlaybookInstanceStatus', 'PublishPlaybook', 'QueryTreeData', 'RevertPlaybookRelease', 'TriggerPlaybook', + 'TriggerSophonPlaybook', 'VerifyPlaybook', 'VerifyPythonFile', ], + 'type' => 'directory', + 'title' => 'Playbook orchestration', ], [ - 'id' => 349193, - 'title' => null, + 'children' => ['DescribeProcessStatistics', 'DescribeProcessTasks', 'DescribeProcessTaskCount', 'DescribeSophonCommands', 'TriggerProcessTask'], 'type' => 'directory', - 'children' => [ - 'DescribeProcessStatistics', - 'DescribeProcessTasks', - 'DescribeProcessTaskCount', - 'DescribeSophonCommands', - 'TriggerProcessTask', - ], + 'title' => 'Remediation tasks', ], [ - 'id' => 349199, - 'title' => null, + 'children' => ['DescribeOpenApiList', 'DescribeGroupProductions', 'RunNotifyComponentWithEmail', 'RunNotifyComponentWithMessageCenter', 'RunNotifyComponentWithWebhook', 'ConvertPlaybook', 'CopyPlaybook', 'DescribeNotifyTemplateList', 'DescribeOpenApiInfo', 'DescribeVendorApiList'], 'type' => 'directory', - 'children' => [ - 'DescribeOpenApiList', - 'DescribeOpenApiInfo', - 'DescribeGroupProductions', - 'DescribeNotifyTemplateList', - 'RunNotifyComponentWithEmail', - 'RunNotifyComponentWithMessageCenter', - 'RunNotifyComponentWithWebhook', - 'DescribeVendorApiList', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CopyPlaybook' => [ - 'summary' => 'Copies a playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'BatchModifyInstanceStatus' => [ + 'summary' => 'Enables or disables a batch of playbooks.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '218814', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DisplayName', + 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本展示名称', - 'description' => 'The display name of the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'playbook_xxx', - ], + 'schema' => ['title' => '', 'description' => 'The UUID of the playbook. To modify multiple playbooks, separate the UUIDs with commas.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,s8df2e-s8dfs-xxxx'], ], [ - 'name' => 'Description', + 'name' => 'Active', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的描述', - 'description' => 'The description of the playbook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'playbook description', - ], + 'schema' => ['title' => '', 'description' => 'The status to set for the playbook. Valid values:'."\n" + ."\n" + .'- **0**: Disables the playbook.'."\n" + ."\n" + .'- **1**: Enables the playbook.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'SourcePlaybookUuid', - 'in' => 'formData', + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'zh'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '要复制的剧本uuid', - 'description' => 'The UUID of the playbook that you want to copy.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '94bc318c-****-4cba-****-801ccb0d739f', + 'title' => 'SophonResult<Void>', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9ED0-A1A361CDE615\\"\\n}","type":"json"}]', + 'title' => 'BatchModifyInstanceStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ComparePlaybooks' => [ + 'summary' => 'Compares the configurations of two published playbook versions.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ReleaseVersion', - 'in' => 'formData', - 'schema' => [ - 'title' => '要复制的剧本的taskflowMd5. 特殊取值：-1：代表现在编辑中的版本 0:当前剧本的线上最新发布版本(不传默认为0)', - 'description' => 'The release version of the playbook that you want to copy. Default value: 0. Valid values:'."\n" - ."\n" - .'* \\-1: The version that is being edited.'."\n" - .'* 0: The latest online version of the current playbook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f916b93e-e814-459f-9662-xxxxx'], ], [ - 'name' => 'Lang', + 'name' => 'OldPlaybookReleaseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default).'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The UUID of the first published version for comparison.'."\n" + ."\n" + .'> To obtain the UUID of a historical version, call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation. The system automatically generates a UUID for a new version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => 'sflk23423-e814-459f-9662-xxxxx'], ], [ - 'name' => 'RoleType', + 'name' => 'NewPlaybookReleaseId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view. Valid values:'."\n" - ."\n" - .'* **0** (default): the view of the current account.'."\n" - .'* **1**: the view of the global account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The UUID of the second published version for comparison.'."\n" + ."\n" + .'> To obtain the UUID of a historical version, call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation. The system automatically generates a UUID for a new version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => 'sfdf2395-e814-459f-9662-xxxxx'], ], [ - 'name' => 'RoleFor', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '137602*****718726', - ], + 'schema' => ['description' => 'The language of the request and response.'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<PlaybookCloudDTO>', - 'description' => 'SophonResult'."\n", + 'title' => 'SophonResult<CompareResult>', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'title' => '剧本的名称', - 'description' => 'The name of the new playbook.'."\n", - 'type' => 'string', - 'example' => '11111', - ], - 'PlaybookUuid' => [ - 'title' => '剧本的UUID', - 'description' => 'The UUID of the new playbook.'."\n", - 'type' => 'string', - 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx', - ], - 'OwnType' => [ - 'title' => '剧本的权限类型', - 'description' => 'The type of the playbook. Valid values:'."\n" - ."\n" - .'* preset: predefined playbook.'."\n" - .'* user: custom playbook.'."\n", - 'type' => 'string', - 'example' => 'user', - ], - 'Active' => [ - 'title' => '剧本的启用状态', - 'description' => 'The status of the playbook. Valid values:'."\n" - ."\n" - .'* 1: enabled.'."\n" - .'* 0: disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LastRuntime' => [ - 'title' => '剧本的最后执行时间', - 'description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1725258397847', - ], - 'Permission' => [ - 'title' => '剧本是否可编辑', - 'description' => 'The permission to operate the playbook. Valid values:'."\n" - ."\n" - .'* 1: view.'."\n" - .'* 2: edit.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtCreate' => [ - 'title' => '剧本创建时间', - 'description' => 'The time when the playbook was created. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655951601000', - ], - 'GmtModified' => [ - 'title' => '剧本创建时间', - 'description' => 'The time when the playbook was modified. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1638270967000', - ], - 'HistoryMd5' => [ - 'title' => '剧本历史版本数', - 'description' => 'The number of historical versions of the playbook.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SuccNum' => [ - 'title' => '剧本执行成功数', - 'description' => 'The number of successful playbook executions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'FailNum' => [ - 'title' => '剧本执行失败数', - 'description' => 'The number of playbook execution failures.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'FailRate' => [ - 'title' => '剧本执行失败率', - 'description' => 'The failure rate of playbook execution.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.5', - ], - 'InputParams' => [ - 'title' => '剧本的入参', - 'description' => 'The input parameters of the playbook.'."\n", - 'type' => 'string', - 'example' => '[{\\"name\\":\\"1\\",\\"dataType\\":\\"String\\",\\"required\\":false,\\"isArray\\":false,\\"example\\":\\"\\",\\"description\\":\\"\\",\\"id\\":0,\\"typeName\\":\\"String\\",\\"dataClass\\":\\"normal\\"}]', - ], - 'OutputParams' => [ - 'title' => '剧本的出参', - 'description' => 'The output parameters of the playbook.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'Description' => [ - 'title' => '剧本描述', - 'description' => 'The description of the playbook.'."\n", - 'type' => 'string', - 'example' => 'This is a action of processing for WAF', - ], - 'LogicReleaseTaskflowMd5' => [ - 'title' => '剧本的线上版本', - 'description' => 'The online version MD5 of the playbook.'."\n", - 'type' => 'string', - 'example' => '037046****1b00c4717963818ccbf2xx', - ], - 'PlaybookStatus' => [ - 'title' => '剧本描述', - 'description' => 'The status of the playbook.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TenantId' => [ - 'title' => '剧本所属的租户', - 'description' => 'The ID of the user to which the playbook belongs.'."\n", - 'type' => 'string', - 'example' => '13760*****8718726', - ], - ], - ], - 'Page' => [ - 'description' => 'The pagination information.'."\n", + 'RequestId' => ['description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A'], + 'CompareResult' => [ + 'title' => '', + 'description' => 'The result of the comparison.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'Same' => ['description' => 'Indicates whether the two versions are identical.'."\n" + ."\n" + .'- **true**: Identical.'."\n" + ."\n" + .'- **false**: Not identical.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'New' => ['description' => 'Indicates whether the second version used for comparison is a new version.'."\n" + ."\n" + .'- **true**: The version is new.'."\n" + ."\n" + .'- **false**: The version is not new.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The description of the comparison result.', 'type' => 'string', 'example' => 'The first version adds one node compared to the second version', 'title' => ''], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2EC05B06-****-5F3E-****-3B1FAD76087A\\",\\n \\"CompareResult\\": {\\n \\"Same\\": false,\\n \\"New\\": true,\\n \\"Description\\": \\"The first version adds one node compared to the second version\\"\\n }\\n}","type":"json"}]', + 'title' => 'ComparePlaybooks', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ComparePlaybooks'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2EC05B06-****-5F3E-****-3B1FAD76087A\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"11111\\",\\n \\"PlaybookUuid\\": \\"9e38111e-9794-4784-9ca8-xxxxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1725258397847,\\n \\"Permission\\": 1,\\n \\"GmtCreate\\": 1655951601000,\\n \\"GmtModified\\": 1638270967000,\\n \\"HistoryMd5\\": 1,\\n \\"SuccNum\\": 1,\\n \\"FailNum\\": 1,\\n \\"FailRate\\": 0.5,\\n \\"InputParams\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"isArray\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"typeName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataClass\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"normal\\\\\\\\\\\\\\"}]\\",\\n \\"OutputParams\\": \\"[]\\",\\n \\"Description\\": \\"This is a action of processing for WAF\\",\\n \\"LogicReleaseTaskflowMd5\\": \\"037046****1b00c4717963818ccbf2xx\\",\\n \\"PlaybookStatus\\": 1,\\n \\"TenantId\\": \\"13760*****8718726\\"\\n },\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'CopyPlaybook', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + 'ramActions' => [], ], 'ConvertPlaybook' => [ 'summary' => 'Convert XML configuration.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -401,71 +190,47 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208668', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Taskflow', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本编辑配置', - 'description' => 'XML configuration information for playbook orchestration.', - 'type' => 'string', - 'required' => true, - 'example' => '<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>'."\n" - .'<bpmn:definitions xmlns:xsi=\\"http://www.w3.org/2001/XMLSchema-instance\\" xmlns:bpmn=\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\" xmlns:bpmndi=\\"http://www.omg.org/spec/BPMN/20100524/DI\\" xmlns:dc=\\"http://www.omg.org/spec/DD/20100524/DC\\" id=\\"Definitions_1\\" targetNamespace=\\"http://bpmn.io/schema/bpmn\\">'."\n" - .' <bpmn:process id=\\"Process_1\\" isExecutable=\\"false\\">'."\n" - .' <bpmn:startEvent id=\\"StartEvent_1\\" />'."\n" - .' </bpmn:process>'."\n" - .' <bpmndi:BPMNDiagram id=\\"BPMNDiagram_1\\">'."\n" - .' <bpmndi:BPMNPlane id=\\"BPMNPlane_1\\" bpmnElement=\\"Process_1\\">'."\n" - .' <bpmndi:BPMNShape id=\\"_BPMNShape_StartEvent_2\\" bpmnElement=\\"StartEvent_1\\">'."\n" - .' <dc:Bounds x=\\"173\\" y=\\"102\\" width=\\"36\\" height=\\"36\\" />'."\n" - .' </bpmndi:BPMNShape>'."\n" - .' </bpmndi:BPMNPlane>'."\n" - .' </bpmndi:BPMNDiagram>'."\n" - .'</bpmn:definitions>'."\n" - .' ', - ], + 'schema' => ['title' => '剧本编辑配置', 'description' => 'XML configuration information for playbook orchestration.', 'type' => 'string', 'required' => true, 'example' => '<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>'."\n" + .'<bpmn:definitions xmlns:xsi=\\"http://www.w3.org/2001/XMLSchema-instance\\" xmlns:bpmn=\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\" xmlns:bpmndi=\\"http://www.omg.org/spec/BPMN/20100524/DI\\" xmlns:dc=\\"http://www.omg.org/spec/DD/20100524/DC\\" id=\\"Definitions_1\\" targetNamespace=\\"http://bpmn.io/schema/bpmn\\">'."\n" + .' <bpmn:process id=\\"Process_1\\" isExecutable=\\"false\\">'."\n" + .' <bpmn:startEvent id=\\"StartEvent_1\\" />'."\n" + .' </bpmn:process>'."\n" + .' <bpmndi:BPMNDiagram id=\\"BPMNDiagram_1\\">'."\n" + .' <bpmndi:BPMNPlane id=\\"BPMNPlane_1\\" bpmnElement=\\"Process_1\\">'."\n" + .' <bpmndi:BPMNShape id=\\"_BPMNShape_StartEvent_2\\" bpmnElement=\\"StartEvent_1\\">'."\n" + .' <dc:Bounds x=\\"173\\" y=\\"102\\" width=\\"36\\" height=\\"36\\" />'."\n" + .' </bpmndi:BPMNShape>'."\n" + .' </bpmndi:BPMNPlane>'."\n" + .' </bpmndi:BPMNDiagram>'."\n" + .'</bpmn:definitions>'."\n" + .' '], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'Language type for request and response messages. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'Language type for request and response messages. Values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleType', 'in' => 'query', - 'schema' => [ - 'description' => 'View type. Values:'."\n" - ."\n" - .'- 0: Current Alibaba Cloud account view.'."\n" - .'- 1: View for all accounts under the enterprise.', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'View type. Values:'."\n" + ."\n" + .'- 0: Current Alibaba Cloud account view.'."\n" + .'- 1: View for all accounts under the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'query', - 'schema' => [ - 'description' => 'User ID for the administrator to switch to another member\'s perspective.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'User ID for the administrator to switch to another member\'s perspective.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], ], 'responses' => [ @@ -475,38 +240,41 @@ 'description' => 'SophonResult<String>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '39C38A34-****-*****-****-7263B435C316', - ], - 'Config' => [ - 'title' => '传输的数据', - 'description' => 'The configurations.', - 'type' => 'string', - 'example' => '{}', - ], + 'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '39C38A34-****-*****-****-7263B435C316'], + 'Config' => ['title' => '传输的数据', 'description' => 'The configurations.', 'type' => 'string', 'example' => '{}'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-****-*****-****-7263B435C316\\",\\n \\"Config\\": \\"{}\\"\\n}","type":"json"}]', 'title' => 'Convert Playbook Flowchart Configuration Format', 'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the orchestration product before using this interface.', - 'translator' => 'machine', - ], - 'RunPython3Script' => [ - 'summary' => 'Submits and runs a Python3 script. You can call this operation only for data processing.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:ConvertPlaybook', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertPlaybook'], + ], ], + ], + 'CopyPlaybook' => [ + 'summary' => 'Copies a playbook.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -517,249 +285,145 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '218814', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ - 'name' => 'PythonScript', + 'name' => 'DisplayName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The Python3 script.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'import logging'."\n" - .'def execute (params):'."\n" - .' #ip = params[\'ip\']'."\n" - .' #logging.info("enter execute,ip is "+ip)'."\n" - .' success=True'."\n" - .' message=\'OK\''."\n" - .' data=[]'."\n" - .' return (success,message,data)', - ], + 'schema' => ['title' => '', 'description' => 'The display name of the playbook.'."\n", 'type' => 'string', 'required' => true, 'example' => 'playbook_xxx'], ], [ - 'name' => 'Params', + 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The input parameters of the Python3 script.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "input1": "xx.xx.xx.xx",'."\n" - .' "input2": "7d"'."\n" - .'}', - ], + 'schema' => ['title' => '', 'description' => 'The description of the playbook.'."\n", 'type' => 'string', 'required' => false, 'example' => 'playbook description'], ], [ - 'name' => 'PlaybookUuid', + 'name' => 'SourcePlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.', - 'type' => 'string', - 'required' => false, - 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The UUID of the playbook that you want to copy.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.'."\n", 'type' => 'string', 'required' => true, 'example' => '94bc318c-****-4cba-****-801ccb0d739f'], ], [ - 'name' => 'NodeName', + 'name' => 'ReleaseVersion', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the node in the playbook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'python3_3', - ], - ], - [ - 'name' => 'PythonVersion', - 'in' => 'query', - 'schema' => [ - 'title' => 'python版本。', - 'type' => 'string', - 'example' => 'python2.0', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<String>', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F210521C-D9BF-5264-8369-83EDDC617DB0', - ], - 'RunResult' => [ - 'title' => '传输的数据', - 'description' => 'The execution result of the Python3 script.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n" - .' "content": {'."\n" - .' "resultData": [],'."\n" - .' "success": true'."\n" - .' }'."\n" - .'}', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F210521C-D9BF-5264-8369-83EDDC617DB0\\",\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\"\\n}","type":"json"}]', - 'title' => 'RunPython3Script', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.alibabacloud.com/en/pricing-calculator?_p_lc=1&spm=openapi-amp.newDocPublishment.0.0.4c41281fWhbdPa#/commodity/vm_intl).', - 'responseParamsDescription' => 'The value of **RunResult** is a JSON object, which contains the following fields:'."\n" - ."\n" - .'* **requestUuid**: the UUID of the request, which is used to query operational logs.'."\n" - .'* **content**: the execution result of the Python3 script, which is defined by users.'."\n", - ], - 'ComparePlaybooks' => [ - 'summary' => 'Compares configurations between two versions of a published playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'PlaybookUuid', - 'in' => 'query', - 'schema' => [ - 'title' => '剧本的UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'f916b93e-e814-459f-9662-xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The release version of the playbook that you want to copy. Default value: 0. Valid values:'."\n" + ."\n" + .'* \\-1: The version that is being edited.'."\n" + .'* 0: The latest online version of the current playbook.'."\n", 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'OldPlaybookReleaseId', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'title' => '老版本的ID', - 'description' => 'The ID of the first version.'."\n" - ."\n" - .'> You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to query the IDs of versions. The system automatically generates IDs for new versions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => 'sflk23423-e814-459f-9662-xxxxx', - ], + 'schema' => ['description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default).'."\n" + .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ - 'name' => 'NewPlaybookReleaseId', + 'name' => 'RoleType', 'in' => 'query', - 'schema' => [ - 'title' => '新版本的ID', - 'description' => 'The ID of the second version.'."\n" - ."\n" - .'> You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to query the IDs of versions. The system automatically generates IDs for new versions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => 'sfdf2395-e814-459f-9662-xxxxx', - ], + 'schema' => ['description' => 'The type of the view. Valid values:'."\n" + ."\n" + .'* **0** (default): the view of the current account.'."\n" + .'* **1**: the view of the global account.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'RoleFor', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602*****718726', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<CompareResult>', - 'description' => 'The response parameters.'."\n", + 'title' => 'SophonResult<PlaybookCloudDTO>', + 'description' => 'SophonResult'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2EC05B06-BF3C-5F3E-8FE8-3B1FAD76087A', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A'], + 'Data' => [ + 'title' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['title' => '', 'description' => 'The name of the new playbook.'."\n", 'type' => 'string', 'example' => '11111'], + 'PlaybookUuid' => ['title' => '', 'description' => 'The UUID of the new playbook.'."\n", 'type' => 'string', 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx'], + 'OwnType' => ['title' => '', 'description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'* preset: predefined playbook.'."\n" + .'* user: custom playbook.'."\n", 'type' => 'string', 'example' => 'user'], + 'Active' => ['title' => '', 'description' => 'The status of the playbook. Valid values:'."\n" + ."\n" + .'* 1: enabled.'."\n" + .'* 0: disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'LastRuntime' => ['title' => '', 'description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1725258397847'], + 'Permission' => ['title' => '', 'description' => 'The permission to operate the playbook. Valid values:'."\n" + ."\n" + .'* 1: view.'."\n" + .'* 2: edit.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'GmtCreate' => ['title' => '', 'description' => 'The time when the playbook was created. The value is a 13-digit timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1655951601000'], + 'GmtModified' => ['title' => '', 'description' => 'The time when the playbook was modified. The value is a 13-digit timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1638270967000'], + 'HistoryMd5' => ['title' => '', 'description' => 'The number of historical versions of the playbook.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SuccNum' => ['title' => '', 'description' => 'The number of successful playbook executions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'FailNum' => ['title' => '', 'description' => 'The number of playbook execution failures.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'FailRate' => ['title' => '', 'description' => 'The failure rate of playbook execution.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.5'], + 'InputParams' => ['title' => '', 'description' => 'The input parameters of the playbook.'."\n", 'type' => 'string', 'example' => '[{\\"name\\":\\"1\\",\\"dataType\\":\\"String\\",\\"required\\":false,\\"isArray\\":false,\\"example\\":\\"\\",\\"description\\":\\"\\",\\"id\\":0,\\"typeName\\":\\"String\\",\\"dataClass\\":\\"normal\\"}]'], + 'OutputParams' => ['title' => '', 'description' => 'The output parameters of the playbook.'."\n", 'type' => 'string', 'example' => '[]'], + 'Description' => ['title' => '', 'description' => 'The description of the playbook.'."\n", 'type' => 'string', 'example' => 'This is a action of processing for WAF'], + 'LogicReleaseTaskflowMd5' => ['title' => '', 'description' => 'The online version MD5 of the playbook.'."\n", 'type' => 'string', 'example' => '037046****1b00c4717963818ccbf2xx'], + 'PlaybookStatus' => ['title' => '', 'description' => 'The status of the playbook.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TenantId' => ['title' => '', 'description' => 'The ID of the user to which the playbook belongs.'."\n", 'type' => 'string', 'example' => '13760*****8718726'], + ], + 'example' => '', ], - 'CompareResult' => [ - 'title' => '传输的数据', - 'description' => 'The comparison result.'."\n", + 'Page' => [ + 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ - 'Same' => [ - 'description' => 'Indicates whether the configurations of the two versions are the same. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'New' => [ - 'description' => 'Indicates whether the second version provides more information than the first version. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Description' => [ - 'description' => 'The description of the comparison result.'."\n", - 'type' => 'string', - 'example' => 'The first version adds one node compared to the second version', - ], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CopyPlaybook', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyPlaybook'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2EC05B06-****-5F3E-****-3B1FAD76087A\\",\\n \\"CompareResult\\": {\\n \\"Same\\": false,\\n \\"New\\": true,\\n \\"Description\\": \\"The first version adds one node compared to the second version\\"\\n }\\n}","type":"json"}]', - 'title' => 'ComparePlaybooks', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-sas:CopyPlaybook', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2EC05B06-****-5F3E-****-3B1FAD76087A\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"11111\\",\\n \\"PlaybookUuid\\": \\"9e38111e-9794-4784-9ca8-xxxxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1725258397847,\\n \\"Permission\\": 1,\\n \\"GmtCreate\\": 1655951601000,\\n \\"GmtModified\\": 1638270967000,\\n \\"HistoryMd5\\": 1,\\n \\"SuccNum\\": 1,\\n \\"FailNum\\": 1,\\n \\"FailRate\\": 0.5,\\n \\"InputParams\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"isArray\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"typeName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataClass\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"normal\\\\\\\\\\\\\\"}]\\",\\n \\"OutputParams\\": \\"[]\\",\\n \\"Description\\": \\"This is a action of processing for WAF\\",\\n \\"LogicReleaseTaskflowMd5\\": \\"037046****1b00c4717963818ccbf2xx\\",\\n \\"PlaybookStatus\\": 1,\\n \\"TenantId\\": \\"13760*****8718726\\"\\n },\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', ], 'CreatePlaybook' => [ - 'summary' => 'New Playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Creates a new playbook.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -772,123 +436,97 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '167210', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'DisplayName', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本名称', - 'description' => 'Name of the playbook.', - 'type' => 'string', - 'required' => true, - 'example' => 'test09', - ], + 'schema' => ['title' => '剧本名称', 'description' => 'The name of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'test09'], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的描述', - 'description' => 'Description of the playbook.', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a new version', - ], + 'schema' => ['title' => '剧本的描述', 'description' => 'The description of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'This is a new version'], ], [ 'name' => 'TaskflowType', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'Playbook TaskFlow type.'."\n" - .'- **x6** : x6'."\n" - .'- **bpmn**: bpmn', - 'example' => 'x6', - ], + 'schema' => ['description' => 'The configuration format of the playbook.'."\n" + ."\n" + .'- **xml**: XML format.'."\n" + ."\n" + .'- **x6**: JSON format.', 'type' => 'string', 'required' => false, 'example' => 'x6', 'title' => ''], ], [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'Language type for receiving messages. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese'."\n" - .'- **en**: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the messages to receive. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'OutputParams', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本输出配置。', - 'type' => 'string', - 'example' => '{\'result\': \'success\'}', - ], + 'schema' => ['description' => 'The output configuration of the playbook.', 'type' => 'string', 'example' => '{\'result\': \'success\'}', 'title' => '', 'required' => false], ], [ 'name' => 'InputParams', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本输入配置。', - 'type' => 'string', - 'example' => '{\'key1\': \'value1\', \'key2\': \'value2\'}', - ], + 'schema' => ['description' => 'The input configuration of the playbook.', 'type' => 'string', 'example' => '{\'key1\': \'value1\', \'key2\': \'value2\'}', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<PlaybookCloudDTO>', - 'description' => 'Return information.', + 'description' => 'The returned information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for this request, which can be used to troubleshoot and locate issues.', - 'type' => 'string', - 'example' => 'B09B40B2-F11E-512C-B755-423F2056C17B', - ], + 'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'B09B40B2-F11E-512C-B755-423F2056C17B'], 'Data' => [ 'title' => '传输的数据', - 'description' => 'The result of the creation.', + 'description' => 'The returned result of the creation.', 'type' => 'object', 'properties' => [ - 'PlaybookUuid' => [ - 'title' => '剧本唯一标识符。', - 'description' => 'UUID of the newly created playbook.', - 'type' => 'string', - 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx', - ], + 'PlaybookUuid' => ['title' => '剧本的UUID', 'description' => 'The UUID of the newly created playbook.', 'type' => 'string', 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx'], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B09B40B2-F11E-512C-B755-423F2056C17B\\",\\n \\"Data\\": {\\n \\"PlaybookUuid\\": \\"9e38111e-9794-4784-9ca8-xxxxxxx\\"\\n }\\n}","type":"json"}]', 'title' => 'CreatePlaybook', - 'description' => 'Create Playbook.', - 'translator' => 'machine', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlaybook'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-sas:CreatePlaybook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/*'], + ], + ], + ], + ], ], 'DebugPlaybook' => [ 'summary' => 'Debugs a playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -896,102 +534,81 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The playbook UUID.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'f916b93e-e814-459f-9662-xxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f916b93e-e814-459f-9662-xxxxx'], ], [ 'name' => 'Record', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的入参', - 'description' => 'The input parameters that you use to debug the playbook. You can define the parameters based on your business requirements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "param1":"a",'."\n" - .' "param2":"b"'."\n" - .'}', - ], + 'schema' => ['description' => 'The user-defined input parameters for debugging the playbook.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "param1":"a",'."\n" + .' "param2":"b"'."\n" + .'}'], ], [ 'name' => 'Taskflow', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本流程', - 'description' => 'The XML configuration of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybook](~~DescribePlaybook~~) operation to query the XML configuration of the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'."\n", - ], + 'schema' => ['description' => 'The XML configuration of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybook](~~DescribePlaybook~~) operation to obtain this configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'."\n"], ], [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<PlaybookTriggerDTO>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF', - ], - 'RequestUuid' => [ - 'description' => 'The UUID of the debugging task. You can use the UUID to query the result and other details of the debugging task.'."\n", - 'type' => 'string', - 'example' => '6d412cfa-0905-4567-8a83-xxxxxx', - ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF'], + 'RequestUuid' => ['description' => 'The run UUID of the debugging task. Use this UUID to query information, such as the task result.', 'type' => 'string', 'example' => '6d412cfa-0905-4567-8a83-xxxxxx', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF\\",\\n \\"RequestUuid\\": \\"6d412cfa-0905-4567-8a83-xxxxxx\\"\\n}","type":"json"}]', 'title' => 'DebugPlaybook', - ], - 'DeleteComponentAsset' => [ - 'summary' => 'Deletes the assets in a component.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DebugPlaybook'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DebugPlaybook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], + ], + 'DeleteComponentAsset' => [ + 'summary' => 'Deletes a component asset.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -999,71 +616,65 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AssetId', 'in' => 'query', - 'schema' => [ - 'title' => '资产的ID', - 'description' => 'The ID of the asset.'."\n" - ."\n" - .'> You can call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12x', - ], + 'schema' => ['description' => 'The asset ID of the component.'."\n" + ."\n" + .'> Call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to obtain this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '12x'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<Void>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '39C38A34-8532-5D44-B88A-7263B435C316', - ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '39C38A34-8532-5D44-B88A-7263B435C316'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-8532-5D44-B88A-7263B435C316\\"\\n}","type":"json"}]', 'title' => 'DeleteComponentAsset', - ], - 'DeletePlaybook' => [ - 'summary' => 'Deletes a custom playbook.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentAsset'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'yundun-sas:DeleteComponentAsset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeletePlaybook' => [ + 'summary' => 'Deletes a specified custom playbook.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1075,69 +686,54 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e99dab31-499b-4307-9248-xxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e99dab31-499b-4307-9248-xxxxxx'], ], [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<Void>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]', 'title' => 'DeletePlaybook', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlaybook'], + ], + ], + 'ramActions' => [], ], 'DescribeComponentAssetForm' => [ - 'summary' => 'Queries the metadata of assets in a component. The metadata of an asset refers to the fields that describe the asset.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Obtains the metadata for a component asset, which defines the fields that constitute the asset.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1145,86 +741,79 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ComponentName', 'in' => 'query', - 'schema' => [ - 'title' => '组件的名称', - 'description' => 'The component name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'python3', - ], + 'schema' => ['description' => 'The name of the component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<String>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9D1651AC-31CC-5CC4-A14E-626B3FCC1022', - ], - 'ComponentAssetForm' => [ - 'title' => '传输的数据', - 'description' => 'The metadata of the asset in the component. The value is a JSON array and contains the following fields:'."\n" - ."\n" - .'* **name**: the parameter name.'."\n" - .'* **defaultValue**: the default parameter value.'."\n" - .'* **description**: the parameter description.'."\n" - .'* **required**: indicates whether the parameter is required. Valid values: **true** and **false**.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "defaultValue": "",'."\n" - .' "description": "assetname",'."\n" - .' "name": "assetname",'."\n" - .' "required": true'."\n" - .' }'."\n" - .']', - ], + 'RequestId' => ['description' => 'The ID of the request. This is a unique identifier that is generated by Alibaba Cloud for the request. This ID can be used to locate and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '9D1651AC-31CC-5CC4-A14E-626B3FCC1022'], + 'ComponentAssetForm' => ['description' => 'The configuration metadata for the component asset. The value is a string in the JSON array format. The array contains the following fields:'."\n" + ."\n" + .'- **name**: The name of the parameter.'."\n" + ."\n" + .'- **defaultValue**: The default value of the parameter.'."\n" + ."\n" + .'- **description**: The description of the parameter.'."\n" + ."\n" + .'- **required**: Specifies whether the parameter is required. A value of **true** means it is required. A value of **false** means it is optional.', 'type' => 'string', 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "defaultValue": "",'."\n" + .' "description": "assetname",'."\n" + .' "name": "assetname",'."\n" + .' "required": true'."\n" + .' }'."\n" + .']'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D1651AC-31CC-5CC4-A14E-626B3FCC1022\\",\\n \\"ComponentAssetForm\\": \\"[\\\\n {\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"assetname\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"assetname\\\\\\",\\\\n \\\\\\"required\\\\\\": true\\\\n }\\\\n]\\"\\n}","type":"json"}]', 'title' => 'DescribeComponentAssetForm', - ], - 'DescribeComponentAssets' => [ - 'summary' => 'Queries a list of assets in a component.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssetForm'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeComponentAssetForm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeComponentAssets' => [ + 'summary' => 'Retrieves the asset list for a component.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1232,140 +821,103 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ComponentName', 'in' => 'query', - 'schema' => [ - 'title' => '组件的名称', - 'description' => 'The name of the component.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'python3', - ], + 'schema' => ['description' => 'The component name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response.'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<List<SaoAsset>>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F', - ], + 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F'], 'ComponentAssets' => [ - 'title' => '传输的数据', - 'description' => 'The information about the assets.'."\n", + 'title' => '', + 'description' => 'A list of assets.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Asset information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'This field was generated by MyBatis Generator.', - 'description' => 'The UUID of the asset.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7xx', - ], - 'GmtCreate' => [ - 'title' => 'This field was generated by MyBatis Generator.', - 'description' => 'The time when the asset was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-03-23T14:38Z', - ], - 'GmtModified' => [ - 'title' => 'This field was generated by MyBatis Generator.', - 'description' => 'The time when the asset was modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-03-23T14:38Z', - ], - 'Name' => [ - 'title' => 'This field was generated by MyBatis Generator.', - 'description' => 'The name of the asset.'."\n", - 'type' => 'string', - 'example' => 'test asset', - ], - 'Componentname' => [ - 'title' => 'This field was generated by MyBatis Generator.', - 'description' => 'The name of the component to which the asset belongs.'."\n", - 'type' => 'string', - 'example' => 'pyhton3', - ], - 'Params' => [ - 'title' => 'This field was generated by MyBatis Generator.', - 'description' => 'The configurations of the asset in the JSON string format. DescribeComponentAssetForm'."\n" - ."\n" - .'> For more information, see [DescribeComponentAssetForm](~~DescribeComponentAssetForm~~).'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "name": "authMethod",'."\n" - .' "value": "ak"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "accessKeyId",'."\n" - .' "value": "xxxxxxx"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "accessKeySecret",'."\n" - .' "value": "xxxxx"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "roleArn",'."\n" - .' "value": ""'."\n" - .' }'."\n" - .']', - ], - 'AssetUuid' => [ - 'description' => 'The UUID of the asset.'."\n", - 'type' => 'string', - 'example' => 'ff6fe161-93e2-464c-a326-fxxxxxx', - ], + 'Id' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The unique ID of the asset.', 'type' => 'integer', 'format' => 'int64', 'example' => '7xx'], + 'GmtCreate' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The time when the asset was created. The time is in UTC and follows the yyyy-MM-ddTHH:mm:ssZ format.', 'type' => 'string', 'example' => '2023-03-23T14:38Z'], + 'GmtModified' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The time when the asset was last modified. The time is in UTC and follows the yyyy-MM-ddTHH:mm:ssZ format.', 'type' => 'string', 'example' => '2023-03-23T14:38Z'], + 'Name' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The asset name.', 'type' => 'string', 'example' => 'test asset'], + 'Componentname' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The name of the component that the asset belongs to.', 'type' => 'string', 'example' => 'pyhton3'], + 'Params' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The asset configuration in JSON format.'."\n" + ."\n" + .'> For more information about the format, see [DescribeComponentAssetForm](~~DescribeComponentAssetForm~~).', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "name": "authMethod",'."\n" + .' "value": "ak"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "accessKeyId",'."\n" + .' "value": "xxxxxxx"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "accessKeySecret",'."\n" + .' "value": "xxxxx"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "roleArn",'."\n" + .' "value": ""'."\n" + .' }'."\n" + .']'], + 'AssetUuid' => ['description' => 'The asset\'s UUID.', 'type' => 'string', 'example' => 'ff6fe161-93e2-464c-a326-fxxxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"Id\\": 0,\\n \\"GmtCreate\\": \\"2023-03-23T14:38Z\\",\\n \\"GmtModified\\": \\"2023-03-23T14:38Z\\",\\n \\"Name\\": \\"test asset\\",\\n \\"Componentname\\": \\"pyhton3\\",\\n \\"Params\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"authMethod\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ak\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"accessKeyId\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"xxxxxxx\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"accessKeySecret\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"xxxxx\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"roleArn\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"\\\\\\"\\\\n }\\\\n]\\",\\n \\"AssetUuid\\": \\"ff6fe161-93e2-464c-a326-fxxxxxx\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeComponentAssets', - ], - 'DescribeComponentList' => [ - 'summary' => 'Queries a list of common components that are available.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssets'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeComponentAssets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeComponentList' => [ + 'summary' => 'Retrieves a list of standard components that you can use.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1373,118 +925,110 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to get this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<String>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B0A255B3-495C-56FB-8B6B-DB073F80388A', - ], - 'Components' => [ - 'title' => '传输的数据', - 'description' => 'The information about the components. The value is a JSON array.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "actions": ['."\n" - .' {'."\n" - .' "description": "mysql component",'."\n" - .' "name": "storeIdb",'."\n" - .' "parameters": ['."\n" - .' {'."\n" - .' "description": "update the mysql db",'."\n" - .' "name": "updateSql",'."\n" - .' "required": false'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ],'."\n" - .' "basic": {'."\n" - .' "description": "mysq sql component for 5.6",'."\n" - .' "logo": "https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg",'."\n" - .' "name": "Mysql"'."\n" - .' }'."\n" - .' }'."\n" - .']', - ], + 'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'B0A255B3-495C-56FB-8B6B-DB073F80388A'], + 'Components' => ['description' => 'The component information. The value is a string in the format of a JSON array.', 'type' => 'string', 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "actions": ['."\n" + .' {'."\n" + .' "description": "mysql component",'."\n" + .' "name": "storeIdb",'."\n" + .' "parameters": ['."\n" + .' {'."\n" + .' "description": "update the mysql db",'."\n" + .' "name": "updateSql",'."\n" + .' "required": false'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ],'."\n" + .' "basic": {'."\n" + .' "description": "mysq sql component for 5.6",'."\n" + .' "logo": "https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg",'."\n" + .' "name": "Mysql"'."\n" + .' }'."\n" + .' }'."\n" + .']'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B0A255B3-495C-56FB-8B6B-DB073F80388A\\",\\n \\"Components\\": \\"[\\\\n {\\\\n \\\\\\"actions\\\\\\": [\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"mysql component\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"storeIdb\\\\\\",\\\\n \\\\\\"parameters\\\\\\": [\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"update the mysql db\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"updateSql\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n ]\\\\n }\\\\n ],\\\\n \\\\\\"basic\\\\\\": {\\\\n \\\\\\"description\\\\\\": \\\\\\"mysq sql component for 5.6\\\\\\",\\\\n \\\\\\"logo\\\\\\": \\\\\\"https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Mysql\\\\\\"\\\\n }\\\\n }\\\\n]\\"\\n}","type":"json"}]', 'title' => 'DescribeComponentList', - 'responseParamsDescription' => 'The value of **Components** is a JSON string, which contains the following fields:'."\n" + 'responseParamsDescription' => 'The **Components** parameter is in JSON format and includes the following fields:'."\n" + ."\n" + .'- **actions**: The executable actions of the component. This parameter is a JSON array that contains the following fields:'."\n" ."\n" - .'* **actions**: the actions that are supported by the component. The value is a JSON array and contains the following fields:'."\n" + .' - **description**: The description of the action.'."\n" ."\n" - .' * **description**: the description of the action.'."\n" + .' - **name**: The name of the action.'."\n" ."\n" - .' * **name**: the name of the action.'."\n" + .' - **parameters**: The input parameters for the action. This parameter is a JSON object that contains the following fields:'."\n" ."\n" - .' * **parameters**: the input parameters of the action. The value is a JSON object and contains the following fields:'."\n" + .' - **description**: The description of the input parameter.'."\n" ."\n" - .' * **description**: the description of the input parameter.'."\n" - .' * **name**: the name of the input parameter.'."\n" - .' * **required**: specifies whether the input parameter is required. Valid values are true and false.'."\n" + .' - **name**: The name of the input parameter.'."\n" ."\n" - .'* **basic**: the basic information of the component. The value contains the following fields:'."\n" + .' - **required**: Specifies whether the input parameter is required. A value of true indicates that the parameter is required. A value of false indicates that the parameter is optional.'."\n" ."\n" - .'* **description**: the description of the component.'."\n" + .'- **basic**: The basic information about the component. This parameter contains the following fields:'."\n" ."\n" - .'* **logo**: the address information of the component logo.'."\n" + .'- **description**: The description of the component.'."\n" ."\n" - .'* **name**: the name of the component.'."\n", + .'- **logo**: The URL of the component logo.'."\n" + ."\n" + .'- **name**: The name of the component.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeComponentList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], + ], ], 'DescribeComponentPlaybook' => [ - 'summary' => 'Queries a list of predefined components that are available.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves a list of predefined components.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1496,121 +1040,103 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ac343acc-1a61-4084-9a1cxxxxx', - ], + 'schema' => ['description' => 'The UUID of the component playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1cxxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<List<PlaybookCloudDTO>>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C5F5D6C9-DF1A-5381-92B1-39676F777D20', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C5F5D6C9-DF1A-5381-92B1-39676F777D20', 'title' => ''], 'Playbooks' => [ - 'title' => '传输的数据。', - 'description' => 'The information about the predefined components.'."\n", + 'title' => '', + 'description' => 'The list of component playbooks.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The information about the component playbook.', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'title' => '剧本的名称。', - 'description' => 'The name of the predefined component.'."\n", - 'type' => 'string', - 'example' => 'AegisKillQuara', - ], - 'InputParams' => [ - 'title' => '剧本的入参。', - 'description' => 'The input parameter configuration of the playbook. The value is a JSON array.'."\n" - ."\n" - .'> For more information, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "typeName": "String",'."\n" - .' "dataClass": "normal",'."\n" - .' "dataType": "String",'."\n" - .' "description": "period",'."\n" - .' "example": "",'."\n" - .' "name": "period",'."\n" - .' "required": false'."\n" - .' }'."\n" - .']', - ], - 'Description' => [ - 'title' => '剧本描述。', - 'description' => 'The description of the predefined component.'."\n", - 'type' => 'string', - 'example' => 'aegis_kill_process', - ], - 'ParamType' => [ - 'title' => '剧本的入参类型。'."\n" - ."\n" - .'template-ip：IP请求模板。'."\n" - .'template-file：文件请求模板。'."\n" - .'template-process：进程请求模板。'."\n" - .'custom：自定义参数。', - 'type' => 'string', - 'example' => 'template-alert', - ], + 'DisplayName' => ['description' => 'The name of the component playbook.', 'type' => 'string', 'example' => 'AegisKillQuara', 'title' => ''], + 'InputParams' => ['description' => 'The input parameter configurations of the component playbook. The value is a JSON array.'."\n" + ."\n" + .'> For more information about the format, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']', 'title' => ''], + 'Description' => ['description' => 'The description of the component playbook.', 'type' => 'string', 'example' => 'aegis_kill_process', 'title' => ''], + 'ParamType' => ['description' => 'The input parameter type of the component playbook.'."\n" + ."\n" + .'template-ip: IP request template.'."\n" + .'template-file: file request template.'."\n" + .'template-process: process request template.'."\n" + .'custom: custom parameters.', 'type' => 'string', 'example' => 'template-alert', 'title' => ''], ], - 'title' => '预定义剧本信息。', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5F5D6C9-DF1A-5381-92B1-39676F777D20\\",\\n \\"Playbooks\\": [\\n {\\n \\"DisplayName\\": \\"AegisKillQuara\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"Description\\": \\"aegis_kill_process\\",\\n \\"ParamType\\": \\"template-alert\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeComponentPlaybook', - ], - 'DescribeComponentsJs' => [ - 'summary' => 'Queries the JavaScript file of a component. The component uses the returned JavaScript file for page rendering.', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2025-10-09T09:35:06.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPlaybook'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeComponentPlaybook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], + ], + 'DescribeComponentsJs' => [ + 'summary' => 'Obtains the JavaScript (JS) file that a component uses to render the page.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1618,72 +1144,72 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<String>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073', - ], - 'ComponentsJs' => [ - 'title' => '传输的数据', - 'description' => 'The configuration of the JavaScript file for the component.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "js": "https://xxxxx.oss-cn-zhangjiakou.aliyuncs.com/componentUpload/xxxxx",'."\n" - .' "name": "python3",'."\n" - .' "ownType": "sys"'."\n" - .' }'."\n" - .']', - ], + 'RequestId' => ['description' => 'The request ID. This is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073'], + 'ComponentsJs' => ['description' => 'The configuration information of the component\'s JS file.', 'type' => 'string', 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "js": "https://xxxxx.oss-cn-zhangjiakou.aliyuncs.com/componentUpload/xxxxx",'."\n" + .' "name": "python3",'."\n" + .' "ownType": "sys"'."\n" + .' }'."\n" + .']'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\",\\n \\"ComponentsJs\\": \\"[\\\\n {\\\\n \\\\\\"js\\\\\\": \\\\\\"https://xxxxx.oss-cn-zhangjiakou.aliyuncs.com/componentUpload/xxxxx\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"python3\\\\\\",\\\\n \\\\\\"ownType\\\\\\": \\\\\\"sys\\\\\\"\\\\n }\\\\n]\\"\\n}","type":"json"}]', 'title' => 'DescribeComponentsJs', - 'responseParamsDescription' => 'The value of the **ComponentsJs** parameter is a JSON array, which contains the following fields:'."\n" + 'responseParamsDescription' => 'The **ComponentsJs** parameter is in the JSONArray format and contains the following fields:'."\n" + ."\n" + .'- **js**: The URL of the JS file.'."\n" + ."\n" + .'- **name**: The name of the component.'."\n" ."\n" - .'* **js**: the URL of the JavaScript file.'."\n" - .'* **name**: the name of the component.'."\n" - .'* **ownType**: the type of component. The value is fixed as **sys**. Components of other types are unavailable.'."\n", + .'- **ownType**: The type of the component. The value is fixed to **sys**. Other component types are not supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentsJs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeComponentsJs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'DescribeDistinctReleases' => [ - 'summary' => 'Queries the information about the published versions of a playbook after deduplication.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Retrieves a list of distinct playbook releases.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1696,111 +1222,92 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '172028', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The playbook UUID.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'bc0b8424-535c-4ed5-bd94-xxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'bc0b8424-535c-4ed5-bd94-xxxxxx'], ], [ 'name' => 'TaskflowMd5', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The MD5 value of the playbook XML configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'be0a4ef084dd174abe47xxxxx', - ], + 'schema' => ['description' => 'The MD5 value of the playbook\'s XML configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'be0a4ef084dd174abe47xxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<List<SaoReleaseInfo>>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '145CACF6-D276-5197-8549-CB1AD76E2AC8', - ], + 'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request and is used to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '145CACF6-D276-5197-8549-CB1AD76E2AC8'], 'Records' => [ - 'title' => '传输的数据', - 'description' => 'The information about versions.'."\n", + 'title' => '', + 'description' => 'The version records.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the version.'."\n", + 'description' => 'The version information.', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => '描述信息', - 'description' => 'The version description.'."\n", - 'type' => 'string', - 'example' => 'demo version', - ], - 'TaskflowMd5' => [ - 'title' => 'taskflow的MD5信息，用于比较是否 有变化', - 'description' => 'The MD5 value of the version XML configuration.'."\n", - 'type' => 'string', - 'example' => '17cf53049bc8efa941207xxxxx', - ], - 'TaskflowType' => [ - 'description' => 'The format of the playbook. Valid values:'."\n" - ."\n" - .'* **xml**: XML format.'."\n" - .'* **x6**: JSON format.'."\n", - 'type' => 'string', - 'example' => 'x6', - ], + 'Description' => ['description' => 'The description of the version.', 'type' => 'string', 'title' => '', 'example' => 'demo version'], + 'TaskflowMd5' => ['description' => 'The MD5 value of the version\'s XML configuration.', 'type' => 'string', 'title' => '', 'example' => '17cf53049bc8efa941207xxxxx'], + 'TaskflowType' => ['description' => 'The configuration format of the playbook.'."\n" + ."\n" + .'- **xml**: XML format.'."\n" + ."\n" + .'- **x6**: JSON format.', 'type' => 'string', 'example' => 'x6', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"145CACF6-D276-5197-8549-CB1AD76E2AC8\\",\\n \\"Records\\": [\\n {\\n \\"Description\\": \\"demo version\\",\\n \\"TaskflowMd5\\": \\"17cf53049bc8efa941207xxxxx\\",\\n \\"TaskflowType\\": \\"x6\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeDistinctReleases', - ], - 'DescribeEnumItems' => [ - 'summary' => 'Queries enumeration items that are required by a cloud service.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistinctReleases'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeDistinctReleases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], + ], + 'DescribeEnumItems' => [ + 'summary' => 'Queries the enumeration information for a product.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1808,92 +1315,81 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'EnumType', 'in' => 'query', - 'schema' => [ - 'title' => '枚举类型', - 'description' => 'The type of the enumeration item. Valid values:'."\n" - ."\n" - .'* **process**: scenarios'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'process', - ], + 'schema' => ['description' => 'The type of the enumeration. Valid value:'."\n" + ."\n" + .'- **process**: The enumeration for response scenarios.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'process'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh_cn**: Simplified Chinese (default)'."\n" - .'* **en_us**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh\\_cn**: The default value. Simplified Chinese.'."\n" + ."\n" + .'- **en\\_us**: American English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<List<EnumDTO>>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94', - ], + 'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'], 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The information about the enumeration item.'."\n", + 'title' => '', + 'description' => 'The enumeration information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The key-value pair of the enumeration.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the enumeration item.'."\n", - 'type' => 'string', - 'example' => 'system_xxxxx_process_book', - ], - 'Value' => [ - 'description' => 'The value of the enumeration item.'."\n", - 'type' => 'string', - 'example' => 'system_xxxxx_process_book', - ], + 'Key' => ['description' => 'The key of the enumeration.', 'type' => 'string', 'example' => 'system_xxxxx_process_book', 'title' => ''], + 'Value' => ['description' => 'The value of the enumeration.', 'type' => 'string', 'example' => 'system_xxxxx_process_book', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"system_xxxxx_process_book\\",\\n \\"Value\\": \\"system_xxxxx_process_book\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeEnumItems', - ], - 'DescribeExecutePlaybooks' => [ - 'summary' => 'Queries the playbooks that are available for an automatic response plan.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnumItems'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeEnumItems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeExecutePlaybooks' => [ + 'summary' => 'Queries a list of executable playbooks that are used to configure automated response plans.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1906,163 +1402,206 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '172464', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'InputMode', 'in' => 'query', - 'schema' => [ - 'title' => '入参类型筛选', - 'description' => 'The entity type of the script input parameter. When you want to query multiple entity types, separate them with commas.'."\n" - .'- **ip**: IP entity.'."\n" - .'- **file**: file entity.'."\n" - .'- **process**: process entity.'."\n" - .'- **incident**: incident entity.', - 'type' => 'string', - 'required' => false, - 'example' => 'ip,file,process,host', - ], + 'schema' => ['title' => '入参类型筛选', 'description' => 'The entity type of the input parameter for the playbook. To query multiple entity types, separate them with commas.'."\n" + ."\n" + .'- **ip**: IP entity.'."\n" + ."\n" + .'- **file**: file entity.'."\n" + ."\n" + .'- **process**: process entity.'."\n" + ."\n" + .'- **incident**: event entity.', 'type' => 'string', 'required' => false, 'example' => 'ip,file,process,host'], ], [ 'name' => 'PlaybookName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的名字', - 'description' => 'The playbook name. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'demo_test', - ], + 'schema' => ['description' => 'The name of the playbook. Fuzzy search is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo_test'], ], [ 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的UUID', - 'description' => 'The playbook UUID.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'f916b93e-e814-459f-9662-xxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'ParamType', 'in' => 'query', - 'schema' => [ - 'description' => 'The input parameter type of the playbook.'."\n" - ."\n" - .'* **template-ip**'."\n" - .'* **template-file**'."\n" - .'* **template-process**'."\n" - .'* **custom**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - ], + 'schema' => ['description' => 'The type of the input parameter for the playbook.'."\n" + ."\n" + .'- **template-ip**: IP request template.'."\n" + ."\n" + .'- **template-file**: file request template.'."\n" + ."\n" + .'- **template-process**: process request template.'."\n" + ."\n" + .'- **custom**: custom parameter.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<List<PlaybookExecuteMetrics>>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '88A39217-2802-5B1E-BA2B-CF1BBC43C1F5', - ], + 'RequestId' => ['description' => 'The ID of the request. This ID is unique to the request and is generated by Alibaba Cloud. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '88A39217-2802-5B1E-BA2B-CF1BBC43C1F5'], 'PlaybookMetrics' => [ - 'title' => '传输的数据', - 'description' => 'The playbook.'."\n", + 'title' => '', + 'description' => 'The list of playbooks.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Summary information about the playbook.', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'The playbook description.'."\n", - 'type' => 'string', - 'example' => 'a demo playbook', - ], - 'DisplayName' => [ - 'description' => 'The playbook name.'."\n", - 'type' => 'string', - 'example' => 'demo_playbook', - ], - 'Uuid' => [ - 'description' => 'The playbook UUID.'."\n", - 'type' => 'string', - 'example' => 'c5c88b5e-97ca-435d-8c20-2xxxxx', - ], - 'ParamConfig' => [ - 'description' => 'The configuration of the input parameter. The value is a JSON array.'."\n" - ."\n" - .'> For more information, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "typeName": "String",'."\n" - .' "dataClass": "normal",'."\n" - .' "dataType": "String",'."\n" - .' "description": "period",'."\n" - .' "example": "",'."\n" - .' "name": "period",'."\n" - .' "required": false'."\n" - .' }'."\n" - .']', - ], - 'ParamType' => [ - 'description' => 'The input parameter type of the playbook.'."\n" - ."\n" - .'* **template-ip**'."\n" - .'* **template-file**'."\n" - .'* **template-process**'."\n" - .'* **custom**'."\n", - 'type' => 'string', - 'example' => 'custom', - ], + 'Description' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'a demo playbook', 'title' => ''], + 'DisplayName' => ['description' => 'The name of the playbook.', 'type' => 'string', 'example' => 'demo_playbook', 'title' => ''], + 'Uuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => 'c5c88b5e-97ca-435d-8c20-2xxxxx', 'title' => ''], + 'ParamConfig' => ['description' => 'The configuration of the input parameters for the playbook. The value is in the JSONArray format.'."\n" + ."\n" + .'> For more information about the format, see the [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~) operation.', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']', 'title' => ''], + 'ParamType' => ['description' => 'The type of the input parameter for the playbook.'."\n" + ."\n" + .'- **template-ip**: IP request template.'."\n" + ."\n" + .'- **template-file**: file request template.'."\n" + ."\n" + .'- **template-process**: process request template.'."\n" + ."\n" + .'- **custom**: custom parameter.', 'type' => 'string', 'example' => 'custom', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88A39217-2802-5B1E-BA2B-CF1BBC43C1F5\\",\\n \\"PlaybookMetrics\\": [\\n {\\n \\"Description\\": \\"a demo playbook\\",\\n \\"DisplayName\\": \\"demo_playbook\\",\\n \\"Uuid\\": \\"c5c88b5e-97ca-435d-8c20-2xxxxx\\",\\n \\"ParamConfig\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"ParamType\\": \\"custom\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeExecutePlaybooks', + 'changeSet' => [ + ['createdAt' => '2024-03-19T03:26:12.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExecutePlaybooks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeExecutePlaybooks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'DescribeField' => [ - 'summary' => 'Queries the global configuration information about a cloud service.', - 'methods' => [ - 'get', + 'summary' => 'Retrieves global configuration information for the product.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'QueryKey', + 'in' => 'query', + 'schema' => ['description' => 'The key of the global configuration. Valid value:'."\n" + ."\n" + .'- **soar\\_filed\\_tags**: Obtains the input field template for a playbook.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'soar_filed_tags'], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the request and response messages. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<SystemConfigView>', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'BCDE6498-83CC-50A1-8307-3D5A539C42F8'], + 'Name' => ['description' => 'The name of the global configuration.', 'type' => 'string', 'example' => 'soar_filed_tags', 'title' => ''], + 'Fields' => ['description' => 'The content of the configuration.', 'type' => 'string', 'example' => '["ip","name","hostinfo","md5"]', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCDE6498-83CC-50A1-8307-3D5A539C42F8\\",\\n \\"Name\\": \\"soar_filed_tags\\",\\n \\"Fields\\": \\"[\\\\\\"ip\\\\\\",\\\\\\"name\\\\\\",\\\\\\"hostinfo\\\\\\",\\\\\\"md5\\\\\\"]\\"\\n}","type":"json"}]', + 'title' => 'DescribeField', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeField'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeField', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeGroupProductions' => [ + 'summary' => 'Queries groups of Alibaba Cloud services.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2074,76 +1613,143 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '203522', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ - 'name' => 'QueryKey', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'title' => '全局配置的KEY值', - 'description' => 'The key of the global configuration. Valid values:'."\n" - ."\n" - .'* **soar_filed_tags**: queries the input template of the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'soar_filed_tags', - ], + 'schema' => ['description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default)'."\n" + .'* **en**'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'RoleType', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The type of the view. Valid values:'."\n" + ."\n" + .'* **0** (default): the view of the current Alibaba Cloud account.'."\n" + .'* **1**: the view of all accounts for the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11824150xxx50980', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<SystemConfigView>', - 'description' => 'The response parameters.'."\n", + 'title' => 'SophonResult<List<ProductionGroup>>', + 'description' => 'SophonResult\\<List>'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BCDE6498-83CC-50A1-8307-3D5A539C42F8', - ], - 'Name' => [ - 'description' => 'The name of the global configuration.'."\n", - 'type' => 'string', - 'example' => 'soar_filed_tags', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '358E012F-B516-599D-9Exxx-A1A361CDE615'], + 'Data' => [ + 'title' => '', + 'description' => 'The information about the groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the group.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the cloud service.'."\n", 'type' => 'string', 'example' => 'Database', 'title' => ''], + 'Productions' => [ + 'description' => 'The information about the cloud services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the cloud service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The code of the cloud service.'."\n", 'type' => 'string', 'example' => 'Rds', 'title' => ''], + 'Name' => ['description' => 'The name of the cloud service.'."\n", 'type' => 'string', 'example' => 'ApsaraDB RDS', 'title' => ''], + 'ShortName' => ['description' => 'The short name of the cloud service.'."\n", 'type' => 'string', 'example' => 'RDS', 'title' => ''], + 'Description' => ['description' => 'The description of the cloud service.'."\n", 'type' => 'string', 'example' => 'ApsaraDB', 'title' => ''], + 'Group' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'example' => 'ApsaraDB', 'title' => ''], + 'Versions' => [ + 'description' => 'The API versions.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The API version.'."\n", 'type' => 'string', 'example' => '2014-08-15', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DefaultVersion' => ['description' => 'The default version.'."\n", 'type' => 'string', 'example' => '2014-08-15', 'title' => ''], + 'DefaultDomain' => ['description' => 'The default requested domain name.'."\n", 'type' => 'string', 'example' => 'rds.aliyuncs.com', 'title' => ''], + 'FullDomains' => [ + 'description' => 'The requested domain names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The requested domain name.'."\n", 'type' => 'string', 'example' => 'rds.aliyuncs.com', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RamCode' => ['description' => 'The Resource Access Management (RAM) code of the POP to which the resource belongs.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'Source' => ['description' => 'The information source of the cloud service.'."\n", 'type' => 'string', 'example' => 'next', 'title' => ''], + 'PolicyList' => [ + 'title' => '', + 'description' => 'The RAM policies of the cloud service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The RAM policy of the cloud service.'."\n", + 'type' => 'object', + 'properties' => [ + 'PolicyName' => ['title' => '', 'description' => 'The name of the RAM policy.'."\n", 'type' => 'string', 'example' => 'AliyunRAMReadOnlyAccess'], + 'Type' => ['title' => '', 'description' => 'The type of the RAM policy. Valid values:'."\n" + ."\n" + .'* **All**: permissions.'."\n" + .'* **Read-only**: permissions.', 'type' => 'string', 'example' => 'Read-only permission'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'Fields' => [ - 'description' => 'The configuration content.'."\n", - 'type' => 'string', - 'example' => '["ip","name","hostinfo","md5"]', + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9Exxx-A1A361CDE615\\",\\n \\"Data\\": [\\n {\\n \\"GroupName\\": \\"Database\\",\\n \\"Productions\\": [\\n {\\n \\"Code\\": \\"Rds\\",\\n \\"Name\\": \\"ApsaraDB RDS\\",\\n \\"ShortName\\": \\"RDS\\",\\n \\"Description\\": \\"ApsaraDB\\",\\n \\"Group\\": \\"ApsaraDB\\",\\n \\"Versions\\": [\\n \\"2014-08-15\\"\\n ],\\n \\"DefaultVersion\\": \\"2014-08-15\\",\\n \\"DefaultDomain\\": \\"rds.aliyuncs.com\\",\\n \\"FullDomains\\": [\\n \\"rds.aliyuncs.com\\"\\n ],\\n \\"RamCode\\": \\"rds\\",\\n \\"Source\\": \\"next\\",\\n \\"PolicyList\\": [\\n {\\n \\"PolicyName\\": \\"AliyunRAMReadOnlyAccess\\",\\n \\"Type\\": \\"Read-only permission\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'DescribeGroupProductions', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupProductions'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCDE6498-83CC-50A1-8307-3D5A539C42F8\\",\\n \\"Name\\": \\"soar_filed_tags\\",\\n \\"Fields\\": \\"[\\\\\\"ip\\\\\\",\\\\\\"name\\\\\\",\\\\\\"hostinfo\\\\\\",\\\\\\"md5\\\\\\"]\\"\\n}","type":"json"}]', - 'title' => 'DescribeField', + 'ramActions' => [], ], 'DescribeLatestRecordSchema' => [ - 'summary' => 'Queries the output structure information of each node in a playbook based on the most recent running record of the playbook.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Describes the output structure of each node in a playbook based on the latest execution record.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2155,110 +1761,98 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<PlaybookNodeSchema>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9'], 'PlaybookNodeSchema' => [ - 'title' => '传输的数据', - 'description' => 'The output structure information of the playbook.'."\n", + 'title' => '', + 'description' => 'The output structure of the playbook.', 'type' => 'object', 'properties' => [ 'NodeSchema' => [ - 'description' => 'The structure information.'."\n", + 'description' => 'The structure information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The structure information.', 'type' => 'object', 'properties' => [ - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'DataFormat_1', - ], - 'ComponentName' => [ - 'description' => 'The name of the component.'."\n", - 'type' => 'string', - 'example' => 'DataFormat', - ], - 'ActionName' => [ - 'description' => 'The action name of the component.'."\n", - 'type' => 'string', - 'example' => 'formatedata', - ], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''], + 'ComponentName' => ['description' => 'The name of the component.', 'type' => 'string', 'example' => 'DataFormat', 'title' => ''], + 'ActionName' => ['description' => 'The action name of the component.', 'type' => 'string', 'example' => 'formatedata', 'title' => ''], 'OutputFields' => [ - 'description' => 'The output fields.'."\n", + 'description' => 'The output fields.', 'type' => 'array', - 'items' => [ - 'description' => 'The reference path of the output field.'."\n", - 'type' => 'string', - 'example' => 'play_group.datalist.*.ids', - ], + 'items' => ['description' => 'The reference path of the output field.', 'type' => 'string', 'example' => 'play_group.datalist.*.ids', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\",\\n \\"PlaybookNodeSchema\\": {\\n \\"NodeSchema\\": [\\n {\\n \\"NodeName\\": \\"DataFormat_1\\",\\n \\"ComponentName\\": \\"DataFormat\\",\\n \\"ActionName\\": \\"formatedata\\",\\n \\"OutputFields\\": [\\n \\"play_group.datalist.*.ids\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'DescribeLatestRecordSchema', - ], - 'DescribeNodeParamTags' => [ - 'summary' => 'Queries recommended dynamic input parameters of a component for playbook orchestration.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLatestRecordSchema'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeLatestRecordSchema', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], + ], + 'DescribeNodeParamTags' => [ + 'summary' => 'Returns the reference paths for component inputs in a playbook orchestration.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2266,106 +1860,172 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The playbook UUID.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx'], ], [ 'name' => 'NodeName', 'in' => 'query', - 'schema' => [ - 'title' => '组件节点名', - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'python3_2', - ], + 'schema' => ['description' => 'The name of the component node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3_2'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response.'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<List<ParamReferredPathsInfo>>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6BE94351-712A-505D-A40A-BC77CC8254A9', - ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '6BE94351-712A-505D-A40A-BC77CC8254A9'], 'ParamReferredPaths' => [ - 'title' => '传输的数据', - 'description' => 'The configuration of the recommended path.'."\n", + 'title' => '', + 'description' => 'The recommended path configurations.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The path information.', 'type' => 'object', 'properties' => [ - 'ParamName' => [ - 'description' => 'The name of the upstream node.'."\n", - 'type' => 'string', - 'example' => 'DataFormat_1', - ], + 'ParamName' => ['description' => 'The name of the ancestor node.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''], 'ReferredPath' => [ - 'description' => 'The paths.'."\n", + 'description' => 'An array of paths.', 'type' => 'array', - 'items' => [ - 'description' => 'The configuration of the referenced path.'."\n", - 'type' => 'string', - 'example' => 'filter_1.datalist.*.score', - ], + 'items' => ['description' => 'The reference path configuration.', 'type' => 'string', 'example' => 'filter_1.datalist.*.score', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BE94351-712A-505D-A40A-BC77CC8254A9\\",\\n \\"ParamReferredPaths\\": [\\n {\\n \\"ParamName\\": \\"DataFormat_1\\",\\n \\"ReferredPath\\": [\\n \\"filter_1.datalist.*.score\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeNodeParamTags', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeParamTags'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeNodeParamTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], + ], ], - 'DescribePlaybook' => [ - 'summary' => 'Queries the XML configuration of a playbook.', - 'methods' => [ - 'get', + 'DescribeNodeUsedInfos' => [ + 'summary' => 'Queries the nodes that reference a specific node in a playbook.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxx'], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the component node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3_2'], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the request and the response. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID to help you troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '3B10F836-C2B1-54FA-AB59-7591B548FB59'], + 'NodeUsedInfos' => ['description' => 'The reference information for the node. This is returned in a JSON string and includes the following fields:'."\n" + ."\n" + .'- **action**: The referenced action. It contains the following information:'."\n" + ."\n" + .' - **name**: The name of the referenced node.'."\n" + ."\n" + .' - **inputParams**: The referenced parameter settings.', 'type' => 'string', 'title' => '', 'example' => '{'."\n" + .' "action": ['."\n" + .' {'."\n" + .' "name": "query_books",'."\n" + .' "inputParams": ['."\n" + .' {'."\n" + .' "referInfos": ['."\n" + .' "${play_group.datalist.*.ids}"'."\n" + .' ],'."\n" + .' "name": "querySql"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3B10F836-C2B1-54FA-AB59-7591B548FB59\\",\\n \\"NodeUsedInfos\\": \\"{\\\\n \\\\\\"action\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"query_books\\\\\\",\\\\n \\\\\\"inputParams\\\\\\": [\\\\n {\\\\n \\\\\\"referInfos\\\\\\": [\\\\n \\\\\\"${play_group.datalist.*.ids}\\\\\\"\\\\n ],\\\\n \\\\\\"name\\\\\\": \\\\\\"querySql\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribeNodeUsedInfos', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeUsedInfos'], + ], + ], + 'ramActions' => [], + ], + 'DescribeNotifyTemplateList' => [ + 'summary' => 'Queries notification templates.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2377,193 +2037,447 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeCode' => '225868', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ - 'name' => 'PlaybookUuid', + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese.'."\n" + .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'RoleType', 'in' => 'query', + 'schema' => ['description' => 'The type of the view. Default value: 0. Valid values:'."\n" + ."\n" + .'* 0: the view of the current Alibaba Cloud account.'."\n" + .'* 1: the view of all accounts for the enterprise.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602425xxx8726', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9030076b-6733-4842-b05a-xxxxx', + 'title' => 'SophonResult<List<NotifyTemplateDTO>>', + 'description' => 'SophonResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573'], + 'Data' => [ + 'title' => '', + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateName' => ['title' => '', 'description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => 'incident generate'], + 'EventId' => ['title' => '', 'description' => 'The ID of the message event corresponding to the template.'."\n", 'type' => 'string', 'example' => 'yundun_soar_incident_generate'], + 'Subject' => ['title' => '', 'description' => 'The title of the template.'."\n", 'type' => 'string', 'example' => '[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)'], + 'Content' => ['title' => '', 'description' => 'The body of the template.'."\n", 'type' => 'string', 'example' => 'Dear $aliyunUID : Cloud Security Center Threat Analysis and Response has detected a newly discovered security incident $incidentName(Incident id :$incidentID) in $startTime, Please go to Cloud Security Center Console View.'], + 'Params' => ['title' => '', 'description' => 'The parameters of the template.'."\n", 'type' => 'string', 'example' => '[\\"aliyunUID\\",\\"incidentName\\",\\"incidentID\\",\\"startTime\\"]'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3FED5B9-190A-5952-93A4-24FBF0F0C573\\",\\n \\"Data\\": [\\n {\\n \\"TemplateName\\": \\"incident generate\\",\\n \\"EventId\\": \\"yundun_soar_incident_generate\\",\\n \\"Subject\\": \\"[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)\\",\\n \\"Content\\": \\"Dear $aliyunUID : Cloud Security Center Threat Analysis and Response has detected a newly discovered security incident $incidentName(Incident id :$incidentID) in $startTime, Please go to Cloud Security Center Console View.\\",\\n \\"Params\\": \\"[\\\\\\\\\\\\\\"aliyunUID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"incidentName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"incidentID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\"]\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'DescribeNotifyTemplateList', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeNotifyTemplateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNotifyTemplateList'], + ], + ], + ], + 'DescribeOpenApiInfo' => [ + 'summary' => 'Queries the details of an API operation.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203523', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + ], + 'parameters' => [ + [ + 'name' => 'PopCode', + 'in' => 'query', + 'schema' => ['description' => 'The POP code of the Alibaba Cloud service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Sas', 'title' => ''], + ], + [ + 'name' => 'ApiVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version number of the API.'."\n" + ."\n" + .'> You can call the [DescribeGroupProductions](~~DescribeGroupProductions~~) operation to query version numbers.'."\n", 'type' => 'string', 'required' => true, 'example' => '2018-12-03', 'title' => ''], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => ['description' => 'The operation that you want to perform.'."\n", 'type' => 'string', 'required' => true, 'example' => 'DescribePopApiItemList', 'title' => ''], + ], [ 'name' => 'Lang', 'in' => 'query', + 'schema' => ['description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese.'."\n" + .'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the view. Valid values:'."\n" + ."\n" + .'* 0 (default): the view of the current Alibaba Cloud account.'."\n" + .'* 1: the view of all accounts for the enterprise.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1592757xxx002956', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'title' => 'SophonResult<APIDetailVO>', + 'description' => 'SophonResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615'], + 'Data' => [ + 'title' => '', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OutputParams' => ['description' => 'The output parameters of the API operation.'."\n", 'type' => 'string', 'example' => '[]', 'title' => ''], + 'InputParams' => ['description' => 'The input parameters of the API operation.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'ResponseDemo' => ['description' => 'The sample response parameters.'."\n", 'type' => 'string', 'example' => '[]', 'title' => ''], + 'Title' => ['description' => 'The title of the API operation.'."\n", 'type' => 'string', 'example' => 'describeEcs', 'title' => ''], + 'Summary' => ['description' => 'The summary of the API operation.'."\n", 'type' => 'string', 'example' => 'describeEcs', 'title' => ''], + 'Description' => ['description' => 'The description of the API operation.'."\n", 'type' => 'string', 'example' => 'describeEcs', 'title' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9ED0-A1A361CDE615\\",\\n \\"Data\\": {\\n \\"OutputParams\\": \\"[]\\",\\n \\"InputParams\\": \\"{}\\",\\n \\"ResponseDemo\\": \\"[]\\",\\n \\"Title\\": \\"describeEcs\\",\\n \\"Summary\\": \\"describeEcs\\",\\n \\"Description\\": \\"describeEcs\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeOpenApiInfo', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeOpenApiInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiInfo'], + ], + ], + ], + 'DescribeOpenApiList' => [ + 'summary' => 'Retrieve the API list for a product.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TaskflowMd5', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203524', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + ], + 'parameters' => [ + [ + 'name' => 'PopCode', + 'in' => 'query', + 'schema' => ['description' => 'The POP CODE of the Alibaba Cloud product API.', 'type' => 'string', 'required' => true, 'example' => 'Sas', 'title' => ''], + ], + [ + 'name' => 'ApiVersion', + 'in' => 'query', + 'schema' => ['description' => 'The API version number.'."\n" + ."\n" + .'> Call the [DescribeGroupProductions](~~DescribeGroupProductions~~) API to get this parameter.', 'type' => 'string', 'required' => true, 'example' => '2021-10-01', 'title' => ''], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => ['description' => 'The API name.', 'type' => 'string', 'required' => false, 'example' => 'DescribePopApiItemList', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language type for requests and responses. The default value is **zh**. Values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => ['description' => 'The view type. The default is 0. Values:'."\n" + ."\n" + .'- 0: Current Alibaba Cloud account view.'."\n" + ."\n" + .'- 1: View of all accounts under the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'RoleFor', 'in' => 'query', + 'schema' => ['description' => 'The user ID of the member whose perspective the administrator switches to.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602xxx8718726', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The MD5 hash value of the playbook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7a8f608dc64c242632aa578xxxxx', + 'title' => 'SophonResult<APITreeBO>', + 'description' => 'SophonResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of this request, a unique identifier generated by Alibaba Cloud for this request, used for troubleshooting and locating issues.', 'type' => 'string', 'title' => '', 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2'], + 'Data' => [ + 'title' => '', + 'description' => 'Returned result data.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code. Values:'."\n" + ."\n" + .'- 200: Success'."\n" + ."\n" + .'- 500: Failed', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Version' => ['description' => 'The API version number.', 'type' => 'string', 'example' => '2018-12-03', 'title' => ''], + 'Directories' => ['description' => 'The returned API list content.', 'type' => 'any', 'example' => '[{"apis":[{"summary":"get account information","deprecated":false,"name":"DescAccountSummary","title":"get account information"}],"childrens":[],"title":"account"}]', 'title' => ''], + 'Versions' => ['description' => 'List of supported versions.', 'type' => 'any', 'title' => '', 'example' => '["2018-12-03" ]'], + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2\\",\\n \\"Data\\": {\\n \\"Code\\": \\"200\\",\\n \\"Version\\": \\"2018-12-03\\",\\n \\"Directories\\": \\"[{\\\\\\"apis\\\\\\":[{\\\\\\"summary\\\\\\":\\\\\\"get account information\\\\\\",\\\\\\"deprecated\\\\\\":false,\\\\\\"name\\\\\\":\\\\\\"DescAccountSummary\\\\\\",\\\\\\"title\\\\\\":\\\\\\"get account information\\\\\\"}],\\\\\\"childrens\\\\\\":[],\\\\\\"title\\\\\\":\\\\\\"account\\\\\\"}]\\",\\n \\"Versions\\": \\"[\\\\\\"2018-12-03\\\\\\" ]\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeOpenApiList', + 'description' => 'Before you use this API, review the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for the orchestration product, which supports threat analysis, response, log access, and traffic monitoring.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeOpenApiList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribePlaybook' => [ + 'summary' => 'Retrieves the XML configuration of a playbook.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '9030076b-6733-4842-b05a-xxxxx'], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'TaskflowMd5', + 'in' => 'query', + 'schema' => ['description' => 'The MD5 value of the playbook configuration.', 'type' => 'string', 'required' => false, 'example' => '7a8f608dc64c242632aa578xxxxx', 'title' => ''], + ], [ 'name' => 'DebugFlag', 'in' => 'query', - 'schema' => [ - 'description' => 'The flag that indicates whether the playbook is of the debugging or published version. Valid values:'."\n" - ."\n" - .'* **1**: playbook of the debugging version'."\n" - .'* **0**: playbook of the published version'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'A flag that indicates whether the version is a published version or a debug version. Valid values:'."\n" + ."\n" + .'- **1**: retrieves the debug version.'."\n" + ."\n" + .'- **0**: retrieves the published version.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<PlaybookDetailDTO>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2989BC59-E9F0-5C83-B453-B368857649C8', - ], + 'RequestId' => ['description' => 'The request ID. This is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '2989BC59-E9F0-5C83-B453-B368857649C8'], 'Playbook' => [ - 'title' => '传输的数据', - 'description' => 'The configuration of the playbook.'."\n", + 'title' => '', + 'description' => 'The configuration of the playbook.', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The creation time of the playbook. The value is a 13-digit timestamp.'."\n", - 'type' => 'string', - 'example' => '1665288858000', - ], - 'GmtModified' => [ - 'description' => 'The modification time of the playbook. The value is a 13-digit timestamp.'."\n", - 'type' => 'string', - 'example' => '1677482519000', - ], - 'PlaybookUuid' => [ - 'description' => 'The UUID of the playbook.'."\n", - 'type' => 'string', - 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx', - ], - 'Taskflow' => [ - 'description' => 'The XML configuration of the playbook.'."\n", - 'type' => 'string', - 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>', - ], - 'TaskflowType' => [ - 'type' => 'string', - 'description' => 'The playbook configuration type.'."\n" - .'* **xml**: XML format.'."\n" - .'* **x6**: JSON format.', - 'example' => 'xml', - ], - 'OwnType' => [ - 'description' => 'The type of the playbook. Valid values:'."\n" - ."\n" - .'* **preset**: predefined playbook'."\n" - .'* **user**: custom playbook'."\n", - 'type' => 'string', - 'example' => 'preset', - ], - 'SuccessExeNum' => [ - 'description' => 'The number of times that the playbook was successfully run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'FailExeNum' => [ - 'description' => 'The number of times that the playbook failed to be run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LastExeTime' => [ - 'description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1665288858000', - ], - 'DisplayName' => [ - 'description' => 'The display name of the playbook.'."\n", - 'type' => 'string', - 'example' => 'demo_test', - ], - 'InputParams' => [ - 'description' => 'The input parameter configuration of the playbook. The value is a JSON array.'."\n" - ."\n" - .'> For more information, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "typeName": "String",'."\n" - .' "dataClass": "normal",'."\n" - .' "dataType": "String",'."\n" - .' "description": "period",'."\n" - .' "example": "",'."\n" - .' "name": "period",'."\n" - .' "required": false'."\n" - .' }'."\n" - .']', - ], - 'Description' => [ - 'description' => 'The description of the playbook.'."\n", - 'type' => 'string', - 'example' => 'demo playbook', - ], - 'OnlineActive' => [ - 'description' => 'The status of the playbook. Valid values:'."\n" - ."\n" - .'* **0**: disabled'."\n" - .'* **1**: enabled'."\n", - 'type' => 'boolean', - 'example' => '0', - ], - 'OnlineReleaseTaskflowMd5' => [ - 'description' => 'The MD5 hash value in the latest published version of the playbook.'."\n", - 'type' => 'string', - 'example' => 'asdfsdfe232-e2b2-44fd-b2cc-xxxxx', - ], + 'GmtCreate' => ['description' => 'The time when the playbook was created. This is a 13-digit timestamp.', 'type' => 'string', 'example' => '1665288858000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the playbook was last modified. This is a 13-digit timestamp.', 'type' => 'string', 'example' => '1677482519000', 'title' => ''], + 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx', 'title' => ''], + 'Taskflow' => ['description' => 'The XML configuration of the playbook.', 'type' => 'string', 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>', 'title' => ''], + 'TaskflowType' => ['description' => 'The configuration format of the playbook.'."\n" + ."\n" + .'- **xml**: XML format.'."\n" + ."\n" + .'- **x6**: JSON format.', 'type' => 'string', 'example' => 'xml', 'title' => ''], + 'OwnType' => ['description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'- **preset**: predefined playbook.'."\n" + ."\n" + .'- **user**: custom playbook.', 'type' => 'string', 'example' => 'preset', 'title' => ''], + 'SuccessExeNum' => ['description' => 'The number of times the playbook was successfully run.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'FailExeNum' => ['description' => 'The number of times the playbook failed to run.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'LastExeTime' => ['description' => 'The last time when the playbook was run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1665288858000', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the playbook.', 'type' => 'string', 'example' => 'demo_test', 'title' => ''], + 'InputParams' => ['description' => 'The input parameter configuration of the playbook. The value is a JSONArray string.'."\n" + ."\n" + .'> For more information about the format, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']', 'title' => ''], + 'Description' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'demo playbook', 'title' => ''], + 'OnlineActive' => ['description' => 'A flag that indicates whether the playbook is enabled. Valid values:'."\n" + ."\n" + .'- **0**: The playbook is disabled.'."\n" + ."\n" + .'- **1**: The playbook is enabled.', 'type' => 'boolean', 'example' => '0', 'title' => ''], + 'OnlineReleaseTaskflowMd5' => ['description' => 'The MD5 value of the latest published version of the playbook.', 'type' => 'string', 'example' => 'asdfsdfe232-e2b2-44fd-b2cc-xxxxx', 'title' => ''], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2989BC59-E9F0-5C83-B453-B368857649C8\\",\\n \\"Playbook\\": {\\n \\"GmtCreate\\": \\"1665288858000\\",\\n \\"GmtModified\\": \\"1677482519000\\",\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"Taskflow\\": \\"<?xml version=\\\\\\"1.0\\\\\\" encoding=\\\\\\"UTF-8\\\\\\"?><bpmn:definitions xmlns:xsi=\\\\\\"http://www.w3.org/2001/XMLSchema-instance\\\\\\" xmlns:bpmn=\\\\\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\\\\\" xmlns:bpmndi=\\\\\\"http://www.omg.org/spec/BPMN/20100524/DI\\\\\\" xmlns:dc=\\\\\\"http://www.omg.org/spec/DD/20100524/DC\\\\\\" targetNamespace=\\\\\\"http://bpmn.io/schema/bpmn\\\\\\" id=\\\\\\"Definitions_1\\\\\\"><bpmn:process id=\\\\\\"Process_1\\\\\\" isExecutable=\\\\\\"false\\\\\\"><bpmn:startEvent id=\\\\\\"StartEvent_1\\\\\\"/></bpmn:process><bpmndi:BPMNDiagram id=\\\\\\"BPMNDiagram_1\\\\\\"><bpmndi:BPMNPlane id=\\\\\\"BPMNPlane_1\\\\\\" bpmnElement=\\\\\\"Process_1\\\\\\"><bpmndi:BPMNShape id=\\\\\\"_BPMNShape_StartEvent_2\\\\\\" bpmnElement=\\\\\\"StartEvent_1\\\\\\"><dc:Bounds height=\\\\\\"36.0\\\\\\" width=\\\\\\"36.0\\\\\\" x=\\\\\\"173.0\\\\\\" y=\\\\\\"102.0\\\\\\"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>\\",\\n \\"TaskflowType\\": \\"xml\\",\\n \\"OwnType\\": \\"preset\\",\\n \\"SuccessExeNum\\": 100,\\n \\"FailExeNum\\": 1,\\n \\"LastExeTime\\": 1665288858000,\\n \\"DisplayName\\": \\"demo_test\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"Description\\": \\"demo playbook\\",\\n \\"OnlineActive\\": true,\\n \\"OnlineReleaseTaskflowMd5\\": \\"asdfsdfe232-e2b2-44fd-b2cc-xxxxx\\"\\n }\\n}","type":"json"}]', 'title' => 'DescribePlaybook', - ], - 'DescribePlaybookInputOutput' => [ - 'summary' => 'Queries the input and output parameter configurations of a playbook.', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-26T03:24:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-19T03:26:13.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybook'], + ], ], + 'ramActions' => [], + ], + 'DescribePlaybookInputOutput' => [ + 'summary' => 'Retrieves the input and output parameter configurations for a playbook.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2576,132 +2490,119 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '167574', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<PlaybookInputOutputDTO>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response that is returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '688B4CCD-5272-5DCF-9D76-FE5EFEF545F8', - ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '688B4CCD-5272-5DCF-9D76-FE5EFEF545F8'], 'Config' => [ - 'title' => '传输的数据', - 'description' => 'The configurations.'."\n", + 'title' => '', + 'description' => 'The configuration information.', 'type' => 'object', 'properties' => [ - 'ParamType' => [ - 'title' => '输入类型', - 'description' => 'The input parameter type of the playbook. Valid values:'."\n" - ."\n" - .'* **template-ip**'."\n" - .'* **template-file**'."\n" - .'* **template-process**'."\n" - .'* **custom**'."\n", - 'type' => 'string', - 'example' => 'custom', - ], - 'ExeConfig' => [ - 'title' => '输入类型', - 'description' => 'The execution method of the playbook is in JSONObject format.', - 'type' => 'string', - 'example' => '{'."\n" - .' "executeMode":"mul",'."\n" - .' "cron":"0 0 1 */1 * ?"'."\n" - .'}', - ], - 'InputParams' => [ - 'title' => '入参配置', - 'description' => 'The input parameter configuration of the playbook. The value is a JSON array.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "typeName": "String",'."\n" - .' "dataClass": "normal",'."\n" - .' "dataType": "String",'."\n" - .' "description": "period",'."\n" - .' "example": "",'."\n" - .' "name": "period",'."\n" - .' "required": false'."\n" - .' }'."\n" - .']', - ], - 'OutputParams' => [ - 'title' => '出参配置', - 'description' => 'The output parameter configuration. This parameter is unavailable and is always left empty.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'PlaybookUuid' => [ - 'description' => 'The UUID of the playbook.'."\n", - 'type' => 'string', - 'example' => '9030076b-6733-4842-b05a-xxxxxx', - ], + 'ParamType' => ['description' => 'The type of the input parameters for the playbook.'."\n" + ."\n" + .'- **template-ip**: IP request template.'."\n" + ."\n" + .'- **template-file**: file request template.'."\n" + ."\n" + .'- **template-process**: process request template.'."\n" + ."\n" + .'- **custom**: custom parameters.', 'type' => 'string', 'title' => '', 'example' => 'custom'], + 'ExeConfig' => ['title' => '输入类型', 'description' => 'The execution method of the playbook. The value is in the JSONObject format.', 'type' => 'string', 'example' => '{'."\n" + .' "executeMode":"mul",'."\n" + .' "cron":"0 0 1 */1 * ?"'."\n" + .'}'], + 'InputParams' => ['description' => 'The input parameter configurations of the playbook. The value is in the JSONArray format.', 'type' => 'string', 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']'], + 'OutputParams' => ['description' => 'Playbooks do not support output parameter configurations. This parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '[]'], + 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => '9030076b-6733-4842-b05a-xxxxxx', 'title' => ''], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"688B4CCD-5272-5DCF-9D76-FE5EFEF545F8\\",\\n \\"Config\\": {\\n \\"ParamType\\": \\"custom\\",\\n \\"ExeConfig\\": \\"{\\\\n \\\\\\"executeMode\\\\\\":\\\\\\"mul\\\\\\",\\\\n \\\\\\"cron\\\\\\":\\\\\\"0 0 1 */1 * ?\\\\\\"\\\\n}\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"OutputParams\\": \\"[]\\",\\n \\"PlaybookUuid\\": \\"9030076b-6733-4842-b05a-xxxxxx\\"\\n }\\n}","type":"json"}]', 'title' => 'DescribePlaybookInputOutput', - 'responseParamsDescription' => 'The value of **InputParams** is a JSON array, which contains the following fields:'."\n" + 'responseParamsDescription' => 'The **InputParams** parameter is in JSON array format. It contains the following fields:'."\n" + ."\n" + .'- typeName: The name of the parameter type.'."\n" ."\n" - .'* typeName: the data type name of the parameter.'."\n" - .'* dataClass: the level of the parameter type. Valid values are **normal** and **custom**. The value normal indicates a common parameter, and the value custom indicates a complex parameter.'."\n" - .'* dataType: the type of the parameter. Valid values are **string, long, int, ip, file, and account**.'."\n" - .'* description: the description of the parameter.'."\n" - .'* example: the example value of the parameter.'."\n" - .'* name: the name of the parameter.'."\n" - .'* required: specifies whether the parameter is required. Valid values are **true** and **false**.'."\n", + .'- dataClass: The class of the parameter type. Valid values include **normal** for a standard parameter and **custom** for a complex parameter.'."\n" + ."\n" + .'- dataType: The data type of the parameter. Valid values: string, long, int, ip, file, and **account**.'."\n" + ."\n" + .'- description: The description of the parameter.'."\n" + ."\n" + .'- example: An example of the parameter value.'."\n" + ."\n" + .'- name: The name of the parameter.'."\n" + ."\n" + .'- required: Specifies whether the parameter is required. Valid values: **true** and **false**.', + 'changeSet' => [ + ['createdAt' => '2024-03-21T02:56:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-15T02:09:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-16T08:25:46.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookInputOutput'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribePlaybookInputOutput', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], + ], ], 'DescribePlaybookMetrics' => [ - 'summary' => 'Queries the metrics of a playbook. The metrics include the playbook name, playbook description, the number of times that the playbook is run, and the failure rate of the playbook.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Queries playbook metadata, including its name, description, number of runs, and failure rate.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2709,148 +2610,91 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2a687089-d4dd-47d4-9709-xxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2a687089-d4dd-47d4-9709-xxxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<PlaybookCloudDTO>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73', - ], + 'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request and is used for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73'], 'Metrics' => [ - 'title' => '传输的数据', - 'description' => 'The details of the playbook.'."\n", + 'title' => '', + 'description' => 'The details of the playbook.', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'title' => '剧本的名称', - 'description' => 'The name of the playbook.'."\n", - 'type' => 'string', - 'example' => 'demo name', - ], - 'PlaybookUuid' => [ - 'title' => '剧本的UUID', - 'description' => 'The UUID of the playbook.'."\n", - 'type' => 'string', - 'example' => '0fbc9bdb-9ae3-4ef4-a709-xxxxx', - ], - 'OwnType' => [ - 'title' => '剧本的权限类型', - 'description' => 'The type of the playbook. Valid values:'."\n" - ."\n" - .'* **preset**: predefined playbook'."\n" - .'* **user**: custom playbook'."\n", - 'type' => 'string', - 'example' => 'user', - ], - 'Active' => [ - 'title' => '剧本的启用状态', - 'description' => 'The status of the playbook. Valid values:'."\n" - ."\n" - .'* **1**: enabled'."\n" - .'* **0**: disabled'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LastRuntime' => [ - 'title' => '剧本的最后执行时间', - 'description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683526277415', - ], - 'GmtCreate' => [ - 'title' => '剧本创建时间', - 'description' => 'The time when the playbook was created. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655277397000', - ], - 'HistoryMd5' => [ - 'title' => '剧本历史版本数', - 'description' => 'The number of historical versions of the playbook.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SuccNum' => [ - 'title' => '剧本执行成功数', - 'description' => 'The number of the tasks that are created for the playbook and were successfully run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'FailNum' => [ - 'title' => '剧本执行失败数', - 'description' => 'The number of the tasks that are created for the playbook and failed to run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Description' => [ - 'description' => 'The description of the playbook.'."\n", - 'type' => 'string', - 'example' => 'This is a playbook for waf processing', - ], + 'DisplayName' => ['description' => 'The name of the playbook.', 'type' => 'string', 'title' => '', 'example' => 'demo name'], + 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'title' => '', 'example' => '0fbc9bdb-9ae3-4ef4-a709-xxxxx'], + 'OwnType' => ['description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'- **preset**: predefined playbook.'."\n" + ."\n" + .'- **user**: custom playbook.', 'type' => 'string', 'title' => '', 'example' => 'user'], + 'Active' => ['description' => 'The status of the playbook. Valid values:'."\n" + ."\n" + .'- **1**: The playbook is enabled.'."\n" + ."\n" + .'- **0**: The playbook is disabled.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'LastRuntime' => ['description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1683526277415'], + 'GmtCreate' => ['description' => 'The time when the playbook was created. The value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1655277397000'], + 'HistoryMd5' => ['description' => 'The number of historical versions of the playbook.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'SuccNum' => ['description' => 'The number of successful playbook runs.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'FailNum' => ['description' => 'The number of failed playbook runs.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'Description' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'This is a playbook for waf processing', 'title' => ''], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Metrics\\": {\\n \\"DisplayName\\": \\"demo name\\",\\n \\"PlaybookUuid\\": \\"0fbc9bdb-9ae3-4ef4-a709-xxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1683526277415,\\n \\"GmtCreate\\": 1655277397000,\\n \\"HistoryMd5\\": 10,\\n \\"SuccNum\\": 100,\\n \\"FailNum\\": 10,\\n \\"Description\\": \\"This is a playbook for waf processing\\"\\n }\\n}","type":"json"}]', 'title' => 'DescribePlaybookMetrics', - ], - 'DescribePlaybookNodesOutput' => [ - 'summary' => 'Queries the historical output data of a component node.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookMetrics'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribePlaybookMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], + ], + 'DescribePlaybookNodesOutput' => [ + 'summary' => 'Retrieves the historical output data of a component.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2858,123 +2702,110 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ac343acc-1a61-4084-9a1c-xxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxxx'], ], [ 'name' => 'NodeName', 'in' => 'query', - 'schema' => [ - 'title' => '组件节点名', - 'description' => 'The name of the component node.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'DataFormat_1', - ], + 'schema' => ['description' => 'The name of the component node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'DataFormat_1'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<PlaybookNodeOutput>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response that is returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A491170C-FE1F-520E-83D4-72ED205B72ED', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A491170C-FE1F-520E-83D4-72ED205B72ED'], 'PlaybookNodesOutput' => [ - 'title' => '传输的数据', - 'description' => 'The output data of the component node.'."\n", + 'title' => '', + 'description' => 'The output data of the node.', 'type' => 'object', 'properties' => [ - 'NodeName' => [ - 'description' => 'The name of the component node.'."\n", - 'type' => 'string', - 'example' => 'DataFormat_1', - ], - 'NodeOutput' => [ - 'description' => 'The historical output data of the component node. The value is in the JSON string format. If no data is found, the parameter is left empty.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "datalist": ['."\n" - .' {'."\n" - .' "score": "10",'."\n" - .' "ip": "1.1.1.1"'."\n" - .' }'."\n" - .' ],'."\n" - .' "total_data_successful": 1,'."\n" - .' "filter_total_data": 1,'."\n" - .' "total_data": 1,'."\n" - .' "total_exe_successful": 1,'."\n" - .' "total_exe": 1,'."\n" - .' "total_data_with_dup": 1,'."\n" - .' "filter_total_data_successful": 1,'."\n" - .' "status": true'."\n" - .'}', - ], + 'NodeName' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''], + 'NodeOutput' => ['description' => 'The historical output data of the component. The data is in the JSON format. If no data exists, this parameter is empty.', 'type' => 'string', 'example' => '{'."\n" + .' "datalist": ['."\n" + .' {'."\n" + .' "score": "10",'."\n" + .' "ip": "1.1.1.1"'."\n" + .' }'."\n" + .' ],'."\n" + .' "total_data_successful": 1,'."\n" + .' "filter_total_data": 1,'."\n" + .' "total_data": 1,'."\n" + .' "total_exe_successful": 1,'."\n" + .' "total_exe": 1,'."\n" + .' "total_data_with_dup": 1,'."\n" + .' "filter_total_data_successful": 1,'."\n" + .' "status": true'."\n" + .'}', 'title' => ''], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A491170C-FE1F-520E-83D4-72ED205B72ED\\",\\n \\"PlaybookNodesOutput\\": {\\n \\"NodeName\\": \\"DataFormat_1\\",\\n \\"NodeOutput\\": \\"{\\\\n \\\\\\"datalist\\\\\\": [\\\\n {\\\\n \\\\\\"score\\\\\\": \\\\\\"10\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"1.1.1.1\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"total_data_successful\\\\\\": 1,\\\\n \\\\\\"filter_total_data\\\\\\": 1,\\\\n \\\\\\"total_data\\\\\\": 1,\\\\n \\\\\\"total_exe_successful\\\\\\": 1,\\\\n \\\\\\"total_exe\\\\\\": 1,\\\\n \\\\\\"total_data_with_dup\\\\\\": 1,\\\\n \\\\\\"filter_total_data_successful\\\\\\": 1,\\\\n \\\\\\"status\\\\\\": true\\\\n}\\"\\n }\\n}","type":"json"}]', 'title' => 'DescribePlaybookNodesOutput', - 'responseParamsDescription' => 'The value of **NodeOutput** is a JSON object, which contains the following fields:'."\n" + 'responseParamsDescription' => 'The **NodeOutput** parameter is a JSON object that contains the following fields:'."\n" + ."\n" + .'- **datalist**: The details of the output data.'."\n" + ."\n" + .'- **total\\_data\\_successful**: The number of successfully processed data entries.'."\n" + ."\n" + .'- **total\\_data**: The total number of data entries.'."\n" ."\n" - .'* **datalist**: the details of output data.'."\n" - .'* **total_data_successful**: the number of components that are successfully run.'."\n" - .'* **total_data**: the total number of components that are run.'."\n" - .'* **total_exe_successful**: the number of times that the running is successful.'."\n" - .'* **total_exe**: the total number of times for running.'."\n" - .'* **total_data_with_dup**: the number of times that the data is repeated.'."\n" - .'* **status**: indicates whether the component is successfully run. Valid values: **true** and **false**.'."\n", + .'- **total\\_exe\\_successful**: The number of successful executions.'."\n" + ."\n" + .'- **total\\_exe**: The total number of executions.'."\n" + ."\n" + .'- **total\\_data\\_with\\_dup**: The number of duplicate data entries.'."\n" + ."\n" + .'- **status**: Indicates whether the execution was successful. A value of **true** indicates success and a value of **false** indicates failure.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNodesOutput'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribePlaybookNodesOutput', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], + ], ], 'DescribePlaybookNumberMetrics' => [ - 'summary' => 'Queries the statistics of Security Orchestration Automation Response (SOAR), such as the numbers of created and enabled playbooks.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves metrics for the response orchestration product, including the total number of playbooks and the number of enabled playbooks.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2982,73 +2813,68 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response.'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<PlaybookMetrics>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Metrics' => [ - 'title' => '传输的数据', - 'description' => 'The statistics.'."\n", + 'title' => '', + 'description' => 'The statistics.', 'type' => 'object', 'properties' => [ - 'TotalNum' => [ - 'description' => 'The total number of playbooks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'StartUpNum' => [ - 'description' => 'The number of enabled playbooks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], + 'TotalNum' => ['description' => 'The total number of playbooks.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'StartUpNum' => ['description' => 'The number of enabled playbooks.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B', - ], + 'RequestId' => ['description' => 'The unique ID of the request. If you have an issue with a request, provide this ID for troubleshooting.', 'type' => 'string', 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metrics\\": {\\n \\"TotalNum\\": 100,\\n \\"StartUpNum\\": 50\\n },\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\"\\n}","type":"json"}]', 'title' => 'DescribePlaybookNumberMetrics', - ], - 'DescribePlaybookReleases' => [ - 'summary' => 'Queries the information about the published versions of a playbook.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNumberMetrics'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribePlaybookNumberMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribePlaybookReleases' => [ + 'summary' => 'Queries a list of published versions of a playbook.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3056,165 +2882,106 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The playbook UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ac343acc-1a61-4084-9a1c-xxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. If you do not specify the PageSize parameter, 10 entries are returned by default.'."\n" - ."\n" - .'> We recommend that you do not leave this parameter empty.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. If you do not specify this parameter, 10 entries are returned.'."\n" + ."\n" + .'> Specify a value for this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<List<SaoReleaseInfo>>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3DFBE11C-6EB6-5166-92D6-3397796AFE1E', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3DFBE11C-6EB6-5166-92D6-3397796AFE1E'], 'Records' => [ - 'title' => '传输的数据', - 'description' => 'The information about the playbook version.'."\n", + 'title' => '', + 'description' => 'A list of playbook versions.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The version information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The record ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80xxx', - ], - 'GmtCreate' => [ - 'title' => '创建时间', - 'description' => 'The time when the version was created. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655277397000', - ], - 'GmtModified' => [ - 'title' => '修改时间', - 'description' => 'The time when the version was modified. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1691460804000', - ], - 'Creator' => [ - 'title' => '创建人', - 'description' => 'The ID of the Alibaba Cloud account that is used to publish the version.'."\n", - 'type' => 'string', - 'example' => '145xxxx985', - ], - 'Description' => [ - 'title' => '描述信息', - 'description' => 'The description of the layer version.'."\n", - 'type' => 'string', - 'example' => 'This is a new version', - ], - 'TaskflowMd5' => [ - 'title' => 'taskflow的MD5信息，用于比较是否 有变化', - 'description' => 'The MD5 value configured for the published version of the playbook.'."\n", - 'type' => 'string', - 'example' => 'be0a4ef084dd174abe47xxxxx', - ], - ], + 'Id' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '80xxx', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the version was created. This is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1655277397000'], + 'GmtModified' => ['description' => 'The time when the version was last modified. This is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1691460804000'], + 'Creator' => ['description' => 'The ID of the Alibaba Cloud account that published the version.', 'type' => 'string', 'title' => '', 'example' => '145xxxx985'], + 'Description' => ['description' => 'The description of the version.', 'type' => 'string', 'title' => '', 'example' => 'This is a new version'], + 'TaskflowMd5' => ['description' => 'The MD5 hash of the playbook configuration for the published version.', 'type' => 'string', 'title' => '', 'example' => 'be0a4ef084dd174abe47xxxxx'], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], 'Page' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3DFBE11C-6EB6-5166-92D6-3397796AFE1E\\",\\n \\"Records\\": [\\n {\\n \\"Id\\": 0,\\n \\"GmtCreate\\": 1655277397000,\\n \\"GmtModified\\": 1691460804000,\\n \\"Creator\\": \\"145xxxx985\\",\\n \\"Description\\": \\"This is a new version\\",\\n \\"TaskflowMd5\\": \\"be0a4ef084dd174abe47xxxxx\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', 'title' => 'DescribePlaybookReleases', - ], - 'DescribePlaybooks' => [ - 'summary' => 'Retrieve the list of playbooks.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookReleases'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribePlaybookReleases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], + ], + 'DescribePlaybooks' => [ + 'summary' => 'Queries a list of playbooks.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3227,328 +2994,227 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '167066', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Active', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的状态', - 'description' => 'Activation status of the playbook. Values:'."\n" - ."\n" - .'- **1**: Indicates the playbook is activated.'."\n" - .'- **0**: Indicates the playbook is not activated.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '剧本的状态', 'description' => 'The status of the playbook. Valid values:'."\n" + ."\n" + .'- **1**: The playbook is enabled.'."\n" + ."\n" + .'- **0**: The playbook is disabled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'OwnType', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的类型', - 'description' => 'Type of the playbook. Values:'."\n" - ."\n" - .'- **preset**: Predefined playbook.'."\n" - .'- **user**: Custom playbook.', - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], + 'schema' => ['title' => '剧本的类型', 'description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'- **preset**: predefined playbook.'."\n" + ."\n" + .'- **user**: custom playbook.', 'type' => 'string', 'required' => false, 'example' => 'user'], ], [ 'name' => 'StartMillis', 'in' => 'query', - 'schema' => [ - 'title' => '开始时间', - 'description' => 'Start time for the query, in 13-digit timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1683526277415', - ], + 'schema' => ['title' => '开始时间', 'description' => 'The start of the time range to query. This value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526277415'], ], [ 'name' => 'EndMillis', 'in' => 'query', - 'schema' => [ - 'title' => '结束时间', - 'description' => 'End time for the query, in 13-digit timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1683858064361', - ], + 'schema' => ['title' => '结束时间', 'description' => 'The end of the time range to query. This value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683858064361'], ], [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - .'> You can use the UUID to query specific playbook information.'."\n" - .'> - Call the [CreatePlaybook](~~CreatePlaybook~~) API to obtain this parameter.', - 'type' => 'string', - 'required' => false, - 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx', - ], + 'schema' => ['title' => '剧本UUID', 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [CreatePlaybook](~~CreatePlaybook~~) operation to obtain this parameter.', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '剧本名称', - 'description' => 'The name of the playbook.', - 'type' => 'string', - 'required' => false, - 'example' => 'demo_playbook', - ], + 'schema' => ['title' => '剧本名称', 'description' => 'The name of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'demo_playbook'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the language type for the request and response, default is **zh**. Values:'."\n" - .'- **zh**: Chinese.'."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the maximum number of items to display per page in a paginated query. The default number of items per page is 20. If the PageSize parameter is empty, it will return 10 items by default.'."\n" - .'> It is recommended that the PageSize value is not empty.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned by default.'."\n" + ."\n" + .'> Specify a value for this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Sets the page number from which to start displaying the query results. The default value is 1, indicating the first page.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Sort', 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting basis, with a default value of **1**. Values:'."\n" - .'- **1**: Last modified time.'."\n" - .'- **2**: Most recent execution time.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'title' => '排序依据 1-上次修改时间 2-最近执行时间', - ], + 'schema' => ['title' => '排序依据 1-上次修改时间 2-最近执行时间', 'description' => 'The field to sort by. Default value: **1**. Valid values:'."\n" + ."\n" + .'- **1**: last modification time.'."\n" + ."\n" + .'- **2**: last running time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'title' => '排序逻辑：desc asc,默认desc', - 'description' => 'The sorting logic, with a default value of **desc**. Values:'."\n" - .'- **desc**: Descending order.'."\n" - .'- **asc**: Ascending order.', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['title' => '排序逻辑：desc asc,默认desc', 'description' => 'The sort order. Default value: **desc**. Valid values:'."\n" + ."\n" + .'- **desc**: descending.'."\n" + ."\n" + .'- **asc**: ascending.', 'type' => 'string', 'required' => false, 'example' => 'desc'], ], [ 'name' => 'ParamTypes', 'in' => 'query', - 'schema' => [ - 'description' => 'The trigger method for the playbook, with a default value of **query all**. Values:'."\n" - .'- **template-incident**: Security incident.'."\n" - .'- **template-ip**: IP entity.'."\n" - .'- **template-file**: File entity.'."\n" - .'- **template-process**: Process entity.'."\n" - .'- **template-alert**: Security alert.'."\n" - .'- **template-domain**: Domain entity.'."\n" - .'- **template-container**: Container entity.'."\n" - .'- **template-host**: Host entity.'."\n" - .'- **template-custom**: Custom.', - 'type' => 'string', - 'required' => false, - 'example' => 'template-alert', - ], + 'schema' => ['description' => 'The trigger type of the playbook. If you do not specify this parameter, playbooks of all trigger types are queried. Valid values:'."\n" + ."\n" + .'- **template-incident**: security event.'."\n" + ."\n" + .'- **template-ip**: IP entity.'."\n" + ."\n" + .'- **template-file**: file entity.'."\n" + ."\n" + .'- **template-process**: process entity.'."\n" + ."\n" + .'- **template-alert**: security alert.'."\n" + ."\n" + .'- **template-domain**: domain name entity.'."\n" + ."\n" + .'- **template-container**: container entity.'."\n" + ."\n" + .'- **template-host**: host entity.'."\n" + ."\n" + .'- **template-custom**: custom.', 'type' => 'string', 'required' => false, 'example' => 'template-alert', 'title' => ''], ], [ 'name' => 'PlaybookUuids', 'in' => 'query', - 'schema' => [ - 'description' => 'UUID List of the playbook.'."\n" - ."\n" - .'Note You can use the UUID list to query specific playbook information.'."\n" - .'Call the DescribePlaybooks API to obtain this parameter.', - 'type' => 'string', - 'required' => false, - 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,7745e6cff-319e-4ede-97bc-1xxxxxx', - ], + 'schema' => ['description' => 'A comma-separated list of playbook UUIDs. You can specify up to 100 UUIDs.', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<List<PlaybookCloudDTO>>', - 'description' => 'Response information.', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The ID of the current request, generated by Alibaba Cloud as a unique identifier for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '138B5AB7-****-5814-87A3-E3E****F207E', - ], + 'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The request ID. This ID is generated by Alibaba Cloud for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => '138B5AB7-****-5814-87A3-E3E****F207E'], 'Playbooks' => [ 'title' => '传输的数据', - 'description' => 'List of playbooks.', + 'description' => 'The list of playbooks.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the playbook.', + 'description' => 'The information about the playbook.', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'title' => '剧本的名称', - 'description' => 'The display name of the playbook.', - 'type' => 'string', - 'example' => 'demo_playbook', - ], - 'PlaybookUuid' => [ - 'title' => '剧本的UUID', - 'description' => 'The UUID of the playbook.', - 'type' => 'string', - 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx', - ], - 'OwnType' => [ - 'title' => '剧本的权限类型', - 'description' => 'The type of the playbook. Values:'."\n" - ."\n" - .'- **preset**: Predefined playbook.'."\n" - .'- **user**: Custom playbook.', - 'type' => 'string', - 'example' => 'user', - ], - 'Active' => [ - 'title' => '剧本的启用状态', - 'description' => 'The status indicator of the playbook. Values:'."\n" - ."\n" - .'- **1**: Indicates the playbook is activated.'."\n" - .'- **0**: Indicates the playbook is deactivated.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LastRuntime' => [ - 'title' => '剧本的最后执行时间', - 'description' => 'The last execution time of the playbook, in 13-digit timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683526277415', - ], - 'GmtCreate' => [ - 'title' => '剧本创建时间', - 'description' => 'The creation time of the playbook, in 13-digit timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683526277415', - ], - 'GmtModified' => [ - 'title' => '剧本修改时间', - 'description' => 'The modification time of the playbook.', - 'type' => 'string', - 'example' => '1681396398000', - ], - 'ParamType' => [ - 'description' => 'The trigger method for the playbook, with a default value of **query all**. Possible values are:'."\n" - .'- **template-incident**: Security incident.'."\n" - .'- **template-ip**: IP entity.'."\n" - .'- **template-file**: File entity.'."\n" - .'- **template-process**: Process entity.'."\n" - .'- **template-alert**: Security alert.'."\n" - .'- **template-domain**: Domain entity.'."\n" - .'- **template-container**: Container entity.'."\n" - .'- **template-host**: Host entity.', - 'type' => 'string', - 'example' => 'template-alert', - ], - 'Description' => [ - 'type' => 'string', - 'description' => 'The description of the playbook.', - 'example' => 'aegis_kill_process', - ], - 'TenantId' => [ - 'type' => 'string', - 'description' => 'The ID of the tenant. ', - 'example' => '296004', - ], + 'DisplayName' => ['title' => '剧本的名称', 'description' => 'The display name of the playbook.', 'type' => 'string', 'example' => 'demo_playbook'], + 'PlaybookUuid' => ['title' => '剧本的UUID', 'description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx'], + 'OwnType' => ['title' => '剧本的权限类型', 'description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'- **preset**: predefined playbook.'."\n" + ."\n" + .'- **user**: custom playbook.', 'type' => 'string', 'example' => 'user'], + 'Active' => ['title' => '剧本的启用状态', 'description' => 'The status of the playbook. Valid values:'."\n" + ."\n" + .'- **1**: The playbook is enabled.'."\n" + ."\n" + .'- **0**: The playbook is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'LastRuntime' => ['title' => '剧本的最后执行时间', 'description' => 'The last time the playbook was run. This value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683526277415'], + 'GmtCreate' => ['title' => '剧本创建时间', 'description' => 'The time when the playbook was created. This value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683526277415'], + 'GmtModified' => ['title' => '剧本修改时间', 'description' => 'The time when the playbook was modified.', 'type' => 'string', 'example' => '1681396398000'], + 'ParamType' => ['description' => 'The trigger type of the playbook. Valid values:'."\n" + ."\n" + .'- **template-incident**: security event.'."\n" + ."\n" + .'- **template-ip**: IP entity.'."\n" + ."\n" + .'- **template-file**: file entity.'."\n" + ."\n" + .'- **template-process**: process entity.'."\n" + ."\n" + .'- **template-alert**: security alert.'."\n" + ."\n" + .'- **template-domain**: domain name entity.'."\n" + ."\n" + .'- **template-container**: container entity.'."\n" + ."\n" + .'- **template-host**: host entity.', 'type' => 'string', 'example' => 'template-alert', 'title' => ''], + 'Description' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'aegis_kill_process', 'title' => ''], + 'TenantId' => ['description' => 'The ID of the user to which the playbook belongs.', 'type' => 'string', 'example' => '123456', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], 'Page' => [ - 'description' => 'Pagination query information.', + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of items found.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number in pagination queries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of items per page in pagination queries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"138B5AB7-****-5814-87A3-E3E****F207E\\",\\n \\"Playbooks\\": [\\n {\\n \\"DisplayName\\": \\"demo_playbook\\",\\n \\"PlaybookUuid\\": \\"bb5a8640-a14f-44ef-8376-cxxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1683526277415,\\n \\"GmtCreate\\": 1683526277415,\\n \\"GmtModified\\": \\"1681396398000\\",\\n \\"ParamType\\": \\"template-alert\\",\\n \\"Description\\": \\"aegis_kill_process\\",\\n \\"TenantId\\": \\"123456\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', 'title' => 'Get Playbook List', - 'translator' => 'machine', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for Security Orchestration, Automation, and Response (SOAR).', + 'changeSet' => [ + ['createdAt' => '2025-04-10T12:08:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-08T11:52:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-24T09:31:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-14T05:49:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-22T03:42:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-01T08:32:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybooks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribePlaybooks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/*'], + ], + ], + ], + ], ], 'DescribePopApi' => [ - 'summary' => 'Queries the details of an API operation.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3560,138 +3226,116 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'PopCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The POP code of the Alibaba Cloud service.'."\n" - ."\n" - .'> You can call the [DescribeApiList](~~DescribeApiList~~) operation to query the POP code.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Sas', - ], + 'schema' => ['description' => 'The POP code of the Alibaba Cloud product API.', 'type' => 'string', 'required' => true, 'example' => 'Sas', 'title' => ''], ], [ 'name' => 'ApiVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the API.'."\n" - ."\n" - .'> You can call the [DescribePopApiVersionList](~~DescribePopApiVersionList~~) operation to query the version number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-10-01', - ], + 'schema' => ['description' => 'The version number of the API.', 'type' => 'string', 'required' => true, 'example' => '2021-10-01', 'title' => ''], ], [ 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'The operation name of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'DescribeInstanceInfo', - ], + 'schema' => ['description' => 'The name of the Alibaba Cloud product API.', 'type' => 'string', 'required' => true, 'example' => 'DescribeInstanceInfo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<ListApiMetaResponse>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response contains the requested information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A01B0BA-CFC4-5813-9EB0-A5DA15FA95AE', - ], - 'PopCode' => [ - 'description' => 'The POP code of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'example' => 'Sas', - ], - 'Version' => [ - 'description' => 'The version of the API.'."\n", - 'type' => 'string', - 'example' => '2019-09-10', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'AddAssetCleanConfig', - ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE'], + 'PopCode' => ['description' => 'The POP code of the Alibaba Cloud product API.', 'type' => 'string', 'example' => 'Sas', 'title' => ''], + 'Version' => ['description' => 'The version number of the API.', 'type' => 'string', 'example' => '2019-09-10', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'AddAssetCleanConfig', 'title' => ''], 'OpenApiMetaList' => [ - 'description' => 'The information about the API.'."\n", + 'description' => 'List of API information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Detailed information.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'DescribePopApi', - ], - 'Required' => [ - 'description' => 'Indicates whether the parameter is required.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ExampleValue' => [ - 'description' => 'The example value.'."\n", - 'type' => 'string', - 'example' => '12.xx.xx.xx', - ], - 'Description' => [ - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'demo parameter', - ], - 'Type' => [ - 'description' => 'The data type of the parameter field. Valid values:'."\n" - ."\n" - .'* **string**'."\n" - .'* **boolean**'."\n" - .'* **integer**'."\n" - .'* **long**'."\n", - 'type' => 'string', - 'example' => 'string', - ], - 'Style' => [ - 'type' => 'string', - ], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'DescribePopApi', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the parameter is required.'."\n" + ."\n" + .'- **true**: required.'."\n" + ."\n" + .'- **false**: not required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ExampleValue' => ['description' => 'The example value.', 'type' => 'string', 'example' => '12.xx.xx.xx', 'title' => ''], + 'Description' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'demo parameter', 'title' => ''], + 'Type' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- **string**: a string.'."\n" + ."\n" + .'- **boolean**: a Boolean value.'."\n" + ."\n" + .'- **integer**: an integer.'."\n" + ."\n" + .'- **long**: a long integer.', 'type' => 'string', 'example' => 'string', 'title' => ''], + 'Style' => ['description' => 'The serialization method for an array parameter. Valid values:'."\n" + ."\n" + .'- **repeatList**: An array is serialized in the XXX.N format. Example: Instance.1=i-instance1&\\&Instance.2=i-instance2.'."\n" + ."\n" + .'- **simple**: An array is serialized as a comma-separated string. Example: i-instance1,i-instance2.'."\n" + ."\n" + .'- **spaceDelimited**: An array is serialized as a space-separated string. Example: i-instance1 i-instance2.'."\n" + ."\n" + .'- **pipeDelimited**: An array is serialized as a pipe-separated string. Example: i-instance1|i-instance2.'."\n" + ."\n" + .'- **json**: An array is serialized in JSON format. Example: \\["i-instance1","i-instance2"].'."\n" + ."\n" + .'- **flat**: An array is serialized in the XXX.N format. Example: Instance.1=i-instance1\\&Instance.2=i-instance2.', 'type' => 'string', 'example' => 'json', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PopCode\\": \\"Sas\\",\\n \\"Version\\": \\"2019-09-10\\",\\n \\"ApiName\\": \\"AddAssetCleanConfig\\",\\n \\"OpenApiMetaList\\": [\\n {\\n \\"Name\\": \\"DescribePopApi\\",\\n \\"Required\\": false,\\n \\"ExampleValue\\": \\"12.xx.xx.xx\\",\\n \\"Description\\": \\"demo parameter\\",\\n \\"Type\\": \\"string\\",\\n \\"Style\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribePopApi', - ], - 'DescribeSoarRecordActionOutputList' => [ - 'summary' => 'Queries the data that is returned when a component initiates an action in a playbook task.', - 'methods' => [ - 'get', + 'summary' => 'Retrieves the details of an OpenAPI.', + 'changeSet' => [ + ['createdAt' => '2025-05-15T01:38:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-08T09:37:47.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePopApi'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribePopApi', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PopCode\\": \\"Sas\\",\\n \\"Version\\": \\"2019-09-10\\",\\n \\"ApiName\\": \\"AddAssetCleanConfig\\",\\n \\"OpenApiMetaList\\": [\\n {\\n \\"Name\\": \\"DescribePopApi\\",\\n \\"Required\\": false,\\n \\"ExampleValue\\": \\"12.xx.xx.xx\\",\\n \\"Description\\": \\"demo parameter\\",\\n \\"Type\\": \\"string\\",\\n \\"Style\\": \\"json\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeProcessStatistics' => [ + 'summary' => 'Retrieves statistics information.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3703,122 +3347,83 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '208550', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ - 'name' => 'ActionUuid', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'title' => '动作的UUID', - 'description' => 'The UUID of the component action.'."\n" - ."\n" - .'> You can call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) operation to query the UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2202c90d-fa93-4726-bc32-xxxxxx', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'RoleType', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The view type. Valid values:'."\n" + ."\n" + .'- 0 (default): the view of the current Alibaba Cloud account.'."\n" + .'- 1: the view of all accounts in the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RoleFor', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. If you leave this parameter empty, 10 entries are returned on each page.'."\n" - ."\n" - .'> We recommend that you do not leave this parameter empty.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The user ID of the member to which the administrator switches the view.', 'type' => 'string', 'required' => false, 'example' => '1709821xxxxx3093', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ProcessActionStart', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The start time of the query for response tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17000XXX83572', 'title' => ''], + ], + [ + 'name' => 'ProcessActionEnd', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the query for response tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17561XXX77435', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<String>', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'SophonResult<ProcessMetricsDTO>', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90', - ], - 'ActionOutputs' => [ - 'title' => '传输的数据', - 'description' => 'The data that is returned when the component action is performed. The value is a JSON array.'."\n" - ."\n" - .'> The format of the output data is determined by the component that is configured when the playbook is written.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "a": "a",'."\n" - .' "taskname": "92af3c79-1754-4646-9366-9ddbd1e45536_xxxx",'."\n" - .' "log_time": 1699868849000'."\n" - .' }'."\n" - .']', - ], - 'PageNumber' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', + 'RequestId' => ['title' => '', 'description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => '4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F'], + 'Metrics' => [ + 'title' => '', + 'description' => 'The returned result data.', + 'type' => 'object', + 'properties' => [ + 'TaskNum' => ['description' => 'The number of response tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BanIpNum' => ['description' => 'The number of blocked IP addresses.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BanFileNum' => ['description' => 'The number of blocked files.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BanProcessNum' => ['description' => 'The number of blocked processes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F\\",\\n \\"Metrics\\": {\\n \\"TaskNum\\": 1,\\n \\"BanIpNum\\": 1,\\n \\"BanFileNum\\": 1,\\n \\"BanProcessNum\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve statistics of response tasks', + 'description' => 'Make sure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (Cloud Threat Detection and Response (CTDR) log traffic) before you call this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessStatistics'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90\\",\\n \\"ActionOutputs\\": \\"[\\\\n {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\",\\\\n \\\\\\"taskname\\\\\\": \\\\\\"92af3c79-1754-4646-9366-9ddbd1e45536_xxxx\\\\\\",\\\\n \\\\\\"log_time\\\\\\": 1699868849000\\\\n }\\\\n]\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', - 'title' => 'DescribeSoarRecordActionOutputList', + 'ramActions' => [], ], - 'DescribeSoarRecordInOutput' => [ - 'summary' => 'Queries the input and output data of a component action. You can call this operation after a playbook is run.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeProcessTaskCount' => [ + 'summary' => 'Queries the count of response tasks associated with an entity UUID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3830,127 +3435,106 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '245000', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ActionUuid', + 'name' => 'EntityUuidList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '动作的UUID', - 'description' => 'The UUID of the component action.'."\n" - ."\n" - .'> You can call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) operation to query the UUIDs of component actions.'."\n", - 'type' => 'string', + 'title' => '实体的entityUuid集合', + 'description' => 'The UUIDs of the entities.', + 'type' => 'array', + 'items' => ['description' => 'The UUID of the entity.', 'type' => 'string', 'required' => false, 'example' => 'a680c9ae-****-4c39-****-0302****fc8e', 'title' => ''], 'required' => true, - 'example' => '0531ff66-dd05-4f24-84bf-xxxxxxxx', + 'maxItems' => 100, + 'example' => '', ], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => ['description' => 'The view type.'."\n" + ."\n" + .'- **0**: The view of the current Alibaba Cloud account.'."\n" + ."\n" + .'- **1**: The view of all accounts that belong to the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => ['description' => 'The UID of the member whose permissions you want to use to call the operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '104739******259', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<String>', - 'description' => 'The response parameters.'."\n", + 'title' => 'SophonResult<List<ProcessTaskNumberDTO>>', + 'description' => 'The data that is returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '372D8B41-AF8D-573A-9B3F-0924950F241F', - ], - 'InOutputInfo' => [ + 'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'e866cce0-****-41de-817e-****8d5e2650'], + 'Data' => [ 'title' => '传输的数据', - 'description' => 'The execution result of the component action.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "actionUuid": "3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx",'."\n" - .' "outputSummary": {'."\n" - .' "datalist": ['."\n" - .' {'."\n" - .' "a": "a"'."\n" - .' }'."\n" - .' ],'."\n" - .' "total_data_successful": 1,'."\n" - .' "total_data": 1,'."\n" - .' "total_exe_successful": 1,'."\n" - .' "total_exe": 1,'."\n" - .' "total_data_with_dup": 1,'."\n" - .' "status": true'."\n" - .' },'."\n" - .' "outputSchema": {'."\n" - .' "a": "String",'."\n" - .' "startTime": "DateTime"'."\n" - .' },'."\n" - .' "inputParams": {'."\n" - .' "inputData": ['."\n" - .' {'."\n" - .' "outputFields": {'."\n" - .' "a": "a"'."\n" - .' }'."\n" - .' }'."\n" - .' ],'."\n" - .' "totalSize": 1'."\n" - .' },'."\n" - .' "startTime": "2023-11-13 17:47:28.645",'."\n" - .' "taskName": "92af3c79-1754-4646-9366-9ddbxxxxx"'."\n" - .'}', + 'description' => 'The data that is returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result set.', + 'type' => 'object', + 'properties' => [ + 'EntityUuid' => ['title' => '实体uuid', 'description' => 'The UUID of the entity.', 'type' => 'string', 'example' => 'a680c9ae-****-4c39-****-0302****fc8e'], + 'Count' => ['title' => '数量', 'description' => 'The number of tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '67'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"372D8B41-AF8D-573A-9B3F-0924950F241F\\",\\n \\"InOutputInfo\\": \\"{\\\\n \\\\\\"actionUuid\\\\\\": \\\\\\"3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx\\\\\\",\\\\n \\\\\\"outputSummary\\\\\\": {\\\\n \\\\\\"datalist\\\\\\": [\\\\n {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"total_data_successful\\\\\\": 1,\\\\n \\\\\\"total_data\\\\\\": 1,\\\\n \\\\\\"total_exe_successful\\\\\\": 1,\\\\n \\\\\\"total_exe\\\\\\": 1,\\\\n \\\\\\"total_data_with_dup\\\\\\": 1,\\\\n \\\\\\"status\\\\\\": true\\\\n },\\\\n \\\\\\"outputSchema\\\\\\": {\\\\n \\\\\\"a\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"DateTime\\\\\\"\\\\n },\\\\n \\\\\\"inputParams\\\\\\": {\\\\n \\\\\\"inputData\\\\\\": [\\\\n {\\\\n \\\\\\"outputFields\\\\\\": {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"totalSize\\\\\\": 1\\\\n },\\\\n \\\\\\"startTime\\\\\\": \\\\\\"2023-11-13 17:47:28.645\\\\\\",\\\\n \\\\\\"taskName\\\\\\": \\\\\\"92af3c79-1754-4646-9366-9ddbxxxxx\\\\\\"\\\\n}\\"\\n}","type":"json"}]', - 'title' => 'DescribeSoarRecordInOutput', - 'responseParamsDescription' => 'The value of **InOutputInfo** is a JSON string, which contains the following fields:'."\n" - ."\n" - .'* **actionUuid**: the UUID that is generated when the component action is performed.'."\n" - ."\n" - .'* **startTime**: the start time when the action of the component is performed.'."\n" - ."\n" - .'* **taskName**: the task name of the playbook in which the component action is specified.'."\n" - ."\n" - .'* **outputSchema**: the metadata of the output data for the component action. The metadata is in the JSON format and is defined when the playbook is orchestrated.'."\n" - ."\n" - .'* **outputSummary**: the output data of the component action. The data is in the JSON format and contains the following fields:'."\n" - ."\n" - .' * **datalist**: the details of the output data.'."\n" - .' * **total_data_successful**: the number of components that are successfully run.'."\n" - .' * **total_data**: the total number of components that are run.'."\n" - .' * **total_exe_successful**: the number of times that the running is successful.'."\n" - .' * **total_exe**: the total number of times for running.'."\n" - .' * **total_data_with_dup**: the number of times that the data is repeated.'."\n" - .' * **status**: indicates whether the component is successfully run. Valid values are **true** and **false**.'."\n" - ."\n" - .'* **inputParams**: the input data of the component action. The data is in the JSON format and contains the following fields:'."\n" - ."\n" - .' * **inputData**: the details of the input data.'."\n" - .' * **totalSize**: the number of input data entries.'."\n", - ], - 'DescribeSoarRecords' => [ - 'summary' => 'Get the execution records of a playbook.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e866cce0-****-41de-817e-****8d5e2650\\",\\n \\"Data\\": [\\n {\\n \\"EntityUuid\\": \\"a680c9ae-****-4c39-****-0302****fc8e\\",\\n \\"Count\\": 67\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the Number of Associated Disposal Tasks by Entity UUID', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTaskCount'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeProcessTaskNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeProcessTasks' => [ + 'summary' => 'Retrieves a list of response tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3962,556 +3546,284 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeCode' => '186031', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ - 'name' => 'PlaybookUuid', + 'name' => 'ProcessStrategyUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的UUID', - 'description' => 'The UUID of the playbook.'."\n" - .'> You can obtain this parameter by calling the [DescribePlaybooks](~~DescribePlaybooks~~) interface.', - 'type' => 'string', - 'required' => false, - 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', - ], + 'schema' => ['description' => 'The UUID of the response policy.'."\n" + ."\n" + .'> Call the [ListDisposeStrategy](~~2584440~~) operation to obtain this parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_****'], ], [ - 'name' => 'TaskflowMd5', + 'name' => 'EntityName', 'in' => 'query', - 'schema' => [ - 'title' => '任务的版本ID', - 'description' => 'The MD5 value of the playbook configuration.', - 'type' => 'string', - 'required' => false, - 'example' => 'be0a4ef084dd174abe478df52xxxxx', - ], + 'schema' => ['description' => 'The name of the entity to which the response is performed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '127.0.0.1'], ], [ - 'name' => 'StartMillis', + 'name' => 'EntityType', 'in' => 'query', - 'schema' => [ - 'title' => '任务开始时间', - 'description' => 'The start time of the task execution, in 13-digit timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1683526284584', - ], + 'schema' => ['description' => 'The type of the entity to which the response is performed. Valid values:'."\n" + ."\n" + .'- **ip**: an IP address.'."\n" + ."\n" + .'- **file**: a file.'."\n" + ."\n" + .'- **process**: a process.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ip'], ], [ - 'name' => 'EndMillis', + 'name' => 'SceneCode', 'in' => 'query', - 'schema' => [ - 'title' => '任务结束时间', - 'description' => 'The end time of the task execution, in 13-digit timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1683772744953', - ], + 'schema' => ['description' => 'The code of the response scenario.'."\n" + ."\n" + .'> Call the [DescribeEnumItems](~~DescribeEnumItems~~) operation to obtain this parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'event_xxx_whole_process'], ], [ - 'name' => 'Lang', + 'name' => 'TaskStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'Set the language type for requests and received messages. The default is **zh**. Values:'."\n" - .'- **zh**: Chinese'."\n" - .'- **en**: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The statuses of the response tasks. The value is a string in an array format. Valid values:'."\n" + ."\n" + .'- **11**: The task is in progress.'."\n" + ."\n" + .'- **21**: The entity is being blocked.'."\n" + ."\n" + .'- **22**: The entity is in isolation.'."\n" + ."\n" + .'- **23**: The task is complete.'."\n" + ."\n" + .'- **24**: The entity is added to the whitelist.'."\n" + ."\n" + .'- **20**: The task is successful.'."\n" + ."\n" + .'- **90**: The task failed.'."\n" + ."\n" + .'- **91**: Unblocking failed.'."\n" + ."\n" + .'- **92**: Removing the entity from isolation failed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '["11","21"]'], ], [ - 'name' => 'TriggerUser', + 'name' => 'Scope', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud account ID that executed the playbook task.', - 'type' => 'string', - 'required' => false, - 'example' => '127xxxx4392', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account for which the response task is performed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '125xxxxx9870'], ], [ - 'name' => 'TaskStatus', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the task execution. Values:'."\n" - ."\n" - .'- **success**: Successful task.'."\n" - .'- **failed**: Failed task.'."\n" - .'- **inprogress**: Task in progress', - 'type' => 'string', - 'required' => false, - 'example' => 'inprogress', - ], + 'schema' => ['description' => 'The source that triggers the response task. The value is a string in an array format. Valid values:'."\n" + ."\n" + .'- **system**: The task is triggered by manually responding to an event.'."\n" + ."\n" + .'- **custom**: The task is triggered by an automatic response rule for an event.'."\n" + ."\n" + .'- **custom\\_alert**: The task is triggered by an automatic response rule for an alert.'."\n" + ."\n" + .'- **soar-manual**: The task is triggered by a playbook that is manually run in Security Orchestration Automation Response (SOAR).'."\n" + ."\n" + .'- **soar-mdr**: The task is triggered by Managed Security Service.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '["system"]'], ], [ - 'name' => 'PageNumber', + 'name' => 'ProcessActionStart', 'in' => 'query', - 'schema' => [ - 'description' => 'Set which page to start displaying the query results from. The default value is 1, indicating the first page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The start of the time range to query response tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1700031183572'], ], [ - 'name' => 'PageSize', + 'name' => 'ProcessActionEnd', 'in' => 'query', - 'schema' => [ - 'description' => 'Specify the maximum number of data entries per page when performing a paginated query. The default number of entries per page is 20. If the PageSize parameter is empty, it will return 10 entries by default.'."\n" - .'> It is recommended not to leave the PageSize value empty.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end of the time range to query response tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1700031183572'], ], [ - 'name' => 'RequestUuid', + 'name' => 'ProcessRemoveStart', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'UUID of the playbook task execution.'."\n" - .'> You can obtain this parameter by calling the [DescribeSoarRecords](~~2627455~~) interface.', - 'example' => '6d412cfa-0905-4567-8a83-xxxxxx', - ], + 'schema' => ['description' => 'The start of the time range to query unblocking tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1700031183572'], ], [ - 'name' => 'TriggerType', + 'name' => 'ProcessRemoveEnd', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The end of the time range to query unblocking tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1700031183572'], ], [ - 'name' => 'QueryValue', + 'name' => 'ParamContent', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The keyword for a fuzzy search. The operation queries the entity, response scenario, and response parameter fields.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '12.x.x.x'], ], [ - 'name' => 'CompletedBeginTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. If you do not specify this parameter, 10 entries are returned.'."\n" + ."\n" + .'> Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'CompletedEndTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<List<SaoExecuteInfo>>', - 'description' => 'Return information.', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The ID of the current request, generated by Alibaba Cloud as a unique identifier for the request, which can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '601C2DAC-6A67-5237-BEE8-5BF1CEE96296', - ], - 'SoarExecuteRecords' => [ - 'title' => '传输的数据', - 'description' => 'Execution record result set.', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the execution records.', - 'type' => 'object', - 'properties' => [ - 'TriggerType' => [ - 'description' => 'The type of the playbook task. Values:'."\n" - ."\n" - .'- **debug**: Indicates a debugging task.'."\n" - .'- **manual**: Indicates a manual task.'."\n" - .'- **siem**: Indicates a task triggered by an event or alert.', - 'type' => 'string', - 'example' => 'debug', - ], - 'TaskName' => [ - 'description' => 'The name of the playbook task, which is the same as the playbook\'s UUID.', - 'type' => 'string', - 'example' => '82848ebc-eaff-4791-acd4-xxxxx', - ], - 'StartTime' => [ - 'description' => 'The start time of the task execution, in 13-digit timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1675823338433', - ], - 'EndTime' => [ - 'description' => 'The end time of the component execution, in 13-digit timestamp format.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686294686000', - ], - 'Status' => [ - 'description' => 'The status of the playbook task. Values:'."\n" - ."\n" - .'- **success**: Indicates successful execution.'."\n" - .'- **fail**: Indicates failed execution.'."\n" - .'- **running**: Indicates the task is running', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestUuid' => [ - 'description' => 'The request ID of the playbook task, a unique ID for each task run.', - 'type' => 'string', - 'example' => 'ba1ec480-aa90-4bb6-a1a7-9e311ae79321', - ], - 'TriggerUser' => [ - 'description' => 'The Alibaba Cloud account ID that executes the playbook task.', - 'type' => 'string', - 'example' => '127xxxx4392', - ], - 'ErrorMsg' => [ - 'description' => 'The error message of the playbook task. This field is empty when the task succeeds.', - 'type' => 'string', - 'example' => 'stime not match', - ], - 'RawEventReq' => [ - 'description' => 'The request parameters of the playbook task.', - 'type' => 'string', - 'example' => '{'."\n" - .' "input1": "xx.xx.xx.xx",'."\n" - .' "input2": "7d"'."\n" - .'}', - ], - 'TaskflowMd5' => [ - 'description' => 'The MD5 value of the playbook configuration.', - 'type' => 'string', - 'example' => 'dea65a3db87fb9bd84bbxxxxx', - ], - 'OutputList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'type' => 'string', - ], - 'NodeName' => [ - 'type' => 'string', - ], - 'ActionUuid' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'Page' => [ - 'description' => 'Information displayed on the page.', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of queried items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', - 'default' => '0', - ], - 'PageNumber' => [ - 'description' => 'The current page number in paginated queries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of items per page in paginated queries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'default' => '10', - ], - ], - 'required' => true, - ], - ], - ], + 'schema' => ['description' => 'The page number to return. Default value: 1. This value indicates the first page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"601C2DAC-6A67-5237-BEE8-5BF1CEE9*****\\",\\n \\"SoarExecuteRecords\\": [\\n {\\n \\"TriggerType\\": \\"debug\\",\\n \\"TaskName\\": \\"82848ebc-eaff-4791-acd4-xxxxx\\",\\n \\"StartTime\\": 1675823338433,\\n \\"EndTime\\": 1686294686000,\\n \\"Status\\": \\"success\\",\\n \\"RequestUuid\\": \\"ba1ec480-aa90-4bb6-a1a7-9e311ae*****\\",\\n \\"TriggerUser\\": \\"127xxxx4392\\",\\n \\"ErrorMsg\\": \\"stime not match\\",\\n \\"RawEventReq\\": \\"{\\\\n \\\\\\"input1\\\\\\": \\\\\\"xx.xx.xx.xx\\\\\\",\\\\n \\\\\\"input2\\\\\\": \\\\\\"7d\\\\\\"\\\\n}\\",\\n \\"TaskflowMd5\\": \\"dea65a3db87fb9bd84bbxxxxx\\",\\n \\"OutputList\\": [\\n {\\n \\"Content\\": \\" {\\\\\\"msg\\\\\\":\\\\\\"process has been killed\\\\\\",\\\\\\"code\\\\\\":\\\\\\"KillSuccess\\\\\\",\\\\\\"status\\\\\\":\\\\\\"success\\\\\\"}\\",\\n \\"NodeName\\": \\"TriggerPlaybook_4\\",\\n \\"ActionUuid\\": \\"4e78d665-2366-4485-8fbc-048a8d41a2c3-25****\\"\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 22,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'DescribeSoarRecords', - 'translator' => 'machine', - ], - 'DescribeSoarTaskAndActions' => [ - 'summary' => 'Queries the execution records of a component during the running of a playbook.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'YunCode', + 'in' => 'query', + 'schema' => ['description' => 'The cloud service associated with the response task. The value is a string in an array format. Valid values:'."\n" + ."\n" + .'- **WAF**: Web Application Firewall'."\n" + ."\n" + .'- **CFW**: Cloud Firewall'."\n" + ."\n" + .'- **Aegis**: Security Center', 'type' => 'string', 'required' => false, 'example' => '["WAF"]', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the response task.'."\n" + ."\n" + .'> Use this parameter to query a specific task. You can obtain the task ID from the response to a previous request.', 'type' => 'string', 'required' => false, 'example' => '150xxxxxxxxx95066', 'title' => ''], ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'RequestUuid', + 'name' => 'OrderField', 'in' => 'query', - 'schema' => [ - 'title' => '任务请求的UUID', - 'description' => 'The playbook UUID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1077f2f9-25e8-42d9-bfdf-1528e1313f6d', - ], + 'schema' => ['description' => 'The field by which to sort the query results.'."\n" + ."\n" + .'> You can obtain the field from the response.', 'type' => 'string', 'required' => false, 'example' => 'gmtCreate', 'title' => ''], ], [ - 'name' => 'Lang', + 'name' => 'Direction', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response.'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- **desc**: descending (default)'."\n" + ."\n" + .'- **asc**: ascending', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'EntityUuid', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The UUID of the entity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n"], ], [ - 'name' => 'PageSize', + 'name' => 'EventUuid', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The UUID of the event.', 'type' => 'string', 'required' => false, 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****', 'title' => ''], ], [ - 'name' => 'QueryValue', + 'name' => 'TriggerSource', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The source that triggers the response task. Valid values:'."\n" + ."\n" + .'- **system**: The task is triggered by manually responding to an event.'."\n" + ."\n" + .'- **custom**: The task is triggered by an automatic response rule for an event.'."\n" + ."\n" + .'- **custom\\_alert**: The task is triggered by an automatic response rule for an alert.'."\n" + ."\n" + .'- **soar-manual**: The task is triggered by a playbook that is manually run in SOAR.'."\n" + ."\n" + .'- **soar-mdr**: The task is triggered by Managed Security Service.', 'type' => 'string', 'required' => false, 'example' => 'system', 'title' => ''], ], [ - 'name' => 'QueryType', + 'name' => 'ReqUuid', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The playbook trigger ID.', 'type' => 'string', 'required' => false, 'example' => 'b73d0b08-f1bd-4e8f-967a-8e2982c9****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<SaoExecuteInfo>', - 'description' => 'The response parameters.'."\n", + 'title' => 'SophonResult<List<ProcessTaskDTO>>', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '18017A93-3D5D-503A-8308-914543F1CBA3', - ], - 'Details' => [ - 'title' => '传输的数据', - 'description' => 'The execution details of each task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TriggerType' => [ - 'description' => 'The task type. Valid values:'."\n" + 'RequestId' => ['description' => 'The ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'], + 'ProcessTasks' => [ + 'title' => '', + 'description' => 'A list of response tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the response task.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The unique ID of the response task.', 'type' => 'string', 'example' => '150xxxxxxxxx95066', 'title' => ''], + 'Creator' => ['description' => 'The ID of the Alibaba Cloud account that submitted the response task.', 'type' => 'string', 'title' => '', 'example' => '123xxxx355'], + 'GmtCreateMillis' => ['description' => 'The time when the response task was created. This value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1700031183572'], + 'GmtModifiedMillis' => ['description' => 'The time when the response task was last modified. This value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1700031183572'], + 'YunCode' => ['description' => 'The code of the cloud service that is associated with the response task.', 'type' => 'string', 'title' => '', 'example' => 'WAF'], + 'EntityName' => ['description' => 'The name of the entity to which the response was performed.', 'type' => 'string', 'title' => '', 'example' => '1.1.1.x'], + 'EntityType' => ['description' => 'The type of the entity to which the response was performed.', 'type' => 'string', 'title' => '', 'example' => 'ip'], + 'TaskStatus' => ['description' => 'The status of the response task.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '11'], + 'Scope' => ['description' => 'The ID of the Alibaba Cloud account for which the response task was performed.', 'type' => 'string', 'title' => '', 'example' => '123xxxxx234'], + 'InputParams' => ['description' => 'The input parameters of the response task.', 'type' => 'string', 'title' => '', 'example' => '{"groupuuid":"c6a9b1df-f4ac-4078-bef4-99xxxxxx"}'], + 'SceneCode' => ['description' => 'The code of the response scenario.', 'type' => 'string', 'title' => '', 'example' => 'event_xxx_whole_process'], + 'SceneName' => ['description' => 'The name of the response scenario.', 'type' => 'string', 'title' => '', 'example' => 'waf_whole_process'], + 'ProcessTime' => ['description' => 'The time when the response task was delivered. This value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1700031183572'], + 'RemoveTime' => ['description' => 'The time when the entity was unblocked. This value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1700031183572'], + 'ProcessStrategyUuid' => ['description' => 'The ID of the associated policy.', 'type' => 'string', 'title' => '', 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_****'], + 'Source' => ['description' => 'The source from which the response task was submitted.', 'type' => 'string', 'example' => 'system', 'title' => ''], + 'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'sts_openapi.Info.DefenseSceneNotSupported', 'title' => ''], + 'ErrMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ParamError : The parameters of your request are invalid', 'title' => ''], + 'ErrTip' => ['description' => 'The error message details.', 'type' => 'string', 'example' => 'Verify that the input parameters of the components are correct', 'title' => ''], + 'EntityUuid' => ['description' => 'The UUID of the entity.', 'type' => 'string', 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n", 'title' => ''], + 'EventUuid' => ['description' => 'The UUID of the event.', 'type' => 'string', 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****'."\n", 'title' => ''], + 'ReqUuid' => ['description' => 'The UUID of the playbook execution record.', 'type' => 'string', 'example' => '93e5df20-3d03-42e1-b44b-58197c71****'."\n", 'title' => ''], + 'TriggerSource' => ['description' => 'The source that triggers the response task. Valid values:'."\n" ."\n" - .'* **debug**: a debugging task'."\n" - .'* **manual**: a manual task'."\n" - .'* **siem**: an event-triggered task'."\n", - 'type' => 'string', - 'example' => 'siem', - ], - 'TaskName' => [ - 'description' => 'The name of the task. The value is the same as the playbook UUID.'."\n", - 'type' => 'string', - 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range during which the playbook is run. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1699868848645', - ], - 'EndTime' => [ - 'description' => 'The end of the time range during which the playbook is run. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1699868848767', - ], - 'Status' => [ - 'description' => 'The task status. Valid values:'."\n" + .'- **system**: The task is triggered by manually responding to an event.'."\n" ."\n" - .'* **success**'."\n" - .'* **fail**'."\n" - .'* **running**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestUuid' => [ - 'description' => 'The request ID of the task. The value is unique.'."\n", - 'type' => 'string', - 'example' => '17f75844-75cc-4174-86da-cec07a690142', - ], - 'TriggerUser' => [ - 'description' => 'The ID of the Alibaba Cloud account that triggers the task.'."\n", - 'type' => 'string', - 'example' => '127xxxx4392', - ], - 'ErrorMsg' => [ - 'description' => 'The error message of the task. If the task is successful, this field is empty.'."\n", - 'type' => 'string', - 'example' => 'stime not match', - ], - 'RawEventReq' => [ - 'description' => 'The request parameters of the task.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "input1": "xx.xx.xx.xx",'."\n" - .' "input2": "7d"'."\n" - .'}', - ], - 'Actions' => [ - 'description' => 'The list of component actions during the running of the playbook.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Component' => [ - 'description' => 'The component name.'."\n", - 'type' => 'string', - 'example' => 'DataFormat', - ], - 'Action' => [ - 'description' => 'The action name of the component.'."\n", - 'type' => 'string', - 'example' => 'formatdata', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range during which the component is run. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1699868848731', - ], - 'EndTime' => [ - 'description' => 'The end of the time range during which the component is run. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1699868848766', - ], - 'Status' => [ - 'description' => 'The running result of the component. Valid values:'."\n" - ."\n" - .'* **success**'."\n" - .'* **fail**'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ActionUuid' => [ - 'description' => 'The UUID of the component execution record.'."\n", - 'type' => 'string', - 'example' => '091be399-a937-4276-af78-xxxxxxxx', - ], - 'AssetName' => [ - 'description' => 'The name of the asset that is used by the component.'."\n", - 'type' => 'string', - 'example' => 'SLS Asset', - ], - 'NodeName' => [ - 'description' => 'The custom name of the node in the component.'."\n", - 'type' => 'string', - 'example' => 'DataFormat_1', - ], - ], - ], - ], - 'TaskFlowMd5' => [ - 'description' => 'The MD5 value of the playbook.'."\n", - 'type' => 'string', - 'example' => 'ed127287-6699-4e4d-b986-9f770879xxx', - ], - 'ActionLogNum' => [ - 'type' => 'integer', - 'format' => 'int32', + .'- **custom**: The task is triggered by an automatic response rule for an event.'."\n" + ."\n" + .'- **custom\\_alert**: The task is triggered by an automatic response rule for an alert.'."\n" + ."\n" + .'- **soar-manual**: The task is triggered by a playbook that is manually run in SOAR.'."\n" + ."\n" + .'- **soar-mdr**: The task is triggered by Managed Security Service.', 'type' => 'string', 'example' => 'system', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], 'Page' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'type' => 'string', - ], - 'PageNumber' => [ - 'type' => 'string', - ], - 'PageSize' => [ - 'type' => 'string', - ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"ProcessTasks\\": [\\n {\\n \\"TaskId\\": \\"150xxxxxxxxx95066\\",\\n \\"Creator\\": \\"123xxxx355\\",\\n \\"GmtCreateMillis\\": 1700031183572,\\n \\"GmtModifiedMillis\\": 1700031183572,\\n \\"YunCode\\": \\"WAF\\",\\n \\"EntityName\\": \\"1.1.1.x\\",\\n \\"EntityType\\": \\"ip\\",\\n \\"TaskStatus\\": 11,\\n \\"Scope\\": \\"123xxxxx234\\",\\n \\"InputParams\\": \\"{\\\\\\"groupuuid\\\\\\":\\\\\\"c6a9b1df-f4ac-4078-bef4-99xxxxxx\\\\\\"}\\",\\n \\"SceneCode\\": \\"event_xxx_whole_process\\",\\n \\"SceneName\\": \\"waf_whole_process\\",\\n \\"ProcessTime\\": 1700031183572,\\n \\"RemoveTime\\": 1700031183572,\\n \\"ProcessStrategyUuid\\": \\"92af3c79-1754-4646-9366-9ddbd1e45536_****\\",\\n \\"Source\\": \\"system\\",\\n \\"ErrCode\\": \\"sts_openapi.Info.DefenseSceneNotSupported\\",\\n \\"ErrMsg\\": \\"ParamError : The parameters of your request are invalid\\",\\n \\"ErrTip\\": \\"Verify that the input parameters of the components are correct\\",\\n \\"EntityUuid\\": \\"69d189e2-ec17-4676-a2fe-02969234****\\\\n\\",\\n \\"EventUuid\\": \\"c1020ce1-d6a5-11e8-8298-00163e10****\\\\n\\",\\n \\"ReqUuid\\": \\"93e5df20-3d03-42e1-b44b-58197c71****\\\\n\\",\\n \\"TriggerSource\\": \\"system\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProcessTasks', + 'description' => 'Before you call this operation, review the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for Threat Analysis and Response. Response orchestration is billed based on the volume of ingested log traffic.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTasks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeProcessTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18017A93-3D5D-503A-8308-914543F1CBA3\\",\\n \\"Details\\": {\\n \\"TriggerType\\": \\"siem\\",\\n \\"TaskName\\": \\"92af3c79-1754-4646-9366-9ddbd1e45536\\",\\n \\"StartTime\\": 1699868848645,\\n \\"EndTime\\": 1699868848767,\\n \\"Status\\": \\"success\\",\\n \\"RequestUuid\\": \\"17f75844-75cc-4174-86da-cec07a690142\\",\\n \\"TriggerUser\\": \\"127xxxx4392\\",\\n \\"ErrorMsg\\": \\"stime not match\\",\\n \\"RawEventReq\\": \\"{\\\\n \\\\\\"input1\\\\\\": \\\\\\"xx.xx.xx.xx\\\\\\",\\\\n \\\\\\"input2\\\\\\": \\\\\\"7d\\\\\\"\\\\n}\\",\\n \\"Actions\\": [\\n {\\n \\"Component\\": \\"DataFormat\\",\\n \\"Action\\": \\"formatdata\\",\\n \\"StartTime\\": 1699868848731,\\n \\"EndTime\\": 1699868848766,\\n \\"Status\\": \\"success\\",\\n \\"ActionUuid\\": \\"091be399-a937-4276-af78-xxxxxxxx\\",\\n \\"AssetName\\": \\"SLS Asset\\",\\n \\"NodeName\\": \\"DataFormat_1\\"\\n }\\n ],\\n \\"TaskFlowMd5\\": \\"ed127287-6699-4e4d-b986-9f770879xxx\\",\\n \\"ActionLogNum\\": 5\\n },\\n \\"Page\\": {\\n \\"TotalCount\\": \\"20\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeSoarTaskAndActions', ], - 'DescriberPython3ScriptLogs' => [ - 'summary' => 'Queries the operational logs of a Python3 script by using the UUID that is returned when the script is run. The UUID is specified by requestUuid.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeSoarRecordActionOutputList' => [ + 'summary' => 'Retrieves the output data generated by a component for an action in a playbook task.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4519,988 +3831,612 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RequestUuid', + 'name' => 'ActionUuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The UUID that is returned when the Python3 script is run.'."\n" - ."\n" - .'> You can call the [RunPython3Script](~~RunPython3Script~~) operation to query the UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '69edc2b4-c95c-424f-9114-xxxxxxx', - ], + 'schema' => ['description' => 'The UUID of the component action.'."\n" + ."\n" + .'> Call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) operation to get this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2202c90d-fa93-4726-bc32-xxxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned.'."\n" + ."\n" + .'> We recommend that you specify a value for this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the results to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<String>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D22D8A0C-6E86-57B2-A142-929184122AB1', - ], - 'RunResult' => [ - 'title' => '传输的数据', - 'description' => 'The operational logs of the Python3 script.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "logs": ['."\n" - .' {'."\n" - .' "message": "function input is {}"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], + 'RequestId' => ['description' => 'The ID of the request. It is a unique identifier generated by Alibaba Cloud. You can use it to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90'], + 'ActionOutputs' => ['description' => 'The output data from the component action. The data is in the JSONArray format.'."\n" + ."\n" + .'> The data format is determined by the component that you configure in the playbook.', 'type' => 'string', 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "a": "a",'."\n" + .' "taskname": "92af3c79-1754-4646-9366-9ddbd1e45536_xxxx",'."\n" + .' "log_time": 1699868849000'."\n" + .' }'."\n" + .']'], + 'PageNumber' => ['description' => 'The returned page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D22D8A0C-6E86-57B2-A142-929184122AB1\\",\\n \\"RunResult\\": \\"{\\\\n \\\\\\"logs\\\\\\": [\\\\n {\\\\n \\\\\\"message\\\\\\": \\\\\\"function input is {}\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n}","type":"json"}]', - 'title' => 'DescriberPython3ScriptLogs', - ], - 'ModifyComponentAsset' => [ - 'summary' => 'Modifies the information about the asset that is configured for a component.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90\\",\\n \\"ActionOutputs\\": \\"[\\\\n {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\",\\\\n \\\\\\"taskname\\\\\\": \\\\\\"92af3c79-1754-4646-9366-9ddbd1e45536_xxxx\\\\\\",\\\\n \\\\\\"log_time\\\\\\": 1699868849000\\\\n }\\\\n]\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => 'DescribeSoarRecordActionOutputList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordActionOutputList'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeSoarRecordActionOutputList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeSoarRecordInOutput' => [ + 'summary' => 'Retrieves the input and output data of a component action after a playbook task is executed.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AssetConfig', + 'name' => 'ActionUuid', 'in' => 'query', - 'schema' => [ - 'title' => '资产的配置', - 'description' => 'The configuration of the asset. The value is a JSON object.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "name": "test asset",'."\n" - .' "componentName": "SLS",'."\n" - .' "params": ['."\n" - .' {'."\n" - .' "name": "end_point",'."\n" - .' "value": "xxx"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "sub_id",'."\n" - .' "value": "xxxx"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "access_key",'."\n" - .' "value": "xxxx"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], + 'schema' => ['description' => 'The UUID of the component action.'."\n" + ."\n" + .'> Call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) API to get this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0531ff66-dd05-4f24-84bf-xxxxxxxx'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response.'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<Void>', - 'description' => 'The response parameters.'."\n", + 'title' => 'SophonResult<String>', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1C5F11E9-464E-51F0-9296-43BB312A0557', - ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '372D8B41-AF8D-573A-9B3F-0924950F241F'], + 'InOutputInfo' => ['description' => 'The execution result of the component action.', 'type' => 'string', 'title' => '', 'example' => '{'."\n" + .' "actionUuid": "3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx",'."\n" + .' "outputSummary": {'."\n" + .' "datalist": ['."\n" + .' {'."\n" + .' "a": "a"'."\n" + .' }'."\n" + .' ],'."\n" + .' "total_data_successful": 1,'."\n" + .' "total_data": 1,'."\n" + .' "total_exe_successful": 1,'."\n" + .' "total_exe": 1,'."\n" + .' "total_data_with_dup": 1,'."\n" + .' "status": true'."\n" + .' },'."\n" + .' "outputSchema": {'."\n" + .' "a": "String",'."\n" + .' "startTime": "DateTime"'."\n" + .' },'."\n" + .' "inputParams": {'."\n" + .' "inputData": ['."\n" + .' {'."\n" + .' "outputFields": {'."\n" + .' "a": "a"'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "totalSize": 1'."\n" + .' },'."\n" + .' "startTime": "2023-11-13 17:47:28.645",'."\n" + .' "taskName": "92af3c79-1754-4646-9366-9ddbxxxxx"'."\n" + .'}'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C5F11E9-464E-51F0-9296-43BB312A0557\\"\\n}","type":"json"}]', - 'title' => 'ModifyComponentAsset', - 'requestParamsDescription' => 'The following list describes the fields contained in the **AssetConfig** parameter:'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"372D8B41-AF8D-573A-9B3F-0924950F241F\\",\\n \\"InOutputInfo\\": \\"{\\\\n \\\\\\"actionUuid\\\\\\": \\\\\\"3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx\\\\\\",\\\\n \\\\\\"outputSummary\\\\\\": {\\\\n \\\\\\"datalist\\\\\\": [\\\\n {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"total_data_successful\\\\\\": 1,\\\\n \\\\\\"total_data\\\\\\": 1,\\\\n \\\\\\"total_exe_successful\\\\\\": 1,\\\\n \\\\\\"total_exe\\\\\\": 1,\\\\n \\\\\\"total_data_with_dup\\\\\\": 1,\\\\n \\\\\\"status\\\\\\": true\\\\n },\\\\n \\\\\\"outputSchema\\\\\\": {\\\\n \\\\\\"a\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"DateTime\\\\\\"\\\\n },\\\\n \\\\\\"inputParams\\\\\\": {\\\\n \\\\\\"inputData\\\\\\": [\\\\n {\\\\n \\\\\\"outputFields\\\\\\": {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"totalSize\\\\\\": 1\\\\n },\\\\n \\\\\\"startTime\\\\\\": \\\\\\"2023-11-13 17:47:28.645\\\\\\",\\\\n \\\\\\"taskName\\\\\\": \\\\\\"92af3c79-1754-4646-9366-9ddbxxxxx\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribeSoarRecordInOutput', + 'responseParamsDescription' => '**InOutputInfo** is a JSON string that contains the following fields:'."\n" ."\n" - .'* **name**: the asset name.'."\n" + .'- **actionUuid**: The UUID of the component action execution record.'."\n" ."\n" - .'* **componentName**: the component name.'."\n" + .'- **startTime**: The time when the component action started.'."\n" ."\n" - .'* **params**: the configuration information. Valid values:'."\n" + .'- **taskName**: The name of the playbook task that corresponds to the component action.'."\n" ."\n" - .' * **end_point**: the connection information.'."\n" - .' * **sub_id**: the AccessKey ID of the account.'."\n" - .' * **access_key**: the AccessKey secret of the account.'."\n", - ], - 'ModifyPlaybook' => [ - 'summary' => 'Modifies the configuration of a playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], - ], - 'parameters' => [ - [ - 'name' => 'PlaybookUuid', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '8baa6cff-319e-4ede-97bc-1586c35e61f8', - ], - ], - [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的展示名称', - 'description' => 'The display name of the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun_waf_test_playbook', - ], - ], - [ - 'name' => 'Taskflow', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本编辑配置', - 'description' => 'The XML configuration of the playbook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的描述', - 'description' => 'The description of the playbook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'demo test task', - ], - ], - [ - 'name' => 'Lang', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<Void>', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9B584F84-D66A-5525-8E7B-05612A903ABF', - ], + .'- **outputSchema**: The metadata of the action\'s output data. This is in JSON format and is defined during playbook orchestration.'."\n" + ."\n" + .'- **outputSummary**: The output parameters of the action. This is in JSON format and contains the following fields:'."\n" + ."\n" + .' - **datalist**: The details of the output data.'."\n" + ."\n" + .' - **total\\_data\\_successful**: The number of successfully executed data entries.'."\n" + ."\n" + .' - **total\\_data**: The total number of data entries.'."\n" + ."\n" + .' - **total\\_exe\\_successful**: The number of successful executions.'."\n" + ."\n" + .' - **total\\_exe**: The total number of executions.'."\n" + ."\n" + .' - **total\\_data\\_with\\_dup**: The number of duplicate data entries.'."\n" + ."\n" + .' - **status**: Indicates whether the execution was successful. **true** indicates success, and **false** indicates failure.'."\n" + ."\n" + .'- **inputParams**: The input data for the action. This is in JSON format and contains the following fields:'."\n" + ."\n" + .' - **inputData**: The specific input data for the action.'."\n" + ."\n" + .' - **totalSize**: The number of input data entries for the action.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordInOutput'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeSoarRecordInOutput', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B584F84-D66A-5525-8E7B-05612A903ABF\\"\\n}","type":"json"}]', - 'title' => 'ModifyPlaybook', ], - 'ModifyPlaybookInputOutput' => [ - 'summary' => 'Modifies the input and output parameters of a playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeSoarRecords' => [ + 'summary' => 'Queries the execution records for a playbook.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'PlaybookUuid', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx', - ], - ], - [ - 'name' => 'InputParams', - 'in' => 'formData', - 'schema' => [ - 'title' => '入参配置', - 'description' => 'The configuration of the input parameters. The value is a JSON array.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '['."\n" - .' {'."\n" - .' "typeName": "String",'."\n" - .' "dataClass": "normal",'."\n" - .' "dataType": "String",'."\n" - .' "description": "period",'."\n" - .' "example": "",'."\n" - .' "name": "period",'."\n" - .' "required": false'."\n" - .' }'."\n" - .']', - ], + 'in' => 'query', + 'schema' => ['title' => '剧本的UUID', 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> For more information, see [DescribePlaybooks](~~DescribePlaybooks~~).', 'type' => 'string', 'required' => false, 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx'], ], [ - 'name' => 'OutputParams', - 'in' => 'formData', - 'schema' => [ - 'title' => '出参配置', - 'description' => 'The configuration of the output parameters. This parameter is unavailable. Leave it empty.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[]', - ], + 'name' => 'TaskflowMd5', + 'in' => 'query', + 'schema' => ['title' => '任务的版本ID', 'description' => 'The MD5 value of the playbook configuration.', 'type' => 'string', 'required' => false, 'example' => 'be0a4ef084dd174abe478df52xxxxx'], ], [ - 'name' => 'ParamType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The input parameter type.'."\n" - ."\n" - .'* **template-ip**'."\n" - .'* **template-file**'."\n" - .'* **template-process**'."\n" - .'* **custom**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'custom', - ], + 'name' => 'StartMillis', + 'in' => 'query', + 'schema' => ['title' => '任务开始时间', 'description' => 'The start time of the task run. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526284584'], ], [ - 'name' => 'ExeConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The executed mode of a playbook. The value is a JSON array.', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "executeMode":"mul",'."\n" - .' "cron":"0 0 1 */1 * ?"'."\n" - .'}', - ], + 'name' => 'EndMillis', + 'in' => 'query', + 'schema' => ['title' => '任务结束时间', 'description' => 'The end time of the task run. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683772744953'], ], [ 'name' => 'Lang', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The language of the content within the request and response.'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<Void>', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8DDC07CE-D41B-5142-8D91-469462719C77', - ], - ], - ], + 'in' => 'query', + 'schema' => ['description' => 'The language of the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8DDC07CE-D41B-5142-8D91-469462719C77\\"\\n}","type":"json"}]', - 'title' => 'ModifyPlaybookInputOutput', - 'requestParamsDescription' => 'The value of the **InputParams** parameter is a JSON array, which contains the following fields:'."\n" - ."\n" - .'* typeName: the name of the parameter type.'."\n" - .'* dataClass: the level of the parameter type. This field is optional. **normal** specifies a common parameter and **custom** specifies a complex parameter.'."\n" - .'* dataType: the data type of the parameter. Valid values: **string, long, int, ip, file, and account**.'."\n" - .'* description: the parameter description.'."\n" - .'* example: the example parameter.'."\n" - .'* name: the parameter name.'."\n" - .'* required: specifies whether the parameter is required. Valid values: **true** and **false**.'."\n" - ."\n" - .'The value of the **ExeConfig** parameter is a JSON object, which contains the following fields:'."\n" - .'* executeMode: execution mode, fixed to **mul**.'."\n" - .'* cron: tCRON expression, following CRON standard.', - ], - 'PublishPlaybook' => [ - 'summary' => 'Publishes the playbook. After the playbook is published, the playbook runs based on the new logic.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsasK0Q1Y8', + 'name' => 'TriggerUser', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account that runs the playbook task.', 'type' => 'string', 'required' => false, 'example' => '127xxxx4392', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'PlaybookUuid', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The playbook UUID.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx', - ], + 'name' => 'TaskStatus', + 'in' => 'query', + 'schema' => ['description' => 'The status of the task run. Valid values:'."\n" + ."\n" + .'- **success**: The task is successful.'."\n" + ."\n" + .'- **failed**: The task failed.'."\n" + ."\n" + .'- **inprogress**: The task is in progress.', 'type' => 'string', 'required' => false, 'example' => 'inprogress', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的描述', - 'description' => 'The description of the released version.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a waf processing playbook', - 'maxLength' => 128, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<Void>', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF', - ], - ], - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF\\"\\n}","type":"json"}]', - 'title' => 'PublishPlaybook', - ], - 'QueryTreeData' => [ - 'summary' => 'Queries all playbooks at a time.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned on each page.'."\n" + ."\n" + .'> Specify a value for PageSize.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'Lang', + 'name' => 'RequestUuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the response. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese (default)'."\n" - .'* **en**: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<String>', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2', - ], - 'Playbooks' => [ - 'title' => '传输的数据', - 'description' => 'The returned information about the playbook. The value is a JSON string.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "playbook": {'."\n" - .' "active": false,'."\n" - .' "displayName": "test_playbook",'."\n" - .' "playbookUuid": "09a20455-3d3a-424c-a1df-xxxxxx"'."\n" - .' }'."\n" - .' }'."\n" - .']', - ], - ], - ], + 'schema' => ['description' => 'The UUID of the playbook task execution.'."\n" + ."\n" + .'> For more information, see [DescribeSoarRecords](~~2627455~~).', 'type' => 'string', 'required' => false, 'example' => '6d412cfa-0905-4567-8a83-xxxxxx', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2\\",\\n \\"Playbooks\\": \\"[\\\\n {\\\\n \\\\\\"playbook\\\\\\": {\\\\n \\\\\\"active\\\\\\": false,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"test_playbook\\\\\\",\\\\n \\\\\\"playbookUuid\\\\\\": \\\\\\"09a20455-3d3a-424c-a1df-xxxxxx\\\\\\"\\\\n }\\\\n }\\\\n]\\"\\n}","type":"json"}]', - 'title' => 'QueryTreeData', - 'responseParamsDescription' => 'The following list describes the fields that are contained in the value of the **Playbooks** parameter:'."\n" - ."\n" - .'* **active**: indicates whether the playbook is started. Valid values: **true** and **false**.'."\n" - .'* **displayName**: the playbook name.'."\n" - .'* **playbookUuid**: the playbook UUID.'."\n", - ], - 'RevertPlaybookRelease' => [ - 'summary' => 'Rolls back a playbook to a specific version. You can determine whether to publish the new playbook version during the rollback.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', + 'name' => 'TriggerType', + 'in' => 'query', + 'schema' => ['description' => 'The trigger type of the task. Valid values:'."\n" + ."\n" + .'- **stream**: stream'."\n" + ."\n" + .'- **debug**: test'."\n" + ."\n" + .'- **manual**: manual'."\n" + ."\n" + .'- **timer**: scheduled'."\n" + ."\n" + .'- **SubInvoke**: child flow'."\n" + ."\n" + .'- **siem**: triggered by a SIEM product', 'type' => 'string', 'required' => false, 'example' => 'debug', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'PlaybookUuid', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '185295a1-c987-4b64-8796-xxxxxxxx', - ], + 'name' => 'QueryValue', + 'in' => 'query', + 'schema' => ['description' => 'The input parameter of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'input', 'title' => ''], ], [ - 'name' => 'PlayReleaseId', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的发布记录ID', - 'description' => 'The version of the playbook that you want to publish.'."\n" - ."\n" - .'> You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to query the playbook version.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3f97b56e-064e-47e7-a309-xxxxxxx', - ], + 'name' => 'CompletedBeginTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time when the task was completed. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1755676363777', 'title' => ''], ], [ - 'name' => 'IsPublish', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否回滚发布', - 'description' => 'Specifies whether to directly publish the new playbook after the rollback.'."\n" - ."\n" - .'* **true** (default)'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'CompletedEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time when the task was completed. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526284584', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<Void>', - 'description' => 'The response parameters.'."\n", + 'title' => 'SophonResult<List<SaoExecuteInfo>>', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573', + 'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The unique request ID, generated by Alibaba Cloud. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '601C2DAC-6A67-5237-BEE8-5BF1CEE9*****'], + 'SoarExecuteRecords' => [ + 'title' => '传输的数据', + 'description' => 'The execution records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an execution record.', + 'type' => 'object', + 'properties' => [ + 'TriggerType' => ['description' => 'The type of the playbook task. Valid values:'."\n" + ."\n" + .'- **debug**: a test task'."\n" + ."\n" + .'- **manual**: a one-time task'."\n" + ."\n" + .'- **siem**: a task that is triggered by an event or alert', 'type' => 'string', 'example' => 'debug', 'title' => ''], + 'TaskName' => ['description' => 'The name of the playbook task. The value is the UUID of the playbook.', 'type' => 'string', 'example' => '82848ebc-eaff-4791-acd4-xxxxx', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the task run. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1675823338433', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the component run. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686294686000', 'title' => ''], + 'Status' => ['description' => 'The status of the playbook task. Valid values:'."\n" + ."\n" + .'- **success**: The execution is successful.'."\n" + ."\n" + .'- **fail**: The execution failed.'."\n" + ."\n" + .'- **running**: The execution is in progress.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestUuid' => ['description' => 'The request ID of the playbook task. The ID is unique for each task run.', 'type' => 'string', 'example' => 'ba1ec480-aa90-4bb6-a1a7-9e311ae*****', 'title' => ''], + 'TriggerUser' => ['description' => 'The ID of the Alibaba Cloud account that runs the playbook task.', 'type' => 'string', 'example' => '127xxxx4392', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message of the playbook task. This parameter is empty if the task is successful.', 'type' => 'string', 'example' => 'stime not match', 'title' => ''], + 'RawEventReq' => ['description' => 'The request parameters of the playbook task.', 'type' => 'string', 'example' => '{'."\n" + .' "input1": "xx.xx.xx.xx",'."\n" + .' "input2": "7d"'."\n" + .'}', 'title' => ''], + 'TaskflowMd5' => ['description' => 'The MD5 value of the playbook configuration.', 'type' => 'string', 'example' => 'dea65a3db87fb9bd84bbxxxxx', 'title' => ''], + 'OutputList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The output content.', 'type' => 'string', 'example' => ' {"msg":"process has been killed","code":"KillSuccess","status":"success"}', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node that generates the output.', 'type' => 'string', 'example' => 'TriggerPlaybook_4', 'title' => ''], + 'ActionUuid' => ['description' => 'The UUID of the node.', 'type' => 'string', 'example' => '4e78d665-2366-4485-8fbc-048a8d41a2c3-25****', 'title' => ''], + ], + 'description' => 'JSONArray', + 'title' => '', + 'example' => '', + ], + 'description' => 'The output information of the playbook.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Page' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'example' => '22', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'example' => '10', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3FED5B9-190A-5952-93A4-24FBF0F0C573\\"\\n}","type":"json"}]', - 'title' => 'RevertPlaybookRelease', - ], - 'TriggerPlaybook' => [ - 'summary' => 'Triggers an enabled custom playbook or a predefined playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"601C2DAC-6A67-5237-BEE8-5BF1CEE9*****\\",\\n \\"SoarExecuteRecords\\": [\\n {\\n \\"TriggerType\\": \\"debug\\",\\n \\"TaskName\\": \\"82848ebc-eaff-4791-acd4-xxxxx\\",\\n \\"StartTime\\": 1675823338433,\\n \\"EndTime\\": 1686294686000,\\n \\"Status\\": \\"success\\",\\n \\"RequestUuid\\": \\"ba1ec480-aa90-4bb6-a1a7-9e311ae*****\\",\\n \\"TriggerUser\\": \\"127xxxx4392\\",\\n \\"ErrorMsg\\": \\"stime not match\\",\\n \\"RawEventReq\\": \\"{\\\\n \\\\\\"input1\\\\\\": \\\\\\"xx.xx.xx.xx\\\\\\",\\\\n \\\\\\"input2\\\\\\": \\\\\\"7d\\\\\\"\\\\n}\\",\\n \\"TaskflowMd5\\": \\"dea65a3db87fb9bd84bbxxxxx\\",\\n \\"OutputList\\": [\\n {\\n \\"Content\\": \\" {\\\\\\"msg\\\\\\":\\\\\\"process has been killed\\\\\\",\\\\\\"code\\\\\\":\\\\\\"KillSuccess\\\\\\",\\\\\\"status\\\\\\":\\\\\\"success\\\\\\"}\\",\\n \\"NodeName\\": \\"TriggerPlaybook_4\\",\\n \\"ActionUuid\\": \\"4e78d665-2366-4485-8fbc-048a8d41a2c3-25****\\"\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 22,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSoarRecords', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecords'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'PlaybookUuid', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The playbook UUID.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the playbook UUID.', - 'type' => 'string', - 'required' => true, - 'example' => '2a687089-d4dd-47d4-9709-xxxxxxxx', - ], - ], + 'ramActions' => [ [ - 'name' => 'InputParam', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的入参', - 'description' => 'The input parameters of the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "input1": "xx.xx.xx.xx",'."\n" - .' "input2": "7d"'."\n" - .'}'."\n", - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<PlaybookTriggerDTO>', - 'description' => 'The returned message.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BD5A8DB6-A42C-532B-BCE8-83E69550CD59', - ], - 'TriggerUuid' => [ - 'description' => 'The running UUID of the playbook. This parameter is used to query the running result of the playbook.'."\n", - 'type' => 'string', - 'example' => '55E63C57-D6C8-5036-A770-5CB10AC807AA', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeSoarRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD5A8DB6-A42C-532B-BCE8-83E69550CD59\\",\\n \\"TriggerUuid\\": \\"55E63C57-D6C8-5036-A770-5CB10AC807AA\\"\\n}","type":"json"}]', - 'title' => 'TriggerPlaybook', - 'description' => 'Before you call this operation, make sure that you understand the billing methods and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.alibabacloud.com/en/pricing-calculator?_p_lc=1&spm=a2796.7960336.3034855210.1.7adab91arMeIx2#/commodity/vm_intl).', ], - 'TriggerSophonPlaybook' => [ - 'summary' => 'Triggers a playbook or a command.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSoarTaskAndActions' => [ + 'summary' => 'Retrieves the component execution records for a single playbook run.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '149322', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'CommandName', + 'name' => 'RequestUuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the command that you want to trigger.'."\n" - ."\n" - .'> You can call the [DescribeSophonCommands](~~DescribeSophonCommands~~) operation to query the command name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'waf_process_command', - ], + 'schema' => ['description' => 'The UUID of the playbook task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1077f2f9-25e8-42d9-bfdf-1528e1313f6d'], ], [ - 'name' => 'InputParams', + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The input parameters of the command or playbook that you want to trigger.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "param1": "xx.xx.xx.xx",'."\n" - .' "param2": "7d"'."\n" - .'}', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ - 'name' => 'SophonTaskId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom ID. If you do not specify this parameter when the playbook is triggered, a random ID is generated for fault locating and troubleshooting.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Uuid', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx', - ], + 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 20. If you do not specify this parameter, 10 entries are returned.'."\n" + ."\n" + .'> Specify a value for this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'TriggerType', + 'name' => 'QueryValue', 'in' => 'query', - 'schema' => [ - 'description' => 'The task type. Valid values:'."\n" - ."\n" - .'* **command**'."\n" - .'* **playbook**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'playbook', - ], + 'schema' => ['description' => 'The input parameter of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'input', 'title' => ''], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => ['description' => 'The trigger type of the task. Valid values:'."\n" + ."\n" + .'- **stream**: The task is triggered by a data stream.'."\n" + ."\n" + .'- **debug**: The task is triggered by a debugging process.'."\n" + ."\n" + .'- **manual**: The task is triggered manually.'."\n" + ."\n" + .'- **timer**: The task is triggered by a timer.'."\n" + ."\n" + .'- **SubInvoke**: The task is triggered by a child flow.', 'type' => 'string', 'required' => false, 'example' => 'debug', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<SophonTaskResult>', - 'description' => 'The returned message.'."\n", + 'title' => 'SophonResult<SaoExecuteInfo>', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The details that is returned after the command or playbook is triggered.'."\n", + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '18017A93-3D5D-503A-8308-914543F1CBA3'], + 'Details' => [ + 'title' => '', + 'description' => 'The details of the task execution.', 'type' => 'object', 'properties' => [ - 'SophonTaskId' => [ - 'description' => 'The custom ID. If you do not specify this parameter when the playbook is triggered, a random ID is generated for fault locating and troubleshooting.'."\n", - 'type' => 'string', - 'example' => 'a7c6d055-a72f-4676-bc89-3cd9edc0284c', + 'TriggerType' => ['description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- **debug**: A task for debugging a playbook.'."\n" + ."\n" + .'- **manual**: A manually triggered task.'."\n" + ."\n" + .'- **siem**: An event-triggered task.', 'type' => 'string', 'example' => 'siem', 'title' => ''], + 'TaskName' => ['description' => 'The name of the playbook task. This is the same as the playbook UUID.', 'type' => 'string', 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the playbook run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848645', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the playbook run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848767', 'title' => ''], + 'Status' => ['description' => 'The status of the playbook task. Valid values:'."\n" + ."\n" + .'- **success**: The task was successful.'."\n" + ."\n" + .'- **fail**: The task failed.'."\n" + ."\n" + .'- **running**: The task is running.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestUuid' => ['description' => 'The request ID of the playbook task. This is the unique ID for each task run.', 'type' => 'string', 'example' => '17f75844-75cc-4174-86da-cec07a690142', 'title' => ''], + 'TriggerUser' => ['description' => 'The ID of the Alibaba Cloud account that triggered the playbook task.', 'type' => 'string', 'example' => '127xxxx4392', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message for the playbook task. This field is empty if the task is successful.', 'type' => 'string', 'example' => 'stime not match', 'title' => ''], + 'RawEventReq' => ['description' => 'The request parameters of the playbook task.', 'type' => 'string', 'example' => '{'."\n" + .' "input1": "xx.xx.xx.xx",'."\n" + .' "input2": "7d"'."\n" + .'}', 'title' => ''], + 'Actions' => [ + 'description' => 'The list of component actions executed in the playbook.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a component action executed in the playbook.', + 'type' => 'object', + 'properties' => [ + 'Component' => ['description' => 'The name of the component.', 'type' => 'string', 'example' => 'DataFormat', 'title' => ''], + 'Action' => ['description' => 'The name of the component action.', 'type' => 'string', 'example' => 'formatdata', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the component run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848731', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the component run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848766', 'title' => ''], + 'Status' => ['description' => 'The result of the component run. Valid values:'."\n" + ."\n" + .'- **success**: The run was successful.'."\n" + ."\n" + .'- **fail**: The run failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ActionUuid' => ['description' => 'The UUID of the component action execution record.', 'type' => 'string', 'example' => '091be399-a937-4276-af78-xxxxxxxx', 'title' => ''], + 'AssetName' => ['description' => 'The name of the asset used by the component.', 'type' => 'string', 'example' => 'SLS Asset', 'title' => ''], + 'NodeName' => ['description' => 'The custom node name of the component.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TaskFlowMd5' => ['description' => 'The MD5 value of the playbook configuration that was run.', 'type' => 'string', 'example' => 'ed127287-6699-4e4d-b986-9f770879xxx', 'title' => ''], + 'ActionLogNum' => ['description' => 'The total number of action logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54', + 'Page' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'string', 'example' => '10', 'title' => ''], + ], + 'description' => 'The pagination information.', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SophonTaskId\\": \\"a7c6d055-a72f-4676-bc89-3cd9edc0284c\\"\\n },\\n \\"RequestId\\": \\"0DFC9403-54EB-5672-B690-9AA93C9EBB54\\"\\n}","type":"json"}]', - 'title' => 'TriggerSophonPlaybook', - 'description' => 'Before you call this operation, make sure that you understand the billing methods and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.alibabacloud.com/en/pricing-calculator?_p_lc=1&spm=a2796.7960336.3034855210.1.7adab91arMeIx2#/commodity/vm_intl).', - ], - 'VerifyPlaybook' => [ - 'summary' => 'Checks whether the configuration of the playbook is correct and whether the logic of the orchestration is reasonable.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18017A93-3D5D-503A-8308-914543F1CBA3\\",\\n \\"Details\\": {\\n \\"TriggerType\\": \\"siem\\",\\n \\"TaskName\\": \\"92af3c79-1754-4646-9366-9ddbd1e45536\\",\\n \\"StartTime\\": 1699868848645,\\n \\"EndTime\\": 1699868848767,\\n \\"Status\\": \\"success\\",\\n \\"RequestUuid\\": \\"17f75844-75cc-4174-86da-cec07a690142\\",\\n \\"TriggerUser\\": \\"127xxxx4392\\",\\n \\"ErrorMsg\\": \\"stime not match\\",\\n \\"RawEventReq\\": \\"{\\\\n \\\\\\"input1\\\\\\": \\\\\\"xx.xx.xx.xx\\\\\\",\\\\n \\\\\\"input2\\\\\\": \\\\\\"7d\\\\\\"\\\\n}\\",\\n \\"Actions\\": [\\n {\\n \\"Component\\": \\"DataFormat\\",\\n \\"Action\\": \\"formatdata\\",\\n \\"StartTime\\": 1699868848731,\\n \\"EndTime\\": 1699868848766,\\n \\"Status\\": \\"success\\",\\n \\"ActionUuid\\": \\"091be399-a937-4276-af78-xxxxxxxx\\",\\n \\"AssetName\\": \\"SLS Asset\\",\\n \\"NodeName\\": \\"DataFormat_1\\"\\n }\\n ],\\n \\"TaskFlowMd5\\": \\"ed127287-6699-4e4d-b986-9f770879xxx\\",\\n \\"ActionLogNum\\": 5\\n },\\n \\"Page\\": {\\n \\"TotalCount\\": \\"20\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSoarTaskAndActions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarTaskAndActions'], ], ], - 'parameters' => [ - [ - 'name' => 'PlaybookUuid', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本UUID', - 'description' => 'The playbook UUID.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the playbook UUID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9fcd3829-80ff-4681-be1e-4d2662c35fed', - ], - ], + 'ramActions' => [ [ - 'name' => 'TaskFlow', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本编辑配置', - 'description' => 'The XML configuration of the playbook.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<List<CheckTaskInfo>>', - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54', - ], - 'CheckTaskInfos' => [ - 'title' => '传输的数据', - 'description' => 'The result of the verification.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RiskLevel' => [ - 'description' => 'The severity level of the verification information. Valid values:'."\n" - ."\n" - .'* warn: An issue may occur during playbook running.'."\n" - .'* error: The playbook cannot be compiled.'."\n" - .'* remind: The publishing and running of the playbook are not affected. We recommend that you optimize the playbook format.'."\n", - 'type' => 'string', - 'example' => 'error', - ], - 'NodeName' => [ - 'description' => 'The name of the node in the playbook.'."\n", - 'type' => 'string', - 'example' => 'python3_3', - ], - 'Detail' => [ - 'description' => 'The error message returned when the playbook does not pass the check.'."\n", - 'type' => 'string', - 'example' => 'Node [python3_3] doesn\'t have the asset information', - ], - ], - ], - ], - 'Prerequisites' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PrerequisiteType' => [ - 'type' => 'string', - ], - 'PrerequisiteValue' => [ - 'type' => 'string', - ], - ], - ], - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeSoarTaskAndActions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DFC9403-54EB-5672-B690-9AA93C9EBB54\\",\\n \\"CheckTaskInfos\\": [\\n {\\n \\"RiskLevel\\": \\"error\\",\\n \\"NodeName\\": \\"python3_3\\",\\n \\"Detail\\": \\"Node [python3_3] doesn\'t have the asset information\\"\\n }\\n ],\\n \\"Prerequisites\\": [\\n {\\n \\"PrerequisiteType\\": \\"role\\",\\n \\"PrerequisiteValue\\": \\"AliyunSiemSoarExecutionDefaultRole\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'VerifyPlaybook', ], - 'VerifyPythonFile' => [ - 'summary' => 'Checks whether the syntax of a Python code snippet is correct.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeSophonCommands' => [ + 'summary' => 'Queries the commands that are used to manage entities.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5508,236 +4444,93 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Python code snippet.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'import logging'."\n" - .'def execute (params):'."\n" - .' success=True'."\n" - .' message=\'OK\''."\n" - .' data=[]'."\n" - .' return (success,message,data)', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the command. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'waf_process', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<PythonVerifyDTO>', - 'description' => 'The data returned.'."\n", + 'title' => 'SophonResult<List<SophonCommandBO>>', + 'description' => 'The returned information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F72685FB-A6E6-5A9A-97F7-6DC1056E63CE', - ], - 'Syntax' => [ - 'description' => 'The verification result. If the parameter is left empty, the syntax of the code snippet is correct.'."\n", + 'Data' => [ + 'title' => '', + 'description' => 'The list of returned commands.', 'type' => 'array', 'items' => [ + 'description' => 'The details of the command.', 'type' => 'object', 'properties' => [ - 'StartLineNumber' => [ - 'description' => 'The number that indicates the start line of the error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'StartColumn' => [ - 'description' => 'The number that indicates the start column of the error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'EndLineNumber' => [ - 'description' => 'The number that indicates the end line of the error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'EndColumn' => [ - 'description' => 'The number that indicates the end column of the error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Message' => [ - 'description' => 'The error message for the error code.'."\n", - 'type' => 'string', - 'example' => 'undefined name \'ab\'', - ], - 'Severity' => [ - 'description' => 'The severity level of the error code. Valid values:'."\n" - ."\n" - .'* 4: moderate'."\n" - .'* 8: serious'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - 4 => '', - 8 => '', + 'Name' => ['description' => 'The name of the command.', 'type' => 'string', 'example' => 'waf_process_ip_v2', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the command.', 'type' => 'string', 'example' => 'WAF Process IP', 'title' => ''], + 'ParamConfig' => [ + 'description' => 'The parameter settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter settings.', + 'type' => 'object', + 'properties' => [ + 'Necessary' => ['description' => 'Indicates whether the parameter is required. Valid values:'."\n" + ."\n" + .'- **true**: The parameter is required. This is the default value.'."\n" + ."\n" + .'- **false**: The parameter is optional.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Field' => ['description' => 'The name of the parameter field.', 'type' => 'string', 'example' => 'ip', 'title' => ''], + 'Value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => '12.xx.xx.xx', 'title' => ''], + 'CheckField' => ['description' => 'The regular expression that is used to check the format of the field. If this parameter is empty, no check is performed.', 'type' => 'string', 'example' => '[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => '4', + 'title' => '', + 'example' => '', ], + 'Description' => ['description' => 'The description of the command.', 'type' => 'string', 'example' => 'This is a action of processing for WAF', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => '1E1EC464-3BD7-518F-9937-BCC12E6855FE', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 491 => [ - [ - 'errorCode' => 'Playbook.External.ParamError', - 'errorMessage' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F72685FB-A6E6-5A9A-97F7-6DC1056E63CE\\",\\n \\"Syntax\\": [\\n {\\n \\"StartLineNumber\\": 2,\\n \\"StartColumn\\": 2,\\n \\"EndLineNumber\\": 5,\\n \\"EndColumn\\": 5,\\n \\"Message\\": \\"undefined name \'ab\'\\",\\n \\"Severity\\": 4\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'VerifyPythonFile', - ], - 'DescribeProcessStatistics' => [ - 'summary' => 'Queries statistics.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '208550', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"waf_process_ip_v2\\",\\n \\"DisplayName\\": \\"WAF Process IP\\",\\n \\"ParamConfig\\": [\\n {\\n \\"Necessary\\": true,\\n \\"Field\\": \\"ip\\",\\n \\"Value\\": \\"12.xx.xx.xx\\",\\n \\"CheckField\\": \\"[0-9]{4}\\\\\\\\.[0-9]{4}\\\\\\\\.[0-9]{4}\\\\\\\\.[0-9]{4}\\"\\n }\\n ],\\n \\"Description\\": \\"This is a action of processing for WAF\\"\\n }\\n ],\\n \\"RequestId\\": \\"1E1EC464-3BD7-518F-9937-BCC12E6855FE\\"\\n}","type":"json"}]', + 'title' => 'DescribeSophonCommands', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSophonCommands'], ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'RoleType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view. Valid values:'."\n" - ."\n" - .'* 0 (default): the view of the current Alibaba Cloud account.'."\n" - .'* 1: the view of all accounts for the enterprise.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'RoleFor', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1709821xxxxx3093', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'SophonResult<ProcessMetricsDTO>', - 'description' => 'SophonResult'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F', - ], - 'Metrics' => [ - 'title' => '传输的数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskNum' => [ - 'description' => 'The number of handling tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BanIpNum' => [ - 'description' => 'The number of blocked IP addresses.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BanFileNum' => [ - 'description' => 'The number of blocked files.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BanProcessNum' => [ - 'description' => 'The number of blocked processes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeSophonCommands', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F\\",\\n \\"Metrics\\": {\\n \\"TaskNum\\": 1,\\n \\"BanIpNum\\": 1,\\n \\"BanFileNum\\": 1,\\n \\"BanProcessNum\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'DescribeProcessStatistics', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", ], - 'DescribeProcessTasks' => [ - 'summary' => 'Queries the information about handling tasks. When you use Security Orchestration Automation Response (SOAR) to handle events, handling tasks are generated in the handling center.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeVendorApiList' => [ + 'summary' => 'Queries the API operations of a cloud service provider.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5749,499 +4542,155 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '186031', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ProcessStrategyUuid', - 'in' => 'query', - 'schema' => [ - 'title' => '处置策略ID', - 'description' => 'The UUID of the handling policy.'."\n" - ."\n" - .'> You can call the [ListDisposeStrategy](~~2584440~~) operation to query the UUID of the handling policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_xxxx', - ], - ], - [ - 'name' => 'EntityName', - 'in' => 'query', - 'schema' => [ - 'title' => '实体的名称', - 'description' => 'The name of the handling entity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], - ], - [ - 'name' => 'EntityType', - 'in' => 'query', - 'schema' => [ - 'title' => '实体的类型', - 'description' => 'The type of the handling entity. Valid values:'."\n" - ."\n" - .'* **ip**.'."\n" - .'* **file**.'."\n" - .'* **process**.', - 'type' => 'string', - 'required' => false, - 'example' => 'ip', - ], - ], - [ - 'name' => 'SceneCode', - 'in' => 'query', - 'schema' => [ - 'title' => '处置场景', - 'description' => 'The scenario code of the handling task.'."\n" - ."\n" - .'> You can call the [DescribeEnumItems](~~DescribeEnumItems~~) operation to query the scenario code of the handling task. This parameter is available when you set **EnumType** to **process**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'event_xxx_whole_process', - ], - ], - [ - 'name' => 'TaskStatus', - 'in' => 'query', - 'schema' => [ - 'title' => '任务状态 list', - 'description' => 'The status of the handling task. The value is a string. Valid values:'."\n" - ."\n" - .'* **11**: being handled.'."\n" - .'* **21**: being blocked.'."\n" - .'* **22**: being quarantined.'."\n" - .'* **23**: completed.'."\n" - .'* **24**: added to the whitelist.'."\n" - .'* **20**: successful.'."\n" - .'* **90**: failed.'."\n" - .'* **91**: unblocking failed.'."\n" - .'* **92**: restoring quarantined files failed', - 'type' => 'string', - 'required' => false, - 'example' => '["11","21"]', - ], - ], - [ - 'name' => 'Scope', - 'in' => 'query', - 'schema' => [ - 'title' => '作用域', - 'description' => 'The ID of the Alibaba Cloud account that is specified in the handling task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '125xxxxx9870', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'title' => '处置来源 list', - 'description' => 'The triggering source of the handling task. The value is a string array. Valid values:'."\n" - ."\n" - .'* **system**: triggered when you manually handle an event.'."\n" - .'* **custom**: triggered by an event based on an automatic response rule.'."\n" - .'* **custom_alert**: triggered by an alert based on an automatic response rule.'."\n" - .'* **soar-manual**: triggered when you use SOAR to manually run a playbook.'."\n" - .'* **soar-mdr**: triggered by Managed Security Service.', - 'type' => 'string', - 'required' => false, - 'example' => '["system"]', - ], - ], - [ - 'name' => 'ProcessActionStart', - 'in' => 'query', - 'schema' => [ - 'title' => '处置时间的查询开始时间', - 'description' => 'The beginning of the time range for a handling task. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1700031183572', - ], - ], - [ - 'name' => 'ProcessActionEnd', - 'in' => 'query', - 'schema' => [ - 'title' => '处置时间的查询结束时间', - 'description' => 'The end of the time range for a handling task. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1700031183572', - ], - ], - [ - 'name' => 'ProcessRemoveStart', - 'in' => 'query', - 'schema' => [ - 'title' => '解封时间的查询开始时间', - 'description' => 'The beginning of the time range for an unblocking task. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1700031183572', - ], - ], - [ - 'name' => 'ProcessRemoveEnd', - 'in' => 'query', - 'schema' => [ - 'title' => '解封时间的查询结束时间', - 'description' => 'The end of the time range for an unblocking task. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1700031183572', - ], - ], - [ - 'name' => 'ParamContent', - 'in' => 'query', - 'schema' => [ - 'title' => '模糊查询', - 'description' => 'The handling entity, handling scenario, or handling parameter that is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12.x.x.x', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. If you do not specify the PageSize parameter, 10 entries are returned by default.'."\n" - ."\n" - .'> We recommend that you do not leave this parameter empty.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'YunCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud service that is associated with the handling task. The value is a string. Valid values:'."\n" - ."\n" - .'* **WAF**: Web Application Firewall (WAF).'."\n" - .'* **CFW**: Cloud Firewall.'."\n" - .'* **Aegis**: Security Center.', - 'type' => 'string', - 'required' => false, - 'example' => '["WAF"]', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the handling task.'."\n" - ."\n" - .'> This parameter is used to query a specific task. You can obtain the value from the response result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '150xxxxxxxxx95066', - ], - ], - [ - 'name' => 'OrderField', - 'in' => 'query', - 'schema' => [ - 'description' => 'The field that you use to sort the result.'."\n" - ."\n" - .'> You can obtain the field from the response result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gmtCreate', - ], + 'schema' => ['description' => 'The current page number for pagination. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Direction', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The sort order. Valid values:'."\n" - ."\n" - .'* **desc** (default).'."\n" - .'* **asc**.', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'The number of items per page when displaying paginated results. The default is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'EntityUuid', + 'name' => 'KeyWord', 'in' => 'query', - 'schema' => [ - 'title' => '实体UUID', - 'description' => 'The UUID of the handling entity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n", - ], + 'schema' => ['description' => 'Keyword.', 'type' => 'string', 'required' => false, 'example' => 'Create', 'title' => ''], ], [ - 'name' => 'EventUuid', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The UUID of the event.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****', - ], + 'schema' => ['description' => 'Vendor\'s product identifier:'."\n" + .'- **waf**: Web Application Firewall.'."\n" + .'- **cfw**: Cloud Firewall.', 'type' => 'string', 'required' => false, 'example' => 'waf', 'title' => ''], ], [ - 'name' => 'TriggerSource', + 'name' => 'ApiName', 'in' => 'query', - 'schema' => [ - 'description' => 'The triggering source of the handling task. Valid values:'."\n" - ."\n" - .'* **system**: triggered when you manually handle an event.'."\n" - .'* **custom**: triggered by an event based on an automatic response rule.'."\n" - .'* **custom_alert**: triggered by an alert based on an automatic response rule.'."\n" - .'* **soar-manual**: triggered when you use SOAR to manually run a playbook.'."\n" - .'* **soar-mdr**: triggered by Managed Security Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'system', - ], + 'schema' => ['description' => 'The name of the Alibaba Cloud product interface, supporting fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'AddAssetCleanConfig', 'title' => ''], ], [ - 'name' => 'ReqUuid', + 'name' => 'VendorCode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Vendor code:'."\n" + .'- **Tencent**: Tencent.'."\n" + .'- **HUAWEICLOUD**: Huawei.'."\n" + .'- **Azure**: Microsoft Azure.'."\n" + .'- **AWS**: Amazon Web Services.'."\n" + .'- **Chaitin**: Chaitin.', 'type' => 'string', 'required' => false, 'example' => 'Azure', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<List<ProcessTaskDTO>>', - 'description' => 'The returned data.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94', + 'RequestId' => ['description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94', 'title' => ''], + 'Page' => [ + 'description' => 'Pagination query information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number in the pagination query.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of items displayed per page in the pagination query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ProcessTasks' => [ - 'title' => '传输的数据', - 'description' => 'The handling tasks.'."\n", + 'ApiList' => [ + 'description' => 'Product information.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the handling task.'."\n", + 'description' => 'Product information.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The unique identifier of the handling task.'."\n", - 'type' => 'string', - 'example' => '150xxxxxxxxx95066', - ], - 'Creator' => [ - 'title' => '任务的创建人', - 'description' => 'The ID of the Alibaba Cloud account that is used to submit the handling task.'."\n", - 'type' => 'string', - 'example' => '123xxxx355', - ], - 'GmtCreateMillis' => [ - 'title' => '任务创建时间', - 'description' => 'The creation time of the handling task. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700031183572', - ], - 'GmtModifiedMillis' => [ - 'title' => '任务修复时间', - 'description' => 'The modification time of the handling task. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700031183572', - ], - 'YunCode' => [ - 'title' => '关联产品', - 'description' => 'The code of the cloud service that is associated with the handling task.'."\n", - 'type' => 'string', - 'example' => 'WAF', - ], - 'EntityName' => [ - 'title' => '处置的实体名称', - 'description' => 'The name of the handling entity.'."\n", - 'type' => 'string', - 'example' => '1.1.1.x', - ], - 'EntityType' => [ - 'title' => '处置的实体类型', - 'description' => 'The type of the handling entity.'."\n", - 'type' => 'string', - 'example' => 'ip', - ], - 'TaskStatus' => [ - 'title' => '任务状态', - 'description' => 'The status of the handling task.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'Scope' => [ - 'title' => '作战域', - 'description' => 'The ID of the Alibaba Cloud account that is specified in the handling task.'."\n", - 'type' => 'string', - 'example' => '123xxxxx234', - ], - 'InputParams' => [ - 'title' => '任务的入参', - 'description' => 'The input parameter of the handling task.'."\n", - 'type' => 'string', - 'example' => '{"groupuuid":"c6a9b1df-f4ac-4078-bef4-99xxxxxx"}', - ], - 'SceneCode' => [ - 'title' => '处置场景', - 'description' => 'The scenario code of the handling task.'."\n", - 'type' => 'string', - 'example' => 'event_xxx_whole_process', - ], - 'SceneName' => [ - 'title' => '处置场景名称', - 'description' => 'The scenario name of the handling task.'."\n", - 'type' => 'string', - 'example' => 'waf_whole_process', - ], - 'ProcessTime' => [ - 'title' => '处置时间', - 'description' => 'The delivery time of the handling task. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700031183572', - ], - 'RemoveTime' => [ - 'title' => '解除时间', - 'description' => 'The unblocking time of the handling task. The value is a 13-digit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700031183572', - ], - 'ProcessStrategyUuid' => [ - 'title' => '关联的策略ID', - 'description' => 'The ID of the associated policy.'."\n", - 'type' => 'string', - 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_xxxx', - ], - 'Source' => [ - 'description' => 'The submission source of the handling task.'."\n", - 'type' => 'string', - 'example' => 'system', - ], - 'ErrCode' => [ - 'description' => 'The error code returned if the call failed.'."\n", - 'type' => 'string', - 'example' => 'sts_openapi.Info.DefenseSceneNotSupported', - ], - 'ErrMsg' => [ - 'description' => 'The error message returned if the call failed.', - 'type' => 'string', - 'example' => 'ParamError : The parameters of your request are invalid', - ], - 'ErrTip' => [ - 'description' => 'The error tip returned if the call failed.', - 'type' => 'string', - 'example' => 'Verify that the input parameters of the components are correct', - ], - 'EntityUuid' => [ - 'description' => 'The UUID of the handling entity.'."\n", - 'type' => 'string', - 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n", - ], - 'EventUuid' => [ - 'description' => 'The UUID of the event.'."\n", - 'type' => 'string', - 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****'."\n", - ], - 'ReqUuid' => [ - 'description' => 'The UUID of the playbook execution record.'."\n", - 'type' => 'string', - 'example' => '93e5df20-3d03-42e1-b44b-58197c71****'."\n", - ], - 'TriggerSource' => [ - 'description' => 'The triggering source of the handling task. Valid values:'."\n" - ."\n" - .'* **system**: triggered when you manually handle an event.'."\n" - .'* **custom**: triggered by an event based on an automatic response rule.'."\n" - .'* **custom_alert**: triggered by an alert based on an automatic response rule.'."\n" - .'* **soar-manual**: triggered when you use SOAR to manually run a playbook.'."\n" - .'* **soar-mdr**: triggered by Managed Security Service.'."\n", - 'type' => 'string', - 'example' => 'system', - ], - ], - ], - ], - 'Page' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'VendorCode' => ['description' => 'Vendor code:'."\n" + .'- **Tencent**: Tencent.'."\n" + .'- **HUAWEICLOUD**: Huawei.'."\n" + .'- **Azure**: Microsoft Azure.'."\n" + .'- **AWS**: Amazon Web Services.'."\n" + .'- **Chaitin**: Chaitin.', 'type' => 'string', 'example' => 'Azure', 'title' => ''], + 'ProductCode' => ['description' => 'Vendor\'s product identifier:'."\n" + .'- **waf**: Web Application Firewall.'."\n" + .'- **cfw**: Cloud Firewall.', 'type' => 'string', 'example' => 'cfw', 'title' => ''], + 'ProductName' => ['description' => 'Product name.', 'type' => 'string', 'example' => 'waf', 'title' => ''], + 'Parameter' => ['description' => 'Interface request parameter configuration information.', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "name": "Domain",'."\n" + .' "type": "String",'."\n" + .' "isRequired": true,'."\n" + .' "exampleValue": "www.***.com",'."\n" + .' "description": "www.***.com"'."\n" + .' }'."\n" + .']', 'title' => ''], + 'ProductDomain' => ['description' => 'Default domain of the product.', 'type' => 'string', 'example' => 'cfw.xxx.com', 'title' => ''], + 'Protocol' => ['description' => 'Request protocol. Values:'."\n" + .'- **http**: HTTP request protocol.'."\n" + .'- **https**: HTTPS request protocol.', 'type' => 'string', 'example' => 'https', 'title' => ''], + 'Method' => ['description' => 'Request methods: '."\n" + .'- **POST**: POST request method. '."\n" + .'- **GET**: GET request method. '."\n" + .'- **PUT**: PUT request method. '."\n" + .'- **DELETE**: DELETE request method.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'ApiName' => ['description' => 'The name of the vendor\'s API.', 'type' => 'string', 'example' => 'VerifyMobile', 'title' => ''], + 'NeedPageInfo' => ['description' => 'Indicates whether pagination is needed.'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'PageInfo' => ['description' => 'Information displayed on the page.', 'type' => 'string', 'example' => '{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}', 'title' => ''], + 'ApiVersion' => ['description' => 'The version number of the API.', 'type' => 'string', 'example' => '2017-08-01', 'title' => ''], + 'NeedAdvanceConfig' => ['description' => 'Indicates whether advanced configuration is included.'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AdvanceConfig' => ['description' => 'Advanced configuration for the API.', 'type' => 'string', 'example' => '{'."\n" + .' "cmd": "DescribeAclApiDispatch"'."\n" + .'}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"ProcessTasks\\": [\\n {\\n \\"TaskId\\": \\"150xxxxxxxxx95066\\",\\n \\"Creator\\": \\"123xxxx355\\",\\n \\"GmtCreateMillis\\": 1700031183572,\\n \\"GmtModifiedMillis\\": 1700031183572,\\n \\"YunCode\\": \\"WAF\\",\\n \\"EntityName\\": \\"1.1.1.x\\",\\n \\"EntityType\\": \\"ip\\",\\n \\"TaskStatus\\": 11,\\n \\"Scope\\": \\"123xxxxx234\\",\\n \\"InputParams\\": \\"{\\\\\\"groupuuid\\\\\\":\\\\\\"c6a9b1df-f4ac-4078-bef4-99xxxxxx\\\\\\"}\\",\\n \\"SceneCode\\": \\"event_xxx_whole_process\\",\\n \\"SceneName\\": \\"waf_whole_process\\",\\n \\"ProcessTime\\": 1700031183572,\\n \\"RemoveTime\\": 1700031183572,\\n \\"ProcessStrategyUuid\\": \\"92af3c79-1754-4646-9366-9ddbd1e45536_****\\",\\n \\"Source\\": \\"system\\",\\n \\"ErrCode\\": \\"sts_openapi.Info.DefenseSceneNotSupported\\",\\n \\"ErrMsg\\": \\"ParamError : The parameters of your request are invalid\\",\\n \\"ErrTip\\": \\"Verify that the input parameters of the components are correct\\",\\n \\"EntityUuid\\": \\"69d189e2-ec17-4676-a2fe-02969234****\\\\n\\",\\n \\"EventUuid\\": \\"c1020ce1-d6a5-11e8-8298-00163e10****\\\\n\\",\\n \\"ReqUuid\\": \\"93e5df20-3d03-42e1-b44b-58197c71****\\\\n\\",\\n \\"TriggerSource\\": \\"system\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'DescribeProcessTasks', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", - ], - 'DescribeProcessTaskCount' => [ - 'summary' => 'Query the number of associated disposal tasks based on the entity UUID.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-****-5840-8EC9-691B86729E94\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"ApiList\\": [\\n {\\n \\"VendorCode\\": \\"Azure\\",\\n \\"ProductCode\\": \\"cfw\\",\\n \\"ProductName\\": \\"waf\\",\\n \\"Parameter\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"Domain\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"isRequired\\\\\\": true,\\\\n \\\\\\"exampleValue\\\\\\": \\\\\\"www.***.com\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"www.***.com\\\\\\"\\\\n }\\\\n]\\",\\n \\"ProductDomain\\": \\"cfw.xxx.com\\",\\n \\"Protocol\\": \\"https\\",\\n \\"Method\\": \\"POST\\",\\n \\"ApiName\\": \\"VerifyMobile\\",\\n \\"NeedPageInfo\\": false,\\n \\"PageInfo\\": \\"{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}\\",\\n \\"ApiVersion\\": \\"2017-08-01\\",\\n \\"NeedAdvanceConfig\\": true,\\n \\"AdvanceConfig\\": \\"{\\\\n \\\\\\"cmd\\\\\\": \\\\\\"DescribeAclApiDispatch\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeVendorApiList', + 'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., threat analysis and response log access traffic) before using this interface.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescribeVendorApiList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVendorApiList'], + ], ], + ], + 'DescriberPython3ScriptLogs' => [ + 'summary' => 'After you submit a task for a Python 3 script, use the returned requestUuid to retrieve the operational logs.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6249,243 +4698,166 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '245000', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EntityUuidList', + 'name' => 'RequestUuid', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '实体的entityUuid集合', - 'description' => 'Collection of entity UUIDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'Entity UUID.', - 'type' => 'string', - 'required' => false, - 'example' => 'a680c9ae-****-4c39-****-0302****fc8e', - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The UUID that is returned when you run a Python 3 script.'."\n" + ."\n" + .'> Call the [RunPython3Script](~~RunPython3Script~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => '69edc2b4-c95c-424f-9114-xxxxxxx', 'title' => ''], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'Language type for request and response messages. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - ."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'RoleType', - 'in' => 'query', - 'schema' => [ - 'description' => 'View type.'."\n" - ."\n" - .'- **0**: Current Alibaba Cloud account view.'."\n" - .'- **1**: View for all accounts under the enterprise.', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'RoleFor', - 'in' => 'query', - 'schema' => [ - 'description' => 'User ID for administrators to switch to other member\'s perspective.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '104739******259', - ], + 'schema' => ['description' => 'The language of the request and response.'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<List<ProcessTaskNumberDTO>>', - 'description' => 'Return information.', + 'title' => 'SophonResult<String>', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'e866cce0-****-41de-817e-****8d5e2650', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'Transmitted data.', - 'type' => 'array', - 'items' => [ - 'description' => 'Result set.', - 'type' => 'object', - 'properties' => [ - 'EntityUuid' => [ - 'title' => '实体uuid', - 'description' => 'Entity UUID.', - 'type' => 'string', - 'example' => 'a680c9ae-****-4c39-****-0302****fc8e', - ], - 'Count' => [ - 'title' => '数量', - 'description' => 'Count.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '67', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The unique ID of the request. This ID is generated by Alibaba Cloud and can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => 'D22D8A0C-6E86-57B2-A142-929184122AB1'], + 'RunResult' => ['description' => 'The operational logs of the Python 3 script.', 'type' => 'string', 'title' => '', 'example' => '{'."\n" + .' "logs": ['."\n" + .' {'."\n" + .' "message": "function input is {}"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e866cce0-****-41de-817e-****8d5e2650\\",\\n \\"Data\\": [\\n {\\n \\"EntityUuid\\": \\"a680c9ae-****-4c39-****-0302****fc8e\\",\\n \\"Count\\": 67\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'Query the Number of Associated Disposal Tasks by Entity UUID', - 'translator' => 'machine', - ], - 'DescribeSophonCommands' => [ - 'summary' => 'Queries the commands that can be run to obtain objects.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D22D8A0C-6E86-57B2-A142-929184122AB1\\",\\n \\"RunResult\\": \\"{\\\\n \\\\\\"logs\\\\\\": [\\\\n {\\\\n \\\\\\"message\\\\\\": \\\\\\"function input is {}\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescriberPython3ScriptLogs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescriberPython3ScriptLogs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:DescriberPython3ScriptLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyComponentAsset' => [ + 'summary' => 'You can call this operation to modify the asset information for a component.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'AssetConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the command. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'waf_process', - ], + 'schema' => ['description' => 'The configuration of the component asset. This parameter is a JSON object.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n" + .' "name": "test asset",'."\n" + .' "componentName": "SLS",'."\n" + .' "params": ['."\n" + .' {'."\n" + .' "name": "end_point",'."\n" + .' "value": "xxx"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "sub_id",'."\n" + .' "value": "xxxx"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "access_key",'."\n" + .' "value": "xxxx"'."\n" + .' }'."\n" + .' ]'."\n" + .'}'], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the request and response.'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<List<SophonCommandBO>>', - 'description' => 'The response parameters.'."\n", + 'title' => 'SophonResult<Void>', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The commands.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the command.'."\n", - 'type' => 'string', - 'example' => 'waf_process_ip_v2', - ], - 'DisplayName' => [ - 'description' => 'The display name of the command.'."\n", - 'type' => 'string', - 'example' => 'WAF Process IP', - ], - 'ParamConfig' => [ - 'description' => 'The parameter configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Necessary' => [ - 'description' => 'Indicates whether the parameter is required. Valid values:'."\n" - ."\n" - .'* **true** (default)'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Field' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'ip', - ], - 'Value' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'example' => '12.xx.xx.xx', - ], - 'CheckField' => [ - 'description' => 'The regular expression that is used to check the format of the parameter value. If the parameter is left empty, the check is not performed.'."\n", - 'type' => 'string', - 'example' => '[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}', - ], - ], - ], - ], - 'Description' => [ - 'description' => 'The description of the command.'."\n", - 'type' => 'string', - 'example' => 'This is a action of processing for WAF', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1E1EC464-3BD7-518F-9937-BCC12E6855FE', - ], + 'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request and is used to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '1C5F11E9-464E-51F0-9296-43BB312A0557'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"waf_process_ip_v2\\",\\n \\"DisplayName\\": \\"WAF Process IP\\",\\n \\"ParamConfig\\": [\\n {\\n \\"Necessary\\": true,\\n \\"Field\\": \\"ip\\",\\n \\"Value\\": \\"12.xx.xx.xx\\",\\n \\"CheckField\\": \\"[0-9]{4}\\\\\\\\.[0-9]{4}\\\\\\\\.[0-9]{4}\\\\\\\\.[0-9]{4}\\"\\n }\\n ],\\n \\"Description\\": \\"This is a action of processing for WAF\\"\\n }\\n ],\\n \\"RequestId\\": \\"1E1EC464-3BD7-518F-9937-BCC12E6855FE\\"\\n}","type":"json"}]', - 'title' => 'DescribeSophonCommands', - ], - 'TriggerProcessTask' => [ - 'summary' => 'Performs an action on a handling task that is generated by the handling center when an event is handled by using Security Orchestration Automation Response (SOAR). For example, you can call this operation to cancel blocking or isolation, or retry blocking.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C5F11E9-464E-51F0-9296-43BB312A0557\\"\\n}","type":"json"}]', + 'title' => 'ModifyComponentAsset', + 'requestParamsDescription' => 'Description of the **AssetConfig** parameter:'."\n" + ."\n" + .'- **name**: The name of the asset.'."\n" + ."\n" + .'- **componentName**: The name of the component.'."\n" + ."\n" + .'- **params**: The configuration details. This parameter includes the following fields:'."\n" + ."\n" + .' - **end\\_point**: The connection endpoint.'."\n" + ."\n" + .' - **sub\\_id**: The AccessKey ID of your account.'."\n" + ."\n" + .' - **access\\_key**: The AccessKey secret of your account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyComponentAsset'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-sas:ModifyComponentAsset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyPlaybook' => [ + 'summary' => 'Modifies the configuration of a playbook.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6494,369 +4866,283 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', + 'operationType' => 'update', + 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the handling task.'."\n" - ."\n" - .'> You can call the [DescribeProcessTasks](~~DescribeProcessTasks~~) operation to query the IDs of handling tasks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '15355xxxxxx82894882', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8baa6cff-319e-4ede-97bc-1586c35e61f8'], ], [ - 'name' => 'ActionType', - 'in' => 'query', - 'schema' => [ - 'title' => '处置类型', - 'description' => 'The type of the action. Valid values:'."\n" - ."\n" - .'* **remove**: cancels blocking or isolation.'."\n" - .'* **retry**: submits the task again.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'remove', - ], + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the playbook.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aliyun_waf_test_playbook'], + ], + [ + 'name' => 'Taskflow', + 'in' => 'formData', + 'schema' => ['description' => 'The XML configuration of the playbook.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the playbook.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo test task'], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => ['description' => 'The language of the request and response.'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<Void>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073', - ], + 'RequestId' => ['description' => 'The unique ID of the request. Use this ID to locate and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '9B584F84-D66A-5525-8E7B-05612A903ABF'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B584F84-D66A-5525-8E7B-05612A903ABF\\"\\n}","type":"json"}]', + 'title' => 'ModifyPlaybook', + 'changeSet' => [ + ['createdAt' => '2023-12-07T09:16:28.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\"\\n}","type":"json"}]', - 'title' => 'TriggerProcessTask', - ], - 'DescribeOpenApiList' => [ - 'summary' => 'Queries the API operations of an Alibaba Cloud service.', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybook'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-sas:ModifyPlaybook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], + ], + 'ModifyPlaybookInputOutput' => [ + 'summary' => 'Modifies the input and output parameters of a playbook.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '203524', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'PopCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The POP code of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Sas', - ], + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx'], ], [ - 'name' => 'ApiVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the API.'."\n" - ."\n" - .'> You can call the [DescribeGroupProductions](~~DescribeGroupProductions~~) operation to query the version number.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2021-10-01', - ], + 'name' => 'InputParams', + 'in' => 'formData', + 'schema' => ['description' => 'The input parameter configuration for the playbook. This parameter is in the JSONArray format.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']'], ], [ - 'name' => 'ApiName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operation that you want to perform.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DescribePopApiItemList', - ], + 'name' => 'OutputParams', + 'in' => 'formData', + 'schema' => ['description' => 'Playbooks do not support output parameter configurations. This parameter is fixed to an empty value.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '[]'], ], [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" - ."\n" - .'* **zh**: Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the input parameter for the playbook.'."\n" + ."\n" + .'- **template-ip**: IP request template.'."\n" + ."\n" + .'- **template-file**: file request template.'."\n" + ."\n" + .'- **template-process**: process request template.'."\n" + ."\n" + .'- **custom**: custom parameter.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''], ], [ - 'name' => 'RoleType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view. Default value: 0. Valid values:'."\n" - ."\n" - .'* 0: the view of the current Alibaba Cloud account.'."\n" - .'* 1: the view of all accounts for the enterprise.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'name' => 'ExeConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The execution method for the playbook. This parameter is in the JSONObject format.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "executeMode":"mul",'."\n" + .' "cron":"0 0 1 */1 * ?"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'RoleFor', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '137602xxx8718726', - ], + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => ['description' => 'The language of the request and response messages.'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<APITreeBO>', - 'description' => 'SophonResult'."\n", + 'title' => 'SophonResult<Void>', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response code. Valid values:'."\n" - ."\n" - .'* 200: successful.'."\n" - .'* 500: failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Version' => [ - 'description' => 'The version number of the API.'."\n", - 'type' => 'string', - 'example' => '2018-12-03', - ], - 'Directories' => [ - 'description' => 'The information about the returned APIs.'."\n", - 'type' => 'any', - 'example' => '[{"apis":[{"summary":"get account information","deprecated":false,"name":"DescAccountSummary","title":"get account information"}],"childrens":[],"title":"account"}]', - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier that is generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '8DDC07CE-D41B-5142-8D91-469462719C77'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8DDC07CE-D41B-5142-8D91-469462719C77\\"\\n}","type":"json"}]', + 'title' => 'ModifyPlaybookInputOutput', + 'requestParamsDescription' => '**InputParams** is in the JSONArray format. The parameters are described as follows:'."\n" + ."\n" + .'- typeName: The name of the parameter type.'."\n" + ."\n" + .'- dataClass: The class of the parameter type. Valid values: **normal** for a standard parameter and **custom** for a complex parameter.'."\n" + ."\n" + .'- dataType: The data type of the parameter. Valid values: string, long, int, ip, file, and **account**.'."\n" + ."\n" + .'- description: The parameter description.'."\n" + ."\n" + .'- example: An example value for the parameter.'."\n" + ."\n" + .'- name: The parameter name.'."\n" + ."\n" + .'- required: Specifies whether the parameter is required. Valid values: **true** and **false**.'."\n" + ."\n" + .'**ExeConfig** is in the JSONObject format. The parameters are described as follows:'."\n" + ."\n" + .'- executeMode: The execution method. The only valid value is **mul**.'."\n" + ."\n" + .'- cron: The CRON expression. The expression must follow the CRON standard.', + 'changeSet' => [ + ['createdAt' => '2024-01-16T08:25:44.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2\\",\\n \\"Data\\": {\\n \\"Code\\": \\"200\\",\\n \\"Version\\": \\"2018-12-03\\",\\n \\"Directories\\": \\"[{\\\\\\"apis\\\\\\":[{\\\\\\"summary\\\\\\":\\\\\\"get account information\\\\\\",\\\\\\"deprecated\\\\\\":false,\\\\\\"name\\\\\\":\\\\\\"DescAccountSummary\\\\\\",\\\\\\"title\\\\\\":\\\\\\"get account information\\\\\\"}],\\\\\\"childrens\\\\\\":[],\\\\\\"title\\\\\\":\\\\\\"account\\\\\\"}]\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeOpenApiList', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or the pricing for log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", - ], - 'DescribeOpenApiInfo' => [ - 'summary' => 'Queries the details of an API operation.', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInputOutput'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-sas:ModifyPlaybookInputOutput', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], + ], + 'ModifyPlaybookInstanceStatus' => [ + 'summary' => 'Starts or stops a playbook.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '203523', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PopCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The POP code of the Alibaba Cloud service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Sas', - ], - ], - [ - 'name' => 'ApiVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the API.'."\n" - ."\n" - .'> You can call the [DescribeGroupProductions](~~DescribeGroupProductions~~) operation to query version numbers.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2018-12-03', - ], + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => '9fcd3829-80ff-4681-be1e-xxxxxxxx'], ], [ - 'name' => 'ApiName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operation that you want to perform.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'DescribePopApiItemList', - ], + 'name' => 'Active', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The status of the playbook. Valid values:'."\n" + ."\n" + .'- **1**: Starts the playbook.'."\n" + ."\n" + .'- **0**: Stops the playbook.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'RoleType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view. Valid values:'."\n" - ."\n" - .'* 0 (default): the view of the current Alibaba Cloud account.'."\n" - .'* 1: the view of all accounts for the enterprise.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'RoleFor', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1592757xxx002956', - ], + 'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<APIDetailVO>', - 'description' => 'SophonResult'."\n", + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'OutputParams' => [ - 'description' => 'The output parameters of the API operation.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'InputParams' => [ - 'description' => 'The input parameters of the API operation.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'ResponseDemo' => [ - 'description' => 'The sample response parameters.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'Title' => [ - 'description' => 'The title of the API operation.'."\n", - 'type' => 'string', - 'example' => 'describeEcs', - ], - 'Summary' => [ - 'description' => 'The summary of the API operation.'."\n", - 'type' => 'string', - 'example' => 'describeEcs', - ], - 'Description' => [ - 'description' => 'The description of the API operation.'."\n", - 'type' => 'string', - 'example' => 'describeEcs', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'C2A32830-2842-5F8F-B4ED-E4783E400BBE'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2A32830-2842-5F8F-B4ED-E4783E400BBE\\"\\n}","type":"json"}]', + 'title' => 'ModifyPlaybookInstanceStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9ED0-A1A361CDE615\\",\\n \\"Data\\": {\\n \\"OutputParams\\": \\"[]\\",\\n \\"InputParams\\": \\"{}\\",\\n \\"ResponseDemo\\": \\"[]\\",\\n \\"Title\\": \\"describeEcs\\",\\n \\"Summary\\": \\"describeEcs\\",\\n \\"Description\\": \\"describeEcs\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeOpenApiInfo', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + 'ramActions' => [], ], - 'DescribeGroupProductions' => [ - 'summary' => 'Queries groups of Alibaba Cloud services.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'PublishPlaybook' => [ + 'summary' => 'Publishes a playbook. Once published, the playbook runs with the new logic.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6865,376 +5151,217 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '203522', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsasK0Q1Y8'], ], 'parameters' => [ [ - 'name' => 'Lang', - 'in' => 'query', + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the published version.', 'type' => 'string', 'maxLength' => 128, 'title' => '', 'required' => false, 'example' => 'This is a waf processing playbook'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The language of the content within the response. Valid values:'."\n" - ."\n" - .'* **zh** (default)'."\n" - .'* **en**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', + 'title' => 'SophonResult<Void>', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF\\"\\n}","type":"json"}]', + 'title' => 'PublishPlaybook', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishPlaybook'], + ], + ], + 'ramActions' => [ [ - 'name' => 'RoleType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view. Valid values:'."\n" - ."\n" - .'* **0** (default): the view of the current Alibaba Cloud account.'."\n" - .'* **1**: the view of all accounts for the enterprise.', - 'type' => 'string', - 'required' => false, - 'example' => '0', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-sas:PublishPlaybook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], ], ], + ], + ], + 'QueryTreeData' => [ + 'summary' => 'Retrieves a list of all playbooks.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RoleFor', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '118******150980', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<List<ProductionGroup>>', - 'description' => 'SophonResult\\<List>'."\n", + 'title' => 'SophonResult<String>', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '358E012F-****-599D-9ED0-****61CDE615', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The information about the groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the group.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => 'The name of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'Cloud Communication', - ], - 'Productions' => [ - 'description' => 'The information about the cloud services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the cloud service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The code of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'DM', - ], - 'Name' => [ - 'description' => 'The name of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'DirectMail', - ], - 'ShortName' => [ - 'description' => 'The short name of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'DM', - ], - 'Description' => [ - 'description' => 'The description of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'DM', - ], - 'Group' => [ - 'description' => 'The name of the group.'."\n", - 'type' => 'string', - 'example' => 'Cloud Communication', - ], - 'Versions' => [ - 'description' => 'The API versions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The API version.'."\n", - 'type' => 'string', - 'example' => '2014-08-15', - ], - ], - 'DefaultVersion' => [ - 'description' => 'The default version.'."\n", - 'type' => 'string', - 'example' => '2014-08-15', - ], - 'DefaultDomain' => [ - 'description' => 'The default requested domain name.'."\n", - 'type' => 'string', - 'example' => 'dm.aliyuncs.com', - ], - 'FullDomains' => [ - 'description' => 'The requested domain names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The requested domain name.'."\n", - 'type' => 'string', - 'example' => 'dm.aliyuncs.com', - ], - ], - 'RamCode' => [ - 'description' => 'The Resource Access Management (RAM) code of the POP to which the resource belongs.'."\n", - 'type' => 'string', - 'example' => 'dm', - ], - 'Source' => [ - 'description' => 'The information source of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'next', - ], - 'PolicyList' => [ - 'title' => '产品的ram策略集合', - 'description' => 'The RAM policies of the cloud service.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The RAM policy of the cloud service.'."\n", - 'type' => 'object', - 'properties' => [ - 'PolicyName' => [ - 'title' => 'ram策略名称', - 'description' => 'The name of the RAM policy.'."\n", - 'type' => 'string', - 'example' => 'AliyunRAMReadOnlyAccess', - ], - 'Type' => [ - 'title' => 'ram策略类型（全部权限OR只读权限）', - 'description' => 'The type of the RAM policy. Valid values:'."\n" - ."\n" - .'* **All**: permissions.'."\n" - .'* **Read-only**: permissions.', - 'type' => 'string', - 'example' => 'All', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'Page' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2'], + 'Playbooks' => ['description' => 'A list of playbooks in JSON string format. The string contains the following fields:'."\n" + ."\n" + .'- **active**: Indicates whether the playbook is active. A value of **true** means the playbook is active. A value of **false** means the playbook is inactive.'."\n" + ."\n" + .'- **displayName**: The name of the playbook.'."\n" + ."\n" + .'- **playbookUuid**: The UUID of the playbook.', 'type' => 'string', 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "playbook": {'."\n" + .' "active": false,'."\n" + .' "displayName": "test_playbook",'."\n" + .' "playbookUuid": "09a20455-3d3a-424c-a1df-xxxxxx"'."\n" + .' }'."\n" + .' }'."\n" + .']'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9Exxx-A1A361CDE615\\",\\n \\"Data\\": [\\n {\\n \\"GroupName\\": \\"数据库\\",\\n \\"Productions\\": [\\n {\\n \\"Code\\": \\"Rds\\",\\n \\"Name\\": \\"云数据库 RDS\\",\\n \\"ShortName\\": \\"RDS\\",\\n \\"Description\\": \\"云数据库\\",\\n \\"Group\\": \\"云数据库\\",\\n \\"Versions\\": [\\n \\"2014-08-15\\"\\n ],\\n \\"DefaultVersion\\": \\"2014-08-15\\",\\n \\"DefaultDomain\\": \\"rds.aliyuncs.com\\",\\n \\"FullDomains\\": [\\n \\"rds.aliyuncs.com\\"\\n ],\\n \\"RamCode\\": \\"rds\\",\\n \\"Source\\": \\"next\\",\\n \\"PolicyList\\": [\\n {\\n \\"PolicyName\\": \\"AliyunRAMReadOnlyAccess\\",\\n \\"Type\\": \\"只读权限\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'DescribeGroupProductions', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", - ], - 'DescribeNotifyTemplateList' => [ - 'summary' => 'Queries notification templates.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2\\",\\n \\"Playbooks\\": \\"[\\\\n {\\\\n \\\\\\"playbook\\\\\\": {\\\\n \\\\\\"active\\\\\\": false,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"test_playbook\\\\\\",\\\\n \\\\\\"playbookUuid\\\\\\": \\\\\\"09a20455-3d3a-424c-a1df-xxxxxx\\\\\\"\\\\n }\\\\n }\\\\n]\\"\\n}","type":"json"}]', + 'title' => 'QueryTreeData', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTreeData'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:QueryTreeData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RevertPlaybookRelease' => [ + 'summary' => 'Rolls back a playbook to a specified version. You can also specify whether to publish that version after the rollback.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225868', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '185295a1-c987-4b64-8796-xxxxxxxx'], ], [ - 'name' => 'RoleType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view. Default value: 0. Valid values:'."\n" - ."\n" - .'* 0: the view of the current Alibaba Cloud account.'."\n" - .'* 1: the view of all accounts for the enterprise.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'name' => 'PlayReleaseId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the published playbook version.'."\n" + ."\n" + .'> Call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to obtain this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '3f97b56e-064e-47e7-a309-xxxxxxx'], ], [ - 'name' => 'RoleFor', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '137602425xxx8726', - ], + 'name' => 'IsPublish', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to publish the playbook after the rollback.'."\n" + ."\n" + .'- **true** (default): Publishes the playbook after the rollback.'."\n" + ."\n" + .'- **false**: Rolls back the playbook without publishing it.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SophonResult<List<NotifyTemplateDTO>>', - 'description' => 'SophonResult\\<List>'."\n", + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'TemplateName' => [ - 'title' => '模版名称', - 'description' => 'The name of the template.'."\n", - 'type' => 'string', - 'example' => 'incident generate', - ], - 'EventId' => [ - 'title' => '模版对应的消息事件的id', - 'description' => 'The ID of the message event corresponding to the template.'."\n", - 'type' => 'string', - 'example' => 'yundun_soar_incident_generate', - ], - 'Subject' => [ - 'title' => '模版的标题', - 'description' => 'The title of the template.'."\n", - 'type' => 'string', - 'example' => '[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)', - ], - 'Content' => [ - 'title' => '模版的正文', - 'description' => 'The body of the template.'."\n", - 'type' => 'string', - 'example' => 'Dear $aliyunUID : Cloud Security Center Threat Analysis and Response has detected a newly discovered security incident $incidentName(Incident id :$incidentID) in $startTime, Please go to Cloud Security Center Console View.', - ], - 'Params' => [ - 'title' => '模版的参数', - 'description' => 'The parameters of the template.'."\n", - 'type' => 'string', - 'example' => '[\\"aliyunUID\\",\\"incidentName\\",\\"incidentID\\",\\"startTime\\"]', - ], - ], - ], - ], - 'Page' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request. This ID is unique to the request and can be used for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3FED5B9-190A-5952-93A4-24FBF0F0C573\\"\\n}","type":"json"}]', + 'title' => 'RevertPlaybookRelease', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevertPlaybookRelease'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-sas:RevertPlaybookRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Application', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3FED5B9-190A-5952-93A4-24FBF0F0C573\\",\\n \\"Data\\": [\\n {\\n \\"TemplateName\\": \\"incident generate\\",\\n \\"EventId\\": \\"yundun_soar_incident_generate\\",\\n \\"Subject\\": \\"[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)\\",\\n \\"Content\\": \\"Dear $aliyunUID : Cloud Security Center Threat Analysis and Response has detected a newly discovered security incident $incidentName(Incident id :$incidentID) in $startTime, Please go to Cloud Security Center Console View.\\",\\n \\"Params\\": \\"[\\\\\\\\\\\\\\"aliyunUID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"incidentName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"incidentID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\"]\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'DescribeNotifyTemplateList', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", ], 'RunNotifyComponentWithEmail' => [ - 'summary' => 'Runs the email notification component to send messages.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Runs the notification component to send an email message.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7247,9 +5374,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226653', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ @@ -7257,201 +5382,130 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'title' => '邮箱地址列表', - 'description' => 'The email addresses.'."\n", + 'title' => '', + 'description' => 'A list of email addresses.', 'type' => 'array', - 'items' => [ - 'description' => 'The email address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123xxx@163.com', - ], + 'items' => ['description' => 'A single email address.', 'type' => 'string', 'required' => false, 'example' => '123xxx@163.com', 'title' => ''], 'required' => true, 'maxItems' => 100, + 'example' => '', ], ], [ 'name' => 'Subject', 'in' => 'query', - 'schema' => [ - 'title' => '邮箱标题', - 'description' => 'The subject of the email.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'title', - ], + 'schema' => ['description' => 'The title of the email.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'title'], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'title' => '邮箱正文', - 'description' => 'The body of the email.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'email content', - ], + 'schema' => ['description' => 'The body of the email.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'email content'], ], [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本uuid', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e99dab31-499b-4307-9248-xxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e99dab31-499b-4307-9248-xxxxxx'], ], [ 'name' => 'NodeName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的节点名称', - 'description' => 'The name of the node in the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'notify_message_1', - ], + 'schema' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notify_message_1'], ], [ 'name' => 'ComponentName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的组件名称', - 'description' => 'The name of component in the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'NotifyMessage', - ], + 'schema' => ['description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'NotifyMessage'], ], [ 'name' => 'ActionName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的动作名称', - 'description' => 'The action name of the component.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'notifyByCustom', - ], + 'schema' => ['description' => 'The name of the component action.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notifyByCustom'], ], [ 'name' => 'AssetId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The resource instance ID of the email sender.'."\n" - ."\n" - .'> You can call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to query the ID.'."\n", - 'type' => 'string', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the asset that is used to send the email.'."\n" + ."\n" + .'> Call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to obtain this parameter.', 'type' => 'string', 'title' => '', 'format' => 'int32', 'required' => true, 'example' => '10'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid value:'."\n" - ."\n" - .'* **zh** (default): Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view. Valid values:'."\n" - ."\n" - .'* 0: the view of the current Alibaba Cloud account.'."\n" - .'* 1: the view of all accounts for the enterprise.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The view type. Valid values:'."\n" + ."\n" + .'- 0: The view of the current Alibaba Cloud account.'."\n" + ."\n" + .'- 1: The view of all accounts that belong to the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '137602xxx718726', - ], + 'schema' => ['description' => 'The UID of the member whose data an administrator wants to access.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602xxx718726', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<String>', - 'description' => 'SophonResult'."\n", + 'description' => 'SophonResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The data returned.'."\n", - 'type' => 'string', - 'example' => '{}', - ], + 'RequestId' => ['description' => 'The ID of the request. Use this ID for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B'], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'title' => '', 'example' => '{}'], 'Page' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RunNotifyComponentWithEmail', + 'description' => 'Before calling this operation, understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for Security Orchestration Application Response (SOAR). SOAR is billed based on the log traffic added to the service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithEmail'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-sas:RunNotifyComponentWithEmail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'RunNotifyComponentWithEmail', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", ], 'RunNotifyComponentWithMessageCenter' => [ - 'summary' => 'Execute Notification Component - Send Message via Message Center.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7464,49 +5518,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226714', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Aliuid', 'in' => 'query', - 'schema' => [ - 'title' => '要发送的aliuid', - 'description' => 'The user ID receiving the message.', - 'type' => 'string', - 'required' => true, - 'example' => '146789xxxx733152', - ], + 'schema' => ['title' => '要发送的aliuid', 'description' => 'The ID of the user who receives the message.', 'type' => 'string', 'required' => true, 'example' => '146789xxxx733152'], ], [ 'name' => 'EventId', 'in' => 'query', - 'schema' => [ - 'title' => '云鸽的消息事件id', - 'description' => 'Cloud Pigeon\'s message event ID. Values:'."\n" - .'- yundun_soar_incident_generate: Incident generation.'."\n" - .'- yundun_soar_alert_generate: Alert generation.'."\n" - .'- yundun_soar_incident_update: Incident update.', - 'type' => 'string', - 'required' => true, - 'example' => 'yundun_soar_incident_generate', - ], + 'schema' => ['title' => '云鸽的消息事件id', 'description' => 'The ID of the message event in Message Center. Valid values:'."\n" + ."\n" + .'- yundun\\_soar\\_incident\\_generate: An event is generated.'."\n" + ."\n" + .'- yundun\\_soar\\_alert\\_generate: An alert is generated.'."\n" + ."\n" + .'- yundun\\_soar\\_incident\\_update: An event is updated.', 'type' => 'string', 'required' => true, 'example' => 'yundun_soar_incident_generate'], ], [ 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'title' => '消息参数', - 'description' => 'Template parameters for the message event.'."\n" - .'- For incident generation: aliyunUID, incidentName, incidentID, startTime'."\n" - .'- For alert generation: aliyunUID, alertName, alertID, startTime'."\n" - .'- For incident update: aliyunUID, incidentName, incidentID, startTime, endTime, status, level', - 'type' => 'string', - 'required' => false, - 'example' => '{"startTime":"test222","incidentName":"test123","incidentID":"teset123"}', - ], + 'schema' => ['title' => '消息参数', 'description' => 'The template parameters for the message event.'."\n" + ."\n" + .'- Event generation: aliyunUID, incidentName, incidentID, startTime'."\n" + ."\n" + .'- Alert generation: aliyunUID, alertName, alertID, startTime'."\n" + ."\n" + .'- Event update: aliyunUID, incidentName, incidentID, startTime, endTime, status, level', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"test222","incidentName":"test123","incidentID":"teset123"}'], ], [ 'name' => 'ChannelTypeList', @@ -7514,178 +5554,127 @@ 'style' => 'repeatList', 'schema' => [ 'title' => '通道类型集合，不传默认发送消息事件配置的所有通道', - 'description' => 'Collection of channel types. If not provided, all channels will be used by default, and it is not required to provide this parameter by default.', + 'description' => 'A collection of channel types. If you do not specify this parameter, messages are sent through all channels by default.', 'type' => 'array', - 'items' => [ - 'description' => 'Single channel type. Values:'."\n" - .'- sms: SMS.'."\n" - .'- email: Email.'."\n" - .'- webhook: DingTalk group webhook.'."\n" - .'- pmsg: In-site message.', - 'type' => 'string', - 'required' => false, - 'example' => 'sms', - ], + 'items' => ['description' => 'A channel type. Valid values:'."\n" + ."\n" + .'- sms: text message'."\n" + ."\n" + .'- email: email'."\n" + ."\n" + .'- webhook: DingTalk group webhook'."\n" + ."\n" + .'- pmsg: internal message', 'type' => 'string', 'required' => false, 'example' => 'sms', 'title' => ''], 'required' => false, 'maxItems' => 100, + 'example' => '', ], ], [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本uuid', - 'description' => 'The UUID of the playbook.'."\n" - .'> You can obtain this parameter by calling the [DescribePlaybooks](~~DescribePlaybooks~~) interface.', - 'type' => 'string', - 'required' => true, - 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx', - ], + 'schema' => ['title' => '剧本uuid', 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain the value of this parameter.', 'type' => 'string', 'required' => true, 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx'], ], [ 'name' => 'NodeName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的节点名称', - 'description' => 'The node name of the playbook.', - 'type' => 'string', - 'required' => true, - 'example' => 'notify_message', - ], + 'schema' => ['title' => '剧本的节点名称', 'description' => 'The name of the playbook node.', 'type' => 'string', 'required' => true, 'example' => 'notify_message'], ], [ 'name' => 'ComponentName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的组件名称', - 'description' => 'The component name of the playbook.', - 'type' => 'string', - 'required' => true, - 'example' => 'NotifyMessage', - ], + 'schema' => ['title' => '剧本的组件名称', 'description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'example' => 'NotifyMessage'], ], [ 'name' => 'ActionName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的动作名称', - 'description' => 'The action name of the playbook.', - 'type' => 'string', - 'required' => true, - 'example' => 'notifyByMessageCenter', - ], + 'schema' => ['title' => '剧本的动作名称', 'description' => 'The name of the playbook action.', 'type' => 'string', 'required' => true, 'example' => 'notifyByMessageCenter'], ], [ 'name' => 'AssetId', 'in' => 'query', - 'schema' => [ - 'title' => '资源实例id', - 'description' => 'Resource instance ID. This parameter is currently deprecated and no longer in use.', - 'type' => 'string', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '资源实例id', 'description' => 'The ID of the asset. This parameter is deprecated.', 'type' => 'string', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language type for requesting and receiving messages. Values:'."\n" - .'- **zh** (default): Chinese.'."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + ."\n" + .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleType', 'in' => 'query', - 'schema' => [ - 'description' => 'View type. Values:'."\n" - .'- 0 (default): Current Alibaba Cloud account view.'."\n" - .'- 1: View for all accounts under the enterprise.', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The view type. Valid values:'."\n" + ."\n" + .'- 0 (default): The view of the current Alibaba Cloud account.'."\n" + ."\n" + .'- 1: The view of all accounts that belong to the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID when an administrator switches to another member\'s perspective.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1467894xxx733152', - ], + 'schema' => ['description' => 'The user ID of the member. This parameter is used when an administrator calls the operation on behalf of a member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1467894xxx733152', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult<String>', - 'description' => 'SophonResult<String>', + 'description' => 'SophonResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'Data returned by the interface.', - 'type' => 'string', - 'example' => '{}', - ], + 'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The unique ID generated for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'], + 'Data' => ['title' => '传输的数据', 'description' => 'The data returned.', 'type' => 'string', 'example' => '{}'], 'Page' => [ - 'description' => 'Pagination query information.', + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'Number of list entries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'Page number in pagination queries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of items to display per page when performing a paginated query.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Notification Component - Test Message Center Message Sending', + 'summary' => 'Sends a message using the notification component in Message Center.', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Security Orchestration Automation Response (SOAR). The service is billed based on the log traffic for threat analysis and response.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithMessageCenter'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-sas:RunNotifyComponentWithMessageCenter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'Notification Component - Test Message Center Message Sending', - 'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., Threat Analysis and Response Log Access Traffic) before using this interface.', - 'translator' => 'machine', ], 'RunNotifyComponentWithWebhook' => [ - 'summary' => 'Runs the webhook notification component to send messages.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Sends a message from a notification component using a webhook.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7698,168 +5687,98 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226713', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Webhook', 'in' => 'query', - 'schema' => [ - 'title' => 'webhook地址', - 'description' => 'The IDs of chatbots that are configured in the message center. Only DingTalk chatbots are supported.'."\n" - ."\n" - .'> You can call the [ListEncryptWebhooks](~~ListEncryptWebhooks~~) operation to query the chatbot IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '[\\"10651\\"]', - ], + 'schema' => ['description' => 'The IDs of the DingTalk robots. Obtain the IDs on the robot management page in Message Center.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '[\\"10651\\"]'], ], [ 'name' => 'Secret', 'in' => 'query', - 'schema' => [ - 'title' => 'webhook消息秘钥', - 'description' => 'The message key of the DingTalk chatbot webhook. This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SECc1*****e157b32b380f********bb8c70e1a67a22072', - ], + 'schema' => ['description' => 'The secret key for the webhook of the DingTalk group robot. This parameter is deprecated and no longer used.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'SECc1*****e157b32b380f********bb8c70e1a67a22072'], ], [ 'name' => 'MsgType', 'in' => 'query', - 'schema' => [ - 'title' => 'webhook消息类型，取值：text、markdown、actionCard', - 'description' => 'The type of the webhook message. Valid values:'."\n" - .'* text.'."\n" - .'* markdown.'."\n" - .'* actionCard.', - 'type' => 'string', - 'required' => true, - 'example' => 'text', - ], + 'schema' => ['description' => 'The message type of the webhook. Valid values:'."\n" + ."\n" + .'- text'."\n" + ."\n" + .'- markdown'."\n" + ."\n" + .'- actionCard', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'text'], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'title' => 'webhook消息正文', - 'description' => 'The message body sent by the DingTalk group chatbot webhook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "at": {'."\n" - .' "atMobiles":['."\n" - .' "180xxxxxx"'."\n" - .' ],'."\n" - .' "atUserIds":['."\n" - .' "user123"'."\n" - .' ],'."\n" - .' "isAtAll": false'."\n" - .' },'."\n" - .' "text": {'."\n" - .' "content":"1234"'."\n" - .' },'."\n" - .' "msgtype":"text"'."\n" - .'}', - ], + 'schema' => ['description' => 'The content of the message sent by the webhook of the DingTalk group robot.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n" + .' "at": {'."\n" + .' "atMobiles":['."\n" + .' "180xxxxxx"'."\n" + .' ],'."\n" + .' "atUserIds":['."\n" + .' "user123"'."\n" + .' ],'."\n" + .' "isAtAll": false'."\n" + .' },'."\n" + .' "text": {'."\n" + .' "content":"1234"'."\n" + .' },'."\n" + .' "msgtype":"text"'."\n" + .'}'], ], [ 'name' => 'PlaybookUuid', 'in' => 'query', - 'schema' => [ - 'title' => '剧本uuid', - 'description' => 'The UUID of the playbook.'."\n" - ."\n" - .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '94bc318c-****-4cba-****-801ccb0d739f', - ], + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~3000306~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '94bc318c-****-4cba-****-801ccb0d739f'], ], [ 'name' => 'NodeName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的节点名称', - 'description' => 'The name of the node in the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'notify_message_node', - ], + 'schema' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notify_message_node'], ], [ 'name' => 'ComponentName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的组件名称', - 'description' => 'The name of the component in the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'NotifyMessage', - ], + 'schema' => ['description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'NotifyMessage'], ], [ 'name' => 'ActionName', 'in' => 'query', - 'schema' => [ - 'title' => '剧本的动作名称', - 'description' => 'The name of the action in the playbook.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'notifyByCustom', - ], + 'schema' => ['description' => 'The name of the playbook action.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notifyByCustom'], ], [ 'name' => 'AssetId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the resource. This parameter is deprecated.'."\n", - 'type' => 'string', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the resource. This parameter is deprecated and no longer used.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the content within the request and the response. Valid values:'."\n" - ."\n" - .'* **zh** (default): Chinese.'."\n" - .'* **en**: English.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the view. Valid values:'."\n" - ."\n" - .'* 0 (default): the view of the current Alibaba Cloud account.'."\n" - .'* 1: the view of all accounts for the enterprise.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The view type. Valid values:'."\n" + ."\n" + .'- 0 (default): the view of the current Alibaba Cloud account.'."\n" + ."\n" + .'- 1: the view of all accounts that belong to the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '126339xxxx805497', - ], + 'schema' => ['description' => 'The UID of the member that the administrator wants to switch to.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '126339xxxx805497', 'title' => ''], ], ], 'responses' => [ @@ -7869,310 +5788,745 @@ 'description' => 'SophonResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '接口请求的requestId', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94', - ], - 'Data' => [ - 'title' => '传输的数据', - 'description' => 'The data returned.'."\n", - 'type' => 'string', - 'example' => '{}', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94'], + 'Data' => ['description' => 'The data returned.', 'type' => 'string', 'title' => '', 'example' => '{}'], 'Page' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'TotalCount' => ['description' => 'The total number of entries returned. This parameter is available only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-****-5840-8EC9-691B86729E94\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', 'title' => 'RunNotifyComponentWithWebhook', - 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", - ], - 'DescribeVendorApiList' => [ - 'summary' => 'Queries the API operations of a cloud service provider.', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of response orchestration. This feature is billed based on the log traffic for threat analysis and response.', + 'changeSet' => [ + ['createdAt' => '2025-12-09T11:25:07.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithWebhook'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-sas:RunNotifyComponentWithWebhook', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'RunPython3Script' => [ + 'summary' => 'Executes a Python 3 code snippet for data processing.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'PythonScript', + 'in' => 'formData', + 'schema' => ['description' => 'The Python 3 script.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'import logging'."\n" + .'def execute (params):'."\n" + .' #ip = params[\'ip\']'."\n" + .' #logging.info("enter execute,ip is "+ip)'."\n" + .' success=True'."\n" + .' message=\'OK\''."\n" + .' data=[]'."\n" + .' return (success,message,data)'], + ], + [ + 'name' => 'Params', + 'in' => 'formData', + 'schema' => ['description' => 'The input parameters for the Python 3 script.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n" + .' "input1": "xx.xx.xx.xx",'."\n" + .' "input2": "7d"'."\n" + .'}'], + ], + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx'], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'python3_3'], + ], + [ + 'name' => 'PythonVersion', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => 'The Python version.', 'title' => '', 'required' => false, 'example' => 'python2.0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The current page number for pagination. The default value is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => 'SophonResult<String>', + 'description' => 'The returned information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request. Alibaba Cloud generates this unique ID for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'F210521C-D9BF-5264-8369-83EDDC617DB0'], + 'RunResult' => ['title' => '', 'description' => 'The data returned after the script is run.', 'type' => 'string', 'example' => '{'."\n" + .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n" + .' "content": {'."\n" + .' "resultData": [],'."\n" + .' "success": true'."\n" + .' }'."\n" + .'}'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F210521C-D9BF-5264-8369-83EDDC617DB0\\",\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'RunPython3Script', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product.', + 'responseParamsDescription' => 'The **RunResult** parameter is a JSON object that contains the following fields:'."\n" + ."\n" + .'- **requestUuid**: The UUID of the request. You can use this UUID to query the run logs.'."\n" + ."\n" + .'- **content**: The result of the script execution. This field is user-defined.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunPython3Script'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'yundun-sas:RunPython3Script', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'TriggerPlaybook' => [ + 'summary' => 'Triggers an enabled custom or predefined playbook.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2a687089-d4dd-47d4-9709-xxxxxxxx'], + ], + [ + 'name' => 'InputParam', + 'in' => 'formData', + 'schema' => ['description' => 'The input parameters for the playbook.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n" + .' "input1": "xx.xx.xx.xx",'."\n" + .' "input2": "7d"'."\n" + .'}'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of items per page when displaying paginated results. The default is 10.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + 'title' => 'SophonResult<PlaybookTriggerDTO>', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'BD5A8DB6-A42C-532B-BCE8-83E69550CD59'], + 'TriggerUuid' => ['description' => 'The UUID of the playbook run. You can use this UUID to obtain the results of the playbook run.', 'type' => 'string', 'example' => '55E63C57-D6C8-5036-A770-5CB10AC807AA', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD5A8DB6-A42C-532B-BCE8-83E69550CD59\\",\\n \\"TriggerUuid\\": \\"55E63C57-D6C8-5036-A770-5CB10AC807AA\\"\\n}","type":"json"}]', + 'title' => 'TriggerPlaybook', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Response Orchestration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerPlaybook'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-sas:TriggerPlaybook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], ], ], + ], + ], + 'TriggerProcessTask' => [ + 'summary' => 'When an event is handled using response orchestration, the response center creates a task. Perform follow-up actions on the task, such as unblocking, retrying a block, and removing from isolation.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'KeyWord', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the handling task.'."\n" + ."\n" + .'> Call the [DescribeProcessTasks](~~DescribeProcessTasks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => '15355xxxxxx82894882', 'title' => ''], + ], + [ + 'name' => 'ActionType', 'in' => 'query', + 'schema' => ['description' => 'The type of the handling action. Valid values:'."\n" + ."\n" + .'- **remove**: Removes a block or an asset from isolation.'."\n" + ."\n" + .'- **retry**: Resubmits the task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'remove'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Keyword.', - 'type' => 'string', - 'required' => false, - 'example' => 'Create', + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\"\\n}","type":"json"}]', + 'title' => 'TriggerProcessTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 5, 'regionId' => '*', 'api' => 'TriggerProcessTask'], + ], + ], + 'ramActions' => [], + ], + 'TriggerSophonPlaybook' => [ + 'summary' => 'Triggers a playbook or responds to a command.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProductCode', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '149322', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + ], + 'parameters' => [ + [ + 'name' => 'CommandName', 'in' => 'query', - 'schema' => [ - 'description' => 'Vendor\'s product identifier:'."\n" - .'- **waf**: Web Application Firewall.'."\n" - .'- **cfw**: Cloud Firewall.', - 'type' => 'string', - 'required' => false, - 'example' => 'waf', - ], + 'schema' => ['description' => 'The name of the command to trigger.'."\n" + ."\n" + .'> Call the [DescribeSophonCommands](~~DescribeSophonCommands~~) operation to obtain the command name.', 'type' => 'string', 'required' => false, 'example' => 'waf_process_command', 'title' => ''], ], [ - 'name' => 'ApiName', + 'name' => 'InputParams', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Alibaba Cloud product interface, supporting fuzzy search.', - 'type' => 'string', - 'required' => false, - 'example' => 'AddAssetCleanConfig', - ], + 'schema' => ['description' => 'The input parameters to trigger the command or playbook.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "param1": "xx.xx.xx.xx",'."\n" + .' "param2": "7d"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'VendorCode', + 'name' => 'SophonTaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'Vendor code:'."\n" - .'- **Tencent**: Tencent.'."\n" - .'- **HUAWEICLOUD**: Huawei.'."\n" - .'- **Azure**: Microsoft Azure.'."\n" - .'- **AWS**: Amazon Web Services.'."\n" - .'- **Chaitin**: Chaitin.', - 'type' => 'string', - 'required' => false, - 'example' => 'Azure', - ], + 'schema' => ['description' => 'A custom ID for the task. If you do not specify this parameter when you trigger the playbook, a random ID is generated. You can use the ID to locate and troubleshoot issues.', 'type' => 'string', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain the playbook UUID.', 'type' => 'string', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'TriggerType', + 'in' => 'query', + 'schema' => ['description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- **command**: triggers a command task'."\n" + ."\n" + .'- **playbook**: triggers a playbook task', 'type' => 'string', 'required' => false, 'example' => 'playbook', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'SophonResult<SophonTaskResult>', + 'description' => 'The information returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used to troubleshoot and locate issues.', - 'type' => 'string', - 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94', - ], - 'Page' => [ - 'description' => 'Pagination query information.', + 'Data' => [ + 'title' => '', + 'description' => 'The details returned after the command or playbook is triggered.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'Total number of items.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The current page number in the pagination query.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'SophonTaskId' => ['description' => 'A custom ID for the task. If you do not specify this parameter when you trigger the playbook, a random ID is generated. You can use the ID to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'a7c6d055-a72f-4676-bc89-3cd9edc0284c', 'title' => ''], + ], + 'example' => '', + ], + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SophonTaskId\\": \\"a7c6d055-a72f-4676-bc89-3cd9edc0284c\\"\\n },\\n \\"RequestId\\": \\"0DFC9403-54EB-5672-B690-9AA93C9EBB54\\"\\n}","type":"json"}]', + 'title' => 'TriggerSophonPlaybook', + 'description' => 'Before calling this operation, ensure you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for response orchestration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 2, 'regionId' => '*', 'api' => 'TriggerSophonPlaybook'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'yundun-sas:TriggerSophonPlaybook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'VerifyPlaybook' => [ + 'summary' => 'Verifies that a playbook configuration is correct and its orchestration logic is valid.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => ['description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9fcd3829-80ff-4681-be1e-4d2662c35fed'], + ], + [ + 'name' => 'TaskFlow', + 'in' => 'formData', + 'schema' => ['description' => 'The XML configuration of the playbook.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<CheckTaskInfo>>', + 'description' => 'The response parameters for the playbook verification.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique identifier for the request. Use this ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54'], + 'CheckTaskInfos' => [ + 'title' => '', + 'description' => 'The verification results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => ['description' => 'The severity level of the verification message. Valid values:'."\n" + ."\n" + .'- **warn**: A warning message. An issue may occur when the playbook runs.'."\n" + ."\n" + .'- **error**: An error message. The playbook fails to be compiled.'."\n" + ."\n" + .'- **remind**: A suggestion. This does not affect publishing or running the playbook. Optimize the playbook format.', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'NodeName' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'example' => 'python3_3', 'title' => ''], + 'Detail' => ['description' => 'The specific error message that is returned if the verification fails.', 'type' => 'string', 'example' => 'Node [python3_3] doesn\'t have the asset information', 'title' => ''], ], - 'PageSize' => [ - 'description' => 'The number of items displayed per page in the pagination query.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Prerequisites' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrerequisiteType' => ['description' => 'The check type. Valid values:'."\n" + ."\n" + .'- **role**: The name of the custom RAM role.'."\n" + ."\n" + .'- **policies**: The list of RAM system policies.', 'type' => 'string', 'example' => 'role', 'title' => ''], + 'PrerequisiteValue' => ['description' => 'The check content. The value is determined as follows:'."\n" + ."\n" + .'- If PrerequisiteType is **role**, the value is the static field AliyunSiemSoarExecutionDefaultRole.'."\n" + ."\n" + .'- If PrerequisiteType is **policies**, the value is a collection of policy names.', 'type' => 'string', 'example' => 'AliyunSiemSoarExecutionDefaultRole', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The prerequisite check information for the playbook.', + 'title' => '', + 'example' => '', ], - 'ApiList' => [ - 'description' => 'Product information.', + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DFC9403-54EB-5672-B690-9AA93C9EBB54\\",\\n \\"CheckTaskInfos\\": [\\n {\\n \\"RiskLevel\\": \\"error\\",\\n \\"NodeName\\": \\"python3_3\\",\\n \\"Detail\\": \\"Node [python3_3] doesn\'t have the asset information\\"\\n }\\n ],\\n \\"Prerequisites\\": [\\n {\\n \\"PrerequisiteType\\": \\"role\\",\\n \\"PrerequisiteValue\\": \\"AliyunSiemSoarExecutionDefaultRole\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'VerifyPlaybook', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPlaybook'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:VerifyPlaybook', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], + ], + ], + ], + ], + ], + 'VerifyPythonFile' => [ + 'summary' => 'Verifies the syntax of a Python code snippet.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The Python code snippet to verify.', 'type' => 'string', 'required' => true, 'example' => 'import logging'."\n" + .'def execute (params):'."\n" + .' success=True'."\n" + .' message=\'OK\''."\n" + .' data=[]'."\n" + .' return (success,message,data)', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PythonVerifyDTO>', + 'description' => 'The code hinting information returned after verification.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'F72685FB-A6E6-5A9A-97F7-6DC1056E63CE'], + 'Syntax' => [ + 'description' => 'The result set of the Python code verification. If this parameter is empty, the code syntax is correct.', 'type' => 'array', 'items' => [ - 'description' => 'Product information.', 'type' => 'object', 'properties' => [ - 'VendorCode' => [ - 'description' => 'Vendor code:'."\n" - .'- **Tencent**: Tencent.'."\n" - .'- **HUAWEICLOUD**: Huawei.'."\n" - .'- **Azure**: Microsoft Azure.'."\n" - .'- **AWS**: Amazon Web Services.'."\n" - .'- **Chaitin**: Chaitin.', - 'type' => 'string', - 'example' => 'Azure', - ], - 'ProductCode' => [ - 'description' => 'Vendor\'s product identifier:'."\n" - .'- **waf**: Web Application Firewall.'."\n" - .'- **cfw**: Cloud Firewall.', - 'type' => 'string', - 'example' => 'cfw', - ], - 'ProductName' => [ - 'description' => 'Product name.', - 'type' => 'string', - 'example' => 'waf', - ], - 'Parameter' => [ - 'description' => 'Interface request parameter configuration information.', - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "name": "Domain",'."\n" - .' "type": "String",'."\n" - .' "isRequired": true,'."\n" - .' "exampleValue": "www.***.com",'."\n" - .' "description": "www.***.com"'."\n" - .' }'."\n" - .']', - ], - 'ProductDomain' => [ - 'description' => 'Default domain of the product.', - 'type' => 'string', - 'example' => 'cfw.xxx.com', - ], - 'Protocol' => [ - 'description' => 'Request protocol. Values:'."\n" - .'- **http**: HTTP request protocol.'."\n" - .'- **https**: HTTPS request protocol.', - 'type' => 'string', - 'example' => 'https', - ], - 'Method' => [ - 'description' => 'Request methods: '."\n" - .'- **POST**: POST request method. '."\n" - .'- **GET**: GET request method. '."\n" - .'- **PUT**: PUT request method. '."\n" - .'- **DELETE**: DELETE request method.', - 'type' => 'string', - 'example' => 'POST', - ], - 'ApiName' => [ - 'description' => 'The name of the vendor\'s API.', - 'type' => 'string', - 'example' => 'VerifyMobile', - ], - 'NeedPageInfo' => [ - 'description' => 'Indicates whether pagination is needed.'."\n" - .'- **true**: Yes.'."\n" - .'- **false**: No.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'PageInfo' => [ - 'description' => 'Information displayed on the page.', - 'type' => 'string', - 'example' => '{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}', - ], - 'ApiVersion' => [ - 'description' => 'The version number of the API.', - 'type' => 'string', - 'example' => '2017-08-01', - ], - 'NeedAdvanceConfig' => [ - 'description' => 'Indicates whether advanced configuration is included.'."\n" - .'- **true**: Yes.'."\n" - .'- **false**: No.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AdvanceConfig' => [ - 'description' => 'Advanced configuration for the API.', - 'type' => 'string', - 'example' => '{'."\n" - .' "cmd": "DescribeAclApiDispatch"'."\n" - .'}', + 'StartLineNumber' => ['description' => 'The starting line number of the code that contains an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'StartColumn' => ['description' => 'The starting column number of the code that contains an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'EndLineNumber' => ['description' => 'The ending line number of the code that contains an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'EndColumn' => ['description' => 'The ending column number of the code that contains an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Message' => ['description' => 'The error message for the code.', 'type' => 'string', 'example' => 'undefined name \'ab\'', 'title' => ''], + 'Severity' => [ + 'description' => 'The error level of the code.'."\n" + ."\n" + .'- 4: General error'."\n" + ."\n" + .'- 8: Critical error', + 'enumValueTitles' => [4 => 'General error', 8 => 'Critical error'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 491 => [ + ['errorCode' => 'Playbook.External.ParamError', 'errorMessage' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F72685FB-A6E6-5A9A-97F7-6DC1056E63CE\\",\\n \\"Syntax\\": [\\n {\\n \\"StartLineNumber\\": 2,\\n \\"StartColumn\\": 2,\\n \\"EndLineNumber\\": 5,\\n \\"EndColumn\\": 5,\\n \\"Message\\": \\"undefined name \'ab\'\\",\\n \\"Severity\\": 4\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'VerifyPythonFile', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPythonFile'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'yundun-sas:VerifyPythonFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-****-5840-8EC9-691B86729E94\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"ApiList\\": [\\n {\\n \\"VendorCode\\": \\"Azure\\",\\n \\"ProductCode\\": \\"cfw\\",\\n \\"ProductName\\": \\"waf\\",\\n \\"Parameter\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"Domain\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"isRequired\\\\\\": true,\\\\n \\\\\\"exampleValue\\\\\\": \\\\\\"www.***.com\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"www.***.com\\\\\\"\\\\n }\\\\n]\\",\\n \\"ProductDomain\\": \\"cfw.xxx.com\\",\\n \\"Protocol\\": \\"https\\",\\n \\"Method\\": \\"POST\\",\\n \\"ApiName\\": \\"VerifyMobile\\",\\n \\"NeedPageInfo\\": false,\\n \\"PageInfo\\": \\"{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}\\",\\n \\"ApiVersion\\": \\"2017-08-01\\",\\n \\"NeedAdvanceConfig\\": true,\\n \\"AdvanceConfig\\": \\"{\\\\n \\\\\\"cmd\\\\\\": \\\\\\"DescribeAclApiDispatch\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeVendorApiList', - 'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., threat analysis and response log access traffic) before using this interface.', - 'translator' => 'machine', ], ], 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'vpc' => 'sophonsoar-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'public', 'regionName' => 'Public network', 'areaId' => 'other', 'areaName' => 'Other', 'public' => 'sophonsoar.aliyuncs.com', 'endpoint' => 'sophonsoar.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'Component.External.NotExist', 'message' => 'Component does not exist.', 'http_code' => 400, 'description' => 'Component does not exist.'], + ['code' => 'ComponentAsset.External.NotExist', 'message' => 'The component asset is not exist.', 'http_code' => 400, 'description' => 'The asset corresponding to the component you entered does not exist. Please enter it again.'], + ['code' => 'Playbook.Abnormal.ERROR', 'message' => 'Interface call exception, please contact the developer.', 'http_code' => 400, 'description' => ''], + ['code' => 'Playbook.External.AccountError', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => 'Parameter error. Please login with an buy user account. Verify the provided parameters and try again.'], + ['code' => 'Playbook.External.DebugError', 'message' => 'Debugging the script failed. Please verify whether the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => ''], + ['code' => 'Playbook.External.InvalidParameter', 'message' => 'The request parameter is incorrect. Please verify the provided parameters and try again.', 'http_code' => 400, 'description' => 'The request parameter is incorrect. Please verify the provided parameters and try again.'], + ['code' => 'Playbook.External.ParamError', 'message' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'http_code' => 400, 'description' => 'The parameters of the request interface are incorrect. Please verify the parameters and request again.'], + ['code' => 'Playbook.External.PublishError', 'message' => 'Failed to publish or run the script. Please verify that the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => 'Failed to publish or run the script. Please check whether the status and configuration of the script are correct before trying again.'], + ['code' => 'Playbook.External.StatusError', 'message' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.', 'http_code' => 400, 'description' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.'], + ['code' => 'Playbook.Internal.MetricsError', 'message' => 'The configuration information is abnormal, please check the relevant configuration.', 'http_code' => 400, 'description' => 'The configuration information is abnormal. You are requested to check the configuration.'], + ['code' => 'Playbook.Internal.RecordError', 'message' => 'The data format is abnormal, please check whether the data format meets the requirements.', 'http_code' => 400, 'description' => 'The data format is abnormal. Check whether the data format meets the requirements.'], + ['code' => 'SYS_ERROR', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => 'The parameter is incorrect. Please verify the provided parameters and try again: Please use the purchase account to access.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RunNotifyComponentWithEmail'], + ['description' => 'Request parameters changed', 'api' => 'RunNotifyComponentWithMessageCenter'], + ['description' => 'Request parameters changed', 'api' => 'RunNotifyComponentWithWebhook'], + ], + 'createdAt' => '2025-12-09T11:25:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RunPython3Script'], + ], + 'createdAt' => '2025-11-27T13:31:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribePlaybooks'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeProcessTasks'], + ], + 'createdAt' => '2024-11-01T08:33:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeProcessTasks'], + ], + 'createdAt' => '2024-05-21T08:18:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribePlaybookInputOutput'], + ], + 'createdAt' => '2024-03-21T02:56:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeExecutePlaybooks'], + ['description' => 'Response parameters changed', 'api' => 'DescribePlaybook'], + ['description' => 'Response parameters changed', 'api' => 'DescribeProcessTasks'], + ], + 'createdAt' => '2024-03-19T03:26:23.000Z', + 'description' => '', + ], [ - 'regionId' => 'public', - 'endpoint' => 'sophonsoar.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribePlaybookInputOutput'], + ], + 'createdAt' => '2024-03-15T02:09:33.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyPlaybook'], + ], + 'createdAt' => '2023-12-07T09:16:36.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeUsedInfos'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordInOutput'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookInputOutput'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentsJs'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunPython3Script'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DebugPlaybook'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerPlaybook'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupProductions'], + ['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTasks'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPythonFile'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarTaskAndActions'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlaybook'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentAsset'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPlaybook'], + ['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybooks'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssets'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeParamTags'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookReleases'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyPlaybook'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeField'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVendorApiList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePopApi'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSophonCommands'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiInfo'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybook'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyComponentAsset'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNumberMetrics'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistinctReleases'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchModifyInstanceStatus'], + ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTaskCount'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPlaybook'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertPlaybook'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInputOutput'], + ['threshold' => '20', 'countWindow' => 2, 'regionId' => '*', 'api' => 'TriggerSophonPlaybook'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishPlaybook'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescriberPython3ScriptLogs'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ComparePlaybooks'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExecutePlaybooks'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNotifyTemplateList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessStatistics'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevertPlaybookRelease'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybook'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssetForm'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookMetrics'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlaybook'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLatestRecordSchema'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInstanceStatus'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithEmail'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenamePlaybookNode'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecords'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTreeData'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnumItems'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithWebhook'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNodesOutput'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordActionOutputList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithMessageCenter'], + ['threshold' => '50', 'countWindow' => 5, 'regionId' => '*', 'api' => 'TriggerProcessTask'], + ], + ], + 'ram' => [ + 'productCode' => 'ThreatDetection', + 'productName' => 'Security Center', + 'ramCodes' => ['threatdetection', 'yundun-aegis', 'yundun-sas'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [ + [ + 'name' => 'acs:ResourceGroupId', + 'schema' => ['type' => 'String', 'description' => '资源组ID'], + ], ], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; diff --git a/data/en_us/sophonsoar/2025-09-03/api-docs.php b/data/en_us/sophonsoar/2025-09-03/api-docs.php index 4b8a064..9eef3f8 100644 --- a/data/en_us/sophonsoar/2025-09-03/api-docs.php +++ b/data/en_us/sophonsoar/2025-09-03/api-docs.php @@ -1,51 +1,25 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'sophonsoar', - 'version' => '2025-09-03', - ], + 'info' => ['style' => 'RPC', 'product' => 'sophonsoar', 'version' => '2025-09-03'], 'directories' => [ [ - 'id' => 278796, - 'title' => 'Orchestration Automation and Response', + 'children' => ['CreateComponentAsset', 'DeleteComponentAsset', 'UpdateComponentAsset', 'ListComponentAssets', 'GetPlaybook', 'ListPlaybooks', 'CreatePlaybook', 'DeletePlaybook', 'UpdatePlaybook', 'ExecuteComponent'], 'type' => 'directory', - 'children' => [ - 'ListComponents', - 'CreateComponentAsset', - 'DeleteComponentAsset', - 'UpdateComponentAsset', - 'ListComponentAssets', - 'GetPlaybook', - 'ListPlaybooks', - 'CreatePlaybook', - 'DeletePlaybook', - 'UpdatePlaybook', - ], + 'title' => 'Response orchestration', ], [ - 'id' => 0, - 'title' => '其它', + 'children' => ['AbortPlaybookExecution', 'ListComponents'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'ExecuteComponent', - ], ], ], 'components' => [ 'schemas' => [ 'FieldInputConfig' => [ 'description' => 'Configuration of input parameters.', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'FieldName' => [ - 'description' => 'Field name.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'appName', - 'backendName' => 'fieldName', - ], + 'FieldName' => ['description' => 'Field name.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldType' => [ 'description' => 'The field type. The value is as follows:'."\n" ."\n" @@ -62,104 +36,50 @@ .'- **host**: host entity.'."\n" .'- **domain**: The domain name entity.'."\n" .'- **container**: container entity.', - 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], - 'example' => 'String', - 'backendName' => 'fieldType', - ], - 'DefaultValue' => [ - 'description' => 'Field default value.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'defaultValue', - ], - 'Required' => [ - 'description' => 'Is the field mandatory? Possible values are:'."\n" - ."\n" - .'- **true**: Required.'."\n" - .'- **false**: Optional.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'required', - ], - 'Arrayed' => [ - 'description' => 'Is the field arrayed? Possible values are:'."\n" - ."\n" - .'- true: Arrayed.'."\n" - .'- false: Not Arrayed.', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'arrayed', - ], - 'FieldPath' => [ - 'description' => 'Field path.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xx.appName', - 'backendName' => 'fieldPath', - ], - 'FieldCheckRegex' => [ - 'description' => 'Field check regex.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[a-zA-Z0-9\\u4e00-\\u9fa5_-]{2,128}', - 'backendName' => 'fieldCheckRegex', - ], - 'FieldExample' => [ - 'description' => 'Field example.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - 'backendName' => 'fieldExample', - ], - 'FieldClass' => [ - 'description' => 'Field types, with the following values:'."\n" - ."\n" - .'- **normal**: Normal type.'."\n" - .'- **custom**: Complex type; in this mode, FieldConfigs can be configured.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'normal', - 'backendName' => 'fieldClass', - ], - 'FieldDescription' => [ - 'description' => 'Field description.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'app name', - 'backendName' => 'fieldDescription', - ], + 'title' => '', + 'example' => '', + ], + 'DefaultValue' => ['description' => 'Field default value.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Required' => ['description' => 'Is the field mandatory? Possible values are:'."\n" + ."\n" + .'- **true**: Required.'."\n" + .'- **false**: Optional.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'Arrayed' => ['description' => 'Is the field arrayed? Possible values are:'."\n" + ."\n" + .'- true: Arrayed.'."\n" + .'- false: Not Arrayed.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'FieldPath' => ['description' => 'Field path.', 'type' => 'string', 'title' => '', 'example' => ''], + 'FieldCheckRegex' => ['description' => 'Field check regex.', 'type' => 'string', 'title' => '', 'example' => ''], + 'FieldExample' => ['description' => 'Field example.', 'type' => 'string', 'title' => '', 'example' => ''], + 'FieldClass' => ['description' => 'Field types, with the following values:'."\n" + ."\n" + .'- **normal**: Normal type.'."\n" + .'- **custom**: Complex type; in this mode, FieldConfigs can be configured.', 'type' => 'string', 'title' => '', 'example' => ''], + 'FieldDescription' => ['description' => 'Field description.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldConfigs' => [ 'description' => 'Supports configuring nested input parameters in complex-type scenarios.', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'Configuration of input parameters.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/FieldInputConfig', - ], - 'backendName' => 'fieldConfigs', + 'items' => ['description' => 'Configuration of input parameters.', '$ref' => '#/components/schemas/FieldInputConfig', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'FieldOutputConfig' => [ 'description' => 'Configuration of output parameters.', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', - 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], - 'example' => 'ip', - 'backendName' => 'fieldName', + 'title' => '', + 'example' => '', ], 'FieldType' => [ 'description' => 'Field type, with the following values:'."\n" @@ -169,62 +89,36 @@ .'- **Integer**: Integer.'."\n" .'- **Double**: Double.'."\n" .'- **Boolean**: Boolean.', - 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], - 'example' => 'String', - 'backendName' => 'fieldType', - ], - 'FieldDescription' => [ - 'description' => 'Field description information.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Single IP to be blocked', - 'backendName' => 'fieldDescription', - ], - 'DefaultValue' => [ - 'description' => 'Field default value.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '11.**.*.11', - 'backendName' => 'defaultValue', - ], - 'FieldExample' => [ - 'description' => 'Field example.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2.*.*.2', - 'backendName' => 'fieldExample', + 'title' => '', + 'example' => '', ], + 'FieldDescription' => ['description' => 'Field description information.', 'type' => 'string', 'title' => '', 'example' => ''], + 'DefaultValue' => ['description' => 'Field default value.', 'type' => 'string', 'title' => '', 'example' => ''], + 'FieldExample' => ['description' => 'Field example.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'apis' => [ - 'ListComponents' => [ - 'summary' => 'Get Component List.', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AbortPlaybookExecution' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -232,347 +126,65 @@ [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language type for the request and response. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - ."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language type for receiving messages. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'Resource directory member account ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'The User ID of a member whose perspective an administrator switches to.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ - 'name' => 'ComponentName', + 'name' => 'RoleType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the component.', - 'type' => 'string', - 'required' => false, - 'example' => 'SLS', - ], + 'schema' => ['description' => 'The view type. Valid values:'."\n" + ."\n" + .'- **0**: View of the current Alibaba Cloud account.'."\n" + .'- **1**: View of all accounts under the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'PlaybookExecutionUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number for pagination, with a default value of 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of items per page for pagination. Range: 1~100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The size of the page. Range: 1~100. Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The playbook execution ID.', 'type' => 'string', 'required' => true, 'example' => 'e776dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'The token to start the next page query.', - 'type' => 'string', - 'required' => false, - 'example' => 'kt0BLbenY2XCyRfsmoEcVg=='."\n", - ], + 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response information.', + 'title' => '', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of items found.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '52', - ], - 'RequestId' => [ - 'description' => 'The unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n", - ], - 'Components' => [ - 'description' => 'List of components.', - 'type' => 'array', - 'items' => [ - 'description' => 'Component information.', - 'type' => 'object', - 'properties' => [ - 'ComponentName' => [ - 'description' => 'The name of the component.', - 'type' => 'string', - 'example' => 'SLS', - ], - 'ComponentAlias' => [ - 'description' => 'The alias of the component.', - 'type' => 'string', - 'example' => 'Log', - ], - 'ComponentDescription' => [ - 'description' => 'The description of the component.', - 'type' => 'string', - 'example' => 'Log query', - ], - 'ComponentLogo' => [ - 'description' => 'The icon URL of the component.', - 'type' => 'string', - 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg', - ], - 'ComponentExtension' => [ - 'description' => 'Extended information of the component.', - 'type' => 'string', - 'example' => '{"type":"common"}', - ], - 'ComponentActions' => [ - 'description' => 'List of component actions.', - 'type' => 'array', - 'items' => [ - 'description' => 'Component action.', - 'type' => 'object', - 'properties' => [ - 'ComponentActionName' => [ - 'description' => 'The name of the component action.', - 'type' => 'string', - 'example' => 'QueryLogs', - ], - 'ComponentActionDescription' => [ - 'description' => 'The description of the component action name.', - 'type' => 'string', - 'example' => 'Query logs from SLS', - ], - 'InputConfigs' => [ - 'description' => 'Configuration of input parameters for the action.', - 'type' => 'array', - 'items' => [ - 'description' => 'Input parameters for the action.', - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'Field name.', - 'type' => 'string', - 'example' => 'Project', - ], - 'FieldType' => [ - 'description' => 'Field type, with the following values:'."\n" - ."\n" - .'- **String**: String.'."\n" - .'- **Long**: Long integer.'."\n" - .'- **Integer**: Integer.'."\n" - .'- **Double**: Double.'."\n" - .'- **Boolean**: Boolean.'."\n" - .'- **Complex**: Key-value pair.', - 'type' => 'string', - 'example' => 'String', - ], - 'FieldDescription' => [ - 'description' => 'Field description information.', - 'type' => 'string', - 'example' => 'Project Name', - ], - 'FieldDisplayConfig' => [ - 'description' => 'Field display configuration.', - 'type' => 'string', - 'example' => '{'."\n" - .' "height": 200,'."\n" - .' "theme": "vs-light",'."\n" - .' "language": "markdown",'."\n" - .' "editorOptions": {}'."\n" - .'}', - ], - 'DefaultValue' => [ - 'description' => 'Default value.', - 'type' => 'string', - 'example' => '1', - ], - 'Required' => [ - 'description' => 'Whether this parameter is required.'."\n" - ."\n" - .'- **true**: Required.'."\n" - .'- **false**: Not required.', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'OutputConfigs' => [ - 'description' => 'Action output parameter configuration.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'Field name.', - 'type' => 'string', - 'example' => 'lh_source', - ], - 'FieldType' => [ - 'description' => 'Field type, with the following values:'."\n" - ."\n" - .'- **String**: String.'."\n" - .'- **Long**: Long integer.'."\n" - .'- **Integer**: Integer.'."\n" - .'- **Double**: Double.'."\n" - .'- **Boolean**: Boolean.'."\n" - .'- **Complex**: Key-value pair.', - 'type' => 'string', - 'example' => 'String', - ], - ], - ], - ], - ], - ], - ], - 'ComponentAssetConfigs' => [ - 'description' => 'List of asset field configurations.', - 'type' => 'array', - 'items' => [ - 'description' => 'Asset field configuration.', - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'Field name.', - 'type' => 'string', - 'example' => 'project', - ], - 'FieldType' => [ - 'description' => 'Field type, with the following values:'."\n" - ."\n" - .'- **String**: String.'."\n" - .'- **Long**: Long integer.'."\n" - .'- **Integer**: Integer.'."\n" - .'- **Double**: Double.'."\n" - .'- **Boolean**: Boolean.'."\n" - .'- **Complex**: Key-value pair.', - 'type' => 'string', - 'example' => 'String', - ], - 'FieldDescription' => [ - 'description' => 'Description of the field.', - 'type' => 'string', - 'example' => 'project name', - ], - 'Required' => [ - 'description' => 'Whether this parameter is required.'."\n" - ."\n" - .'- **true**: Required.'."\n" - .'- **false**: Not required.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Encrypted' => [ - 'description' => 'Whether the field value needs to be encrypted. The range of values is as follows:'."\n" - ."\n" - .'- true: Encrypted.'."\n" - .'- false: Not encrypted.'."\n" - ."\n" - .'Default value: false.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DefaultValue' => [ - 'description' => 'Default value.', - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'Creation time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757902337000', - ], - 'UpdateTime' => [ - 'description' => 'Update time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757902337000', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => 'Page number for pagination, with a default value of 1.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'Number of items per page for pagination. Range: 1~100.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxResults' => [ - 'description' => 'Maximum number of results returned in a single request. Range: 1~100.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => 'Token for the start of the next query.', - 'type' => 'string', - 'example' => '7fbb1c66d607c1f79a740f039a8dcfda', - ], + 'RequestId' => ['description' => 'The ID of this request, which is a Unique Identifier (UUID) generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues.', 'title' => '', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n"], + 'Success' => ['description' => 'Indicates whether the job was stopped successfully. Valid values:'."\n" + ."\n" + .'- *true*: The job was stopped successfully.'."\n" + .'- *false*: The job was not stopped successfully.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 52,\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"Components\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAlias\\": \\"Log\\",\\n \\"ComponentDescription\\": \\"Log query\\",\\n \\"ComponentLogo\\": \\"https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg\\",\\n \\"ComponentExtension\\": \\"{\\\\\\"type\\\\\\":\\\\\\"common\\\\\\"}\\",\\n \\"ComponentActions\\": [\\n {\\n \\"ComponentActionName\\": \\"QueryLogs\\",\\n \\"ComponentActionDescription\\": \\"Query logs from SLS\\",\\n \\"InputConfigs\\": [\\n {\\n \\"FieldName\\": \\"Project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"Project Name\\",\\n \\"FieldDisplayConfig\\": \\"{\\\\n \\\\\\"height\\\\\\": 200,\\\\n \\\\\\"theme\\\\\\": \\\\\\"vs-light\\\\\\",\\\\n \\\\\\"language\\\\\\": \\\\\\"markdown\\\\\\",\\\\n \\\\\\"editorOptions\\\\\\": {}\\\\n}\\",\\n \\"DefaultValue\\": \\"1\\",\\n \\"Required\\": false\\n }\\n ],\\n \\"OutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldType\\": \\"String\\"\\n }\\n ]\\n }\\n ],\\n \\"ComponentAssetConfigs\\": [\\n {\\n \\"FieldName\\": \\"project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"project name\\",\\n \\"Required\\": false,\\n \\"Encrypted\\": false,\\n \\"DefaultValue\\": \\"1\\"\\n }\\n ],\\n \\"CreateTime\\": 1757902337000,\\n \\"UpdateTime\\": 1757902337000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"7fbb1c66d607c1f79a740f039a8dcfda\\"\\n}","type":"json"}]', - 'title' => 'Get Component List', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Stop Playbook Execution', + 'summary' => 'Stop the execution of a playbook and its sub-playbooks.', + 'description' => 'Before using this API, make sure you fully understand the billing method of Response Orchestration and its [pricing](https://www.aliyun.com/price/product#/sas/detail/sas).', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreateComponentAsset' => [ - 'summary' => 'Create Component Asset.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -584,9 +196,7 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -594,115 +204,77 @@ [ 'name' => 'ComponentName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the component.', - 'type' => 'string', - 'required' => true, - 'example' => 'SLS', - ], + 'schema' => ['description' => 'The name of the component.', 'type' => 'string', 'required' => true, 'example' => 'SLS', 'title' => ''], ], [ 'name' => 'ComponentAssetName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the asset.', - 'type' => 'string', - 'required' => true, - 'example' => 'shanghai-log-config', - ], + 'schema' => ['description' => 'The asset name.', 'type' => 'string', 'required' => true, 'example' => 'shanghai-log-config', 'title' => ''], ], [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language type for receiving messages. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'ComponentAssetValues', 'in' => 'formData', 'style' => 'flat', 'schema' => [ - 'description' => 'Configuration information of the asset.', + 'description' => 'The configuration information of the asset.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the asset fields.', + 'description' => 'The asset field information.', 'type' => 'object', 'properties' => [ - 'FieldName' => [ - 'description' => 'Field name.', - 'type' => 'string', - 'required' => true, - 'example' => 'endpoint', - ], - 'FieldValue' => [ - 'description' => 'Field value.', - 'type' => 'string', - 'required' => true, - 'example' => 'http://logs.aliyuncs.com', - ], + 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'endpoint', 'title' => ''], + 'FieldValue' => ['description' => 'The field value.', 'type' => 'string', 'required' => true, 'example' => 'http://logs.aliyuncs.com', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'Resource directory member account ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'The ID of the member account in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Return information.', + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request and can be used to troubleshoot and locate issues.', - 'type' => 'string', - 'example' => '0727DAC8-****-51EC-****-14999C62B502', - ], - 'ComponentAssetUuid' => [ - 'description' => 'Asset UUID.', - 'type' => 'string', - 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'], + 'ComponentAssetUuid' => ['description' => 'The UUID of the asset.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'."\n", 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an asset', + 'summary' => 'Creates an asset for a component.', + 'description' => 'Make sure that you are familiar with the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Cloud Threat Detection and Response (CTDR) log ingestion before you call this operation.', + 'changeSet' => [], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\\\n\\"\\n}","type":"json"}]', - 'title' => 'Create Component Asset', - 'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., Threat Analysis and Response Log Ingress Traffic) before using this interface.', 'translator' => 'machine', ], - 'DeleteComponentAsset' => [ - 'summary' => 'Delete Component Asset.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreatePlaybook' => [ + 'summary' => 'Create a playbook.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -711,12 +283,10 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -724,71 +294,102 @@ [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'Set the language type for requests and received messages, default is **zh**. Values:'."\n" - ."\n" - .'- **zh**: Chinese'."\n" - .'- **en**: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language type for receiving messages. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', + 'schema' => ['description' => 'The member account ID in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '170*********3093', 'title' => ''], + ], + [ + 'name' => 'PlaybookName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the playbook. Special characters are not allowed.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 2, 'example' => 'waftest', 'title' => ''], + ], + [ + 'name' => 'PlaybookDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the playbook.', 'type' => 'string', 'maxLength' => 512, 'minLength' => 0, 'required' => false, 'example' => 'waf ip block', 'title' => ''], + ], + [ + 'name' => 'PlaybookInputConfigs', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => 'Resource directory member account ID.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The input parameter configurations of the playbook.', + 'type' => 'array', + 'items' => ['description' => 'The input parameter configuration.', '$ref' => '#/components/schemas/FieldInputConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - 'example' => '13760*****718726', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ComponentAssetUuid', + 'name' => 'PlaybookOutputConfigs', 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => 'Asset UUID.', - 'type' => 'string', - 'required' => true, - 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', + 'description' => 'The output parameter configurations of the playbook.', + 'type' => 'array', + 'items' => ['description' => 'The output parameter configuration.', '$ref' => '#/components/schemas/FieldOutputConfig', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'SrcPlaybookUuid', + 'in' => 'formData', + 'schema' => ['description' => 'The UUID of the source playbook to be specified in the copy scenario. When this parameter has a value, all other parameters except the playbook name and playbook description are ignored.', 'type' => 'string', 'required' => false, 'example' => '1B5A9144-****-****-A466-****9D64AA99', 'title' => ''], + ], + [ + 'name' => 'PlaybookTaskFlow', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow of the playbook.', 'type' => 'string', 'required' => false, 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]', 'title' => ''], + ], + [ + 'name' => 'PlaybookParamType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The parameter type of the playbook. Valid values:'."\n" + ."\n" + .'- **template-ip**: IP entity.'."\n" + .'- **template-file**: File entity.'."\n" + .'- **template-process**: Process entity.'."\n" + .'- **template-host**: Host entity.'."\n" + .'- **template-domain**: Domain entity.'."\n" + .'- **template-container**: Container entity.'."\n" + .'- **template-incident**: Security incident.'."\n" + .'- **template-alert**: Security alert.'."\n" + .'- **custom**: Custom.', 'type' => 'string', 'example' => 'custom', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Return information.', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.', - 'type' => 'string', - 'example' => '0727DAC8-****-51EC-****-14999C62B502', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request. It can be used for troubleshooting and problem locating.', 'type' => 'string', 'example' => '007BC211-709E-549B-9534-4C8EA0922828'], + 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => 'e99dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\"\\n}","type":"json"}]', - 'title' => 'Delete Component Asset', - 'description' => 'Please ensure that before using this interface, you have fully understood the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., Threat Analysis and Response Log Access Traffic).', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a playbook', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"007BC211-709E-549B-9534-4C8EA0922828\\",\\n \\"PlaybookUuid\\": \\"e99dab31-499b-4307-9248-xxxxxx\\"\\n}","type":"json"}]', 'translator' => 'machine', ], - 'UpdateComponentAsset' => [ - 'summary' => 'Update Component Asset.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteComponentAsset' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -797,12 +398,10 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -810,342 +409,205 @@ [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language type for the request and response. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - ."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'- **zh**: Chinese'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ - 'name' => 'ComponentAssetUuid', + 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'Asset UUID.', - 'type' => 'string', - 'required' => true, - 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', - ], + 'schema' => ['description' => 'The ID of the member account in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ - 'name' => 'ComponentAssetValues', + 'name' => 'ComponentAssetUuid', 'in' => 'formData', - 'style' => 'flat', + 'schema' => ['description' => 'The UUID of the asset.', 'type' => 'string', 'required' => true, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Configuration information of the asset.', - 'type' => 'array', - 'items' => [ - 'description' => 'Configuration information of the asset.', - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'Field name.', - 'type' => 'string', - 'required' => false, - 'example' => 'lh_source', - ], - 'FieldValue' => [ - 'description' => 'Field value.', - 'type' => 'string', - 'required' => false, - 'example' => 'device', - ], - ], - 'required' => false, + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'], ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a component asset', + 'summary' => 'Deletes a component asset.', + 'description' => 'Make sure that you are fully aware of the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Cloud Threat Detection and Response (CTDR) log traffic before you call this operation.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeletePlaybook' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], [ 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'Resource directory member account ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'The ID of the user to whom the administrator switches the view.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ - 'name' => 'ComponentAssetName', + 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'Asset name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test_asset', - ], + 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response information.', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.', - 'type' => 'string', - 'example' => '0727DAC8-****-51EC-****-14999C62B502', - ], - 'ComponentAssetUuid' => [ - 'description' => 'Asset UUID.', - 'type' => 'string', - 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.', 'type' => 'string', 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\"\\n}","type":"json"}]', - 'title' => 'Update Component Asset', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a playbook', + 'summary' => 'Deletes a specified custom playbook.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]', 'translator' => 'machine', ], - 'ListComponentAssets' => [ - 'summary' => 'Get the list of assets configured for a component.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ExecuteComponent' => [ + 'summary' => 'Runs a component in a playbook and returns the execution result of the component.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Lang', + 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language type for requests and responses. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - ."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'The UUID of the playbook.'."\n" + .'>You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'example' => 'ac343acc-1a61-4084-9a1cxxxxx', 'required' => false], ], [ - 'name' => 'RoleFor', + 'name' => 'PlayBookNodeName', 'in' => 'formData', - 'schema' => [ - 'description' => 'Resource directory member account ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'The node name of the current component in the playbook.', 'type' => 'string', 'required' => false, 'example' => 'node1', 'title' => ''], ], [ 'name' => 'ComponentName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the component.', - 'type' => 'string', - 'required' => false, - 'example' => 'SLS', - ], + 'schema' => ['title' => '', 'description' => 'The name of the component.', 'type' => 'string', 'example' => 'SLS', 'required' => false], ], [ - 'name' => 'ComponentAssetUuid', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Asset UUID.', - 'type' => 'string', - 'required' => false, - 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'ComponentActionName', 'in' => 'formData', - 'schema' => [ - 'description' => 'Page number for paginated queries, with a default value of 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The action name of the component.', 'type' => 'string', 'required' => false, 'example' => 'doRequest'], ], [ - 'name' => 'PageSize', + 'name' => 'ComponentAssetUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'Number of items per page for paginated queries. Range: 1~100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The UUID of the asset.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'required' => false], ], [ - 'name' => 'MaxResults', + 'name' => 'ComponentInput', 'in' => 'formData', - 'schema' => [ - 'description' => 'Maximum number of results to return. Range: 0~100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The input parameters of the component.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'Lang', 'in' => 'formData', 'schema' => [ - 'description' => 'Token for the next query. Value: Not required for the first query or if there is no next query. For subsequent queries, use the NextToken value returned from the previous API call.', + 'title' => '', + 'description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', + 'enumValueTitles' => [], 'type' => 'string', + 'example' => 'zh', 'required' => false, - 'example' => 'kt0BLbenY2XCyRfsmoEcVg==', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and issue localization.', - 'type' => 'string', - 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n", - ], - 'ComponentAssets' => [ - 'description' => 'List of assets.', - 'type' => 'array', - 'items' => [ - 'description' => 'Asset information.', - 'type' => 'object', - 'properties' => [ - 'ComponentName' => [ - 'description' => 'The name of the component.', - 'type' => 'string', - 'example' => 'SLS', - ], - 'ComponentAssetName' => [ - 'description' => 'Asset name.', - 'type' => 'string', - 'example' => 'test', - ], - 'ComponentAssetUuid' => [ - 'description' => 'Asset UUID.', - 'type' => 'string', - 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', - ], - 'ComponentAssetValues' => [ - 'description' => 'Configuration information of the asset.', - 'type' => 'array', - 'items' => [ - 'description' => 'Configuration information of the asset.', - 'type' => 'object', - 'properties' => [ - 'FieldName' => [ - 'description' => 'Field name.', - 'type' => 'string', - 'example' => 'lh_source', - ], - 'FieldValue' => [ - 'description' => 'Field value.', - 'type' => 'string', - 'example' => 'device', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'Creation time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1744078554000', - ], - 'UpdateTime' => [ - 'description' => 'Update time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1744078554000', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => 'Total number of queried items.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '824', - ], - 'PageNumber' => [ - 'description' => 'Page number for paginated queries, with a default value of 1.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of items to return per page. Range: 1~100.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxResults' => [ - 'description' => 'The maximum number of results to return. Range: 0~100.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'NextToken' => [ - 'description' => 'The token for the next page of results.', - 'type' => 'string', - 'example' => 'eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9', - ], + 'RunResult' => ['description' => 'The execution result of the component.', 'type' => 'string', 'example' => '{'."\n" + .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n" + .' "content": {'."\n" + .' "resultData": [],'."\n" + .' "success": true'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.', 'type' => 'string', 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAssetName\\": \\"test\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\",\\n \\"ComponentAssetValues\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldValue\\": \\"device\\"\\n }\\n ],\\n \\"CreateTime\\": 1744078554000,\\n \\"UpdateTime\\": 1744078554000\\n }\\n ],\\n \\"TotalCount\\": 824,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9\\"\\n}","type":"json"}]', - 'title' => 'Get Component Asset List', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Run a component', + 'description' => 'Make sure that you are familiar with the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Cloud Threat Detection and Response (CTDR) before you call this operation.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\",\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'GetPlaybook' => [ 'summary' => 'Get playbook details.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1157,9 +619,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1167,202 +627,111 @@ [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language type for requests and received messages.'."\n" - .'- **zh** (default): Chinese'."\n" - .'- **en**: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language type for requesting and receiving messages.'."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'The user ID for the administrator to switch to another member\'s perspective.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'The user ID used by an administrator to switch to the perspective of another member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'The UUID of the playbook.', - 'type' => 'string', - 'required' => true, - 'example' => 'e99dab31-499b-4307-9248-xxxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], [ 'name' => 'PlaybookVersionType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The version type of the playbook, with the following values:'."\n" - ."\n" - .'- **Draft**: Editing state.'."\n" - .'- **Online**: Online version.'."\n" - .'- **History**: Historical version.', - 'type' => 'string', - 'required' => false, - 'example' => 'History', - ], + 'schema' => ['description' => 'The version type of the playbook. Valid values:'."\n" + ."\n" + .'- **Draft**: Draft version.'."\n" + .'- **Online**: Online version.'."\n" + .'- **History**: Historical version.', 'type' => 'string', 'required' => false, 'example' => 'History', 'title' => ''], ], [ 'name' => 'PlaybookVersion', 'in' => 'formData', - 'schema' => [ - 'description' => 'The version ID of the playbook, which is only effective when **PlaybookVersionType** is **History**.', - 'type' => 'string', - 'required' => false, - 'example' => '36c9dcd6-****-4262-****-d508464ebd21', - ], + 'schema' => ['description' => 'The version ID of the playbook. This parameter takes effect only when **PlaybookVersionType** is set to **History**.', 'type' => 'string', 'required' => false, 'example' => '36c9dcd6-****-4262-****-d508464ebd21', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of this request, a unique identifier generated by Alibaba Cloud for the request, which can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F', - ], + 'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for this request. It can be used for troubleshooting.', 'type' => 'string', 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F', 'title' => ''], 'Playbook' => [ - 'description' => 'Configuration information of the playbook.', + 'description' => 'The configuration information of the playbook.', 'type' => 'object', 'properties' => [ - 'PlaybookUuid' => [ - 'description' => 'UUID of the playbook.', - 'type' => 'string', - 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx', - ], - 'PlaybookName' => [ - 'description' => 'Name of the playbook, without special characters.', - 'type' => 'string', - 'example' => 'waftest', - ], - 'PlaybookDescription' => [ - 'description' => 'Description of the playbook.', - 'type' => 'string', - 'example' => 'waf ip blocked', - ], - 'PlaybookParamType' => [ - 'description' => 'Parameter type of the playbook, with the following values:'."\n" - ."\n" - .'- **template-ip**: IP entity.'."\n" - .'- **template-file**: File entity.'."\n" - .'- **template-process**: Process entity.'."\n" - .'- **template-host**: Host entity.'."\n" - .'- **template-domain**: Domain entity.'."\n" - .'- **template-container**: Container entity.'."\n" - .'- **template-incident**: Security incident.'."\n" - .'- **template-alert**: Security alert.'."\n" - .'- **custom**: Custom.', - 'type' => 'string', - 'example' => 'template-ip', - ], - 'PlaybookExtension' => [ - 'description' => 'Extended information of the playbook.', - 'type' => 'string', - 'example' => '{"opCode":1}', - ], - 'PlaybookStatus' => [ - 'description' => 'Publication status of the playbook, with the following values:'."\n" - ."\n" - .'- **0**: Unpublished.'."\n" - .'- **1**: Published.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PlaybookTaskFlow' => [ - 'description' => 'Workflow of the playbook.', - 'type' => 'string', - 'example' => '[]', - ], - 'PlaybookVersion' => [ - 'description' => 'Version number of the playbook.', - 'type' => 'string', - 'example' => '36c9dcd6-****-4262-****-d508464ebd21', - ], - 'PlaybookTaskFlowUuid' => [ - 'description' => 'UUID of the playbook workflow.', - 'type' => 'string', - 'example' => '8ea81047-****-4481-****-fcd8557bf242', - ], - 'PlaybookParamsExample' => [ - 'description' => 'Input example of the playbook.', - 'type' => 'string', - 'example' => '{"ip":"1.*.*.1"}', - ], - 'CreateTime' => [ - 'description' => 'Creation time (in milliseconds).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731378251000', - ], - 'UpdateTime' => [ - 'description' => 'Update time (in milliseconds).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731378251000', - ], + 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx', 'title' => ''], + 'PlaybookName' => ['description' => 'The name of the playbook, which does not contain special characters.', 'type' => 'string', 'example' => 'waftest', 'title' => ''], + 'PlaybookDescription' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'waf ip blocked', 'title' => ''], + 'PlaybookParamType' => ['description' => 'The parameter type of the playbook. Valid values:'."\n" + ."\n" + .'- **template-ip**: IP entity.'."\n" + .'- **template-file**: File entity.'."\n" + .'- **template-process**: Process entity.'."\n" + .'- **template-host**: Host entity.'."\n" + .'- **template-domain**: Domain entity.'."\n" + .'- **template-container**: Container entity.'."\n" + .'- **template-incident**: Security incident.'."\n" + .'- **template-alert**: Security alert.'."\n" + .'- **custom**: Custom.', 'type' => 'string', 'example' => 'template-ip', 'title' => ''], + 'PlaybookExtension' => ['description' => 'The extension information of the playbook.', 'type' => 'string', 'example' => '{"opCode":1}', 'title' => ''], + 'PlaybookStatus' => ['description' => 'The publishing status of the playbook. Valid values:'."\n" + ."\n" + .'- **0**: Unpublished.'."\n" + .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PlaybookTaskFlow' => ['description' => 'The workflow of the playbook.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'PlaybookVersion' => ['description' => 'The version number of the playbook.', 'type' => 'string', 'example' => '36c9dcd6-****-4262-****-d508464ebd21', 'title' => ''], + 'PlaybookTaskFlowUuid' => ['description' => 'The UUID of the playbook workflow.', 'type' => 'string', 'example' => '8ea81047-****-4481-****-fcd8557bf242', 'title' => ''], + 'PlaybookParamsExample' => ['description' => 'The input example of the playbook.', 'type' => 'string', 'example' => '{"ip":"1.*.*.1"}', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time, in millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time, in millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', 'title' => ''], 'PlaybookInputConfigs' => [ - 'description' => 'List of playbook input parameter configurations.', + 'description' => 'The list of input parameter configurations of the playbook.', 'type' => 'array', - 'items' => [ - 'description' => 'Playbook input parameter configuration.', - '$ref' => '#/components/schemas/FieldInputConfig', - ], + 'items' => ['description' => 'The input parameter configuration of the playbook.', '$ref' => '#/components/schemas/FieldInputConfig', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], 'PlaybookOutputConfigs' => [ - 'description' => 'List of playbook output parameter configurations.', + 'description' => 'The list of output parameter configurations of the playbook.', 'type' => 'array', - 'items' => [ - 'description' => 'Playbook output parameter configuration.', - '$ref' => '#/components/schemas/FieldOutputConfig', - ], - ], - 'PlaybookType' => [ - 'title' => '剧本类型', - 'description' => 'Type of the playbook, with values as follows:'."\n" - ."\n" - .'- **preset**: Predefined playbook.'."\n" - .'- **user**: Custom playbook.'."\n" - .'- **component**: Security response component.', - 'type' => 'string', - 'example' => 'preset', + 'items' => ['description' => 'The output parameter configuration of the playbook.', '$ref' => '#/components/schemas/FieldOutputConfig', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'PlaybookType' => ['title' => '', 'description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'- **preset**: Predefined playbook.'."\n" + .'- **user**: Custom playbook.'."\n" + .'- **component**: Security disposition component.', 'type' => 'string', 'example' => 'x6'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"Playbook\\": {\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"PlaybookName\\": \\"waftest\\",\\n \\"PlaybookDescription\\": \\"waf ip blocked\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{\\\\\\"opCode\\\\\\":1}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookTaskFlow\\": \\"[]\\",\\n \\"PlaybookVersion\\": \\"36c9dcd6-****-4262-****-d508464ebd21\\",\\n \\"PlaybookTaskFlowUuid\\": \\"8ea81047-****-4481-****-fcd8557bf242\\",\\n \\"PlaybookParamsExample\\": \\"{\\\\\\"ip\\\\\\":\\\\\\"1.*.*.1\\\\\\"}\\",\\n \\"CreateTime\\": 1731378251000,\\n \\"UpdateTime\\": 1731378251000,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"FieldExample\\": \\"\\"\\n }\\n ],\\n \\"PlaybookType\\": \\"x6\\"\\n }\\n}","type":"json"}]', - 'title' => 'Get Playbook Details', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get playbook details', + 'changeSet' => [], + 'ramActions' => [], 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"Playbook\\": {\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"PlaybookName\\": \\"waftest\\",\\n \\"PlaybookDescription\\": \\"waf ip blocked\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{\\\\\\"opCode\\\\\\":1}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookTaskFlow\\": \\"[]\\",\\n \\"PlaybookVersion\\": \\"36c9dcd6-****-4262-****-d508464ebd21\\",\\n \\"PlaybookTaskFlowUuid\\": \\"8ea81047-****-4481-****-fcd8557bf242\\",\\n \\"PlaybookParamsExample\\": \\"{\\\\\\"ip\\\\\\":\\\\\\"1.*.*.1\\\\\\"}\\",\\n \\"CreateTime\\": 1731378251000,\\n \\"UpdateTime\\": 1731378251000,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"FieldExample\\": \\"\\"\\n }\\n ],\\n \\"PlaybookType\\": \\"x6\\"\\n }\\n}","type":"json"}]', ], - 'ListPlaybooks' => [ - 'summary' => 'Get Playbook List.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListComponentAssets' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1374,9 +743,7 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1384,368 +751,342 @@ [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'Language type for request and response messages.'."\n" - .'- **zh** (default): Chinese'."\n" - .'- **en**: English', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language type for the request and response messages. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'User ID for the administrator to switch to another member\'s perspective.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'The ID of the member account in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ComponentName', 'in' => 'formData', - 'schema' => [ - 'description' => 'Page number for pagination, default value is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the component.', 'type' => 'string', 'required' => false, 'example' => 'SLS', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ComponentAssetUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'Number of items per page for pagination. Range: 1~100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The UUID of the asset.', 'type' => 'string', 'required' => false, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'Maximum number of results returned in a single request. Range: 1~100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The page number for paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'Token for the next query start.', - 'type' => 'string', - 'required' => false, - 'example' => '7fbb1c****07c1f79a740f039a8dcfda', - ], + 'schema' => ['description' => 'The number of entries per page for paging query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PlaybookStatus', + 'name' => 'MaxResults', 'in' => 'formData', - 'schema' => [ - 'description' => 'Publication status of the playbook, with values as follows:'."\n" - ."\n" - .'- **0**: Unpublished.'."\n" - .'- **1**: Published.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The maximum number of results to return. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'PlaybookUuids', + 'name' => 'NextToken', 'in' => 'formData', - 'style' => 'simple', + 'schema' => ['description' => 'The pagination token for the next query. You do not need to specify this parameter for the first query or if no more results exist. If more results exist, set this parameter to the NextToken value returned by the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'kt0BLbenY2XCyRfsmoEcVg==', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Collection of UUIDs of playbooks.', - 'type' => 'array', - 'items' => [ - 'description' => 'UUID of the playbook.', - 'type' => 'string', - 'required' => false, - 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n", 'title' => ''], + 'ComponentAssets' => [ + 'description' => 'The list of assets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The asset information.', + 'type' => 'object', + 'properties' => [ + 'ComponentName' => ['description' => 'The name of the component.', 'type' => 'string', 'example' => 'SLS', 'title' => ''], + 'ComponentAssetName' => ['description' => 'The name of the asset.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ComponentAssetUuid' => ['description' => 'The UUID of the asset.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], + 'ComponentAssetValues' => [ + 'description' => 'The configuration information of the asset.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration information of the asset.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'lh_source', 'title' => ''], + 'FieldValue' => ['description' => 'The field value.', 'type' => 'string', 'example' => 'device', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744078554000', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744078554000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '824', 'title' => ''], + 'PageNumber' => ['description' => 'The page number for paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page for paging query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of results to return. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9', 'title' => ''], ], - 'deprecated' => false, - 'required' => false, - 'maxItems' => 1, - 'minItems' => 0, + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve asset list of a component', + 'summary' => 'Retrieves the list of assets associated with a component.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAssetName\\": \\"test\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\",\\n \\"ComponentAssetValues\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldValue\\": \\"device\\"\\n }\\n ],\\n \\"CreateTime\\": 1744078554000,\\n \\"UpdateTime\\": 1744078554000\\n }\\n ],\\n \\"TotalCount\\": 824,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListComponents' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PlaybookName', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsas104PTS'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'Name of the playbook, supports fuzzy search.', - 'type' => 'string', - 'required' => false, - 'example' => 'demo_test', - ], + 'schema' => ['description' => 'The language type for the request and response messages. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ - 'name' => 'PlaybookParamTypes', + 'name' => 'RoleFor', 'in' => 'formData', - 'style' => 'simple', - 'schema' => [ - 'description' => 'Collection of input parameter types for the playbook.', - 'type' => 'array', - 'items' => [ - 'description' => 'Parameter types for the playbook, with values as follows:'."\n" - ."\n" - .'- **template-ip**: IP entity.'."\n" - .'- **template-file**: File entity.'."\n" - .'- **template-process**: Process entity.'."\n" - .'- **template-host**: Host entity.'."\n" - .'- **template-domain**: Domain entity.'."\n" - .'- **template-container**: Container entity.'."\n" - .'- **template-incident**: Security incident.'."\n" - .'- **template-alert**: Security alert.'."\n" - .'- **custom**: Custom.', - 'type' => 'string', - 'required' => false, - 'example' => 'template-ip', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the resource directory member accounts.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ - 'name' => 'PlaybookExecutionStartTime', + 'name' => 'ComponentName', 'in' => 'formData', - 'schema' => [ - 'description' => 'Start time of the latest execution of the playbook.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1731378251000', - ], + 'schema' => ['description' => 'The name of the component.', 'type' => 'string', 'required' => false, 'example' => 'SLS', 'title' => ''], ], [ - 'name' => 'PlaybookExecutionEndTime', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'End time of the latest execution of the playbook.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1731379251000', - ], + 'schema' => ['description' => 'The page number for paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'OrderField', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'Sorting field. Values:'."\n" - ."\n" - .'- **UpdateTime**: Sort by update time.'."\n" - .'- **ExecutionTime**: Sort by the latest execution time.', - 'type' => 'string', - 'required' => false, - 'example' => 'UpdateTime', - ], + 'schema' => ['description' => 'The number of entries per page in the paging query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'MaxResults', 'in' => 'formData', - 'schema' => [ - 'description' => 'Sorting logic, default is **desc**, with values as follows:'."\n" - .'- **desc**: Descending order.'."\n" - .'- **asc**: Ascending order.', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'schema' => ['description' => 'The maximum number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PlaybookType', + 'name' => 'NextToken', 'in' => 'formData', - 'schema' => [ - 'description' => 'Type of the playbook, with values as follows:'."\n" - ."\n" - .'- **preset**: Predefined playbook.'."\n" - .'- **user**: Custom playbook.'."\n" - .'- **component**: Security response component.', - 'type' => 'string', - 'required' => false, - 'example' => 'preset', - ], + 'schema' => ['description' => 'The token for the next page query.', 'type' => 'string', 'required' => false, 'example' => 'kt0BLbenY2XCyRfsmoEcVg=='."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73', - ], - 'Playbooks' => [ - 'description' => 'List of playbooks.', + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '52', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n", 'title' => ''], + 'Components' => [ + 'description' => 'The list of components.', 'type' => 'array', 'items' => [ - 'description' => 'Information about the playbook.', + 'description' => 'The component information.', 'type' => 'object', 'properties' => [ - 'PlaybookUuid' => [ - 'description' => 'UUID of the playbook.', - 'type' => 'string', - 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx', - ], - 'PlaybookName' => [ - 'description' => 'Name of the playbook.', - 'type' => 'string', - 'example' => 'system_aliyun_alb_process_book', - ], - 'PlaybookDescription' => [ - 'description' => 'Description of the playbook.', - 'type' => 'string', - 'example' => 'alb block', - ], - 'PlaybookType' => [ - 'description' => 'Type of the playbook, with values as follows:'."\n" - ."\n" - .'- **preset**: Predefined playbook.'."\n" - .'- **user**: Custom playbook.'."\n" - .'- **component**: Security response component.', - 'type' => 'string', - 'example' => 'user', - ], - 'PlaybookParamType' => [ - 'description' => 'The parameter type of the playbook, with values as follows:'."\n" - ."\n" - .'- **template-ip**: IP entity.'."\n" - .'- **template-file**: File entity.'."\n" - .'- **template-process**: Process entity.'."\n" - .'- **template-host**: Host entity.'."\n" - .'- **template-domain**: Domain entity.'."\n" - .'- **template-container**: Container entity.'."\n" - .'- **template-incident**: Security incident.'."\n" - .'- **template-alert**: Security alert.'."\n" - .'- **custom**: Custom.', - 'type' => 'string', - 'example' => 'template-ip', - ], - 'PlaybookExtension' => [ - 'description' => 'Extended information of the playbook.', - 'type' => 'string', - 'example' => '{}', - ], - 'PlaybookStatus' => [ - 'description' => 'The publication status of the playbook, with values as follows:'."\n" - ."\n" - .'- **0**: Unpublished.'."\n" - .'- **1**: Published.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PlaybookInputConfigs' => [ - 'description' => 'List of input parameter configurations for the playbook.', + 'ComponentName' => ['description' => 'The name of the component.', 'type' => 'string', 'example' => 'SLS', 'title' => ''], + 'ComponentAlias' => ['description' => 'The alias of the component.', 'type' => 'string', 'example' => 'Log', 'title' => ''], + 'ComponentDescription' => ['description' => 'The description of the component.', 'type' => 'string', 'example' => 'Log query', 'title' => ''], + 'ComponentLogo' => ['description' => 'The icon URL of the component.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg', 'title' => ''], + 'ComponentExtension' => ['description' => 'The extension information of the component.', 'type' => 'string', 'example' => '{"type":"common"}', 'title' => ''], + 'ComponentActions' => [ + 'description' => 'The list of component actions.', 'type' => 'array', 'items' => [ - 'description' => 'Input parameter configuration for the playbook.', - '$ref' => '#/components/schemas/FieldInputConfig', + 'description' => 'The component action.', + 'type' => 'object', + 'properties' => [ + 'ComponentActionName' => ['description' => 'The name of the component action.', 'type' => 'string', 'example' => 'QueryLogs', 'title' => ''], + 'ComponentActionDescription' => ['description' => 'The description of the component action name.', 'type' => 'string', 'example' => 'Query logs from SLS', 'title' => ''], + 'InputConfigs' => [ + 'description' => 'The input parameter settings of the action.', + 'type' => 'array', + 'items' => [ + 'description' => 'The input parameter of the action.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'FieldType' => ['description' => 'The field type. Valid values:'."\n" + ."\n" + .'- **String**: string.'."\n" + .'- **Long**: long integer.'."\n" + .'- **Integer**: integer.'."\n" + .'- **Double**: floating-point.'."\n" + .'- **Boolean**: Boolean.'."\n" + .'- **Complex**: key-value pair.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'FieldDescription' => ['description' => 'The description of the field.', 'type' => 'string', 'example' => 'Project Name', 'title' => ''], + 'FieldDisplayConfig' => ['description' => 'The display configuration of the field.', 'type' => 'string', 'example' => '{'."\n" + .' "height": 200,'."\n" + .' "theme": "vs-light",'."\n" + .' "language": "markdown",'."\n" + .' "editorOptions": {}'."\n" + .'}', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the parameter is required.'."\n" + ."\n" + .'- **true**: required.'."\n" + .'- **false**: not required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OutputConfigs' => [ + 'description' => 'The output parameter settings of the action.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'lh_source', 'title' => ''], + 'FieldType' => ['description' => 'The field type. Valid values:'."\n" + ."\n" + .'- **String**: string.'."\n" + .'- **Long**: long integer.'."\n" + .'- **Integer**: integer.'."\n" + .'- **Double**: floating-point.'."\n" + .'- **Boolean**: Boolean.'."\n" + .'- **Complex**: key-value pair.', 'type' => 'string', 'example' => 'String', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'PlaybookOutputConfigs' => [ - 'description' => 'List of output parameter configurations for the playbook.', + 'ComponentAssetConfigs' => [ + 'description' => 'The list of asset field configurations.', 'type' => 'array', 'items' => [ - 'description' => 'Output parameter configuration for the playbook.', - '$ref' => '#/components/schemas/FieldOutputConfig', + 'description' => 'The asset field configuration.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'project', 'title' => ''], + 'FieldType' => ['description' => 'The field type. Valid values:'."\n" + ."\n" + .'- **String**: string.'."\n" + .'- **Long**: long integer.'."\n" + .'- **Integer**: integer.'."\n" + .'- **Double**: floating-point.'."\n" + .'- **Boolean**: Boolean.'."\n" + .'- **Complex**: key-value pair.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'FieldDescription' => ['description' => 'The description of the field.', 'type' => 'string', 'example' => 'project name', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the parameter is required.'."\n" + ."\n" + .'- **true**: required.'."\n" + .'- **false**: not required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Encrypted' => ['description' => 'Specifies whether the field value needs to be encrypted. Valid values:'."\n" + ."\n" + .'- true: encrypted.'."\n" + .'- false: not encrypted.'."\n" + ."\n" + .'Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'Creation time (in milliseconds).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1667792399000', - ], - 'UpdateTime' => [ - 'description' => 'Update time (in milliseconds).', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731378251000', - ], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757902337000', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757902337000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'description' => 'Total number of items found.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'Current page number. The default value is 1.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'Number of items per page in a paginated query.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxResults' => [ - 'description' => 'Maximum number of results allowed to be returned. Range: 0~100.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'NextToken' => [ - 'description' => 'Token for the start of the next page query.', - 'type' => 'string', - 'example' => '7fbb1c****07c1f79a740f039a8dcfda', - ], + 'PageNumber' => ['description' => 'The page number for paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page in the paging query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of entries returned per request. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page query.', 'type' => 'string', 'example' => '7fbb1c66d607c1f79a740f039a8dcfda', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Playbooks\\": [\\n {\\n \\"PlaybookUuid\\": \\"bb5a8640-a14f-44ef-8376-cxxxxx\\",\\n \\"PlaybookName\\": \\"system_aliyun_alb_process_book\\",\\n \\"PlaybookDescription\\": \\"alb block\\",\\n \\"PlaybookType\\": \\"user\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"FieldExample\\": \\"\\"\\n }\\n ],\\n \\"CreateTime\\": 1667792399000,\\n \\"UpdateTime\\": 1731378251000\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"7fbb1c****07c1f79a740f039a8dcfda\\"\\n}","type":"json"}]', - 'title' => 'Query Playbook List', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve component list', + 'summary' => 'Retrieves a list of components.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 52,\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"Components\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAlias\\": \\"Log\\",\\n \\"ComponentDescription\\": \\"Log query\\",\\n \\"ComponentLogo\\": \\"https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg\\",\\n \\"ComponentExtension\\": \\"{\\\\\\"type\\\\\\":\\\\\\"common\\\\\\"}\\",\\n \\"ComponentActions\\": [\\n {\\n \\"ComponentActionName\\": \\"QueryLogs\\",\\n \\"ComponentActionDescription\\": \\"Query logs from SLS\\",\\n \\"InputConfigs\\": [\\n {\\n \\"FieldName\\": \\"Project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"Project Name\\",\\n \\"FieldDisplayConfig\\": \\"{\\\\n \\\\\\"height\\\\\\": 200,\\\\n \\\\\\"theme\\\\\\": \\\\\\"vs-light\\\\\\",\\\\n \\\\\\"language\\\\\\": \\\\\\"markdown\\\\\\",\\\\n \\\\\\"editorOptions\\\\\\": {}\\\\n}\\",\\n \\"DefaultValue\\": \\"1\\",\\n \\"Required\\": false\\n }\\n ],\\n \\"OutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldType\\": \\"String\\"\\n }\\n ]\\n }\\n ],\\n \\"ComponentAssetConfigs\\": [\\n {\\n \\"FieldName\\": \\"project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"project name\\",\\n \\"Required\\": false,\\n \\"Encrypted\\": false,\\n \\"DefaultValue\\": \\"1\\"\\n }\\n ],\\n \\"CreateTime\\": 1757902337000,\\n \\"UpdateTime\\": 1757902337000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"7fbb1c66d607c1f79a740f039a8dcfda\\"\\n}","type":"json"}]', 'translator' => 'machine', ], - 'CreatePlaybook' => [ - 'summary' => 'Create Playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListPlaybooks' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1753,107 +1094,72 @@ [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'Language type for receiving messages. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language type for the request and response messages.'."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'Resource directory member account ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '170*********3093', - ], + 'schema' => ['description' => 'The user ID that the administrator wants to use to switch to the perspective of another member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ - 'name' => 'PlaybookName', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'Name of the playbook, without special characters.', - 'type' => 'string', - 'required' => true, - 'example' => 'waftest', - 'maxLength' => 128, - 'minLength' => 2, - ], + 'schema' => ['description' => 'The page number for a paginated query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PlaybookDescription', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'Description of the playbook.', - 'type' => 'string', - 'required' => false, - 'example' => 'waf ip block', - 'maxLength' => 512, - 'minLength' => 0, - ], + 'schema' => ['description' => 'The number of entries per page for a paginated query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PlaybookInputConfigs', + 'name' => 'MaxResults', 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'description' => 'Input parameter configuration of the playbook.', - 'type' => 'array', - 'items' => [ - 'description' => 'Input parameter configuration.', - 'required' => false, - '$ref' => '#/components/schemas/FieldInputConfig', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The maximum number of entries to return per request. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'PlaybookOutputConfigs', + 'name' => 'NextToken', 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'description' => 'Output parameter configuration of the playbook.', - 'type' => 'array', - 'items' => [ - 'description' => 'Output parameter configuration.', - 'required' => false, - '$ref' => '#/components/schemas/FieldOutputConfig', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => '7fbb1c****07c1f79a740f039a8dcfda', 'title' => ''], ], [ - 'name' => 'SrcPlaybookUuid', + 'name' => 'PlaybookStatus', 'in' => 'formData', - 'schema' => [ - 'description' => 'In a copy scenario, the UUID of the source playbook needs to be filled in. When this parameter has a value, all other parameters except the playbook name and description are invalid.', - 'type' => 'string', - 'required' => false, - 'example' => '1B5A9144-****-****-A466-****9D64AA99', - ], + 'schema' => ['description' => 'The publishing status of the playbook. Valid values:'."\n" + ."\n" + .'- **0**: Unpublished.'."\n" + .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PlaybookTaskFlow', + 'name' => 'PlaybookUuids', 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'description' => 'Workflow of the playbook.', - 'type' => 'string', + 'description' => 'The collection of playbook UUIDs.', + 'type' => 'array', + 'items' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx', 'title' => ''], + 'deprecated' => false, 'required' => false, - 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]', + 'maxItems' => 1, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PlaybookParamType', + 'name' => 'PlaybookName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the playbook. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'demo_test', 'title' => ''], + ], + [ + 'name' => 'PlaybookParamTypes', 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'title' => '剧本参数类型', - 'description' => 'Type of input parameters for the playbook.'."\n" + 'description' => 'The collection of playbook input parameter types.', + 'type' => 'array', + 'items' => ['description' => 'The parameter type of the playbook. Valid values:'."\n" ."\n" .'- **template-ip**: IP entity.'."\n" .'- **template-file**: File entity.'."\n" @@ -1863,50 +1169,131 @@ .'- **template-container**: Container entity.'."\n" .'- **template-incident**: Security incident.'."\n" .'- **template-alert**: Security alert.'."\n" - .'- **custom**: Custom.', - 'type' => 'string', + .'- **custom**: Custom.', 'type' => 'string', 'required' => false, 'example' => 'template-ip', 'title' => ''], 'required' => false, - 'example' => 'custom', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PlaybookExecutionStartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start time of the latest playbook execution.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731378251000', 'title' => ''], + ], + [ + 'name' => 'PlaybookExecutionEndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end time of the latest playbook execution.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731379251000', 'title' => ''], + ], + [ + 'name' => 'OrderField', + 'in' => 'formData', + 'schema' => ['description' => 'The sort field. Valid values:'."\n" + ."\n" + .'- **UpdateTime**: Sort by update time.'."\n" + .'- **ExecutionTime**: Sort by the latest execution time.', 'type' => 'string', 'required' => false, 'example' => 'UpdateTime', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => ['description' => 'The sort order. Default value: **desc**. Valid values:'."\n" + .'- **desc**: Descending order.'."\n" + .'- **asc**: Ascending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + ], + [ + 'name' => 'PlaybookType', + 'in' => 'formData', + 'schema' => ['description' => 'The playbook type. Valid values:'."\n" + ."\n" + .'- **preset**: Predefined playbook.'."\n" + .'- **user**: Custom playbook.'."\n" + .'- **component**: Security disposition component.', 'type' => 'string', 'required' => false, 'example' => 'preset', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '007BC211-709E-549B-9534-4C8EA0922828', - ], - 'PlaybookUuid' => [ - 'description' => 'UUID of the playbook.', - 'type' => 'string', - 'example' => 'e99dab31-499b-4307-9248-xxxxxx', + 'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. It can be used to troubleshoot issues.', 'type' => 'string', 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73', 'title' => ''], + 'Playbooks' => [ + 'description' => 'The list of playbooks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the playbook.', + 'type' => 'object', + 'properties' => [ + 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx', 'title' => ''], + 'PlaybookName' => ['description' => 'The name of the playbook.', 'type' => 'string', 'example' => 'system_aliyun_alb_process_book', 'title' => ''], + 'PlaybookDescription' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'alb block', 'title' => ''], + 'PlaybookType' => ['description' => 'The playbook type. Valid values:'."\n" + ."\n" + .'- **preset**: Predefined playbook.'."\n" + .'- **user**: Custom playbook.'."\n" + .'- **component**: Security disposition component.', 'type' => 'string', 'example' => 'user', 'title' => ''], + 'PlaybookParamType' => ['description' => 'The parameter type of the playbook. Valid values:'."\n" + ."\n" + .'- **template-ip**: IP entity.'."\n" + .'- **template-file**: File entity.'."\n" + .'- **template-process**: Process entity.'."\n" + .'- **template-host**: Host entity.'."\n" + .'- **template-domain**: Domain entity.'."\n" + .'- **template-container**: Container entity.'."\n" + .'- **template-incident**: Security incident.'."\n" + .'- **template-alert**: Security alert.'."\n" + .'- **custom**: Custom.', 'type' => 'string', 'example' => 'template-ip', 'title' => ''], + 'PlaybookExtension' => ['description' => 'The extension information of the playbook.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'PlaybookStatus' => ['description' => 'The publishing status of the playbook. Valid values:'."\n" + ."\n" + .'- **0**: Unpublished.'."\n" + .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PlaybookInputConfigs' => [ + 'description' => 'The list of input parameter configurations of the playbook.', + 'type' => 'array', + 'items' => ['description' => 'The input parameter configuration of the playbook.', '$ref' => '#/components/schemas/FieldInputConfig', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'PlaybookOutputConfigs' => [ + 'description' => 'The list of output parameter configurations of the playbook.', + 'type' => 'array', + 'items' => ['description' => 'The output parameter configuration of the playbook.', '$ref' => '#/components/schemas/FieldOutputConfig', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'CreateTime' => ['description' => 'The creation time, in milliseconds timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1667792399000', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time, in milliseconds timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of results allowed to be returned. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'NextToken' => ['description' => 'The token for the start of the next page query.', 'type' => 'string', 'example' => '7fbb1c****07c1f79a740f039a8dcfda', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"007BC211-709E-549B-9534-4C8EA0922828\\",\\n \\"PlaybookUuid\\": \\"e99dab31-499b-4307-9248-xxxxxx\\"\\n}","type":"json"}]', - 'title' => 'Create Playbook', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query playbook list', + 'summary' => 'Queries the list of playbooks.', + 'changeSet' => [], + 'ramActions' => [], 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Playbooks\\": [\\n {\\n \\"PlaybookUuid\\": \\"bb5a8640-a14f-44ef-8376-cxxxxx\\",\\n \\"PlaybookName\\": \\"system_aliyun_alb_process_book\\",\\n \\"PlaybookDescription\\": \\"alb block\\",\\n \\"PlaybookType\\": \\"user\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"FieldExample\\": \\"\\"\\n }\\n ],\\n \\"CreateTime\\": 1667792399000,\\n \\"UpdateTime\\": 1731378251000\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"7fbb1c****07c1f79a740f039a8dcfda\\"\\n}","type":"json"}]', ], - 'DeletePlaybook' => [ - 'summary' => 'Delete Playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateComponentAsset' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1915,12 +1302,10 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -1928,71 +1313,76 @@ [ 'name' => 'Lang', 'in' => 'formData', + 'schema' => ['description' => 'The language type of the request and response messages. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], + [ + 'name' => 'ComponentAssetUuid', + 'in' => 'formData', + 'schema' => ['description' => 'The asset UUID.', 'type' => 'string', 'required' => true, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], + ], + [ + 'name' => 'ComponentAssetValues', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => 'The language type for requests and received messages. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - ."\n" - .'- **en**: English.', - 'type' => 'string', + 'description' => 'The configuration information of the asset.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration information of the asset.', + 'type' => 'object', + 'properties' => [ + 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => 'lh_source', 'title' => ''], + 'FieldValue' => ['description' => 'The field value.', 'type' => 'string', 'required' => false, 'example' => 'device', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'zh', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'User ID for the administrator to switch to another member\'s perspective.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'The member account ID in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ - 'name' => 'PlaybookUuid', + 'name' => 'ComponentAssetName', 'in' => 'formData', - 'schema' => [ - 'description' => 'UUID of the playbook.', - 'type' => 'string', - 'required' => true, - 'example' => 'e99dab31-499b-4307-9248-xxxxxx', - ], + 'schema' => ['description' => 'The asset name.', 'type' => 'string', 'required' => false, 'example' => 'test_asset', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier that Alibaba Cloud generates for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'], + 'ComponentAssetUuid' => ['description' => 'The asset UUID.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]', - 'title' => 'Delete Playbook', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateComponentAsset', + 'summary' => 'Updates a component asset.', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'UpdatePlaybook' => [ - 'summary' => 'Update Playbook.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2004,9 +1394,7 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], + 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -2014,60 +1402,38 @@ [ 'name' => 'Lang', 'in' => 'formData', - 'schema' => [ - 'description' => 'The language type for requests and received messages. Values:'."\n" - ."\n" - .'- **zh** (default): Chinese.'."\n" - .'- **en**: English.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The language of the request and response. Valid values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', - 'schema' => [ - 'description' => 'The user ID for the administrator to switch to another member\'s perspective.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13760*****718726', - ], + 'schema' => ['description' => 'The user ID of the member to which the administrator switches the view.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'PlaybookName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the playbook.', - 'type' => 'string', - 'required' => false, - 'example' => 'system_aliyun_alb_process_book', - ], + 'schema' => ['description' => 'The name of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'system_aliyun_alb_process_book', 'title' => ''], ], [ 'name' => 'PlaybookDescription', 'in' => 'formData', - 'schema' => [ - 'description' => 'Description of the playbook.', - 'type' => 'string', - 'required' => false, - 'example' => 'alb block', - ], + 'schema' => ['description' => 'The description of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'alb block', 'title' => ''], ], [ 'name' => 'PlaybookInputConfigs', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'List of input parameter configurations for the playbook.', + 'description' => 'The list of input parameter settings of the playbook.', 'type' => 'array', - 'items' => [ - 'description' => 'Input parameter configuration for the playbook.', - 'required' => false, - '$ref' => '#/components/schemas/FieldInputConfig', - ], + 'items' => ['description' => 'The input parameter settings of the playbook.', '$ref' => '#/components/schemas/FieldInputConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ @@ -2075,235 +1441,94 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'List of output parameter configurations for the playbook.', + 'description' => 'The list of output parameter settings of the playbook.', 'type' => 'array', - 'items' => [ - 'description' => 'Output parameter configuration for the playbook.', - 'required' => false, - '$ref' => '#/components/schemas/FieldOutputConfig', - ], + 'items' => ['description' => 'The output parameter settings of the playbook.', '$ref' => '#/components/schemas/FieldOutputConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'PlaybookTaskFlow', 'in' => 'formData', - 'schema' => [ - 'description' => 'Content of the playbook.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]', - ], + 'schema' => ['description' => 'The content of the playbook.', 'type' => 'string', 'required' => false, 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]', 'title' => ''], ], [ 'name' => 'PlaybookParamType', 'in' => 'formData', - 'schema' => [ - 'description' => 'Type of input parameters for the playbook.'."\n" - ."\n" - .'- **template-ip**: IP entity.'."\n" - .'- **template-file**: File entity.'."\n" - .'- **template-process**: Process entity.'."\n" - .'- **template-host**: Host entity.'."\n" - .'- **template-domain**: Domain entity.'."\n" - .'- **template-container**: Container entity.'."\n" - .'- **template-incident**: Security incident.'."\n" - .'- **template-alert**: Security alert.'."\n" - .'- **custom**: Custom.', - 'type' => 'string', - 'required' => false, - 'example' => 'template-ip', - ], + 'schema' => ['description' => 'The input parameter type of the playbook. Valid values:'."\n" + ."\n" + .'- **template-ip**: IP entity.'."\n" + .'- **template-file**: file entity.'."\n" + .'- **template-process**: process entity.'."\n" + .'- **template-host**: host entity.'."\n" + .'- **template-domain**: domain name entity.'."\n" + .'- **template-container**: container entity.'."\n" + .'- **template-incident**: security event.'."\n" + .'- **template-alert**: security alert.'."\n" + .'- **custom**: custom.', 'type' => 'string', 'required' => false, 'example' => 'template-ip', 'title' => ''], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'UUID of the playbook.', - 'type' => 'string', - 'required' => true, - 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', - ], + 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', - 'type' => 'string', - 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE', - ], - 'PlaybookUuid' => [ - 'description' => 'UUID of the playbook.', - 'type' => 'string', - 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE'], + 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update a playbook', + 'summary' => 'Updates a playbook.', + 'changeSet' => [], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PlaybookUuid\\": \\"8f55e76d-b5d5-4720-9cd7-xxxxx\\"\\n}","type":"json"}]', - 'title' => 'Update Playbook', 'translator' => 'machine', ], - 'ExecuteComponent' => [ - 'summary' => '执行组件动作', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREsas104PTS', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'PlaybookUuid', - 'in' => 'formData', - 'schema' => [ - 'title' => '剧本的UUID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ac343acc-1a61-4084-9a1cxxxxx', - ], - ], - [ - 'name' => 'PlayBookNodeName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'node1', - ], - ], - [ - 'name' => 'ComponentName', - 'in' => 'formData', - 'schema' => [ - 'title' => '组件的名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SLS', - ], - ], - [ - 'name' => 'ComponentActionName', - 'in' => 'formData', - 'schema' => [ - 'title' => '组件的动作名称。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'doRequest', - ], - ], - [ - 'name' => 'ComponentAssetUuid', - 'in' => 'formData', - 'schema' => [ - 'title' => '资产UUID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', - ], - ], - [ - 'name' => 'ComponentInput', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'Lang', - 'in' => 'formData', - 'schema' => [ - 'title' => '请求和接收消息的语言类型。取值：'."\n" - ."\n" - .'- **zh**（默认）：中文。'."\n" - ."\n" - .'- **en**：英文。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'zh', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RunResult' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n" - .' "content": {'."\n" - .' "resultData": [],'."\n" - .' "success": true'."\n" - .' }'."\n" - .'}', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\",\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\"\\n}","type":"json"}]', - ], ], 'endpoints' => [ - [ - 'regionId' => 'public', - 'endpoint' => 'sophonsoar.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'vpc' => 'sophonsoar-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'public', 'regionName' => 'Public network', 'areaId' => 'other', 'areaName' => 'Other', 'public' => 'sophonsoar.aliyuncs.com', 'endpoint' => 'sophonsoar.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'Component.External.NotExist', 'message' => 'Component does not exist.', 'http_code' => 400, 'description' => 'Component does not exist.'], + ['code' => 'ComponentAsset.External.NotExist', 'message' => 'The component asset is not exist.', 'http_code' => 400, 'description' => 'The asset corresponding to the component you entered does not exist. Please enter it again.'], + ['code' => 'Playbook.Abnormal.ERROR', 'message' => 'Interface call exception, please contact the developer.', 'http_code' => 400, 'description' => ''], + ['code' => 'Playbook.External.AccountError', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => 'Parameter error. Please login with an buy user account. Verify the provided parameters and try again.'], + ['code' => 'Playbook.External.DebugError', 'message' => 'Debugging the script failed. Please verify whether the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => ''], + ['code' => 'Playbook.External.InvalidParameter', 'message' => 'The request parameter is incorrect. Please verify the provided parameters and try again.', 'http_code' => 400, 'description' => 'The request parameter is incorrect. Please verify the provided parameters and try again.'], + ['code' => 'Playbook.External.ParamError', 'message' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'http_code' => 400, 'description' => 'The parameters of the request interface are incorrect. Please verify the parameters and request again.'], + ['code' => 'Playbook.External.PublishError', 'message' => 'Failed to publish or run the script. Please verify that the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => 'Failed to publish or run the script. Please check whether the status and configuration of the script are correct before trying again.'], + ['code' => 'Playbook.External.StatusError', 'message' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.', 'http_code' => 400, 'description' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.'], + ['code' => 'Playbook.Internal.MetricsError', 'message' => 'The configuration information is abnormal, please check the relevant configuration.', 'http_code' => 400, 'description' => 'The configuration information is abnormal. You are requested to check the configuration.'], + ['code' => 'Playbook.Internal.RecordError', 'message' => 'The data format is abnormal, please check whether the data format meets the requirements.', 'http_code' => 400, 'description' => 'The data format is abnormal. Check whether the data format meets the requirements.'], + ['code' => 'SYS_ERROR', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => 'The parameter is incorrect. Please verify the provided parameters and try again: Please use the purchase account to access.'], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'ThreatDetection', + 'productName' => 'Security Center', + 'ramCodes' => ['threatdetection', 'yundun-aegis', 'yundun-sas'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [ + [ + 'name' => 'acs:ResourceGroupId', + 'schema' => ['type' => 'String', 'description' => '资源组ID'], + ], ], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; |