diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/sophonsoar/2022-07-28/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/sophonsoar/2022-07-28/api-docs.php')
| -rw-r--r-- | data/en_us/sophonsoar/2022-07-28/api-docs.php | 8178 |
1 files changed, 8178 insertions, 0 deletions
diff --git a/data/en_us/sophonsoar/2022-07-28/api-docs.php b/data/en_us/sophonsoar/2022-07-28/api-docs.php new file mode 100644 index 0000000..9643567 --- /dev/null +++ b/data/en_us/sophonsoar/2022-07-28/api-docs.php @@ -0,0 +1,8178 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'sophonsoar', + 'version' => '2022-07-28', + ], + 'directories' => [ + [ + 'id' => 349146, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CopyPlaybook', + 'ConvertPlaybook', + 'RunPython3Script', + 'ComparePlaybooks', + 'CreatePlaybook', + 'DebugPlaybook', + 'DeleteComponentAsset', + 'DeletePlaybook', + 'DescribeComponentAssetForm', + 'DescribeComponentAssets', + 'DescribeComponentList', + 'DescribeComponentPlaybook', + 'DescribeComponentsJs', + 'DescribeDistinctReleases', + 'DescribeEnumItems', + 'DescribeExecutePlaybooks', + 'DescribeField', + 'DescribeLatestRecordSchema', + 'DescribeNodeParamTags', + 'DescribePlaybook', + 'DescribePlaybookInputOutput', + 'DescribePlaybookMetrics', + 'DescribePlaybookNodesOutput', + 'DescribePlaybookNumberMetrics', + 'DescribePlaybookReleases', + 'DescribePlaybooks', + 'DescribePopApi', + 'DescribeSoarRecordActionOutputList', + 'DescribeSoarRecordInOutput', + 'DescribeSoarRecords', + 'DescribeSoarTaskAndActions', + 'DescriberPython3ScriptLogs', + 'ModifyComponentAsset', + 'ModifyPlaybook', + 'ModifyPlaybookInputOutput', + 'PublishPlaybook', + 'QueryTreeData', + 'RevertPlaybookRelease', + 'TriggerPlaybook', + 'TriggerSophonPlaybook', + 'VerifyPlaybook', + 'VerifyPythonFile', + ], + ], + [ + 'id' => 349193, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeProcessStatistics', + 'DescribeProcessTasks', + 'DescribeProcessTaskCount', + 'DescribeSophonCommands', + 'TriggerProcessTask', + ], + ], + [ + 'id' => 349199, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeOpenApiList', + 'DescribeOpenApiInfo', + 'DescribeGroupProductions', + 'DescribeNotifyTemplateList', + 'RunNotifyComponentWithEmail', + 'RunNotifyComponentWithMessageCenter', + 'RunNotifyComponentWithWebhook', + 'DescribeVendorApiList', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + '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' => '要复制的剧本uuid', + 'description' => 'The UUID of the playbook that you want to copy.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '94bc318c-****-4cba-****-801ccb0d739f', + ], + ], + [ + 'name' => 'ReleaseVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => '要复制的剧本的taskflowMd5. 特殊取值：-1：代表现在编辑中的版本 0:当前剧本的线上最新发布版本(不传默认为0)', + 'description' => 'The release version of the playbook that you want to copy. Default value: 0. Valid values:'."\n" + ."\n" + .'* \\-1: The version that is being edited.'."\n" + .'* 0: The latest online version of the current playbook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookCloudDTO>', + 'description' => 'SophonResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'title' => '剧本的名称', + 'description' => 'The name of the new playbook.'."\n", + 'type' => 'string', + 'example' => '11111', + ], + 'PlaybookUuid' => [ + 'title' => '剧本的UUID', + 'description' => 'The UUID of the new playbook.'."\n", + 'type' => 'string', + 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx', + ], + 'OwnType' => [ + 'title' => '剧本的权限类型', + 'description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'* preset: predefined playbook.'."\n" + .'* user: custom playbook.'."\n", + 'type' => 'string', + 'example' => 'user', + ], + 'Active' => [ + 'title' => '剧本的启用状态', + 'description' => 'The status of the playbook. Valid values:'."\n" + ."\n" + .'* 1: enabled.'."\n" + .'* 0: disabled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastRuntime' => [ + 'title' => '剧本的最后执行时间', + 'description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1725258397847', + ], + 'Permission' => [ + 'title' => '剧本是否可编辑', + 'description' => 'The permission to operate the playbook. Valid values:'."\n" + ."\n" + .'* 1: view.'."\n" + .'* 2: edit.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtCreate' => [ + 'title' => '剧本创建时间', + 'description' => 'The time when the playbook was created. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655951601000', + ], + 'GmtModified' => [ + 'title' => '剧本创建时间', + 'description' => 'The time when the playbook was modified. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1638270967000', + ], + 'HistoryMd5' => [ + 'title' => '剧本历史版本数', + 'description' => 'The number of historical versions of the playbook.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SuccNum' => [ + 'title' => '剧本执行成功数', + 'description' => 'The number of successful playbook executions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FailNum' => [ + 'title' => '剧本执行失败数', + 'description' => 'The number of playbook execution failures.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FailRate' => [ + 'title' => '剧本执行失败率', + 'description' => 'The failure rate of playbook execution.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '0.5', + ], + 'InputParams' => [ + 'title' => '剧本的入参', + 'description' => 'The input parameters of the playbook.'."\n", + 'type' => 'string', + 'example' => '[{\\"name\\":\\"1\\",\\"dataType\\":\\"String\\",\\"required\\":false,\\"isArray\\":false,\\"example\\":\\"\\",\\"description\\":\\"\\",\\"id\\":0,\\"typeName\\":\\"String\\",\\"dataClass\\":\\"normal\\"}]', + ], + 'OutputParams' => [ + 'title' => '剧本的出参', + 'description' => 'The output parameters of the playbook.'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'Description' => [ + 'title' => '剧本描述', + 'description' => 'The description of the playbook.'."\n", + 'type' => 'string', + 'example' => 'This is a action of processing for WAF', + ], + 'LogicReleaseTaskflowMd5' => [ + 'title' => '剧本的线上版本', + 'description' => 'The online version MD5 of the playbook.'."\n", + 'type' => 'string', + 'example' => '037046****1b00c4717963818ccbf2xx', + ], + 'PlaybookStatus' => [ + 'title' => '剧本描述', + 'description' => 'The status of the playbook.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TenantId' => [ + 'title' => '剧本所属的租户', + 'description' => 'The ID of the user to which the playbook belongs.'."\n", + 'type' => 'string', + 'example' => '13760*****8718726', + ], + ], + ], + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2EC05B06-****-5F3E-****-3B1FAD76087A\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"11111\\",\\n \\"PlaybookUuid\\": \\"9e38111e-9794-4784-9ca8-xxxxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1725258397847,\\n \\"Permission\\": 1,\\n \\"GmtCreate\\": 1655951601000,\\n \\"GmtModified\\": 1638270967000,\\n \\"HistoryMd5\\": 1,\\n \\"SuccNum\\": 1,\\n \\"FailNum\\": 1,\\n \\"FailRate\\": 0.5,\\n \\"InputParams\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"isArray\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"typeName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataClass\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"normal\\\\\\\\\\\\\\"}]\\",\\n \\"OutputParams\\": \\"[]\\",\\n \\"Description\\": \\"This is a action of processing for WAF\\",\\n \\"LogicReleaseTaskflowMd5\\": \\"037046****1b00c4717963818ccbf2xx\\",\\n \\"PlaybookStatus\\": 1,\\n \\"TenantId\\": \\"13760*****8718726\\"\\n },\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'CopyPlaybook', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + ], + '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' => '<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>'."\n" + .'<bpmn:definitions xmlns:xsi=\\"http://www.w3.org/2001/XMLSchema-instance\\" xmlns:bpmn=\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\" xmlns:bpmndi=\\"http://www.omg.org/spec/BPMN/20100524/DI\\" xmlns:dc=\\"http://www.omg.org/spec/DD/20100524/DC\\" id=\\"Definitions_1\\" targetNamespace=\\"http://bpmn.io/schema/bpmn\\">'."\n" + .' <bpmn:process id=\\"Process_1\\" isExecutable=\\"false\\">'."\n" + .' <bpmn:startEvent id=\\"StartEvent_1\\" />'."\n" + .' </bpmn:process>'."\n" + .' <bpmndi:BPMNDiagram id=\\"BPMNDiagram_1\\">'."\n" + .' <bpmndi:BPMNPlane id=\\"BPMNPlane_1\\" bpmnElement=\\"Process_1\\">'."\n" + .' <bpmndi:BPMNShape id=\\"_BPMNShape_StartEvent_2\\" bpmnElement=\\"StartEvent_1\\">'."\n" + .' <dc:Bounds x=\\"173\\" y=\\"102\\" width=\\"36\\" height=\\"36\\" />'."\n" + .' </bpmndi:BPMNShape>'."\n" + .' </bpmndi:BPMNPlane>'."\n" + .' </bpmndi:BPMNDiagram>'."\n" + .'</bpmn:definitions>'."\n" + .' ', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Language type for request and response messages. Values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'SophonResult<String>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => '39C38A34-****-*****-****-7263B435C316', + ], + 'Config' => [ + 'title' => '传输的数据', + 'description' => 'The configurations.', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-****-*****-****-7263B435C316\\",\\n \\"Config\\": \\"{}\\"\\n}","type":"json"}]', + 'title' => 'Convert Playbook Flowchart Configuration Format', + 'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the orchestration product before using this interface.', + 'translator' => 'machine', + ], + 'RunPython3Script' => [ + 'summary' => 'Submits and runs a Python3 script. You can call this operation only for data processing.', + 'methods' => [ + 'post', + ], + '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 Python3 script.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'import logging'."\n" + .'def execute (params):'."\n" + .' #ip = params[\'ip\']'."\n" + .' #logging.info("enter execute,ip is "+ip)'."\n" + .' success=True'."\n" + .' message=\'OK\''."\n" + .' data=[]'."\n" + .' return (success,message,data)', + ], + ], + [ + 'name' => 'Params', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The input parameters of the Python3 script.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "input1": "xx.xx.xx.xx",'."\n" + .' "input2": "7d"'."\n" + .'}', + ], + ], + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.', + 'type' => 'string', + 'required' => false, + 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the node in the playbook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'python3_3', + ], + ], + [ + 'name' => 'PythonVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'python版本。', + 'type' => 'string', + 'example' => 'python2.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F210521C-D9BF-5264-8369-83EDDC617DB0', + ], + 'RunResult' => [ + 'title' => '传输的数据', + 'description' => 'The execution result of the Python3 script.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n" + .' "content": {'."\n" + .' "resultData": [],'."\n" + .' "success": true'."\n" + .' }'."\n" + .'}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F210521C-D9BF-5264-8369-83EDDC617DB0\\",\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'RunPython3Script', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.alibabacloud.com/en/pricing-calculator?_p_lc=1&spm=openapi-amp.newDocPublishment.0.0.4c41281fWhbdPa#/commodity/vm_intl).', + 'responseParamsDescription' => 'The value of **RunResult** is a JSON object, which contains the following fields:'."\n" + ."\n" + .'* **requestUuid**: the UUID of the request, which is used to query operational logs.'."\n" + .'* **content**: the execution result of the Python3 script, which is defined by users.'."\n", + ], + 'ComparePlaybooks' => [ + 'summary' => 'Compares configurations between two versions of a published playbook.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'f916b93e-e814-459f-9662-xxxxx', + ], + ], + [ + 'name' => 'OldPlaybookReleaseId', + 'in' => 'query', + 'schema' => [ + 'title' => '老版本的ID', + 'description' => 'The ID of the first version.'."\n" + ."\n" + .'> You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to query the IDs of versions. The system automatically generates IDs for new versions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => 'sflk23423-e814-459f-9662-xxxxx', + ], + ], + [ + 'name' => 'NewPlaybookReleaseId', + 'in' => 'query', + 'schema' => [ + 'title' => '新版本的ID', + 'description' => 'The ID of the second version.'."\n" + ."\n" + .'> You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to query the IDs of versions. The system automatically generates IDs for new versions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => 'sfdf2395-e814-459f-9662-xxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<CompareResult>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2EC05B06-BF3C-5F3E-8FE8-3B1FAD76087A', + ], + 'CompareResult' => [ + 'title' => '传输的数据', + 'description' => 'The comparison result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Same' => [ + 'description' => 'Indicates whether the configurations of the two versions are the same. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'New' => [ + 'description' => 'Indicates whether the second version provides more information than the first version. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Description' => [ + 'description' => 'The description of the comparison result.'."\n", + 'type' => 'string', + 'example' => 'The first version adds one node compared to the second version', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'CreatePlaybook' => [ + 'summary' => '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' => 'Name of the playbook.', + 'type' => 'string', + 'required' => true, + 'example' => 'test09', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本的描述', + 'description' => 'Description of the playbook.', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a new version', + ], + ], + [ + 'name' => 'TaskflowType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Playbook TaskFlow type.'."\n" + .'- **x6** : x6'."\n" + .'- **bpmn**: bpmn', + 'example' => 'x6', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Language type for receiving messages. Values:'."\n" + ."\n" + .'- **zh** (default): Chinese'."\n" + .'- **en**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'OutputParams', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本输出配置。', + 'type' => 'string', + 'example' => '{\'result\': \'success\'}', + ], + ], + [ + 'name' => 'InputParams', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本输入配置。', + 'type' => 'string', + 'example' => '{\'key1\': \'value1\', \'key2\': \'value2\'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookCloudDTO>', + 'description' => 'Return information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The ID of this call request, a unique identifier generated by Alibaba Cloud for this request, which can be used to troubleshoot and locate issues.', + 'type' => 'string', + 'example' => 'B09B40B2-F11E-512C-B755-423F2056C17B', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The result of the creation.', + 'type' => 'object', + 'properties' => [ + 'PlaybookUuid' => [ + 'title' => '剧本唯一标识符。', + 'description' => 'UUID of the newly created playbook.', + 'type' => 'string', + 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B09B40B2-F11E-512C-B755-423F2056C17B\\",\\n \\"Data\\": {\\n \\"PlaybookUuid\\": \\"9e38111e-9794-4784-9ca8-xxxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreatePlaybook', + 'description' => 'Create Playbook.', + 'translator' => 'machine', + ], + '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' => [ + 'title' => '剧本UUID', + 'description' => 'The playbook UUID.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'f916b93e-e814-459f-9662-xxxxx', + ], + ], + [ + 'name' => 'Record', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本的入参', + 'description' => 'The input parameters that you use to debug the playbook. You can define the parameters based on your business requirements.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "param1":"a",'."\n" + .' "param2":"b"'."\n" + .'}', + ], + ], + [ + 'name' => 'Taskflow', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本流程', + 'description' => 'The XML configuration of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybook](~~DescribePlaybook~~) operation to query the XML configuration of the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'."\n", + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookTriggerDTO>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF', + ], + 'RequestUuid' => [ + 'description' => 'The UUID of the debugging task. You can use the UUID to query the result and other details of the debugging task.'."\n", + 'type' => 'string', + 'example' => '6d412cfa-0905-4567-8a83-xxxxxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF\\",\\n \\"RequestUuid\\": \\"6d412cfa-0905-4567-8a83-xxxxxx\\"\\n}","type":"json"}]', + 'title' => 'DebugPlaybook', + ], + 'DeleteComponentAsset' => [ + 'summary' => 'Deletes the assets in a component.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AssetId', + 'in' => 'query', + 'schema' => [ + 'title' => '资产的ID', + 'description' => 'The ID of the asset.'."\n" + ."\n" + .'> You can call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to query the ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12x', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '39C38A34-8532-5D44-B88A-7263B435C316', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-8532-5D44-B88A-7263B435C316\\"\\n}","type":"json"}]', + 'title' => 'DeleteComponentAsset', + ], + 'DeletePlaybook' => [ + 'summary' => 'Deletes a custom playbook.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'e99dab31-499b-4307-9248-xxxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]', + 'title' => 'DeletePlaybook', + ], + 'DescribeComponentAssetForm' => [ + 'summary' => 'Queries the metadata of assets in a component. The metadata of an asset refers to the fields that describe the asset.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => [ + 'title' => '组件的名称', + 'description' => 'The component name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'python3', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9D1651AC-31CC-5CC4-A14E-626B3FCC1022', + ], + 'ComponentAssetForm' => [ + 'title' => '传输的数据', + 'description' => 'The metadata of the asset in the component. The value is a JSON array and contains the following fields:'."\n" + ."\n" + .'* **name**: the parameter name.'."\n" + .'* **defaultValue**: the default parameter value.'."\n" + .'* **description**: the parameter description.'."\n" + .'* **required**: indicates whether the parameter is required. Valid values: **true** and **false**.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "defaultValue": "",'."\n" + .' "description": "assetname",'."\n" + .' "name": "assetname",'."\n" + .' "required": true'."\n" + .' }'."\n" + .']', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D1651AC-31CC-5CC4-A14E-626B3FCC1022\\",\\n \\"ComponentAssetForm\\": \\"[\\\\n {\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"assetname\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"assetname\\\\\\",\\\\n \\\\\\"required\\\\\\": true\\\\n }\\\\n]\\"\\n}","type":"json"}]', + 'title' => 'DescribeComponentAssetForm', + ], + 'DescribeComponentAssets' => [ + 'summary' => 'Queries a list of assets in a component.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => [ + 'title' => '组件的名称', + 'description' => 'The name of the component.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'python3', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<SaoAsset>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F', + ], + 'ComponentAssets' => [ + 'title' => '传输的数据', + 'description' => 'The information about the assets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'This field was generated by MyBatis Generator.', + 'description' => 'The UUID of the asset.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7xx', + ], + 'GmtCreate' => [ + 'title' => 'This field was generated by MyBatis Generator.', + 'description' => 'The time when the asset was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-03-23T14:38Z', + ], + 'GmtModified' => [ + 'title' => 'This field was generated by MyBatis Generator.', + 'description' => 'The time when the asset was modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-03-23T14:38Z', + ], + 'Name' => [ + 'title' => 'This field was generated by MyBatis Generator.', + 'description' => 'The name of the asset.'."\n", + 'type' => 'string', + 'example' => 'test asset', + ], + 'Componentname' => [ + 'title' => 'This field was generated by MyBatis Generator.', + 'description' => 'The name of the component to which the asset belongs.'."\n", + 'type' => 'string', + 'example' => 'pyhton3', + ], + 'Params' => [ + 'title' => 'This field was generated by MyBatis Generator.', + 'description' => 'The configurations of the asset in the JSON string format. DescribeComponentAssetForm'."\n" + ."\n" + .'> For more information, see [DescribeComponentAssetForm](~~DescribeComponentAssetForm~~).'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "name": "authMethod",'."\n" + .' "value": "ak"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "accessKeyId",'."\n" + .' "value": "xxxxxxx"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "accessKeySecret",'."\n" + .' "value": "xxxxx"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "roleArn",'."\n" + .' "value": ""'."\n" + .' }'."\n" + .']', + ], + 'AssetUuid' => [ + 'description' => 'The UUID of the asset.'."\n", + 'type' => 'string', + 'example' => 'ff6fe161-93e2-464c-a326-fxxxxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"Id\\": 0,\\n \\"GmtCreate\\": \\"2023-03-23T14:38Z\\",\\n \\"GmtModified\\": \\"2023-03-23T14:38Z\\",\\n \\"Name\\": \\"test asset\\",\\n \\"Componentname\\": \\"pyhton3\\",\\n \\"Params\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"authMethod\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ak\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"accessKeyId\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"xxxxxxx\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"accessKeySecret\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"xxxxx\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"roleArn\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"\\\\\\"\\\\n }\\\\n]\\",\\n \\"AssetUuid\\": \\"ff6fe161-93e2-464c-a326-fxxxxxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeComponentAssets', + ], + 'DescribeComponentList' => [ + 'summary' => 'Queries a list of common components that are available.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B0A255B3-495C-56FB-8B6B-DB073F80388A', + ], + 'Components' => [ + 'title' => '传输的数据', + 'description' => 'The information about the components. The value is a JSON array.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "actions": ['."\n" + .' {'."\n" + .' "description": "mysql component",'."\n" + .' "name": "storeIdb",'."\n" + .' "parameters": ['."\n" + .' {'."\n" + .' "description": "update the mysql db",'."\n" + .' "name": "updateSql",'."\n" + .' "required": false'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ],'."\n" + .' "basic": {'."\n" + .' "description": "mysq sql component for 5.6",'."\n" + .' "logo": "https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg",'."\n" + .' "name": "Mysql"'."\n" + .' }'."\n" + .' }'."\n" + .']', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B0A255B3-495C-56FB-8B6B-DB073F80388A\\",\\n \\"Components\\": \\"[\\\\n {\\\\n \\\\\\"actions\\\\\\": [\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"mysql component\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"storeIdb\\\\\\",\\\\n \\\\\\"parameters\\\\\\": [\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"update the mysql db\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"updateSql\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n ]\\\\n }\\\\n ],\\\\n \\\\\\"basic\\\\\\": {\\\\n \\\\\\"description\\\\\\": \\\\\\"mysq sql component for 5.6\\\\\\",\\\\n \\\\\\"logo\\\\\\": \\\\\\"https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Mysql\\\\\\"\\\\n }\\\\n }\\\\n]\\"\\n}","type":"json"}]', + 'title' => 'DescribeComponentList', + 'responseParamsDescription' => 'The value of **Components** is a JSON string, which contains the following fields:'."\n" + ."\n" + .'* **actions**: the actions that are supported by the component. The value is a JSON array and 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 of the action. The value is a JSON object and contains the following fields:'."\n" + ."\n" + .' * **description**: the description of the input parameter.'."\n" + .' * **name**: the name of the input parameter.'."\n" + .' * **required**: specifies whether the input parameter is required. Valid values are true and false.'."\n" + ."\n" + .'* **basic**: the basic information of the component. The value contains the following fields:'."\n" + ."\n" + .'* **description**: the description of the component.'."\n" + ."\n" + .'* **logo**: the address information of the component logo.'."\n" + ."\n" + .'* **name**: the name of the component.'."\n", + ], + 'DescribeComponentPlaybook' => [ + 'summary' => 'Queries a list of predefined components that are available.', + '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" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ac343acc-1a61-4084-9a1cxxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<PlaybookCloudDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId。', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C5F5D6C9-DF1A-5381-92B1-39676F777D20', + ], + 'Playbooks' => [ + 'title' => '传输的数据。', + 'description' => 'The information about the predefined components.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'title' => '剧本的名称。', + 'description' => 'The name of the predefined component.'."\n", + 'type' => 'string', + 'example' => 'AegisKillQuara', + ], + 'InputParams' => [ + 'title' => '剧本的入参。', + 'description' => 'The input parameter configuration of the playbook. The value is a JSON array.'."\n" + ."\n" + .'> For more information, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']', + ], + 'Description' => [ + 'title' => '剧本描述。', + 'description' => 'The description of the predefined component.'."\n", + 'type' => 'string', + 'example' => 'aegis_kill_process', + ], + 'ParamType' => [ + 'title' => '剧本的入参类型。'."\n" + ."\n" + .'template-ip：IP请求模板。'."\n" + .'template-file：文件请求模板。'."\n" + .'template-process：进程请求模板。'."\n" + .'custom：自定义参数。', + 'type' => 'string', + 'example' => 'template-alert', + ], + ], + 'title' => '预定义剧本信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5F5D6C9-DF1A-5381-92B1-39676F777D20\\",\\n \\"Playbooks\\": [\\n {\\n \\"DisplayName\\": \\"AegisKillQuara\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"Description\\": \\"aegis_kill_process\\",\\n \\"ParamType\\": \\"template-alert\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeComponentPlaybook', + ], + 'DescribeComponentsJs' => [ + 'summary' => 'Queries the JavaScript file of a component. The component uses the returned JavaScript file for page rendering.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073', + ], + 'ComponentsJs' => [ + 'title' => '传输的数据', + 'description' => 'The configuration of the JavaScript file for the component.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "js": "https://xxxxx.oss-cn-zhangjiakou.aliyuncs.com/componentUpload/xxxxx",'."\n" + .' "name": "python3",'."\n" + .' "ownType": "sys"'."\n" + .' }'."\n" + .']', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\",\\n \\"ComponentsJs\\": \\"[\\\\n {\\\\n \\\\\\"js\\\\\\": \\\\\\"https://xxxxx.oss-cn-zhangjiakou.aliyuncs.com/componentUpload/xxxxx\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"python3\\\\\\",\\\\n \\\\\\"ownType\\\\\\": \\\\\\"sys\\\\\\"\\\\n }\\\\n]\\"\\n}","type":"json"}]', + 'title' => 'DescribeComponentsJs', + 'responseParamsDescription' => 'The value of the **ComponentsJs** parameter is a JSON array, which contains the following fields:'."\n" + ."\n" + .'* **js**: the URL of the JavaScript file.'."\n" + .'* **name**: the name of the component.'."\n" + .'* **ownType**: the type of component. The value is fixed as **sys**. Components of other types are unavailable.'."\n", + ], + 'DescribeDistinctReleases' => [ + 'summary' => 'Queries the information about the published versions of a playbook after deduplication.', + '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' => [ + 'title' => '剧本UUID', + 'description' => 'The playbook UUID.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'bc0b8424-535c-4ed5-bd94-xxxxxx', + ], + ], + [ + 'name' => 'TaskflowMd5', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The MD5 value of the playbook XML configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'be0a4ef084dd174abe47xxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<SaoReleaseInfo>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '145CACF6-D276-5197-8549-CB1AD76E2AC8', + ], + 'Records' => [ + 'title' => '传输的数据', + 'description' => 'The information about versions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the version.'."\n", + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '描述信息', + 'description' => 'The version description.'."\n", + 'type' => 'string', + 'example' => 'demo version', + ], + 'TaskflowMd5' => [ + 'title' => 'taskflow的MD5信息，用于比较是否 有变化', + 'description' => 'The MD5 value of the version XML configuration.'."\n", + 'type' => 'string', + 'example' => '17cf53049bc8efa941207xxxxx', + ], + 'TaskflowType' => [ + 'description' => 'The format of the playbook. Valid values:'."\n" + ."\n" + .'* **xml**: XML format.'."\n" + .'* **x6**: JSON format.'."\n", + 'type' => 'string', + 'example' => 'x6', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"145CACF6-D276-5197-8549-CB1AD76E2AC8\\",\\n \\"Records\\": [\\n {\\n \\"Description\\": \\"demo version\\",\\n \\"TaskflowMd5\\": \\"17cf53049bc8efa941207xxxxx\\",\\n \\"TaskflowType\\": \\"x6\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDistinctReleases', + ], + 'DescribeEnumItems' => [ + 'summary' => 'Queries enumeration items that are required by a cloud service.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EnumType', + 'in' => 'query', + 'schema' => [ + 'title' => '枚举类型', + 'description' => 'The type of the enumeration item. Valid values:'."\n" + ."\n" + .'* **process**: scenarios'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'process', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh_cn**: Simplified Chinese (default)'."\n" + .'* **en_us**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<EnumDTO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The information about the enumeration item.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the enumeration item.'."\n", + 'type' => 'string', + 'example' => 'system_xxxxx_process_book', + ], + 'Value' => [ + 'description' => 'The value of the enumeration item.'."\n", + 'type' => 'string', + 'example' => 'system_xxxxx_process_book', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"system_xxxxx_process_book\\",\\n \\"Value\\": \\"system_xxxxx_process_book\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeEnumItems', + ], + 'DescribeExecutePlaybooks' => [ + 'summary' => 'Queries the playbooks that are available for an automatic response plan.', + 'methods' => [ + 'get', + ], + '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 script input parameter. When you want to query multiple entity types, separate them with commas.'."\n" + .'- **ip**: IP entity.'."\n" + .'- **file**: file entity.'."\n" + .'- **process**: process entity.'."\n" + .'- **incident**: incident entity.', + 'type' => 'string', + 'required' => false, + 'example' => 'ip,file,process,host', + ], + ], + [ + 'name' => 'PlaybookName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的名字', + 'description' => 'The playbook name. Fuzzy search is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demo_test', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的UUID', + 'description' => 'The playbook UUID.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f916b93e-e814-459f-9662-xxxxxx', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ParamType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The input parameter type of the playbook.'."\n" + ."\n" + .'* **template-ip**'."\n" + .'* **template-file**'."\n" + .'* **template-process**'."\n" + .'* **custom**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<PlaybookExecuteMetrics>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '88A39217-2802-5B1E-BA2B-CF1BBC43C1F5', + ], + 'PlaybookMetrics' => [ + 'title' => '传输的数据', + 'description' => 'The playbook.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => 'The playbook description.'."\n", + 'type' => 'string', + 'example' => 'a demo playbook', + ], + 'DisplayName' => [ + 'description' => 'The playbook name.'."\n", + 'type' => 'string', + 'example' => 'demo_playbook', + ], + 'Uuid' => [ + 'description' => 'The playbook UUID.'."\n", + 'type' => 'string', + 'example' => 'c5c88b5e-97ca-435d-8c20-2xxxxx', + ], + 'ParamConfig' => [ + 'description' => 'The configuration of the input parameter. The value is a JSON array.'."\n" + ."\n" + .'> For more information, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']', + ], + 'ParamType' => [ + 'description' => 'The input parameter type of the playbook.'."\n" + ."\n" + .'* **template-ip**'."\n" + .'* **template-file**'."\n" + .'* **template-process**'."\n" + .'* **custom**'."\n", + 'type' => 'string', + 'example' => 'custom', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'DescribeField' => [ + 'summary' => 'Queries the global configuration information about a cloud service.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'QueryKey', + 'in' => 'query', + 'schema' => [ + 'title' => '全局配置的KEY值', + 'description' => 'The key of the global configuration. Valid values:'."\n" + ."\n" + .'* **soar_filed_tags**: queries the input template of the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'soar_filed_tags', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<SystemConfigView>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BCDE6498-83CC-50A1-8307-3D5A539C42F8', + ], + 'Name' => [ + 'description' => 'The name of the global configuration.'."\n", + 'type' => 'string', + 'example' => 'soar_filed_tags', + ], + 'Fields' => [ + 'description' => 'The configuration content.'."\n", + 'type' => 'string', + 'example' => '["ip","name","hostinfo","md5"]', + ], + ], + ], + ], + ], + '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', + ], + 'DescribeLatestRecordSchema' => [ + 'summary' => 'Queries the output structure information of each node in a playbook based on the most recent running record of the playbook.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + '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" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookNodeSchema>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9', + ], + 'PlaybookNodeSchema' => [ + 'title' => '传输的数据', + 'description' => 'The output structure information of the playbook.'."\n", + 'type' => 'object', + 'properties' => [ + 'NodeSchema' => [ + 'description' => 'The structure information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NodeName' => [ + 'description' => 'The name of the node.'."\n", + 'type' => 'string', + 'example' => 'DataFormat_1', + ], + 'ComponentName' => [ + 'description' => 'The name of the component.'."\n", + 'type' => 'string', + 'example' => 'DataFormat', + ], + 'ActionName' => [ + 'description' => 'The action name of the component.'."\n", + 'type' => 'string', + 'example' => 'formatedata', + ], + 'OutputFields' => [ + 'description' => 'The output fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The reference path of the output field.'."\n", + 'type' => 'string', + 'example' => 'play_group.datalist.*.ids', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\",\\n \\"PlaybookNodeSchema\\": {\\n \\"NodeSchema\\": [\\n {\\n \\"NodeName\\": \\"DataFormat_1\\",\\n \\"ComponentName\\": \\"DataFormat\\",\\n \\"ActionName\\": \\"formatedata\\",\\n \\"OutputFields\\": [\\n \\"play_group.datalist.*.ids\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeLatestRecordSchema', + ], + 'DescribeNodeParamTags' => [ + 'summary' => 'Queries recommended dynamic input parameters of a component for playbook orchestration.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The playbook UUID.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '组件节点名', + 'description' => 'The name of the node.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'python3_2', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<ParamReferredPathsInfo>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6BE94351-712A-505D-A40A-BC77CC8254A9', + ], + 'ParamReferredPaths' => [ + 'title' => '传输的数据', + 'description' => 'The configuration of the recommended path.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ParamName' => [ + 'description' => 'The name of the upstream node.'."\n", + 'type' => 'string', + 'example' => 'DataFormat_1', + ], + 'ReferredPath' => [ + 'description' => 'The paths.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of the referenced path.'."\n", + 'type' => 'string', + 'example' => 'filter_1.datalist.*.score', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'DescribePlaybook' => [ + 'summary' => 'Queries 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' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '9030076b-6733-4842-b05a-xxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskflowMd5', + 'in' => 'query', + 'schema' => [ + 'description' => 'The MD5 hash value of the playbook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7a8f608dc64c242632aa578xxxxx', + ], + ], + [ + 'name' => 'DebugFlag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The flag that indicates whether the playbook is of the debugging or published version. Valid values:'."\n" + ."\n" + .'* **1**: playbook of the debugging version'."\n" + .'* **0**: playbook of the published version'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookDetailDTO>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2989BC59-E9F0-5C83-B453-B368857649C8', + ], + 'Playbook' => [ + 'title' => '传输的数据', + 'description' => 'The configuration of the playbook.'."\n", + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => 'The creation time of the playbook. The value is a 13-digit timestamp.'."\n", + 'type' => 'string', + 'example' => '1665288858000', + ], + 'GmtModified' => [ + 'description' => 'The modification time of the playbook. The value is a 13-digit timestamp.'."\n", + 'type' => 'string', + 'example' => '1677482519000', + ], + 'PlaybookUuid' => [ + 'description' => 'The UUID of the playbook.'."\n", + 'type' => 'string', + 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx', + ], + 'Taskflow' => [ + 'description' => 'The XML configuration of the playbook.'."\n", + 'type' => 'string', + 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>', + ], + 'TaskflowType' => [ + 'type' => 'string', + 'description' => 'The playbook configuration type.'."\n" + .'* **xml**: XML format.'."\n" + .'* **x6**: JSON format.', + 'example' => 'xml', + ], + 'OwnType' => [ + 'description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'* **preset**: predefined playbook'."\n" + .'* **user**: custom playbook'."\n", + 'type' => 'string', + 'example' => 'preset', + ], + 'SuccessExeNum' => [ + 'description' => 'The number of times that the playbook was successfully run.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'FailExeNum' => [ + 'description' => 'The number of times that the playbook failed to be run.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastExeTime' => [ + 'description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1665288858000', + ], + 'DisplayName' => [ + 'description' => 'The display name of the playbook.'."\n", + 'type' => 'string', + 'example' => 'demo_test', + ], + 'InputParams' => [ + 'description' => 'The input parameter configuration of the playbook. The value is a JSON array.'."\n" + ."\n" + .'> For more information, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']', + ], + 'Description' => [ + 'description' => 'The description of the playbook.'."\n", + 'type' => 'string', + 'example' => 'demo playbook', + ], + 'OnlineActive' => [ + 'description' => 'The status of the playbook. Valid values:'."\n" + ."\n" + .'* **0**: disabled'."\n" + .'* **1**: enabled'."\n", + 'type' => 'boolean', + 'example' => '0', + ], + 'OnlineReleaseTaskflowMd5' => [ + 'description' => 'The MD5 hash value in the latest published version of the playbook.'."\n", + 'type' => 'string', + 'example' => 'asdfsdfe232-e2b2-44fd-b2cc-xxxxx', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2989BC59-E9F0-5C83-B453-B368857649C8\\",\\n \\"Playbook\\": {\\n \\"GmtCreate\\": \\"1665288858000\\",\\n \\"GmtModified\\": \\"1677482519000\\",\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"Taskflow\\": \\"<?xml version=\\\\\\"1.0\\\\\\" encoding=\\\\\\"UTF-8\\\\\\"?><bpmn:definitions xmlns:xsi=\\\\\\"http://www.w3.org/2001/XMLSchema-instance\\\\\\" xmlns:bpmn=\\\\\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\\\\\" xmlns:bpmndi=\\\\\\"http://www.omg.org/spec/BPMN/20100524/DI\\\\\\" xmlns:dc=\\\\\\"http://www.omg.org/spec/DD/20100524/DC\\\\\\" targetNamespace=\\\\\\"http://bpmn.io/schema/bpmn\\\\\\" id=\\\\\\"Definitions_1\\\\\\"><bpmn:process id=\\\\\\"Process_1\\\\\\" isExecutable=\\\\\\"false\\\\\\"><bpmn:startEvent id=\\\\\\"StartEvent_1\\\\\\"/></bpmn:process><bpmndi:BPMNDiagram id=\\\\\\"BPMNDiagram_1\\\\\\"><bpmndi:BPMNPlane id=\\\\\\"BPMNPlane_1\\\\\\" bpmnElement=\\\\\\"Process_1\\\\\\"><bpmndi:BPMNShape id=\\\\\\"_BPMNShape_StartEvent_2\\\\\\" bpmnElement=\\\\\\"StartEvent_1\\\\\\"><dc:Bounds height=\\\\\\"36.0\\\\\\" width=\\\\\\"36.0\\\\\\" x=\\\\\\"173.0\\\\\\" y=\\\\\\"102.0\\\\\\"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>\\",\\n \\"TaskflowType\\": \\"xml\\",\\n \\"OwnType\\": \\"preset\\",\\n \\"SuccessExeNum\\": 100,\\n \\"FailExeNum\\": 1,\\n \\"LastExeTime\\": 1665288858000,\\n \\"DisplayName\\": \\"demo_test\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"Description\\": \\"demo playbook\\",\\n \\"OnlineActive\\": true,\\n \\"OnlineReleaseTaskflowMd5\\": \\"asdfsdfe232-e2b2-44fd-b2cc-xxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribePlaybook', + ], + 'DescribePlaybookInputOutput' => [ + 'summary' => 'Queries the input and output parameter configurations of a playbook.', + 'methods' => [ + 'get', + ], + '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' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookInputOutputDTO>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '688B4CCD-5272-5DCF-9D76-FE5EFEF545F8', + ], + 'Config' => [ + 'title' => '传输的数据', + 'description' => 'The configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'ParamType' => [ + 'title' => '输入类型', + 'description' => 'The input parameter type of the playbook. Valid values:'."\n" + ."\n" + .'* **template-ip**'."\n" + .'* **template-file**'."\n" + .'* **template-process**'."\n" + .'* **custom**'."\n", + 'type' => 'string', + 'example' => 'custom', + ], + 'ExeConfig' => [ + 'title' => '输入类型', + 'description' => 'The execution method of the playbook is in JSONObject format.', + 'type' => 'string', + 'example' => '{'."\n" + .' "executeMode":"mul",'."\n" + .' "cron":"0 0 1 */1 * ?"'."\n" + .'}', + ], + 'InputParams' => [ + 'title' => '入参配置', + 'description' => 'The input parameter configuration of the playbook. The value is a JSON array.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']', + ], + 'OutputParams' => [ + 'title' => '出参配置', + 'description' => 'The output parameter configuration. This parameter is unavailable and is always left empty.'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'PlaybookUuid' => [ + 'description' => 'The UUID of the playbook.'."\n", + 'type' => 'string', + 'example' => '9030076b-6733-4842-b05a-xxxxxx', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"688B4CCD-5272-5DCF-9D76-FE5EFEF545F8\\",\\n \\"Config\\": {\\n \\"ParamType\\": \\"custom\\",\\n \\"ExeConfig\\": \\"{\\\\n \\\\\\"executeMode\\\\\\":\\\\\\"mul\\\\\\",\\\\n \\\\\\"cron\\\\\\":\\\\\\"0 0 1 */1 * ?\\\\\\"\\\\n}\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"OutputParams\\": \\"[]\\",\\n \\"PlaybookUuid\\": \\"9030076b-6733-4842-b05a-xxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribePlaybookInputOutput', + 'responseParamsDescription' => 'The value of **InputParams** is a JSON array, which contains the following fields:'."\n" + ."\n" + .'* typeName: the data type name of the parameter.'."\n" + .'* dataClass: the level of the parameter type. Valid values are **normal** and **custom**. The value normal indicates a common parameter, and the value custom indicates a complex parameter.'."\n" + .'* dataType: the type of the parameter. Valid values are **string, long, int, ip, file, and account**.'."\n" + .'* description: the description of the parameter.'."\n" + .'* example: the example value of the parameter.'."\n" + .'* name: the name of the parameter.'."\n" + .'* required: specifies whether the parameter is required. Valid values are **true** and **false**.'."\n", + ], + 'DescribePlaybookMetrics' => [ + 'summary' => 'Queries the metrics of a playbook. The metrics include the playbook name, playbook description, the number of times that the playbook is run, and the failure rate of the playbook.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2a687089-d4dd-47d4-9709-xxxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookCloudDTO>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73', + ], + 'Metrics' => [ + 'title' => '传输的数据', + 'description' => 'The details of the playbook.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'title' => '剧本的名称', + 'description' => 'The name of the playbook.'."\n", + 'type' => 'string', + 'example' => 'demo name', + ], + 'PlaybookUuid' => [ + 'title' => '剧本的UUID', + 'description' => 'The UUID of the playbook.'."\n", + 'type' => 'string', + 'example' => '0fbc9bdb-9ae3-4ef4-a709-xxxxx', + ], + 'OwnType' => [ + 'title' => '剧本的权限类型', + 'description' => 'The type of the playbook. Valid values:'."\n" + ."\n" + .'* **preset**: predefined playbook'."\n" + .'* **user**: custom playbook'."\n", + 'type' => 'string', + 'example' => 'user', + ], + 'Active' => [ + 'title' => '剧本的启用状态', + 'description' => 'The status of the playbook. Valid values:'."\n" + ."\n" + .'* **1**: enabled'."\n" + .'* **0**: disabled'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastRuntime' => [ + 'title' => '剧本的最后执行时间', + 'description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1683526277415', + ], + 'GmtCreate' => [ + 'title' => '剧本创建时间', + 'description' => 'The time when the playbook was created. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655277397000', + ], + 'HistoryMd5' => [ + 'title' => '剧本历史版本数', + 'description' => 'The number of historical versions of the playbook.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SuccNum' => [ + 'title' => '剧本执行成功数', + 'description' => 'The number of the tasks that are created for the playbook and were successfully run.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'FailNum' => [ + 'title' => '剧本执行失败数', + 'description' => 'The number of the tasks that are created for the playbook and failed to run.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Description' => [ + 'description' => 'The description of the playbook.'."\n", + 'type' => 'string', + 'example' => 'This is a playbook for waf processing', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Metrics\\": {\\n \\"DisplayName\\": \\"demo name\\",\\n \\"PlaybookUuid\\": \\"0fbc9bdb-9ae3-4ef4-a709-xxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1683526277415,\\n \\"GmtCreate\\": 1655277397000,\\n \\"HistoryMd5\\": 10,\\n \\"SuccNum\\": 100,\\n \\"FailNum\\": 10,\\n \\"Description\\": \\"This is a playbook for waf processing\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribePlaybookMetrics', + ], + 'DescribePlaybookNodesOutput' => [ + 'summary' => 'Queries the historical output data of a component node.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ac343acc-1a61-4084-9a1c-xxxxx', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '组件节点名', + 'description' => 'The name of the component node.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DataFormat_1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookNodeOutput>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A491170C-FE1F-520E-83D4-72ED205B72ED', + ], + 'PlaybookNodesOutput' => [ + 'title' => '传输的数据', + 'description' => 'The output data of the component node.'."\n", + 'type' => 'object', + 'properties' => [ + 'NodeName' => [ + 'description' => 'The name of the component node.'."\n", + 'type' => 'string', + 'example' => 'DataFormat_1', + ], + 'NodeOutput' => [ + 'description' => 'The historical output data of the component node. The value is in the JSON string format. If no data is found, the parameter is left empty.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "datalist": ['."\n" + .' {'."\n" + .' "score": "10",'."\n" + .' "ip": "1.1.1.1"'."\n" + .' }'."\n" + .' ],'."\n" + .' "total_data_successful": 1,'."\n" + .' "filter_total_data": 1,'."\n" + .' "total_data": 1,'."\n" + .' "total_exe_successful": 1,'."\n" + .' "total_exe": 1,'."\n" + .' "total_data_with_dup": 1,'."\n" + .' "filter_total_data_successful": 1,'."\n" + .' "status": true'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A491170C-FE1F-520E-83D4-72ED205B72ED\\",\\n \\"PlaybookNodesOutput\\": {\\n \\"NodeName\\": \\"DataFormat_1\\",\\n \\"NodeOutput\\": \\"{\\\\n \\\\\\"datalist\\\\\\": [\\\\n {\\\\n \\\\\\"score\\\\\\": \\\\\\"10\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"1.1.1.1\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"total_data_successful\\\\\\": 1,\\\\n \\\\\\"filter_total_data\\\\\\": 1,\\\\n \\\\\\"total_data\\\\\\": 1,\\\\n \\\\\\"total_exe_successful\\\\\\": 1,\\\\n \\\\\\"total_exe\\\\\\": 1,\\\\n \\\\\\"total_data_with_dup\\\\\\": 1,\\\\n \\\\\\"filter_total_data_successful\\\\\\": 1,\\\\n \\\\\\"status\\\\\\": true\\\\n}\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribePlaybookNodesOutput', + 'responseParamsDescription' => 'The value of **NodeOutput** is a JSON object, which contains the following fields:'."\n" + ."\n" + .'* **datalist**: the details of output data.'."\n" + .'* **total_data_successful**: the number of components that are successfully run.'."\n" + .'* **total_data**: the total number of components that are run.'."\n" + .'* **total_exe_successful**: the number of times that the running is successful.'."\n" + .'* **total_exe**: the total number of times for running.'."\n" + .'* **total_data_with_dup**: the number of times that the data is repeated.'."\n" + .'* **status**: indicates whether the component is successfully run. Valid values: **true** and **false**.'."\n", + ], + 'DescribePlaybookNumberMetrics' => [ + 'summary' => 'Queries the statistics of Security Orchestration Automation Response (SOAR), such as the numbers of created and enabled playbooks.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookMetrics>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Metrics' => [ + 'title' => '传输的数据', + 'description' => 'The statistics.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalNum' => [ + 'description' => 'The total number of playbooks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'StartUpNum' => [ + 'description' => 'The number of enabled playbooks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metrics\\": {\\n \\"TotalNum\\": 100,\\n \\"StartUpNum\\": 50\\n },\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\"\\n}","type":"json"}]', + 'title' => 'DescribePlaybookNumberMetrics', + ], + 'DescribePlaybookReleases' => [ + 'summary' => 'Queries the information about the published versions of a playbook.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The playbook UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ac343acc-1a61-4084-9a1c-xxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. If you do not specify the PageSize parameter, 10 entries are returned by default.'."\n" + ."\n" + .'> We recommend that you do not leave this parameter empty.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<SaoReleaseInfo>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '3DFBE11C-6EB6-5166-92D6-3397796AFE1E', + ], + 'Records' => [ + 'title' => '传输的数据', + 'description' => 'The information about the playbook version.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The record ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80xxx', + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => 'The time when the version was created. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655277397000', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => 'The time when the version was modified. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1691460804000', + ], + 'Creator' => [ + 'title' => '创建人', + 'description' => 'The ID of the Alibaba Cloud account that is used to publish the version.'."\n", + 'type' => 'string', + 'example' => '145xxxx985', + ], + 'Description' => [ + 'title' => '描述信息', + 'description' => 'The description of the layer version.'."\n", + 'type' => 'string', + 'example' => 'This is a new version', + ], + 'TaskflowMd5' => [ + 'title' => 'taskflow的MD5信息，用于比较是否 有变化', + 'description' => 'The MD5 value configured for the published version of the playbook.'."\n", + 'type' => 'string', + 'example' => 'be0a4ef084dd174abe47xxxxx', + ], + ], + ], + ], + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3DFBE11C-6EB6-5166-92D6-3397796AFE1E\\",\\n \\"Records\\": [\\n {\\n \\"Id\\": 0,\\n \\"GmtCreate\\": 1655277397000,\\n \\"GmtModified\\": 1691460804000,\\n \\"Creator\\": \\"145xxxx985\\",\\n \\"Description\\": \\"This is a new version\\",\\n \\"TaskflowMd5\\": \\"be0a4ef084dd174abe47xxxxx\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'DescribePlaybookReleases', + ], + 'DescribePlaybooks' => [ + 'summary' => 'Retrieve the list of playbooks.', + 'methods' => [ + 'get', + ], + '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' => 'Activation status of the playbook. Values:'."\n" + ."\n" + .'- **1**: Indicates the playbook is activated.'."\n" + .'- **0**: Indicates the playbook is not activated.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OwnType', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的类型', + 'description' => 'Type of the playbook. Values:'."\n" + ."\n" + .'- **preset**: Predefined playbook.'."\n" + .'- **user**: Custom playbook.', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'StartMillis', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => 'Start time for the query, in 13-digit timestamp format.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683526277415', + ], + ], + [ + 'name' => 'EndMillis', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => 'End time for the query, in 13-digit timestamp format.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683858064361', + ], + ], + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + .'> You can use the UUID to query specific playbook information.'."\n" + .'> - Call the [CreatePlaybook](~~CreatePlaybook~~) API to obtain this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx', + ], + ], + [ + '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' => 'Specifies the language type for the request and response, default is **zh**. Values:'."\n" + .'- **zh**: Chinese.'."\n" + .'- **en**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the maximum number of items to display per page in a paginated query. The default number of items per page is 20. If the PageSize parameter is empty, it will return 10 items by default.'."\n" + .'> It is recommended that the PageSize value is not empty.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sets the page number from which to start displaying the query results. The default value is 1, indicating the first page.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Sort', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting basis, with a default value of **1**. Values:'."\n" + .'- **1**: Last modified time.'."\n" + .'- **2**: Most recent execution time.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '排序依据 1-上次修改时间 2-最近执行时间', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序逻辑：desc asc,默认desc', + 'description' => 'The sorting logic, with a default value of **desc**. Values:'."\n" + .'- **desc**: Descending order.'."\n" + .'- **asc**: Ascending order.', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'ParamTypes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The trigger method for the playbook, with a default value of **query all**. Values:'."\n" + .'- **template-incident**: Security incident.'."\n" + .'- **template-ip**: IP entity.'."\n" + .'- **template-file**: File entity.'."\n" + .'- **template-process**: Process entity.'."\n" + .'- **template-alert**: Security alert.'."\n" + .'- **template-domain**: Domain entity.'."\n" + .'- **template-container**: Container entity.'."\n" + .'- **template-host**: Host entity.'."\n" + .'- **template-custom**: Custom.', + 'type' => 'string', + 'required' => false, + 'example' => 'template-alert', + ], + ], + [ + 'name' => 'PlaybookUuids', + 'in' => 'query', + 'schema' => [ + 'description' => 'UUID List of the playbook.'."\n" + ."\n" + .'Note You can use the UUID list to query specific playbook information.'."\n" + .'Call the DescribePlaybooks API to obtain this parameter.', + 'type' => 'string', + 'required' => false, + 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,7745e6cff-319e-4ede-97bc-1xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<PlaybookCloudDTO>>', + 'description' => 'Response information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The ID of the current request, generated by Alibaba Cloud as a unique identifier for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => '138B5AB7-****-5814-87A3-E3E****F207E', + ], + 'Playbooks' => [ + 'title' => '传输的数据', + 'description' => 'List of playbooks.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the playbook.', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'title' => '剧本的名称', + 'description' => 'The display name of the playbook.', + 'type' => 'string', + 'example' => 'demo_playbook', + ], + 'PlaybookUuid' => [ + 'title' => '剧本的UUID', + 'description' => 'The UUID of the playbook.', + 'type' => 'string', + 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx', + ], + 'OwnType' => [ + 'title' => '剧本的权限类型', + 'description' => 'The type of the playbook. Values:'."\n" + ."\n" + .'- **preset**: Predefined playbook.'."\n" + .'- **user**: Custom playbook.', + 'type' => 'string', + 'example' => 'user', + ], + 'Active' => [ + 'title' => '剧本的启用状态', + 'description' => 'The status indicator of the playbook. Values:'."\n" + ."\n" + .'- **1**: Indicates the playbook is activated.'."\n" + .'- **0**: Indicates the playbook is deactivated.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastRuntime' => [ + 'title' => '剧本的最后执行时间', + 'description' => 'The last execution time of the playbook, in 13-digit timestamp format.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1683526277415', + ], + 'GmtCreate' => [ + 'title' => '剧本创建时间', + 'description' => 'The creation time of the playbook, in 13-digit timestamp format.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1683526277415', + ], + 'GmtModified' => [ + 'title' => '剧本修改时间', + 'description' => 'The modification time of the playbook.', + 'type' => 'string', + 'example' => '1681396398000', + ], + 'ParamType' => [ + 'description' => 'The trigger method for the playbook, with a default value of **query all**. Possible values are:'."\n" + .'- **template-incident**: Security incident.'."\n" + .'- **template-ip**: IP entity.'."\n" + .'- **template-file**: File entity.'."\n" + .'- **template-process**: Process entity.'."\n" + .'- **template-alert**: Security alert.'."\n" + .'- **template-domain**: Domain entity.'."\n" + .'- **template-container**: Container entity.'."\n" + .'- **template-host**: Host entity.', + 'type' => 'string', + 'example' => 'template-alert', + ], + 'Description' => [ + 'type' => 'string', + 'description' => 'The description of the playbook.', + 'example' => 'aegis_kill_process', + ], + 'TenantId' => [ + 'type' => 'string', + 'description' => 'The ID of the tenant. ', + 'example' => '296004', + ], + ], + ], + ], + 'Page' => [ + 'description' => 'Pagination query information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of items found.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => 'The page number in pagination queries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of items per page in pagination queries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"138B5AB7-****-5814-87A3-E3E****F207E\\",\\n \\"Playbooks\\": [\\n {\\n \\"DisplayName\\": \\"demo_playbook\\",\\n \\"PlaybookUuid\\": \\"bb5a8640-a14f-44ef-8376-cxxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1683526277415,\\n \\"GmtCreate\\": 1683526277415,\\n \\"GmtModified\\": \\"1681396398000\\",\\n \\"ParamType\\": \\"template-alert\\",\\n \\"Description\\": \\"aegis_kill_process\\",\\n \\"TenantId\\": \\"123456\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'Get Playbook List', + 'translator' => 'machine', + ], + 'DescribePopApi' => [ + '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', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PopCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The POP code of the Alibaba Cloud service.'."\n" + ."\n" + .'> You can call the [DescribeApiList](~~DescribeApiList~~) operation to query the POP code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Sas', + ], + ], + [ + 'name' => 'ApiVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version number of the API.'."\n" + ."\n" + .'> You can call the [DescribePopApiVersionList](~~DescribePopApiVersionList~~) operation to query the version number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2021-10-01', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation name of the Alibaba Cloud service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DescribeInstanceInfo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<ListApiMetaResponse>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1A01B0BA-CFC4-5813-9EB0-A5DA15FA95AE', + ], + 'PopCode' => [ + 'description' => 'The POP code of the Alibaba Cloud service.'."\n", + 'type' => 'string', + 'example' => 'Sas', + ], + 'Version' => [ + 'description' => 'The version of the API.'."\n", + 'type' => 'string', + 'example' => '2019-09-10', + ], + 'ApiName' => [ + 'description' => 'The name of the API.'."\n", + 'type' => 'string', + 'example' => 'AddAssetCleanConfig', + ], + 'OpenApiMetaList' => [ + 'description' => 'The information about the API.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The parameter name.'."\n", + 'type' => 'string', + 'example' => 'DescribePopApi', + ], + 'Required' => [ + 'description' => 'Indicates whether the parameter is required.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExampleValue' => [ + 'description' => 'The example value.'."\n", + 'type' => 'string', + 'example' => '12.xx.xx.xx', + ], + 'Description' => [ + 'description' => 'The parameter description.'."\n", + 'type' => 'string', + 'example' => 'demo parameter', + ], + 'Type' => [ + 'description' => 'The data type of the parameter field. Valid values:'."\n" + ."\n" + .'* **string**'."\n" + .'* **boolean**'."\n" + .'* **integer**'."\n" + .'* **long**'."\n", + 'type' => 'string', + 'example' => 'string', + ], + 'Style' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PopCode\\": \\"Sas\\",\\n \\"Version\\": \\"2019-09-10\\",\\n \\"ApiName\\": \\"AddAssetCleanConfig\\",\\n \\"OpenApiMetaList\\": [\\n {\\n \\"Name\\": \\"DescribePopApi\\",\\n \\"Required\\": false,\\n \\"ExampleValue\\": \\"12.xx.xx.xx\\",\\n \\"Description\\": \\"demo parameter\\",\\n \\"Type\\": \\"string\\",\\n \\"Style\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribePopApi', + ], + 'DescribeSoarRecordActionOutputList' => [ + 'summary' => 'Queries the data that is returned when a component initiates 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' => [ + 'title' => '动作的UUID', + 'description' => 'The UUID of the component action.'."\n" + ."\n" + .'> You can call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) operation to query the UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2202c90d-fa93-4726-bc32-xxxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. If you leave this parameter empty, 10 entries are returned on each page.'."\n" + ."\n" + .'> We recommend that you do not leave this parameter empty.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90', + ], + 'ActionOutputs' => [ + 'title' => '传输的数据', + 'description' => 'The data that is returned when the component action is performed. The value is a JSON array.'."\n" + ."\n" + .'> The format of the output data is determined by the component that is configured when the playbook is written.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "a": "a",'."\n" + .' "taskname": "92af3c79-1754-4646-9366-9ddbd1e45536_xxxx",'."\n" + .' "log_time": 1699868849000'."\n" + .' }'."\n" + .']', + ], + 'PageNumber' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of pages returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + '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', + ], + 'DescribeSoarRecordInOutput' => [ + 'summary' => 'Queries the input and output data of a component action. You can call this operation after a playbook is run.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ActionUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '动作的UUID', + 'description' => 'The UUID of the component action.'."\n" + ."\n" + .'> You can call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) operation to query the UUIDs of component actions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0531ff66-dd05-4f24-84bf-xxxxxxxx', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '372D8B41-AF8D-573A-9B3F-0924950F241F', + ], + 'InOutputInfo' => [ + 'title' => '传输的数据', + 'description' => 'The execution result of the component action.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "actionUuid": "3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx",'."\n" + .' "outputSummary": {'."\n" + .' "datalist": ['."\n" + .' {'."\n" + .' "a": "a"'."\n" + .' }'."\n" + .' ],'."\n" + .' "total_data_successful": 1,'."\n" + .' "total_data": 1,'."\n" + .' "total_exe_successful": 1,'."\n" + .' "total_exe": 1,'."\n" + .' "total_data_with_dup": 1,'."\n" + .' "status": true'."\n" + .' },'."\n" + .' "outputSchema": {'."\n" + .' "a": "String",'."\n" + .' "startTime": "DateTime"'."\n" + .' },'."\n" + .' "inputParams": {'."\n" + .' "inputData": ['."\n" + .' {'."\n" + .' "outputFields": {'."\n" + .' "a": "a"'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "totalSize": 1'."\n" + .' },'."\n" + .' "startTime": "2023-11-13 17:47:28.645",'."\n" + .' "taskName": "92af3c79-1754-4646-9366-9ddbxxxxx"'."\n" + .'}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"372D8B41-AF8D-573A-9B3F-0924950F241F\\",\\n \\"InOutputInfo\\": \\"{\\\\n \\\\\\"actionUuid\\\\\\": \\\\\\"3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx\\\\\\",\\\\n \\\\\\"outputSummary\\\\\\": {\\\\n \\\\\\"datalist\\\\\\": [\\\\n {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"total_data_successful\\\\\\": 1,\\\\n \\\\\\"total_data\\\\\\": 1,\\\\n \\\\\\"total_exe_successful\\\\\\": 1,\\\\n \\\\\\"total_exe\\\\\\": 1,\\\\n \\\\\\"total_data_with_dup\\\\\\": 1,\\\\n \\\\\\"status\\\\\\": true\\\\n },\\\\n \\\\\\"outputSchema\\\\\\": {\\\\n \\\\\\"a\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"DateTime\\\\\\"\\\\n },\\\\n \\\\\\"inputParams\\\\\\": {\\\\n \\\\\\"inputData\\\\\\": [\\\\n {\\\\n \\\\\\"outputFields\\\\\\": {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"totalSize\\\\\\": 1\\\\n },\\\\n \\\\\\"startTime\\\\\\": \\\\\\"2023-11-13 17:47:28.645\\\\\\",\\\\n \\\\\\"taskName\\\\\\": \\\\\\"92af3c79-1754-4646-9366-9ddbxxxxx\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescribeSoarRecordInOutput', + 'responseParamsDescription' => 'The value of **InOutputInfo** is a JSON string, which contains the following fields:'."\n" + ."\n" + .'* **actionUuid**: the UUID that is generated when the component action is performed.'."\n" + ."\n" + .'* **startTime**: the start time when the action of the component is performed.'."\n" + ."\n" + .'* **taskName**: the task name of the playbook in which the component action is specified.'."\n" + ."\n" + .'* **outputSchema**: the metadata of the output data for the component action. The metadata is in the JSON format and is defined when the playbook is orchestrated.'."\n" + ."\n" + .'* **outputSummary**: the output data of the component action. The data is in the JSON format and contains the following fields:'."\n" + ."\n" + .' * **datalist**: the details of the output data.'."\n" + .' * **total_data_successful**: the number of components that are successfully run.'."\n" + .' * **total_data**: the total number of components that are run.'."\n" + .' * **total_exe_successful**: the number of times that the running is successful.'."\n" + .' * **total_exe**: the total number of times for running.'."\n" + .' * **total_data_with_dup**: the number of times that the data is repeated.'."\n" + .' * **status**: indicates whether the component is successfully run. Valid values are **true** and **false**.'."\n" + ."\n" + .'* **inputParams**: the input data of the component action. The data is in the JSON format and contains the following fields:'."\n" + ."\n" + .' * **inputData**: the details of the input data.'."\n" + .' * **totalSize**: the number of input data entries.'."\n", + ], + 'DescribeSoarRecords' => [ + 'summary' => 'Get the execution records of a playbook.', + 'methods' => [ + 'get', + ], + '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" + .'> You can obtain this parameter by calling the [DescribePlaybooks](~~DescribePlaybooks~~) interface.', + '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 execution, in 13-digit timestamp format.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683526284584', + ], + ], + [ + 'name' => 'EndMillis', + 'in' => 'query', + 'schema' => [ + 'title' => '任务结束时间', + 'description' => 'The end time of the task execution, in 13-digit timestamp format.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683772744953', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set the language type for requests and received messages. The default is **zh**. Values:'."\n" + .'- **zh**: Chinese'."\n" + .'- **en**: English', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TriggerUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID that executed the playbook task.', + 'type' => 'string', + 'required' => false, + 'example' => '127xxxx4392', + ], + ], + [ + 'name' => 'TaskStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the task execution. Values:'."\n" + ."\n" + .'- **success**: Successful task.'."\n" + .'- **failed**: Failed task.'."\n" + .'- **inprogress**: Task in progress', + 'type' => 'string', + 'required' => false, + 'example' => 'inprogress', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Set which page to start displaying the query results from. The default value is 1, indicating the first page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specify the maximum number of data entries per page when performing a paginated query. The default number of entries per page is 20. If the PageSize parameter is empty, it will return 10 entries by default.'."\n" + .'> It is recommended not to leave the PageSize value empty.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RequestUuid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'UUID of the playbook task execution.'."\n" + .'> You can obtain this parameter by calling the [DescribeSoarRecords](~~2627455~~) interface.', + 'example' => '6d412cfa-0905-4567-8a83-xxxxxx', + ], + ], + [ + 'name' => 'TriggerType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'QueryValue', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'CompletedBeginTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'CompletedEndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<SaoExecuteInfo>>', + 'description' => 'Return information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The ID of the current request, generated by Alibaba Cloud as a unique identifier for the request, which can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => '601C2DAC-6A67-5237-BEE8-5BF1CEE96296', + ], + 'SoarExecuteRecords' => [ + 'title' => '传输的数据', + 'description' => 'Execution record result set.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the execution records.', + 'type' => 'object', + 'properties' => [ + 'TriggerType' => [ + 'description' => 'The type of the playbook task. Values:'."\n" + ."\n" + .'- **debug**: Indicates a debugging task.'."\n" + .'- **manual**: Indicates a manual task.'."\n" + .'- **siem**: Indicates a task triggered by an event or alert.', + 'type' => 'string', + 'example' => 'debug', + ], + 'TaskName' => [ + 'description' => 'The name of the playbook task, which is the same as the playbook\'s UUID.', + 'type' => 'string', + 'example' => '82848ebc-eaff-4791-acd4-xxxxx', + ], + 'StartTime' => [ + 'description' => 'The start time of the task execution, in 13-digit timestamp format.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1675823338433', + ], + 'EndTime' => [ + 'description' => 'The end time of the component execution, in 13-digit timestamp format.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1686294686000', + ], + 'Status' => [ + 'description' => 'The status of the playbook task. Values:'."\n" + ."\n" + .'- **success**: Indicates successful execution.'."\n" + .'- **fail**: Indicates failed execution.'."\n" + .'- **running**: Indicates the task is running', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestUuid' => [ + 'description' => 'The request ID of the playbook task, a unique ID for each task run.', + 'type' => 'string', + 'example' => 'ba1ec480-aa90-4bb6-a1a7-9e311ae79321', + ], + 'TriggerUser' => [ + 'description' => 'The Alibaba Cloud account ID that executes the playbook task.', + 'type' => 'string', + 'example' => '127xxxx4392', + ], + 'ErrorMsg' => [ + 'description' => 'The error message of the playbook task. This field is empty when the task succeeds.', + 'type' => 'string', + 'example' => 'stime not match', + ], + 'RawEventReq' => [ + 'description' => 'The request parameters of the playbook task.', + 'type' => 'string', + 'example' => '{'."\n" + .' "input1": "xx.xx.xx.xx",'."\n" + .' "input2": "7d"'."\n" + .'}', + ], + 'TaskflowMd5' => [ + 'description' => 'The MD5 value of the playbook configuration.', + 'type' => 'string', + 'example' => 'dea65a3db87fb9bd84bbxxxxx', + ], + 'OutputList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'type' => 'string', + ], + 'NodeName' => [ + 'type' => 'string', + ], + 'ActionUuid' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'Page' => [ + 'description' => 'Information displayed on the page.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of queried items.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + 'default' => '0', + ], + 'PageNumber' => [ + 'description' => 'The current page number in paginated queries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of items per page in paginated queries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'default' => '10', + ], + ], + 'required' => true, + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"601C2DAC-6A67-5237-BEE8-5BF1CEE9*****\\",\\n \\"SoarExecuteRecords\\": [\\n {\\n \\"TriggerType\\": \\"debug\\",\\n \\"TaskName\\": \\"82848ebc-eaff-4791-acd4-xxxxx\\",\\n \\"StartTime\\": 1675823338433,\\n \\"EndTime\\": 1686294686000,\\n \\"Status\\": \\"success\\",\\n \\"RequestUuid\\": \\"ba1ec480-aa90-4bb6-a1a7-9e311ae*****\\",\\n \\"TriggerUser\\": \\"127xxxx4392\\",\\n \\"ErrorMsg\\": \\"stime not match\\",\\n \\"RawEventReq\\": \\"{\\\\n \\\\\\"input1\\\\\\": \\\\\\"xx.xx.xx.xx\\\\\\",\\\\n \\\\\\"input2\\\\\\": \\\\\\"7d\\\\\\"\\\\n}\\",\\n \\"TaskflowMd5\\": \\"dea65a3db87fb9bd84bbxxxxx\\",\\n \\"OutputList\\": [\\n {\\n \\"Content\\": \\" {\\\\\\"msg\\\\\\":\\\\\\"process has been killed\\\\\\",\\\\\\"code\\\\\\":\\\\\\"KillSuccess\\\\\\",\\\\\\"status\\\\\\":\\\\\\"success\\\\\\"}\\",\\n \\"NodeName\\": \\"TriggerPlaybook_4\\",\\n \\"ActionUuid\\": \\"4e78d665-2366-4485-8fbc-048a8d41a2c3-25****\\"\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 22,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSoarRecords', + 'translator' => 'machine', + ], + 'DescribeSoarTaskAndActions' => [ + 'summary' => 'Queries the execution records of a component during the running of a playbook.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RequestUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '任务请求的UUID', + 'description' => 'The playbook UUID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1077f2f9-25e8-42d9-bfdf-1528e1313f6d', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'QueryValue', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<SaoExecuteInfo>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '18017A93-3D5D-503A-8308-914543F1CBA3', + ], + 'Details' => [ + 'title' => '传输的数据', + 'description' => 'The execution details of each task.'."\n", + 'type' => 'object', + 'properties' => [ + 'TriggerType' => [ + 'description' => 'The task type. Valid values:'."\n" + ."\n" + .'* **debug**: a debugging task'."\n" + .'* **manual**: a manual task'."\n" + .'* **siem**: an event-triggered task'."\n", + 'type' => 'string', + 'example' => 'siem', + ], + 'TaskName' => [ + 'description' => 'The name of the task. The value is the same as the playbook UUID.'."\n", + 'type' => 'string', + 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536', + ], + 'StartTime' => [ + 'description' => 'The beginning of the time range during which the playbook is run. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1699868848645', + ], + 'EndTime' => [ + 'description' => 'The end of the time range during which the playbook is run. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1699868848767', + ], + 'Status' => [ + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n" + .'* **running**'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'RequestUuid' => [ + 'description' => 'The request ID of the task. The value is unique.'."\n", + 'type' => 'string', + 'example' => '17f75844-75cc-4174-86da-cec07a690142', + ], + 'TriggerUser' => [ + 'description' => 'The ID of the Alibaba Cloud account that triggers the task.'."\n", + 'type' => 'string', + 'example' => '127xxxx4392', + ], + 'ErrorMsg' => [ + 'description' => 'The error message of the task. If the task is successful, this field is empty.'."\n", + 'type' => 'string', + 'example' => 'stime not match', + ], + 'RawEventReq' => [ + 'description' => 'The request parameters of the task.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "input1": "xx.xx.xx.xx",'."\n" + .' "input2": "7d"'."\n" + .'}', + ], + 'Actions' => [ + 'description' => 'The list of component actions during the running of the playbook.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Component' => [ + 'description' => 'The component name.'."\n", + 'type' => 'string', + 'example' => 'DataFormat', + ], + 'Action' => [ + 'description' => 'The action name of the component.'."\n", + 'type' => 'string', + 'example' => 'formatdata', + ], + 'StartTime' => [ + 'description' => 'The beginning of the time range during which the component is run. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1699868848731', + ], + 'EndTime' => [ + 'description' => 'The end of the time range during which the component is run. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1699868848766', + ], + 'Status' => [ + 'description' => 'The running result of the component. Valid values:'."\n" + ."\n" + .'* **success**'."\n" + .'* **fail**'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'ActionUuid' => [ + 'description' => 'The UUID of the component execution record.'."\n", + 'type' => 'string', + 'example' => '091be399-a937-4276-af78-xxxxxxxx', + ], + 'AssetName' => [ + 'description' => 'The name of the asset that is used by the component.'."\n", + 'type' => 'string', + 'example' => 'SLS Asset', + ], + 'NodeName' => [ + 'description' => 'The custom name of the node in the component.'."\n", + 'type' => 'string', + 'example' => 'DataFormat_1', + ], + ], + ], + ], + 'TaskFlowMd5' => [ + 'description' => 'The MD5 value of the playbook.'."\n", + 'type' => 'string', + 'example' => 'ed127287-6699-4e4d-b986-9f770879xxx', + ], + 'ActionLogNum' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'Page' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'type' => 'string', + ], + 'PageNumber' => [ + 'type' => 'string', + ], + 'PageSize' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'DescriberPython3ScriptLogs' => [ + 'summary' => 'Queries the operational logs of a Python3 script by using the UUID that is returned when the script is run. The UUID is specified by requestUuid.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + '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 the Python3 script is run.'."\n" + ."\n" + .'> You can call the [RunPython3Script](~~RunPython3Script~~) operation to query the UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '69edc2b4-c95c-424f-9114-xxxxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D22D8A0C-6E86-57B2-A142-929184122AB1', + ], + 'RunResult' => [ + 'title' => '传输的数据', + 'description' => 'The operational logs of the Python3 script.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "logs": ['."\n" + .' {'."\n" + .' "message": "function input is {}"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D22D8A0C-6E86-57B2-A142-929184122AB1\\",\\n \\"RunResult\\": \\"{\\\\n \\\\\\"logs\\\\\\": [\\\\n {\\\\n \\\\\\"message\\\\\\": \\\\\\"function input is {}\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'DescriberPython3ScriptLogs', + ], + 'ModifyComponentAsset' => [ + 'summary' => 'Modifies the information about the asset that is configured for a component.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AssetConfig', + 'in' => 'query', + 'schema' => [ + 'title' => '资产的配置', + 'description' => 'The configuration of the asset. The value is a JSON object.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "name": "test asset",'."\n" + .' "componentName": "SLS",'."\n" + .' "params": ['."\n" + .' {'."\n" + .' "name": "end_point",'."\n" + .' "value": "xxx"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "sub_id",'."\n" + .' "value": "xxxx"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "access_key",'."\n" + .' "value": "xxxx"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1C5F11E9-464E-51F0-9296-43BB312A0557', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C5F11E9-464E-51F0-9296-43BB312A0557\\"\\n}","type":"json"}]', + 'title' => 'ModifyComponentAsset', + 'requestParamsDescription' => 'The following list describes the fields contained in the **AssetConfig** parameter:'."\n" + ."\n" + .'* **name**: the asset name.'."\n" + ."\n" + .'* **componentName**: the component name.'."\n" + ."\n" + .'* **params**: the configuration information. Valid values:'."\n" + ."\n" + .' * **end_point**: the connection information.'."\n" + .' * **sub_id**: the AccessKey ID of the account.'."\n" + .' * **access_key**: the AccessKey secret of the account.'."\n", + ], + 'ModifyPlaybook' => [ + 'summary' => 'Modifies the configuration of a playbook.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8baa6cff-319e-4ede-97bc-1586c35e61f8', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本的展示名称', + 'description' => 'The display name of the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun_waf_test_playbook', + ], + ], + [ + 'name' => 'Taskflow', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本编辑配置', + 'description' => 'The XML configuration of the playbook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本的描述', + 'description' => 'The description of the playbook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demo test task', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9B584F84-D66A-5525-8E7B-05612A903ABF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B584F84-D66A-5525-8E7B-05612A903ABF\\"\\n}","type":"json"}]', + 'title' => 'ModifyPlaybook', + ], + 'ModifyPlaybookInputOutput' => [ + 'summary' => 'Modifies the input and output parameters of a playbook.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx', + ], + ], + [ + 'name' => 'InputParams', + 'in' => 'formData', + 'schema' => [ + 'title' => '入参配置', + 'description' => 'The configuration of the input parameters. The value is a JSON array.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "typeName": "String",'."\n" + .' "dataClass": "normal",'."\n" + .' "dataType": "String",'."\n" + .' "description": "period",'."\n" + .' "example": "",'."\n" + .' "name": "period",'."\n" + .' "required": false'."\n" + .' }'."\n" + .']', + ], + ], + [ + 'name' => 'OutputParams', + 'in' => 'formData', + 'schema' => [ + 'title' => '出参配置', + 'description' => 'The configuration of the output parameters. This parameter is unavailable. Leave it empty.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[]', + ], + ], + [ + 'name' => 'ParamType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The input parameter type.'."\n" + ."\n" + .'* **template-ip**'."\n" + .'* **template-file**'."\n" + .'* **template-process**'."\n" + .'* **custom**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + [ + 'name' => 'ExeConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The executed mode of a playbook. The value is a JSON array.', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "executeMode":"mul",'."\n" + .' "cron":"0 0 1 */1 * ?"'."\n" + .'}', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The language of the content within the request and response.'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8DDC07CE-D41B-5142-8D91-469462719C77', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8DDC07CE-D41B-5142-8D91-469462719C77\\"\\n}","type":"json"}]', + 'title' => 'ModifyPlaybookInputOutput', + 'requestParamsDescription' => 'The value of the **InputParams** parameter is a JSON array, which contains the following fields:'."\n" + ."\n" + .'* typeName: the name of the parameter type.'."\n" + .'* dataClass: the level of the parameter type. This field is optional. **normal** specifies a common parameter and **custom** specifies a complex parameter.'."\n" + .'* dataType: the data type of the parameter. Valid values: **string, long, int, ip, file, and account**.'."\n" + .'* description: the parameter description.'."\n" + .'* example: the example parameter.'."\n" + .'* name: the parameter name.'."\n" + .'* required: specifies whether the parameter is required. Valid values: **true** and **false**.'."\n" + ."\n" + .'The value of the **ExeConfig** parameter is a JSON object, which contains the following fields:'."\n" + .'* executeMode: execution mode, fixed to **mul**.'."\n" + .'* cron: tCRON expression, following CRON standard.', + ], + 'PublishPlaybook' => [ + 'summary' => 'Publishes the playbook. After the playbook is published, the playbook runs based on the new logic.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The playbook UUID.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本的描述', + 'description' => 'The description of the released version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a waf processing playbook', + 'maxLength' => 128, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF\\"\\n}","type":"json"}]', + 'title' => 'PublishPlaybook', + ], + 'QueryTreeData' => [ + 'summary' => 'Queries all playbooks at a time.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese (default)'."\n" + .'* **en**: English'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2', + ], + 'Playbooks' => [ + 'title' => '传输的数据', + 'description' => 'The returned information about the playbook. The value is a JSON string.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "playbook": {'."\n" + .' "active": false,'."\n" + .' "displayName": "test_playbook",'."\n" + .' "playbookUuid": "09a20455-3d3a-424c-a1df-xxxxxx"'."\n" + .' }'."\n" + .' }'."\n" + .']', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2\\",\\n \\"Playbooks\\": \\"[\\\\n {\\\\n \\\\\\"playbook\\\\\\": {\\\\n \\\\\\"active\\\\\\": false,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"test_playbook\\\\\\",\\\\n \\\\\\"playbookUuid\\\\\\": \\\\\\"09a20455-3d3a-424c-a1df-xxxxxx\\\\\\"\\\\n }\\\\n }\\\\n]\\"\\n}","type":"json"}]', + 'title' => 'QueryTreeData', + 'responseParamsDescription' => 'The following list describes the fields that are contained in the value of the **Playbooks** parameter:'."\n" + ."\n" + .'* **active**: indicates whether the playbook is started. Valid values: **true** and **false**.'."\n" + .'* **displayName**: the playbook name.'."\n" + .'* **playbookUuid**: the playbook UUID.'."\n", + ], + 'RevertPlaybookRelease' => [ + 'summary' => 'Rolls back a playbook to a specific version. You can determine whether to publish the new playbook version during the rollback.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '185295a1-c987-4b64-8796-xxxxxxxx', + ], + ], + [ + 'name' => 'PlayReleaseId', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本的发布记录ID', + 'description' => 'The version of the playbook that you want to publish.'."\n" + ."\n" + .'> You can call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to query the playbook version.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3f97b56e-064e-47e7-a309-xxxxxxx', + ], + ], + [ + 'name' => 'IsPublish', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否回滚发布', + 'description' => 'Specifies whether to directly publish the new playbook after the rollback.'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3FED5B9-190A-5952-93A4-24FBF0F0C573\\"\\n}","type":"json"}]', + 'title' => 'RevertPlaybookRelease', + ], + 'TriggerPlaybook' => [ + 'summary' => 'Triggers an enabled custom playbook or a predefined playbook.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The playbook UUID.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the playbook UUID.', + 'type' => 'string', + 'required' => true, + 'example' => '2a687089-d4dd-47d4-9709-xxxxxxxx', + ], + ], + [ + 'name' => 'InputParam', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本的入参', + 'description' => 'The input parameters of the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "input1": "xx.xx.xx.xx",'."\n" + .' "input2": "7d"'."\n" + .'}'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PlaybookTriggerDTO>', + 'description' => 'The returned message.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BD5A8DB6-A42C-532B-BCE8-83E69550CD59', + ], + 'TriggerUuid' => [ + 'description' => 'The running UUID of the playbook. This parameter is used to query the running result of the playbook.'."\n", + 'type' => 'string', + 'example' => '55E63C57-D6C8-5036-A770-5CB10AC807AA', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD5A8DB6-A42C-532B-BCE8-83E69550CD59\\",\\n \\"TriggerUuid\\": \\"55E63C57-D6C8-5036-A770-5CB10AC807AA\\"\\n}","type":"json"}]', + 'title' => 'TriggerPlaybook', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.alibabacloud.com/en/pricing-calculator?_p_lc=1&spm=a2796.7960336.3034855210.1.7adab91arMeIx2#/commodity/vm_intl).', + ], + 'TriggerSophonPlaybook' => [ + 'summary' => 'Triggers a playbook or a command.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + '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 that you want to trigger.'."\n" + ."\n" + .'> You can call the [DescribeSophonCommands](~~DescribeSophonCommands~~) operation to query the command name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'waf_process_command', + ], + ], + [ + 'name' => 'InputParams', + 'in' => 'query', + 'schema' => [ + 'description' => 'The input parameters of the command or playbook that you want to trigger.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "param1": "xx.xx.xx.xx",'."\n" + .' "param2": "7d"'."\n" + .'}', + ], + ], + [ + 'name' => 'SophonTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom ID. If you do not specify this parameter when the playbook is triggered, a random ID is generated for fault locating and troubleshooting.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~)operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx', + ], + ], + [ + 'name' => 'TriggerType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task type. Valid values:'."\n" + ."\n" + .'* **command**'."\n" + .'* **playbook**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'playbook', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<SophonTaskResult>', + 'description' => 'The returned message.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The details that is returned after the command or playbook is triggered.'."\n", + 'type' => 'object', + 'properties' => [ + 'SophonTaskId' => [ + 'description' => 'The custom ID. If you do not specify this parameter when the playbook is triggered, a random ID is generated for fault locating and troubleshooting.'."\n", + 'type' => 'string', + 'example' => 'a7c6d055-a72f-4676-bc89-3cd9edc0284c', + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SophonTaskId\\": \\"a7c6d055-a72f-4676-bc89-3cd9edc0284c\\"\\n },\\n \\"RequestId\\": \\"0DFC9403-54EB-5672-B690-9AA93C9EBB54\\"\\n}","type":"json"}]', + 'title' => 'TriggerSophonPlaybook', + 'description' => 'Before you call this operation, make sure that you understand the billing methods and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.alibabacloud.com/en/pricing-calculator?_p_lc=1&spm=a2796.7960336.3034855210.1.7adab91arMeIx2#/commodity/vm_intl).', + ], + 'VerifyPlaybook' => [ + 'summary' => 'Checks whether the configuration of the playbook is correct and whether the logic of the orchestration is reasonable.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PlaybookUuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本UUID', + 'description' => 'The playbook UUID.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the playbook UUID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9fcd3829-80ff-4681-be1e-4d2662c35fed', + ], + ], + [ + 'name' => 'TaskFlow', + 'in' => 'formData', + 'schema' => [ + 'title' => '剧本编辑配置', + 'description' => 'The XML configuration of the playbook.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<CheckTaskInfo>>', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54', + ], + 'CheckTaskInfos' => [ + 'title' => '传输的数据', + 'description' => 'The result of the verification.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => 'The severity level of the verification information. Valid values:'."\n" + ."\n" + .'* warn: An issue may occur during playbook running.'."\n" + .'* error: The playbook cannot be compiled.'."\n" + .'* remind: The publishing and running of the playbook are not affected. We recommend that you optimize the playbook format.'."\n", + 'type' => 'string', + 'example' => 'error', + ], + 'NodeName' => [ + 'description' => 'The name of the node in the playbook.'."\n", + 'type' => 'string', + 'example' => 'python3_3', + ], + 'Detail' => [ + 'description' => 'The error message returned when the playbook does not pass the check.'."\n", + 'type' => 'string', + 'example' => 'Node [python3_3] doesn\'t have the asset information', + ], + ], + ], + ], + 'Prerequisites' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PrerequisiteType' => [ + 'type' => 'string', + ], + 'PrerequisiteValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DFC9403-54EB-5672-B690-9AA93C9EBB54\\",\\n \\"CheckTaskInfos\\": [\\n {\\n \\"RiskLevel\\": \\"error\\",\\n \\"NodeName\\": \\"python3_3\\",\\n \\"Detail\\": \\"Node [python3_3] doesn\'t have the asset information\\"\\n }\\n ],\\n \\"Prerequisites\\": [\\n {\\n \\"PrerequisiteType\\": \\"role\\",\\n \\"PrerequisiteValue\\": \\"AliyunSiemSoarExecutionDefaultRole\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'VerifyPlaybook', + ], + 'VerifyPythonFile' => [ + 'summary' => 'Checks whether the syntax of a Python code snippet is correct.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Python code snippet.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'import logging'."\n" + .'def execute (params):'."\n" + .' success=True'."\n" + .' message=\'OK\''."\n" + .' data=[]'."\n" + .' return (success,message,data)', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<PythonVerifyDTO>', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F72685FB-A6E6-5A9A-97F7-6DC1056E63CE', + ], + 'Syntax' => [ + 'description' => 'The verification result. If the parameter is left empty, the syntax of the code snippet is correct.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartLineNumber' => [ + 'description' => 'The number that indicates the start line of the error code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'StartColumn' => [ + 'description' => 'The number that indicates the start column of the error code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'EndLineNumber' => [ + 'description' => 'The number that indicates the end line of the error code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'EndColumn' => [ + 'description' => 'The number that indicates the end column of the error code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Message' => [ + 'description' => 'The error message for the error code.'."\n", + 'type' => 'string', + 'example' => 'undefined name \'ab\'', + ], + 'Severity' => [ + 'description' => 'The severity level of the error code. Valid values:'."\n" + ."\n" + .'* 4: moderate'."\n" + .'* 8: serious'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + 4 => '', + 8 => '', + ], + 'example' => '4', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 491 => [ + [ + 'errorCode' => 'Playbook.External.ParamError', + 'errorMessage' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F72685FB-A6E6-5A9A-97F7-6DC1056E63CE\\",\\n \\"Syntax\\": [\\n {\\n \\"StartLineNumber\\": 2,\\n \\"StartColumn\\": 2,\\n \\"EndLineNumber\\": 5,\\n \\"EndColumn\\": 5,\\n \\"Message\\": \\"undefined name \'ab\'\\",\\n \\"Severity\\": 4\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'VerifyPythonFile', + ], + 'DescribeProcessStatistics' => [ + 'summary' => 'Queries statistics.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208550', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese.'."\n" + .'* **en**: English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the view. Valid values:'."\n" + ."\n" + .'* 0 (default): the view of the current Alibaba Cloud account.'."\n" + .'* 1: the view of all accounts for the enterprise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1709821xxxxx3093', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<ProcessMetricsDTO>', + 'description' => 'SophonResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F', + ], + 'Metrics' => [ + 'title' => '传输的数据', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskNum' => [ + 'description' => 'The number of handling tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BanIpNum' => [ + 'description' => 'The number of blocked IP addresses.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BanFileNum' => [ + 'description' => 'The number of blocked files.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BanProcessNum' => [ + 'description' => 'The number of blocked processes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F\\",\\n \\"Metrics\\": {\\n \\"TaskNum\\": 1,\\n \\"BanIpNum\\": 1,\\n \\"BanFileNum\\": 1,\\n \\"BanProcessNum\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProcessStatistics', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + ], + 'DescribeProcessTasks' => [ + 'summary' => 'Queries the information about handling tasks. When you use Security Orchestration Automation Response (SOAR) to handle events, handling tasks are generated in the handling center.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186031', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProcessStrategyUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '处置策略ID', + 'description' => 'The UUID of the handling policy.'."\n" + ."\n" + .'> You can call the [ListDisposeStrategy](~~2584440~~) operation to query the UUID of the handling policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_xxxx', + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => [ + 'title' => '实体的名称', + 'description' => 'The name of the handling entity.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => [ + 'title' => '实体的类型', + 'description' => 'The type of the handling entity. Valid values:'."\n" + ."\n" + .'* **ip**.'."\n" + .'* **file**.'."\n" + .'* **process**.', + 'type' => 'string', + 'required' => false, + 'example' => 'ip', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'title' => '处置场景', + 'description' => 'The scenario code of the handling task.'."\n" + ."\n" + .'> You can call the [DescribeEnumItems](~~DescribeEnumItems~~) operation to query the scenario code of the handling task. This parameter is available when you set **EnumType** to **process**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'event_xxx_whole_process', + ], + ], + [ + 'name' => 'TaskStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '任务状态 list', + 'description' => 'The status of the handling task. The value is a string. Valid values:'."\n" + ."\n" + .'* **11**: being handled.'."\n" + .'* **21**: being blocked.'."\n" + .'* **22**: being quarantined.'."\n" + .'* **23**: completed.'."\n" + .'* **24**: added to the whitelist.'."\n" + .'* **20**: successful.'."\n" + .'* **90**: failed.'."\n" + .'* **91**: unblocking failed.'."\n" + .'* **92**: restoring quarantined files failed', + 'type' => 'string', + 'required' => false, + 'example' => '["11","21"]', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'title' => '作用域', + 'description' => 'The ID of the Alibaba Cloud account that is specified in the handling task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '125xxxxx9870', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'title' => '处置来源 list', + 'description' => 'The triggering source of the handling task. The value is a string array. Valid values:'."\n" + ."\n" + .'* **system**: triggered when you manually handle an event.'."\n" + .'* **custom**: triggered by an event based on an automatic response rule.'."\n" + .'* **custom_alert**: triggered by an alert based on an automatic response rule.'."\n" + .'* **soar-manual**: triggered when you use SOAR to manually run a playbook.'."\n" + .'* **soar-mdr**: triggered by Managed Security Service.', + 'type' => 'string', + 'required' => false, + 'example' => '["system"]', + ], + ], + [ + 'name' => 'ProcessActionStart', + 'in' => 'query', + 'schema' => [ + 'title' => '处置时间的查询开始时间', + 'description' => 'The beginning of the time range for a handling task. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1700031183572', + ], + ], + [ + 'name' => 'ProcessActionEnd', + 'in' => 'query', + 'schema' => [ + 'title' => '处置时间的查询结束时间', + 'description' => 'The end of the time range for a handling task. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1700031183572', + ], + ], + [ + 'name' => 'ProcessRemoveStart', + 'in' => 'query', + 'schema' => [ + 'title' => '解封时间的查询开始时间', + 'description' => 'The beginning of the time range for an unblocking task. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1700031183572', + ], + ], + [ + 'name' => 'ProcessRemoveEnd', + 'in' => 'query', + 'schema' => [ + 'title' => '解封时间的查询结束时间', + 'description' => 'The end of the time range for an unblocking task. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1700031183572', + ], + ], + [ + 'name' => 'ParamContent', + 'in' => 'query', + 'schema' => [ + 'title' => '模糊查询', + 'description' => 'The handling entity, handling scenario, or handling parameter that is used for fuzzy match.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12.x.x.x', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. If you do not specify the PageSize parameter, 10 entries are returned by default.'."\n" + ."\n" + .'> We recommend that you do not leave this parameter empty.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'YunCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud service that is associated with the handling task. The value is a string. Valid values:'."\n" + ."\n" + .'* **WAF**: Web Application Firewall (WAF).'."\n" + .'* **CFW**: Cloud Firewall.'."\n" + .'* **Aegis**: Security Center.', + 'type' => 'string', + 'required' => false, + 'example' => '["WAF"]', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the handling task.'."\n" + ."\n" + .'> This parameter is used to query a specific task. You can obtain the value from the response result.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '150xxxxxxxxx95066', + ], + ], + [ + 'name' => 'OrderField', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field that you use to sort the result.'."\n" + ."\n" + .'> You can obtain the field from the response result.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gmtCreate', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'* **desc** (default).'."\n" + .'* **asc**.', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'EntityUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '实体UUID', + 'description' => 'The UUID of the handling entity.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n", + ], + ], + [ + 'name' => 'EventUuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the event.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****', + ], + ], + [ + 'name' => 'TriggerSource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The triggering source of the handling task. Valid values:'."\n" + ."\n" + .'* **system**: triggered when you manually handle an event.'."\n" + .'* **custom**: triggered by an event based on an automatic response rule.'."\n" + .'* **custom_alert**: triggered by an alert based on an automatic response rule.'."\n" + .'* **soar-manual**: triggered when you use SOAR to manually run a playbook.'."\n" + .'* **soar-mdr**: triggered by Managed Security Service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + ], + [ + 'name' => 'ReqUuid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<ProcessTaskDTO>>', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94', + ], + 'ProcessTasks' => [ + 'title' => '传输的数据', + 'description' => 'The handling tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the handling task.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The unique identifier of the handling task.'."\n", + 'type' => 'string', + 'example' => '150xxxxxxxxx95066', + ], + 'Creator' => [ + 'title' => '任务的创建人', + 'description' => 'The ID of the Alibaba Cloud account that is used to submit the handling task.'."\n", + 'type' => 'string', + 'example' => '123xxxx355', + ], + 'GmtCreateMillis' => [ + 'title' => '任务创建时间', + 'description' => 'The creation time of the handling task. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700031183572', + ], + 'GmtModifiedMillis' => [ + 'title' => '任务修复时间', + 'description' => 'The modification time of the handling task. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700031183572', + ], + 'YunCode' => [ + 'title' => '关联产品', + 'description' => 'The code of the cloud service that is associated with the handling task.'."\n", + 'type' => 'string', + 'example' => 'WAF', + ], + 'EntityName' => [ + 'title' => '处置的实体名称', + 'description' => 'The name of the handling entity.'."\n", + 'type' => 'string', + 'example' => '1.1.1.x', + ], + 'EntityType' => [ + 'title' => '处置的实体类型', + 'description' => 'The type of the handling entity.'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'TaskStatus' => [ + 'title' => '任务状态', + 'description' => 'The status of the handling task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'Scope' => [ + 'title' => '作战域', + 'description' => 'The ID of the Alibaba Cloud account that is specified in the handling task.'."\n", + 'type' => 'string', + 'example' => '123xxxxx234', + ], + 'InputParams' => [ + 'title' => '任务的入参', + 'description' => 'The input parameter of the handling task.'."\n", + 'type' => 'string', + 'example' => '{"groupuuid":"c6a9b1df-f4ac-4078-bef4-99xxxxxx"}', + ], + 'SceneCode' => [ + 'title' => '处置场景', + 'description' => 'The scenario code of the handling task.'."\n", + 'type' => 'string', + 'example' => 'event_xxx_whole_process', + ], + 'SceneName' => [ + 'title' => '处置场景名称', + 'description' => 'The scenario name of the handling task.'."\n", + 'type' => 'string', + 'example' => 'waf_whole_process', + ], + 'ProcessTime' => [ + 'title' => '处置时间', + 'description' => 'The delivery time of the handling task. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700031183572', + ], + 'RemoveTime' => [ + 'title' => '解除时间', + 'description' => 'The unblocking time of the handling task. The value is a 13-digit timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700031183572', + ], + 'ProcessStrategyUuid' => [ + 'title' => '关联的策略ID', + 'description' => 'The ID of the associated policy.'."\n", + 'type' => 'string', + 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_xxxx', + ], + 'Source' => [ + 'description' => 'The submission source of the handling task.'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'ErrCode' => [ + 'description' => 'The error code returned if the call failed.'."\n", + 'type' => 'string', + 'example' => 'sts_openapi.Info.DefenseSceneNotSupported', + ], + 'ErrMsg' => [ + 'description' => 'The error message returned if the call failed.', + 'type' => 'string', + 'example' => 'ParamError : The parameters of your request are invalid', + ], + 'ErrTip' => [ + 'description' => 'The error tip returned if the call failed.', + 'type' => 'string', + 'example' => 'Verify that the input parameters of the components are correct', + ], + 'EntityUuid' => [ + 'description' => 'The UUID of the handling entity.'."\n", + 'type' => 'string', + 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n", + ], + 'EventUuid' => [ + 'description' => 'The UUID of the event.'."\n", + 'type' => 'string', + 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****'."\n", + ], + 'ReqUuid' => [ + 'description' => 'The UUID of the playbook execution record.'."\n", + 'type' => 'string', + 'example' => '93e5df20-3d03-42e1-b44b-58197c71****'."\n", + ], + 'TriggerSource' => [ + 'description' => 'The triggering source of the handling task. Valid values:'."\n" + ."\n" + .'* **system**: triggered when you manually handle an event.'."\n" + .'* **custom**: triggered by an event based on an automatic response rule.'."\n" + .'* **custom_alert**: triggered by an alert based on an automatic response rule.'."\n" + .'* **soar-manual**: triggered when you use SOAR to manually run a playbook.'."\n" + .'* **soar-mdr**: triggered by Managed Security Service.'."\n", + 'type' => 'string', + 'example' => 'system', + ], + ], + ], + ], + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"ProcessTasks\\": [\\n {\\n \\"TaskId\\": \\"150xxxxxxxxx95066\\",\\n \\"Creator\\": \\"123xxxx355\\",\\n \\"GmtCreateMillis\\": 1700031183572,\\n \\"GmtModifiedMillis\\": 1700031183572,\\n \\"YunCode\\": \\"WAF\\",\\n \\"EntityName\\": \\"1.1.1.x\\",\\n \\"EntityType\\": \\"ip\\",\\n \\"TaskStatus\\": 11,\\n \\"Scope\\": \\"123xxxxx234\\",\\n \\"InputParams\\": \\"{\\\\\\"groupuuid\\\\\\":\\\\\\"c6a9b1df-f4ac-4078-bef4-99xxxxxx\\\\\\"}\\",\\n \\"SceneCode\\": \\"event_xxx_whole_process\\",\\n \\"SceneName\\": \\"waf_whole_process\\",\\n \\"ProcessTime\\": 1700031183572,\\n \\"RemoveTime\\": 1700031183572,\\n \\"ProcessStrategyUuid\\": \\"92af3c79-1754-4646-9366-9ddbd1e45536_****\\",\\n \\"Source\\": \\"system\\",\\n \\"ErrCode\\": \\"sts_openapi.Info.DefenseSceneNotSupported\\",\\n \\"ErrMsg\\": \\"ParamError : The parameters of your request are invalid\\",\\n \\"ErrTip\\": \\"Verify that the input parameters of the components are correct\\",\\n \\"EntityUuid\\": \\"69d189e2-ec17-4676-a2fe-02969234****\\\\n\\",\\n \\"EventUuid\\": \\"c1020ce1-d6a5-11e8-8298-00163e10****\\\\n\\",\\n \\"ReqUuid\\": \\"93e5df20-3d03-42e1-b44b-58197c71****\\\\n\\",\\n \\"TriggerSource\\": \\"system\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProcessTasks', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + ], + 'DescribeProcessTaskCount' => [ + 'summary' => 'Query the number of associated disposal tasks based on the entity UUID.', + 'methods' => [ + 'get', + ], + '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' => 'Collection of entity UUIDs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Entity UUID.', + 'type' => 'string', + 'required' => false, + 'example' => 'a680c9ae-****-4c39-****-0302****fc8e', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'Language type for request and response messages. Values:'."\n" + ."\n" + .'- **zh** (default): Chinese.'."\n" + ."\n" + .'- **en**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'View type.'."\n" + ."\n" + .'- **0**: Current Alibaba Cloud account view.'."\n" + .'- **1**: View for all accounts under the enterprise.', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => [ + 'description' => 'User ID for administrators to switch to other member\'s perspective.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '104739******259', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<ProcessTaskNumberDTO>>', + 'description' => 'Return information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => 'e866cce0-****-41de-817e-****8d5e2650', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'Transmitted data.', + 'type' => 'array', + 'items' => [ + 'description' => 'Result set.', + 'type' => 'object', + 'properties' => [ + 'EntityUuid' => [ + 'title' => '实体uuid', + 'description' => 'Entity UUID.', + 'type' => 'string', + 'example' => 'a680c9ae-****-4c39-****-0302****fc8e', + ], + 'Count' => [ + 'title' => '数量', + 'description' => 'Count.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '67', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e866cce0-****-41de-817e-****8d5e2650\\",\\n \\"Data\\": [\\n {\\n \\"EntityUuid\\": \\"a680c9ae-****-4c39-****-0302****fc8e\\",\\n \\"Count\\": 67\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the Number of Associated Disposal Tasks by Entity UUID', + 'translator' => 'machine', + ], + 'DescribeSophonCommands' => [ + 'summary' => 'Queries the commands that can be run to obtain objects.', + 'methods' => [ + 'post', + 'get', + ], + '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 match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'waf_process', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<SophonCommandBO>>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The commands.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the command.'."\n", + 'type' => 'string', + 'example' => 'waf_process_ip_v2', + ], + 'DisplayName' => [ + 'description' => 'The display name of the command.'."\n", + 'type' => 'string', + 'example' => 'WAF Process IP', + ], + 'ParamConfig' => [ + 'description' => 'The parameter configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Necessary' => [ + 'description' => 'Indicates whether the parameter is required. Valid values:'."\n" + ."\n" + .'* **true** (default)'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Field' => [ + 'description' => 'The name of the parameter.'."\n", + 'type' => 'string', + 'example' => 'ip', + ], + 'Value' => [ + 'description' => 'The value of the parameter.'."\n", + 'type' => 'string', + 'example' => '12.xx.xx.xx', + ], + 'CheckField' => [ + 'description' => 'The regular expression that is used to check the format of the parameter value. If the parameter is left empty, the check is not performed.'."\n", + 'type' => 'string', + 'example' => '[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}', + ], + ], + ], + ], + 'Description' => [ + 'description' => 'The description of the command.'."\n", + 'type' => 'string', + 'example' => 'This is a action of processing for WAF', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1E1EC464-3BD7-518F-9937-BCC12E6855FE', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"waf_process_ip_v2\\",\\n \\"DisplayName\\": \\"WAF Process IP\\",\\n \\"ParamConfig\\": [\\n {\\n \\"Necessary\\": true,\\n \\"Field\\": \\"ip\\",\\n \\"Value\\": \\"12.xx.xx.xx\\",\\n \\"CheckField\\": \\"[0-9]{4}\\\\\\\\.[0-9]{4}\\\\\\\\.[0-9]{4}\\\\\\\\.[0-9]{4}\\"\\n }\\n ],\\n \\"Description\\": \\"This is a action of processing for WAF\\"\\n }\\n ],\\n \\"RequestId\\": \\"1E1EC464-3BD7-518F-9937-BCC12E6855FE\\"\\n}","type":"json"}]', + 'title' => 'DescribeSophonCommands', + ], + 'TriggerProcessTask' => [ + 'summary' => 'Performs an action on a handling task that is generated by the handling center when an event is handled by using Security Orchestration Automation Response (SOAR). For example, you can call this operation to cancel blocking or isolation, or retry blocking.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the handling task.'."\n" + ."\n" + .'> You can call the [DescribeProcessTasks](~~DescribeProcessTasks~~) operation to query the IDs of handling tasks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '15355xxxxxx82894882', + ], + ], + [ + 'name' => 'ActionType', + 'in' => 'query', + 'schema' => [ + 'title' => '处置类型', + 'description' => 'The type of the action. Valid values:'."\n" + ."\n" + .'* **remove**: cancels blocking or isolation.'."\n" + .'* **retry**: submits the task again.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'remove', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<Void>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\"\\n}","type":"json"}]', + 'title' => 'TriggerProcessTask', + ], + 'DescribeOpenApiList' => [ + 'summary' => 'Queries the API operations of an Alibaba Cloud service.', + 'methods' => [ + 'get', + ], + '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 service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Sas', + ], + ], + [ + 'name' => 'ApiVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version number of the API.'."\n" + ."\n" + .'> You can call the [DescribeGroupProductions](~~DescribeGroupProductions~~) operation to query the version number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2021-10-01', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation that you want to perform.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DescribePopApiItemList', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n" + ."\n" + .'* **zh**: Chinese.'."\n" + .'* **en**: English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the view. Default value: 0. Valid values:'."\n" + ."\n" + .'* 0: the view of the current Alibaba Cloud account.'."\n" + .'* 1: the view of all accounts for the enterprise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '137602xxx8718726', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<APITreeBO>', + 'description' => 'SophonResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code. Valid values:'."\n" + ."\n" + .'* 200: successful.'."\n" + .'* 500: failed.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Version' => [ + 'description' => 'The version number of the API.'."\n", + 'type' => 'string', + 'example' => '2018-12-03', + ], + 'Directories' => [ + 'description' => 'The information about the returned APIs.'."\n", + 'type' => 'any', + 'example' => '[{"apis":[{"summary":"get account information","deprecated":false,"name":"DescAccountSummary","title":"get account information"}],"childrens":[],"title":"account"}]', + ], + ], + ], + ], + ], + ], + ], + '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 }\\n}","type":"json"}]', + 'title' => 'DescribeOpenApiList', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or the pricing for log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + ], + 'DescribeOpenApiInfo' => [ + 'summary' => 'Queries the details of an API operation.', + 'methods' => [ + 'get', + ], + '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', + ], + ], + [ + 'name' => 'ApiVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version number of the API.'."\n" + ."\n" + .'> You can call the [DescribeGroupProductions](~~DescribeGroupProductions~~) operation to query version numbers.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2018-12-03', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation that you want to perform.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DescribePopApiItemList', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese.'."\n" + .'* **en**: English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the view. Valid values:'."\n" + ."\n" + .'* 0 (default): the view of the current Alibaba Cloud account.'."\n" + .'* 1: the view of all accounts for the enterprise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1592757xxx002956', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<APIDetailVO>', + 'description' => 'SophonResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'OutputParams' => [ + 'description' => 'The output parameters of the API operation.'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'InputParams' => [ + 'description' => 'The input parameters of the API operation.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'ResponseDemo' => [ + 'description' => 'The sample response parameters.'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'Title' => [ + 'description' => 'The title of the API operation.'."\n", + 'type' => 'string', + 'example' => 'describeEcs', + ], + 'Summary' => [ + 'description' => 'The summary of the API operation.'."\n", + 'type' => 'string', + 'example' => 'describeEcs', + ], + 'Description' => [ + 'description' => 'The description of the API operation.'."\n", + 'type' => 'string', + 'example' => 'describeEcs', + ], + ], + ], + ], + ], + ], + ], + '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", + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => '118******150980', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<ProductionGroup>>', + 'description' => 'SophonResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '358E012F-****-599D-9ED0-****61CDE615', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The information about the groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the group.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => 'The name of the cloud service.'."\n", + 'type' => 'string', + 'example' => 'Cloud Communication', + ], + 'Productions' => [ + 'description' => 'The information about the cloud services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the cloud service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'example' => 'DM', + ], + 'Name' => [ + 'description' => 'The name of the cloud service.'."\n", + 'type' => 'string', + 'example' => 'DirectMail', + ], + 'ShortName' => [ + 'description' => 'The short name of the cloud service.'."\n", + 'type' => 'string', + 'example' => 'DM', + ], + 'Description' => [ + 'description' => 'The description of the cloud service.'."\n", + 'type' => 'string', + 'example' => 'DM', + ], + 'Group' => [ + 'description' => 'The name of the group.'."\n", + 'type' => 'string', + 'example' => 'Cloud Communication', + ], + 'Versions' => [ + 'description' => 'The API versions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The API version.'."\n", + 'type' => 'string', + 'example' => '2014-08-15', + ], + ], + 'DefaultVersion' => [ + 'description' => 'The default version.'."\n", + 'type' => 'string', + 'example' => '2014-08-15', + ], + 'DefaultDomain' => [ + 'description' => 'The default requested domain name.'."\n", + 'type' => 'string', + 'example' => 'dm.aliyuncs.com', + ], + 'FullDomains' => [ + 'description' => 'The requested domain names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The requested domain name.'."\n", + 'type' => 'string', + 'example' => 'dm.aliyuncs.com', + ], + ], + 'RamCode' => [ + 'description' => 'The Resource Access Management (RAM) code of the POP to which the resource belongs.'."\n", + 'type' => 'string', + 'example' => 'dm', + ], + 'Source' => [ + 'description' => 'The information source of the cloud service.'."\n", + 'type' => 'string', + 'example' => 'next', + ], + 'PolicyList' => [ + 'title' => '产品的ram策略集合', + 'description' => 'The RAM policies of the cloud service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The RAM policy of the cloud service.'."\n", + 'type' => 'object', + 'properties' => [ + 'PolicyName' => [ + 'title' => 'ram策略名称', + 'description' => 'The name of the RAM policy.'."\n", + 'type' => 'string', + 'example' => 'AliyunRAMReadOnlyAccess', + ], + 'Type' => [ + 'title' => 'ram策略类型（全部权限OR只读权限）', + 'description' => 'The type of the RAM policy. Valid values:'."\n" + ."\n" + .'* **All**: permissions.'."\n" + .'* **Read-only**: permissions.', + 'type' => 'string', + 'example' => 'All', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9Exxx-A1A361CDE615\\",\\n \\"Data\\": [\\n {\\n \\"GroupName\\": \\"数据库\\",\\n \\"Productions\\": [\\n {\\n \\"Code\\": \\"Rds\\",\\n \\"Name\\": \\"云数据库 RDS\\",\\n \\"ShortName\\": \\"RDS\\",\\n \\"Description\\": \\"云数据库\\",\\n \\"Group\\": \\"云数据库\\",\\n \\"Versions\\": [\\n \\"2014-08-15\\"\\n ],\\n \\"DefaultVersion\\": \\"2014-08-15\\",\\n \\"DefaultDomain\\": \\"rds.aliyuncs.com\\",\\n \\"FullDomains\\": [\\n \\"rds.aliyuncs.com\\"\\n ],\\n \\"RamCode\\": \\"rds\\",\\n \\"Source\\": \\"next\\",\\n \\"PolicyList\\": [\\n {\\n \\"PolicyName\\": \\"AliyunRAMReadOnlyAccess\\",\\n \\"Type\\": \\"只读权限\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'DescribeGroupProductions', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + ], + 'DescribeNotifyTemplateList' => [ + 'summary' => 'Queries notification templates.', + 'methods' => [ + 'get', + ], + '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', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the view. Default value: 0. Valid values:'."\n" + ."\n" + .'* 0: the view of the current Alibaba Cloud account.'."\n" + .'* 1: the view of all accounts for the enterprise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<List<NotifyTemplateDTO>>', + 'description' => 'SophonResult\\<List>'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateName' => [ + 'title' => '模版名称', + 'description' => 'The name of the template.'."\n", + 'type' => 'string', + 'example' => 'incident generate', + ], + 'EventId' => [ + 'title' => '模版对应的消息事件的id', + 'description' => 'The ID of the message event corresponding to the template.'."\n", + 'type' => 'string', + 'example' => 'yundun_soar_incident_generate', + ], + 'Subject' => [ + 'title' => '模版的标题', + 'description' => 'The title of the template.'."\n", + 'type' => 'string', + 'example' => '[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)', + ], + 'Content' => [ + 'title' => '模版的正文', + 'description' => 'The body of the template.'."\n", + 'type' => 'string', + 'example' => 'Dear $aliyunUID : Cloud Security Center Threat Analysis and Response has detected a newly discovered security incident $incidentName(Incident id :$incidentID) in $startTime, Please go to Cloud Security Center Console View.', + ], + 'Params' => [ + 'title' => '模版的参数', + 'description' => 'The parameters of the template.'."\n", + 'type' => 'string', + 'example' => '[\\"aliyunUID\\",\\"incidentName\\",\\"incidentID\\",\\"startTime\\"]', + ], + ], + ], + ], + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + '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", + ], + 'RunNotifyComponentWithEmail' => [ + 'summary' => 'Runs the email notification component to send messages.', + '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' => 'The email addresses.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The email address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Subject', + 'in' => 'query', + 'schema' => [ + 'title' => '邮箱标题', + 'description' => 'The subject of the email.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'title', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'title' => '邮箱正文', + 'description' => 'The body of the email.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'email content', + ], + ], + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本uuid', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'e99dab31-499b-4307-9248-xxxxxx', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的节点名称', + 'description' => 'The name of the node in the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'notify_message_1', + ], + ], + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的组件名称', + 'description' => 'The name of component in the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NotifyMessage', + ], + ], + [ + 'name' => 'ActionName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的动作名称', + 'description' => 'The action name of the component.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'notifyByCustom', + ], + ], + [ + 'name' => 'AssetId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The resource instance ID of the email sender.'."\n" + ."\n" + .'> You can call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to query the ID.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid value:'."\n" + ."\n" + .'* **zh** (default): Chinese.'."\n" + .'* **en**: English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the view. Valid values:'."\n" + ."\n" + .'* 0: the view of the current Alibaba Cloud account.'."\n" + .'* 1: the view of all accounts for the enterprise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '137602xxx718726', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'SophonResult'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The data returned.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'RunNotifyComponentWithEmail', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + ], + 'RunNotifyComponentWithMessageCenter' => [ + 'summary' => 'Execute Notification Component - Send Message via Message Center.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + '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 user ID receiving the message.', + 'type' => 'string', + 'required' => true, + 'example' => '146789xxxx733152', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'title' => '云鸽的消息事件id', + 'description' => 'Cloud Pigeon\'s message event ID. Values:'."\n" + .'- yundun_soar_incident_generate: Incident generation.'."\n" + .'- yundun_soar_alert_generate: Alert generation.'."\n" + .'- yundun_soar_incident_update: Incident update.', + 'type' => 'string', + 'required' => true, + 'example' => 'yundun_soar_incident_generate', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'title' => '消息参数', + 'description' => 'Template parameters for the message event.'."\n" + .'- For incident generation: aliyunUID, incidentName, incidentID, startTime'."\n" + .'- For alert generation: aliyunUID, alertName, alertID, startTime'."\n" + .'- For incident update: aliyunUID, incidentName, incidentID, startTime, endTime, status, level', + 'type' => 'string', + 'required' => false, + 'example' => '{"startTime":"test222","incidentName":"test123","incidentID":"teset123"}', + ], + ], + [ + 'name' => 'ChannelTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '通道类型集合，不传默认发送消息事件配置的所有通道', + 'description' => 'Collection of channel types. If not provided, all channels will be used by default, and it is not required to provide this parameter by default.', + 'type' => 'array', + 'items' => [ + 'description' => 'Single channel type. Values:'."\n" + .'- sms: SMS.'."\n" + .'- email: Email.'."\n" + .'- webhook: DingTalk group webhook.'."\n" + .'- pmsg: In-site message.', + 'type' => 'string', + 'required' => false, + 'example' => 'sms', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本uuid', + 'description' => 'The UUID of the playbook.'."\n" + .'> You can obtain this parameter by calling the [DescribePlaybooks](~~DescribePlaybooks~~) interface.', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的节点名称', + 'description' => 'The node name of the playbook.', + 'type' => 'string', + 'required' => true, + 'example' => 'notify_message', + ], + ], + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的组件名称', + 'description' => 'The component name of the playbook.', + 'type' => 'string', + 'required' => true, + 'example' => 'NotifyMessage', + ], + ], + [ + 'name' => 'ActionName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的动作名称', + 'description' => 'The action name of the playbook.', + 'type' => 'string', + 'required' => true, + 'example' => 'notifyByMessageCenter', + ], + ], + [ + 'name' => 'AssetId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源实例id', + 'description' => 'Resource instance ID. This parameter is currently deprecated and no longer in use.', + 'type' => 'string', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language type for requesting and receiving messages. Values:'."\n" + .'- **zh** (default): Chinese.'."\n" + .'- **en**: English.', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'View type. Values:'."\n" + .'- 0 (default): Current Alibaba Cloud account view.'."\n" + .'- 1: View for all accounts under the enterprise.', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user ID when an administrator switches to another member\'s perspective.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1467894xxx733152', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'SophonResult<String>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', + 'type' => 'string', + 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'Data returned by the interface.', + 'type' => 'string', + 'example' => '{}', + ], + 'Page' => [ + 'description' => 'Pagination query information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'Number of list entries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'Page number in pagination queries.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of items to display per page when performing a paginated query.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'Notification Component - Test Message Center Message Sending', + 'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., Threat Analysis and Response Log Access Traffic) before using this interface.', + 'translator' => 'machine', + ], + 'RunNotifyComponentWithWebhook' => [ + 'summary' => 'Runs the webhook notification component to send messages.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226713', + 'abilityTreeNodes' => [ + 'FEATUREsas104PTS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'title' => 'webhook地址', + 'description' => 'The IDs of chatbots that are configured in the message center. Only DingTalk chatbots are supported.'."\n" + ."\n" + .'> You can call the [ListEncryptWebhooks](~~ListEncryptWebhooks~~) operation to query the chatbot IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[\\"10651\\"]', + ], + ], + [ + 'name' => 'Secret', + 'in' => 'query', + 'schema' => [ + 'title' => 'webhook消息秘钥', + 'description' => 'The message key of the DingTalk chatbot webhook. This parameter is deprecated.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SECc1*****e157b32b380f********bb8c70e1a67a22072', + ], + ], + [ + 'name' => 'MsgType', + 'in' => 'query', + 'schema' => [ + 'title' => 'webhook消息类型，取值：text、markdown、actionCard', + 'description' => 'The type of the webhook message. Valid values:'."\n" + .'* text.'."\n" + .'* markdown.'."\n" + .'* actionCard.', + 'type' => 'string', + 'required' => true, + 'example' => 'text', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'title' => 'webhook消息正文', + 'description' => 'The message body sent by the DingTalk group chatbot webhook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "at": {'."\n" + .' "atMobiles":['."\n" + .' "180xxxxxx"'."\n" + .' ],'."\n" + .' "atUserIds":['."\n" + .' "user123"'."\n" + .' ],'."\n" + .' "isAtAll": false'."\n" + .' },'."\n" + .' "text": {'."\n" + .' "content":"1234"'."\n" + .' },'."\n" + .' "msgtype":"text"'."\n" + .'}', + ], + ], + [ + 'name' => 'PlaybookUuid', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本uuid', + 'description' => 'The UUID of the playbook.'."\n" + ."\n" + .'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '94bc318c-****-4cba-****-801ccb0d739f', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的节点名称', + 'description' => 'The name of the node in the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'notify_message_node', + ], + ], + [ + 'name' => 'ComponentName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的组件名称', + 'description' => 'The name of the component in the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NotifyMessage', + ], + ], + [ + 'name' => 'ActionName', + 'in' => 'query', + 'schema' => [ + 'title' => '剧本的动作名称', + 'description' => 'The name of the action in the playbook.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'notifyByCustom', + ], + ], + [ + 'name' => 'AssetId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ID of the resource. This parameter is deprecated.'."\n", + 'type' => 'string', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the content within the request and the response. Valid values:'."\n" + ."\n" + .'* **zh** (default): Chinese.'."\n" + .'* **en**: English.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RoleType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the view. Valid values:'."\n" + ."\n" + .'* 0 (default): the view of the current Alibaba Cloud account.'."\n" + .'* 1: the view of all accounts for the enterprise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RoleFor', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '126339xxxx805497', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SophonResult<String>', + 'description' => 'SophonResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的requestId', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94', + ], + 'Data' => [ + 'title' => '传输的数据', + 'description' => 'The data returned.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'Page' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-****-5840-8EC9-691B86729E94\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'RunNotifyComponentWithWebhook', + 'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n", + ], + 'DescribeVendorApiList' => [ + 'summary' => 'Queries the API operations of a cloud service provider.', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => 'Keyword.', + 'type' => 'string', + 'required' => false, + 'example' => 'Create', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Alibaba Cloud product interface, supporting fuzzy search.', + 'type' => 'string', + 'required' => false, + 'example' => 'AddAssetCleanConfig', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + 'Page' => [ + 'description' => 'Pagination query information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'Total number of items.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => 'The current page number in the pagination query.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of items displayed per page in the pagination query.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + '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', + ], + 'ProductCode' => [ + 'description' => 'Vendor\'s product identifier:'."\n" + .'- **waf**: Web Application Firewall.'."\n" + .'- **cfw**: Cloud Firewall.', + 'type' => 'string', + 'example' => 'cfw', + ], + 'ProductName' => [ + 'description' => 'Product name.', + 'type' => 'string', + 'example' => 'waf', + ], + 'Parameter' => [ + 'description' => 'Interface request parameter configuration information.', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "name": "Domain",'."\n" + .' "type": "String",'."\n" + .' "isRequired": true,'."\n" + .' "exampleValue": "www.***.com",'."\n" + .' "description": "www.***.com"'."\n" + .' }'."\n" + .']', + ], + 'ProductDomain' => [ + 'description' => 'Default domain of the product.', + 'type' => 'string', + 'example' => 'cfw.xxx.com', + ], + 'Protocol' => [ + 'description' => 'Request protocol. Values:'."\n" + .'- **http**: HTTP request protocol.'."\n" + .'- **https**: HTTPS request protocol.', + 'type' => 'string', + 'example' => 'https', + ], + 'Method' => [ + 'description' => 'Request methods: '."\n" + .'- **POST**: POST request method. '."\n" + .'- **GET**: GET request method. '."\n" + .'- **PUT**: PUT request method. '."\n" + .'- **DELETE**: DELETE request method.', + 'type' => 'string', + 'example' => 'POST', + ], + 'ApiName' => [ + 'description' => 'The name of the vendor\'s API.', + 'type' => 'string', + 'example' => 'VerifyMobile', + ], + 'NeedPageInfo' => [ + 'description' => 'Indicates whether pagination is needed.'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PageInfo' => [ + 'description' => 'Information displayed on the page.', + 'type' => 'string', + 'example' => '{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}', + ], + 'ApiVersion' => [ + 'description' => 'The version number of the API.', + 'type' => 'string', + 'example' => '2017-08-01', + ], + 'NeedAdvanceConfig' => [ + 'description' => 'Indicates whether advanced configuration is included.'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AdvanceConfig' => [ + 'description' => 'Advanced configuration for the API.', + 'type' => 'string', + 'example' => '{'."\n" + .' "cmd": "DescribeAclApiDispatch"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + 'translator' => 'machine', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'public', + 'endpoint' => 'sophonsoar.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', + ], + ], +]; |