'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'sophonsoar', 'version' => '2025-09-03', ], 'directories' => [ [ 'id' => 278796, 'title' => 'Orchestration Automation and Response‌', 'type' => 'directory', 'children' => [ 'ListComponents', 'CreateComponentAsset', 'DeleteComponentAsset', 'UpdateComponentAsset', 'ListComponentAssets', 'GetPlaybook', 'ListPlaybooks', 'CreatePlaybook', 'DeletePlaybook', 'UpdatePlaybook', ], ], [ 'id' => 0, 'title' => '其它', 'type' => 'directory', 'children' => [ 'ExecuteComponent', ], ], ], 'components' => [ 'schemas' => [ 'FieldInputConfig' => [ 'description' => 'Configuration of input parameters.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'appName', 'backendName' => 'fieldName', ], 'FieldType' => [ 'description' => 'The field type. The value is as follows:'."\n" ."\n" .'- **String**: String.'."\n" .'- **Long**: Long integer.'."\n" .'- **Integer**: Integer.'."\n" .'- **Double**: Floating-point type.'."\n" .'- **Boolean**: Boolean.'."\n" .'- **ip**: The IP entity.'."\n" .'- **file**: file entity.'."\n" .'- **process**: process entity.'."\n" .'- **incident**: event entity.'."\n" .'- **alert**: alert entity.'."\n" .'- **host**: host entity.'."\n" .'- **domain**: The domain name entity.'."\n" .'- **container**: container entity.', 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'String', 'backendName' => 'fieldType', ], 'DefaultValue' => [ 'description' => 'Field default value.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'defaultValue', ], 'Required' => [ 'description' => 'Is the field mandatory? Possible values are:'."\n" ."\n" .'- **true**: Required.'."\n" .'- **false**: Optional.', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'required', ], 'Arrayed' => [ 'description' => 'Is the field arrayed? Possible values are:'."\n" ."\n" .'- true: Arrayed.'."\n" .'- false: Not Arrayed.', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'arrayed', ], 'FieldPath' => [ 'description' => 'Field path.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'xx.appName', 'backendName' => 'fieldPath', ], 'FieldCheckRegex' => [ 'description' => 'Field check regex.', 'visibility' => 'Public', 'type' => 'string', 'example' => '[a-zA-Z0-9\\u4e00-\\u9fa5_-]{2,128}', 'backendName' => 'fieldCheckRegex', ], 'FieldExample' => [ 'description' => 'Field example.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test', 'backendName' => 'fieldExample', ], 'FieldClass' => [ 'description' => 'Field types, with the following values:'."\n" ."\n" .'- **normal**: Normal type.'."\n" .'- **custom**: Complex type; in this mode, FieldConfigs can be configured.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'normal', 'backendName' => 'fieldClass', ], 'FieldDescription' => [ 'description' => 'Field description.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'app name', 'backendName' => 'fieldDescription', ], 'FieldConfigs' => [ 'description' => 'Supports configuring nested input parameters in complex-type scenarios.', 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'Configuration of input parameters.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/FieldInputConfig', ], 'backendName' => 'fieldConfigs', ], ], ], 'FieldOutputConfig' => [ 'description' => 'Configuration of output parameters.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'ip', 'backendName' => 'fieldName', ], 'FieldType' => [ 'description' => 'Field type, with the following values:'."\n" ."\n" .'- **String**: String.'."\n" .'- **Long**: Long integer.'."\n" .'- **Integer**: Integer.'."\n" .'- **Double**: Double.'."\n" .'- **Boolean**: Boolean.', 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'String', 'backendName' => 'fieldType', ], 'FieldDescription' => [ 'description' => 'Field description information.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Single IP to be blocked', 'backendName' => 'fieldDescription', ], 'DefaultValue' => [ 'description' => 'Field default value.', 'visibility' => 'Public', 'type' => 'string', 'example' => '11.**.*.11', 'backendName' => 'defaultValue', ], 'FieldExample' => [ 'description' => 'Field example.', 'visibility' => 'Public', 'type' => 'string', 'example' => '2.*.*.2', 'backendName' => 'fieldExample', ], ], ], ], ], 'apis' => [ 'ListComponents' => [ 'summary' => 'Get Component List.', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language type for the request and response. Values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'Resource directory member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], [ 'name' => 'ComponentName', 'in' => 'formData', 'schema' => [ 'description' => 'The name of the component.', 'type' => 'string', 'required' => false, 'example' => 'SLS', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => 'The page number for pagination, with a default value of 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => 'The number of items per page for pagination. Range: 1~100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => [ 'description' => 'The size of the page. Range: 1~100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'description' => 'The token to start the next page query.', 'type' => 'string', 'required' => false, 'example' => 'kt0BLbenY2XCyRfsmoEcVg=='."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => 'The total number of items found.', 'type' => 'integer', 'format' => 'int32', 'example' => '52', ], 'RequestId' => [ 'description' => 'The unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n", ], 'Components' => [ 'description' => 'List of components.', 'type' => 'array', 'items' => [ 'description' => 'Component information.', 'type' => 'object', 'properties' => [ 'ComponentName' => [ 'description' => 'The name of the component.', 'type' => 'string', 'example' => 'SLS', ], 'ComponentAlias' => [ 'description' => 'The alias of the component.', 'type' => 'string', 'example' => 'Log', ], 'ComponentDescription' => [ 'description' => 'The description of the component.', 'type' => 'string', 'example' => 'Log query', ], 'ComponentLogo' => [ 'description' => 'The icon URL of the component.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg', ], 'ComponentExtension' => [ 'description' => 'Extended information of the component.', 'type' => 'string', 'example' => '{"type":"common"}', ], 'ComponentActions' => [ 'description' => 'List of component actions.', 'type' => 'array', 'items' => [ 'description' => 'Component action.', 'type' => 'object', 'properties' => [ 'ComponentActionName' => [ 'description' => 'The name of the component action.', 'type' => 'string', 'example' => 'QueryLogs', ], 'ComponentActionDescription' => [ 'description' => 'The description of the component action name.', 'type' => 'string', 'example' => 'Query logs from SLS', ], 'InputConfigs' => [ 'description' => 'Configuration of input parameters for the action.', 'type' => 'array', 'items' => [ 'description' => 'Input parameters for the action.', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'type' => 'string', 'example' => 'Project', ], 'FieldType' => [ 'description' => 'Field type, with the following values:'."\n" ."\n" .'- **String**: String.'."\n" .'- **Long**: Long integer.'."\n" .'- **Integer**: Integer.'."\n" .'- **Double**: Double.'."\n" .'- **Boolean**: Boolean.'."\n" .'- **Complex**: Key-value pair.', 'type' => 'string', 'example' => 'String', ], 'FieldDescription' => [ 'description' => 'Field description information.', 'type' => 'string', 'example' => 'Project Name', ], 'FieldDisplayConfig' => [ 'description' => 'Field display configuration.', 'type' => 'string', 'example' => '{'."\n" .' "height": 200,'."\n" .' "theme": "vs-light",'."\n" .' "language": "markdown",'."\n" .' "editorOptions": {}'."\n" .'}', ], 'DefaultValue' => [ 'description' => 'Default value.', 'type' => 'string', 'example' => '1', ], 'Required' => [ 'description' => 'Whether this parameter is required.'."\n" ."\n" .'- **true**: Required.'."\n" .'- **false**: Not required.', 'type' => 'boolean', 'example' => 'false', ], ], ], ], 'OutputConfigs' => [ 'description' => 'Action output parameter configuration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'type' => 'string', 'example' => 'lh_source', ], 'FieldType' => [ 'description' => 'Field type, with the following values:'."\n" ."\n" .'- **String**: String.'."\n" .'- **Long**: Long integer.'."\n" .'- **Integer**: Integer.'."\n" .'- **Double**: Double.'."\n" .'- **Boolean**: Boolean.'."\n" .'- **Complex**: Key-value pair.', 'type' => 'string', 'example' => 'String', ], ], ], ], ], ], ], 'ComponentAssetConfigs' => [ 'description' => 'List of asset field configurations.', 'type' => 'array', 'items' => [ 'description' => 'Asset field configuration.', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'type' => 'string', 'example' => 'project', ], 'FieldType' => [ 'description' => 'Field type, with the following values:'."\n" ."\n" .'- **String**: String.'."\n" .'- **Long**: Long integer.'."\n" .'- **Integer**: Integer.'."\n" .'- **Double**: Double.'."\n" .'- **Boolean**: Boolean.'."\n" .'- **Complex**: Key-value pair.', 'type' => 'string', 'example' => 'String', ], 'FieldDescription' => [ 'description' => 'Description of the field.', 'type' => 'string', 'example' => 'project name', ], 'Required' => [ 'description' => 'Whether this parameter is required.'."\n" ."\n" .'- **true**: Required.'."\n" .'- **false**: Not required.', 'type' => 'boolean', 'example' => 'false', ], 'Encrypted' => [ 'description' => 'Whether the field value needs to be encrypted. The range of values is as follows:'."\n" ."\n" .'- true: Encrypted.'."\n" .'- false: Not encrypted.'."\n" ."\n" .'Default value: false.', 'type' => 'boolean', 'example' => 'false', ], 'DefaultValue' => [ 'description' => 'Default value.', 'type' => 'string', 'example' => '1', ], ], ], ], 'CreateTime' => [ 'description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757902337000', ], 'UpdateTime' => [ 'description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757902337000', ], ], ], ], 'PageNumber' => [ 'description' => 'Page number for pagination, with a default value of 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'Number of items per page for pagination. Range: 1~100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'MaxResults' => [ 'description' => 'Maximum number of results returned in a single request. Range: 1~100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'NextToken' => [ 'description' => 'Token for the start of the next query.', 'type' => 'string', 'example' => '7fbb1c66d607c1f79a740f039a8dcfda', ], ], ], ], ], 'errorCodes' => [], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 52,\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"Components\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAlias\\": \\"Log\\",\\n \\"ComponentDescription\\": \\"Log query\\",\\n \\"ComponentLogo\\": \\"https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg\\",\\n \\"ComponentExtension\\": \\"{\\\\\\"type\\\\\\":\\\\\\"common\\\\\\"}\\",\\n \\"ComponentActions\\": [\\n {\\n \\"ComponentActionName\\": \\"QueryLogs\\",\\n \\"ComponentActionDescription\\": \\"Query logs from SLS\\",\\n \\"InputConfigs\\": [\\n {\\n \\"FieldName\\": \\"Project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"Project Name\\",\\n \\"FieldDisplayConfig\\": \\"{\\\\n \\\\\\"height\\\\\\": 200,\\\\n \\\\\\"theme\\\\\\": \\\\\\"vs-light\\\\\\",\\\\n \\\\\\"language\\\\\\": \\\\\\"markdown\\\\\\",\\\\n \\\\\\"editorOptions\\\\\\": {}\\\\n}\\",\\n \\"DefaultValue\\": \\"1\\",\\n \\"Required\\": false\\n }\\n ],\\n \\"OutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldType\\": \\"String\\"\\n }\\n ]\\n }\\n ],\\n \\"ComponentAssetConfigs\\": [\\n {\\n \\"FieldName\\": \\"project\\",\\n \\"FieldType\\": \\"String\\",\\n \\"FieldDescription\\": \\"project name\\",\\n \\"Required\\": false,\\n \\"Encrypted\\": false,\\n \\"DefaultValue\\": \\"1\\"\\n }\\n ],\\n \\"CreateTime\\": 1757902337000,\\n \\"UpdateTime\\": 1757902337000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"7fbb1c66d607c1f79a740f039a8dcfda\\"\\n}","type":"json"}]', 'title' => 'Get Component List', 'translator' => 'machine', ], 'CreateComponentAsset' => [ 'summary' => 'Create Component Asset.', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ComponentName', 'in' => 'formData', 'schema' => [ 'description' => 'The name of the component.', 'type' => 'string', 'required' => true, 'example' => 'SLS', ], ], [ 'name' => 'ComponentAssetName', 'in' => 'formData', 'schema' => [ 'description' => 'The name of the asset.', 'type' => 'string', 'required' => true, 'example' => 'shanghai-log-config', ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language type for receiving messages. Values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ComponentAssetValues', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'Configuration information of the asset.', 'type' => 'array', 'items' => [ 'description' => 'Information about the asset fields.', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'type' => 'string', 'required' => true, 'example' => 'endpoint', ], 'FieldValue' => [ 'description' => 'Field value.', 'type' => 'string', 'required' => true, 'example' => 'http://logs.aliyuncs.com', ], ], 'required' => false, ], 'required' => true, ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'Resource directory member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Return information.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502', ], 'ComponentAssetUuid' => [ 'description' => 'Asset UUID.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'."\n", ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\\\n\\"\\n}","type":"json"}]', 'title' => 'Create Component Asset', 'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., Threat Analysis and Response Log Ingress Traffic) before using this interface.', 'translator' => 'machine', ], 'DeleteComponentAsset' => [ 'summary' => 'Delete Component Asset.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], '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' => 'Set the language type for requests and received messages, default is **zh**. Values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'Resource directory member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], [ 'name' => 'ComponentAssetUuid', 'in' => 'formData', 'schema' => [ 'description' => 'Asset UUID.', 'type' => 'string', 'required' => true, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Return information.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\"\\n}","type":"json"}]', 'title' => 'Delete Component Asset', 'description' => 'Please ensure that before using this interface, you have fully understood the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., Threat Analysis and Response Log Access Traffic).', 'translator' => 'machine', ], 'UpdateComponentAsset' => [ 'summary' => 'Update Component Asset.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language type for the request and response. Values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ComponentAssetUuid', 'in' => 'formData', 'schema' => [ 'description' => 'Asset UUID.', 'type' => 'string', 'required' => true, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', ], ], [ 'name' => 'ComponentAssetValues', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'Configuration information of the asset.', 'type' => 'array', 'items' => [ 'description' => 'Configuration information of the asset.', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'type' => 'string', 'required' => false, 'example' => 'lh_source', ], 'FieldValue' => [ 'description' => 'Field value.', 'type' => 'string', 'required' => false, 'example' => 'device', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'Resource directory member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], [ 'name' => 'ComponentAssetName', 'in' => 'formData', 'schema' => [ 'description' => 'Asset name.', 'type' => 'string', 'required' => false, 'example' => 'test_asset', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response information.', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502', ], 'ComponentAssetUuid' => [ 'description' => 'Asset UUID.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\"\\n}","type":"json"}]', 'title' => 'Update Component Asset', 'translator' => 'machine', ], 'ListComponentAssets' => [ 'summary' => 'Get the list of assets configured for a component.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language type for requests and responses. Values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'Resource directory member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], [ 'name' => 'ComponentName', 'in' => 'formData', 'schema' => [ 'description' => 'The name of the component.', 'type' => 'string', 'required' => false, 'example' => 'SLS', ], ], [ 'name' => 'ComponentAssetUuid', 'in' => 'formData', 'schema' => [ 'description' => 'Asset UUID.', 'type' => 'string', 'required' => false, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => 'Page number for paginated queries, with a default value of 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => 'Number of items per page for paginated queries. Range: 1~100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => [ 'description' => 'Maximum number of results to return. Range: 0~100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'description' => 'Token for the next query. Value: Not required for the first query or if there is no next query. For subsequent queries, use the NextToken value returned from the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'kt0BLbenY2XCyRfsmoEcVg==', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and issue localization.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n", ], 'ComponentAssets' => [ 'description' => 'List of assets.', 'type' => 'array', 'items' => [ 'description' => 'Asset information.', 'type' => 'object', 'properties' => [ 'ComponentName' => [ 'description' => 'The name of the component.', 'type' => 'string', 'example' => 'SLS', ], 'ComponentAssetName' => [ 'description' => 'Asset name.', 'type' => 'string', 'example' => 'test', ], 'ComponentAssetUuid' => [ 'description' => 'Asset UUID.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', ], 'ComponentAssetValues' => [ 'description' => 'Configuration information of the asset.', 'type' => 'array', 'items' => [ 'description' => 'Configuration information of the asset.', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'type' => 'string', 'example' => 'lh_source', ], 'FieldValue' => [ 'description' => 'Field value.', 'type' => 'string', 'example' => 'device', ], ], ], ], 'CreateTime' => [ 'description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744078554000', ], 'UpdateTime' => [ 'description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744078554000', ], ], ], ], 'TotalCount' => [ 'description' => 'Total number of queried items.', 'type' => 'integer', 'format' => 'int32', 'example' => '824', ], 'PageNumber' => [ 'description' => 'Page number for paginated queries, with a default value of 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'The number of items to return per page. Range: 1~100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'MaxResults' => [ 'description' => 'The maximum number of results to return. Range: 0~100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'NextToken' => [ 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9', ], ], ], ], ], 'errorCodes' => [], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\\\n\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"ComponentName\\": \\"SLS\\",\\n \\"ComponentAssetName\\": \\"test\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\",\\n \\"ComponentAssetValues\\": [\\n {\\n \\"FieldName\\": \\"lh_source\\",\\n \\"FieldValue\\": \\"device\\"\\n }\\n ],\\n \\"CreateTime\\": 1744078554000,\\n \\"UpdateTime\\": 1744078554000\\n }\\n ],\\n \\"TotalCount\\": 824,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9\\"\\n}","type":"json"}]', 'title' => 'Get Component Asset List', 'translator' => 'machine', ], 'GetPlaybook' => [ 'summary' => 'Get playbook details.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language type for requests and received messages.'."\n" .'- **zh** (default): Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'The user ID for the administrator to switch to another member\'s perspective.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', 'schema' => [ 'description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx', ], ], [ 'name' => 'PlaybookVersionType', 'in' => 'formData', 'schema' => [ 'description' => 'The version type of the playbook, with the following values:'."\n" ."\n" .'- **Draft**: Editing state.'."\n" .'- **Online**: Online version.'."\n" .'- **History**: Historical version.', 'type' => 'string', 'required' => false, 'example' => 'History', ], ], [ 'name' => 'PlaybookVersion', 'in' => 'formData', 'schema' => [ 'description' => 'The version ID of the playbook, which is only effective when **PlaybookVersionType** is **History**.', 'type' => 'string', 'required' => false, 'example' => '36c9dcd6-****-4262-****-d508464ebd21', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The ID of this request, a unique identifier generated by Alibaba Cloud for the request, which can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F', ], 'Playbook' => [ 'description' => 'Configuration information of the playbook.', 'type' => 'object', 'properties' => [ 'PlaybookUuid' => [ 'description' => 'UUID of the playbook.', 'type' => 'string', 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx', ], 'PlaybookName' => [ 'description' => 'Name of the playbook, without special characters.', 'type' => 'string', 'example' => 'waftest', ], 'PlaybookDescription' => [ 'description' => 'Description of the playbook.', 'type' => 'string', 'example' => 'waf ip blocked', ], 'PlaybookParamType' => [ 'description' => 'Parameter type of the playbook, with the following values:'."\n" ."\n" .'- **template-ip**: IP entity.'."\n" .'- **template-file**: File entity.'."\n" .'- **template-process**: Process entity.'."\n" .'- **template-host**: Host entity.'."\n" .'- **template-domain**: Domain entity.'."\n" .'- **template-container**: Container entity.'."\n" .'- **template-incident**: Security incident.'."\n" .'- **template-alert**: Security alert.'."\n" .'- **custom**: Custom.', 'type' => 'string', 'example' => 'template-ip', ], 'PlaybookExtension' => [ 'description' => 'Extended information of the playbook.', 'type' => 'string', 'example' => '{"opCode":1}', ], 'PlaybookStatus' => [ 'description' => 'Publication status of the playbook, with the following values:'."\n" ."\n" .'- **0**: Unpublished.'."\n" .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PlaybookTaskFlow' => [ 'description' => 'Workflow of the playbook.', 'type' => 'string', 'example' => '[]', ], 'PlaybookVersion' => [ 'description' => 'Version number of the playbook.', 'type' => 'string', 'example' => '36c9dcd6-****-4262-****-d508464ebd21', ], 'PlaybookTaskFlowUuid' => [ 'description' => 'UUID of the playbook workflow.', 'type' => 'string', 'example' => '8ea81047-****-4481-****-fcd8557bf242', ], 'PlaybookParamsExample' => [ 'description' => 'Input example of the playbook.', 'type' => 'string', 'example' => '{"ip":"1.*.*.1"}', ], 'CreateTime' => [ 'description' => 'Creation time (in milliseconds).', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', ], 'UpdateTime' => [ 'description' => 'Update time (in milliseconds).', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', ], 'PlaybookInputConfigs' => [ 'description' => 'List of playbook input parameter configurations.', 'type' => 'array', 'items' => [ 'description' => 'Playbook input parameter configuration.', '$ref' => '#/components/schemas/FieldInputConfig', ], ], 'PlaybookOutputConfigs' => [ 'description' => 'List of playbook output parameter configurations.', 'type' => 'array', 'items' => [ 'description' => 'Playbook output parameter configuration.', '$ref' => '#/components/schemas/FieldOutputConfig', ], ], 'PlaybookType' => [ 'title' => '剧本类型', 'description' => 'Type of the playbook, with values as follows:'."\n" ."\n" .'- **preset**: Predefined playbook.'."\n" .'- **user**: Custom playbook.'."\n" .'- **component**: Security response component.', 'type' => 'string', 'example' => 'preset', ], ], ], ], ], ], ], 'errorCodes' => [], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"Playbook\\": {\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"PlaybookName\\": \\"waftest\\",\\n \\"PlaybookDescription\\": \\"waf ip blocked\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{\\\\\\"opCode\\\\\\":1}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookTaskFlow\\": \\"[]\\",\\n \\"PlaybookVersion\\": \\"36c9dcd6-****-4262-****-d508464ebd21\\",\\n \\"PlaybookTaskFlowUuid\\": \\"8ea81047-****-4481-****-fcd8557bf242\\",\\n \\"PlaybookParamsExample\\": \\"{\\\\\\"ip\\\\\\":\\\\\\"1.*.*.1\\\\\\"}\\",\\n \\"CreateTime\\": 1731378251000,\\n \\"UpdateTime\\": 1731378251000,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"FieldExample\\": \\"\\"\\n }\\n ],\\n \\"PlaybookType\\": \\"x6\\"\\n }\\n}","type":"json"}]', 'title' => 'Get Playbook Details', 'translator' => 'machine', ], 'ListPlaybooks' => [ 'summary' => 'Get Playbook List.', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'Language type for request and response messages.'."\n" .'- **zh** (default): Chinese'."\n" .'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'User ID for the administrator to switch to another member\'s perspective.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'description' => 'Page number for pagination, default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => 'Number of items per page for pagination. Range: 1~100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => [ 'description' => 'Maximum number of results returned in a single request. Range: 1~100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'description' => 'Token for the next query start.', 'type' => 'string', 'required' => false, 'example' => '7fbb1c****07c1f79a740f039a8dcfda', ], ], [ 'name' => 'PlaybookStatus', 'in' => 'formData', 'schema' => [ 'description' => 'Publication status of the playbook, with values as follows:'."\n" ."\n" .'- **0**: Unpublished.'."\n" .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PlaybookUuids', 'in' => 'formData', 'style' => 'simple', 'schema' => [ 'description' => 'Collection of UUIDs of playbooks.', 'type' => 'array', 'items' => [ 'description' => 'UUID of the playbook.', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx', ], 'deprecated' => false, 'required' => false, 'maxItems' => 1, 'minItems' => 0, ], ], [ 'name' => 'PlaybookName', 'in' => 'formData', 'schema' => [ 'description' => 'Name of the playbook, supports fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'demo_test', ], ], [ 'name' => 'PlaybookParamTypes', 'in' => 'formData', 'style' => 'simple', 'schema' => [ 'description' => 'Collection of input parameter types for the playbook.', 'type' => 'array', 'items' => [ 'description' => 'Parameter types for the playbook, with values as follows:'."\n" ."\n" .'- **template-ip**: IP entity.'."\n" .'- **template-file**: File entity.'."\n" .'- **template-process**: Process entity.'."\n" .'- **template-host**: Host entity.'."\n" .'- **template-domain**: Domain entity.'."\n" .'- **template-container**: Container entity.'."\n" .'- **template-incident**: Security incident.'."\n" .'- **template-alert**: Security alert.'."\n" .'- **custom**: Custom.', 'type' => 'string', 'required' => false, 'example' => 'template-ip', ], 'required' => false, ], ], [ 'name' => 'PlaybookExecutionStartTime', 'in' => 'formData', 'schema' => [ 'description' => 'Start time of the latest execution of the playbook.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731378251000', ], ], [ 'name' => 'PlaybookExecutionEndTime', 'in' => 'formData', 'schema' => [ 'description' => 'End time of the latest execution of the playbook.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731379251000', ], ], [ 'name' => 'OrderField', 'in' => 'formData', 'schema' => [ 'description' => 'Sorting field. Values:'."\n" ."\n" .'- **UpdateTime**: Sort by update time.'."\n" .'- **ExecutionTime**: Sort by the latest execution time.', 'type' => 'string', 'required' => false, 'example' => 'UpdateTime', ], ], [ 'name' => 'Order', 'in' => 'formData', 'schema' => [ 'description' => 'Sorting logic, default is **desc**, with values as follows:'."\n" .'- **desc**: Descending order.'."\n" .'- **asc**: Ascending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', ], ], [ 'name' => 'PlaybookType', 'in' => 'formData', 'schema' => [ 'description' => 'Type of the playbook, with values as follows:'."\n" ."\n" .'- **preset**: Predefined playbook.'."\n" .'- **user**: Custom playbook.'."\n" .'- **component**: Security response component.', 'type' => 'string', 'required' => false, 'example' => 'preset', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'The unique identifier generated by Alibaba Cloud for this request, which can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73', ], 'Playbooks' => [ 'description' => 'List of playbooks.', 'type' => 'array', 'items' => [ 'description' => 'Information about the playbook.', 'type' => 'object', 'properties' => [ 'PlaybookUuid' => [ 'description' => 'UUID of the playbook.', 'type' => 'string', 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx', ], 'PlaybookName' => [ 'description' => 'Name of the playbook.', 'type' => 'string', 'example' => 'system_aliyun_alb_process_book', ], 'PlaybookDescription' => [ 'description' => 'Description of the playbook.', 'type' => 'string', 'example' => 'alb block', ], 'PlaybookType' => [ 'description' => 'Type of the playbook, with values as follows:'."\n" ."\n" .'- **preset**: Predefined playbook.'."\n" .'- **user**: Custom playbook.'."\n" .'- **component**: Security response component.', 'type' => 'string', 'example' => 'user', ], 'PlaybookParamType' => [ 'description' => 'The parameter type of the playbook, with values as follows:'."\n" ."\n" .'- **template-ip**: IP entity.'."\n" .'- **template-file**: File entity.'."\n" .'- **template-process**: Process entity.'."\n" .'- **template-host**: Host entity.'."\n" .'- **template-domain**: Domain entity.'."\n" .'- **template-container**: Container entity.'."\n" .'- **template-incident**: Security incident.'."\n" .'- **template-alert**: Security alert.'."\n" .'- **custom**: Custom.', 'type' => 'string', 'example' => 'template-ip', ], 'PlaybookExtension' => [ 'description' => 'Extended information of the playbook.', 'type' => 'string', 'example' => '{}', ], 'PlaybookStatus' => [ 'description' => 'The publication status of the playbook, with values as follows:'."\n" ."\n" .'- **0**: Unpublished.'."\n" .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PlaybookInputConfigs' => [ 'description' => 'List of input parameter configurations for the playbook.', 'type' => 'array', 'items' => [ 'description' => 'Input parameter configuration for the playbook.', '$ref' => '#/components/schemas/FieldInputConfig', ], ], 'PlaybookOutputConfigs' => [ 'description' => 'List of output parameter configurations for the playbook.', 'type' => 'array', 'items' => [ 'description' => 'Output parameter configuration for the playbook.', '$ref' => '#/components/schemas/FieldOutputConfig', ], ], 'CreateTime' => [ 'description' => 'Creation time (in milliseconds).', 'type' => 'integer', 'format' => 'int64', 'example' => '1667792399000', ], 'UpdateTime' => [ 'description' => 'Update time (in milliseconds).', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', ], ], ], ], 'TotalCount' => [ 'description' => 'Total number of items found.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'PageNumber' => [ 'description' => 'Current page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => 'Number of items per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'MaxResults' => [ 'description' => 'Maximum number of results allowed to be returned. Range: 0~100.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'NextToken' => [ 'description' => 'Token for the start of the next page query.', 'type' => 'string', 'example' => '7fbb1c****07c1f79a740f039a8dcfda', ], ], ], ], ], 'errorCodes' => [], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Playbooks\\": [\\n {\\n \\"PlaybookUuid\\": \\"bb5a8640-a14f-44ef-8376-cxxxxx\\",\\n \\"PlaybookName\\": \\"system_aliyun_alb_process_book\\",\\n \\"PlaybookDescription\\": \\"alb block\\",\\n \\"PlaybookType\\": \\"user\\",\\n \\"PlaybookParamType\\": \\"template-ip\\",\\n \\"PlaybookExtension\\": \\"{}\\",\\n \\"PlaybookStatus\\": 1,\\n \\"PlaybookInputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": true,\\n \\"Arrayed\\": true,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"PlaybookOutputConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"FieldExample\\": \\"\\"\\n }\\n ],\\n \\"CreateTime\\": 1667792399000,\\n \\"UpdateTime\\": 1731378251000\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 50,\\n \\"NextToken\\": \\"7fbb1c****07c1f79a740f039a8dcfda\\"\\n}","type":"json"}]', 'title' => 'Query Playbook List', 'translator' => 'machine', ], 'CreatePlaybook' => [ 'summary' => 'Create Playbook.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'Language type for receiving messages. Values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'Resource directory member account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '170*********3093', ], ], [ 'name' => 'PlaybookName', 'in' => 'formData', 'schema' => [ 'description' => 'Name of the playbook, without special characters.', 'type' => 'string', 'required' => true, 'example' => 'waftest', 'maxLength' => 128, 'minLength' => 2, ], ], [ 'name' => 'PlaybookDescription', 'in' => 'formData', 'schema' => [ 'description' => 'Description of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'waf ip block', 'maxLength' => 512, 'minLength' => 0, ], ], [ 'name' => 'PlaybookInputConfigs', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'Input parameter configuration of the playbook.', 'type' => 'array', 'items' => [ 'description' => 'Input parameter configuration.', 'required' => false, '$ref' => '#/components/schemas/FieldInputConfig', ], 'required' => false, ], ], [ 'name' => 'PlaybookOutputConfigs', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'Output parameter configuration of the playbook.', 'type' => 'array', 'items' => [ 'description' => 'Output parameter configuration.', 'required' => false, '$ref' => '#/components/schemas/FieldOutputConfig', ], 'required' => false, ], ], [ 'name' => 'SrcPlaybookUuid', 'in' => 'formData', 'schema' => [ 'description' => 'In a copy scenario, the UUID of the source playbook needs to be filled in. When this parameter has a value, all other parameters except the playbook name and description are invalid.', 'type' => 'string', 'required' => false, 'example' => '1B5A9144-****-****-A466-****9D64AA99', ], ], [ 'name' => 'PlaybookTaskFlow', 'in' => 'formData', 'schema' => [ 'description' => 'Workflow of the playbook.', 'type' => 'string', 'required' => false, 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]', ], ], [ 'name' => 'PlaybookParamType', 'in' => 'formData', 'schema' => [ 'title' => '剧本参数类型', 'description' => 'Type of input parameters for the playbook.'."\n" ."\n" .'- **template-ip**: IP entity.'."\n" .'- **template-file**: File entity.'."\n" .'- **template-process**: Process entity.'."\n" .'- **template-host**: Host entity.'."\n" .'- **template-domain**: Domain entity.'."\n" .'- **template-container**: Container entity.'."\n" .'- **template-incident**: Security incident.'."\n" .'- **template-alert**: Security alert.'."\n" .'- **custom**: Custom.', 'type' => 'string', 'required' => false, 'example' => 'custom', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '007BC211-709E-549B-9534-4C8EA0922828', ], 'PlaybookUuid' => [ 'description' => 'UUID of the playbook.', 'type' => 'string', 'example' => 'e99dab31-499b-4307-9248-xxxxxx', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"007BC211-709E-549B-9534-4C8EA0922828\\",\\n \\"PlaybookUuid\\": \\"e99dab31-499b-4307-9248-xxxxxx\\"\\n}","type":"json"}]', 'title' => 'Create Playbook', 'translator' => 'machine', ], 'DeletePlaybook' => [ 'summary' => 'Delete Playbook.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language type for requests and received messages. Values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'User ID for the administrator to switch to another member\'s perspective.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', 'schema' => [ 'description' => 'UUID of the playbook.', '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' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]', 'title' => 'Delete Playbook', 'translator' => 'machine', ], 'UpdatePlaybook' => [ 'summary' => 'Update Playbook.', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'description' => 'The language type for requests and received messages. Values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => [ 'description' => 'The user ID for the administrator to switch to another member\'s perspective.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', ], ], [ 'name' => 'PlaybookName', 'in' => 'formData', 'schema' => [ 'description' => 'The name of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'system_aliyun_alb_process_book', ], ], [ 'name' => 'PlaybookDescription', 'in' => 'formData', 'schema' => [ 'description' => 'Description of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'alb block', ], ], [ 'name' => 'PlaybookInputConfigs', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of input parameter configurations for the playbook.', 'type' => 'array', 'items' => [ 'description' => 'Input parameter configuration for the playbook.', 'required' => false, '$ref' => '#/components/schemas/FieldInputConfig', ], 'required' => false, ], ], [ 'name' => 'PlaybookOutputConfigs', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of output parameter configurations for the playbook.', 'type' => 'array', 'items' => [ 'description' => 'Output parameter configuration for the playbook.', 'required' => false, '$ref' => '#/components/schemas/FieldOutputConfig', ], 'required' => false, ], ], [ 'name' => 'PlaybookTaskFlow', 'in' => 'formData', 'schema' => [ 'description' => 'Content of the playbook.', 'type' => 'string', 'required' => false, 'example' => '[{"id":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4","zIndex":1,"data":{"nodeType":"startEvent","appType":"basic","nodeName":"start","icon":"icon-circle","description":"start"},"position":{"x":-440,"y":-170}},{"id":"5293c3f9-e1c9-4a49-b0eb-635067dc67e8","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"},"target":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"vertices":[]},{"id":"317dd1be-2d20-460e-977e-1fc936ffb583","zIndex":1,"data":{"nodeType":"endEvent","appType":"basic","nodeName":"end","icon":"icon-radio-off-full","description":"end"},"position":{"x":-140,"y":-170}},{"id":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2","zIndex":1,"data":{"isDebug":false,"nodeType":"action","appType":"component","nodeName":"data","valueData":{"outputFields":"[{\\"fieldName\\":\\"ip\\",\\"fieldValue\\":\\"${event.ip}\\"}]"},"icon":"https://img.alicdn.com/imgextra/i2/O1CN01NCKmL026m1z8o0DeN_!!6000000007703-2-tps-248-248.png","description":"","advance":{"inputParamMode":false,"onError":"stop_cur_flow","rspStatusType":3,"rspStatusThreshold":0},"componentName":"DataFormat","actionName":"formatdata"},"position":{"x":-340,"y":-185}},{"id":"1c7f0021-fb93-4478-b10f-af78dd5a69d6","zIndex":1,"data":{"nodeType":"sequenceFlow","appType":"basic","icon":"icon-upper-right-arrow","isRequired":true},"source":{"cell":"f9d6d1f5-b0cd-45b6-93d0-02cd4b2a6fa2"},"target":{"cell":"317dd1be-2d20-460e-977e-1fc936ffb583"},"vertices":[]}]', ], ], [ 'name' => 'PlaybookParamType', 'in' => 'formData', 'schema' => [ 'description' => 'Type of input parameters for the playbook.'."\n" ."\n" .'- **template-ip**: IP entity.'."\n" .'- **template-file**: File entity.'."\n" .'- **template-process**: Process entity.'."\n" .'- **template-host**: Host entity.'."\n" .'- **template-domain**: Domain entity.'."\n" .'- **template-container**: Container entity.'."\n" .'- **template-incident**: Security incident.'."\n" .'- **template-alert**: Security alert.'."\n" .'- **custom**: Custom.', 'type' => 'string', 'required' => false, 'example' => 'template-ip', ], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', 'schema' => [ 'description' => 'UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE', ], 'PlaybookUuid' => [ 'description' => 'UUID of the playbook.', 'type' => 'string', 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PlaybookUuid\\": \\"8f55e76d-b5d5-4720-9cd7-xxxxx\\"\\n}","type":"json"}]', 'title' => 'Update Playbook', 'translator' => 'machine', ], 'ExecuteComponent' => [ 'summary' => '执行组件动作', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREsas104PTS', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'PlaybookUuid', 'in' => 'formData', 'schema' => [ 'title' => '剧本的UUID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'ac343acc-1a61-4084-9a1cxxxxx', ], ], [ 'name' => 'PlayBookNodeName', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'node1', ], ], [ 'name' => 'ComponentName', 'in' => 'formData', 'schema' => [ 'title' => '组件的名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'SLS', ], ], [ 'name' => 'ComponentActionName', 'in' => 'formData', 'schema' => [ 'title' => '组件的动作名称。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => 'doRequest', ], ], [ 'name' => 'ComponentAssetUuid', 'in' => 'formData', 'schema' => [ 'title' => '资产UUID。', 'description' => '', 'type' => 'string', 'required' => false, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', ], ], [ 'name' => 'ComponentInput', 'in' => 'formData', 'schema' => [ 'description' => '', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'title' => '请求和接收消息的语言类型。取值：'."\n" ."\n" .'- **zh**（默认）：中文。'."\n" ."\n" .'- **en**：英文。', 'description' => '', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RunResult' => [ 'description' => '', 'type' => 'string', 'example' => '{'."\n" .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n" .' "content": {'."\n" .' "resultData": [],'."\n" .' "success": true'."\n" .' }'."\n" .'}', ], 'RequestId' => [ 'description' => '', 'type' => 'string', 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\",\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ [ 'regionId' => 'public', 'endpoint' => 'sophonsoar.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', ], ], ];