'1.0', 'info' => ['style' => 'RPC', 'product' => 'sophonsoar', 'version' => '2022-07-28'], 'directories' => [ [ 'children' => [ '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', ], [ 'children' => ['DescribeProcessStatistics', 'DescribeProcessTasks', 'DescribeProcessTaskCount', 'DescribeSophonCommands', 'TriggerProcessTask'], 'type' => 'directory', 'title' => 'Remediation tasks', ], [ 'children' => ['DescribeOpenApiList', 'DescribeGroupProductions', 'RunNotifyComponentWithEmail', 'RunNotifyComponentWithMessageCenter', 'RunNotifyComponentWithWebhook', 'ConvertPlaybook', 'CopyPlaybook', 'DescribeNotifyTemplateList', 'DescribeOpenApiInfo', 'DescribeVendorApiList'], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'BatchModifyInstanceStatus' => [ 'summary' => 'Enables or disables a batch of playbooks.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'formData', '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' => 'Active', 'in' => 'formData', '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' => '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' => 'SophonResult', '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' => [ [ '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' => 'OldPlaybookReleaseId', 'in' => 'query', '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' => 'NewPlaybookReleaseId', 'in' => 'query', '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' => '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', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ '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' => [ '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'], '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'], ], ], 'ramActions' => [], ], 'ConvertPlaybook' => [ 'summary' => 'Convert XML configuration.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208668', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Taskflow', 'in' => 'formData', 'schema' => ['title' => '剧本编辑配置', 'description' => 'XML configuration information for playbook orchestration.', 'type' => 'string', 'required' => true, 'example' => ''."\n" .''."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .' '."\n" .''."\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', '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', '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', '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 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'], '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.', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-sas:ConvertPlaybook', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertPlaybook'], ], ], ], 'CopyPlaybook' => [ 'summary' => 'Copies a playbook.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '218814', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The display name of the playbook.'."\n", 'type' => 'string', 'required' => true, 'example' => 'playbook_xxx'], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The description of the playbook.'."\n", 'type' => 'string', 'required' => false, 'example' => 'playbook description'], ], [ 'name' => 'SourcePlaybookUuid', 'in' => 'formData', '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' => 'ReleaseVersion', 'in' => 'formData', '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' => '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', 'title' => ''], ], [ 'name' => 'RoleType', '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', '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' => '137602*****718726', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'SophonResult'."\n", 'type' => 'object', 'properties' => [ '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' => '', ], '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'], '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'], ], ], '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' => 'Creates a new playbook.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '167210', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => ['title' => '剧本名称', 'description' => 'The name of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'test09'], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['title' => '剧本的描述', 'description' => 'The description of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'This is a new version'], ], [ 'name' => 'TaskflowType', 'in' => 'formData', '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' => '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' => ['description' => 'The output configuration of the playbook.', 'type' => 'string', 'example' => '{\'result\': \'success\'}', 'title' => '', 'required' => false], ], [ 'name' => 'InputParams', 'in' => 'formData', 'schema' => ['description' => 'The input configuration of the playbook.', 'type' => 'string', 'example' => '{\'key1\': \'value1\', \'key2\': \'value2\'}', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The returned information.', 'type' => 'object', 'properties' => [ '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 returned result of the creation.', 'type' => 'object', 'properties' => [ 'PlaybookUuid' => ['title' => '剧本的UUID', 'description' => 'The UUID of the newly created playbook.', 'type' => 'string', 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx'], ], 'example' => '', ], ], 'example' => '', ], ], ], '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', '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'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', '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' => 'f916b93e-e814-459f-9662-xxxxx'], ], [ 'name' => 'Record', 'in' => 'formData', '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' => ['description' => 'The XML configuration of the playbook.'."\n" ."\n" .'> Call the [DescribePlaybook](~~DescribePlaybook~~) operation to obtain this configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''."\n"], ], [ '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' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ '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'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF\\",\\n \\"RequestUuid\\": \\"6d412cfa-0905-4567-8a83-xxxxxx\\"\\n}","type":"json"}]', 'title' => 'DebugPlaybook', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DebugPlaybook'], ], ], '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' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AssetId', 'in' => 'query', '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 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', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ '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'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-8532-5D44-B88A-7263B435C316\\"\\n}","type":"json"}]', 'title' => 'DeleteComponentAsset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentAsset'], ], ], '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' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', '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' => true, 'title' => '', 'example' => 'e99dab31-499b-4307-9248-xxxxxx'], ], [ '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' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584'], ], 'example' => '', ], ], ], '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' => 'Obtains the metadata for a component asset, which defines the fields that constitute the asset.', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ComponentName', 'in' => 'query', 'schema' => ['description' => 'The name of the component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3'], ], [ 'name' => 'Lang', 'in' => 'query', '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', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ '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'], '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', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssetForm'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ComponentName', 'in' => 'query', 'schema' => ['description' => 'The component name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3'], ], [ 'name' => 'Lang', 'in' => 'query', '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>', 'description' => 'The response.', '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' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F'], 'ComponentAssets' => [ 'title' => '', 'description' => 'A list of assets.', 'type' => 'array', 'items' => [ 'description' => 'Asset information.', 'type' => 'object', 'properties' => [ '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'], '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', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssets'], ], ], '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' => [], ], ], '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 get this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxx'], ], [ '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, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The returned information.', 'type' => 'object', 'properties' => [ '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'], '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 **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" .' - **description**: The description of the action.'."\n" ."\n" .' - **name**: The name of the action.'."\n" ."\n" .' - **parameters**: The input parameters for the action. This parameter is a JSON object that contains the following fields:'."\n" ."\n" .' - **description**: The description of the input parameter.'."\n" ."\n" .' - **name**: The name of the input parameter.'."\n" ."\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" .'- **basic**: The basic information about the component. This parameter contains the following fields:'."\n" ."\n" .'- **description**: The description of the component.'."\n" ."\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' => 'Retrieves a list of predefined components.', '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 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 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>', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C5F5D6C9-DF1A-5381-92B1-39676F777D20', 'title' => ''], 'Playbooks' => [ 'title' => '', 'description' => 'The list of component playbooks.', 'type' => 'array', 'items' => [ 'description' => 'The information about the component playbook.', 'type' => 'object', 'properties' => [ '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' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], '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', 'changeSet' => [ ['createdAt' => '2025-10-09T09:35:06.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPlaybook'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ '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, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ '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'], '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 **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" .'- **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' => 'Retrieves a list of distinct playbook releases.', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '172028', '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' => 'bc0b8424-535c-4ed5-bd94-xxxxxx'], ], [ 'name' => 'TaskflowMd5', 'in' => 'query', '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 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>', 'description' => 'The response.', 'type' => 'object', 'properties' => [ '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 version records.', 'type' => 'array', 'items' => [ 'description' => 'The version information.', 'type' => 'object', 'properties' => [ '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'], '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', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistinctReleases'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'EnumType', 'in' => 'query', '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 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>', 'description' => 'The response.', 'type' => 'object', 'properties' => [ '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 enumeration information.', 'type' => 'array', 'items' => [ 'description' => 'The key-value pair of the enumeration.', 'type' => 'object', 'properties' => [ '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'], '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', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnumItems'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '172464', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'InputMode', 'in' => 'query', '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' => ['description' => 'The name of the playbook. Fuzzy search is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo_test'], ], [ 'name' => 'Uuid', 'in' => 'query', '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 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 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>', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ '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 list of playbooks.', 'type' => 'array', 'items' => [ 'description' => 'Summary information about the playbook.', 'type' => 'object', 'properties' => [ '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'], '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' => 'Retrieves global configuration information for the product.', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], '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', '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '203522', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', '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' => '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', '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>', 'description' => 'SophonResult\\'."\n", 'type' => 'object', 'properties' => [ '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' => '', ], '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'], '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'], ], ], 'ramActions' => [], ], 'DescribeLatestRecordSchema' => [ 'summary' => 'Describes the output structure of each node in a playbook based on the latest execution record.', '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' => 'c5c88b5e-97ca-435d-8c20-xxxxxx'], ], [ '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' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9'], 'PlaybookNodeSchema' => [ 'title' => '', 'description' => 'The output structure of the playbook.', 'type' => 'object', 'properties' => [ 'NodeSchema' => [ 'description' => 'The structure information.', 'type' => 'array', 'items' => [ 'description' => 'The structure information.', 'type' => 'object', 'properties' => [ '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.', 'type' => 'array', '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'], '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', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLatestRecordSchema'], ], ], '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' => [], ], ], '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-xxxxxxx'], ], [ '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 response.'."\n" ."\n" .'- **zh**: Chinese'."\n" ."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult>', 'description' => 'The returned data.', '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' => '6BE94351-712A-505D-A40A-BC77CC8254A9'], 'ParamReferredPaths' => [ 'title' => '', 'description' => 'The recommended path configurations.', 'type' => 'array', 'items' => [ 'description' => 'The path information.', 'type' => 'object', 'properties' => [ 'ParamName' => ['description' => 'The name of the ancestor node.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''], 'ReferredPath' => [ 'description' => 'An array of paths.', 'type' => 'array', 'items' => ['description' => 'The reference path configuration.', 'type' => 'string', 'example' => 'filter_1.datalist.*.score', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], '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}'], ], ], ], ], ], 'DescribeNodeUsedInfos' => [ 'summary' => 'Queries the nodes that reference a specific node in a playbook.', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ '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' => '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', '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225868', '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', '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' => 'SophonResult>', 'description' => 'SophonResult\\'."\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' => [ 'title' => 'SophonResult', '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' => [ [ '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' => [ 'title' => 'SophonResult', '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' => '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', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ '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.', 'type' => 'object', 'properties' => [ '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' => '', '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'], '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\\": \\"\\",\\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', 'changeSet' => [ ['createdAt' => '2025-02-26T03:24:20.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-03-19T03:26:13.000Z', 'description' => 'Response parameters changed'], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '167574', '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' => 'b724d2b0-3c3b-4223-9bfd-xxxxxxx'], ], [ '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' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The response that is returned.', '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' => '688B4CCD-5272-5DCF-9D76-FE5EFEF545F8'], 'Config' => [ 'title' => '', 'description' => 'The configuration information.', 'type' => 'object', 'properties' => [ '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'], '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 **InputParams** parameter is in JSON array format. It contains the following fields:'."\n" ."\n" .'- typeName: The name of the parameter type.'."\n" ."\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 playbook metadata, including its name, description, number of runs, and failure rate.', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ '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' => '2a687089-d4dd-47d4-9709-xxxxxx'], ], [ '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' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ '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.', 'type' => 'object', 'properties' => [ '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'], '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', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookMetrics'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', '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-xxxxx'], ], [ 'name' => 'NodeName', 'in' => 'query', '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 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', 'description' => 'The response that is returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A491170C-FE1F-520E-83D4-72ED205B72ED'], 'PlaybookNodesOutput' => [ 'title' => '', 'description' => 'The output data of the node.', 'type' => 'object', 'properties' => [ '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'], '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 **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" .'- **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' => '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ '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', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Metrics' => [ 'title' => '', 'description' => 'The statistics.', 'type' => 'object', 'properties' => [ '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 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'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metrics\\": {\\n \\"TotalNum\\": 100,\\n \\"StartUpNum\\": 50\\n },\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\"\\n}","type":"json"}]', 'title' => 'DescribePlaybookNumberMetrics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNumberMetrics'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'query', '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" ."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', '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 of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult>', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3DFBE11C-6EB6-5166-92D6-3397796AFE1E'], 'Records' => [ 'title' => '', 'description' => 'A list of playbook versions.', 'type' => 'array', 'items' => [ 'description' => 'The version information.', 'type' => 'object', 'properties' => [ '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.', 'type' => 'object', 'properties' => [ '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'], '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', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookReleases'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '167066', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Active', 'in' => 'query', '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' => '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' => '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' => '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" ."\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'], ], [ '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" ."\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 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' => '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' => ['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 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 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' => '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>', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ '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' => 'The list of playbooks.', 'type' => 'array', 'items' => [ '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. 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' => 'The pagination information.', 'type' => 'object', 'properties' => [ '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'], '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', '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' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', '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 version number of the API.', 'type' => 'string', 'required' => true, 'example' => '2021-10-01', 'title' => ''], ], [ 'name' => 'ApiName', 'in' => 'query', 'schema' => ['description' => 'The name of the Alibaba Cloud product API.', 'type' => 'string', 'required' => true, 'example' => 'DescribeInstanceInfo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'The response contains the requested information.', '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' => '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' => 'List of API information.', 'type' => 'array', 'items' => [ 'description' => 'Detailed information.', 'type' => 'object', 'properties' => [ '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'], 'title' => 'DescribePopApi', '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'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208550', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', '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' => 'RoleType', 'in' => 'query', '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' => 'RoleFor', 'in' => 'query', 'schema' => ['description' => 'The user ID of the member to which the administrator switches the view.', 'type' => 'string', 'required' => false, 'example' => '1709821xxxxx3093', 'title' => ''], ], [ 'name' => 'ProcessActionStart', 'in' => 'query', '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' => '', 'description' => 'SophonResult', 'type' => 'object', 'properties' => [ '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'], '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'], ], ], 'ramActions' => [], ], 'DescribeProcessTaskCount' => [ 'summary' => 'Queries the count of response tasks associated with an entity UUID.', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245000', 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'EntityUuidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ '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, 'maxItems' => 100, 'example' => '', ], ], [ '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, '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>', 'description' => 'The data that is returned.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'e866cce0-****-41de-817e-****8d5e2650'], 'Data' => [ 'title' => '传输的数据', '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\\": \\"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'], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '186031', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'ProcessStrategyUuid', 'in' => 'query', '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' => 'EntityName', 'in' => 'query', 'schema' => ['description' => 'The name of the entity to which the response is performed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '127.0.0.1'], ], [ 'name' => 'EntityType', 'in' => 'query', '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' => 'SceneCode', 'in' => 'query', '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' => 'TaskStatus', 'in' => 'query', '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' => 'Scope', 'in' => 'query', 'schema' => ['description' => 'The ID of the Alibaba Cloud account for which the response task is performed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '125xxxxx9870'], ], [ 'name' => 'Source', 'in' => 'query', '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' => 'ProcessActionStart', 'in' => 'query', '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' => 'ProcessActionEnd', 'in' => 'query', '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' => 'ProcessRemoveStart', 'in' => 'query', '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' => 'ProcessRemoveEnd', 'in' => 'query', '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' => 'ParamContent', 'in' => 'query', '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' => 'PageSize', 'in' => 'query', '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' => 'PageNumber', 'in' => 'query', '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' => ''], ], [ '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' => ''], ], [ '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' => ''], ], [ 'name' => 'OrderField', 'in' => 'query', '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' => 'Direction', 'in' => 'query', 'schema' => ['description' => 'The sort order. Valid values:'."\n" ."\n" .'- **desc**: descending (default)'."\n" ."\n" .'- **asc**: ascending', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'EntityUuid', 'in' => 'query', 'schema' => ['description' => 'The UUID of the entity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n"], ], [ 'name' => 'EventUuid', 'in' => 'query', 'schema' => ['description' => 'The UUID of the event.', 'type' => 'string', 'required' => false, 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****', 'title' => ''], ], [ 'name' => 'TriggerSource', 'in' => 'query', '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' => 'ReqUuid', 'in' => 'query', 'schema' => ['description' => 'The playbook trigger ID.', 'type' => 'string', 'required' => false, 'example' => 'b73d0b08-f1bd-4e8f-967a-8e2982c9****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult>', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ '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" .'- **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', 'example' => 'system', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Page' => [ 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ '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'], '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' => '*'], ], ], ], ], ], 'DescribeSoarRecordActionOutputList' => [ 'summary' => 'Retrieves the output data generated by a component for an action in a playbook task.', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ActionUuid', 'in' => 'query', '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 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', 'description' => 'The response.', 'type' => 'object', 'properties' => [ '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\\": \\"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'], ], ], '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' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ActionUuid', 'in' => 'query', '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 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', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ '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\\": \\"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" .'- **actionUuid**: The UUID of the component action execution record.'."\n" ."\n" .'- **startTime**: The time when the component action started.'."\n" ."\n" .'- **taskName**: The name of the playbook task that corresponds to the component action.'."\n" ."\n" .'- **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' => '*'], ], ], ], ], ], 'DescribeSoarRecords' => [ 'summary' => 'Queries the execution records for 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' => ['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' => 'TaskflowMd5', 'in' => 'query', 'schema' => ['title' => '任务的版本ID', 'description' => 'The MD5 value of the playbook configuration.', 'type' => 'string', 'required' => false, 'example' => 'be0a4ef084dd174abe478df52xxxxx'], ], [ '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' => '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' => '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' => ''], ], [ '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' => ''], ], [ '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' => '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' => ''], ], [ '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' => ''], ], [ 'name' => 'RequestUuid', 'in' => 'query', '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' => ''], ], [ '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' => ''], ], [ 'name' => 'QueryValue', 'in' => 'query', 'schema' => ['description' => 'The input parameter of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'input', 'title' => ''], ], [ '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' => '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>', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ '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\\": \\"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'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-sas:DescribeSoarRecords', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'], ], ], ], ], ], 'DescribeSoarTaskAndActions' => [ 'summary' => 'Retrieves the component execution records for a single playbook run.', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RequestUuid', 'in' => 'query', 'schema' => ['description' => 'The UUID of the playbook task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1077f2f9-25e8-42d9-bfdf-1528e1313f6d'], ], [ '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, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', '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' => 'QueryValue', 'in' => 'query', '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', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ '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' => [ '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' => '', ], '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 \\"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'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-sas:DescribeSoarTaskAndActions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeSophonCommands' => [ 'summary' => 'Queries the commands that are used to manage entities.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ '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>', 'description' => 'The returned information.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The list of returned commands.', 'type' => 'array', 'items' => [ 'description' => 'The details of the command.', 'type' => 'object', 'properties' => [ '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' => '', ], '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' => '', ], ], ], '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'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'yundun-sas:DescribeSophonCommands', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeVendorApiList' => [ 'summary' => 'Queries the API operations of a cloud service provider.', 'path' => '', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The current page number for pagination. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', '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' => 'KeyWord', 'in' => 'query', 'schema' => ['description' => 'Keyword.', 'type' => 'string', 'required' => false, 'example' => 'Create', 'title' => ''], ], [ 'name' => 'ProductCode', 'in' => 'query', 'schema' => ['description' => 'Vendor\'s product identifier:'."\n" .'- **waf**: Web Application Firewall.'."\n" .'- **cfw**: Cloud Firewall.', 'type' => 'string', 'required' => false, 'example' => 'waf', 'title' => ''], ], [ 'name' => 'ApiName', 'in' => 'query', 'schema' => ['description' => 'The name of the Alibaba Cloud product interface, supporting fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'AddAssetCleanConfig', 'title' => ''], ], [ 'name' => 'VendorCode', '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', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', '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', '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' => '', ], 'ApiList' => [ 'description' => 'Product information.', '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', '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-****-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' => '*'], ], ], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RequestUuid', 'in' => 'query', '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' => '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', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ '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\\": \\"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'], ], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AssetConfig', 'in' => 'query', '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', 'description' => 'The response.', 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', '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' => true, 'title' => '', 'example' => '8baa6cff-319e-4ede-97bc-1586c35e61f8'], ], [ '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' => ''], ], [ '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', 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ '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'], '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'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybook'], ], ], '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' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsas104PTS'], 'tenantRelevance' => 'tenant', ], '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' => '8baa6cff-319e-4ede-97bc-xxxxxxx'], ], [ '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' => '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' => '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' => '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' => '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', 'description' => 'The response.', 'type' => 'object', 'properties' => [ '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'], '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'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInputOutput'], ], ], '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ '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' => '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 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', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ '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'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2A32830-2842-5F8F-B4ED-E4783E400BBE\\"\\n}","type":"json"}]', 'title' => 'ModifyPlaybookInstanceStatus', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'PublishPlaybook' => [ 'summary' => 'Publishes a playbook. Once published, the playbook runs with the new logic.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsasK0Q1Y8'], ], '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' => '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' => [ 'title' => 'SophonResult', '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' => [ [ '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' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'query', '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', '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' => '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\\": \\"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'], ], ], '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' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', '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' => true, 'title' => '', 'example' => '185295a1-c987-4b64-8796-xxxxxxxx'], ], [ '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' => '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', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ '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'], '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}'], ], ], ], ], ], 'RunNotifyComponentWithEmail' => [ 'summary' => 'Runs the notification component to send an email message.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226653', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Receivers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '', 'description' => 'A list of email addresses.', 'type' => 'array', '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' => ['description' => 'The title of the email.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'title'], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The body of the email.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'email content'], ], [ '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' => 'e99dab31-499b-4307-9248-xxxxxx'], ], [ 'name' => 'NodeName', 'in' => 'query', 'schema' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notify_message_1'], ], [ 'name' => 'ComponentName', 'in' => 'query', 'schema' => ['description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'NotifyMessage'], ], [ 'name' => 'ActionName', 'in' => 'query', 'schema' => ['description' => 'The name of the component action.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notifyByCustom'], ], [ 'name' => 'AssetId', 'in' => 'query', '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 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. 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 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', 'description' => 'SophonResult', 'type' => 'object', 'properties' => [ '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.', 'type' => 'object', 'properties' => [ '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'], '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"}]', ], 'RunNotifyComponentWithMessageCenter' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226714', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Aliuid', 'in' => 'query', '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' => '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' => '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', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '通道类型集合，不传默认发送消息事件配置的所有通道', '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' => '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" ."\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 name of the playbook node.', 'type' => 'string', 'required' => true, 'example' => 'notify_message'], ], [ 'name' => 'ComponentName', 'in' => 'query', 'schema' => ['title' => '剧本的组件名称', 'description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'example' => 'NotifyMessage'], ], [ 'name' => 'ActionName', 'in' => 'query', 'schema' => ['title' => '剧本的动作名称', 'description' => 'The name of the playbook action.', 'type' => 'string', 'required' => true, 'example' => 'notifyByMessageCenter'], ], [ 'name' => 'AssetId', 'in' => 'query', '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 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. 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 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', 'description' => 'SophonResult', 'type' => 'object', 'properties' => [ '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' => 'The pagination information.', 'type' => 'object', 'properties' => [ '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'], '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"}]', ], 'RunNotifyComponentWithWebhook' => [ 'summary' => 'Sends a message from a notification component using a webhook.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226713', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'Webhook', 'in' => 'query', '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' => ['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' => ['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' => ['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' => ['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' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notify_message_node'], ], [ 'name' => 'ComponentName', 'in' => 'query', 'schema' => ['description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'NotifyMessage'], ], [ 'name' => 'ActionName', 'in' => 'query', 'schema' => ['description' => 'The name of the playbook action.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notifyByCustom'], ], [ 'name' => 'AssetId', 'in' => 'query', '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 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. 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 UID of the member that the administrator wants to switch to.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '126339xxxx805497', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult', 'description' => 'SophonResult', 'type' => 'object', 'properties' => [ '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.', 'type' => 'object', 'properties' => [ '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'], '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 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'], ], '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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ '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' => [ 'title' => 'SophonResult', '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' => [ [ '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' => [ 'title' => 'SophonResult', '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' => [ [ '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' => [ 'title' => 'SophonResult', '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' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '149322', 'abilityTreeNodes' => ['FEATUREsas104PTS'], ], 'parameters' => [ [ 'name' => 'CommandName', 'in' => 'query', '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' => 'InputParams', 'in' => 'query', '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' => 'SophonTaskId', 'in' => 'query', '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' => 'SophonResult', 'description' => 'The information returned.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The details returned after the command or playbook is triggered.', 'type' => 'object', 'properties' => [ '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' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SophonResult>', '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' => ''], ], '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' => '', ], ], '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', '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' => [ 'type' => 'object', 'properties' => [ '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' => '', ], ], ], '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' => '*'], ], ], ], ], ], ], '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' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'DescribePlaybookInputOutput'], ], 'createdAt' => '2024-03-15T02:09:33.000Z', 'description' => '', ], [ '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' => [], ], ];