diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/sophonsoar/2025-09-03/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/zh_cn/sophonsoar/2025-09-03/api-docs.php')
| -rw-r--r-- | data/zh_cn/sophonsoar/2025-09-03/api-docs.php | 2373 |
1 files changed, 773 insertions, 1600 deletions
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' => [], ], ]; |
