summaryrefslogtreecommitdiff
path: root/data/zh_cn/sophonsoar
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/sophonsoar
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/sophonsoar')
-rw-r--r--data/zh_cn/sophonsoar/2022-07-28/api-docs.php9606
-rw-r--r--data/zh_cn/sophonsoar/2025-09-03/api-docs.php2373
2 files changed, 4530 insertions, 7449 deletions
diff --git a/data/zh_cn/sophonsoar/2022-07-28/api-docs.php b/data/zh_cn/sophonsoar/2022-07-28/api-docs.php
index fae6ed3..93f9f5a 100644
--- a/data/zh_cn/sophonsoar/2022-07-28/api-docs.php
+++ b/data/zh_cn/sophonsoar/2022-07-28/api-docs.php
@@ -1,398 +1,185 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'sophonsoar',
- 'version' => '2022-07-28',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'sophonsoar', 'version' => '2022-07-28'],
'directories' => [
[
- 'id' => 349146,
- 'title' => '剧本编排',
- 'type' => 'directory',
'children' => [
- 'CopyPlaybook',
- 'ConvertPlaybook',
- 'RunPython3Script',
- 'ComparePlaybooks',
- 'CreatePlaybook',
- 'DebugPlaybook',
- 'DeleteComponentAsset',
- 'DeletePlaybook',
- 'DescribeComponentAssetForm',
- 'DescribeComponentAssets',
- 'DescribeComponentList',
- 'DescribeComponentPlaybook',
- 'DescribeComponentsJs',
- 'DescribeDistinctReleases',
- 'DescribeEnumItems',
- 'DescribeExecutePlaybooks',
- 'DescribeField',
- 'DescribeLatestRecordSchema',
- 'DescribeNodeParamTags',
- 'DescribePlaybook',
- 'DescribePlaybookInputOutput',
- 'DescribePlaybookMetrics',
- 'DescribePlaybookNodesOutput',
- 'DescribePlaybookNumberMetrics',
- 'DescribePlaybookReleases',
- 'DescribePlaybooks',
- 'DescribePopApi',
- 'DescribeSoarRecordActionOutputList',
- 'DescribeSoarRecordInOutput',
- 'DescribeSoarRecords',
- 'DescribeSoarTaskAndActions',
- 'DescriberPython3ScriptLogs',
- 'ModifyComponentAsset',
- 'ModifyPlaybook',
- 'ModifyPlaybookInputOutput',
- 'PublishPlaybook',
- 'QueryTreeData',
- 'RevertPlaybookRelease',
- 'TriggerPlaybook',
- 'TriggerSophonPlaybook',
- 'VerifyPlaybook',
- 'VerifyPythonFile',
+ 'BatchModifyInstanceStatus', 'CopyPlaybook', 'ConvertPlaybook', 'RunPython3Script', 'ComparePlaybooks', 'CreatePlaybook', 'DebugPlaybook', 'DeleteComponentAsset', 'DeletePlaybook', 'DescribeComponentAssetForm', 'DescribeComponentAssets', 'DescribeComponentList', 'DescribeComponentPlaybook', 'DescribeComponentsJs', 'DescribeDistinctReleases', 'DescribeEnumItems', 'DescribeExecutePlaybooks', 'DescribeField', 'DescribeLatestRecordSchema', 'DescribeNodeParamTags',
+ 'DescribeNodeUsedInfos', 'DescribePlaybook', 'DescribePlaybookInputOutput', 'DescribePlaybookMetrics', 'DescribePlaybookNodesOutput', 'DescribePlaybookNumberMetrics', 'DescribePlaybookReleases', 'DescribePlaybooks', 'DescribePopApi', 'DescribeSoarRecordActionOutputList', 'DescribeSoarRecordInOutput', 'DescribeSoarRecords', 'DescribeSoarTaskAndActions', 'DescriberPython3ScriptLogs', 'ModifyComponentAsset', 'ModifyPlaybook', 'ModifyPlaybookInputOutput', 'ModifyPlaybookInstanceStatus', 'PublishPlaybook', 'QueryTreeData',
+ 'RevertPlaybookRelease', 'TriggerPlaybook', 'TriggerSophonPlaybook', 'VerifyPlaybook', 'VerifyPythonFile',
],
+ 'type' => 'directory',
+ 'title' => '剧本编排',
+ 'id' => 45973,
],
[
- 'id' => 349193,
- 'title' => '处置任务',
+ 'children' => ['DescribeProcessStatistics', 'DescribeProcessTasks', 'DescribeProcessTaskCount', 'DescribeSophonCommands', 'TriggerProcessTask'],
'type' => 'directory',
- 'children' => [
- 'DescribeProcessStatistics',
- 'DescribeProcessTasks',
- 'DescribeProcessTaskCount',
- 'DescribeSophonCommands',
- 'TriggerProcessTask',
- ],
+ 'title' => '处置任务',
+ 'id' => 290041,
],
[
- 'id' => 349199,
- 'title' => '其他',
+ 'children' => ['DescribeOpenApiList', 'DescribeOpenApiInfo', 'DescribeGroupProductions', 'DescribeNotifyTemplateList', 'RunNotifyComponentWithEmail', 'RunNotifyComponentWithMessageCenter', 'RunNotifyComponentWithWebhook', 'DescribeVendorApiList'],
'type' => 'directory',
- 'children' => [
- 'DescribeOpenApiList',
- 'DescribeOpenApiInfo',
- 'DescribeGroupProductions',
- 'DescribeNotifyTemplateList',
- 'RunNotifyComponentWithEmail',
- 'RunNotifyComponentWithMessageCenter',
- 'RunNotifyComponentWithWebhook',
- 'DescribeVendorApiList',
- ],
+ 'title' => '其他',
+ 'id' => 72343,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CopyPlaybook' => [
- 'summary' => '剧本复制。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'BatchModifyInstanceStatus' => [
+ 'summary' => '用于批量修改剧本的启用与停止状态',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '218814',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'DisplayName',
+ 'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本展示名称',
- 'description' => '剧本展示名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'playbook_xxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID，如果操作多个剧本，UUID以逗号分隔。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,s8df2e-s8dfs-xxxx'],
],
[
- 'name' => 'Description',
+ 'name' => 'Active',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的描述',
- 'description' => '剧本的描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'playbook description',
- ],
+ 'schema' => ['title' => '剧本启禁用状态', 'description' => '剧本启动停止状态：'."\n"
+ ."\n"
+ .'- **0**：表示停止剧本'."\n"
+ .'- **1**：表示启用剧本', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'SourcePlaybookUuid',
- 'in' => 'formData',
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '要复制的剧本uuid',
- 'description' => '要复制的剧本UUID。'."\n"
- .'>调用[DescribePlaybooks](~~3000306~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '94bc318c-****-4cba-****-801ccb0d739f',
+ 'title' => 'SophonResult<Void>',
+ 'description' => '返回信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9ED0-A1A361CDE615\\"\\n}","type":"json"}]',
+ 'title' => '批量修改剧本状态',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'ComparePlaybooks' => [
+ 'summary' => '用于比较发布的两个版本的剧本配置信息。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ReleaseVersion',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '要复制的剧本的taskflowMd5. 特殊取值：-1：代表现在编辑中的版本 0:当前剧本的线上最新发布版本(不传默认为0)',
- 'description' => '要复制剧本的发布版本，默认为0。 取值：'."\n"
- .'- -1：代表正在编辑中的版本。'."\n"
- ."\n"
- .'- 0：当前剧本的线上最新发布版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'Lang',
+ 'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**：（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['title' => '剧本的UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'f916b93e-e814-459f-9662-xxxxx'],
],
[
- 'name' => 'RoleType',
+ 'name' => 'OldPlaybookReleaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。取值：'."\n"
- ."\n"
- .'- **0**（默认）：当前账号视图。'."\n"
- ."\n"
- .'- **1**：全局账号视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '老版本的ID', 'description' => '用于比较的第一个发布版本UUID。'."\n"
+ .'>历史版本调用[DescribePlaybookReleases](~~DescribePlaybookReleases~~)接口可以获取该参数，新发布版本系统会自动生成。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => 'sflk23423-e814-459f-9662-xxxxx'],
],
[
- 'name' => 'RoleFor',
+ 'name' => 'NewPlaybookReleaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '137602*****718726',
- ],
+ 'schema' => ['title' => '新版本的ID', 'description' => '用于比较的第二个发布版本UUID。'."\n"
+ .'>历史版本调用[DescribePlaybookReleases](~~DescribePlaybookReleases~~)接口可以获取该参数，新发布版本系统会自动生成。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => 'sfdf2395-e814-459f-9662-xxxxx'],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<PlaybookCloudDTO>',
- 'description' => 'SophonResult<PlaybookCloudDTO>',
+ 'title' => 'SophonResult<CompareResult>',
+ 'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A',
- ],
- 'Data' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A'],
+ 'CompareResult' => [
'title' => '传输的数据',
- 'description' => '返回结果信息。',
- 'type' => 'object',
- 'properties' => [
- 'DisplayName' => [
- 'title' => '剧本的名称',
- 'description' => '复制后的剧本名称。',
- 'type' => 'string',
- 'example' => '11111',
- ],
- 'PlaybookUuid' => [
- 'title' => '剧本的UUID',
- 'description' => '复制后剧本的UUID。',
- 'type' => 'string',
- 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx',
- ],
- 'OwnType' => [
- 'title' => '剧本的权限类型',
- 'description' => '剧本的类型。取值：'."\n"
- ."\n"
- .'- preset：预定义剧本。'."\n"
- ."\n"
- .'- user：自定义剧本。',
- 'type' => 'string',
- 'example' => 'user',
- ],
- 'Active' => [
- 'title' => '剧本的启用状态',
- 'description' => '剧本的启用状态。取值：'."\n"
- ."\n"
- .'- 1：剧本已启用。'."\n"
- ."\n"
- .'- 0：剧本未启用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'LastRuntime' => [
- 'title' => '剧本的最后执行时间',
- 'description' => '剧本的最后执行时间。格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1725258397847',
- ],
- 'Permission' => [
- 'title' => '剧本是否可编辑',
- 'description' => '剧本的操作权限。取值：'."\n"
- ."\n"
- .'- 1：不可编辑，可查看'."\n"
- ."\n"
- .'- 2：可编辑',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'GmtCreate' => [
- 'title' => '剧本创建时间',
- 'description' => '剧本创建时间。格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1655951601000',
- ],
- 'GmtModified' => [
- 'title' => '剧本创建时间',
- 'description' => '剧本修改时间。格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1638270967000',
- ],
- 'HistoryMd5' => [
- 'title' => '剧本历史版本数',
- 'description' => '剧本历史版本数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SuccNum' => [
- 'title' => '剧本执行成功数',
- 'description' => '剧本执行成功数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'FailNum' => [
- 'title' => '剧本执行失败数',
- 'description' => '剧本执行失败数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'FailRate' => [
- 'title' => '剧本执行失败率',
- 'description' => '剧本执行失败率。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
- ],
- 'InputParams' => [
- 'title' => '剧本的入参',
- 'description' => '剧本的入参。',
- 'type' => 'string',
- 'example' => '[{\\"name\\":\\"1\\",\\"dataType\\":\\"String\\",\\"required\\":false,\\"isArray\\":false,\\"example\\":\\"\\",\\"description\\":\\"\\",\\"id\\":0,\\"typeName\\":\\"String\\",\\"dataClass\\":\\"normal\\"}]',
- ],
- 'OutputParams' => [
- 'title' => '剧本的出参',
- 'description' => '剧本的出参。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'Description' => [
- 'title' => '剧本描述',
- 'description' => '剧本描述。',
- 'type' => 'string',
- 'example' => 'This is a action of processing for WAF',
- ],
- 'LogicReleaseTaskflowMd5' => [
- 'title' => '剧本的线上版本',
- 'description' => '剧本的线上版本MD5。',
- 'type' => 'string',
- 'example' => '037046****1b00c4717963818ccbf2xx',
- ],
- 'PlaybookStatus' => [
- 'title' => '剧本描述',
- 'description' => '剧本状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TenantId' => [
- 'title' => '剧本所属的租户',
- 'description' => '剧本所属的用户ID。',
- 'type' => 'string',
- 'example' => '13760*****8718726',
- ],
- ],
- ],
- 'Page' => [
- 'description' => '分页查询信息。',
+ 'description' => '比较结果。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Same' => ['description' => '两个版本是否相同的标记。'."\n"
+ .'- **true**：相同。'."\n"
+ .'- **false**：不相同。', 'type' => 'boolean', 'example' => 'false'],
+ 'New' => ['description' => '用于比较的第二个版本，是否为新增版本：'."\n"
+ ."\n"
+ .'- **true**：表示为新增版本。'."\n"
+ .'- **false**：表示不是新增版本。', 'type' => 'boolean', 'example' => 'true'],
+ 'Description' => ['description' => '比较结果的描述信息。', 'type' => 'string', 'example' => 'The first version adds one node compared to the second version'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2EC05B06-****-5F3E-****-3B1FAD76087A\\",\\n \\"CompareResult\\": {\\n \\"Same\\": false,\\n \\"New\\": true,\\n \\"Description\\": \\"The first version adds one node compared to the second version\\"\\n }\\n}","type":"json"}]',
+ 'title' => '比较剧本版本信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ComparePlaybooks'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:ComparePlaybooks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
],
- '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' => '复制剧本',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
],
'ConvertPlaybook' => [
'summary' => '转换剧本流程图配置格式，由xml转为x6。用于兼容历史数据，早期版本中配置剧本使用的xml格式，之后改为了x6格式。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -405,72 +192,48 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '208668',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Taskflow',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本编辑配置',
- 'description' => '剧本编排的XML配置信息。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>'."\n"
- .'<bpmn:definitions xmlns:xsi=\\"http://www.w3.org/2001/XMLSchema-instance\\" xmlns:bpmn=\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\" xmlns:bpmndi=\\"http://www.omg.org/spec/BPMN/20100524/DI\\" xmlns:dc=\\"http://www.omg.org/spec/DD/20100524/DC\\" id=\\"Definitions_1\\" targetNamespace=\\"http://bpmn.io/schema/bpmn\\">'."\n"
- .' <bpmn:process id=\\"Process_1\\" isExecutable=\\"false\\">'."\n"
- .' <bpmn:startEvent id=\\"StartEvent_1\\" />'."\n"
- .' </bpmn:process>'."\n"
- .' <bpmndi:BPMNDiagram id=\\"BPMNDiagram_1\\">'."\n"
- .' <bpmndi:BPMNPlane id=\\"BPMNPlane_1\\" bpmnElement=\\"Process_1\\">'."\n"
- .' <bpmndi:BPMNShape id=\\"_BPMNShape_StartEvent_2\\" bpmnElement=\\"StartEvent_1\\">'."\n"
- .' <dc:Bounds x=\\"173\\" y=\\"102\\" width=\\"36\\" height=\\"36\\" />'."\n"
- .' </bpmndi:BPMNShape>'."\n"
- .' </bpmndi:BPMNPlane>'."\n"
- .' </bpmndi:BPMNDiagram>'."\n"
- .'</bpmn:definitions>'."\n"
- .' ',
- ],
+ 'schema' => ['title' => '剧本编辑配置', 'description' => '剧本编排的XML配置信息。', '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' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleType',
'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。取值：'."\n"
- ."\n"
- .'- 0：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- 0：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'RoleFor',
'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
],
'responses' => [
@@ -480,37 +243,40 @@
'description' => 'SophonResult<String>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '39C38A34-****-*****-****-7263B435C316',
- ],
- 'Config' => [
- 'title' => '传输的数据',
- 'description' => '转换后的X6配置信息。',
- 'type' => 'string',
- 'example' => '{}',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '39C38A34-****-*****-****-7263B435C316'],
+ 'Config' => ['title' => '传输的数据', 'description' => '转换后的X6配置信息。', 'type' => 'string', 'example' => '{}'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-****-*****-****-7263B435C316\\",\\n \\"Config\\": \\"{}\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '转换剧本流程图配置格式',
'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'RunPython3Script' => [
- 'summary' => '用于提交一段python3的代码片段并执行，只能用于数据处理。',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertPlaybook'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:ConvertPlaybook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-****-*****-****-7263B435C316\\",\\n \\"Config\\": \\"{}\\"\\n}","type":"json"}]',
+ ],
+ 'CopyPlaybook' => [
+ 'summary' => '剧本复制。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -521,245 +287,145 @@
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '218814',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'PythonScript',
+ 'name' => 'DisplayName',
'in' => 'formData',
- 'schema' => [
- 'description' => 'python3的脚本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'import logging'."\n"
- .'def execute (params):'."\n"
- .' #ip = params[\'ip\']'."\n"
- .' #logging.info("enter execute,ip is "+ip)'."\n"
- .' success=True'."\n"
- .' message=\'OK\''."\n"
- .' data=[]'."\n"
- .' return (success,message,data)',
- ],
+ 'schema' => ['title' => '剧本展示名称', 'description' => '剧本展示名称。', 'type' => 'string', 'required' => true, 'example' => 'playbook_xxx'],
],
[
- 'name' => 'Params',
+ 'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'description' => 'python3脚本的入参。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "input1": "xx.xx.xx.xx",'."\n"
- .' "input2": "7d"'."\n"
- .'}',
- ],
+ 'schema' => ['title' => '剧本的描述', 'description' => '剧本的描述。', 'type' => 'string', 'required' => false, 'example' => 'playbook description'],
],
[
- 'name' => 'PlaybookUuid',
+ 'name' => 'SourcePlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx',
- ],
+ 'schema' => ['title' => '要复制的剧本uuid', 'description' => '要复制的剧本UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~3000306~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '94bc318c-****-4cba-****-801ccb0d739f'],
],
[
- 'name' => 'NodeName',
+ 'name' => 'ReleaseVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的节点名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'python3_3',
- ],
- ],
- [
- 'name' => 'PythonVersion',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'python版本。',
- 'description' => 'python版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'python2.0',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SophonResult<String>',
- 'description' => '返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'F210521C-D9BF-5264-8369-83EDDC617DB0',
- ],
- 'RunResult' => [
- 'title' => '传输的数据',
- 'description' => '运行脚本的结果数据。',
- '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' => '运行python3脚本',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- 'responseParamsDescription' => '**RunResult**参数为JSONObject格式，包含的字段为：'."\n"
- ."\n"
- .'- **requestUuid**：表示该次请求的UUID，用于查询运行日志'."\n"
- .'- **content**：表示脚本运行的结果，由用户定义',
- ],
- 'ComparePlaybooks' => [
- 'summary' => '用于比较发布的两个版本的剧本配置信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'schema' => ['title' => '要复制的剧本的taskflowMd5. 特殊取值：-1：代表现在编辑中的版本 0:当前剧本的线上最新发布版本(不传默认为0)', 'description' => '要复制剧本的发布版本，默认为0。 取值：'."\n"
+ .'- -1：代表正在编辑中的版本。'."\n"
+ ."\n"
+ .'- 0：当前剧本的线上最新发布版本。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
[
- 'name' => 'PlaybookUuid',
+ 'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本的UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'f916b93e-e814-459f-9662-xxxxx',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**：（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
- 'name' => 'OldPlaybookReleaseId',
+ 'name' => 'RoleType',
'in' => 'query',
- 'schema' => [
- 'title' => '老版本的ID',
- 'description' => '用于比较的第一个发布版本UUID。'."\n"
- .'>历史版本调用[DescribePlaybookReleases](~~DescribePlaybookReleases~~)接口可以获取该参数，新发布版本系统会自动生成。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => 'sflk23423-e814-459f-9662-xxxxx',
- ],
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- **0**（默认）：当前账号视图。'."\n"
+ ."\n"
+ .'- **1**：全局账号视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
- 'name' => 'NewPlaybookReleaseId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '新版本的ID',
- 'description' => '用于比较的第二个发布版本UUID。'."\n"
- .'>历史版本调用[DescribePlaybookReleases](~~DescribePlaybookReleases~~)接口可以获取该参数，新发布版本系统会自动生成。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => 'sfdf2395-e814-459f-9662-xxxxx',
- ],
- ],
- [
- 'name' => 'Lang',
+ 'name' => 'RoleFor',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602*****718726'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<CompareResult>',
- 'description' => '返回信息。',
+ 'title' => 'SophonResult<PlaybookCloudDTO>',
+ 'description' => 'SophonResult<PlaybookCloudDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A',
- ],
- 'CompareResult' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A'],
+ 'Data' => [
'title' => '传输的数据',
- 'description' => '比较结果。',
+ 'description' => '返回结果信息。',
'type' => 'object',
'properties' => [
- 'Same' => [
- 'description' => '两个版本是否相同的标记。'."\n"
- .'- **true**：相同。'."\n"
- .'- **false**：不相同。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'New' => [
- 'description' => '用于比较的第二个版本，是否为新增版本：'."\n"
- ."\n"
- .'- **true**：表示为新增版本。'."\n"
- .'- **false**：表示不是新增版本。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Description' => [
- 'description' => '比较结果的描述信息。',
- 'type' => 'string',
- 'example' => 'The first version adds one node compared to the second version',
- ],
+ 'DisplayName' => ['title' => '剧本的名称', 'description' => '复制后的剧本名称。', 'type' => 'string', 'example' => '11111'],
+ 'PlaybookUuid' => ['title' => '剧本的UUID', 'description' => '复制后剧本的UUID。', 'type' => 'string', 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx'],
+ 'OwnType' => ['title' => '剧本的权限类型', 'description' => '剧本的类型。取值：'."\n"
+ ."\n"
+ .'- preset：预定义剧本。'."\n"
+ ."\n"
+ .'- user：自定义剧本。', 'type' => 'string', 'example' => 'user'],
+ 'Active' => ['title' => '剧本的启用状态', 'description' => '剧本的启用状态。取值：'."\n"
+ ."\n"
+ .'- 1：剧本已启用。'."\n"
+ ."\n"
+ .'- 0：剧本未启用。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'LastRuntime' => ['title' => '剧本的最后执行时间', 'description' => '剧本的最后执行时间。格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1725258397847'],
+ 'Permission' => ['title' => '剧本是否可编辑', 'description' => '剧本的操作权限。取值：'."\n"
+ ."\n"
+ .'- 1：不可编辑，可查看'."\n"
+ ."\n"
+ .'- 2：可编辑', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'GmtCreate' => ['title' => '剧本创建时间', 'description' => '剧本创建时间。格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1655951601000'],
+ 'GmtModified' => ['title' => '剧本创建时间', 'description' => '剧本修改时间。格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1638270967000'],
+ 'HistoryMd5' => ['title' => '剧本历史版本数', 'description' => '剧本历史版本数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SuccNum' => ['title' => '剧本执行成功数', 'description' => '剧本执行成功数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FailNum' => ['title' => '剧本执行失败数', 'description' => '剧本执行失败数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FailRate' => ['title' => '剧本执行失败率', 'description' => '剧本执行失败率。', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
+ 'InputParams' => ['title' => '剧本的入参', 'description' => '剧本的入参。', 'type' => 'string', 'example' => '[{\\"name\\":\\"1\\",\\"dataType\\":\\"String\\",\\"required\\":false,\\"isArray\\":false,\\"example\\":\\"\\",\\"description\\":\\"\\",\\"id\\":0,\\"typeName\\":\\"String\\",\\"dataClass\\":\\"normal\\"}]'],
+ 'OutputParams' => ['title' => '剧本的出参', 'description' => '剧本的出参。', 'type' => 'string', 'example' => '[]'],
+ 'Description' => ['title' => '剧本描述', 'description' => '剧本描述。', 'type' => 'string', 'example' => 'This is a action of processing for WAF'],
+ 'LogicReleaseTaskflowMd5' => ['title' => '剧本的线上版本', 'description' => '剧本的线上版本MD5。', 'type' => 'string', 'example' => '037046****1b00c4717963818ccbf2xx'],
+ 'PlaybookStatus' => ['title' => '剧本描述', 'description' => '剧本状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TenantId' => ['title' => '剧本所属的租户', 'description' => '剧本所属的用户ID。', 'type' => 'string', 'example' => '13760*****8718726'],
+ ],
+ ],
+ 'Page' => [
+ 'description' => '分页查询信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '复制剧本',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyPlaybook'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:CopyPlaybook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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' => '比较剧本版本信息',
],
'CreatePlaybook' => [
'summary' => '用于创建一个初始化的剧本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -772,79 +438,43 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '167210',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'DisplayName',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本名称',
- 'description' => '剧本的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test09',
- ],
+ 'schema' => ['title' => '剧本名称', 'description' => '剧本的名称。', 'type' => 'string', 'required' => true, 'example' => 'test09'],
],
[
'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的描述',
- 'description' => '剧本的描述信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a new version',
- ],
+ 'schema' => ['title' => '剧本的描述', 'description' => '剧本的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'This is a new version'],
],
[
'name' => 'TaskflowType',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的配置格式。'."\n"
- .'- **xml**：XML格式。'."\n"
- .'- **x6**：JSON格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'x6',
- ],
+ 'schema' => ['description' => '剧本的配置格式。'."\n"
+ .'- **xml**：XML格式。'."\n"
+ .'- **x6**：JSON格式。', 'type' => 'string', 'required' => false, 'example' => 'x6'],
],
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'OutputParams',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本输出配置。',
- 'description' => '剧本输出配置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{\'result\': \'success\'}',
- ],
+ 'schema' => ['title' => '剧本输出配置。', 'description' => '剧本输出配置。', 'type' => 'string', 'required' => false, 'example' => '{\'result\': \'success\'}'],
],
[
'name' => 'InputParams',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本输入配置。',
- 'description' => '剧本输入配置。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{\'key1\': \'value1\', \'key2\': \'value2\'}',
- ],
+ 'schema' => ['title' => '剧本输入配置。', 'description' => '剧本输入配置。', 'type' => 'string', 'required' => false, 'example' => '{\'key1\': \'value1\', \'key2\': \'value2\'}'],
],
],
'responses' => [
@@ -854,43 +484,46 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'B09B40B2-F11E-512C-B755-423F2056C17B',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'B09B40B2-F11E-512C-B755-423F2056C17B'],
'Data' => [
'title' => '传输的数据',
'description' => '创建的返回结果。',
'type' => 'object',
'properties' => [
- 'PlaybookUuid' => [
- 'title' => '剧本唯一标识符。',
- 'description' => '新创建剧本的UUID。',
- 'type' => 'string',
- 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx',
- ],
+ 'PlaybookUuid' => ['title' => '剧本唯一标识符。', 'description' => '新创建剧本的UUID。', 'type' => 'string', 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B09B40B2-F11E-512C-B755-423F2056C17B\\",\\n \\"Data\\": {\\n \\"PlaybookUuid\\": \\"9e38111e-9794-4784-9ca8-xxxxxxx\\"\\n }\\n}","type":"json"}]',
'title' => '创建剧本',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlaybook'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:CreatePlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/*'],
+ ],
+ ],
+ ],
+ ],
],
'DebugPlaybook' => [
'summary' => '用于调试运行剧本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -898,63 +531,36 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'f916b93e-e814-459f-9662-xxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'f916b93e-e814-459f-9662-xxxxx'],
],
[
'name' => 'Record',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的入参',
- 'description' => '调试剧本时的输入参数，由用户自定义。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "param1":"a",'."\n"
- .' "param2":"b"'."\n"
- .'}',
- ],
+ 'schema' => ['title' => '剧本的入参', 'description' => '调试剧本时的输入参数，由用户自定义。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "param1":"a",'."\n"
+ .' "param2":"b"'."\n"
+ .'}'],
],
[
'name' => 'Taskflow',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本流程',
- 'description' => '剧本的xml配置。'."\n"
- .'>调用[DescribePlaybook](~~DescribePlaybook~~)接口可以获取该配置。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'."\n",
- ],
+ 'schema' => ['title' => '剧本流程', 'description' => '剧本的xml配置。'."\n"
+ .'>调用[DescribePlaybook](~~DescribePlaybook~~)接口可以获取该配置。', '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' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -964,35 +570,39 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF',
- ],
- 'RequestUuid' => [
- 'description' => '调试任务的运行UUID，可用于查询任务的运行结果等信息。',
- 'type' => 'string',
- 'example' => '6d412cfa-0905-4567-8a83-xxxxxx',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF'],
+ 'RequestUuid' => ['description' => '调试任务的运行UUID，可用于查询任务的运行结果等信息。', 'type' => 'string', 'example' => '6d412cfa-0905-4567-8a83-xxxxxx'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF\\",\\n \\"RequestUuid\\": \\"6d412cfa-0905-4567-8a83-xxxxxx\\"\\n}","type":"json"}]',
'title' => '调试剧本',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DebugPlaybook'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DebugPlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DeleteComponentAsset' => [
'summary' => '用于删除组件配置的资产信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1000,38 +610,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AssetId',
'in' => 'query',
- 'schema' => [
- 'title' => '资产的ID',
- 'description' => '组件的资产ID。'."\n"
- .'>调用[DescribeComponentAssets](~~DescribeComponentAssets~~)接口可以获取该参数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12x',
- ],
+ 'schema' => ['title' => '资产的ID', 'description' => '组件的资产ID。'."\n"
+ .'>调用[DescribeComponentAssets](~~DescribeComponentAssets~~)接口可以获取该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12x'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1041,30 +635,38 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '39C38A34-8532-5D44-B88A-7263B435C316',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '39C38A34-8532-5D44-B88A-7263B435C316'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-8532-5D44-B88A-7263B435C316\\"\\n}","type":"json"}]',
'title' => '删除资产信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentAsset'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DeleteComponentAsset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DeletePlaybook' => [
'summary' => '用于删除指定的自定义剧本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1076,36 +678,23 @@
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e99dab31-499b-4307-9248-xxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1115,30 +704,38 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]',
'title' => '删除剧本',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlaybook'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DeletePlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeComponentAssetForm' => [
'summary' => '用于获取组件的资产元信息，即资产信息是由哪些字段组成的。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1146,35 +743,20 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ComponentName',
'in' => 'query',
- 'schema' => [
- 'title' => '组件的名称',
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'python3',
- ],
+ 'schema' => ['title' => '组件的名称', 'description' => '组件的名称。', 'type' => 'string', 'required' => true, 'example' => 'python3'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1184,48 +766,51 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '9D1651AC-31CC-5CC4-A14E-626B3FCC1022',
- ],
- 'ComponentAssetForm' => [
- 'title' => '传输的数据',
- 'description' => '组件资产的配置元信息，为JSONArray格式，包含字段：'."\n"
- ."\n"
- .'- **name**：参数的名称'."\n"
- .'- **defaultValue**：参数的默认值'."\n"
- .'- **description**：参数描述信息'."\n"
- .'- **required**：参数是否必填，**true**表示必填，**false**表示非必填',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "defaultValue": "",'."\n"
- .' "description": "assetname",'."\n"
- .' "name": "assetname",'."\n"
- .' "required": true'."\n"
- .' }'."\n"
- .']',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '9D1651AC-31CC-5CC4-A14E-626B3FCC1022'],
+ 'ComponentAssetForm' => ['title' => '传输的数据', 'description' => '组件资产的配置元信息，为JSONArray格式，包含字段：'."\n"
+ ."\n"
+ .'- **name**：参数的名称'."\n"
+ .'- **defaultValue**：参数的默认值'."\n"
+ .'- **description**：参数描述信息'."\n"
+ .'- **required**：参数是否必填，**true**表示必填，**false**表示非必填', 'type' => 'string', 'example' => '['."\n"
+ .' {'."\n"
+ .' "defaultValue": "",'."\n"
+ .' "description": "assetname",'."\n"
+ .' "name": "assetname",'."\n"
+ .' "required": true'."\n"
+ .' }'."\n"
+ .']'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D1651AC-31CC-5CC4-A14E-626B3FCC1022\\",\\n \\"ComponentAssetForm\\": \\"[\\\\n {\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"assetname\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"assetname\\\\\\",\\\\n \\\\\\"required\\\\\\": true\\\\n }\\\\n]\\"\\n}","type":"json"}]',
'title' => '获取组件资产元信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssetForm'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeComponentAssetForm',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeComponentAssets' => [
'summary' => '用于获取某一组件的资产信息列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1233,34 +818,19 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ComponentName',
'in' => 'query',
- 'schema' => [
- 'title' => '组件的名称',
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'python3',
- ],
+ 'schema' => ['title' => '组件的名称', 'description' => '组件的名称。', 'type' => 'string', 'required' => true, 'example' => 'python3'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1270,12 +840,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F'],
'ComponentAssets' => [
'title' => '传输的数据',
'description' => '资产列表。',
@@ -1284,66 +849,31 @@
'description' => '资产信息。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => 'This field was generated by MyBatis Generator.',
- 'description' => '资产的唯一标识ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '7xx',
- ],
- 'GmtCreate' => [
- 'title' => 'This field was generated by MyBatis Generator.',
- 'description' => '资产的创建时间，格式为UTC格式，yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2023-03-23T14:38Z',
- ],
- 'GmtModified' => [
- 'title' => 'This field was generated by MyBatis Generator.',
- 'description' => '资产的修改时间，格式为UTC格式，yyyy-MM-ddTHH:mm:ssZ。',
- 'type' => 'string',
- 'example' => '2023-03-23T14:38Z',
- ],
- 'Name' => [
- 'title' => 'This field was generated by MyBatis Generator.',
- 'description' => '资产的名称。',
- 'type' => 'string',
- 'example' => 'test asset',
- ],
- 'Componentname' => [
- 'title' => 'This field was generated by MyBatis Generator.',
- 'description' => '资产所属的组件名称。',
- 'type' => 'string',
- 'example' => 'pyhton3',
- ],
- 'Params' => [
- 'title' => 'This field was generated by MyBatis Generator.',
- 'description' => '资产配置信息，为JSON格式。DescribeComponentAssetForm'."\n"
- .'>资产信息的格式通过[DescribeComponentAssetForm](~~DescribeComponentAssetForm~~)接口获取。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "name": "authMethod",'."\n"
- .' "value": "ak"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "name": "accessKeyId",'."\n"
- .' "value": "xxxxxxx"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "name": "accessKeySecret",'."\n"
- .' "value": "xxxxx"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "name": "roleArn",'."\n"
- .' "value": ""'."\n"
- .' }'."\n"
- .']',
- ],
- 'AssetUuid' => [
- 'description' => '资产的UUID。',
- 'type' => 'string',
- 'example' => 'ff6fe161-93e2-464c-a326-fxxxxxx',
- ],
+ 'Id' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => '资产的唯一标识ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '7xx'],
+ 'GmtCreate' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => '资产的创建时间，格式为UTC格式，yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2023-03-23T14:38Z'],
+ 'GmtModified' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => '资产的修改时间，格式为UTC格式，yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2023-03-23T14:38Z'],
+ 'Name' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => '资产的名称。', 'type' => 'string', 'example' => 'test asset'],
+ 'Componentname' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => '资产所属的组件名称。', 'type' => 'string', 'example' => 'pyhton3'],
+ 'Params' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => '资产配置信息，为JSON格式。DescribeComponentAssetForm'."\n"
+ .'>资产信息的格式通过[DescribeComponentAssetForm](~~DescribeComponentAssetForm~~)接口获取。', 'type' => 'string', 'example' => '['."\n"
+ .' {'."\n"
+ .' "name": "authMethod",'."\n"
+ .' "value": "ak"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name": "accessKeyId",'."\n"
+ .' "value": "xxxxxxx"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name": "accessKeySecret",'."\n"
+ .' "value": "xxxxx"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "name": "roleArn",'."\n"
+ .' "value": ""'."\n"
+ .' }'."\n"
+ .']'],
+ 'AssetUuid' => ['description' => '资产的UUID。', 'type' => 'string', 'example' => 'ff6fe161-93e2-464c-a326-fxxxxxx'],
],
],
],
@@ -1351,20 +881,33 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"Id\\": 0,\\n \\"GmtCreate\\": \\"2023-03-23T14:38Z\\",\\n \\"GmtModified\\": \\"2023-03-23T14:38Z\\",\\n \\"Name\\": \\"test asset\\",\\n \\"Componentname\\": \\"pyhton3\\",\\n \\"Params\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"authMethod\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ak\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"accessKeyId\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"xxxxxxx\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"accessKeySecret\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"xxxxx\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"roleArn\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"\\\\\\"\\\\n }\\\\n]\\",\\n \\"AssetUuid\\": \\"ff6fe161-93e2-464c-a326-fxxxxxx\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取组件的资产列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssets'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeComponentAssets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeComponentList' => [
'summary' => '用于获取用户可使用的普通组件的列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1372,37 +915,22 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1412,46 +940,34 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'B0A255B3-495C-56FB-8B6B-DB073F80388A',
- ],
- 'Components' => [
- 'title' => '传输的数据',
- 'description' => '组件信息，为JSONArray格式。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "actions": ['."\n"
- .' {'."\n"
- .' "description": "mysql component",'."\n"
- .' "name": "storeIdb",'."\n"
- .' "parameters": ['."\n"
- .' {'."\n"
- .' "description": "update the mysql db",'."\n"
- .' "name": "updateSql",'."\n"
- .' "required": false'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "basic": {'."\n"
- .' "description": "mysq sql component for 5.6",'."\n"
- .' "logo": "https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg",'."\n"
- .' "name": "Mysql"'."\n"
- .' }'."\n"
- .' }'."\n"
- .']',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'B0A255B3-495C-56FB-8B6B-DB073F80388A'],
+ 'Components' => ['title' => '传输的数据', 'description' => '组件信息，为JSONArray格式。', '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',
- ],
+ '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' => '获取组件列表',
'responseParamsDescription' => '**Components**参数为JSON格式，包含字段如下：'."\n"
@@ -1469,15 +985,30 @@
.'- **description**：组件的描述信息'."\n"
.'- **logo**：组件logo的地址信息'."\n"
.'- **name**：组件的名称',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeComponentList',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeComponentPlaybook' => [
'summary' => '用于获取用户可以使用的预定义组件列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1489,36 +1020,23 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ac343acc-1a61-4084-9a1cxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'ac343acc-1a61-4084-9a1cxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1528,12 +1046,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId。',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'C5F5D6C9-DF1A-5381-92B1-39676F777D20',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId。', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C5F5D6C9-DF1A-5381-92B1-39676F777D20'],
'Playbooks' => [
'title' => '传输的数据。',
'description' => '预定义组件列表。',
@@ -1543,51 +1056,31 @@
'description' => '预定义剧本信息。',
'type' => 'object',
'properties' => [
- 'DisplayName' => [
- 'title' => '剧本的名称。',
- 'description' => '预定义组件的名称。',
- 'type' => 'string',
- 'example' => 'AegisKillQuara',
- ],
- 'InputParams' => [
- 'title' => '剧本的入参。',
- 'description' => '剧本的入参配置，为JSONArray格式。'."\n"
- .'>参考[DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~)接口的格式说明。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "typeName": "String",'."\n"
- .' "dataClass": "normal",'."\n"
- .' "dataType": "String",'."\n"
- .' "description": "period",'."\n"
- .' "example": "",'."\n"
- .' "name": "period",'."\n"
- .' "required": false'."\n"
- .' }'."\n"
- .']',
- ],
- 'Description' => [
- 'title' => '剧本描述。',
- 'description' => '预定义组件的描述信息。',
- 'type' => 'string',
- 'example' => 'aegis_kill_process',
- ],
- 'ParamType' => [
- 'title' => '剧本的入参类型。'."\n"
- ."\n"
- .'template-ip：IP请求模板。'."\n"
- .'template-file：文件请求模板。'."\n"
- .'template-process：进程请求模板。'."\n"
- .'custom：自定义参数。',
- 'description' => '剧本的入参类型。'."\n"
- ."\n"
- .'template-ip：IP请求模板。'."\n"
- .'template-file：文件请求模板。'."\n"
- .'template-process：进程请求模板。'."\n"
- .'custom：自定义参数。',
- 'type' => 'string',
- 'example' => 'template-alert',
- ],
+ 'DisplayName' => ['title' => '剧本的名称。', 'description' => '预定义组件的名称。', 'type' => 'string', 'example' => 'AegisKillQuara'],
+ 'InputParams' => ['title' => '剧本的入参。', 'description' => '剧本的入参配置，为JSONArray格式。'."\n"
+ .'>参考[DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~)接口的格式说明。', 'type' => 'string', 'example' => '['."\n"
+ .' {'."\n"
+ .' "typeName": "String",'."\n"
+ .' "dataClass": "normal",'."\n"
+ .' "dataType": "String",'."\n"
+ .' "description": "period",'."\n"
+ .' "example": "",'."\n"
+ .' "name": "period",'."\n"
+ .' "required": false'."\n"
+ .' }'."\n"
+ .']'],
+ 'Description' => ['title' => '剧本描述。', 'description' => '预定义组件的描述信息。', 'type' => 'string', 'example' => 'aegis_kill_process'],
+ 'ParamType' => ['title' => '剧本的入参类型。'."\n"
+ ."\n"
+ .'template-ip：IP请求模板。'."\n"
+ .'template-file：文件请求模板。'."\n"
+ .'template-process：进程请求模板。'."\n"
+ .'custom：自定义参数。', 'description' => '剧本的入参类型。'."\n"
+ ."\n"
+ .'template-ip：IP请求模板。'."\n"
+ .'template-file：文件请求模板。'."\n"
+ .'template-process：进程请求模板。'."\n"
+ .'custom：自定义参数。', 'type' => 'string', 'example' => 'template-alert'],
],
],
],
@@ -1595,20 +1088,33 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5F5D6C9-DF1A-5381-92B1-39676F777D20\\",\\n \\"Playbooks\\": [\\n {\\n \\"DisplayName\\": \\"AegisKillQuara\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"Description\\": \\"aegis_kill_process\\",\\n \\"ParamType\\": \\"template-alert\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取预定义组件列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPlaybook'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeComponentPlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeComponentsJs' => [
'summary' => '用于获取组件的JS文件，组件会以返回的JS文件来进行页面的渲染。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1616,23 +1122,16 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1642,31 +1141,19 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073',
- ],
- 'ComponentsJs' => [
- 'title' => '传输的数据',
- 'description' => '组件JS文件的配置信息。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "js": "https://xxxxx.oss-cn-zhangjiakou.aliyuncs.com/componentUpload/xxxxx",'."\n"
- .' "name": "python3",'."\n"
- .' "ownType": "sys"'."\n"
- .' }'."\n"
- .']',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073'],
+ 'ComponentsJs' => ['title' => '传输的数据', 'description' => '组件JS文件的配置信息。', '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',
- ],
+ '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' => '获取组件的JS文件',
'responseParamsDescription' => '**ComponentsJs**参数为JSONArray格式，包含的字段如下：'."\n"
@@ -1674,15 +1161,30 @@
.'- **js**：表示JS文件的地址'."\n"
.'- **name**：表示组件的名称'."\n"
.'- **ownType**：表示组件的类型，暂时不开放基他类型的组件，固定为**sys**',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentsJs'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeComponentsJs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeDistinctReleases' => [
'summary' => '获取去重后的剧本发布的版本信息列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1695,47 +1197,28 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '172028',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'bc0b8424-535c-4ed5-bd94-xxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'bc0b8424-535c-4ed5-bd94-xxxxxx'],
],
[
'name' => 'TaskflowMd5',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本XML配置的MD5值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be0a4ef084dd174abe47xxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本XML配置的MD5值。', 'type' => 'string', 'required' => false, 'example' => 'be0a4ef084dd174abe47xxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1745,12 +1228,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '145CACF6-D276-5197-8549-CB1AD76E2AC8',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '145CACF6-D276-5197-8549-CB1AD76E2AC8'],
'Records' => [
'title' => '传输的数据',
'description' => '版本记录信息。',
@@ -1759,25 +1237,11 @@
'description' => '版本信息。',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'title' => '描述信息',
- 'description' => '版本的描述信息。',
- 'type' => 'string',
- 'example' => 'demo version',
- ],
- 'TaskflowMd5' => [
- 'title' => 'taskflow的MD5信息，用于比较是否 有变化',
- 'description' => '版本的XML配置的MD5值。',
- 'type' => 'string',
- 'example' => '17cf53049bc8efa941207xxxxx',
- ],
- 'TaskflowType' => [
- 'description' => '剧本的配置格式。'."\n"
- .'- **xml**：XML格式。'."\n"
- .'- **x6**：JSON格式。',
- 'type' => 'string',
- 'example' => 'x6',
- ],
+ 'Description' => ['title' => '描述信息', 'description' => '版本的描述信息。', 'type' => 'string', 'example' => 'demo version'],
+ 'TaskflowMd5' => ['title' => 'taskflow的MD5信息，用于比较是否 有变化', 'description' => '版本的XML配置的MD5值。', 'type' => 'string', 'example' => '17cf53049bc8efa941207xxxxx'],
+ 'TaskflowType' => ['description' => '剧本的配置格式。'."\n"
+ .'- **xml**：XML格式。'."\n"
+ .'- **x6**：JSON格式。', 'type' => 'string', 'example' => 'x6'],
],
],
],
@@ -1785,20 +1249,33 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"145CACF6-D276-5197-8549-CB1AD76E2AC8\\",\\n \\"Records\\": [\\n {\\n \\"Description\\": \\"demo version\\",\\n \\"TaskflowMd5\\": \\"17cf53049bc8efa941207xxxxx\\",\\n \\"TaskflowType\\": \\"x6\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取去重的版本列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistinctReleases'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeDistinctReleases',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeEnumItems' => [
'summary' => '用于获取产品需要的一些枚举信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1806,35 +1283,20 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'EnumType',
'in' => 'query',
- 'schema' => [
- 'title' => '枚举类型',
- 'description' => '枚举值的类型，支持的取值：'."\n"
- .'- **process**：表示处置场景枚举。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'process',
- ],
+ 'schema' => ['title' => '枚举类型', 'description' => '枚举值的类型，支持的取值：'."\n"
+ .'- **process**：表示处置场景枚举。', 'type' => 'string', 'required' => true, 'example' => 'process'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- .'- **zh_cn**：默认值，中文（简体）。'."\n"
- .'- **en_us**：英文（美国）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ .'- **zh_cn**：默认值，中文（简体）。'."\n"
+ .'- **en_us**：英文（美国）。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -1844,12 +1306,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'],
'Data' => [
'title' => '传输的数据',
'description' => '枚举信息。',
@@ -1858,16 +1315,8 @@
'description' => '枚举的键值对。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '枚举的KEY值。',
- 'type' => 'string',
- 'example' => 'system_xxxxx_process_book',
- ],
- 'Value' => [
- 'description' => '枚举的VALUE值。',
- 'type' => 'string',
- 'example' => 'system_xxxxx_process_book',
- ],
+ 'Key' => ['description' => '枚举的KEY值。', 'type' => 'string', 'example' => 'system_xxxxx_process_book'],
+ 'Value' => ['description' => '枚举的VALUE值。', 'type' => 'string', 'example' => 'system_xxxxx_process_book'],
],
],
],
@@ -1875,21 +1324,33 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"system_xxxxx_process_book\\",\\n \\"Value\\": \\"system_xxxxx_process_book\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取枚举信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnumItems'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeEnumItems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeExecutePlaybooks' => [
'summary' => '用于配置自动响应计划时，获取可执行的剧本列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1902,75 +1363,45 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '172464',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'InputMode',
'in' => 'query',
- 'schema' => [
- 'title' => '入参类型筛选',
- 'description' => '剧本入参的实体类型，当要想询多个实体类型时，以逗号分隔。'."\n"
- .'- **ip**：IP实体。'."\n"
- .'- **file**：文件实体。'."\n"
- .'- **process**：进程实体。'."\n"
- .'- **incident**：事件实体。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ip,file,process,host',
- ],
+ 'schema' => ['title' => '入参类型筛选', 'description' => '剧本入参的实体类型，当要想询多个实体类型时，以逗号分隔。'."\n"
+ .'- **ip**：IP实体。'."\n"
+ .'- **file**：文件实体。'."\n"
+ .'- **process**：进程实体。'."\n"
+ .'- **incident**：事件实体。', 'type' => 'string', 'required' => false, 'example' => 'ip,file,process,host'],
],
[
'name' => 'PlaybookName',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本的名字',
- 'description' => '剧本的名称，支持模糊搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo_test',
- ],
+ 'schema' => ['title' => '剧本的名字', 'description' => '剧本的名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'demo_test'],
],
[
'name' => 'Uuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本的UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f916b93e-e814-459f-9662-xxxxxx',
- ],
+ 'schema' => ['title' => '剧本的UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'ParamType',
'in' => 'query',
- 'schema' => [
- 'description' => '剧本的入参类型。'."\n"
- .'- **template-ip**：IP请求模板。'."\n"
- .'- **template-file**：文件请求模板。'."\n"
- .'- **template-process**：进程请求模板。'."\n"
- .'- **custom**：自定义参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'custom',
- ],
+ 'schema' => ['description' => '剧本的入参类型。'."\n"
+ .'- **template-ip**：IP请求模板。'."\n"
+ .'- **template-file**：文件请求模板。'."\n"
+ .'- **template-process**：进程请求模板。'."\n"
+ .'- **custom**：自定义参数。', 'type' => 'string', 'required' => false, 'example' => 'custom'],
],
],
'responses' => [
@@ -1980,12 +1411,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '88A39217-2802-5B1E-BA2B-CF1BBC43C1F5',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '88A39217-2802-5B1E-BA2B-CF1BBC43C1F5'],
'PlaybookMetrics' => [
'title' => '传输的数据',
'description' => '剧本列表。',
@@ -1994,46 +1420,26 @@
'description' => '剧本摘要信息。',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '剧本的描述信息。',
- 'type' => 'string',
- 'example' => 'a demo playbook',
- ],
- 'DisplayName' => [
- 'description' => '剧本的名称。',
- 'type' => 'string',
- 'example' => 'demo_playbook',
- ],
- 'Uuid' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'example' => 'c5c88b5e-97ca-435d-8c20-2xxxxx',
- ],
- 'ParamConfig' => [
- 'description' => '剧本的入参配置，为JSONArray格式。'."\n"
- .'>参考[DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~)接口的格式说明。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "typeName": "String",'."\n"
- .' "dataClass": "normal",'."\n"
- .' "dataType": "String",'."\n"
- .' "description": "period",'."\n"
- .' "example": "",'."\n"
- .' "name": "period",'."\n"
- .' "required": false'."\n"
- .' }'."\n"
- .']',
- ],
- 'ParamType' => [
- 'description' => '剧本的入参类型。'."\n"
- .'- **template-ip**：IP请求模板。'."\n"
- .'- **template-file**：文件请求模板。'."\n"
- .'- **template-process**：进程请求模板。'."\n"
- .'- **custom**：自定义参数。',
- 'type' => 'string',
- 'example' => 'custom',
- ],
+ 'Description' => ['description' => '剧本的描述信息。', 'type' => 'string', 'example' => 'a demo playbook'],
+ 'DisplayName' => ['description' => '剧本的名称。', 'type' => 'string', 'example' => 'demo_playbook'],
+ 'Uuid' => ['description' => '剧本的UUID。', 'type' => 'string', 'example' => 'c5c88b5e-97ca-435d-8c20-2xxxxx'],
+ 'ParamConfig' => ['description' => '剧本的入参配置，为JSONArray格式。'."\n"
+ .'>参考[DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~)接口的格式说明。', 'type' => 'string', 'example' => '['."\n"
+ .' {'."\n"
+ .' "typeName": "String",'."\n"
+ .' "dataClass": "normal",'."\n"
+ .' "dataType": "String",'."\n"
+ .' "description": "period",'."\n"
+ .' "example": "",'."\n"
+ .' "name": "period",'."\n"
+ .' "required": false'."\n"
+ .' }'."\n"
+ .']'],
+ 'ParamType' => ['description' => '剧本的入参类型。'."\n"
+ .'- **template-ip**：IP请求模板。'."\n"
+ .'- **template-file**：文件请求模板。'."\n"
+ .'- **template-process**：进程请求模板。'."\n"
+ .'- **custom**：自定义参数。', 'type' => 'string', 'example' => 'custom'],
],
],
],
@@ -2041,20 +1447,100 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88A39217-2802-5B1E-BA2B-CF1BBC43C1F5\\",\\n \\"PlaybookMetrics\\": [\\n {\\n \\"Description\\": \\"a demo playbook\\",\\n \\"DisplayName\\": \\"demo_playbook\\",\\n \\"Uuid\\": \\"c5c88b5e-97ca-435d-8c20-2xxxxx\\",\\n \\"ParamConfig\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"ParamType\\": \\"custom\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取可执行的剧本列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExecutePlaybooks'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeExecutePlaybooks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeField' => [
'summary' => '用于获取产品全局的，通用的配置信息。',
- 'methods' => [
- 'get',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'QueryKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '全局配置的KEY值', 'description' => '全局配置的KEY值，取值：'."\n"
+ ."\n"
+ .'- **soar_filed_tags**：可以获取剧本的输入模板。', 'type' => 'string', 'required' => true, 'example' => 'soar_filed_tags'],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'SophonResult<SystemConfigView>',
+ 'description' => '返回信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'BCDE6498-83CC-50A1-8307-3D5A539C42F8'],
+ 'Name' => ['description' => '全局配置的名称。', 'type' => 'string', 'example' => 'soar_filed_tags'],
+ 'Fields' => ['description' => '配置的内容。', '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' => '获取全局配置信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeField'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeField',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DescribeGroupProductions' => [
+ 'summary' => '获取阿里云产品的分组列表信息。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2066,77 +1552,125 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '203522',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'QueryKey',
+ 'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'title' => '全局配置的KEY值',
- 'description' => '全局配置的KEY值，取值：'."\n"
- ."\n"
- .'- **soar_filed_tags**：可以获取剧本的输入模板。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'soar_filed_tags',
- ],
+ 'schema' => ['description' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
- 'name' => 'Lang',
+ 'name' => 'RoleType',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- 0（默认）：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'query',
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11824150xxx50980'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<SystemConfigView>',
- 'description' => '返回信息。',
+ 'title' => 'SophonResult<List<ProductionGroup>>',
+ 'description' => 'SophonResult<List<ProductionGroup>>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'BCDE6498-83CC-50A1-8307-3D5A539C42F8',
- ],
- 'Name' => [
- 'description' => '全局配置的名称。',
- 'type' => 'string',
- 'example' => 'soar_filed_tags',
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '358E012F-B516-599D-9Exxx-A1A361CDE615'],
+ 'Data' => [
+ 'title' => '传输的数据',
+ 'description' => '返回的结果数据集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '单条数据信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => ['description' => '云产品名称。', 'type' => 'string', 'example' => 'Database'],
+ 'Productions' => [
+ 'description' => '产品信息集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '单个产品信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '云产品Code。', 'type' => 'string', 'example' => 'Rds'],
+ 'Name' => ['description' => '云产品名称。', 'type' => 'string', 'example' => 'ApsaraDB RDS'],
+ 'ShortName' => ['description' => '云产品简短名称。', 'type' => 'string', 'example' => 'RDS'],
+ 'Description' => ['description' => '云产品描述信息。', 'type' => 'string', 'example' => 'ApsaraDB'],
+ 'Group' => ['description' => '分组名称。', 'type' => 'string', 'example' => 'ApsaraDB'],
+ 'Versions' => [
+ 'description' => 'API版本集合。',
+ 'type' => 'array',
+ 'items' => ['description' => 'API版本。', 'type' => 'string', 'example' => '2014-08-15'],
+ ],
+ 'DefaultVersion' => ['description' => '默认版本。', 'type' => 'string', 'example' => '2014-08-15'],
+ 'DefaultDomain' => ['description' => '默认请求域名。', 'type' => 'string', 'example' => 'rds.aliyuncs.com'],
+ 'FullDomains' => [
+ 'description' => '所有域名。',
+ 'type' => 'array',
+ 'items' => ['description' => '请求域名。', 'type' => 'string', 'example' => 'rds.aliyuncs.com'],
+ ],
+ 'RamCode' => ['description' => '资源所属的pop的ramCode。', 'type' => 'string', 'example' => 'rds'],
+ 'Source' => ['description' => '产品的信息来源。', 'type' => 'string', 'example' => 'next'],
+ 'PolicyList' => [
+ 'title' => '产品的ram策略集合',
+ 'description' => '产品的ram策略集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'ram策略信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyName' => ['title' => 'ram策略名称', 'description' => 'ram策略名称。', 'type' => 'string', 'example' => 'AliyunRAMReadOnlyAccess'],
+ 'Type' => ['title' => 'ram策略类型（全部权限OR只读权限）', 'description' => 'ram策略类型。取值：'."\n"
+ .'- 全部权限'."\n"
+ .'- 只读权限', 'type' => 'string', 'example' => 'Read-only permission'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
- 'Fields' => [
- 'description' => '配置的内容。',
- 'type' => 'string',
- 'example' => '["ip","name","hostinfo","md5"]',
+ 'Page' => [
+ 'description' => '分页查询信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => '查询到的信息总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9Exxx-A1A361CDE615\\",\\n \\"Data\\": [\\n {\\n \\"GroupName\\": \\"Database\\",\\n \\"Productions\\": [\\n {\\n \\"Code\\": \\"Rds\\",\\n \\"Name\\": \\"ApsaraDB RDS\\",\\n \\"ShortName\\": \\"RDS\\",\\n \\"Description\\": \\"ApsaraDB\\",\\n \\"Group\\": \\"ApsaraDB\\",\\n \\"Versions\\": [\\n \\"2014-08-15\\"\\n ],\\n \\"DefaultVersion\\": \\"2014-08-15\\",\\n \\"DefaultDomain\\": \\"rds.aliyuncs.com\\",\\n \\"FullDomains\\": [\\n \\"rds.aliyuncs.com\\"\\n ],\\n \\"RamCode\\": \\"rds\\",\\n \\"Source\\": \\"next\\",\\n \\"PolicyList\\": [\\n {\\n \\"PolicyName\\": \\"AliyunRAMReadOnlyAccess\\",\\n \\"Type\\": \\"Read-only permission\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
+ 'title' => '获取阿里云产品的分组列表',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupProductions'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCDE6498-83CC-50A1-8307-3D5A539C42F8\\",\\n \\"Name\\": \\"soar_filed_tags\\",\\n \\"Fields\\": \\"[\\\\\\"ip\\\\\\",\\\\\\"name\\\\\\",\\\\\\"hostinfo\\\\\\",\\\\\\"md5\\\\\\"]\\"\\n}","type":"json"}]',
- 'title' => '获取全局配置信息',
+ 'ramActions' => [],
],
'DescribeLatestRecordSchema' => [
'summary' => '用于根据剧本最新一次的执行记录，动态生成剧本各节点的输出结构信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2148,35 +1682,22 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- ."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ ."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -2186,12 +1707,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9'],
'PlaybookNodeSchema' => [
'title' => '传输的数据',
'description' => '剧本输出结构信息。',
@@ -2204,29 +1720,13 @@
'description' => '结构信息。',
'type' => 'object',
'properties' => [
- 'NodeName' => [
- 'description' => '节点的名称。',
- 'type' => 'string',
- 'example' => 'DataFormat_1',
- ],
- 'ComponentName' => [
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'example' => 'DataFormat',
- ],
- 'ActionName' => [
- 'description' => '组件的动作名称。',
- 'type' => 'string',
- 'example' => 'formatedata',
- ],
+ 'NodeName' => ['description' => '节点的名称。', 'type' => 'string', 'example' => 'DataFormat_1'],
+ 'ComponentName' => ['description' => '组件的名称。', 'type' => 'string', 'example' => 'DataFormat'],
+ 'ActionName' => ['description' => '组件的动作名称。', 'type' => 'string', 'example' => 'formatedata'],
'OutputFields' => [
'description' => '输出字段',
'type' => 'array',
- 'items' => [
- 'description' => '输出字段的引用路径',
- 'type' => 'string',
- 'example' => 'play_group.datalist.*.ids',
- ],
+ 'items' => ['description' => '输出字段的引用路径', 'type' => 'string', 'example' => 'play_group.datalist.*.ids'],
],
],
],
@@ -2237,20 +1737,33 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\",\\n \\"PlaybookNodeSchema\\": {\\n \\"NodeSchema\\": [\\n {\\n \\"NodeName\\": \\"DataFormat_1\\",\\n \\"ComponentName\\": \\"DataFormat\\",\\n \\"ActionName\\": \\"formatedata\\",\\n \\"OutputFields\\": [\\n \\"play_group.datalist.*.ids\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取最新执行记录结构信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLatestRecordSchema'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeLatestRecordSchema',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeNodeParamTags' => [
'summary' => '用于编排剧本时，组件输入的可引用路径。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2258,46 +1771,25 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx'],
],
[
'name' => 'NodeName',
'in' => 'query',
- 'schema' => [
- 'title' => '组件节点名',
- 'description' => '组件节点名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'python3_2',
- ],
+ 'schema' => ['title' => '组件节点名', 'description' => '组件节点名称。', 'type' => 'string', 'required' => true, 'example' => 'python3_2'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -2307,12 +1799,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '6BE94351-712A-505D-A40A-BC77CC8254A9',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '6BE94351-712A-505D-A40A-BC77CC8254A9'],
'ParamReferredPaths' => [
'title' => '传输的数据',
'description' => '推荐的路径配置。',
@@ -2321,19 +1808,11 @@
'description' => '路径信息。',
'type' => 'object',
'properties' => [
- 'ParamName' => [
- 'description' => '上游节点名称。',
- 'type' => 'string',
- 'example' => 'DataFormat_1',
- ],
+ 'ParamName' => ['description' => '上游节点名称。', 'type' => 'string', 'example' => 'DataFormat_1'],
'ReferredPath' => [
'description' => '路径数组。',
'type' => 'array',
- 'items' => [
- 'description' => '引用路径配置。',
- 'type' => 'string',
- 'example' => 'filter_1.datalist.*.score',
- ],
+ 'items' => ['description' => '引用路径配置。', 'type' => 'string', 'example' => 'filter_1.datalist.*.score'],
],
],
],
@@ -2342,20 +1821,105 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BE94351-712A-505D-A40A-BC77CC8254A9\\",\\n \\"ParamReferredPaths\\": [\\n {\\n \\"ParamName\\": \\"DataFormat_1\\",\\n \\"ReferredPath\\": [\\n \\"filter_1.datalist.*.score\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取组件的推荐输入',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeParamTags'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeNodeParamTags',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
- 'DescribePlaybook' => [
- 'summary' => '用于获取剧本的xml配置信息。',
- 'methods' => [
- 'get',
+ 'DescribeNodeUsedInfos' => [
+ 'summary' => '用于获取剧本中，某一节点正在被哪些节点引用',
+ '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' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'ac343acc-1a61-4084-9a1c-xxxx'],
+ ],
+ [
+ 'name' => 'NodeName',
+ 'in' => 'query',
+ 'schema' => ['title' => '组件节点名', 'description' => '组件的节点名称。', 'type' => 'string', 'required' => true, 'example' => 'python3_2'],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ .'- **zh**：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'SophonResult<String>',
+ 'description' => '返回信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3B10F836-C2B1-54FA-AB59-7591B548FB59'],
+ 'NodeUsedInfos' => ['title' => '传输的数据', 'description' => '节点的引用信息，返回为JSON格式，包含的字段：'."\n"
+ ."\n"
+ .'- **action**：引用的动作，包含信息：'."\n"
+ .' - **name**：引用的节点名称'."\n"
+ .' - **inputParams**：引用的参数配置', 'type' => 'string', 'example' => '{'."\n"
+ .' "action": ['."\n"
+ .' {'."\n"
+ .' "name": "query_books",'."\n"
+ .' "inputParams": ['."\n"
+ .' {'."\n"
+ .' "referInfos": ['."\n"
+ .' "${play_group.datalist.*.ids}"'."\n"
+ .' ],'."\n"
+ .' "name": "querySql"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3B10F836-C2B1-54FA-AB59-7591B548FB59\\",\\n \\"NodeUsedInfos\\": \\"{\\\\n \\\\\\"action\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"query_books\\\\\\",\\\\n \\\\\\"inputParams\\\\\\": [\\\\n {\\\\n \\\\\\"referInfos\\\\\\": [\\\\n \\\\\\"${play_group.datalist.*.ids}\\\\\\"\\\\n ],\\\\n \\\\\\"name\\\\\\": \\\\\\"querySql\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n}\\"\\n}","type":"json"}]',
+ 'title' => '获取剧本节点的引用信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'DescribeNotifyTemplateList' => [
+ 'summary' => '查询通知消息模版列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2367,59 +1931,349 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeCode' => '225868',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'PlaybookUuid',
+ 'name' => 'Lang',
'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'RoleType',
+ 'in' => 'query',
+ 'schema' => ['description' => '视图类型，默认为0。取值：'."\n"
+ ."\n"
+ .'- 0：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'query',
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602425xxx8726'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '9030076b-6733-4842-b05a-xxxxx',
+ 'title' => 'SophonResult<List<NotifyTemplateDTO>>',
+ 'description' => 'SophonResult<List<NotifyTemplateDTO>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573'],
+ 'Data' => [
+ 'title' => '传输的数据',
+ 'description' => '返回的结果数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '单个结果数据内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TemplateName' => ['title' => '模版名称', 'description' => '模版名称。', 'type' => 'string', 'example' => 'incident generate'],
+ 'EventId' => ['title' => '模版对应的消息事件的id', 'description' => '模版对应的云鸽消息事件的ID。', 'type' => 'string', 'example' => 'yundun_soar_incident_generate'],
+ 'Subject' => ['title' => '模版的标题', 'description' => '模版的标题。', 'type' => 'string', 'example' => '[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)'],
+ 'Content' => ['title' => '模版的正文', 'description' => '模版的正文。', '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' => '模版的参数。', 'type' => 'string', 'example' => '[\\"aliyunUID\\",\\"incidentName\\",\\"incidentID\\",\\"startTime\\"]'],
+ ],
+ ],
+ ],
+ 'Page' => [
+ 'description' => '分页查询信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询模版列表',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNotifyTemplateList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeNotifyTemplateList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
+ ],
+ 'DescribeOpenApiInfo' => [
+ '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' => '阿里云产品接口的POP CODE。', 'type' => 'string', 'required' => true, 'example' => 'Sas'],
+ ],
+ [
+ 'name' => 'ApiVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'API的版本号。'."\n"
+ .'>调用[DescribeGroupProductions](~~DescribeGroupProductions~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '2018-12-03'],
+ ],
+ [
+ 'name' => 'ApiName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'API的名称。', 'type' => 'string', 'required' => true, 'example' => 'DescribePopApiItemList'],
+ ],
[
'name' => 'Lang',
'in' => 'query',
+ 'schema' => ['description' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'RoleType',
+ 'in' => 'query',
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- 0（默认）：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'query',
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1592757xxx002956'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- ."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
+ 'title' => 'SophonResult<APIDetailVO>',
+ 'description' => 'SophonResult<APIDetailVO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615'],
+ 'Data' => [
+ 'title' => '传输的数据',
+ 'description' => '返回的结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OutputParams' => ['description' => 'OPENAPI的输出参数。', 'type' => 'string', 'example' => '[]'],
+ 'InputParams' => ['description' => 'OPENAPI的输入参数。', 'type' => 'string', 'example' => '{}'],
+ 'ResponseDemo' => ['description' => '响应参数示例。', 'type' => 'string', 'example' => '[]'],
+ 'Title' => ['description' => 'OPENAPI标题。', 'type' => 'string', 'example' => 'describeEcs'],
+ 'Summary' => ['description' => 'OPENAPI概要。', 'type' => 'string', 'example' => 'describeEcs'],
+ 'Description' => ['description' => 'OPENAPI描述。', 'type' => 'string', 'example' => 'describeEcs'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询OPENAPI信息',
+ 'summary' => '获取产品接口的详情。',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiInfo'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TaskflowMd5',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeOpenApiInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
+ ],
+ 'DescribeOpenApiList' => [
+ 'summary' => '获取产品的接口列表。',
+ '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' => '阿里云产品接口的POP CODE。', 'type' => 'string', 'required' => true, 'example' => 'Sas'],
+ ],
+ [
+ 'name' => 'ApiVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'API的版本号。'."\n"
+ .'>调用[DescribeGroupProductions](~~DescribeGroupProductions~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '2021-10-01'],
+ ],
+ [
+ 'name' => 'ApiName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'API的名称。', 'type' => 'string', 'required' => false, 'example' => 'DescribePopApiItemList'],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'RoleType',
+ 'in' => 'query',
+ 'schema' => ['description' => '视图类型，默认为0。取值：'."\n"
+ ."\n"
+ .'- 0：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'RoleFor',
'in' => 'query',
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602xxx8718726'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '剧本配置的MD5值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7a8f608dc64c242632aa578xxxxx',
+ 'title' => 'SophonResult<APITreeBO>',
+ 'description' => 'SophonResult<APITreeBO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2'],
+ 'Data' => [
+ 'title' => '传输的数据',
+ 'description' => '返回的结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应CODE。取值：'."\n"
+ .'- 200：成功'."\n"
+ .'- 500：失败', 'type' => 'string', 'example' => '200'],
+ 'Version' => ['description' => 'API版本号。', 'type' => 'string', 'example' => '2018-12-03'],
+ 'Directories' => ['description' => '返回的API列表内容。', 'type' => 'any', 'example' => '[{"apis":[{"summary":"get account information","deprecated":false,"name":"DescAccountSummary","title":"get account information"}],"childrens":[],"title":"account"}]'],
+ 'Versions' => ['title' => '支持的版本列表', 'description' => '支持的版本列表', 'type' => 'any', 'example' => '["2018-12-03" ]'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2\\",\\n \\"Data\\": {\\n \\"Code\\": \\"200\\",\\n \\"Version\\": \\"2018-12-03\\",\\n \\"Directories\\": \\"[{\\\\\\"apis\\\\\\":[{\\\\\\"summary\\\\\\":\\\\\\"get account information\\\\\\",\\\\\\"deprecated\\\\\\":false,\\\\\\"name\\\\\\":\\\\\\"DescAccountSummary\\\\\\",\\\\\\"title\\\\\\":\\\\\\"get account information\\\\\\"}],\\\\\\"childrens\\\\\\":[],\\\\\\"title\\\\\\":\\\\\\"account\\\\\\"}]\\",\\n \\"Versions\\": \\"[\\\\\\"2018-12-03\\\\\\" ]\\"\\n }\\n}","type":"json"}]',
+ 'title' => '查询OPENAPI列表',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeOpenApiList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'DescribePlaybook' => [
+ 'summary' => '用于获取剧本的xml配置信息。',
+ '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' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '9030076b-6733-4842-b05a-xxxxx'],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ ."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'TaskflowMd5',
+ 'in' => 'query',
+ 'schema' => ['description' => '剧本配置的MD5值。', 'type' => 'string', 'required' => false, 'example' => '7a8f608dc64c242632aa578xxxxx'],
+ ],
[
'name' => 'DebugFlag',
'in' => 'query',
- 'schema' => [
- 'description' => '线上版本与调试版本的标记，取值：'."\n"
- ."\n"
- .'- **1**：表示获取调试版本'."\n"
- .'- **0**：表示获取线上发布版本',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '线上版本与调试版本的标记，取值：'."\n"
+ ."\n"
+ .'- **1**：表示获取调试版本'."\n"
+ .'- **0**：表示获取线上发布版本', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
],
'responses' => [
@@ -2429,129 +2283,78 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '2989BC59-E9F0-5C83-B453-B368857649C8',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '2989BC59-E9F0-5C83-B453-B368857649C8'],
'Playbook' => [
'title' => '传输的数据',
'description' => '剧本的配置信息。',
'type' => 'object',
'properties' => [
- 'GmtCreate' => [
- 'description' => '剧本的创建时间，格式：13位的时间戳。',
- 'type' => 'string',
- 'example' => '1665288858000',
- ],
- 'GmtModified' => [
- 'description' => '剧本的修改时间，格式：13位的时间戳。',
- 'type' => 'string',
- 'example' => '1677482519000',
- ],
- 'PlaybookUuid' => [
- 'description' => '剧本UUID。',
- 'type' => 'string',
- 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx',
- ],
- 'Taskflow' => [
- 'description' => '剧本的XML配置。',
- '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' => [
- 'description' => '剧本的配置格式。'."\n"
- .'- **xml**：XML格式。'."\n"
- .'- **x6**：JSON格式。',
- 'type' => 'string',
- 'example' => 'xml',
- ],
- 'OwnType' => [
- 'description' => '剧本的类型，取值：'."\n"
- ."\n"
- .'- **preset**：预定义剧本。'."\n"
- .'- **user**：自定义剧本。',
- 'type' => 'string',
- 'example' => 'preset',
- ],
- 'SuccessExeNum' => [
- 'description' => '剧本成功运行次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'FailExeNum' => [
- 'description' => '剧本失败运行次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'LastExeTime' => [
- 'description' => '剧本的最后运行时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1665288858000',
- ],
- 'DisplayName' => [
- 'description' => '剧本的展示名称。',
- 'type' => 'string',
- 'example' => 'demo_test',
- ],
- 'InputParams' => [
- 'description' => '剧本的入参配置，为JSONArray格式。'."\n"
- .'>参考[DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~)接口的格式说明。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "typeName": "String",'."\n"
- .' "dataClass": "normal",'."\n"
- .' "dataType": "String",'."\n"
- .' "description": "period",'."\n"
- .' "example": "",'."\n"
- .' "name": "period",'."\n"
- .' "required": false'."\n"
- .' }'."\n"
- .']',
- ],
- 'Description' => [
- 'description' => '剧本的描述信息。',
- 'type' => 'string',
- 'example' => 'demo playbook',
- ],
- 'OnlineActive' => [
- 'description' => '剧本的启停标记，取值：'."\n"
- ."\n"
- .'- **0**：表示剧本已停止'."\n"
- .'- **1**：表示剧本已启用',
- 'type' => 'boolean',
- 'example' => '0',
- ],
- 'OnlineReleaseTaskflowMd5' => [
- 'description' => '剧本最新发布版本的MD5值。',
- 'type' => 'string',
- 'example' => 'asdfsdfe232-e2b2-44fd-b2cc-xxxxx',
- ],
+ 'GmtCreate' => ['description' => '剧本的创建时间，格式：13位的时间戳。', 'type' => 'string', 'example' => '1665288858000'],
+ 'GmtModified' => ['description' => '剧本的修改时间，格式：13位的时间戳。', 'type' => 'string', 'example' => '1677482519000'],
+ 'PlaybookUuid' => ['description' => '剧本UUID。', 'type' => 'string', 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx'],
+ 'Taskflow' => ['description' => '剧本的XML配置。', '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' => ['description' => '剧本的配置格式。'."\n"
+ .'- **xml**：XML格式。'."\n"
+ .'- **x6**：JSON格式。', 'type' => 'string', 'example' => 'xml'],
+ 'OwnType' => ['description' => '剧本的类型，取值：'."\n"
+ ."\n"
+ .'- **preset**：预定义剧本。'."\n"
+ .'- **user**：自定义剧本。', 'type' => 'string', 'example' => 'preset'],
+ 'SuccessExeNum' => ['description' => '剧本成功运行次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'FailExeNum' => ['description' => '剧本失败运行次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'LastExeTime' => ['description' => '剧本的最后运行时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1665288858000'],
+ 'DisplayName' => ['description' => '剧本的展示名称。', 'type' => 'string', 'example' => 'demo_test'],
+ 'InputParams' => ['description' => '剧本的入参配置，为JSONArray格式。'."\n"
+ .'>参考[DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~)接口的格式说明。', 'type' => 'string', 'example' => '['."\n"
+ .' {'."\n"
+ .' "typeName": "String",'."\n"
+ .' "dataClass": "normal",'."\n"
+ .' "dataType": "String",'."\n"
+ .' "description": "period",'."\n"
+ .' "example": "",'."\n"
+ .' "name": "period",'."\n"
+ .' "required": false'."\n"
+ .' }'."\n"
+ .']'],
+ 'Description' => ['description' => '剧本的描述信息。', 'type' => 'string', 'example' => 'demo playbook'],
+ 'OnlineActive' => ['description' => '剧本的启停标记，取值：'."\n"
+ ."\n"
+ .'- **0**：表示剧本已停止'."\n"
+ .'- **1**：表示剧本已启用', 'type' => 'boolean', 'example' => '0'],
+ 'OnlineReleaseTaskflowMd5' => ['description' => '剧本最新发布版本的MD5值。', 'type' => 'string', 'example' => 'asdfsdfe232-e2b2-44fd-b2cc-xxxxx'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2989BC59-E9F0-5C83-B453-B368857649C8\\",\\n \\"Playbook\\": {\\n \\"GmtCreate\\": \\"1665288858000\\",\\n \\"GmtModified\\": \\"1677482519000\\",\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"Taskflow\\": \\"<?xml version=\\\\\\"1.0\\\\\\" encoding=\\\\\\"UTF-8\\\\\\"?><bpmn:definitions xmlns:xsi=\\\\\\"http://www.w3.org/2001/XMLSchema-instance\\\\\\" xmlns:bpmn=\\\\\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\\\\\" xmlns:bpmndi=\\\\\\"http://www.omg.org/spec/BPMN/20100524/DI\\\\\\" xmlns:dc=\\\\\\"http://www.omg.org/spec/DD/20100524/DC\\\\\\" targetNamespace=\\\\\\"http://bpmn.io/schema/bpmn\\\\\\" id=\\\\\\"Definitions_1\\\\\\"><bpmn:process id=\\\\\\"Process_1\\\\\\" isExecutable=\\\\\\"false\\\\\\"><bpmn:startEvent id=\\\\\\"StartEvent_1\\\\\\"/></bpmn:process><bpmndi:BPMNDiagram id=\\\\\\"BPMNDiagram_1\\\\\\"><bpmndi:BPMNPlane id=\\\\\\"BPMNPlane_1\\\\\\" bpmnElement=\\\\\\"Process_1\\\\\\"><bpmndi:BPMNShape id=\\\\\\"_BPMNShape_StartEvent_2\\\\\\" bpmnElement=\\\\\\"StartEvent_1\\\\\\"><dc:Bounds height=\\\\\\"36.0\\\\\\" width=\\\\\\"36.0\\\\\\" x=\\\\\\"173.0\\\\\\" y=\\\\\\"102.0\\\\\\"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>\\",\\n \\"TaskflowType\\": \\"xml\\",\\n \\"OwnType\\": \\"preset\\",\\n \\"SuccessExeNum\\": 100,\\n \\"FailExeNum\\": 1,\\n \\"LastExeTime\\": 1665288858000,\\n \\"DisplayName\\": \\"demo_test\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"Description\\": \\"demo playbook\\",\\n \\"OnlineActive\\": true,\\n \\"OnlineReleaseTaskflowMd5\\": \\"asdfsdfe232-e2b2-44fd-b2cc-xxxxx\\"\\n }\\n}","type":"json"}]',
'title' => '获取剧本配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybook'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribePlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribePlaybookInputOutput' => [
'summary' => '用于获取剧本的输入参数与输出参数的配置信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2564,35 +2367,22 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '167574',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- ."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ ."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -2602,72 +2392,41 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '688B4CCD-5272-5DCF-9D76-FE5EFEF545F8',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '688B4CCD-5272-5DCF-9D76-FE5EFEF545F8'],
'Config' => [
'title' => '传输的数据',
'description' => '配置信息。',
'type' => 'object',
'properties' => [
- 'ParamType' => [
- 'title' => '输入类型',
- 'description' => '剧本的入参类型。'."\n"
- .'- **template-ip**：IP请求模板。'."\n"
- .'- **template-file**：文件请求模板。'."\n"
- .'- **template-process**：进程请求模板。'."\n"
- .'- **custom**：自定义参数。',
- 'type' => 'string',
- 'example' => 'custom',
- ],
- 'ExeConfig' => [
- 'title' => '输入类型',
- 'description' => '剧本的执行方式，为JSONObject格式。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "executeMode":"mul",'."\n"
- .' "cron":"0 0 1 */1 * ?"'."\n"
- .'}',
- ],
- 'InputParams' => [
- 'title' => '入参配置',
- 'description' => '剧本的入参配置，为JSONArray格式。',
- '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' => '剧本暂不支持出参配置，固定为空值。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'PlaybookUuid' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'example' => '9030076b-6733-4842-b05a-xxxxxx',
- ],
+ 'ParamType' => ['title' => '输入类型', 'description' => '剧本的入参类型。'."\n"
+ .'- **template-ip**：IP请求模板。'."\n"
+ .'- **template-file**：文件请求模板。'."\n"
+ .'- **template-process**：进程请求模板。'."\n"
+ .'- **custom**：自定义参数。', 'type' => 'string', 'example' => 'custom'],
+ 'ExeConfig' => ['title' => '输入类型', 'description' => '剧本的执行方式，为JSONObject格式。', 'type' => 'string', 'example' => '{'."\n"
+ .' "executeMode":"mul",'."\n"
+ .' "cron":"0 0 1 */1 * ?"'."\n"
+ .'}'],
+ 'InputParams' => ['title' => '入参配置', 'description' => '剧本的入参配置，为JSONArray格式。', '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' => '剧本暂不支持出参配置，固定为空值。', 'type' => 'string', 'example' => '[]'],
+ 'PlaybookUuid' => ['description' => '剧本的UUID。', 'type' => 'string', 'example' => '9030076b-6733-4842-b05a-xxxxxx'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"688B4CCD-5272-5DCF-9D76-FE5EFEF545F8\\",\\n \\"Config\\": {\\n \\"ParamType\\": \\"custom\\",\\n \\"ExeConfig\\": \\"{\\\\n \\\\\\"executeMode\\\\\\":\\\\\\"mul\\\\\\",\\\\n \\\\\\"cron\\\\\\":\\\\\\"0 0 1 */1 * ?\\\\\\"\\\\n}\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"OutputParams\\": \\"[]\\",\\n \\"PlaybookUuid\\": \\"9030076b-6733-4842-b05a-xxxxxx\\"\\n }\\n}","type":"json"}]',
'title' => '获取剧本的出入参数配置',
'responseParamsDescription' => '**InputParams**为JSONArray格式，具体参数说明：'."\n"
@@ -2678,15 +2437,30 @@
.'- example：参数的示例。'."\n"
.'- name：参数名称。'."\n"
.'- required：参数是否必填，可选值，**true**表示必填，**false**表示不必填',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookInputOutput'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribePlaybookInputOutput',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribePlaybookMetrics' => [
'summary' => '获取某一剧本的元信息，包括名字、描述、运行次数、失败率等。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2694,35 +2468,20 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2a687089-d4dd-47d4-9709-xxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '2a687089-d4dd-47d4-9709-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -2732,108 +2491,61 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73'],
'Metrics' => [
'title' => '传输的数据',
'description' => '剧本的信息详情。',
'type' => 'object',
'properties' => [
- 'DisplayName' => [
- 'title' => '剧本的名称',
- 'description' => '剧本的名称。',
- 'type' => 'string',
- 'example' => 'demo name',
- ],
- 'PlaybookUuid' => [
- 'title' => '剧本的UUID',
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'example' => '0fbc9bdb-9ae3-4ef4-a709-xxxxx',
- ],
- 'OwnType' => [
- 'title' => '剧本的权限类型',
- 'description' => '剧本的类型，取值：'."\n"
- ."\n"
- .'- **preset**：预定义剧本。'."\n"
- .'- **user**：自定义剧本。',
- 'type' => 'string',
- 'example' => 'user',
- ],
- 'Active' => [
- 'title' => '剧本的启用状态',
- 'description' => '剧本的启用状态，取值：'."\n"
- ."\n"
- .'- **1**：表示剧本已启用。'."\n"
- .'- **0**：表示剧本未启用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'LastRuntime' => [
- 'title' => '剧本的最后执行时间',
- 'description' => '剧本的最后执行时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1683526277415',
- ],
- 'GmtCreate' => [
- 'title' => '剧本创建时间',
- 'description' => '剧本创建时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1655277397000',
- ],
- 'HistoryMd5' => [
- 'title' => '剧本历史版本数',
- 'description' => '剧本历史版本个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'SuccNum' => [
- 'title' => '剧本执行成功数',
- 'description' => '剧本任务执行成功数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'FailNum' => [
- 'title' => '剧本执行失败数',
- 'description' => '剧本任务执行失败数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Description' => [
- 'description' => '剧本的描述信息。',
- 'type' => 'string',
- 'example' => 'This is a playbook for waf processing',
- ],
+ 'DisplayName' => ['title' => '剧本的名称', 'description' => '剧本的名称。', 'type' => 'string', 'example' => 'demo name'],
+ 'PlaybookUuid' => ['title' => '剧本的UUID', 'description' => '剧本的UUID。', 'type' => 'string', 'example' => '0fbc9bdb-9ae3-4ef4-a709-xxxxx'],
+ 'OwnType' => ['title' => '剧本的权限类型', 'description' => '剧本的类型，取值：'."\n"
+ ."\n"
+ .'- **preset**：预定义剧本。'."\n"
+ .'- **user**：自定义剧本。', 'type' => 'string', 'example' => 'user'],
+ 'Active' => ['title' => '剧本的启用状态', 'description' => '剧本的启用状态，取值：'."\n"
+ ."\n"
+ .'- **1**：表示剧本已启用。'."\n"
+ .'- **0**：表示剧本未启用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'LastRuntime' => ['title' => '剧本的最后执行时间', 'description' => '剧本的最后执行时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683526277415'],
+ 'GmtCreate' => ['title' => '剧本创建时间', 'description' => '剧本创建时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1655277397000'],
+ 'HistoryMd5' => ['title' => '剧本历史版本数', 'description' => '剧本历史版本个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'SuccNum' => ['title' => '剧本执行成功数', 'description' => '剧本任务执行成功数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'FailNum' => ['title' => '剧本执行失败数', 'description' => '剧本任务执行失败数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Description' => ['description' => '剧本的描述信息。', 'type' => 'string', 'example' => 'This is a playbook for waf processing'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Metrics\\": {\\n \\"DisplayName\\": \\"demo name\\",\\n \\"PlaybookUuid\\": \\"0fbc9bdb-9ae3-4ef4-a709-xxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1683526277415,\\n \\"GmtCreate\\": 1655277397000,\\n \\"HistoryMd5\\": 10,\\n \\"SuccNum\\": 100,\\n \\"FailNum\\": 10,\\n \\"Description\\": \\"This is a playbook for waf processing\\"\\n }\\n}","type":"json"}]',
'title' => '获取剧本的元信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookMetrics'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribePlaybookMetrics',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribePlaybookNodesOutput' => [
'summary' => '用于获取组件输出的历史数据。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2841,47 +2553,26 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ac343acc-1a61-4084-9a1c-xxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'ac343acc-1a61-4084-9a1c-xxxxx'],
],
[
'name' => 'NodeName',
'in' => 'query',
- 'schema' => [
- 'title' => '组件节点名',
- 'description' => '组件节点名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DataFormat_1',
- ],
+ 'schema' => ['title' => '组件节点名', 'description' => '组件节点名称。', 'type' => 'string', 'required' => true, 'example' => 'DataFormat_1'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- ."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ ."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -2891,51 +2582,36 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'A491170C-FE1F-520E-83D4-72ED205B72ED',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'A491170C-FE1F-520E-83D4-72ED205B72ED'],
'PlaybookNodesOutput' => [
'title' => '传输的数据',
'description' => '节点输出数据。',
'type' => 'object',
'properties' => [
- 'NodeName' => [
- 'description' => '剧本的节点名称。',
- 'type' => 'string',
- 'example' => 'DataFormat_1',
- ],
- 'NodeOutput' => [
- 'description' => '组件输出的历史数据，为JSON格式，如果不存在，则为空。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "datalist": ['."\n"
- .' {'."\n"
- .' "score": "10",'."\n"
- .' "ip": "1.1.1.1"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "total_data_successful": 1,'."\n"
- .' "filter_total_data": 1,'."\n"
- .' "total_data": 1,'."\n"
- .' "total_exe_successful": 1,'."\n"
- .' "total_exe": 1,'."\n"
- .' "total_data_with_dup": 1,'."\n"
- .' "filter_total_data_successful": 1,'."\n"
- .' "status": true'."\n"
- .'}',
- ],
+ 'NodeName' => ['description' => '剧本的节点名称。', 'type' => 'string', 'example' => 'DataFormat_1'],
+ 'NodeOutput' => ['description' => '组件输出的历史数据，为JSON格式，如果不存在，则为空。', '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',
- ],
+ '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' => '获取组件输出的历史数据',
'responseParamsDescription' => '**NodeOutput**为JSONObject格式，包含的字段说明：'."\n"
@@ -2946,16 +2622,30 @@
.' - **total_exe**：总执行次数'."\n"
.' - **total_data_with_dup**：重复的数据次数'."\n"
.' - **status**：执行是否成功，**true**表示成功，**false**表示失败',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNodesOutput'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribePlaybookNodesOutput',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribePlaybookNumberMetrics' => [
'summary' => '用于获取响应编排产品的统计信息，包含剧本数量、启用数量等内容。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2963,21 +2653,14 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -2992,43 +2675,42 @@
'description' => '统计信息。',
'type' => 'object',
'properties' => [
- 'TotalNum' => [
- 'description' => '剧本总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'StartUpNum' => [
- 'description' => '启用剧本数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
+ 'TotalNum' => ['description' => '剧本总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'StartUpNum' => ['description' => '启用剧本数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
],
],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B',
- ],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metrics\\": {\\n \\"TotalNum\\": 100,\\n \\"StartUpNum\\": 50\\n },\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\"\\n}","type":"json"}]',
'title' => '获取响应编排统计信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNumberMetrics'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribePlaybookNumberMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribePlaybookReleases' => [
'summary' => '用于获取剧本发布的线上版本的信息列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3036,58 +2718,31 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ac343acc-1a61-4084-9a1c-xxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。', 'type' => 'string', 'required' => true, 'example' => 'ac343acc-1a61-4084-9a1c-xxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- ."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ ."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
- .'> 建议PageSize取值不要为空。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
+ .'> 建议PageSize取值不要为空。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
@@ -3097,12 +2752,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3DFBE11C-6EB6-5166-92D6-3397796AFE1E',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3DFBE11C-6EB6-5166-92D6-3397796AFE1E'],
'Records' => [
'title' => '传输的数据',
'description' => '剧本的版本信息列表。',
@@ -3111,44 +2761,12 @@
'description' => '版本信息。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '记录 ID',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '80xxx',
- ],
- 'GmtCreate' => [
- 'title' => '创建时间',
- 'description' => '版本创建时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1655277397000',
- ],
- 'GmtModified' => [
- 'title' => '修改时间',
- 'description' => '版本修改时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1691460804000',
- ],
- 'Creator' => [
- 'title' => '创建人',
- 'description' => '发布版本的阿里云账户ID。',
- 'type' => 'string',
- 'example' => '145xxxx985',
- ],
- 'Description' => [
- 'title' => '描述信息',
- 'description' => '版本的描述信息。',
- 'type' => 'string',
- 'example' => 'This is a new version',
- ],
- 'TaskflowMd5' => [
- 'title' => 'taskflow的MD5信息，用于比较是否 有变化',
- 'description' => '发布版本的剧本配置的MD5值。',
- 'type' => 'string',
- 'example' => 'be0a4ef084dd174abe47xxxxx',
- ],
+ 'Id' => ['description' => '记录 ID', 'type' => 'integer', 'format' => 'int32', 'example' => '80xxx'],
+ 'GmtCreate' => ['title' => '创建时间', 'description' => '版本创建时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1655277397000'],
+ 'GmtModified' => ['title' => '修改时间', 'description' => '版本修改时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1691460804000'],
+ 'Creator' => ['title' => '创建人', 'description' => '发布版本的阿里云账户ID。', 'type' => 'string', 'example' => '145xxxx985'],
+ 'Description' => ['title' => '描述信息', 'description' => '版本的描述信息。', 'type' => 'string', 'example' => 'This is a new version'],
+ 'TaskflowMd5' => ['title' => 'taskflow的MD5信息，用于比较是否 有变化', 'description' => '发布版本的剧本配置的MD5值。', 'type' => 'string', 'example' => 'be0a4ef084dd174abe47xxxxx'],
],
],
],
@@ -3156,44 +2774,42 @@
'description' => '页面显示的信息。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '查询到的信息总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'TotalCount' => ['description' => '查询到的信息总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3DFBE11C-6EB6-5166-92D6-3397796AFE1E\\",\\n \\"Records\\": [\\n {\\n \\"Id\\": 0,\\n \\"GmtCreate\\": 1655277397000,\\n \\"GmtModified\\": 1691460804000,\\n \\"Creator\\": \\"145xxxx985\\",\\n \\"Description\\": \\"This is a new version\\",\\n \\"TaskflowMd5\\": \\"be0a4ef084dd174abe47xxxxx\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => '获取剧本发布的版本列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookReleases'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribePlaybookReleases',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribePlaybooks' => [
'summary' => '用于获取剧本列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3206,176 +2822,96 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '167066',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Active',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本的状态',
- 'description' => '剧本的启用状态，取值：'."\n"
- ."\n"
- .'- **1**：表示剧本已启用。'."\n"
- .'- **0**：表示剧本未启用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '剧本的状态', 'description' => '剧本的启用状态，取值：'."\n"
+ ."\n"
+ .'- **1**：表示剧本已启用。'."\n"
+ .'- **0**：表示剧本未启用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'OwnType',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本的类型',
- 'description' => '剧本的类型，取值：'."\n"
- ."\n"
- .'- **preset**：预定义剧本。'."\n"
- .'- **user**：自定义剧本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
+ 'schema' => ['title' => '剧本的类型', 'description' => '剧本的类型，取值：'."\n"
+ ."\n"
+ .'- **preset**：预定义剧本。'."\n"
+ .'- **user**：自定义剧本。', 'type' => 'string', 'required' => false, 'example' => 'user'],
],
[
'name' => 'StartMillis',
'in' => 'query',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => '查询的开始时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1683526277415',
- ],
+ 'schema' => ['title' => '开始时间', 'description' => '查询的开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526277415'],
],
[
'name' => 'EndMillis',
'in' => 'query',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => '查询的结束时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1683858064361',
- ],
+ 'schema' => ['title' => '结束时间', 'description' => '查询的结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683858064361'],
],
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[CreatePlaybook](~~CreatePlaybook~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[CreatePlaybook](~~CreatePlaybook~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本名称',
- 'description' => '剧本的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo_playbook',
- ],
+ 'schema' => ['title' => '剧本名称', 'description' => '剧本的名称。', 'type' => 'string', 'required' => false, 'example' => 'demo_playbook'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- .'- **zh**：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ .'- **zh**：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
- .'> 建议PageSize取值不要为空。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
+ .'> 建议PageSize取值不要为空。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'Sort',
'in' => 'query',
- 'schema' => [
- 'description' => '排序依据，默认为**1**。取值：'."\n"
- .'- **1**：上次修改时间。'."\n"
- .'- **2**：最近执行时间。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '排序依据，默认为**1**。取值：'."\n"
+ .'- **1**：上次修改时间。'."\n"
+ .'- **2**：最近执行时间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Order',
'in' => 'query',
- 'schema' => [
- 'title' => '排序逻辑：desc asc,默认desc',
- 'description' => '排序逻辑，默认为**desc**，取值：'."\n"
- .'- **desc** ：降序排序。'."\n"
- .'- **asc**：升序排序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desc',
- ],
+ 'schema' => ['title' => '排序逻辑：desc asc,默认desc', 'description' => '排序逻辑，默认为**desc**，取值：'."\n"
+ .'- **desc** ：降序排序。'."\n"
+ .'- **asc**：升序排序。', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
'name' => 'ParamTypes',
'in' => 'query',
- 'schema' => [
- 'description' => '剧本触发方式，默认为**查询所有**。取值：'."\n"
- .'- **template-incident**：安全事件。'."\n"
- .'- **template-ip**： IP实体。'."\n"
- .'- **template-file**：文件实体。'."\n"
- .'- **template-process**：进程实体。'."\n"
- .'- **template-alert**：安全告警。'."\n"
- .'- **template-domain**：域名实体。'."\n"
- .'- **template-container**：容器实体。'."\n"
- .'- **template-host**：主机实体。'."\n"
- .'- **template-custom**：自定义。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'template-alert',
- ],
+ 'schema' => ['description' => '剧本触发方式，默认为**查询所有**。取值：'."\n"
+ .'- **template-incident**：安全事件。'."\n"
+ .'- **template-ip**： IP实体。'."\n"
+ .'- **template-file**：文件实体。'."\n"
+ .'- **template-process**：进程实体。'."\n"
+ .'- **template-alert**：安全告警。'."\n"
+ .'- **template-domain**：域名实体。'."\n"
+ .'- **template-container**：容器实体。'."\n"
+ .'- **template-host**：主机实体。'."\n"
+ .'- **template-custom**：自定义。', 'type' => 'string', 'required' => false, 'example' => 'template-alert'],
],
[
'name' => 'PlaybookUuids',
'in' => 'query',
- 'schema' => [
- 'description' => '剧本的UUID的集合，最多支持100个，多个用逗号隔开。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx',
- ],
+ 'schema' => ['description' => '剧本的UUID的集合，最多支持100个，多个用逗号隔开。', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx'],
],
],
'responses' => [
@@ -3385,12 +2921,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '138B5AB7-****-5814-87A3-E3E****F207E',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '138B5AB7-****-5814-87A3-E3E****F207E'],
'Playbooks' => [
'title' => '传输的数据',
'description' => '剧本的列表。',
@@ -3399,81 +2930,31 @@
'description' => '剧本的信息。',
'type' => 'object',
'properties' => [
- 'DisplayName' => [
- 'title' => '剧本的名称',
- 'description' => '剧本的展示名称。',
- 'type' => 'string',
- 'example' => 'demo_playbook',
- ],
- 'PlaybookUuid' => [
- 'title' => '剧本的UUID',
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx',
- ],
- 'OwnType' => [
- 'title' => '剧本的权限类型',
- 'description' => '剧本的类型，取值：'."\n"
- ."\n"
- .'- **preset**：预定义剧本。'."\n"
- .'- **user**：自定义剧本。',
- 'type' => 'string',
- 'example' => 'user',
- ],
- 'Active' => [
- 'title' => '剧本的启用状态',
- 'description' => '剧本的状态标识。取值：'."\n"
- ."\n"
- .'- **1**：表示启动剧本。'."\n"
- ."\n"
- .'- **0**：表示停止剧本。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'LastRuntime' => [
- 'title' => '剧本的最后执行时间',
- 'description' => '剧本的最后执行时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1683526277415',
- ],
- 'GmtCreate' => [
- 'title' => '剧本创建时间',
- 'description' => '剧本创建时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1683526277415',
- ],
- 'GmtModified' => [
- 'title' => '剧本修改时间',
- 'description' => '剧本修改时间。',
- 'type' => 'string',
- 'example' => '1681396398000',
- ],
- 'ParamType' => [
- 'description' => '剧本触发方式，默认为**查询所有**。取值：'."\n"
- .'- **template-incident**：安全事件。'."\n"
- .'- **template-ip**：IP实体。'."\n"
- .'- **template-file**：文件实体。'."\n"
- .'- **template-process**：进程实体。'."\n"
- .'- **template-alert**：安全告警。'."\n"
- .'- **template-domain**：域名实体。'."\n"
- .'- **template-container**：容器实体。'."\n"
- .'- **template-host**：主机实体。',
- 'type' => 'string',
- 'example' => 'template-alert',
- ],
- 'Description' => [
- 'description' => '剧本的描述信息。',
- 'type' => 'string',
- 'example' => 'aegis_kill_process',
- ],
- 'TenantId' => [
- 'description' => '剧本所属的用户ID。',
- 'type' => 'string',
- 'example' => '123456',
- ],
+ 'DisplayName' => ['title' => '剧本的名称', 'description' => '剧本的展示名称。', 'type' => 'string', 'example' => 'demo_playbook'],
+ 'PlaybookUuid' => ['title' => '剧本的UUID', 'description' => '剧本的UUID。', 'type' => 'string', 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx'],
+ 'OwnType' => ['title' => '剧本的权限类型', 'description' => '剧本的类型，取值：'."\n"
+ ."\n"
+ .'- **preset**：预定义剧本。'."\n"
+ .'- **user**：自定义剧本。', 'type' => 'string', 'example' => 'user'],
+ 'Active' => ['title' => '剧本的启用状态', 'description' => '剧本的状态标识。取值：'."\n"
+ ."\n"
+ .'- **1**：表示启动剧本。'."\n"
+ ."\n"
+ .'- **0**：表示停止剧本。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'LastRuntime' => ['title' => '剧本的最后执行时间', 'description' => '剧本的最后执行时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683526277415'],
+ 'GmtCreate' => ['title' => '剧本创建时间', 'description' => '剧本创建时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683526277415'],
+ 'GmtModified' => ['title' => '剧本修改时间', 'description' => '剧本修改时间。', 'type' => 'string', 'example' => '1681396398000'],
+ 'ParamType' => ['description' => '剧本触发方式，默认为**查询所有**。取值：'."\n"
+ .'- **template-incident**：安全事件。'."\n"
+ .'- **template-ip**：IP实体。'."\n"
+ .'- **template-file**：文件实体。'."\n"
+ .'- **template-process**：进程实体。'."\n"
+ .'- **template-alert**：安全告警。'."\n"
+ .'- **template-domain**：域名实体。'."\n"
+ .'- **template-container**：容器实体。'."\n"
+ .'- **template-host**：主机实体。', 'type' => 'string', 'example' => 'template-alert'],
+ 'Description' => ['description' => '剧本的描述信息。', 'type' => 'string', 'example' => 'aegis_kill_process'],
+ 'TenantId' => ['description' => '剧本所属的用户ID。', 'type' => 'string', 'example' => '123456'],
],
],
],
@@ -3481,33 +2962,16 @@
'description' => '分页查询信息。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '查询到的信息总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'TotalCount' => ['description' => '查询到的信息总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
@@ -3515,15 +2979,29 @@
'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' => '获取剧本列表',
'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'DescribePopApi' => [
- 'summary' => '用于获取OpenAPI的接口详情。',
- 'methods' => [
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybooks'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribePlaybooks',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribePopApi' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3535,40 +3013,23 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PopCode',
'in' => 'query',
- 'schema' => [
- 'description' => '阿里云产品接口的POP CODE。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Sas',
- ],
+ 'schema' => ['description' => '阿里云产品接口的POP CODE。', 'type' => 'string', 'required' => true, 'example' => 'Sas'],
],
[
'name' => 'ApiVersion',
'in' => 'query',
- 'schema' => [
- 'description' => 'API的版本号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2021-10-01',
- ],
+ 'schema' => ['description' => 'API的版本号。', 'type' => 'string', 'required' => true, 'example' => '2021-10-01'],
],
[
'name' => 'ApiName',
'in' => 'query',
- 'schema' => [
- 'description' => '阿里云产品API名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DescribeInstanceInfo',
- ],
+ 'schema' => ['description' => '阿里云产品API名称。', 'type' => 'string', 'required' => true, 'example' => 'DescribeInstanceInfo'],
],
],
'responses' => [
@@ -3578,27 +3039,10 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE',
- ],
- 'PopCode' => [
- 'description' => '阿里云产品接口的POP CODE。',
- 'type' => 'string',
- 'example' => 'Sas',
- ],
- 'Version' => [
- 'description' => 'API版本号。',
- 'type' => 'string',
- 'example' => '2019-09-10',
- ],
- 'ApiName' => [
- 'description' => 'API的名称。',
- 'type' => 'string',
- 'example' => 'AddAssetCleanConfig',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE'],
+ 'PopCode' => ['description' => '阿里云产品接口的POP CODE。', 'type' => 'string', 'example' => 'Sas'],
+ 'Version' => ['description' => 'API版本号。', 'type' => 'string', 'example' => '2019-09-10'],
+ 'ApiName' => ['description' => 'API的名称。', 'type' => 'string', 'example' => 'AddAssetCleanConfig'],
'OpenApiMetaList' => [
'description' => 'API的信息列表。',
'type' => 'array',
@@ -3606,42 +3050,27 @@
'description' => '信息详情。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '参数名称。',
- 'type' => 'string',
- 'example' => 'DescribePopApi',
- ],
- 'Required' => [
- 'description' => '该参数是否必填。'."\n"
- ."\n"
- .'- **true**：必填。'."\n"
- .'- **false**：非必填。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ExampleValue' => [
- 'description' => '示例值。',
- 'type' => 'string',
- 'example' => '12.xx.xx.xx',
- ],
- 'Description' => [
- 'description' => '参数的描述。',
- 'type' => 'string',
- 'example' => 'demo parameter',
- ],
- 'Type' => [
- 'description' => '参数字段的数据类型，取值如下：'."\n"
- ."\n"
- .'- **string**：字符串。'."\n"
- .'- **boolean**：布尔值。'."\n"
- .'- **integer**：整型。'."\n"
- .'- **long**：长整型。',
- 'type' => 'string',
- 'example' => 'string',
- ],
- 'Style' => [
- 'type' => 'string',
- ],
+ 'Name' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'DescribePopApi'],
+ 'Required' => ['description' => '该参数是否必填。'."\n"
+ ."\n"
+ .'- **true**：必填。'."\n"
+ .'- **false**：非必填。', 'type' => 'boolean', 'example' => 'false'],
+ 'ExampleValue' => ['description' => '示例值。', 'type' => 'string', 'example' => '12.xx.xx.xx'],
+ 'Description' => ['description' => '参数的描述。', 'type' => 'string', 'example' => 'demo parameter'],
+ 'Type' => ['description' => '参数字段的数据类型，取值如下：'."\n"
+ ."\n"
+ .'- **string**：字符串。'."\n"
+ .'- **boolean**：布尔值。'."\n"
+ .'- **integer**：整型。'."\n"
+ .'- **long**：长整型。', 'type' => 'string', 'example' => 'string'],
+ 'Style' => ['description' => '参数序列化方式，取值如下：'."\n"
+ ."\n"
+ .'- **repeatList**：repeatList 数组的序列化方式为XXX.N的形式，例如Instance.1=i-instance1&&Instance.2=i-instance2。'."\n"
+ .'- **simple**：simple 数组的序列化方式为逗号分隔，例如i-instance1,i-instance2。'."\n"
+ .'- **spaceDelimited**：spaceDelimited数组的序列化方式为空格分隔，例如i-instance1 i-instance2。'."\n"
+ .'- **pipeDelimited**：pipeDelimited 数组的序列化方式为竖杠 | 分隔，例如i-instance1|i-instance2。'."\n"
+ .'- **json**：json数组的序列化方式为json，例如["i-instance1","i-instance2"]。'."\n"
+ .'- **flat**：flat 数组的序列化方式为XXX.N的形式，例如Instance.1=i-instance1&Instance.2=i-instance2。', 'type' => 'string', 'example' => 'json'],
],
],
],
@@ -3649,20 +3078,123 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PopCode\\": \\"Sas\\",\\n \\"Version\\": \\"2019-09-10\\",\\n \\"ApiName\\": \\"AddAssetCleanConfig\\",\\n \\"OpenApiMetaList\\": [\\n {\\n \\"Name\\": \\"DescribePopApi\\",\\n \\"Required\\": false,\\n \\"ExampleValue\\": \\"12.xx.xx.xx\\",\\n \\"Description\\": \\"demo parameter\\",\\n \\"Type\\": \\"string\\",\\n \\"Style\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取OpenAPI接口详情',
+ 'summary' => '用于获取OpenAPI的接口详情',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T01:38:42.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-04-08T09:37:47.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePopApi'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribePopApi',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PopCode\\": \\"Sas\\",\\n \\"Version\\": \\"2019-09-10\\",\\n \\"ApiName\\": \\"AddAssetCleanConfig\\",\\n \\"OpenApiMetaList\\": [\\n {\\n \\"Name\\": \\"DescribePopApi\\",\\n \\"Required\\": false,\\n \\"ExampleValue\\": \\"12.xx.xx.xx\\",\\n \\"Description\\": \\"demo parameter\\",\\n \\"Type\\": \\"string\\",\\n \\"Style\\": \\"json\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'DescribeSoarRecordActionOutputList' => [
- 'summary' => '用于获取剧本任务中，某一组件执行动作时，输出的数据列表。',
- 'methods' => [
- 'get',
+ 'DescribeProcessStatistics' => [
+ 'summary' => '获取统计信息。',
+ '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' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'RoleType',
+ 'in' => 'query',
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- 0（默认）：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'query',
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'string', 'required' => false, 'example' => '1709821xxxxx3093'],
+ ],
+ [
+ 'name' => 'ProcessActionStart',
+ 'in' => 'query',
+ 'schema' => ['description' => '处置任务的查询开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17000XXX83572'],
+ ],
+ [
+ 'name' => 'ProcessActionEnd',
+ 'in' => 'query',
+ 'schema' => ['description' => '处置任务的查询结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17561XXX77435'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'SophonResult<ProcessMetricsDTO>',
+ 'description' => 'SophonResult<ProcessMetricsDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F'],
+ 'Metrics' => [
+ 'title' => '传输的数据',
+ 'description' => '返回的结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskNum' => ['description' => '处置任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'BanIpNum' => ['description' => '封禁IP数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'BanFileNum' => ['description' => '封禁文件数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'BanProcessNum' => ['description' => '封禁进程数量。', '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' => '获取处置任务的统计信息',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessStatistics'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'DescribeProcessTaskCount' => [
+ 'summary' => '通过实体UUID查询关联的处置任务数。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3674,119 +3206,440 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '245000',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ActionUuid',
+ 'name' => 'EntityUuidList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '动作的UUID',
- 'description' => '组件动作的UUID。'."\n"
- .'>调用[DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~)接口可以获取该参数。',
- 'type' => 'string',
+ 'title' => '实体的entityUuid集合',
+ 'description' => '实体的UUID集合。',
+ 'type' => 'array',
+ 'items' => ['description' => '实体UUID。', 'type' => 'string', 'required' => false, 'example' => 'a680c9ae-****-4c39-****-0302****fc8e'],
'required' => true,
- 'example' => '2202c90d-fa93-4726-bc32-xxxxxx',
+ 'maxItems' => 100,
],
],
[
'name' => 'Lang',
'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'RoleType',
+ 'in' => 'query',
+ 'schema' => ['description' => '视图类型。'."\n"
+ ."\n"
+ .'- **0**：当前阿里云账号视图。'."\n"
+ .'- **1**：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'query',
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '104739******259'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
+ 'title' => 'SophonResult<List<ProcessTaskNumberDTO>>',
+ 'description' => '返回信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'e866cce0-****-41de-817e-****8d5e2650'],
+ 'Data' => [
+ 'title' => '传输的数据',
+ 'description' => '传输的数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '结果集。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EntityUuid' => ['title' => '实体uuid', 'description' => '实体UUID。', 'type' => 'string', 'example' => 'a680c9ae-****-4c39-****-0302****fc8e'],
+ 'Count' => ['title' => '数量', 'description' => '数量。', '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' => '通过实体UUID查询关联的处置任务数',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTaskCount'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeProcessTaskNumber',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DescribeProcessTasks' => [
+ 'summary' => '用于获取处置任务的列表信息',
+ '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' => '处置策略的UUID。'."\n"
+ .'>调用[ListDisposeStrategy](~~2584440~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_****'],
+ ],
+ [
+ 'name' => 'EntityName',
+ 'in' => 'query',
+ 'schema' => ['title' => '实体的名称', 'description' => '处置的实体的名称。', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'],
+ ],
+ [
+ 'name' => 'EntityType',
+ 'in' => 'query',
+ 'schema' => ['title' => '实体的类型', 'description' => '处置的实体类型，取值：'."\n"
+ ."\n"
+ .'- **ip**：表示IP类型实体。'."\n"
+ .'- **file**：表示文件类型实体。'."\n"
+ .'- **process**：表示进程类型实体。', 'type' => 'string', 'required' => false, 'example' => 'ip'],
+ ],
+ [
+ 'name' => 'SceneCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '处置场景', 'description' => '处置任务的场景CODE。'."\n"
+ .'>调用[DescribeEnumItems](~~DescribeEnumItems~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => 'event_xxx_whole_process'],
+ ],
+ [
+ 'name' => 'TaskStatus',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务状态 list', 'description' => '处置任务的状态列表，为数据字符串的格式，取值：'."\n"
+ ."\n"
+ .'- **11**：表示处置中。'."\n"
+ .'- **21**：表示封禁中。'."\n"
+ .'- **22**：表示隔离中。'."\n"
+ .'- **23**：已结束。'."\n"
+ .'- **24**：已加白。'."\n"
+ .'- **20**：成功。'."\n"
+ .'- **90**：失败。'."\n"
+ .'- **91**：解封失败。'."\n"
+ .'- **92**：解除隔离失败。', 'type' => 'string', 'required' => false, 'example' => '["11","21"]'],
+ ],
+ [
+ 'name' => 'Scope',
+ 'in' => 'query',
+ 'schema' => ['title' => '作用域', 'description' => '处置的阿里云账户ID。', 'type' => 'string', 'required' => false, 'example' => '125xxxxx9870'],
+ ],
+ [
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['title' => '处置来源 list', 'description' => '处置任务的触发来源，为数组字符串格式，取值：'."\n"
+ ."\n"
+ .'- **system**：手动处置事件触发。'."\n"
+ .'- **custom**：自动响应规则，事件触发。'."\n"
+ .'- **custom_alert**：自动响应规则，告警触发。'."\n"
+ .'- **soar-manual**：SOAR手动调用剧本触发。'."\n"
+ .'- **soar-mdr**：由安全管家服务触发。', 'type' => 'string', 'required' => false, 'example' => '["system"]'],
+ ],
+ [
+ 'name' => 'ProcessActionStart',
+ 'in' => 'query',
+ 'schema' => ['title' => '处置时间的查询开始时间', 'description' => '处置时间的查询开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1700031183572'],
+ ],
+ [
+ 'name' => 'ProcessActionEnd',
+ 'in' => 'query',
+ 'schema' => ['title' => '处置时间的查询结束时间', 'description' => '处置时间的查询结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1700031183572'],
+ ],
+ [
+ 'name' => 'ProcessRemoveStart',
+ 'in' => 'query',
+ 'schema' => ['title' => '解封时间的查询开始时间', 'description' => '解封时间的查询开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1700031183572'],
+ ],
+ [
+ 'name' => 'ProcessRemoveEnd',
+ 'in' => 'query',
+ 'schema' => ['title' => '解封时间的查询结束时间', 'description' => '解封时间的查询结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1700031183572'],
+ ],
+ [
+ 'name' => 'ParamContent',
+ 'in' => 'query',
+ 'schema' => ['title' => '模糊查询', 'description' => '模糊匹配，会查询实体、处置场景、处置参数字段。', 'type' => 'string', 'required' => false, 'example' => '12.x.x.x'],
+ ],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
- .'> 建议PageSize取值不要为空。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
+ .'> 建议PageSize取值不要为空。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'YunCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '处置任务关联的云产品，为数据字符串格式，取值：'."\n"
+ ."\n"
+ .'- **WAF**：表示Web应用防火墙。'."\n"
+ .'- **CFW**：表示云防火墙。'."\n"
+ .'- **Aegis**：表示云安全中心。', 'type' => 'string', 'required' => false, 'example' => '["WAF"]'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '处置任务的唯一标识。'."\n"
+ ."\n"
+ .'> 用于查询某具体任务，参数可由接口的返回值中获取。', 'type' => 'string', 'required' => false, 'example' => '150xxxxxxxxx95066'],
+ ],
+ [
+ 'name' => 'OrderField',
+ 'in' => 'query',
+ 'schema' => ['description' => '结果的排序字段。'."\n"
+ ."\n"
+ .'> 排序的字段，由接口的返回结果中获取。', 'type' => 'string', 'required' => false, 'example' => 'gmtCreate'],
+ ],
+ [
+ 'name' => 'Direction',
+ 'in' => 'query',
+ 'schema' => ['description' => '排序方向，取值：'."\n"
+ ."\n"
+ .'- **desc**：递减（默认）。'."\n"
+ .'- **asc**：递增。', 'type' => 'string', 'required' => false, 'example' => 'desc'],
+ ],
+ [
+ 'name' => 'EntityUuid',
+ 'in' => 'query',
+ 'schema' => ['title' => '实体UUID', 'description' => '实体UUID。', 'type' => 'string', 'required' => false, 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n"],
+ ],
+ [
+ 'name' => 'EventUuid',
+ 'in' => 'query',
+ 'schema' => ['description' => '事件UUID。', 'type' => 'string', 'required' => false, 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****'],
+ ],
+ [
+ 'name' => 'TriggerSource',
+ 'in' => 'query',
+ 'schema' => ['description' => '处置任务的触发来源，取值：'."\n"
+ ."\n"
+ .'- **system**：手动处置事件触发。'."\n"
+ .'- **custom**：自动响应规则，事件触发。'."\n"
+ .'- **custom_alert**：自动响应规则，告警触发。'."\n"
+ .'- **soar-manual**：SOAR手动调用剧本触发。'."\n"
+ .'- **soar-mdr**：由安全管家服务触发。', 'type' => 'string', 'required' => false, 'example' => 'system'],
+ ],
+ [
+ 'name' => 'ReqUuid',
+ 'in' => 'query',
+ 'schema' => ['description' => '剧本触发ID。', 'type' => 'string', 'required' => false, 'example' => 'b73d0b08-f1bd-4e8f-967a-8e2982c9****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<String>',
+ 'title' => 'SophonResult<List<ProcessTaskDTO>>',
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90',
- ],
- 'ActionOutputs' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'],
+ 'ProcessTasks' => [
'title' => '传输的数据',
- 'description' => '组件动作执行时的输出数据，为JSONArray格式。'."\n"
- ."\n"
- .'> 输出数据的具体格式，由编写剧本时配置的组件来确定。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "a": "a",'."\n"
- .' "taskname": "92af3c79-1754-4646-9366-9ddbd1e45536_xxxx",'."\n"
- .' "log_time": 1699868849000'."\n"
- .' }'."\n"
- .']',
- ],
- 'PageNumber' => [
- 'description' => '当前分页的页码数。默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页展示时，每个分页包含的列表条目数。默认为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
+ 'description' => '处置任务列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '处置任务详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '处置任务的唯一标识。', 'type' => 'string', 'example' => '150xxxxxxxxx95066'],
+ 'Creator' => ['title' => '任务的创建人', 'description' => '提交处置任务的阿里云账户ID。', 'type' => 'string', 'example' => '123xxxx355'],
+ 'GmtCreateMillis' => ['title' => '任务创建时间', 'description' => '处置任务的创建时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1700031183572'],
+ 'GmtModifiedMillis' => ['title' => '任务修复时间', 'description' => '处置任务的修改时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1700031183572'],
+ 'YunCode' => ['title' => '关联产品', 'description' => '处置任务关联的云产品CODE。', 'type' => 'string', 'example' => 'WAF'],
+ 'EntityName' => ['title' => '处置的实体名称', 'description' => '处置的实体名称。', 'type' => 'string', 'example' => '1.1.1.x'],
+ 'EntityType' => ['title' => '处置的实体类型', 'description' => '处置的实体类型。', 'type' => 'string', 'example' => 'ip'],
+ 'TaskStatus' => ['title' => '任务状态', 'description' => '处置任务的状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
+ 'Scope' => ['title' => '作战域', 'description' => '处置的阿里云账户ID。', 'type' => 'string', 'example' => '123xxxxx234'],
+ 'InputParams' => ['title' => '任务的入参', 'description' => '处置任务的输入参数。', 'type' => 'string', 'example' => '{"groupuuid":"c6a9b1df-f4ac-4078-bef4-99xxxxxx"}'],
+ 'SceneCode' => ['title' => '处置场景', 'description' => '处置任务的场景CODE。', 'type' => 'string', 'example' => 'event_xxx_whole_process'],
+ 'SceneName' => ['title' => '处置场景名称', 'description' => '处置任务的场景名称。', 'type' => 'string', 'example' => 'waf_whole_process'],
+ 'ProcessTime' => ['title' => '处置时间', 'description' => '处置任务的下发时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1700031183572'],
+ 'RemoveTime' => ['title' => '解除时间', 'description' => '处置任务的解封时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1700031183572'],
+ 'ProcessStrategyUuid' => ['title' => '关联的策略ID', 'description' => '关联的策略ID。', 'type' => 'string', 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_****'],
+ 'Source' => ['description' => '处置任务的提交来源。', 'type' => 'string', 'example' => 'system'],
+ 'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'sts_openapi.Info.DefenseSceneNotSupported'],
+ 'ErrMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'ParamError : The parameters of your request are invalid'],
+ 'ErrTip' => ['description' => '错误提示。', 'type' => 'string', 'example' => 'Verify that the input parameters of the components are correct'],
+ 'EntityUuid' => ['description' => '实体UUID。', 'type' => 'string', 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n"],
+ 'EventUuid' => ['description' => '事件UUID。', 'type' => 'string', 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****'."\n"],
+ 'ReqUuid' => ['description' => '剧本执行记录UUID。', 'type' => 'string', 'example' => '93e5df20-3d03-42e1-b44b-58197c71****'."\n"],
+ 'TriggerSource' => ['description' => '处置任务的触发来源，取值：'."\n"
+ ."\n"
+ .'- **system**：手动处置事件触发。'."\n"
+ .'- **custom**：自动响应规则，事件触发。'."\n"
+ .'- **custom_alert**：自动响应规则，告警触发。'."\n"
+ .'- **soar-manual**：SOAR手动调用剧本触发。'."\n"
+ .'- **soar-mdr**：由安全管家服务触发。', 'type' => 'string', 'example' => 'system'],
+ ],
+ ],
],
- 'TotalCount' => [
- 'description' => '总页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
+ 'Page' => [
+ 'description' => '页面显示的信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => '查询到的信息总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"ProcessTasks\\": [\\n {\\n \\"TaskId\\": \\"150xxxxxxxxx95066\\",\\n \\"Creator\\": \\"123xxxx355\\",\\n \\"GmtCreateMillis\\": 1700031183572,\\n \\"GmtModifiedMillis\\": 1700031183572,\\n \\"YunCode\\": \\"WAF\\",\\n \\"EntityName\\": \\"1.1.1.x\\",\\n \\"EntityType\\": \\"ip\\",\\n \\"TaskStatus\\": 11,\\n \\"Scope\\": \\"123xxxxx234\\",\\n \\"InputParams\\": \\"{\\\\\\"groupuuid\\\\\\":\\\\\\"c6a9b1df-f4ac-4078-bef4-99xxxxxx\\\\\\"}\\",\\n \\"SceneCode\\": \\"event_xxx_whole_process\\",\\n \\"SceneName\\": \\"waf_whole_process\\",\\n \\"ProcessTime\\": 1700031183572,\\n \\"RemoveTime\\": 1700031183572,\\n \\"ProcessStrategyUuid\\": \\"92af3c79-1754-4646-9366-9ddbd1e45536_****\\",\\n \\"Source\\": \\"system\\",\\n \\"ErrCode\\": \\"sts_openapi.Info.DefenseSceneNotSupported\\",\\n \\"ErrMsg\\": \\"ParamError : The parameters of your request are invalid\\",\\n \\"ErrTip\\": \\"Verify that the input parameters of the components are correct\\",\\n \\"EntityUuid\\": \\"69d189e2-ec17-4676-a2fe-02969234****\\\\n\\",\\n \\"EventUuid\\": \\"c1020ce1-d6a5-11e8-8298-00163e10****\\\\n\\",\\n \\"ReqUuid\\": \\"93e5df20-3d03-42e1-b44b-58197c71****\\\\n\\",\\n \\"TriggerSource\\": \\"system\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
+ 'title' => '获取处置任务列表',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTasks'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeProcessTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DescribeSoarRecordActionOutputList' => [
+ 'summary' => '用于获取剧本任务中，某一组件执行动作时，输出的数据列表。',
+ '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' => '组件动作的UUID。'."\n"
+ .'>调用[DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '2202c90d-fa93-4726-bc32-xxxxxx'],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
+ .'> 建议PageSize取值不要为空。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'SophonResult<String>',
+ 'description' => '返回信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90'],
+ 'ActionOutputs' => ['title' => '传输的数据', 'description' => '组件动作执行时的输出数据，为JSONArray格式。'."\n"
+ ."\n"
+ .'> 输出数据的具体格式，由编写剧本时配置的组件来确定。', 'type' => 'string', 'example' => '['."\n"
+ .' {'."\n"
+ .' "a": "a",'."\n"
+ .' "taskname": "92af3c79-1754-4646-9366-9ddbd1e45536_xxxx",'."\n"
+ .' "log_time": 1699868849000'."\n"
+ .' }'."\n"
+ .']'],
+ 'PageNumber' => ['description' => '当前分页的页码数。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页展示时，每个分页包含的列表条目数。默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['description' => '总页数。', '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' => '获取组件执行的输出数据列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordActionOutputList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeSoarRecordActionOutputList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeSoarRecordInOutput' => [
'summary' => '当用户执行剧本任务后，通过该接口可获取组件动作的输入数据与输出数据。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3794,35 +3647,20 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ActionUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '动作的UUID',
- 'description' => '组件动作的UUID。'."\n"
- .'>调用[DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0531ff66-dd05-4f24-84bf-xxxxxxxx',
- ],
+ 'schema' => ['title' => '动作的UUID', 'description' => '组件动作的UUID。'."\n"
+ .'>调用[DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '0531ff66-dd05-4f24-84bf-xxxxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -3832,56 +3670,44 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '372D8B41-AF8D-573A-9B3F-0924950F241F',
- ],
- 'InOutputInfo' => [
- 'title' => '传输的数据',
- 'description' => '组件动作的执行结果。',
- '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"
- .'}',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '372D8B41-AF8D-573A-9B3F-0924950F241F'],
+ 'InOutputInfo' => ['title' => '传输的数据', 'description' => '组件动作的执行结果。', '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',
- ],
+ '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' => '获取组件运行时数据',
'responseParamsDescription' => '**InOutputInfo**为JSONString格式，其中包含字段如下：'."\n"
@@ -3900,15 +3726,30 @@
.'- **inputParams**：动作的输入数据，为JSON格式，包含字段如下：'."\n"
.' - **inputData**：动作的具体输入数据'."\n"
.' - **totalSize**：动作的输入数据条目数',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordInOutput'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeSoarRecordInOutput',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeSoarRecords' => [
'summary' => '用于获取剧本的执行记录列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3920,176 +3761,94 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本的UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx',
- ],
+ 'schema' => ['title' => '剧本的UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx'],
],
[
'name' => 'TaskflowMd5',
'in' => 'query',
- 'schema' => [
- 'title' => '任务的版本ID',
- 'description' => '剧本配置的MD5值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'be0a4ef084dd174abe478df52xxxxx',
- ],
+ 'schema' => ['title' => '任务的版本ID', 'description' => '剧本配置的MD5值。', 'type' => 'string', 'required' => false, 'example' => 'be0a4ef084dd174abe478df52xxxxx'],
],
[
'name' => 'StartMillis',
'in' => 'query',
- 'schema' => [
- 'title' => '任务开始时间',
- 'description' => '任务运行的开始时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1683526284584',
- ],
+ 'schema' => ['title' => '任务开始时间', 'description' => '任务运行的开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526284584'],
],
[
'name' => 'EndMillis',
'in' => 'query',
- 'schema' => [
- 'title' => '任务结束时间',
- 'description' => '任务运行的结束时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1683772744953',
- ],
+ 'schema' => ['title' => '任务结束时间', 'description' => '任务运行的结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683772744953'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'TriggerUser',
'in' => 'query',
- 'schema' => [
- 'description' => '执行剧本任务的阿里云账户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '127xxxx4392',
- ],
+ 'schema' => ['description' => '执行剧本任务的阿里云账户ID。', 'type' => 'string', 'required' => false, 'example' => '127xxxx4392'],
],
[
'name' => 'TaskStatus',
'in' => 'query',
- 'schema' => [
- 'description' => '任务的运行状态，取值：'."\n"
- ."\n"
- .'- **success**：成功任务。'."\n"
- .'- **failed**：失败任务。'."\n"
- .'- **inprogress**：运行中任务。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'inprogress',
- ],
+ 'schema' => ['description' => '任务的运行状态，取值：'."\n"
+ ."\n"
+ .'- **success**：成功任务。'."\n"
+ .'- **failed**：失败任务。'."\n"
+ .'- **inprogress**：运行中任务。', 'type' => 'string', 'required' => false, 'example' => 'inprogress'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
- .'> 建议PageSize取值不要为空。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
+ .'> 建议PageSize取值不要为空。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'RequestUuid',
'in' => 'query',
- 'schema' => [
- 'description' => '剧本任务执行的UUID。'."\n"
- .'>调用[DescribeSoarRecords](~~2627455~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6d412cfa-0905-4567-8a83-xxxxxx',
- ],
+ 'schema' => ['description' => '剧本任务执行的UUID。'."\n"
+ .'>调用[DescribeSoarRecords](~~2627455~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => '6d412cfa-0905-4567-8a83-xxxxxx'],
],
[
'name' => 'TriggerType',
'in' => 'query',
- 'schema' => [
- 'description' => '任务触发类型，取值：'."\n"
- ."\n"
- .'- **stream**：流式触发。'."\n"
- .'- **debug**：调试触发。'."\n"
- .'- **manual**：人工触发。'."\n"
- .'- **timer**：定时触发。'."\n"
- .'- **SubInvoke**：子流程触发。'."\n"
- .'- **siem**：siem产品触发。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'debug',
- ],
+ 'schema' => ['description' => '任务触发类型，取值：'."\n"
+ ."\n"
+ .'- **stream**：流式触发。'."\n"
+ .'- **debug**：调试触发。'."\n"
+ .'- **manual**：人工触发。'."\n"
+ .'- **timer**：定时触发。'."\n"
+ .'- **SubInvoke**：子流程触发。'."\n"
+ .'- **siem**：siem产品触发。', 'type' => 'string', 'required' => false, 'example' => 'debug'],
],
[
'name' => 'QueryValue',
'in' => 'query',
- 'schema' => [
- 'description' => '剧本输入参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'input',
- ],
+ 'schema' => ['description' => '剧本输入参数。', 'type' => 'string', 'required' => false, 'example' => 'input'],
],
[
'name' => 'CompletedBeginTime',
'in' => 'query',
- 'schema' => [
- 'description' => '任务完成的开始时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1755676363777',
- ],
+ 'schema' => ['description' => '任务完成的开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1755676363777'],
],
[
'name' => 'CompletedEndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '任务完成的结束时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1683526284584',
- ],
+ 'schema' => ['description' => '任务完成的结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526284584'],
],
],
'responses' => [
@@ -4099,12 +3858,7 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '601C2DAC-6A67-5237-BEE8-5BF1CEE9*****',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '601C2DAC-6A67-5237-BEE8-5BF1CEE9*****'],
'SoarExecuteRecords' => [
'title' => '传输的数据',
'description' => '执行记录结果集。',
@@ -4113,69 +3867,27 @@
'description' => '执行记录详情。',
'type' => 'object',
'properties' => [
- 'TriggerType' => [
- 'description' => '剧本任务的类型，取值：'."\n"
- ."\n"
- .'- **debug**：表示调试任务。'."\n"
- .'- **manual**：表示手动任务。'."\n"
- .'- **siem**：表示事件或告警触发的任务。',
- 'type' => 'string',
- 'example' => 'debug',
- ],
- 'TaskName' => [
- 'description' => '剧本任务的名称，同剧本的UUID。',
- 'type' => 'string',
- 'example' => '82848ebc-eaff-4791-acd4-xxxxx',
- ],
- 'StartTime' => [
- 'description' => '任务运行的开始时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1675823338433',
- ],
- 'EndTime' => [
- 'description' => '组件运行的结束时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1686294686000',
- ],
- 'Status' => [
- 'description' => '剧本执行的任务状态，取值为：'."\n"
- ."\n"
- .'- **success**：表示执行成功。'."\n"
- .'- **fail**：表示执行失败。'."\n"
- .'- **running**：表示正在运行',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestUuid' => [
- 'description' => '剧本任务的请求ID，每次任务运行的唯一ID。',
- 'type' => 'string',
- 'example' => 'ba1ec480-aa90-4bb6-a1a7-9e311ae*****',
- ],
- 'TriggerUser' => [
- 'description' => '执行剧本任务的阿里云账户ID。',
- 'type' => 'string',
- 'example' => '127xxxx4392',
- ],
- 'ErrorMsg' => [
- 'description' => '剧本任务的错误信息，任务成功时，该字段为空。',
- 'type' => 'string',
- 'example' => 'stime not match',
- ],
- 'RawEventReq' => [
- 'description' => '剧本任务的请求参数。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "input1": "xx.xx.xx.xx",'."\n"
- .' "input2": "7d"'."\n"
- .'}',
- ],
- 'TaskflowMd5' => [
- 'description' => '剧本配置的MD5值。',
- 'type' => 'string',
- 'example' => 'dea65a3db87fb9bd84bbxxxxx',
- ],
+ 'TriggerType' => ['description' => '剧本任务的类型，取值：'."\n"
+ ."\n"
+ .'- **debug**：表示调试任务。'."\n"
+ .'- **manual**：表示手动任务。'."\n"
+ .'- **siem**：表示事件或告警触发的任务。', 'type' => 'string', 'example' => 'debug'],
+ 'TaskName' => ['description' => '剧本任务的名称，同剧本的UUID。', 'type' => 'string', 'example' => '82848ebc-eaff-4791-acd4-xxxxx'],
+ 'StartTime' => ['description' => '任务运行的开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1675823338433'],
+ 'EndTime' => ['description' => '组件运行的结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686294686000'],
+ 'Status' => ['description' => '剧本执行的任务状态，取值为：'."\n"
+ ."\n"
+ .'- **success**：表示执行成功。'."\n"
+ .'- **fail**：表示执行失败。'."\n"
+ .'- **running**：表示正在运行', 'type' => 'string', 'example' => 'success'],
+ 'RequestUuid' => ['description' => '剧本任务的请求ID，每次任务运行的唯一ID。', 'type' => 'string', 'example' => 'ba1ec480-aa90-4bb6-a1a7-9e311ae*****'],
+ 'TriggerUser' => ['description' => '执行剧本任务的阿里云账户ID。', 'type' => 'string', 'example' => '127xxxx4392'],
+ 'ErrorMsg' => ['description' => '剧本任务的错误信息，任务成功时，该字段为空。', 'type' => 'string', 'example' => 'stime not match'],
+ 'RawEventReq' => ['description' => '剧本任务的请求参数。', 'type' => 'string', 'example' => '{'."\n"
+ .' "input1": "xx.xx.xx.xx",'."\n"
+ .' "input2": "7d"'."\n"
+ .'}'],
+ 'TaskflowMd5' => ['description' => '剧本配置的MD5值。', 'type' => 'string', 'example' => 'dea65a3db87fb9bd84bbxxxxx'],
'OutputList' => [
'description' => '剧本的输出信息。',
'type' => 'array',
@@ -4183,21 +3895,9 @@
'description' => 'JSONArray',
'type' => 'object',
'properties' => [
- 'Content' => [
- 'description' => '输出内容。',
- 'type' => 'string',
- 'example' => ' {"msg":"process has been killed","code":"KillSuccess","status":"success"}',
- ],
- 'NodeName' => [
- 'description' => '输出信息的节点名称。',
- 'type' => 'string',
- 'example' => 'TriggerPlaybook_4',
- ],
- 'ActionUuid' => [
- 'description' => '节点UUID。',
- 'type' => 'string',
- 'example' => '4e78d665-2366-4485-8fbc-048a8d41a2c3-25****',
- ],
+ 'Content' => ['description' => '输出内容。', 'type' => 'string', 'example' => ' {"msg":"process has been killed","code":"KillSuccess","status":"success"}'],
+ 'NodeName' => ['description' => '输出信息的节点名称。', 'type' => 'string', 'example' => 'TriggerPlaybook_4'],
+ 'ActionUuid' => ['description' => '节点UUID。', 'type' => 'string', 'example' => '4e78d665-2366-4485-8fbc-048a8d41a2c3-25****'],
],
],
],
@@ -4208,27 +3908,9 @@
'description' => '页面显示的信息。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '查询到的信息总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22',
- 'default' => '0',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'default' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'TotalCount' => ['description' => '查询到的信息总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '22', 'default' => '0'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
],
'required' => true,
],
@@ -4236,20 +3918,33 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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' => '获取剧本执行记录',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecords'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeSoarRecords',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'DescribeSoarTaskAndActions' => [
'summary' => '用于获取剧本的一次运行过程中，组件的执行记录列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4261,85 +3956,50 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RequestUuid',
'in' => 'query',
- 'schema' => [
- 'title' => '任务请求的UUID',
- 'description' => '剧本任务的UUID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1077f2f9-25e8-42d9-bfdf-1528e1313f6d',
- ],
+ 'schema' => ['title' => '任务请求的UUID', 'description' => '剧本任务的UUID。', 'type' => 'string', 'required' => false, 'example' => '1077f2f9-25e8-42d9-bfdf-1528e1313f6d'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。', 'type' => 'integer', 'required' => false, 'example' => '1', 'format' => 'int32'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 10 条数据。'."\n"
- ."\n"
- .'> 建议 PageSize 取值不要为空。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 10 条数据。'."\n"
+ ."\n"
+ .'> 建议 PageSize 取值不要为空。', 'type' => 'integer', 'required' => false, 'example' => '10', 'format' => 'int32'],
],
[
'name' => 'QueryValue',
'in' => 'query',
- 'schema' => [
- 'description' => '剧本输入参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'input',
- ],
+ 'schema' => ['description' => '剧本输入参数。', 'type' => 'string', 'required' => false, 'example' => 'input'],
],
[
'name' => 'QueryType',
'in' => 'query',
- 'schema' => [
- 'description' => '任务触发类型，取值：'."\n"
- ."\n"
- .'- **stream**：流式触发。'."\n"
- ."\n"
- .'- **debug**：调试触发。'."\n"
- .'- **manual**：人工触发。'."\n"
- .'- **timer**：定时触发。'."\n"
- .'- **SubInvoke**：子流程触发。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'debug',
- ],
+ 'schema' => ['description' => '任务触发类型，取值：'."\n"
+ ."\n"
+ .'- **stream**：流式触发。'."\n"
+ ."\n"
+ .'- **debug**：调试触发。'."\n"
+ .'- **manual**：人工触发。'."\n"
+ .'- **timer**：定时触发。'."\n"
+ .'- **SubInvoke**：子流程触发。', 'type' => 'string', 'required' => false, 'example' => 'debug'],
],
],
'responses' => [
@@ -4349,75 +4009,32 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '18017A93-3D5D-503A-8308-914543F1CBA3',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '18017A93-3D5D-503A-8308-914543F1CBA3'],
'Details' => [
'title' => '传输的数据',
'description' => '任务执行详情。',
'type' => 'object',
'properties' => [
- 'TriggerType' => [
- 'description' => '触发类型，取值：'."\n"
- ."\n"
- .'- **debug**：剧本调试的任务。'."\n"
- .'- **manual**：手动触发的任务。'."\n"
- .'- **siem**：事件触发的任务。',
- 'type' => 'string',
- 'example' => 'siem',
- ],
- 'TaskName' => [
- 'description' => '剧本任务的名称，同剧本的UUID。',
- 'type' => 'string',
- 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536',
- ],
- 'StartTime' => [
- 'description' => '剧本运行的开始时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1699868848645',
- ],
- 'EndTime' => [
- 'description' => '剧本运行的结束时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1699868848767',
- ],
- 'Status' => [
- 'description' => '剧本执行的任务状态，取值为：'."\n"
- ."\n"
- .'- **success**：表示执行成功'."\n"
- .'- **fail**：表示执行失败'."\n"
- .'- **running**：表示正在运行',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestUuid' => [
- 'description' => '剧本任务的请求ID，每次任务运行的唯一ID。',
- 'type' => 'string',
- 'example' => '17f75844-75cc-4174-86da-cec07a690142',
- ],
- 'TriggerUser' => [
- 'description' => '触发剧本任务的阿里云账号ID。',
- 'type' => 'string',
- 'example' => '127xxxx4392',
- ],
- 'ErrorMsg' => [
- 'description' => '剧本任务的错误信息，任务成功时，该字段为空。',
- 'type' => 'string',
- 'example' => 'stime not match',
- ],
- 'RawEventReq' => [
- 'description' => '剧本任务的请求参数。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "input1": "xx.xx.xx.xx",'."\n"
- .' "input2": "7d"'."\n"
- .'}',
- ],
+ 'TriggerType' => ['description' => '触发类型，取值：'."\n"
+ ."\n"
+ .'- **debug**：剧本调试的任务。'."\n"
+ .'- **manual**：手动触发的任务。'."\n"
+ .'- **siem**：事件触发的任务。', 'type' => 'string', 'example' => 'siem'],
+ 'TaskName' => ['description' => '剧本任务的名称，同剧本的UUID。', 'type' => 'string', 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536'],
+ 'StartTime' => ['description' => '剧本运行的开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848645'],
+ 'EndTime' => ['description' => '剧本运行的结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848767'],
+ 'Status' => ['description' => '剧本执行的任务状态，取值为：'."\n"
+ ."\n"
+ .'- **success**：表示执行成功'."\n"
+ .'- **fail**：表示执行失败'."\n"
+ .'- **running**：表示正在运行', 'type' => 'string', 'example' => 'success'],
+ 'RequestUuid' => ['description' => '剧本任务的请求ID，每次任务运行的唯一ID。', 'type' => 'string', 'example' => '17f75844-75cc-4174-86da-cec07a690142'],
+ 'TriggerUser' => ['description' => '触发剧本任务的阿里云账号ID。', 'type' => 'string', 'example' => '127xxxx4392'],
+ 'ErrorMsg' => ['description' => '剧本任务的错误信息，任务成功时，该字段为空。', 'type' => 'string', 'example' => 'stime not match'],
+ 'RawEventReq' => ['description' => '剧本任务的请求参数。', 'type' => 'string', 'example' => '{'."\n"
+ .' "input1": "xx.xx.xx.xx",'."\n"
+ .' "input2": "7d"'."\n"
+ .'}'],
'Actions' => [
'description' => '剧本执行的组件动作列表。',
'type' => 'array',
@@ -4425,106 +4042,148 @@
'description' => '剧本执行的组件动作详情。',
'type' => 'object',
'properties' => [
- 'Component' => [
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'example' => 'DataFormat',
- ],
- 'Action' => [
- 'description' => '组件的动作名称。',
- 'type' => 'string',
- 'example' => 'formatdata',
- ],
- 'StartTime' => [
- 'description' => '组件运行的开始时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1699868848731',
- ],
- 'EndTime' => [
- 'description' => '剧本运行的结束时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1699868848766',
- ],
- 'Status' => [
- 'description' => '组件的运行结果，取值为：'."\n"
- ."\n"
- .'- **success**：表示执行成功。'."\n"
- .'- **fail**：表示执行失败。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ActionUuid' => [
- 'description' => '组件动作执行记录的UUID。',
- 'type' => 'string',
- 'example' => '091be399-a937-4276-af78-xxxxxxxx',
- ],
- 'AssetName' => [
- 'description' => '组件使用的资产名称。',
- 'type' => 'string',
- 'example' => 'SLS Asset',
- ],
- 'NodeName' => [
- 'description' => '组件的自定义节点名称。',
- 'type' => 'string',
- 'example' => 'DataFormat_1',
- ],
+ 'Component' => ['description' => '组件的名称。', 'type' => 'string', 'example' => 'DataFormat'],
+ 'Action' => ['description' => '组件的动作名称。', 'type' => 'string', 'example' => 'formatdata'],
+ 'StartTime' => ['description' => '组件运行的开始时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848731'],
+ 'EndTime' => ['description' => '剧本运行的结束时间，格式：13位的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848766'],
+ 'Status' => ['description' => '组件的运行结果，取值为：'."\n"
+ ."\n"
+ .'- **success**：表示执行成功。'."\n"
+ .'- **fail**：表示执行失败。', 'type' => 'string', 'example' => 'success'],
+ 'ActionUuid' => ['description' => '组件动作执行记录的UUID。', 'type' => 'string', 'example' => '091be399-a937-4276-af78-xxxxxxxx'],
+ 'AssetName' => ['description' => '组件使用的资产名称。', 'type' => 'string', 'example' => 'SLS Asset'],
+ 'NodeName' => ['description' => '组件的自定义节点名称。', 'type' => 'string', 'example' => 'DataFormat_1'],
],
],
],
- 'TaskFlowMd5' => [
- 'description' => '运行剧本配置的MD5值。',
- 'type' => 'string',
- 'example' => 'ed127287-6699-4e4d-b986-9f770879xxx',
- ],
- 'ActionLogNum' => [
- 'description' => '动作日志总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'TaskFlowMd5' => ['description' => '运行剧本配置的MD5值。', 'type' => 'string', 'example' => 'ed127287-6699-4e4d-b986-9f770879xxx'],
+ 'ActionLogNum' => ['description' => '动作日志总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
],
'Page' => [
'description' => '页面显示的信息。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '查询到的信息总数量。',
- 'type' => 'string',
- 'example' => '20',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'string',
- 'example' => '10',
- ],
+ 'TotalCount' => ['description' => '查询到的信息总数量。', 'type' => 'string', 'example' => '20'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'string', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'string', 'example' => '10'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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' => '获取剧本的组件执行记录',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarTaskAndActions'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeSoarTaskAndActions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
- 'DescriberPython3ScriptLogs' => [
- 'summary' => '在提交pyhton脚本的任务后，通过返回的requestUuid来获取运行日志。',
- 'methods' => [
- 'get',
+ 'DescribeSophonCommands' => [
+ 'summary' => '用于获取处置实体的命令',
+ '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' => '命令名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'waf_process'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'SophonResult<List<SophonCommandBO>>',
+ 'description' => '返回信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'title' => '传输的数据',
+ 'description' => '返回的命令列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '命令详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '命令名称。', 'type' => 'string', 'example' => 'waf_process_ip_v2'],
+ 'DisplayName' => ['description' => '命令的显示名称。', 'type' => 'string', 'example' => 'WAF Process IP'],
+ 'ParamConfig' => [
+ 'description' => '参数配置信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '参数配置信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Necessary' => ['description' => '是否必填，取值：'."\n"
+ .'- **true**（默认）：必填。'."\n"
+ ."\n"
+ .'- **false**：非必填。', 'type' => 'boolean', 'example' => 'true'],
+ 'Field' => ['description' => '参数字段名称。', 'type' => 'string', 'example' => 'ip'],
+ 'Value' => ['description' => '参数值。', 'type' => 'string', 'example' => '12.xx.xx.xx'],
+ 'CheckField' => ['description' => '字段格式校验，正则匹配的方式，如果为空，表示不进行校验。', 'type' => 'string', 'example' => '[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}'],
+ ],
+ ],
+ ],
+ 'Description' => ['description' => '命令描述。', 'type' => 'string', 'example' => 'This is a action of processing for WAF'],
+ ],
+ ],
+ ],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '1E1EC464-3BD7-518F-9937-BCC12E6855FE'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ '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' => '获取处置命令',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSophonCommands'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeSophonCommands',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DescribeVendorApiList' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4536,30 +4195,170 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'RequestUuid',
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前分页的页码数。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['description' => '分页展示时，每个分页包含的列表条目数。默认为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'KeyWord',
+ 'in' => 'query',
+ 'schema' => ['description' => '关键字。', 'type' => 'string', 'required' => false, 'example' => 'Create'],
+ ],
+ [
+ 'name' => 'ProductCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '厂商的产品标识：'."\n"
+ .'- **waf**： Web应用防火墙。'."\n"
+ .'- **cfw** ：云防火墙。', 'type' => 'string', 'required' => false, 'example' => 'waf'],
+ ],
+ [
+ 'name' => 'ApiName',
+ 'in' => 'query',
+ 'schema' => ['description' => '阿里云产品接口的名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'AddAssetCleanConfig'],
+ ],
+ [
+ 'name' => 'VendorCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '厂商code：'."\n"
+ .'- **Tencent** ：腾讯。'."\n"
+ .'- **HUAWEICLOUD：** 华为。'."\n"
+ .'- **Azure** ：微软云。'."\n"
+ .'- **AWS** ：亚马逊云。'."\n"
+ .'- **Chaitin** ：长亭。', 'type' => 'string', 'required' => false, 'example' => 'Azure'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '运行python3脚本时，返回的UUID。'."\n"
- .'>调用[RunPython3Script](~~RunPython3Script~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '69edc2b4-c95c-424f-9114-xxxxxxx',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94'],
+ 'Page' => [
+ 'description' => '分页查询信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ ],
+ 'ApiList' => [
+ 'description' => '产品信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '产品信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'VendorCode' => ['description' => '厂商code：'."\n"
+ .'- **Tencent** ：腾讯。'."\n"
+ .'- **HUAWEICLOUD：** 华为。'."\n"
+ .'- **Azure** ：微软云。'."\n"
+ .'- **AWS** ：亚马逊云。'."\n"
+ .'- **Chaitin** ：长亭。', 'type' => 'string', 'example' => 'Azure'],
+ 'ProductCode' => ['description' => '厂商的产品标识：'."\n"
+ .'- **waf**： Web应用防火墙。'."\n"
+ .'- **cfw** ：云防火墙。', 'type' => 'string', 'example' => 'cfw'],
+ 'ProductName' => ['description' => '产品名称。', 'type' => 'string', 'example' => 'waf'],
+ 'Parameter' => ['description' => '接口请求参数配置信息。', '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' => '产品默认的域名。', 'type' => 'string', 'example' => 'cfw.xxx.com'],
+ 'Protocol' => ['description' => '请求协议。取值：'."\n"
+ .'- **http**： HTTP请求协议。'."\n"
+ .'- **https**：HTTPS请求协议。', 'type' => 'string', 'example' => 'https'],
+ 'Method' => ['description' => '请求方式：'."\n"
+ .'- **POST**： POST请求方式。'."\n"
+ .'- **GET**：GET请求方式。'."\n"
+ .'- **PUT**： PUT请求方式。'."\n"
+ .'- **DELETE**： DELETE请求方式。', 'type' => 'string', 'example' => 'POST'],
+ 'ApiName' => ['description' => '厂商的接口名称。', 'type' => 'string', 'example' => 'VerifyMobile'],
+ 'NeedPageInfo' => ['description' => '是否翻页。'."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'example' => 'false'],
+ 'PageInfo' => ['description' => '页面显示的信息。', 'type' => 'string', 'example' => '{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}'],
+ 'ApiVersion' => ['description' => 'API的版本号。', 'type' => 'string', 'example' => '2017-08-01'],
+ 'NeedAdvanceConfig' => ['description' => '是包含高级配置。'."\n"
+ .'- **true**： 是。'."\n"
+ .'- **false**： 否。', 'type' => 'boolean', 'example' => 'true'],
+ 'AdvanceConfig' => ['description' => '接口高级配置。', 'type' => 'string', 'example' => '{'."\n"
+ .' "cmd": "DescribeAclApiDispatch"'."\n"
+ .'}'],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询多云厂商的OpenApi列表',
+ 'summary' => '查询云厂商OpenApi列表。',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVendorApiList'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescribeVendorApiList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-****-5840-8EC9-691B86729E94\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"ApiList\\": [\\n {\\n \\"VendorCode\\": \\"Azure\\",\\n \\"ProductCode\\": \\"cfw\\",\\n \\"ProductName\\": \\"waf\\",\\n \\"Parameter\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"Domain\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"isRequired\\\\\\": true,\\\\n \\\\\\"exampleValue\\\\\\": \\\\\\"www.***.com\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"www.***.com\\\\\\"\\\\n }\\\\n]\\",\\n \\"ProductDomain\\": \\"cfw.xxx.com\\",\\n \\"Protocol\\": \\"https\\",\\n \\"Method\\": \\"POST\\",\\n \\"ApiName\\": \\"VerifyMobile\\",\\n \\"NeedPageInfo\\": false,\\n \\"PageInfo\\": \\"{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}\\",\\n \\"ApiVersion\\": \\"2017-08-01\\",\\n \\"NeedAdvanceConfig\\": true,\\n \\"AdvanceConfig\\": \\"{\\\\n \\\\\\"cmd\\\\\\": \\\\\\"DescribeAclApiDispatch\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescriberPython3ScriptLogs' => [
+ 'summary' => '在提交pyhton脚本的任务后，通过返回的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' => '运行python3脚本时，返回的UUID。'."\n"
+ .'>调用[RunPython3Script](~~RunPython3Script~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '69edc2b4-c95c-424f-9114-xxxxxxx'],
+ ],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -4569,42 +4368,45 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'D22D8A0C-6E86-57B2-A142-929184122AB1',
- ],
- 'RunResult' => [
- 'title' => '传输的数据',
- 'description' => 'python3的运行日志。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "logs": ['."\n"
- .' {'."\n"
- .' "message": "function input is {}"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'D22D8A0C-6E86-57B2-A142-929184122AB1'],
+ 'RunResult' => ['title' => '传输的数据', 'description' => 'python3的运行日志。', 'type' => 'string', 'example' => '{'."\n"
+ .' "logs": ['."\n"
+ .' {'."\n"
+ .' "message": "function input is {}"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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' => '获取pyhton脚本运行日志',
- ],
- 'ModifyComponentAsset' => [
- 'summary' => '当一个组件需要配置资产时，该接口用户修改组件的资产信息。',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescriberPython3ScriptLogs'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:DescriberPython3ScriptLogs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ModifyComponentAsset' => [
+ 'summary' => '当一个组件需要配置资产时，该接口用户修改组件的资产信息',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4612,51 +4414,36 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AssetConfig',
'in' => 'query',
- 'schema' => [
- 'title' => '资产的配置',
- 'description' => '组件资产的配置，为JSONObject格式。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{'."\n"
- .' "name": "test asset",'."\n"
- .' "componentName": "SLS",'."\n"
- .' "params": ['."\n"
- .' {'."\n"
- .' "name": "end_point",'."\n"
- .' "value": "xxx"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "name": "sub_id",'."\n"
- .' "value": "xxxx"'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "name": "access_key",'."\n"
- .' "value": "xxxx"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
- ],
+ 'schema' => ['title' => '资产的配置', 'description' => '组件资产的配置，为JSONObject格式。', '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' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -4666,19 +4453,12 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '1C5F11E9-464E-51F0-9296-43BB312A0557',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '1C5F11E9-464E-51F0-9296-43BB312A0557'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C5F11E9-464E-51F0-9296-43BB312A0557\\"\\n}","type":"json"}]',
'title' => '修改组件资产',
'requestParamsDescription' => '**AssetConfig**字段参数说明：'."\n"
@@ -4688,15 +4468,30 @@
.' - **end_point**：连接信息。'."\n"
.' - **sub_id**：账号accessID。'."\n"
.' - **access_key**：账号的accessKey。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyComponentAsset'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:ModifyComponentAsset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'ModifyPlaybook' => [
'summary' => '用于修改剧本的配置信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4708,67 +4503,36 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8baa6cff-319e-4ede-97bc-1586c35e61f8',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '8baa6cff-319e-4ede-97bc-1586c35e61f8'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的展示名称',
- 'description' => '剧本的展示名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'aliyun_waf_test_playbook',
- ],
+ 'schema' => ['title' => '剧本的展示名称', 'description' => '剧本的展示名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun_waf_test_playbook'],
],
[
'name' => 'Taskflow',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本编辑配置',
- 'description' => '剧本的xml配置。',
- '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>',
- ],
+ 'schema' => ['title' => '剧本编辑配置', 'description' => '剧本的xml配置。', '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' => '剧本的描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo test task',
- ],
+ 'schema' => ['title' => '剧本的描述', 'description' => '剧本的描述', 'type' => 'string', 'required' => false, 'example' => 'demo test task'],
],
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -4778,30 +4542,38 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '9B584F84-D66A-5525-8E7B-05612A903ABF',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '9B584F84-D66A-5525-8E7B-05612A903ABF'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B584F84-D66A-5525-8E7B-05612A903ABF\\"\\n}","type":"json"}]',
'title' => '编辑剧本',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybook'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:ModifyPlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'ModifyPlaybookInputOutput' => [
'summary' => '用于修改剧本的输入参数与输出参数。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4813,94 +4585,59 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx'],
],
[
'name' => 'InputParams',
'in' => 'formData',
- 'schema' => [
- 'title' => '入参配置',
- 'description' => '剧本的入参配置，为JSONArray格式。',
- '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"
- .']',
- ],
+ 'schema' => ['title' => '入参配置', 'description' => '剧本的入参配置，为JSONArray格式。', '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' => '剧本暂不支持出参配置，固定为空值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '[]',
- ],
+ 'schema' => ['title' => '出参配置', 'description' => '剧本暂不支持出参配置，固定为空值。', 'type' => 'string', 'required' => true, 'example' => '[]'],
],
[
'name' => 'ParamType',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的入参类型。'."\n"
- .'- **template-ip**：IP请求模板。'."\n"
- .'- **template-file**：文件请求模板。'."\n"
- .'- **template-process**：进程请求模板。'."\n"
- .'- **custom**：自定义参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'custom',
- ],
+ 'schema' => ['description' => '剧本的入参类型。'."\n"
+ .'- **template-ip**：IP请求模板。'."\n"
+ .'- **template-file**：文件请求模板。'."\n"
+ .'- **template-process**：进程请求模板。'."\n"
+ .'- **custom**：自定义参数。', 'type' => 'string', 'required' => false, 'example' => 'custom'],
],
[
'name' => 'ExeConfig',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的执行方式，为JSONObject格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "executeMode":"mul",'."\n"
- .' "cron":"0 0 1 */1 * ?"'."\n"
- .'}',
- ],
+ 'schema' => ['description' => '剧本的执行方式，为JSONObject格式。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "executeMode":"mul",'."\n"
+ .' "cron":"0 0 1 */1 * ?"'."\n"
+ .'}'],
],
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -4910,19 +4647,12 @@
'description' => '返回信息',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '8DDC07CE-D41B-5142-8D91-469462719C77',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '8DDC07CE-D41B-5142-8D91-469462719C77'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8DDC07CE-D41B-5142-8D91-469462719C77\\"\\n}","type":"json"}]',
'title' => '修改剧本的出入参数',
'requestParamsDescription' => '**InputParams**为JSONArray格式，具体参数说明：'."\n"
@@ -4937,15 +4667,87 @@
.'**ExeConfig**为JSONObject格式，具体参数说明：'."\n"
.'- executeMode：执行方式，固定为**mul**。'."\n"
.'- cron：CRON表达式，遵循CRON标准。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInputOutput'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:ModifyPlaybookInputOutput',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
- 'PublishPlaybook' => [
- 'summary' => '用于把剧本配置发布线上，发布后，剧本会以新的逻辑来运行。',
- 'methods' => [
- 'post',
+ 'ModifyPlaybookInstanceStatus' => [
+ 'summary' => '用于修改剧本的启动与停止状态',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '9fcd3829-80ff-4681-be1e-xxxxxxxx'],
+ ],
+ [
+ 'name' => 'Active',
+ 'in' => 'formData',
+ 'schema' => ['title' => '剧本启禁用状态', 'description' => '剧本的状态标识。取值：'."\n"
+ ."\n"
+ .'- **1**：表示启动剧本。'."\n"
+ ."\n"
+ .'- **0**：表示停止剧本。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Lang',
+ 'in' => 'query',
+ 'schema' => ['description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'SophonResult<Void>',
+ 'description' => '返回信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C2A32830-2842-5F8F-B4ED-E4783E400BBE'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2A32830-2842-5F8F-B4ED-E4783E400BBE\\"\\n}","type":"json"}]',
+ 'title' => '修改剧本的启停状态',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'PublishPlaybook' => [
+ 'summary' => '用于把剧本配置发布线上，发布后，剧本会以新的逻辑来运行。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4957,34 +4759,19 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsasK0Q1Y8',
- ],
+ 'abilityTreeNodes' => ['FEATUREsasK0Q1Y8'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx'],
],
[
'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的描述',
- 'description' => '本次发布版本的描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a waf processing playbook',
- 'maxLength' => 128,
- ],
+ 'schema' => ['title' => '剧本的描述', 'description' => '本次发布版本的描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a waf processing playbook', 'maxLength' => 128],
],
],
'responses' => [
@@ -4994,30 +4781,38 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF\\"\\n}","type":"json"}]',
'title' => '发布剧本',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishPlaybook'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:PublishPlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
+ ],
],
'QueryTreeData' => [
'summary' => '用于一次性获取所有的剧本列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5025,24 +4820,15 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
],
'responses' => [
@@ -5052,48 +4838,51 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2',
- ],
- 'Playbooks' => [
- 'title' => '传输的数据',
- 'description' => '返回的剧本信息列表，为JSONString的格式。包含以下字段：'."\n"
- ."\n"
- .'- **active**：表示剧本是否启动，**true**表示已启动，**false**表示未启动'."\n"
- .'- **displayName**：表示剧本的名称。'."\n"
- .'- **playbookUuid**：表示剧本的UUID。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {'."\n"
- .' "playbook": {'."\n"
- .' "active": false,'."\n"
- .' "displayName": "test_playbook",'."\n"
- .' "playbookUuid": "09a20455-3d3a-424c-a1df-xxxxxx"'."\n"
- .' }'."\n"
- .' }'."\n"
- .']',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2'],
+ 'Playbooks' => ['title' => '传输的数据', 'description' => '返回的剧本信息列表，为JSONString的格式。包含以下字段：'."\n"
+ ."\n"
+ .'- **active**：表示剧本是否启动，**true**表示已启动，**false**表示未启动'."\n"
+ .'- **displayName**：表示剧本的名称。'."\n"
+ .'- **playbookUuid**：表示剧本的UUID。', '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',
- ],
+ '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' => '获取所有剧本的列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTreeData'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:QueryTreeData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'RevertPlaybookRelease' => [
'summary' => '用于回滚剧本到指定的版本，同时可以指定回滚时是否发布该版本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5105,48 +4894,27 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '185295a1-c987-4b64-8796-xxxxxxxx',
- ],
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '185295a1-c987-4b64-8796-xxxxxxxx'],
],
[
'name' => 'PlayReleaseId',
'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的发布记录ID',
- 'description' => '剧本发布版本的ID。'."\n"
- .'>调用[DescribePlaybookReleases](~~DescribePlaybookReleases~~)接口可以获取该参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '3f97b56e-064e-47e7-a309-xxxxxxx',
- ],
+ 'schema' => ['title' => '剧本的发布记录ID', 'description' => '剧本发布版本的ID。'."\n"
+ .'>调用[DescribePlaybookReleases](~~DescribePlaybookReleases~~)接口可以获取该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3f97b56e-064e-47e7-a309-xxxxxxx'],
],
[
'name' => 'IsPublish',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否回滚发布',
- 'description' => '回滚版本后，是否直接发布。'."\n"
- .'- **true**（默认）：发布并回滚'."\n"
- .'- **false**：不发布，只回滚',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否回滚发布', 'description' => '回滚版本后，是否直接发布。'."\n"
+ .'- **true**（默认）：发布并回滚'."\n"
+ .'- **false**：不发布，只回滚', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -5156,1925 +4924,577 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573',
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3FED5B9-190A-5952-93A4-24FBF0F0C573\\"\\n}","type":"json"}]',
'title' => '回滚剧本版本',
- ],
- 'TriggerPlaybook' => [
- 'summary' => '用于触发已启用的自定义剧本或预定义剧本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevertPlaybookRelease'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'PlaybookUuid',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2a687089-d4dd-47d4-9709-xxxxxxxx',
- ],
- ],
- [
- 'name' => 'InputParam',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的入参',
- 'description' => '剧本的输入参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{'."\n"
- .' "input1": "xx.xx.xx.xx",'."\n"
- .' "input2": "7d"'."\n"
- .'}'."\n",
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SophonResult<PlaybookTriggerDTO>',
- 'description' => '请求返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'BD5A8DB6-A42C-532B-BCE8-83E69550CD59',
- ],
- 'TriggerUuid' => [
- 'description' => '剧本运行的UUID，可用于获取剧本的运行结果。',
- 'type' => 'string',
- 'example' => '55E63C57-D6C8-5036-A770-5CB10AC807AA',
- ],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:RevertPlaybookRelease',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Application', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD5A8DB6-A42C-532B-BCE8-83E69550CD59\\",\\n \\"TriggerUuid\\": \\"55E63C57-D6C8-5036-A770-5CB10AC807AA\\"\\n}","type":"json"}]',
- 'title' => '触发剧本',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
],
- 'TriggerSophonPlaybook' => [
- 'summary' => '用于触发运行剧本或响应命令。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RunNotifyComponentWithEmail' => [
+ 'summary' => '执行通知组件-email发送消息。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '149322',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '226653',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'CommandName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '想要触发的命令名称。'."\n"
- .'>调用[DescribeSophonCommands](~~DescribeSophonCommands~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'waf_process_command',
- ],
- ],
- [
- 'name' => 'InputParams',
+ 'name' => 'Receivers',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '触发命令或剧本的输入参数。',
- 'type' => 'string',
+ 'title' => '邮箱地址列表',
+ 'description' => '邮箱地址列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '单个邮箱地址。', 'type' => 'string', 'required' => false, 'example' => '123xxx@163.com'],
'required' => true,
- 'example' => '{'."\n"
- .' "param1": "xx.xx.xx.xx",'."\n"
- .' "param2": "7d"'."\n"
- .'}',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'SophonTaskId',
+ 'name' => 'Subject',
'in' => 'query',
- 'schema' => [
- 'description' => '业务的自定义ID，如果触发剧本时不指定，会产生一个随机的ID，用于排查与定位问题。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx',
- ],
+ 'schema' => ['title' => '邮箱标题', 'description' => '邮件标题。', 'type' => 'string', 'required' => true, 'example' => 'title'],
],
[
- 'name' => 'Uuid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx',
- ],
- ],
- [
- 'name' => 'TriggerType',
+ 'name' => 'Content',
'in' => 'query',
- 'schema' => [
- 'description' => '触发类型，取值：'."\n"
- ."\n"
- .'- **command**：触发命令任务'."\n"
- .'- **playbook**：触发剧本任务',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'playbook',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SophonResult<SophonTaskResult>',
- 'description' => '请求返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'title' => '传输的数据',
- 'description' => '触发命令或剧本后的返回详情。',
- 'type' => 'object',
- 'properties' => [
- 'SophonTaskId' => [
- 'description' => '业务的自定义ID，如果触发剧本时不指定，会产生一个随机的ID，用于排查与定位问题。',
- 'type' => 'string',
- 'example' => 'a7c6d055-a72f-4676-bc89-3cd9edc0284c',
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- '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' => '触发剧本或响应命令',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'VerifyPlaybook' => [
- 'summary' => '校验剧本的配置是否正确，编排的逻辑是否合理。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'schema' => ['title' => '邮箱正文', 'description' => '邮件正文。', 'type' => 'string', 'required' => true, 'example' => 'email content'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
- ],
- 'parameters' => [
[
'name' => 'PlaybookUuid',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本UUID',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '9fcd3829-80ff-4681-be1e-4d2662c35fed',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '剧本uuid', 'description' => '剧本UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx'],
],
[
- 'name' => 'TaskFlow',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本编辑配置',
- 'description' => '剧本的xml配置。',
- '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' => '剧本校验的返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54',
- ],
- 'CheckTaskInfos' => [
- 'title' => '传输的数据',
- 'description' => '校验的结果信息。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RiskLevel' => [
- 'description' => '校验信息的提示等级。取值：'."\n"
- .'- **warn**：警告提示，在剧本运行过程中可能出现问题。'."\n"
- .'- **error**：错误提示，剧本无法编译通过。'."\n"
- .'- **remind**：建议提示，不影响剧本的发布与运行，建议优化剧本格式。',
- 'type' => 'string',
- 'example' => 'error',
- ],
- 'NodeName' => [
- 'description' => '剧本的节点名称。',
- 'type' => 'string',
- 'example' => 'python3_3',
- ],
- 'Detail' => [
- 'description' => '检查未通过时的具体错误信息。',
- 'type' => 'string',
- 'example' => 'Node [python3_3] doesn\'t have the asset information',
- ],
- ],
- ],
- ],
- 'Prerequisites' => [
- 'description' => '剧本前置检验信息。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'PrerequisiteType' => [
- 'description' => '检验类型。取值：'."\n"
- .'- **role**：RAM自定义角色名称。'."\n"
- .'- **policies**：RAM系统策略列表。',
- 'type' => 'string',
- 'example' => 'role',
- ],
- 'PrerequisiteValue' => [
- 'description' => '检查内容。取值：'."\n"
- .'- **PrerequisiteType为role**：为固定值 AliyunSiemSoarExecutionDefaultRole。'."\n"
- .'- **PrerequisiteType为policies**：是策略名称的集合。',
- 'type' => 'string',
- 'example' => 'AliyunSiemSoarExecutionDefaultRole',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'name' => 'NodeName',
+ 'in' => 'query',
+ 'schema' => ['title' => '剧本的节点名称', 'description' => '剧本的节点名称。', 'type' => 'string', 'required' => true, 'example' => 'notify_message_1'],
],
- ],
- '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' => '校验剧本配置',
- ],
- 'VerifyPythonFile' => [
- 'summary' => '校验Python代码片段的语法是否正确。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'ComponentName',
+ 'in' => 'query',
+ 'schema' => ['title' => '剧本的组件名称', 'description' => '剧本的组件名称。', 'type' => 'string', 'required' => true, 'example' => 'NotifyMessage'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
[
- 'name' => 'Content',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '要校验的python代码片段。',
- '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' => '返回校验后的代码提示信息',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'F72685FB-A6E6-5A9A-97F7-6DC1056E63CE',
- ],
- 'Syntax' => [
- 'description' => 'python代码的校验结果集，如果为空，则表示代码语法正确',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'StartLineNumber' => [
- 'description' => '报错代码的启始行数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'StartColumn' => [
- 'description' => '报错代码的启始列数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'EndLineNumber' => [
- 'description' => '报错代码的结束行数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'EndColumn' => [
- 'description' => '报错代码的结束列数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'Message' => [
- 'description' => '代码的具体报错信息',
- 'type' => 'string',
- 'example' => 'undefined name \'ab\'',
- ],
- 'Severity' => [
- 'description' => '代码的错误等级'."\n"
- ."\n"
- .'- 4 表示一般错误'."\n"
- .'- 8 表示严重错误',
- '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.',
- ],
+ 'name' => 'ActionName',
+ 'in' => 'query',
+ 'schema' => ['title' => '剧本的动作名称', 'description' => '组件的动作名称。', 'type' => 'string', 'required' => true, 'example' => 'notifyByCustom'],
],
- ],
- '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' => '校验python代码片段',
- ],
- 'DescribeProcessStatistics' => [
- 'summary' => '获取统计信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '208550',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
+ 'name' => 'AssetId',
+ 'in' => 'query',
+ 'schema' => ['title' => '资源实例id', 'description' => '邮件发送方的资源实例ID。'."\n"
+ .'>调用[DescribeComponentAssets](~~DescribeComponentAssets~~)接口可以获取该参数。', 'type' => 'string', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
- ],
- 'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleType',
'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。取值：'."\n"
- ."\n"
- .'- 0（默认）：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- 0：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'RoleFor',
'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1709821xxxxx3093',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602xxx718726'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<ProcessMetricsDTO>',
- 'description' => 'SophonResult<ProcessMetricsDTO>',
+ 'title' => 'SophonResult<String>',
+ 'description' => 'SophonResult<String>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F',
- ],
- 'Metrics' => [
- 'title' => '传输的数据',
- 'description' => '返回的结果数据。',
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B'],
+ 'Data' => ['title' => '传输的数据', 'description' => '返回的结果数据。', 'type' => 'string', 'example' => '{}'],
+ 'Page' => [
+ 'description' => '分页查询信息。',
'type' => 'object',
'properties' => [
- 'TaskNum' => [
- 'description' => '处置任务数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'BanIpNum' => [
- 'description' => '封禁IP数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'BanFileNum' => [
- 'description' => '封禁文件数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'BanProcessNum' => [
- 'description' => '封禁进程数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
],
],
- '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' => '获取处置任务的统计信息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '通知组件-测试邮件发送',
'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'DescribeProcessTasks' => [
- 'summary' => '用于获取处置任务的列表信息。',
- 'methods' => [
- 'get',
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithEmail'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:RunNotifyComponentWithEmail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
+ ],
+ 'RunNotifyComponentWithMessageCenter' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '186031',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeCode' => '226714',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'ProcessStrategyUuid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '处置策略ID',
- 'description' => '处置策略的UUID。'."\n"
- .'>调用[ListDisposeStrategy](~~2584440~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_****',
- ],
- ],
- [
- 'name' => 'EntityName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实体的名称',
- 'description' => '处置的实体的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '127.0.0.1',
- ],
- ],
- [
- 'name' => 'EntityType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实体的类型',
- 'description' => '处置的实体类型，取值：'."\n"
- ."\n"
- .'- **ip**：表示IP类型实体。'."\n"
- .'- **file**：表示文件类型实体。'."\n"
- .'- **process**：表示进程类型实体。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ip',
- ],
- ],
- [
- 'name' => 'SceneCode',
- 'in' => 'query',
- 'schema' => [
- 'title' => '处置场景',
- 'description' => '处置任务的场景CODE。'."\n"
- .'>调用[DescribeEnumItems](~~DescribeEnumItems~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'event_xxx_whole_process',
- ],
- ],
- [
- 'name' => 'TaskStatus',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务状态 list',
- 'description' => '处置任务的状态列表，为数据字符串的格式，取值：'."\n"
- ."\n"
- .'- **11**：表示处置中。'."\n"
- .'- **21**：表示封禁中。'."\n"
- .'- **22**：表示隔离中。'."\n"
- .'- **23**：已结束。'."\n"
- .'- **24**：已加白。'."\n"
- .'- **20**：成功。'."\n"
- .'- **90**：失败。'."\n"
- .'- **91**：解封失败。'."\n"
- .'- **92**：解除隔离失败。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["11","21"]',
- ],
- ],
- [
- 'name' => 'Scope',
- 'in' => 'query',
- 'schema' => [
- 'title' => '作用域',
- 'description' => '处置的阿里云账户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '125xxxxx9870',
- ],
- ],
- [
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'title' => '处置来源 list',
- 'description' => '处置任务的触发来源，为数组字符串格式，取值：'."\n"
- ."\n"
- .'- **system**：手动处置事件触发。'."\n"
- .'- **custom**：自动响应规则，事件触发。'."\n"
- .'- **custom_alert**：自动响应规则，告警触发。'."\n"
- .'- **soar-manual**：SOAR手动调用剧本触发。'."\n"
- .'- **soar-mdr**：由安全管家服务触发。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["system"]',
- ],
- ],
- [
- 'name' => 'ProcessActionStart',
- 'in' => 'query',
- 'schema' => [
- 'title' => '处置时间的查询开始时间',
- 'description' => '处置时间的查询开始时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1700031183572',
- ],
- ],
- [
- 'name' => 'ProcessActionEnd',
- 'in' => 'query',
- 'schema' => [
- 'title' => '处置时间的查询结束时间',
- 'description' => '处置时间的查询结束时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1700031183572',
- ],
- ],
- [
- 'name' => 'ProcessRemoveStart',
- 'in' => 'query',
- 'schema' => [
- 'title' => '解封时间的查询开始时间',
- 'description' => '解封时间的查询开始时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1700031183572',
- ],
- ],
- [
- 'name' => 'ProcessRemoveEnd',
+ 'name' => 'Aliuid',
'in' => 'query',
- 'schema' => [
- 'title' => '解封时间的查询结束时间',
- 'description' => '解封时间的查询结束时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1700031183572',
- ],
+ 'schema' => ['title' => '要发送的aliuid', 'description' => '接收消息的用户ID。', 'type' => 'string', 'required' => true, 'example' => '146789xxxx733152'],
],
[
- 'name' => 'ParamContent',
+ 'name' => 'EventId',
'in' => 'query',
- 'schema' => [
- 'title' => '模糊查询',
- 'description' => '模糊匹配，会查询实体、处置场景、处置参数字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12.x.x.x',
- ],
+ 'schema' => ['title' => '云鸽的消息事件id', 'description' => '云鸽的消息事件ID。取值：'."\n"
+ .'- yundun_soar_incident_generate：事件生成'."\n"
+ .'- yundun_soar_alert_generate：告警生成'."\n"
+ .'- yundun_soar_incident_update：事件更新', 'type' => 'string', 'required' => true, 'example' => 'yundun_soar_incident_generate'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Params',
'in' => 'query',
- 'schema' => [
- 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回10条数据。'."\n"
- .'> 建议PageSize取值不要为空。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '消息参数', 'description' => '消息事件的模版参数。'."\n"
+ .'- 事件生成：aliyunUID、incidentName、incidentID、startTime'."\n"
+ .'- 告警生成：aliyunUID、alertName、alertID、startTime'."\n"
+ .'- 事件更新：aliyunUID、incidentName、incidentID、startTime、endTime、status、level', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"test222","incidentName":"test123","incidentID":"teset123"}'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ChannelTypeList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '通道类型集合，不传默认发送消息事件配置的所有通道',
+ 'description' => '通道类型集合，不传则默认发送所有通道，默认不传。',
+ 'type' => 'array',
+ 'items' => ['description' => '单个通道类型。取值：'."\n"
+ .'- sms：短信'."\n"
+ .'- email：邮件'."\n"
+ .'- webhook：钉钉群webhook'."\n"
+ .'- pmsg：站内信', 'type' => 'string', 'required' => false, 'example' => 'sms'],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'YunCode',
+ 'name' => 'PlaybookUuid',
'in' => 'query',
- 'schema' => [
- 'description' => '处置任务关联的云产品，为数据字符串格式，取值：'."\n"
- ."\n"
- .'- **WAF**：表示Web应用防火墙。'."\n"
- .'- **CFW**：表示云防火墙。'."\n"
- .'- **Aegis**：表示云安全中心。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["WAF"]',
- ],
+ 'schema' => ['title' => '剧本uuid', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'NodeName',
'in' => 'query',
- 'schema' => [
- 'description' => '处置任务的唯一标识。'."\n"
- ."\n"
- .'> 用于查询某具体任务，参数可由接口的返回值中获取。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '150xxxxxxxxx95066',
- ],
+ 'schema' => ['title' => '剧本的节点名称', 'description' => '剧本的节点名称。', 'type' => 'string', 'required' => true, 'example' => 'notify_message'],
],
[
- 'name' => 'OrderField',
+ 'name' => 'ComponentName',
'in' => 'query',
- 'schema' => [
- 'description' => '结果的排序字段。'."\n"
- ."\n"
- .'> 排序的字段，由接口的返回结果中获取。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gmtCreate',
- ],
+ 'schema' => ['title' => '剧本的组件名称', 'description' => '剧本的组件名称。', 'type' => 'string', 'required' => true, 'example' => 'NotifyMessage'],
],
[
- 'name' => 'Direction',
+ 'name' => 'ActionName',
'in' => 'query',
- 'schema' => [
- 'description' => '排序方向，取值：'."\n"
- ."\n"
- .'- **desc**：递减（默认）。'."\n"
- .'- **asc**：递增。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desc',
- ],
+ 'schema' => ['title' => '剧本的动作名称', 'description' => '剧本的动作名称。', 'type' => 'string', 'required' => true, 'example' => 'notifyByMessageCenter'],
],
[
- 'name' => 'EntityUuid',
+ 'name' => 'AssetId',
'in' => 'query',
- 'schema' => [
- 'title' => '实体UUID',
- 'description' => '实体UUID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n",
- ],
+ 'schema' => ['title' => '资源实例id', 'description' => '资源实例ID。当前此参数已废弃，不再使用。', 'type' => 'string', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'EventUuid',
+ 'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '事件UUID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
- 'name' => 'TriggerSource',
+ 'name' => 'RoleType',
'in' => 'query',
- 'schema' => [
- 'description' => '处置任务的触发来源，取值：'."\n"
- ."\n"
- .'- **system**：手动处置事件触发。'."\n"
- .'- **custom**：自动响应规则，事件触发。'."\n"
- .'- **custom_alert**：自动响应规则，告警触发。'."\n"
- .'- **soar-manual**：SOAR手动调用剧本触发。'."\n"
- .'- **soar-mdr**：由安全管家服务触发。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'system',
- ],
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- 0（默认）：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
- 'name' => 'ReqUuid',
+ 'name' => 'RoleFor',
'in' => 'query',
- 'schema' => [
- 'description' => '剧本触发ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'b73d0b08-f1bd-4e8f-967a-8e2982c9****',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1467894xxx733152'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<List<ProcessTaskDTO>>',
- 'description' => '返回信息。',
+ 'title' => 'SophonResult<String>',
+ 'description' => 'SophonResult<String>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94',
- ],
- 'ProcessTasks' => [
- 'title' => '传输的数据',
- 'description' => '处置任务列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '处置任务详情。',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '处置任务的唯一标识。',
- 'type' => 'string',
- 'example' => '150xxxxxxxxx95066',
- ],
- 'Creator' => [
- 'title' => '任务的创建人',
- 'description' => '提交处置任务的阿里云账户ID。',
- 'type' => 'string',
- 'example' => '123xxxx355',
- ],
- 'GmtCreateMillis' => [
- 'title' => '任务创建时间',
- 'description' => '处置任务的创建时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1700031183572',
- ],
- 'GmtModifiedMillis' => [
- 'title' => '任务修复时间',
- 'description' => '处置任务的修改时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1700031183572',
- ],
- 'YunCode' => [
- 'title' => '关联产品',
- 'description' => '处置任务关联的云产品CODE。',
- 'type' => 'string',
- 'example' => 'WAF',
- ],
- 'EntityName' => [
- 'title' => '处置的实体名称',
- 'description' => '处置的实体名称。',
- 'type' => 'string',
- 'example' => '1.1.1.x',
- ],
- 'EntityType' => [
- 'title' => '处置的实体类型',
- 'description' => '处置的实体类型。',
- 'type' => 'string',
- 'example' => 'ip',
- ],
- 'TaskStatus' => [
- 'title' => '任务状态',
- 'description' => '处置任务的状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
- ],
- 'Scope' => [
- 'title' => '作战域',
- 'description' => '处置的阿里云账户ID。',
- 'type' => 'string',
- 'example' => '123xxxxx234',
- ],
- 'InputParams' => [
- 'title' => '任务的入参',
- 'description' => '处置任务的输入参数。',
- 'type' => 'string',
- 'example' => '{"groupuuid":"c6a9b1df-f4ac-4078-bef4-99xxxxxx"}',
- ],
- 'SceneCode' => [
- 'title' => '处置场景',
- 'description' => '处置任务的场景CODE。',
- 'type' => 'string',
- 'example' => 'event_xxx_whole_process',
- ],
- 'SceneName' => [
- 'title' => '处置场景名称',
- 'description' => '处置任务的场景名称。',
- 'type' => 'string',
- 'example' => 'waf_whole_process',
- ],
- 'ProcessTime' => [
- 'title' => '处置时间',
- 'description' => '处置任务的下发时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1700031183572',
- ],
- 'RemoveTime' => [
- 'title' => '解除时间',
- 'description' => '处置任务的解封时间，格式：13位的时间戳。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1700031183572',
- ],
- 'ProcessStrategyUuid' => [
- 'title' => '关联的策略ID',
- 'description' => '关联的策略ID。',
- 'type' => 'string',
- 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_****',
- ],
- 'Source' => [
- 'description' => '处置任务的提交来源。',
- 'type' => 'string',
- 'example' => 'system',
- ],
- 'ErrCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'sts_openapi.Info.DefenseSceneNotSupported',
- ],
- 'ErrMsg' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'ParamError : The parameters of your request are invalid',
- ],
- 'ErrTip' => [
- 'description' => '错误提示。',
- 'type' => 'string',
- 'example' => 'Verify that the input parameters of the components are correct',
- ],
- 'EntityUuid' => [
- 'description' => '实体UUID。',
- 'type' => 'string',
- 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n",
- ],
- 'EventUuid' => [
- 'description' => '事件UUID。',
- 'type' => 'string',
- 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****'."\n",
- ],
- 'ReqUuid' => [
- 'description' => '剧本执行记录UUID。',
- 'type' => 'string',
- 'example' => '93e5df20-3d03-42e1-b44b-58197c71****'."\n",
- ],
- 'TriggerSource' => [
- 'description' => '处置任务的触发来源，取值：'."\n"
- ."\n"
- .'- **system**：手动处置事件触发。'."\n"
- .'- **custom**：自动响应规则，事件触发。'."\n"
- .'- **custom_alert**：自动响应规则，告警触发。'."\n"
- .'- **soar-manual**：SOAR手动调用剧本触发。'."\n"
- .'- **soar-mdr**：由安全管家服务触发。',
- 'type' => 'string',
- 'example' => 'system',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'],
+ 'Data' => ['title' => '传输的数据', 'description' => '接口返回数据。', 'type' => 'string', 'example' => '{}'],
'Page' => [
- 'description' => '页面显示的信息。',
+ 'description' => '分页查询信息。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '查询到的信息总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'TotalCount' => ['description' => '列表条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', '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' => '获取处置任务列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '通知组件-测试消息中心的消息发送',
+ 'summary' => '执行通知组件-消息中心发送消息。',
'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'DescribeProcessTaskCount' => [
- 'summary' => '通过实体UUID查询关联的处置任务数。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithMessageCenter'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '245000',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'EntityUuidList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '实体的entityUuid集合',
- 'description' => '实体的UUID集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '实体UUID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a680c9ae-****-4c39-****-0302****fc8e',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'Lang',
- 'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
- ],
- [
- 'name' => 'RoleType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。'."\n"
- ."\n"
- .'- **0**：当前阿里云账号视图。'."\n"
- .'- **1**：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'RoleFor',
- 'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '104739******259',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SophonResult<List<ProcessTaskNumberDTO>>',
- 'description' => '返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'e866cce0-****-41de-817e-****8d5e2650',
- ],
- 'Data' => [
- 'title' => '传输的数据',
- 'description' => '传输的数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '结果集。',
- 'type' => 'object',
- 'properties' => [
- 'EntityUuid' => [
- 'title' => '实体uuid',
- 'description' => '实体UUID。',
- 'type' => 'string',
- 'example' => 'a680c9ae-****-4c39-****-0302****fc8e',
- ],
- 'Count' => [
- 'title' => '数量',
- 'description' => '数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '67',
- ],
- ],
- ],
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:RunNotifyComponentWithMessageCenter',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- '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' => '通过实体UUID查询关联的处置任务数',
+ '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"}]',
],
- 'DescribeSophonCommands' => [
- 'summary' => '用于获取处置实体的命令。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RunNotifyComponentWithWebhook' => [
+ 'summary' => '执行通知组件-webhook发送消息。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '226713',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'Name',
+ 'name' => 'Webhook',
'in' => 'query',
- 'schema' => [
- 'description' => '命令名称，支持模糊搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'waf_process',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SophonResult<List<SophonCommandBO>>',
- 'description' => '返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'title' => '传输的数据',
- 'description' => '返回的命令列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '命令详情。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '命令名称。',
- 'type' => 'string',
- 'example' => 'waf_process_ip_v2',
- ],
- 'DisplayName' => [
- 'description' => '命令的显示名称。',
- 'type' => 'string',
- 'example' => 'WAF Process IP',
- ],
- 'ParamConfig' => [
- 'description' => '参数配置信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '参数配置信息。',
- 'type' => 'object',
- 'properties' => [
- 'Necessary' => [
- 'description' => '是否必填，取值：'."\n"
- .'- **true**（默认）：必填。'."\n"
- ."\n"
- .'- **false**：非必填。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Field' => [
- 'description' => '参数字段名称。',
- 'type' => 'string',
- 'example' => 'ip',
- ],
- 'Value' => [
- 'description' => '参数值。',
- 'type' => 'string',
- 'example' => '12.xx.xx.xx',
- ],
- 'CheckField' => [
- 'description' => '字段格式校验，正则匹配的方式，如果为空，表示不进行校验。',
- 'type' => 'string',
- 'example' => '[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}',
- ],
- ],
- ],
- ],
- 'Description' => [
- 'description' => '命令描述。',
- 'type' => 'string',
- 'example' => 'This is a action of processing for WAF',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '1E1EC464-3BD7-518F-9937-BCC12E6855FE',
- ],
- ],
- ],
+ 'schema' => ['title' => 'webhook地址', 'description' => '消息中心-机器人接收管理页面配置的机器人ID集合，目前只支持钉钉机器人类型。', 'type' => 'string', 'required' => true, 'example' => '[\\"10651\\"]'],
],
- ],
- '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' => '获取处置命令',
- ],
- 'TriggerProcessTask' => [
- 'summary' => '用户在使用响应编排的功能进行事件处置时，处置中心会生成相应的处置任务，该接口用于对生成的处置任务执行后续的解除封禁、重试封禁、解除隔离等动作。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Secret',
+ 'in' => 'query',
+ 'schema' => ['title' => 'webhook消息秘钥', 'description' => '钉钉群机器人webhook消息秘钥。当前此参数已废弃，不再使用。', 'type' => 'string', 'required' => false, 'example' => 'SECc1*****e157b32b380f********bb8c70e1a67a22072'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'high',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
[
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '处置任务的唯一标识。'."\n"
- .'>调用[DescribeProcessTasks](~~DescribeProcessTasks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '15355xxxxxx82894882',
- ],
+ 'name' => 'MsgType',
+ 'in' => 'query',
+ 'schema' => ['title' => 'webhook消息类型，取值：text、markdown、actionCard', 'description' => 'webhook消息类型。取值：'."\n"
+ .'- text'."\n"
+ .'- markdown'."\n"
+ .'- actionCard', 'type' => 'string', 'required' => true, 'example' => 'text'],
],
[
- 'name' => 'ActionType',
+ 'name' => 'Content',
'in' => 'query',
- 'schema' => [
- 'title' => '处置类型',
- 'description' => '处置动作的类型，取值如下：'."\n"
- ."\n"
- .'- **remove**：表示解除封禁或隔离'."\n"
- .'- **retry**：表示重新提交任务',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'remove',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SophonResult<Void>',
- 'description' => '返回信息。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073',
- ],
- ],
- ],
+ 'schema' => ['title' => 'webhook消息正文', 'description' => '钉钉群机器人webhook发送的消息正文。', '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"
+ .'}'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\"\\n}","type":"json"}]',
- 'title' => '执行处置动作',
- ],
- 'DescribeOpenApiList' => [
- 'summary' => '获取产品的接口列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PlaybookUuid',
+ 'in' => 'query',
+ 'schema' => ['title' => '剧本uuid', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~3000306~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '94bc318c-****-4cba-****-801ccb0d739f'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '203524',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
+ [
+ 'name' => 'NodeName',
+ 'in' => 'query',
+ 'schema' => ['title' => '剧本的节点名称', 'description' => '剧本的节点名称。', 'type' => 'string', 'required' => true, 'example' => 'notify_message_node'],
],
- ],
- 'parameters' => [
[
- 'name' => 'PopCode',
+ 'name' => 'ComponentName',
'in' => 'query',
- 'schema' => [
- 'description' => '阿里云产品接口的POP CODE。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Sas',
- ],
+ 'schema' => ['title' => '剧本的组件名称', 'description' => '剧本的组件名称。', 'type' => 'string', 'required' => true, 'example' => 'NotifyMessage'],
],
[
- 'name' => 'ApiVersion',
+ 'name' => 'ActionName',
'in' => 'query',
- 'schema' => [
- 'description' => 'API的版本号。'."\n"
- .'>调用[DescribeGroupProductions](~~DescribeGroupProductions~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2021-10-01',
- ],
+ 'schema' => ['title' => '剧本的动作名称', 'description' => '剧本的动作名称。', 'type' => 'string', 'required' => true, 'example' => 'notifyByCustom'],
],
[
- 'name' => 'ApiName',
+ 'name' => 'AssetId',
'in' => 'query',
- 'schema' => [
- 'description' => 'API的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DescribePopApiItemList',
- ],
+ 'schema' => ['description' => '资源实例ID。当前此参数已废弃，不再使用。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'Lang',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleType',
'in' => 'query',
- 'schema' => [
- 'description' => '视图类型，默认为0。取值：'."\n"
- ."\n"
- .'- 0：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- 0（默认）：当前阿里云账号视图。'."\n"
+ .'- 1：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'RoleFor',
'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '137602xxx8718726',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '126339xxxx805497'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<APITreeBO>',
- 'description' => 'SophonResult<APITreeBO>',
+ 'title' => 'SophonResult<String>',
+ 'description' => 'SophonResult<String>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2',
- ],
- 'Data' => [
- 'title' => '传输的数据',
- 'description' => '返回的结果数据。',
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94'],
+ 'Data' => ['title' => '传输的数据', 'description' => '接口返回数据内容。', 'type' => 'string', 'example' => '{}'],
+ 'Page' => [
+ 'description' => '分页查询信息。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应CODE。取值：'."\n"
- .'- 200：成功'."\n"
- .'- 500：失败',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Version' => [
- 'description' => 'API版本号。',
- 'type' => 'string',
- 'example' => '2018-12-03',
- ],
- 'Directories' => [
- 'description' => '返回的API列表内容。',
- 'type' => 'any',
- 'example' => '[{"apis":[{"summary":"get account information","deprecated":false,"name":"DescAccountSummary","title":"get account information"}],"childrens":[],"title":"account"}]',
- ],
+ 'TotalCount' => ['description' => '总数，分页查询时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'PageNumber' => ['description' => '分页查询时，当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时，每页显示的条目数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
],
],
- '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' => '查询OPENAPI列表',
+ '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' => '通知组件-测试webhook发送',
'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'DescribeOpenApiInfo' => [
- 'summary' => '获取产品接口的详情。',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-09T11:25:07.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithWebhook'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:RunNotifyComponentWithWebhook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RunPython3Script' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '203523',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'PopCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '阿里云产品接口的POP CODE。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Sas',
- ],
- ],
- [
- 'name' => 'ApiVersion',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'API的版本号。'."\n"
- .'>调用[DescribeGroupProductions](~~DescribeGroupProductions~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2018-12-03',
- ],
+ 'name' => 'PythonScript',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'python3的脚本。', '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' => 'ApiName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'API的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DescribePopApiItemList',
- ],
+ 'name' => 'Params',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'python3脚本的入参。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "input1": "xx.xx.xx.xx",'."\n"
+ .' "input2": "7d"'."\n"
+ .'}'],
],
[
- 'name' => 'Lang',
- 'in' => 'query',
- 'schema' => [
- 'description' => '接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx'],
],
[
- 'name' => 'RoleType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。取值：'."\n"
- ."\n"
- .'- 0（默认）：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'name' => 'NodeName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '剧本的节点名称。', 'type' => 'string', 'required' => false, 'example' => 'python3_3'],
],
[
- 'name' => 'RoleFor',
+ 'name' => 'PythonVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1592757xxx002956',
- ],
+ 'schema' => ['title' => 'python版本。', 'description' => 'python版本。', 'type' => 'string', 'required' => false, 'example' => 'python2.0'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<APIDetailVO>',
- 'description' => 'SophonResult<APIDetailVO>',
+ 'title' => 'SophonResult<String>',
+ 'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615',
- ],
- 'Data' => [
- 'title' => '传输的数据',
- 'description' => '返回的结果数据。',
- 'type' => 'object',
- 'properties' => [
- 'OutputParams' => [
- 'description' => 'OPENAPI的输出参数。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'InputParams' => [
- 'description' => 'OPENAPI的输入参数。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'ResponseDemo' => [
- 'description' => '响应参数示例。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'Title' => [
- 'description' => 'OPENAPI标题。',
- 'type' => 'string',
- 'example' => 'describeEcs',
- ],
- 'Summary' => [
- 'description' => 'OPENAPI概要。',
- 'type' => 'string',
- 'example' => 'describeEcs',
- ],
- 'Description' => [
- 'description' => 'OPENAPI描述。',
- 'type' => 'string',
- 'example' => 'describeEcs',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'F210521C-D9BF-5264-8369-83EDDC617DB0'],
+ 'RunResult' => ['title' => '传输的数据', 'description' => '运行脚本的结果数据。', '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\\": \\"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' => '查询OPENAPI信息',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'DescribeGroupProductions' => [
- 'summary' => '获取阿里云产品的分组列表信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '203522',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '运行python3脚本',
+ 'summary' => '用于提交一段python3的代码片段并执行，只能用于数据处理。',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'responseParamsDescription' => '**RunResult**参数为JSONObject格式，包含的字段为：'."\n"
+ ."\n"
+ .'- **requestUuid**：表示该次请求的UUID，用于查询运行日志'."\n"
+ .'- **content**：表示脚本运行的结果，由用户定义',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunPython3Script'],
],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'Lang',
- 'in' => 'query',
- 'schema' => [
- 'description' => '接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
- ],
- [
- 'name' => 'RoleType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。取值：'."\n"
- ."\n"
- .'- 0（默认）：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'RoleFor',
- 'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '11824150xxx50980',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'SophonResult<List<ProductionGroup>>',
- 'description' => 'SophonResult<List<ProductionGroup>>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '358E012F-B516-599D-9Exxx-A1A361CDE615',
- ],
- 'Data' => [
- 'title' => '传输的数据',
- 'description' => '返回的结果数据集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '单条数据信息。',
- 'type' => 'object',
- 'properties' => [
- 'GroupName' => [
- 'description' => '云产品名称。',
- 'type' => 'string',
- 'example' => '数据库',
- ],
- 'Productions' => [
- 'description' => '产品信息集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '单个产品信息。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '云产品Code。',
- 'type' => 'string',
- 'example' => 'Rds',
- ],
- 'Name' => [
- 'description' => '云产品名称。',
- 'type' => 'string',
- 'example' => '云数据库 RDS',
- ],
- 'ShortName' => [
- 'description' => '云产品简短名称。',
- 'type' => 'string',
- 'example' => 'RDS',
- ],
- 'Description' => [
- 'description' => '云产品描述信息。',
- 'type' => 'string',
- 'example' => '云数据库',
- ],
- 'Group' => [
- 'description' => '分组名称。',
- 'type' => 'string',
- 'example' => '云数据库',
- ],
- 'Versions' => [
- 'description' => 'API版本集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'API版本。',
- 'type' => 'string',
- 'example' => '2014-08-15',
- ],
- ],
- 'DefaultVersion' => [
- 'description' => '默认版本。',
- 'type' => 'string',
- 'example' => '2014-08-15',
- ],
- 'DefaultDomain' => [
- 'description' => '默认请求域名。',
- 'type' => 'string',
- 'example' => 'rds.aliyuncs.com',
- ],
- 'FullDomains' => [
- 'description' => '所有域名。',
- 'type' => 'array',
- 'items' => [
- 'description' => '请求域名。',
- 'type' => 'string',
- 'example' => 'rds.aliyuncs.com',
- ],
- ],
- 'RamCode' => [
- 'description' => '资源所属的pop的ramCode。',
- 'type' => 'string',
- 'example' => 'rds',
- ],
- 'Source' => [
- 'description' => '产品的信息来源。',
- 'type' => 'string',
- 'example' => 'next',
- ],
- 'PolicyList' => [
- 'title' => '产品的ram策略集合',
- 'description' => '产品的ram策略集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'ram策略信息。',
- 'type' => 'object',
- 'properties' => [
- 'PolicyName' => [
- 'title' => 'ram策略名称',
- 'description' => 'ram策略名称。',
- 'type' => 'string',
- 'example' => 'AliyunRAMReadOnlyAccess',
- ],
- 'Type' => [
- 'title' => 'ram策略类型（全部权限OR只读权限）',
- 'description' => 'ram策略类型。取值：'."\n"
- .'- 全部权限'."\n"
- .'- 只读权限',
- 'type' => 'string',
- 'example' => '只读权限',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Page' => [
- 'description' => '分页查询信息。',
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'description' => '查询到的信息总数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:RunPython3Script',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- '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' => '获取阿里云产品的分组列表',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ '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"}]',
],
- 'DescribeNotifyTemplateList' => [
- 'summary' => '查询通知消息模版列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'TriggerPlaybook' => [
+ 'summary' => '用于触发已启用的自定义剧本或预定义剧本。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7082,830 +5502,322 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '225868',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'Lang',
- 'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
- ],
- [
- 'name' => 'RoleType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '视图类型，默认为0。取值：'."\n"
- ."\n"
- .'- 0：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '2a687089-d4dd-47d4-9709-xxxxxxxx'],
],
[
- 'name' => 'RoleFor',
- 'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '137602425xxx8726',
- ],
+ 'name' => 'InputParam',
+ 'in' => 'formData',
+ 'schema' => ['title' => '剧本的入参', 'description' => '剧本的输入参数。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
+ .' "input1": "xx.xx.xx.xx",'."\n"
+ .' "input2": "7d"'."\n"
+ .'}'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<List<NotifyTemplateDTO>>',
- 'description' => 'SophonResult<List<NotifyTemplateDTO>>',
+ 'title' => 'SophonResult<PlaybookTriggerDTO>',
+ 'description' => '请求返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573',
- ],
- 'Data' => [
- 'title' => '传输的数据',
- 'description' => '返回的结果数据。',
- 'type' => 'array',
- 'items' => [
- 'description' => '单个结果数据内容。',
- 'type' => 'object',
- 'properties' => [
- 'TemplateName' => [
- 'title' => '模版名称',
- 'description' => '模版名称。',
- 'type' => 'string',
- 'example' => 'incident generate',
- ],
- 'EventId' => [
- 'title' => '模版对应的消息事件的id',
- 'description' => '模版对应的云鸽消息事件的ID。',
- 'type' => 'string',
- 'example' => 'yundun_soar_incident_generate',
- ],
- 'Subject' => [
- 'title' => '模版的标题',
- 'description' => '模版的标题。',
- 'type' => 'string',
- 'example' => '[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)',
- ],
- 'Content' => [
- 'title' => '模版的正文',
- 'description' => '模版的正文。',
- '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' => '模版的参数。',
- 'type' => 'string',
- 'example' => '[\\"aliyunUID\\",\\"incidentName\\",\\"incidentID\\",\\"startTime\\"]',
- ],
- ],
- ],
- ],
- 'Page' => [
- 'description' => '分页查询信息。',
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'BD5A8DB6-A42C-532B-BCE8-83E69550CD59'],
+ 'TriggerUuid' => ['description' => '剧本运行的UUID，可用于获取剧本的运行结果。', 'type' => 'string', 'example' => '55E63C57-D6C8-5036-A770-5CB10AC807AA'],
],
],
],
],
- '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' => '查询模版列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD5A8DB6-A42C-532B-BCE8-83E69550CD59\\",\\n \\"TriggerUuid\\": \\"55E63C57-D6C8-5036-A770-5CB10AC807AA\\"\\n}","type":"json"}]',
+ 'title' => '触发剧本',
'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'RunNotifyComponentWithEmail' => [
- 'summary' => '执行通知组件-email发送消息。',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerPlaybook'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:TriggerPlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'TriggerProcessTask' => [
+ 'summary' => '用户在使用响应编排的功能进行事件处置时，处置中心会生成相应的处置任务，该接口用于对生成的处置任务执行后续的解除封禁、重试封禁、解除隔离等动作',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226653',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'Receivers',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'title' => '邮箱地址列表',
- 'description' => '邮箱地址列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '单个邮箱地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123xxx@163.com',
- ],
- 'required' => true,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'Subject',
- 'in' => 'query',
- 'schema' => [
- 'title' => '邮箱标题',
- 'description' => '邮件标题。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'title',
- ],
- ],
- [
- 'name' => 'Content',
- 'in' => 'query',
- 'schema' => [
- 'title' => '邮箱正文',
- 'description' => '邮件正文。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'email content',
- ],
- ],
- [
- 'name' => 'PlaybookUuid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本uuid',
- 'description' => '剧本UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e99dab31-499b-4307-9248-xxxxxx',
- ],
- ],
- [
- 'name' => 'NodeName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本的节点名称',
- 'description' => '剧本的节点名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'notify_message_1',
- ],
- ],
- [
- 'name' => 'ComponentName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本的组件名称',
- 'description' => '剧本的组件名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'NotifyMessage',
- ],
- ],
- [
- 'name' => 'ActionName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本的动作名称',
- 'description' => '组件的动作名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'notifyByCustom',
- ],
- ],
- [
- 'name' => 'AssetId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '邮件发送方的资源实例ID。'."\n"
- .'>调用[DescribeComponentAssets](~~DescribeComponentAssets~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Lang',
- 'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
- ],
- [
- 'name' => 'RoleType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。取值：'."\n"
- ."\n"
- .'- 0：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '处置任务的唯一标识。'."\n"
+ .'>调用[DescribeProcessTasks](~~DescribeProcessTasks~~)接口可以获取该参数。', 'type' => 'string', 'required' => true, 'example' => '15355xxxxxx82894882'],
],
[
- 'name' => 'RoleFor',
+ 'name' => 'ActionType',
'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '137602xxx718726',
- ],
+ 'schema' => ['title' => '处置类型', 'description' => '处置动作的类型，取值如下：'."\n"
+ ."\n"
+ .'- **remove**：表示解除封禁或隔离'."\n"
+ .'- **retry**：表示重新提交任务', 'type' => 'string', 'required' => true, 'example' => 'remove'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<String>',
- 'description' => 'SophonResult<String>',
+ 'title' => 'SophonResult<Void>',
+ 'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B',
- ],
- 'Data' => [
- 'title' => '传输的数据',
- 'description' => '返回的结果数据。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Page' => [
- 'description' => '分页查询信息。',
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073'],
],
],
],
],
- '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' => '通知组件-测试邮件发送',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'RunNotifyComponentWithMessageCenter' => [
- 'summary' => '执行通知组件-消息中心发送消息。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\"\\n}","type":"json"}]',
+ 'title' => '执行处置动作',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 5, 'regionId' => '*', 'api' => 'TriggerProcessTask'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:TriggerProcessTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'TriggerSophonPlaybook' => [
+ 'summary' => '用于触发运行剧本或响应命令。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '226714',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '149322',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'Aliuid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '要发送的aliuid',
- 'description' => '接收消息的用户ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '146789xxxx733152',
- ],
- ],
- [
- 'name' => 'EventId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '云鸽的消息事件id',
- 'description' => '云鸽的消息事件ID。取值：'."\n"
- .'- yundun_soar_incident_generate：事件生成'."\n"
- .'- yundun_soar_alert_generate：告警生成'."\n"
- .'- yundun_soar_incident_update：事件更新',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'yundun_soar_incident_generate',
- ],
- ],
- [
- 'name' => 'Params',
- 'in' => 'query',
- 'schema' => [
- 'title' => '消息参数',
- 'description' => '消息事件的模版参数。'."\n"
- .'- 事件生成：aliyunUID、incidentName、incidentID、startTime'."\n"
- .'- 告警生成：aliyunUID、alertName、alertID、startTime'."\n"
- .'- 事件更新：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' => '通道类型集合，不传则默认发送所有通道，默认不传。',
- 'type' => 'array',
- 'items' => [
- 'description' => '单个通道类型。取值：'."\n"
- .'- sms：短信'."\n"
- .'- email：邮件'."\n"
- .'- webhook：钉钉群webhook'."\n"
- .'- pmsg：站内信',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sms',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'PlaybookUuid',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本uuid',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx',
- ],
- ],
- [
- 'name' => 'NodeName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本的节点名称',
- 'description' => '剧本的节点名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'notify_message',
- ],
- ],
- [
- 'name' => 'ComponentName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本的组件名称',
- 'description' => '剧本的组件名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'NotifyMessage',
- ],
- ],
- [
- 'name' => 'ActionName',
+ 'name' => 'CommandName',
'in' => 'query',
- 'schema' => [
- 'title' => '剧本的动作名称',
- 'description' => '剧本的动作名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'notifyByMessageCenter',
- ],
+ 'schema' => ['description' => '想要触发的命令名称。'."\n"
+ .'>调用[DescribeSophonCommands](~~DescribeSophonCommands~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => 'waf_process_command'],
],
[
- 'name' => 'AssetId',
+ 'name' => 'InputParams',
'in' => 'query',
- 'schema' => [
- 'description' => '资源实例ID。当前此参数已废弃，不再使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '触发命令或剧本的输入参数。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
+ .' "param1": "xx.xx.xx.xx",'."\n"
+ .' "param2": "7d"'."\n"
+ .'}'],
],
[
- 'name' => 'Lang',
+ 'name' => 'SophonTaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '业务的自定义ID，如果触发剧本时不指定，会产生一个随机的ID，用于排查与定位问题。', 'type' => 'string', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx'],
],
[
- 'name' => 'RoleType',
+ 'name' => 'Uuid',
'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。取值：'."\n"
- ."\n"
- .'- 0（默认）：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx'],
],
[
- 'name' => 'RoleFor',
+ 'name' => 'TriggerType',
'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1467894xxx733152',
- ],
+ 'schema' => ['description' => '触发类型，取值：'."\n"
+ ."\n"
+ .'- **command**：触发命令任务'."\n"
+ .'- **playbook**：触发剧本任务', 'type' => 'string', 'required' => false, 'example' => 'playbook'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SophonResult<String>',
- 'description' => 'SophonResult<String>',
+ 'title' => 'SophonResult<SophonTaskResult>',
+ 'description' => '请求返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94',
- ],
'Data' => [
'title' => '传输的数据',
- 'description' => '接口返回数据。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Page' => [
- 'description' => '分页查询信息。',
+ 'description' => '触发命令或剧本后的返回详情。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '列表条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'SophonTaskId' => ['description' => '业务的自定义ID，如果触发剧本时不指定，会产生一个随机的ID，用于排查与定位问题。', 'type' => 'string', 'example' => 'a7c6d055-a72f-4676-bc89-3cd9edc0284c'],
],
],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54'],
],
],
],
],
- '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' => '通知组件-测试消息中心的消息发送',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'RunNotifyComponentWithWebhook' => [
- 'summary' => '执行通知组件-webhook发送消息。',
- 'methods' => [
- 'post',
+ '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' => '触发剧本或响应命令',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 2, 'regionId' => '*', 'api' => 'TriggerSophonPlaybook'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:TriggerSophonPlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'VerifyPlaybook' => [
+ 'summary' => '校验剧本的配置是否正确，编排的逻辑是否合理。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '226713',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
- 'name' => 'Webhook',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'webhook地址',
- 'description' => '消息中心-机器人接收管理页面配置的机器人ID集合，目前只支持钉钉机器人类型。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '[\\"10651\\"]',
- ],
- ],
- [
- 'name' => 'Secret',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'webhook消息秘钥',
- 'description' => '钉钉群机器人webhook消息秘钥。当前此参数已废弃，不再使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SECc1*****e157b32b380f********bb8c70e1a67a22072',
- ],
- ],
- [
- 'name' => 'MsgType',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'webhook消息类型，取值：text、markdown、actionCard',
- 'description' => 'webhook消息类型。取值：'."\n"
- .'- text'."\n"
- .'- markdown'."\n"
- .'- actionCard',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'text',
- ],
- ],
- [
- 'name' => 'Content',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'webhook消息正文',
- 'description' => '钉钉群机器人webhook发送的消息正文。',
- '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' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~3000306~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '94bc318c-****-4cba-****-801ccb0d739f',
- ],
- ],
- [
- 'name' => 'NodeName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本的节点名称',
- 'description' => '剧本的节点名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'notify_message_node',
- ],
- ],
- [
- 'name' => 'ComponentName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本的组件名称',
- 'description' => '剧本的组件名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'NotifyMessage',
- ],
- ],
- [
- 'name' => 'ActionName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '剧本的动作名称',
- 'description' => '剧本的动作名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'notifyByCustom',
- ],
- ],
- [
- 'name' => 'AssetId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '资源实例ID。当前此参数已废弃，不再使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Lang',
- 'in' => 'query',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
- ],
- [
- 'name' => 'RoleType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '视图类型。取值：'."\n"
- ."\n"
- .'- 0（默认）：当前阿里云账号视图。'."\n"
- .'- 1：企业下所有账号的视图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '剧本UUID', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => '9fcd3829-80ff-4681-be1e-4d2662c35fed'],
],
[
- 'name' => 'RoleFor',
- 'in' => 'query',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '126339xxxx805497',
- ],
+ 'name' => 'TaskFlow',
+ 'in' => 'formData',
+ 'schema' => ['title' => '剧本编辑配置', 'description' => '剧本的xml配置。', '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<String>',
- 'description' => 'SophonResult<String>',
+ 'title' => 'SophonResult<List<CheckTaskInfo>>',
+ 'description' => '剧本校验的返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '接口请求的requestId',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94',
- ],
- 'Data' => [
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54'],
+ 'CheckTaskInfos' => [
'title' => '传输的数据',
- 'description' => '接口返回数据内容。',
- 'type' => 'string',
- 'example' => '{}',
+ 'description' => '校验的结果信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RiskLevel' => ['description' => '校验信息的提示等级。取值：'."\n"
+ .'- **warn**：警告提示，在剧本运行过程中可能出现问题。'."\n"
+ .'- **error**：错误提示，剧本无法编译通过。'."\n"
+ .'- **remind**：建议提示，不影响剧本的发布与运行，建议优化剧本格式。', 'type' => 'string', 'example' => 'error'],
+ 'NodeName' => ['description' => '剧本的节点名称。', 'type' => 'string', 'example' => 'python3_3'],
+ 'Detail' => ['description' => '检查未通过时的具体错误信息。', 'type' => 'string', 'example' => 'Node [python3_3] doesn\'t have the asset information'],
+ ],
+ 'description' => '',
+ ],
],
- 'Page' => [
- 'description' => '分页查询信息。',
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'description' => '总数，分页查询时生效。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Prerequisites' => [
+ 'description' => '剧本前置检验信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PrerequisiteType' => ['description' => '检验类型。取值：'."\n"
+ .'- **role**：RAM自定义角色名称。'."\n"
+ .'- **policies**：RAM系统策略列表。', 'type' => 'string', 'example' => 'role'],
+ 'PrerequisiteValue' => ['description' => '检查内容。取值：'."\n"
+ .'- **PrerequisiteType为role**：为固定值 AliyunSiemSoarExecutionDefaultRole。'."\n"
+ .'- **PrerequisiteType为policies**：是策略名称的集合。', 'type' => 'string', 'example' => 'AliyunSiemSoarExecutionDefaultRole'],
+ ],
+ 'description' => '',
],
],
],
],
],
],
- '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' => '通知组件-测试webhook发送',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
- ],
- 'DescribeVendorApiList' => [
- 'summary' => '查询云厂商OpenApi列表。',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ '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' => '校验剧本配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPlaybook'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:VerifyPlaybook',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'VerifyPythonFile' => [
+ 'summary' => '校验Python代码片段的语法是否正确。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7913,245 +5825,241 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前分页的页码数。默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页展示时，每个分页包含的列表条目数。默认为10。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'KeyWord',
- 'in' => 'query',
- 'schema' => [
- 'description' => '关键字。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Create',
- ],
- ],
- [
- 'name' => 'ProductCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '厂商的产品标识：'."\n"
- .'- **waf**： Web应用防火墙。'."\n"
- .'- **cfw** ：云防火墙。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'waf',
- ],
- ],
- [
- 'name' => 'ApiName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '阿里云产品接口的名称，支持模糊搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AddAssetCleanConfig',
- ],
- ],
- [
- 'name' => 'VendorCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '厂商code：'."\n"
- .'- **Tencent** ：腾讯。'."\n"
- .'- **HUAWEICLOUD：** 华为。'."\n"
- .'- **Azure** ：微软云。'."\n"
- .'- **AWS** ：亚马逊云。'."\n"
- .'- **Chaitin** ：长亭。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Azure',
- ],
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => ['description' => '要校验的python代码片段。', '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' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'SophonResult<PythonVerifyDTO>',
+ 'description' => '返回校验后的代码提示信息',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94',
- ],
- 'Page' => [
- 'description' => '分页查询信息。',
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时，当前页的页码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时，每页显示的条目数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
- 'ApiList' => [
- 'description' => '产品信息。',
+ 'RequestId' => ['title' => '接口请求的requestId', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'F72685FB-A6E6-5A9A-97F7-6DC1056E63CE'],
+ 'Syntax' => [
+ 'description' => 'python代码的校验结果集，如果为空，则表示代码语法正确',
'type' => 'array',
'items' => [
- 'description' => '产品信息。',
'type' => 'object',
'properties' => [
- 'VendorCode' => [
- 'description' => '厂商code：'."\n"
- .'- **Tencent** ：腾讯。'."\n"
- .'- **HUAWEICLOUD：** 华为。'."\n"
- .'- **Azure** ：微软云。'."\n"
- .'- **AWS** ：亚马逊云。'."\n"
- .'- **Chaitin** ：长亭。',
- 'type' => 'string',
- 'example' => 'Azure',
- ],
- 'ProductCode' => [
- 'description' => '厂商的产品标识：'."\n"
- .'- **waf**： Web应用防火墙。'."\n"
- .'- **cfw** ：云防火墙。',
- 'type' => 'string',
- 'example' => 'cfw',
- ],
- 'ProductName' => [
- 'description' => '产品名称。',
- 'type' => 'string',
- 'example' => 'waf',
- ],
- 'Parameter' => [
- 'description' => '接口请求参数配置信息。',
- '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' => '产品默认的域名。',
- 'type' => 'string',
- 'example' => 'cfw.xxx.com',
- ],
- 'Protocol' => [
- 'description' => '请求协议。取值：'."\n"
- .'- **http**： HTTP请求协议。'."\n"
- .'- **https**：HTTPS请求协议。',
- 'type' => 'string',
- 'example' => 'https',
- ],
- 'Method' => [
- 'description' => '请求方式：'."\n"
- .'- **POST**： POST请求方式。'."\n"
- .'- **GET**：GET请求方式。'."\n"
- .'- **PUT**： PUT请求方式。'."\n"
- .'- **DELETE**： DELETE请求方式。',
- 'type' => 'string',
- 'example' => 'POST',
- ],
- 'ApiName' => [
- 'description' => '厂商的接口名称。',
- 'type' => 'string',
- 'example' => 'VerifyMobile',
- ],
- 'NeedPageInfo' => [
- 'description' => '是否翻页。'."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'PageInfo' => [
- 'description' => '页面显示的信息。',
- 'type' => 'string',
- 'example' => '{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}',
- ],
- 'ApiVersion' => [
- 'description' => 'API的版本号。',
- 'type' => 'string',
- 'example' => '2017-08-01',
- ],
- 'NeedAdvanceConfig' => [
- 'description' => '是包含高级配置。'."\n"
- .'- **true**： 是。'."\n"
- .'- **false**： 否。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'AdvanceConfig' => [
- 'description' => '接口高级配置。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "cmd": "DescribeAclApiDispatch"'."\n"
- .'}',
+ 'StartLineNumber' => ['description' => '报错代码的启始行数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'StartColumn' => ['description' => '报错代码的启始列数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'EndLineNumber' => ['description' => '报错代码的结束行数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'EndColumn' => ['description' => '报错代码的结束列数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'Message' => ['description' => '代码的具体报错信息', 'type' => 'string', 'example' => 'undefined name \'ab\''],
+ 'Severity' => [
+ 'description' => '代码的错误等级'."\n"
+ ."\n"
+ .'- 4 表示一般错误'."\n"
+ .'- 8 表示严重错误',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enumValueTitles' => [4 => '一般错误', 8 => '严重错误'],
+ 'example' => '4',
],
],
+ 'description' => '',
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 491 => [
+ ['errorCode' => 'Playbook.External.ParamError', 'errorMessage' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F72685FB-A6E6-5A9A-97F7-6DC1056E63CE\\",\\n \\"Syntax\\": [\\n {\\n \\"StartLineNumber\\": 2,\\n \\"StartColumn\\": 2,\\n \\"EndLineNumber\\": 5,\\n \\"EndColumn\\": 5,\\n \\"Message\\": \\"undefined name \'ab\'\\",\\n \\"Severity\\": 4\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '校验python代码片段',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPythonFile'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'yundun-sas:VerifyPythonFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-****-5840-8EC9-691B86729E94\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"ApiList\\": [\\n {\\n \\"VendorCode\\": \\"Azure\\",\\n \\"ProductCode\\": \\"cfw\\",\\n \\"ProductName\\": \\"waf\\",\\n \\"Parameter\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"Domain\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"isRequired\\\\\\": true,\\\\n \\\\\\"exampleValue\\\\\\": \\\\\\"www.***.com\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"www.***.com\\\\\\"\\\\n }\\\\n]\\",\\n \\"ProductDomain\\": \\"cfw.xxx.com\\",\\n \\"Protocol\\": \\"https\\",\\n \\"Method\\": \\"POST\\",\\n \\"ApiName\\": \\"VerifyMobile\\",\\n \\"NeedPageInfo\\": false,\\n \\"PageInfo\\": \\"{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}\\",\\n \\"ApiVersion\\": \\"2017-08-01\\",\\n \\"NeedAdvanceConfig\\": true,\\n \\"AdvanceConfig\\": \\"{\\\\n \\\\\\"cmd\\\\\\": \\\\\\"DescribeAclApiDispatch\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询多云厂商的OpenApi列表',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
],
],
'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'vpc' => 'sophonsoar-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'public', 'regionName' => '公网', 'areaId' => 'other', 'areaName' => '其它', 'public' => 'sophonsoar.aliyuncs.com', 'endpoint' => 'sophonsoar.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Component.External.NotExist', 'message' => 'Component does not exist.', 'http_code' => 400, 'description' => '组件不存在。'],
+ ['code' => 'ComponentAsset.External.NotExist', 'message' => 'The component asset is not exist.', 'http_code' => 400, 'description' => '您输入的组件对应的资产不存在，请重新输入。'],
+ ['code' => 'Playbook.Abnormal.ERROR', 'message' => 'Interface call exception, please contact the developer.', 'http_code' => 400, 'description' => '接口调用异常，请联系开发人员。'],
+ ['code' => 'Playbook.External.AccountError', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => '参数错误，请校验提供的参数后重试 : Please login with an buy user account.'],
+ ['code' => 'Playbook.External.DebugError', 'message' => 'Debugging the script failed. Please verify whether the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => '调试剧本失败，请校验剧本的状态与配置是否正确后，再尝试。'],
+ ['code' => 'Playbook.External.InvalidParameter', 'message' => 'The request parameter is incorrect. Please verify the provided parameters and try again.', 'http_code' => 400, 'description' => '请求参数错误，请校验提供的参数后重试。'],
+ ['code' => 'Playbook.External.ParamError', 'message' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'http_code' => 400, 'description' => '请求接口的参数错误，请校验参数后，重新请求。'],
+ ['code' => 'Playbook.External.PublishError', 'message' => 'Failed to publish or run the script. Please verify that the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => '发布或运行剧本失败，请校验剧本的状态与配置是否正确后，再尝试。'],
+ ['code' => 'Playbook.External.StatusError', 'message' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.', 'http_code' => 400, 'description' => '剧本或处置任务的状态异常，请检查剧本或处置任务的状态是否正确。'],
+ ['code' => 'Playbook.Internal.MetricsError', 'message' => 'The configuration information is abnormal, please check the relevant configuration.', 'http_code' => 400, 'description' => '配置信息异常，请求检查相关配置。'],
+ ['code' => 'Playbook.Internal.RecordError', 'message' => 'The data format is abnormal, please check whether the data format meets the requirements.', 'http_code' => 400, 'description' => '数据格式异常，请检查数据格式是否符要求。'],
+ ['code' => 'SYS_ERROR', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => '参数错误，请校验提供的参数后重试 : 请使用购买账号访问。'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'RunNotifyComponentWithEmail'],
+ ['description' => '请求参数发生变更', 'api' => 'RunNotifyComponentWithMessageCenter'],
+ ['description' => '请求参数发生变更', 'api' => 'RunNotifyComponentWithWebhook'],
+ ],
+ 'createdAt' => '2025-12-09T11:25:25.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'RunPython3Script'],
+ ],
+ 'createdAt' => '2025-11-27T13:31:32.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribePlaybooks'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeProcessTasks'],
+ ],
+ 'createdAt' => '2024-11-01T08:33:07.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeProcessTasks'],
+ ],
+ 'createdAt' => '2024-05-21T08:18:47.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribePlaybookInputOutput'],
+ ],
+ 'createdAt' => '2024-03-21T02:56:51.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeExecutePlaybooks'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribePlaybook'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribeProcessTasks'],
+ ],
+ 'createdAt' => '2024-03-19T03:26:23.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'public',
- 'endpoint' => 'sophonsoar.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribePlaybookInputOutput'],
+ ],
+ 'createdAt' => '2024-03-15T02:09:33.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ModifyPlaybook'],
+ ],
+ 'createdAt' => '2023-12-07T09:16:36.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeUsedInfos'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordInOutput'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookInputOutput'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentsJs'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunPython3Script'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DebugPlaybook'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerPlaybook'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupProductions'],
+ ['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTasks'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPythonFile'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarTaskAndActions'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlaybook'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentAsset'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPlaybook'],
+ ['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybooks'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentList'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssets'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeParamTags'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiList'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookReleases'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyPlaybook'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeField'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVendorApiList'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePopApi'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSophonCommands'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiInfo'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybook'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyComponentAsset'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNumberMetrics'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistinctReleases'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchModifyInstanceStatus'],
+ ['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTaskCount'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPlaybook'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertPlaybook'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInputOutput'],
+ ['threshold' => '20', 'countWindow' => 2, 'regionId' => '*', 'api' => 'TriggerSophonPlaybook'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishPlaybook'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescriberPython3ScriptLogs'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ComparePlaybooks'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExecutePlaybooks'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNotifyTemplateList'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessStatistics'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevertPlaybookRelease'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybook'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssetForm'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookMetrics'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlaybook'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLatestRecordSchema'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInstanceStatus'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithEmail'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenamePlaybookNode'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecords'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTreeData'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnumItems'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithWebhook'],
+ ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNodesOutput'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordActionOutputList'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithMessageCenter'],
+ ['threshold' => '50', 'countWindow' => 5, 'regionId' => '*', 'api' => 'TriggerProcessTask'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'ThreatDetection',
+ 'productName' => '云安全中心',
+ 'ramCodes' => ['threatdetection', 'yundun-aegis', 'yundun-sas'],
+ 'ramLevel' => '服务级',
+ 'ramConditions' => [
+ [
+ 'name' => 'acs:ResourceGroupId',
+ 'schema' => ['type' => 'String', 'description' => '资源组ID'],
+ ],
],
+ 'ramActions' => [],
+ 'resourceTypes' => [],
],
];
diff --git a/data/zh_cn/sophonsoar/2025-09-03/api-docs.php b/data/zh_cn/sophonsoar/2025-09-03/api-docs.php
index 411d808..a92c750 100644
--- a/data/zh_cn/sophonsoar/2025-09-03/api-docs.php
+++ b/data/zh_cn/sophonsoar/2025-09-03/api-docs.php
@@ -1,35 +1,17 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'sophonsoar',
- 'version' => '2025-09-03',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'sophonsoar', 'version' => '2025-09-03'],
'directories' => [
[
- 'id' => 278796,
- 'title' => '响应编排',
+ 'children' => ['CreateComponentAsset', 'DeleteComponentAsset', 'UpdateComponentAsset', 'ListComponentAssets', 'GetPlaybook', 'ListPlaybooks', 'CreatePlaybook', 'DeletePlaybook', 'UpdatePlaybook', 'ExecuteComponent'],
'type' => 'directory',
- 'children' => [
- 'ListComponents',
- 'CreateComponentAsset',
- 'DeleteComponentAsset',
- 'UpdateComponentAsset',
- 'ListComponentAssets',
- 'GetPlaybook',
- 'ListPlaybooks',
- 'CreatePlaybook',
- 'DeletePlaybook',
- 'UpdatePlaybook',
- ],
+ 'title' => '响应编排',
+ 'id' => 166866,
],
[
- 'id' => 0,
- 'title' => '其它',
+ 'children' => ['AbortPlaybookExecution', 'ListComponents'],
+ 'title' => '其他',
'type' => 'directory',
- 'children' => [
- 'ExecuteComponent',
- ],
],
],
'components' => [
@@ -38,11 +20,7 @@
'description' => '输入字段配置。',
'type' => 'object',
'properties' => [
- 'FieldName' => [
- 'description' => '字段名。',
- 'type' => 'string',
- 'example' => 'appName',
- ],
+ 'FieldName' => ['description' => '字段名。', 'type' => 'string', 'example' => 'appName'],
'FieldType' => [
'description' => '字段类型，取值如下：'."\n"
."\n"
@@ -63,63 +41,28 @@
'enumValueTitles' => [],
'example' => 'String',
],
- 'DefaultValue' => [
- 'description' => '字段默认值。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'Required' => [
- 'description' => '字段是否必填，取值如下：'."\n"
- ."\n"
- .'- **true**：必填。'."\n"
- .'- **false**：非必填。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Arrayed' => [
- 'description' => '是否数组结构，取值如下：'."\n"
- ."\n"
- .'- **true**：必填。'."\n"
- .'- **false**：非必填。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'FieldPath' => [
- 'description' => '字段的路径。',
- 'type' => 'string',
- 'example' => 'xx.appName',
- ],
- 'FieldCheckRegex' => [
- 'description' => '字段检验的正则表达式。',
- 'type' => 'string',
- 'example' => '[a-zA-Z0-9\\u4e00-\\u9fa5_-]{2,128}',
- ],
- 'FieldExample' => [
- 'description' => '字段是示例。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'FieldClass' => [
- 'description' => '字段类型，取值如下：'."\n"
- ."\n"
- .'- **normal**：普通类型。'."\n"
- ."\n"
- .'- **custom**：复杂类型，该模式下支持配置FieldConfigs 。',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- 'FieldDescription' => [
- 'description' => '字段描述信息。',
- 'type' => 'string',
- 'example' => 'app name',
- ],
+ 'DefaultValue' => ['description' => '字段默认值。', 'type' => 'string', 'example' => 'test'],
+ 'Required' => ['description' => '字段是否必填，取值如下：'."\n"
+ ."\n"
+ .'- **true**：必填。'."\n"
+ .'- **false**：非必填。', 'type' => 'boolean', 'example' => 'false'],
+ 'Arrayed' => ['description' => '是否数组结构，取值如下：'."\n"
+ ."\n"
+ .'- **true**：必填。'."\n"
+ .'- **false**：非必填。', 'type' => 'boolean', 'example' => 'false'],
+ 'FieldPath' => ['description' => '字段的路径。', 'type' => 'string', 'example' => 'xx.appName'],
+ 'FieldCheckRegex' => ['description' => '字段检验的正则表达式。', 'type' => 'string', 'example' => '[a-zA-Z0-9\\u4e00-\\u9fa5_-]{2,128}'],
+ 'FieldExample' => ['description' => '字段是示例。', 'type' => 'string', 'example' => 'test'],
+ 'FieldClass' => ['description' => '字段类型，取值如下：'."\n"
+ ."\n"
+ .'- **normal**：普通类型。'."\n"
+ ."\n"
+ .'- **custom**：复杂类型，该模式下支持配置FieldConfigs 。', 'type' => 'string', 'example' => 'normal'],
+ 'FieldDescription' => ['description' => '字段描述信息。', 'type' => 'string', 'example' => 'app name'],
'FieldConfigs' => [
'description' => '复杂类型场景下支持配置嵌套的输入参数配置。',
'type' => 'array',
- 'items' => [
- 'description' => '字段配置项。',
- '$ref' => '#/components/schemas/FieldInputConfig',
- ],
+ 'items' => ['description' => '字段配置项。', '$ref' => '#/components/schemas/FieldInputConfig'],
],
],
],
@@ -146,50 +89,29 @@
'enumValueTitles' => [],
'example' => 'String',
],
- 'FieldDescription' => [
- 'description' => '字段描述信息。',
- 'type' => 'string',
- 'example' => 'Single IP to be blocked',
- ],
- 'DefaultValue' => [
- 'description' => '字段默认值。',
- 'type' => 'string',
- 'example' => '11.**.*.11',
- ],
- 'FieldExample' => [
- 'description' => '字段示例值。',
- 'type' => 'string',
- 'example' => '2.*.*.2',
- ],
+ 'FieldDescription' => ['description' => '字段描述信息。', 'type' => 'string', 'example' => 'Single IP to be blocked'],
+ 'DefaultValue' => ['description' => '字段默认值。', 'type' => 'string', 'example' => '11.**.*.11'],
+ 'FieldExample' => ['description' => '字段示例值。', 'type' => 'string', 'example' => '2.*.*.2'],
],
],
],
],
'apis' => [
- 'ListComponents' => [
- 'summary' => '获取组件列表。',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AbortPlaybookExecution' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -197,346 +119,64 @@
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleFor',
'in' => 'formData',
- 'schema' => [
- 'description' => '资源目录成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
- ],
- [
- 'name' => 'ComponentName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SLS',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询时的页码，默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'RoleType',
'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。取值范围：1~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '视图类型。取值：'."\n"
+ ."\n"
+ .'- **0**：当前阿里云账号视图。'."\n"
+ .'- **1**：企业下所有账号的视图。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'PlaybookExecutionUuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '分页大小。取值范围：1~100。默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '剧本执行ID', 'type' => 'string', 'required' => true, 'example' => 'e776dab31-499b-4307-9248-xxxxxx'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '下一页查询开始的Token。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'kt0BLbenY2XCyRfsmoEcVg=='."\n",
- ],
+ 'schema' => ['description' => '剧本的UUID。', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '查询到的总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '52',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n",
- ],
- 'Components' => [
- 'description' => '组件列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '组件信息。',
- 'type' => 'object',
- 'properties' => [
- 'ComponentName' => [
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'example' => 'SLS',
- ],
- 'ComponentAlias' => [
- 'description' => '组件别名。',
- 'type' => 'string',
- 'example' => 'Log',
- ],
- 'ComponentDescription' => [
- 'description' => '组件描述。',
- 'type' => 'string',
- 'example' => 'Log query',
- ],
- 'ComponentLogo' => [
- 'description' => '组件的icod地址。',
- 'type' => 'string',
- 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg',
- ],
- 'ComponentExtension' => [
- 'description' => '组件的扩展信息。',
- 'type' => 'string',
- 'example' => '{"type":"common"}',
- ],
- 'ComponentActions' => [
- 'description' => '组件动作列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '组件动作。',
- 'type' => 'object',
- 'properties' => [
- 'ComponentActionName' => [
- 'description' => '组件的动作名称。',
- 'type' => 'string',
- 'example' => 'QueryLogs',
- ],
- 'ComponentActionDescription' => [
- 'description' => '组件动作名称的描述。',
- 'type' => 'string',
- 'example' => 'Query logs from SLS',
- ],
- 'InputConfigs' => [
- 'description' => '动作的输入参数配置。',
- 'type' => 'array',
- 'items' => [
- 'description' => '动作输入参数。',
- 'type' => 'object',
- 'properties' => [
- 'FieldName' => [
- 'description' => '字段名。',
- 'type' => 'string',
- 'example' => 'Project',
- ],
- 'FieldType' => [
- 'description' => '字段类型，取值如下：'."\n"
- ."\n"
- .'- **String**：字符串。'."\n"
- .'- **Long**：长整型。'."\n"
- .'- **Integer**：整型。'."\n"
- .'- **Double**：浮点型。'."\n"
- .'- **Boolean**：布尔型。'."\n"
- .'- **Complex**：键值对。',
- 'type' => 'string',
- 'example' => 'String',
- ],
- 'FieldDescription' => [
- 'description' => '字段描述信息。',
- 'type' => 'string',
- 'example' => 'Project Name',
- ],
- 'FieldDisplayConfig' => [
- 'description' => '字段展示配置。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "height": 200,'."\n"
- .' "theme": "vs-light",'."\n"
- .' "language": "markdown",'."\n"
- .' "editorOptions": {}'."\n"
- .'}',
- ],
- 'DefaultValue' => [
- 'description' => '默认值。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Required' => [
- 'description' => '该参数是否必填。'."\n"
- ."\n"
- .'- **true**：必填。'."\n"
- .'- **false**：非必填。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- ],
- 'OutputConfigs' => [
- 'description' => '动作的输出参数配置。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'FieldName' => [
- 'description' => '字段名。',
- 'type' => 'string',
- 'example' => 'lh_source',
- ],
- 'FieldType' => [
- 'description' => '字段类型，取值如下：'."\n"
- ."\n"
- .'- **String**：字符串。'."\n"
- .'- **Long**：长整型。'."\n"
- .'- **Integer**：整型。'."\n"
- .'- **Double**：浮点型。'."\n"
- .'- **Boolean**：布尔型。'."\n"
- .'- **Complex**：键值对。',
- 'type' => 'string',
- 'example' => 'String',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'ComponentAssetConfigs' => [
- 'description' => '资产字段的配置列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '资产字段的配置。',
- 'type' => 'object',
- 'properties' => [
- 'FieldName' => [
- 'description' => '字段名。',
- 'type' => 'string',
- 'example' => 'project',
- ],
- 'FieldType' => [
- 'description' => '字段类型，取值如下：'."\n"
- ."\n"
- .'- **String**：字符串。'."\n"
- .'- **Long**：长整型。'."\n"
- .'- **Integer**：整型。'."\n"
- .'- **Double**：浮点型。'."\n"
- .'- **Boolean**：布尔型。'."\n"
- .'- **Complex**：键值对。',
- 'type' => 'string',
- 'example' => 'String',
- ],
- 'FieldDescription' => [
- 'description' => '字段描述信息。',
- 'type' => 'string',
- 'example' => 'project name',
- ],
- 'Required' => [
- 'description' => '该参数是否必填。'."\n"
- ."\n"
- .'- **true**：必填。'."\n"
- .'- **false**：非必填。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Encrypted' => [
- 'description' => '字段值是否需要加密。取值范围：'."\n"
- ."\n"
- .'- true：加密。'."\n"
- .'- false：不加密。'."\n"
- ."\n"
- .'默认值：false。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DefaultValue' => [
- 'description' => '默认值。',
- 'type' => 'string',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1757902337000',
- ],
- 'UpdateTime' => [
- 'description' => '更新时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1757902337000',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'description' => '分页查询时的页码，默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。取值范围：1~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'MaxResults' => [
- 'description' => '单次请求返回结果的最大条数。取值范围：1~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'description' => '下一个查询开始的Token。',
- 'type' => 'string',
- 'example' => '7fbb1c66d607c1f79a740f039a8dcfda',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n"],
+ 'Success' => ['description' => '任务停止是否成功。取值：'."\n"
+ ."\n"
+ .'- *true*：成功停止。'."\n"
+ .'- *false*：未成功停止。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 52,\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"Components\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAlias\\": \\"Log\\",\\n \\"ComponentDescription\\": \\"Log query\\",\\n \\"ComponentLogo\\": \\"https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg\\",\\n \\"ComponentExtension\\": \\"{\\\\\\"type\\\\\\":\\\\\\"common\\\\\\"}\\",\\n \\"ComponentActions\\": [\\n {\\n \\"ComponentActionName\\": \\"QueryLogs\\",\\n \\"ComponentActionDescription\\": \\"Query logs from SLS\\",\\n \\"InputConfigs\\": [\\n {\\n \\"FieldName\\": \\"Project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"Project Name\\",\\n \\"FieldDisplayConfig\\": \\"{\\\\n \\\\\\"height\\\\\\": 200,\\\\n \\\\\\"theme\\\\\\": \\\\\\"vs-light\\\\\\",\\\\n \\\\\\"language\\\\\\": \\\\\\"markdown\\\\\\",\\\\n \\\\\\"editorOptions\\\\\\": {}\\\\n}\\",\\n \\"DefaultValue\\": \\"1\\",\\n \\"Required\\": false\\n }\\n ],\\n \\"OutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldType\\": \\"String\\"\\n }\\n ]\\n }\\n ],\\n \\"ComponentAssetConfigs\\": [\\n {\\n \\"FieldName\\": \\"project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"project name\\",\\n \\"Required\\": false,\\n \\"Encrypted\\": false,\\n \\"DefaultValue\\": \\"1\\"\\n }\\n ],\\n \\"CreateTime\\": 1757902337000,\\n \\"UpdateTime\\": 1757902337000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"7fbb1c66d607c1f79a740f039a8dcfda\\"\\n}","type":"json"}]',
- 'title' => '获取组件列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '停止剧本执行',
+ 'summary' => '停止执行剧本及其子剧本。',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'CreateComponentAsset' => [
'summary' => '创建组件对应的资产。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -548,9 +188,7 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -558,35 +196,20 @@
[
'name' => 'ComponentName',
'in' => 'formData',
- 'schema' => [
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SLS',
- ],
+ 'schema' => ['description' => '组件的名称。', 'type' => 'string', 'required' => true, 'example' => 'SLS'],
],
[
'name' => 'ComponentAssetName',
'in' => 'formData',
- 'schema' => [
- 'description' => '资产名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'shanghai-log-config',
- ],
+ 'schema' => ['description' => '资产名称。', 'type' => 'string', 'required' => true, 'example' => 'shanghai-log-config'],
],
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'ComponentAssetValues',
@@ -599,18 +222,8 @@
'description' => '资产字段信息。',
'type' => 'object',
'properties' => [
- 'FieldName' => [
- 'description' => '字段名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'endpoint',
- ],
- 'FieldValue' => [
- 'description' => '字段值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'http://logs.aliyuncs.com',
- ],
+ 'FieldName' => ['description' => '字段名。', 'type' => 'string', 'required' => true, 'example' => 'endpoint'],
+ 'FieldValue' => ['description' => '字段值。', 'type' => 'string', 'required' => true, 'example' => 'http://logs.aliyuncs.com'],
],
'required' => false,
],
@@ -620,13 +233,7 @@
[
'name' => 'RoleFor',
'in' => 'formData',
- 'schema' => [
- 'description' => '资源目录成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
+ 'schema' => ['description' => '资源目录成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
],
'responses' => [
@@ -636,36 +243,23 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '0727DAC8-****-51EC-****-14999C62B502',
- ],
- 'ComponentAssetUuid' => [
- 'description' => '资产UUID。',
- 'type' => 'string',
- 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'."\n",
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'],
+ 'ComponentAssetUuid' => ['description' => '资产UUID。', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'."\n"],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\\\n\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建资产',
'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\\\n\\"\\n}","type":"json"}]',
],
- 'DeleteComponentAsset' => [
- 'summary' => '删除组件资产。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreatePlaybook' => [
+ 'summary' => '创建剧本。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -674,12 +268,10 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -687,38 +279,131 @@
[
'name' => 'Lang',
'in' => 'formData',
+ 'schema' => ['description' => '接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => ['description' => '资源目录成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '170*********3093'],
+ ],
+ [
+ 'name' => 'PlaybookName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '剧本的名称，不包含特殊字符。', 'type' => 'string', 'required' => true, 'example' => 'waftest', 'maxLength' => 128, 'minLength' => 2],
+ ],
+ [
+ 'name' => 'PlaybookDescription',
+ 'in' => 'formData',
+ 'schema' => ['description' => '剧本描述。', 'type' => 'string', 'required' => false, 'example' => 'waf ip block', 'maxLength' => 512, 'minLength' => 0],
+ ],
+ [
+ 'name' => 'PlaybookInputConfigs',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
- ."\n"
- .'- **zh**：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
+ 'description' => '剧本的输入参数配置。',
+ 'type' => 'array',
+ 'items' => ['description' => '输入参数配置。', 'required' => false, '$ref' => '#/components/schemas/FieldInputConfig'],
'required' => false,
- 'example' => 'zh',
],
],
[
- 'name' => 'RoleFor',
+ 'name' => 'PlaybookOutputConfigs',
'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => '资源目录成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '剧本的输出参数配置。',
+ 'type' => 'array',
+ 'items' => ['description' => '输出参数配置。', 'required' => false, '$ref' => '#/components/schemas/FieldOutputConfig'],
'required' => false,
- 'example' => '13760*****718726',
],
],
[
- 'name' => 'ComponentAssetUuid',
+ 'name' => 'SrcPlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => '复制场景下需要填入的源剧本的UUID，该参数存在值时，除剧本名称和剧本描述外其余参数无效。', 'type' => 'string', 'required' => false, 'example' => '1B5A9144-****-****-A466-****9D64AA99'],
+ ],
+ [
+ 'name' => 'PlaybookTaskFlow',
'in' => 'formData',
+ 'schema' => ['description' => '剧本的工作流。', 'type' => 'string', 'required' => false, 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]'],
+ ],
+ [
+ 'name' => 'PlaybookParamType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '剧本参数类型', 'description' => '剧本的参数类型，取值如下：'."\n"
+ ."\n"
+ .'- **template-ip**：IP实体。'."\n"
+ .'- **template-file**：文件实体。'."\n"
+ .'- **template-process**：进程实体。'."\n"
+ .'- **template-host**：主机实体。'."\n"
+ .'- **template-domain**：域名实体。'."\n"
+ .'- **template-container**：容器实体。'."\n"
+ .'- **template-incident**：安全事件。'."\n"
+ .'- **template-alert**：安全告警。'."\n"
+ .'- **custom**：自定义。', 'type' => 'string', 'required' => false, 'example' => 'custom'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '资产UUID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1C5F11E9-****-51F0-****-43BB312A0557',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '007BC211-709E-549B-9534-4C8EA0922828'],
+ 'PlaybookUuid' => ['description' => '剧本的UUID。', 'type' => 'string', 'example' => 'e99dab31-499b-4307-9248-xxxxxx'],
+ ],
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建剧本',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"007BC211-709E-549B-9534-4C8EA0922828\\",\\n \\"PlaybookUuid\\": \\"e99dab31-499b-4307-9248-xxxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteComponentAsset' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => ['description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n"
+ ."\n"
+ .'- **zh**：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => ['description' => '资源目录成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
+ ],
+ [
+ 'name' => 'ComponentAssetUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => '资产UUID。', 'type' => 'string', 'required' => true, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
@@ -726,31 +411,22 @@
'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '0727DAC8-****-51EC-****-14999C62B502',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除组件资产',
+ 'summary' => '删除组件资产。',
'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\"\\n}","type":"json"}]',
],
- 'UpdateComponentAsset' => [
- 'summary' => '更新组件资产。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeletePlaybook' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -759,20 +435,113 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
+ 'in' => 'formData',
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
+ ],
+ [
+ 'name' => 'RoleFor',
+ 'in' => 'formData',
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
+ ],
+ [
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => '剧本的UUID。', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除剧本',
+ 'summary' => '用于删除指定的自定义剧本。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]',
+ ],
+ 'ExecuteComponent' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
+ 'name' => 'PlaybookUuid',
+ 'in' => 'formData',
+ 'schema' => ['title' => '剧本的UUID。', 'description' => '剧本的UUID。'."\n"
+ .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。', 'type' => 'string', 'required' => false, 'example' => 'ac343acc-1a61-4084-9a1cxxxxx'],
+ ],
+ [
+ 'name' => 'PlayBookNodeName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '当前组件在剧本中对应的节点名称。', 'type' => 'string', 'required' => false, 'example' => 'node1'],
+ ],
+ [
+ 'name' => 'ComponentName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '组件的名称。', 'description' => '组件的名称。', 'type' => 'string', 'required' => false, 'example' => 'SLS'],
+ ],
+ [
+ 'name' => 'ComponentActionName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '组件的动作名称。', 'description' => '组件的动作名称。', 'type' => 'string', 'required' => false, 'example' => 'doRequest'],
+ ],
+ [
+ 'name' => 'ComponentAssetUuid',
+ 'in' => 'formData',
+ 'schema' => ['title' => '资产UUID。', 'description' => '资产UUID。', 'type' => 'string', 'required' => false, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'],
+ ],
+ [
+ 'name' => 'ComponentInput',
+ 'in' => 'formData',
+ 'schema' => ['description' => '组件输入参数', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ ],
+ [
'name' => 'Lang',
'in' => 'formData',
'schema' => [
+ 'title' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。',
'description' => '请求和接收消息的语言类型。取值：'."\n"
."\n"
.'- **zh**（默认）：中文。'."\n"
@@ -780,107 +549,158 @@
.'- **en**：英文。',
'type' => 'string',
'required' => false,
+ 'enumValueTitles' => [],
'example' => 'zh',
],
],
- [
- 'name' => 'ComponentAssetUuid',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '资产UUID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1C5F11E9-****-51F0-****-43BB312A0557',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RunResult' => ['description' => '组件运行结果。', 'type' => 'string', 'example' => '{'."\n"
+ .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n"
+ .' "content": {'."\n"
+ .' "resultData": [],'."\n"
+ .' "success": true'."\n"
+ .' }'."\n"
+ .'}'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '执行组件',
+ 'summary' => '执行剧本中的组件，并输出组件的运行结果。',
+ 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\",\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\"\\n}","type":"json"}]',
+ ],
+ 'GetPlaybook' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ComponentAssetValues',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Lang',
'in' => 'formData',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '资产的配置信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '资产的配置信息。',
- 'type' => 'object',
- 'properties' => [
- 'FieldName' => [
- 'description' => '字段名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'lh_source',
- ],
- 'FieldValue' => [
- 'description' => '字段值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'device',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleFor',
'in' => 'formData',
- 'schema' => [
- 'description' => '资源目录成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
[
- 'name' => 'ComponentAssetName',
+ 'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '资产名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_asset',
- ],
+ 'schema' => ['description' => '剧本的UUID。', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx'],
+ ],
+ [
+ 'name' => 'PlaybookVersionType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '剧本对应的版本类型，取值如下：'."\n"
+ ."\n"
+ .'- **Draft** ：编辑态。'."\n"
+ .'- **Online**：线上版本。'."\n"
+ .'- **History**：历史版本。', 'type' => 'string', 'required' => false, 'example' => 'History'],
+ ],
+ [
+ 'name' => 'PlaybookVersion',
+ 'in' => 'formData',
+ 'schema' => ['description' => '剧本的版本ID，仅在**PlayboookVersionType**为**History**时生效。', 'type' => 'string', 'required' => false, 'example' => '36c9dcd6-****-4262-****-d508464ebd21'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回信息。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '0727DAC8-****-51EC-****-14999C62B502',
- ],
- 'ComponentAssetUuid' => [
- 'description' => '资产UUID。',
- 'type' => 'string',
- 'example' => '1C5F11E9-****-51F0-****-43BB312A0557',
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F'],
+ 'Playbook' => [
+ 'description' => '剧本的配置信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PlaybookUuid' => ['description' => '剧本UUID。', 'type' => 'string', 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx'],
+ 'PlaybookName' => ['description' => '剧本的名称，不包含特殊字符。', 'type' => 'string', 'example' => 'waftest'],
+ 'PlaybookDescription' => ['description' => '剧本描述。', 'type' => 'string', 'example' => 'waf ip blocked'],
+ 'PlaybookParamType' => ['description' => '剧本的参数类型，取值如下：'."\n"
+ ."\n"
+ .'- **template-ip**：IP实体。'."\n"
+ .'- **template-file**：文件实体。'."\n"
+ .'- **template-process**：进程实体。'."\n"
+ .'- **template-host**：主机实体。'."\n"
+ .'- **template-domain**：域名实体。'."\n"
+ .'- **template-container**：容器实体。'."\n"
+ .'- **template-incident**：安全事件。'."\n"
+ .'- **template-alert**：安全告警。'."\n"
+ .'- **custom**：自定义。', 'type' => 'string', 'example' => 'template-ip'],
+ 'PlaybookExtension' => ['description' => '剧本扩展信息。', 'type' => 'string', 'example' => '{"opCode":1}'],
+ 'PlaybookStatus' => ['description' => '剧本的发布状态，取值如下：'."\n"
+ ."\n"
+ .'- **0**：未发布。'."\n"
+ .'- **1**：已发布。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PlaybookTaskFlow' => ['description' => '剧本的工作流。', 'type' => 'string', 'example' => '[]'],
+ 'PlaybookVersion' => ['description' => '剧本的版本号。', 'type' => 'string', 'example' => '36c9dcd6-****-4262-****-d508464ebd21'],
+ 'PlaybookTaskFlowUuid' => ['description' => '剧本工作流的UUID。', 'type' => 'string', 'example' => '8ea81047-****-4481-****-fcd8557bf242'],
+ 'PlaybookParamsExample' => ['description' => '剧本的输入示例。', 'type' => 'string', 'example' => '{"ip":"1.*.*.1"}'],
+ 'CreateTime' => ['description' => '创建时间（毫秒级时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000'],
+ 'UpdateTime' => ['description' => '创建时间（毫秒级时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000'],
+ 'PlaybookInputConfigs' => [
+ 'description' => '剧本的输入参数配置列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '剧本的输入参数配置。', '$ref' => '#/components/schemas/FieldInputConfig'],
+ ],
+ 'PlaybookOutputConfigs' => [
+ 'description' => '剧本的输出参数配置列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '剧本的输出参数配置。', '$ref' => '#/components/schemas/FieldOutputConfig'],
+ ],
+ 'PlaybookType' => ['title' => '剧本类型', 'description' => '剧本类型，取值如下：'."\n"
+ ."\n"
+ .'- **preset**： 预定义剧本。'."\n"
+ .'- **user**： 自定义剧本。'."\n"
+ .'- **component**： 安全处置组件。', 'type' => 'string', 'example' => 'x6'],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\"\\n}","type":"json"}]',
- 'title' => '更新组件资产',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取剧本详情信息',
+ 'summary' => '获取剧本详情。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"Playbook\\": {\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"PlaybookName\\": \\"waftest\\",\\n \\"PlaybookDescription\\": \\"waf ip blocked\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{\\\\\\"opCode\\\\\\":1}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookTaskFlow\\": \\"[]\\",\\n \\"PlaybookVersion\\": \\"36c9dcd6-****-4262-****-d508464ebd21\\",\\n \\"PlaybookTaskFlowUuid\\": \\"8ea81047-****-4481-****-fcd8557bf242\\",\\n \\"PlaybookParamsExample\\": \\"{\\\\\\"ip\\\\\\":\\\\\\"1.*.*.1\\\\\\"}\\",\\n \\"CreateTime\\": 1731378251000,\\n \\"UpdateTime\\": 1731378251000,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"appName\\",\\n \\"FieldType\\": \\"String\\",\\n \\"DefaultValue\\": \\"test\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"xx.appName\\",\\n \\"FieldCheckRegex\\": \\"[a-zA-Z0-9\\\\\\\\u4e00-\\\\\\\\u9fa5_-]{2,128}\\",\\n \\"FieldExample\\": \\"test\\",\\n \\"FieldClass\\": \\"normal\\",\\n \\"FieldDescription\\": \\"app name\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"appName\\",\\n \\"FieldType\\": \\"String\\",\\n \\"DefaultValue\\": \\"test\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"xx.appName\\",\\n \\"FieldCheckRegex\\": \\"[a-zA-Z0-9\\\\\\\\u4e00-\\\\\\\\u9fa5_-]{2,128}\\",\\n \\"FieldExample\\": \\"test\\",\\n \\"FieldClass\\": \\"normal\\",\\n \\"FieldDescription\\": \\"app name\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"appName\\",\\n \\"FieldType\\": \\"String\\",\\n \\"DefaultValue\\": \\"test\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"xx.appName\\",\\n \\"FieldCheckRegex\\": \\"[a-zA-Z0-9\\\\\\\\u4e00-\\\\\\\\u9fa5_-]{2,128}\\",\\n \\"FieldExample\\": \\"test\\",\\n \\"FieldClass\\": \\"normal\\",\\n \\"FieldDescription\\": \\"app name\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"ip\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"Single IP to be blocked\\",\\n \\"DefaultValue\\": \\"11.**.*.11\\",\\n \\"FieldExample\\": \\"2.*.*.2\\"\\n }\\n ],\\n \\"PlaybookType\\": \\"x6\\"\\n }\\n}","type":"json"}]',
],
'ListComponentAssets' => [
- 'summary' => '获取组件对应的资产列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -892,9 +712,7 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -902,90 +720,46 @@
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleFor',
'in' => 'formData',
- 'schema' => [
- 'description' => '资源目录成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
+ 'schema' => ['description' => '资源目录成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
[
'name' => 'ComponentName',
'in' => 'formData',
- 'schema' => [
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SLS',
- ],
+ 'schema' => ['description' => '组件的名称。', 'type' => 'string', 'required' => false, 'example' => 'SLS'],
],
[
'name' => 'ComponentAssetUuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '资产UUID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1C5F11E9-****-51F0-****-43BB312A0557',
- ],
+ 'schema' => ['description' => '资产UUID。', 'type' => 'string', 'required' => false, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询时的页码，默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '分页查询时的页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。取值范围：1~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => '允许返回的最大结果数目。 取值范围：0~100个。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => '允许返回的最大结果数目。 取值范围：0~100个。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'kt0BLbenY2XCyRfsmoEcVg==',
- ],
+ 'schema' => ['description' => '是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。', 'type' => 'string', 'required' => false, 'example' => 'kt0BLbenY2XCyRfsmoEcVg=='],
],
],
'responses' => [
@@ -995,11 +769,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n",
- ],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n"],
'ComponentAssets' => [
'description' => '资产列表。',
'type' => 'array',
@@ -1007,21 +777,9 @@
'description' => '资产信息。',
'type' => 'object',
'properties' => [
- 'ComponentName' => [
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'example' => 'SLS',
- ],
- 'ComponentAssetName' => [
- 'description' => '资产名称。',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'ComponentAssetUuid' => [
- 'description' => '资产UUID。',
- 'type' => 'string',
- 'example' => '1C5F11E9-****-51F0-****-43BB312A0557',
- ],
+ 'ComponentName' => ['description' => '组件的名称。', 'type' => 'string', 'example' => 'SLS'],
+ 'ComponentAssetName' => ['description' => '资产名称。', 'type' => 'string', 'example' => 'test'],
+ 'ComponentAssetUuid' => ['description' => '资产UUID。', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'],
'ComponentAssetValues' => [
'description' => '资产的配置信息。',
'type' => 'array',
@@ -1029,83 +787,37 @@
'description' => '资产的配置信息。',
'type' => 'object',
'properties' => [
- 'FieldName' => [
- 'description' => '字段名。',
- 'type' => 'string',
- 'example' => 'lh_source',
- ],
- 'FieldValue' => [
- 'description' => '字段值。',
- 'type' => 'string',
- 'example' => 'device',
- ],
+ 'FieldName' => ['description' => '字段名。', 'type' => 'string', 'example' => 'lh_source'],
+ 'FieldValue' => ['description' => '字段值。', 'type' => 'string', 'example' => 'device'],
],
],
],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744078554000',
- ],
- 'UpdateTime' => [
- 'description' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1744078554000',
- ],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1744078554000'],
+ 'UpdateTime' => ['description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1744078554000'],
],
],
],
- 'TotalCount' => [
- 'description' => '查询到的总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '824',
- ],
- 'PageNumber' => [
- 'description' => '分页查询时的页码，默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询时设置的每页行数。取值范围：1~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'MaxResults' => [
- 'description' => '允许返回的最大结果数目。 取值范围：0~100个。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'NextToken' => [
- 'description' => '下一页查询开始的Token。',
- 'type' => 'string',
- 'example' => 'eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9',
- ],
+ 'TotalCount' => ['description' => '查询到的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '824'],
+ 'PageNumber' => ['description' => '分页查询时的页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'MaxResults' => ['description' => '允许返回的最大结果数目。 取值范围：0~100个。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'NextToken' => ['description' => '下一页查询开始的Token。', 'type' => 'string', 'example' => 'eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAssetName\\": \\"test\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\",\\n \\"ComponentAssetValues\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldValue\\": \\"device\\"\\n }\\n ],\\n \\"CreateTime\\": 1744078554000,\\n \\"UpdateTime\\": 1744078554000\\n }\\n ],\\n \\"TotalCount\\": 824,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取组件的资产列表',
+ 'summary' => '获取组件对应的资产列表。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAssetName\\": \\"test\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\",\\n \\"ComponentAssetValues\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldValue\\": \\"device\\"\\n }\\n ],\\n \\"CreateTime\\": 1744078554000,\\n \\"UpdateTime\\": 1744078554000\\n }\\n ],\\n \\"TotalCount\\": 824,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9\\"\\n}","type":"json"}]',
],
- 'GetPlaybook' => [
- 'summary' => '获取剧本详情。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListComponents' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1114,12 +826,10 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1127,59 +837,41 @@
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleFor',
'in' => 'formData',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
+ 'schema' => ['description' => '资源目录成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
[
- 'name' => 'PlaybookUuid',
+ 'name' => 'ComponentName',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e99dab31-499b-4307-9248-xxxxxx',
- ],
+ 'schema' => ['description' => '组件的名称。', 'type' => 'string', 'required' => false, 'example' => 'SLS'],
],
[
- 'name' => 'PlaybookVersionType',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本对应的版本类型，取值如下：'."\n"
- ."\n"
- .'- **Draft** ：编辑态。'."\n"
- .'- **Online**：线上版本。'."\n"
- .'- **History**：历史版本。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'History',
- ],
+ 'schema' => ['description' => '分页查询时的页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'PlaybookVersion',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的版本ID，仅在**PlayboookVersionType**为**History**时生效。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '36c9dcd6-****-4262-****-d508464ebd21',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分页大小。取值范围：1~100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '下一页查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => 'kt0BLbenY2XCyRfsmoEcVg=='."\n"],
],
],
'responses' => [
@@ -1189,139 +881,137 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F',
- ],
- 'Playbook' => [
- 'description' => '剧本的配置信息。',
- 'type' => 'object',
- 'properties' => [
- 'PlaybookUuid' => [
- 'description' => '剧本UUID。',
- 'type' => 'string',
- 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx',
- ],
- 'PlaybookName' => [
- 'description' => '剧本的名称，不包含特殊字符。',
- 'type' => 'string',
- 'example' => 'waftest',
- ],
- 'PlaybookDescription' => [
- 'description' => '剧本描述。',
- 'type' => 'string',
- 'example' => 'waf ip blocked',
- ],
- 'PlaybookParamType' => [
- 'description' => '剧本的参数类型，取值如下：'."\n"
- ."\n"
- .'- **template-ip**：IP实体。'."\n"
- .'- **template-file**：文件实体。'."\n"
- .'- **template-process**：进程实体。'."\n"
- .'- **template-host**：主机实体。'."\n"
- .'- **template-domain**：域名实体。'."\n"
- .'- **template-container**：容器实体。'."\n"
- .'- **template-incident**：安全事件。'."\n"
- .'- **template-alert**：安全告警。'."\n"
- .'- **custom**：自定义。',
- 'type' => 'string',
- 'example' => 'template-ip',
- ],
- 'PlaybookExtension' => [
- 'description' => '剧本扩展信息。',
- 'type' => 'string',
- 'example' => '{"opCode":1}',
- ],
- 'PlaybookStatus' => [
- 'description' => '剧本的发布状态，取值如下：'."\n"
- ."\n"
- .'- **0**：未发布。'."\n"
- .'- **1**：已发布。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PlaybookTaskFlow' => [
- 'description' => '剧本的工作流。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'PlaybookVersion' => [
- 'description' => '剧本的版本号。',
- 'type' => 'string',
- 'example' => '36c9dcd6-****-4262-****-d508464ebd21',
- ],
- 'PlaybookTaskFlowUuid' => [
- 'description' => '剧本工作流的UUID。',
- 'type' => 'string',
- 'example' => '8ea81047-****-4481-****-fcd8557bf242',
- ],
- 'PlaybookParamsExample' => [
- 'description' => '剧本的输入示例。',
- 'type' => 'string',
- 'example' => '{"ip":"1.*.*.1"}',
- ],
- 'CreateTime' => [
- 'description' => '创建时间（毫秒级时间戳）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1731378251000',
- ],
- 'UpdateTime' => [
- 'description' => '创建时间（毫秒级时间戳）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1731378251000',
- ],
- 'PlaybookInputConfigs' => [
- 'description' => '剧本的输入参数配置列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '剧本的输入参数配置。',
- '$ref' => '#/components/schemas/FieldInputConfig',
+ 'TotalCount' => ['description' => '查询到的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '52'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n"],
+ 'Components' => [
+ 'description' => '组件列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentName' => ['description' => '组件的名称。', 'type' => 'string', 'example' => 'SLS'],
+ 'ComponentAlias' => ['description' => '组件别名。', 'type' => 'string', 'example' => 'Log'],
+ 'ComponentDescription' => ['description' => '组件描述。', 'type' => 'string', 'example' => 'Log query'],
+ 'ComponentLogo' => ['description' => '组件的icod地址。', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg'],
+ 'ComponentExtension' => ['description' => '组件的扩展信息。', 'type' => 'string', 'example' => '{"type":"common"}'],
+ 'ComponentActions' => [
+ 'description' => '组件动作列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组件动作。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ComponentActionName' => ['description' => '组件的动作名称。', 'type' => 'string', 'example' => 'QueryLogs'],
+ 'ComponentActionDescription' => ['description' => '组件动作名称的描述。', 'type' => 'string', 'example' => 'Query logs from SLS'],
+ 'InputConfigs' => [
+ 'description' => '动作的输入参数配置。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '动作输入参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldName' => ['description' => '字段名。', 'type' => 'string', 'example' => 'Project'],
+ 'FieldType' => ['description' => '字段类型，取值如下：'."\n"
+ ."\n"
+ .'- **String**：字符串。'."\n"
+ .'- **Long**：长整型。'."\n"
+ .'- **Integer**：整型。'."\n"
+ .'- **Double**：浮点型。'."\n"
+ .'- **Boolean**：布尔型。'."\n"
+ .'- **Complex**：键值对。', 'type' => 'string', 'example' => 'String'],
+ 'FieldDescription' => ['description' => '字段描述信息。', 'type' => 'string', 'example' => 'Project Name'],
+ 'FieldDisplayConfig' => ['description' => '字段展示配置。', 'type' => 'string', 'example' => '{'."\n"
+ .' "height": 200,'."\n"
+ .' "theme": "vs-light",'."\n"
+ .' "language": "markdown",'."\n"
+ .' "editorOptions": {}'."\n"
+ .'}'],
+ 'DefaultValue' => ['description' => '默认值。', 'type' => 'string', 'example' => '1'],
+ 'Required' => ['description' => '该参数是否必填。'."\n"
+ ."\n"
+ .'- **true**：必填。'."\n"
+ .'- **false**：非必填。', 'type' => 'boolean', 'example' => 'false'],
+ ],
+ ],
+ ],
+ 'OutputConfigs' => [
+ 'description' => '动作的输出参数配置。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldName' => ['description' => '字段名。', 'type' => 'string', 'example' => 'lh_source'],
+ 'FieldType' => ['description' => '字段类型，取值如下：'."\n"
+ ."\n"
+ .'- **String**：字符串。'."\n"
+ .'- **Long**：长整型。'."\n"
+ .'- **Integer**：整型。'."\n"
+ .'- **Double**：浮点型。'."\n"
+ .'- **Boolean**：布尔型。'."\n"
+ .'- **Complex**：键值对。', 'type' => 'string', 'example' => 'String'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
],
- ],
- 'PlaybookOutputConfigs' => [
- 'description' => '剧本的输出参数配置列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '剧本的输出参数配置。',
- '$ref' => '#/components/schemas/FieldOutputConfig',
+ 'ComponentAssetConfigs' => [
+ 'description' => '资产字段的配置列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '资产字段的配置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldName' => ['description' => '字段名。', 'type' => 'string', 'example' => 'project'],
+ 'FieldType' => ['description' => '字段类型，取值如下：'."\n"
+ ."\n"
+ .'- **String**：字符串。'."\n"
+ .'- **Long**：长整型。'."\n"
+ .'- **Integer**：整型。'."\n"
+ .'- **Double**：浮点型。'."\n"
+ .'- **Boolean**：布尔型。'."\n"
+ .'- **Complex**：键值对。', 'type' => 'string', 'example' => 'String'],
+ 'FieldDescription' => ['description' => '字段描述信息。', 'type' => 'string', 'example' => 'project name'],
+ 'Required' => ['description' => '该参数是否必填。'."\n"
+ ."\n"
+ .'- **true**：必填。'."\n"
+ .'- **false**：非必填。', 'type' => 'boolean', 'example' => 'false'],
+ 'Encrypted' => ['description' => '字段值是否需要加密。取值范围：'."\n"
+ ."\n"
+ .'- true：加密。'."\n"
+ .'- false：不加密。'."\n"
+ ."\n"
+ .'默认值：false。', 'type' => 'boolean', 'example' => 'false'],
+ 'DefaultValue' => ['description' => '默认值。', 'type' => 'string', 'example' => '1'],
+ ],
+ ],
],
- ],
- 'PlaybookType' => [
- 'title' => '剧本类型',
- 'description' => '剧本类型，取值如下：'."\n"
- ."\n"
- .'- **preset**： 预定义剧本。'."\n"
- .'- **user**： 自定义剧本。'."\n"
- .'- **component**： 安全处置组件。',
- 'type' => 'string',
- 'example' => 'x6',
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1757902337000'],
+ 'UpdateTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1757902337000'],
],
],
],
+ 'PageNumber' => ['description' => '分页查询时的页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询时设置的每页行数。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'MaxResults' => ['description' => '单次请求返回结果的最大条数。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => '7fbb1c66d607c1f79a740f039a8dcfda'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"Playbook\\": {\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"PlaybookName\\": \\"waftest\\",\\n \\"PlaybookDescription\\": \\"waf ip blocked\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{\\\\\\"opCode\\\\\\":1}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookTaskFlow\\": \\"[]\\",\\n \\"PlaybookVersion\\": \\"36c9dcd6-****-4262-****-d508464ebd21\\",\\n \\"PlaybookTaskFlowUuid\\": \\"8ea81047-****-4481-****-fcd8557bf242\\",\\n \\"PlaybookParamsExample\\": \\"{\\\\\\"ip\\\\\\":\\\\\\"1.*.*.1\\\\\\"}\\",\\n \\"CreateTime\\": 1731378251000,\\n \\"UpdateTime\\": 1731378251000,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"FieldExample\\": \\"\\"\\n }\\n ],\\n \\"PlaybookType\\": \\"x6\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取剧本详情信息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取组件列表',
+ 'summary' => '获取组件列表。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 52,\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"Components\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAlias\\": \\"Log\\",\\n \\"ComponentDescription\\": \\"Log query\\",\\n \\"ComponentLogo\\": \\"https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg\\",\\n \\"ComponentExtension\\": \\"{\\\\\\"type\\\\\\":\\\\\\"common\\\\\\"}\\",\\n \\"ComponentActions\\": [\\n {\\n \\"ComponentActionName\\": \\"QueryLogs\\",\\n \\"ComponentActionDescription\\": \\"Query logs from SLS\\",\\n \\"InputConfigs\\": [\\n {\\n \\"FieldName\\": \\"Project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"Project Name\\",\\n \\"FieldDisplayConfig\\": \\"{\\\\n \\\\\\"height\\\\\\": 200,\\\\n \\\\\\"theme\\\\\\": \\\\\\"vs-light\\\\\\",\\\\n \\\\\\"language\\\\\\": \\\\\\"markdown\\\\\\",\\\\n \\\\\\"editorOptions\\\\\\": {}\\\\n}\\",\\n \\"DefaultValue\\": \\"1\\",\\n \\"Required\\": false\\n }\\n ],\\n \\"OutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldType\\": \\"String\\"\\n }\\n ]\\n }\\n ],\\n \\"ComponentAssetConfigs\\": [\\n {\\n \\"FieldName\\": \\"project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"project name\\",\\n \\"Required\\": false,\\n \\"Encrypted\\": false,\\n \\"DefaultValue\\": \\"1\\"\\n }\\n ],\\n \\"CreateTime\\": 1757902337000,\\n \\"UpdateTime\\": 1757902337000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"7fbb1c66d607c1f79a740f039a8dcfda\\"\\n}","type":"json"}]',
],
'ListPlaybooks' => [
- 'summary' => '查询剧本列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1333,9 +1023,7 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1343,84 +1031,42 @@
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。'."\n"
- .'- **zh**（默认）：中文'."\n"
- .'- **en**：英文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。'."\n"
+ .'- **zh**（默认）：中文'."\n"
+ .'- **en**：英文', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleFor',
'in' => 'formData',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询时的页码，默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '分页查询时的页码，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。取值范围：1~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页查询时设置的每页行数。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'description' => '单次请求返回结果的最大条数。取值范围：1~100。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => '单次请求返回结果的最大条数。取值范围：1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '下一个查询开始的Token。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7fbb1c****07c1f79a740f039a8dcfda',
- ],
+ 'schema' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => '7fbb1c****07c1f79a740f039a8dcfda'],
],
[
'name' => 'PlaybookStatus',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的发布状态，取值如下：'."\n"
- ."\n"
- .'- **0**：未发布。'."\n"
- .'- **1**：已发布。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '剧本的发布状态，取值如下：'."\n"
+ ."\n"
+ .'- **0**：未发布。'."\n"
+ .'- **1**：已发布。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PlaybookUuids',
@@ -1429,12 +1075,7 @@
'schema' => [
'description' => '剧本的UUID的集合。',
'type' => 'array',
- 'items' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx',
- ],
+ 'items' => ['description' => '剧本的UUID。', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx'],
'deprecated' => false,
'required' => false,
'maxItems' => 1,
@@ -1444,12 +1085,7 @@
[
'name' => 'PlaybookName',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的名称，支持模糊搜索。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo_test',
- ],
+ 'schema' => ['description' => '剧本的名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'demo_test'],
],
[
'name' => 'PlaybookParamTypes',
@@ -1458,85 +1094,53 @@
'schema' => [
'description' => '剧本输入参数类型集合。',
'type' => 'array',
- 'items' => [
- 'description' => '剧本的参数类型，取值如下：'."\n"
- ."\n"
- .'- **template-ip**：IP实体。'."\n"
- .'- **template-file**：文件实体。'."\n"
- .'- **template-process**：进程实体。'."\n"
- .'- **template-host**：主机实体。'."\n"
- .'- **template-domain**：域名实体。'."\n"
- .'- **template-container**：容器实体。'."\n"
- .'- **template-incident**：安全事件。'."\n"
- .'- **template-alert**：安全告警。'."\n"
- .'- **custom**：自定义。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'template-ip',
- ],
+ 'items' => ['description' => '剧本的参数类型，取值如下：'."\n"
+ ."\n"
+ .'- **template-ip**：IP实体。'."\n"
+ .'- **template-file**：文件实体。'."\n"
+ .'- **template-process**：进程实体。'."\n"
+ .'- **template-host**：主机实体。'."\n"
+ .'- **template-domain**：域名实体。'."\n"
+ .'- **template-container**：容器实体。'."\n"
+ .'- **template-incident**：安全事件。'."\n"
+ .'- **template-alert**：安全告警。'."\n"
+ .'- **custom**：自定义。', 'type' => 'string', 'required' => false, 'example' => 'template-ip'],
'required' => false,
],
],
[
'name' => 'PlaybookExecutionStartTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本最新执行的开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1731378251000',
- ],
+ 'schema' => ['description' => '剧本最新执行的开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731378251000'],
],
[
'name' => 'PlaybookExecutionEndTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本最新执行的结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1731379251000',
- ],
+ 'schema' => ['description' => '剧本最新执行的结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731379251000'],
],
[
'name' => 'OrderField',
'in' => 'formData',
- 'schema' => [
- 'description' => '排序字段。取值：'."\n"
- ."\n"
- .'- **UpdateTime**：按更新时间排序。'."\n"
- .'- **ExecutionTime**：按最新执行时间排序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'UpdateTime',
- ],
+ 'schema' => ['description' => '排序字段。取值：'."\n"
+ ."\n"
+ .'- **UpdateTime**：按更新时间排序。'."\n"
+ .'- **ExecutionTime**：按最新执行时间排序。', 'type' => 'string', 'required' => false, 'example' => 'UpdateTime'],
],
[
'name' => 'Order',
'in' => 'formData',
- 'schema' => [
- 'description' => '排序逻辑，默认为**desc**，取值：'."\n"
- .'- **desc** ：降序排序。'."\n"
- .'- **asc**：升序排序。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'desc',
- ],
+ 'schema' => ['description' => '排序逻辑，默认为**desc**，取值：'."\n"
+ .'- **desc** ：降序排序。'."\n"
+ .'- **asc**：升序排序。', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
'name' => 'PlaybookType',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本类型，取值如下：'."\n"
- ."\n"
- .'- **preset**： 预定义剧本。'."\n"
- .'- **user**： 自定义剧本。'."\n"
- .'- **component**： 安全处置组件。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'preset',
- ],
+ 'schema' => ['description' => '剧本类型，取值如下：'."\n"
+ ."\n"
+ .'- **preset**： 预定义剧本。'."\n"
+ .'- **user**： 自定义剧本。'."\n"
+ .'- **component**： 安全处置组件。', 'type' => 'string', 'required' => false, 'example' => 'preset'],
],
],
'responses' => [
@@ -1546,11 +1150,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73',
- ],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73'],
'Playbooks' => [
'description' => '剧本列表。',
'type' => 'array',
@@ -1558,138 +1158,66 @@
'description' => '剧本的信息。',
'type' => 'object',
'properties' => [
- 'PlaybookUuid' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx',
- ],
- 'PlaybookName' => [
- 'description' => '剧本的名称。',
- 'type' => 'string',
- 'example' => 'system_aliyun_alb_process_book',
- ],
- 'PlaybookDescription' => [
- 'description' => '剧本描述。',
- 'type' => 'string',
- 'example' => 'alb block',
- ],
- 'PlaybookType' => [
- 'description' => '剧本类型，取值如下：'."\n"
- ."\n"
- .'- **preset**： 预定义剧本。'."\n"
- .'- **user**： 自定义剧本。'."\n"
- .'- **component**： 安全处置组件。',
- 'type' => 'string',
- 'example' => 'user',
- ],
- 'PlaybookParamType' => [
- 'description' => '剧本的参数类型，取值如下：'."\n"
- ."\n"
- .'- **template-ip**：IP实体。'."\n"
- .'- **template-file**：文件实体。'."\n"
- .'- **template-process**：进程实体。'."\n"
- .'- **template-host**：主机实体。'."\n"
- .'- **template-domain**：域名实体。'."\n"
- .'- **template-container**：容器实体。'."\n"
- .'- **template-incident**：安全事件。'."\n"
- .'- **template-alert**：安全告警。'."\n"
- .'- **custom**：自定义。',
- 'type' => 'string',
- 'example' => 'template-ip',
- ],
- 'PlaybookExtension' => [
- 'description' => '剧本扩展信息。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'PlaybookStatus' => [
- 'description' => '剧本的发布状态，取值如下：'."\n"
- ."\n"
- .'- **0**：未发布。'."\n"
- .'- **1**：已发布。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'PlaybookUuid' => ['description' => '剧本的UUID。', 'type' => 'string', 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx'],
+ 'PlaybookName' => ['description' => '剧本的名称。', 'type' => 'string', 'example' => 'system_aliyun_alb_process_book'],
+ 'PlaybookDescription' => ['description' => '剧本描述。', 'type' => 'string', 'example' => 'alb block'],
+ 'PlaybookType' => ['description' => '剧本类型，取值如下：'."\n"
+ ."\n"
+ .'- **preset**： 预定义剧本。'."\n"
+ .'- **user**： 自定义剧本。'."\n"
+ .'- **component**： 安全处置组件。', 'type' => 'string', 'example' => 'user'],
+ 'PlaybookParamType' => ['description' => '剧本的参数类型，取值如下：'."\n"
+ ."\n"
+ .'- **template-ip**：IP实体。'."\n"
+ .'- **template-file**：文件实体。'."\n"
+ .'- **template-process**：进程实体。'."\n"
+ .'- **template-host**：主机实体。'."\n"
+ .'- **template-domain**：域名实体。'."\n"
+ .'- **template-container**：容器实体。'."\n"
+ .'- **template-incident**：安全事件。'."\n"
+ .'- **template-alert**：安全告警。'."\n"
+ .'- **custom**：自定义。', 'type' => 'string', 'example' => 'template-ip'],
+ 'PlaybookExtension' => ['description' => '剧本扩展信息。', 'type' => 'string', 'example' => '{}'],
+ 'PlaybookStatus' => ['description' => '剧本的发布状态，取值如下：'."\n"
+ ."\n"
+ .'- **0**：未发布。'."\n"
+ .'- **1**：已发布。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PlaybookInputConfigs' => [
'description' => '剧本的输入参数配置列表。',
'type' => 'array',
- 'items' => [
- 'description' => '剧本的输入参数配置。',
- '$ref' => '#/components/schemas/FieldInputConfig',
- ],
+ 'items' => ['description' => '剧本的输入参数配置。', '$ref' => '#/components/schemas/FieldInputConfig'],
],
'PlaybookOutputConfigs' => [
'description' => '剧本的输出参数配置列表。',
'type' => 'array',
- 'items' => [
- 'description' => '剧本的输出参数配置。',
- '$ref' => '#/components/schemas/FieldOutputConfig',
- ],
- ],
- 'CreateTime' => [
- 'description' => '创建时间（毫秒级时间戳）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1667792399000',
- ],
- 'UpdateTime' => [
- 'description' => '创建时间（毫秒级时间戳）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1731378251000',
+ 'items' => ['description' => '剧本的输出参数配置。', '$ref' => '#/components/schemas/FieldOutputConfig'],
],
+ 'CreateTime' => ['description' => '创建时间（毫秒级时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1667792399000'],
+ 'UpdateTime' => ['description' => '创建时间（毫秒级时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000'],
],
],
],
- 'TotalCount' => [
- 'description' => '查询到的总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageNumber' => [
- 'description' => '当前分页的页码数。默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页查询，每页显示的条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'MaxResults' => [
- 'description' => '允许返回的最大结果数目。 取值范围：0~100个。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'NextToken' => [
- 'description' => '下一页查询开始的Token。',
- 'type' => 'string',
- 'example' => '7fbb1c****07c1f79a740f039a8dcfda',
- ],
+ 'TotalCount' => ['description' => '查询到的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageNumber' => ['description' => '当前分页的页码数。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页查询，每页显示的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'MaxResults' => ['description' => '允许返回的最大结果数目。 取值范围：0~100个。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'NextToken' => ['description' => '下一页查询开始的Token。', 'type' => 'string', 'example' => '7fbb1c****07c1f79a740f039a8dcfda'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Playbooks\\": [\\n {\\n \\"PlaybookUuid\\": \\"bb5a8640-a14f-44ef-8376-cxxxxx\\",\\n \\"PlaybookName\\": \\"system_aliyun_alb_process_book\\",\\n \\"PlaybookDescription\\": \\"alb block\\",\\n \\"PlaybookType\\": \\"user\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"FieldExample\\": \\"\\"\\n }\\n ],\\n \\"CreateTime\\": 1667792399000,\\n \\"UpdateTime\\": 1731378251000\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"7fbb1c****07c1f79a740f039a8dcfda\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询剧本列表',
+ 'summary' => '查询剧本列表。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Playbooks\\": [\\n {\\n \\"PlaybookUuid\\": \\"bb5a8640-a14f-44ef-8376-cxxxxx\\",\\n \\"PlaybookName\\": \\"system_aliyun_alb_process_book\\",\\n \\"PlaybookDescription\\": \\"alb block\\",\\n \\"PlaybookType\\": \\"user\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"appName\\",\\n \\"FieldType\\": \\"String\\",\\n \\"DefaultValue\\": \\"test\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"xx.appName\\",\\n \\"FieldCheckRegex\\": \\"[a-zA-Z0-9\\\\\\\\u4e00-\\\\\\\\u9fa5_-]{2,128}\\",\\n \\"FieldExample\\": \\"test\\",\\n \\"FieldClass\\": \\"normal\\",\\n \\"FieldDescription\\": \\"app name\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"appName\\",\\n \\"FieldType\\": \\"String\\",\\n \\"DefaultValue\\": \\"test\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"xx.appName\\",\\n \\"FieldCheckRegex\\": \\"[a-zA-Z0-9\\\\\\\\u4e00-\\\\\\\\u9fa5_-]{2,128}\\",\\n \\"FieldExample\\": \\"test\\",\\n \\"FieldClass\\": \\"normal\\",\\n \\"FieldDescription\\": \\"app name\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"appName\\",\\n \\"FieldType\\": \\"String\\",\\n \\"DefaultValue\\": \\"test\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"xx.appName\\",\\n \\"FieldCheckRegex\\": \\"[a-zA-Z0-9\\\\\\\\u4e00-\\\\\\\\u9fa5_-]{2,128}\\",\\n \\"FieldExample\\": \\"test\\",\\n \\"FieldClass\\": \\"normal\\",\\n \\"FieldDescription\\": \\"app name\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"ip\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"Single IP to be blocked\\",\\n \\"DefaultValue\\": \\"11.**.*.11\\",\\n \\"FieldExample\\": \\"2.*.*.2\\"\\n }\\n ],\\n \\"CreateTime\\": 1667792399000,\\n \\"UpdateTime\\": 1731378251000\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"7fbb1c****07c1f79a740f039a8dcfda\\"\\n}","type":"json"}]',
],
- 'CreatePlaybook' => [
- 'summary' => '创建剧本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateComponentAsset' => [
+ 'summary' => '更新组件资产。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1701,9 +1229,7 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1711,244 +1237,69 @@
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
- ],
- [
- 'name' => 'RoleFor',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '资源目录成员账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '170*********3093',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
- 'name' => 'PlaybookName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的名称，不包含特殊字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'waftest',
- 'maxLength' => 128,
- 'minLength' => 2,
- ],
- ],
- [
- 'name' => 'PlaybookDescription',
+ 'name' => 'ComponentAssetUuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'waf ip block',
- 'maxLength' => 512,
- 'minLength' => 0,
- ],
+ 'schema' => ['description' => '资产UUID。', 'type' => 'string', 'required' => true, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'],
],
[
- 'name' => 'PlaybookInputConfigs',
- 'in' => 'formData',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '剧本的输入参数配置。',
- 'type' => 'array',
- 'items' => [
- 'description' => '输入参数配置。',
- 'required' => false,
- '$ref' => '#/components/schemas/FieldInputConfig',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'PlaybookOutputConfigs',
+ 'name' => 'ComponentAssetValues',
'in' => 'formData',
'style' => 'flat',
'schema' => [
- 'description' => '剧本的输出参数配置。',
+ 'description' => '资产的配置信息。',
'type' => 'array',
'items' => [
- 'description' => '输出参数配置。',
- 'required' => false,
- '$ref' => '#/components/schemas/FieldOutputConfig',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'SrcPlaybookUuid',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '复制场景下需要填入的源剧本的UUID，该参数存在值时，除剧本名称和剧本描述外其余参数无效。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1B5A9144-****-****-A466-****9D64AA99',
- ],
- ],
- [
- 'name' => 'PlaybookTaskFlow',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的工作流。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]',
- ],
- ],
- [
- 'name' => 'PlaybookParamType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本参数类型',
- 'description' => '剧本的参数类型，取值如下：'."\n"
- ."\n"
- .'- **template-ip**：IP实体。'."\n"
- .'- **template-file**：文件实体。'."\n"
- .'- **template-process**：进程实体。'."\n"
- .'- **template-host**：主机实体。'."\n"
- .'- **template-domain**：域名实体。'."\n"
- .'- **template-container**：容器实体。'."\n"
- .'- **template-incident**：安全事件。'."\n"
- .'- **template-alert**：安全告警。'."\n"
- .'- **custom**：自定义。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'custom',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '007BC211-709E-549B-9534-4C8EA0922828',
- ],
- 'PlaybookUuid' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'example' => 'e99dab31-499b-4307-9248-xxxxxx',
+ 'description' => '资产的配置信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FieldName' => ['description' => '字段名。', 'type' => 'string', 'required' => false, 'example' => 'lh_source'],
+ 'FieldValue' => ['description' => '字段值。', 'type' => 'string', 'required' => false, 'example' => 'device'],
],
+ 'required' => false,
],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"007BC211-709E-549B-9534-4C8EA0922828\\",\\n \\"PlaybookUuid\\": \\"e99dab31-499b-4307-9248-xxxxxx\\"\\n}","type":"json"}]',
- 'title' => '创建剧本',
- ],
- 'DeletePlaybook' => [
- 'summary' => '用于删除指定的自定义剧本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'Lang',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
'required' => false,
- 'example' => 'zh',
],
],
[
'name' => 'RoleFor',
'in' => 'formData',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
+ 'schema' => ['description' => '资源目录成员账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
[
- 'name' => 'PlaybookUuid',
+ 'name' => 'ComponentAssetName',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e99dab31-499b-4307-9248-xxxxxx',
- ],
+ 'schema' => ['description' => '资产名称。', 'type' => 'string', 'required' => false, 'example' => 'test_asset'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回信息。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'],
+ 'ComponentAssetUuid' => ['description' => '资产UUID。', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]',
- 'title' => '删除剧本',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新组件资产',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\"\\n}","type":"json"}]',
],
'UpdatePlaybook' => [
- 'summary' => '更新剧本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1960,9 +1311,7 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
+ 'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -1970,47 +1319,26 @@
[
'name' => 'Lang',
'in' => 'formData',
- 'schema' => [
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**：（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zh',
- ],
+ 'schema' => ['description' => '请求和接收消息的语言类型。取值：'."\n"
+ ."\n"
+ .'- **zh**：（默认）：中文。'."\n"
+ ."\n"
+ .'- **en**：英文。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'RoleFor',
'in' => 'formData',
- 'schema' => [
- 'description' => '管理员切换成其他成员视角的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '13760*****718726',
- ],
+ 'schema' => ['description' => '管理员切换成其他成员视角的用户ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726'],
],
[
'name' => 'PlaybookName',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'system_aliyun_alb_process_book',
- ],
+ 'schema' => ['description' => '剧本的名称。', 'type' => 'string', 'required' => false, 'example' => 'system_aliyun_alb_process_book'],
],
[
'name' => 'PlaybookDescription',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alb block',
- ],
+ 'schema' => ['description' => '剧本描述。', 'type' => 'string', 'required' => false, 'example' => 'alb block'],
],
[
'name' => 'PlaybookInputConfigs',
@@ -2019,11 +1347,7 @@
'schema' => [
'description' => '剧本的输入参数配置列表。',
'type' => 'array',
- 'items' => [
- 'description' => '剧本的输入参数配置。',
- 'required' => false,
- '$ref' => '#/components/schemas/FieldInputConfig',
- ],
+ 'items' => ['description' => '剧本的输入参数配置。', 'required' => false, '$ref' => '#/components/schemas/FieldInputConfig'],
'required' => false,
],
],
@@ -2034,53 +1358,34 @@
'schema' => [
'description' => '剧本的输出参数配置列表。',
'type' => 'array',
- 'items' => [
- 'description' => '剧本的输出参数配置。',
- 'required' => false,
- '$ref' => '#/components/schemas/FieldOutputConfig',
- ],
+ 'items' => ['description' => '剧本的输出参数配置。', 'required' => false, '$ref' => '#/components/schemas/FieldOutputConfig'],
'required' => false,
],
],
[
'name' => 'PlaybookTaskFlow',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本内容。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]',
- ],
+ 'schema' => ['description' => '剧本内容。', 'type' => 'string', 'required' => false, 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]'],
],
[
'name' => 'PlaybookParamType',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的入参类型。'."\n"
- ."\n"
- .'- **template-ip**：IP实体。'."\n"
- .'- **template-file**：文件实体。'."\n"
- .'- **template-process**：进程实体。'."\n"
- .'- **template-host**：主机实体。'."\n"
- .'- **template-domain**：域名实体。'."\n"
- .'- **template-container**：容器实体。'."\n"
- .'- **template-incident**：安全事件。'."\n"
- .'- **template-alert**：安全告警。'."\n"
- .'- **custom**：自定义。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'template-ip',
- ],
+ 'schema' => ['description' => '剧本的入参类型。'."\n"
+ ."\n"
+ .'- **template-ip**：IP实体。'."\n"
+ .'- **template-file**：文件实体。'."\n"
+ .'- **template-process**：进程实体。'."\n"
+ .'- **template-host**：主机实体。'."\n"
+ .'- **template-domain**：域名实体。'."\n"
+ .'- **template-container**：容器实体。'."\n"
+ .'- **template-incident**：安全事件。'."\n"
+ .'- **template-alert**：安全告警。'."\n"
+ .'- **custom**：自定义。', 'type' => 'string', 'required' => false, 'example' => 'template-ip'],
],
[
'name' => 'PlaybookUuid',
'in' => 'formData',
- 'schema' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx',
- ],
+ 'schema' => ['description' => '剧本的UUID。', 'type' => 'string', 'required' => true, 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx'],
],
],
'responses' => [
@@ -2090,183 +1395,51 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE',
- ],
- 'PlaybookUuid' => [
- 'description' => '剧本的UUID。',
- 'type' => 'string',
- 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE'],
+ 'PlaybookUuid' => ['description' => '剧本的UUID。', 'type' => 'string', 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PlaybookUuid\\": \\"8f55e76d-b5d5-4720-9cd7-xxxxx\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新剧本',
- ],
- 'ExecuteComponent' => [
- 'summary' => '执行剧本中的组件，并输出组件的运行结果。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsas104PTS',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'PlaybookUuid',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '剧本的UUID。',
- 'description' => '剧本的UUID。'."\n"
- .'>调用[DescribePlaybooks](~~DescribePlaybooks~~)接口可以获取该参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ac343acc-1a61-4084-9a1cxxxxx',
- ],
- ],
- [
- 'name' => 'PlayBookNodeName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '当前组件在剧本中对应的节点名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'node1',
- ],
- ],
- [
- 'name' => 'ComponentName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '组件的名称。',
- 'description' => '组件的名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SLS',
- ],
- ],
- [
- 'name' => 'ComponentActionName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '组件的动作名称。',
- 'description' => '组件的动作名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'doRequest',
- ],
- ],
- [
- 'name' => 'ComponentAssetUuid',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '资产UUID。',
- 'description' => '资产UUID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1C5F11E9-****-51F0-****-43BB312A0557',
- ],
- ],
- [
- 'name' => 'ComponentInput',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '组件输入参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- ],
- [
- 'name' => 'Lang',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'description' => '请求和接收消息的语言类型。取值：'."\n"
- ."\n"
- .'- **zh**（默认）：中文。'."\n"
- ."\n"
- .'- **en**：英文。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'zh',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RunResult' => [
- 'description' => '组件运行结果。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n"
- .' "content": {'."\n"
- .' "resultData": [],'."\n"
- .' "success": true'."\n"
- .' }'."\n"
- .'}',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\",\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\"\\n}","type":"json"}]',
- 'title' => '执行组件',
- 'description' => '请确保在使用该接口前，已充分了解响应编排产品（即威胁分析与响应日志接入流量）的收费方式和[价格](https://www.aliyun.com/price/product#/sas/detail/sas)。',
+ 'summary' => '更新剧本。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PlaybookUuid\\": \\"8f55e76d-b5d5-4720-9cd7-xxxxx\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'public',
- 'endpoint' => 'sophonsoar.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com',
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'vpc' => 'sophonsoar-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'public', 'regionName' => '公网', 'areaId' => 'other', 'areaName' => '其它', 'public' => 'sophonsoar.aliyuncs.com', 'endpoint' => 'sophonsoar.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'Component.External.NotExist', 'message' => 'Component does not exist.', 'http_code' => 400, 'description' => '组件不存在。'],
+ ['code' => 'ComponentAsset.External.NotExist', 'message' => 'The component asset is not exist.', 'http_code' => 400, 'description' => '您输入的组件对应的资产不存在，请重新输入。'],
+ ['code' => 'Playbook.Abnormal.ERROR', 'message' => 'Interface call exception, please contact the developer.', 'http_code' => 400, 'description' => '接口调用异常，请联系开发人员。'],
+ ['code' => 'Playbook.External.AccountError', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => '参数错误，请校验提供的参数后重试 : Please login with an buy user account.'],
+ ['code' => 'Playbook.External.DebugError', 'message' => 'Debugging the script failed. Please verify whether the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => '调试剧本失败，请校验剧本的状态与配置是否正确后，再尝试。'],
+ ['code' => 'Playbook.External.InvalidParameter', 'message' => 'The request parameter is incorrect. Please verify the provided parameters and try again.', 'http_code' => 400, 'description' => '请求参数错误，请校验提供的参数后重试。'],
+ ['code' => 'Playbook.External.ParamError', 'message' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'http_code' => 400, 'description' => '请求接口的参数错误，请校验参数后，重新请求。'],
+ ['code' => 'Playbook.External.PublishError', 'message' => 'Failed to publish or run the script. Please verify that the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => '发布或运行剧本失败，请校验剧本的状态与配置是否正确后，再尝试。'],
+ ['code' => 'Playbook.External.StatusError', 'message' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.', 'http_code' => 400, 'description' => '剧本或处置任务的状态异常，请检查剧本或处置任务的状态是否正确。'],
+ ['code' => 'Playbook.Internal.MetricsError', 'message' => 'The configuration information is abnormal, please check the relevant configuration.', 'http_code' => 400, 'description' => '配置信息异常，请求检查相关配置。'],
+ ['code' => 'Playbook.Internal.RecordError', 'message' => 'The data format is abnormal, please check whether the data format meets the requirements.', 'http_code' => 400, 'description' => '数据格式异常，请检查数据格式是否符要求。'],
+ ['code' => 'SYS_ERROR', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => '参数错误，请校验提供的参数后重试 : 请使用购买账号访问。'],
+ ],
+ 'changeSet' => [],
+ 'ram' => [
+ 'productCode' => 'ThreatDetection',
+ 'productName' => '云安全中心',
+ 'ramCodes' => ['threatdetection', 'yundun-aegis', 'yundun-sas'],
+ 'ramLevel' => '服务级',
+ 'ramConditions' => [
+ [
+ 'name' => 'acs:ResourceGroupId',
+ 'schema' => ['type' => 'String', 'description' => '资源组ID'],
+ ],
],
+ 'ramActions' => [],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 17:53:22 +0000