'1.0', 'info' => ['style' => 'RPC', 'product' => 'sophonsoar', 'version' => '2025-09-03'], 'directories' => [ [ 'children' => ['CreateComponentAsset', 'DeleteComponentAsset', 'UpdateComponentAsset', 'ListComponentAssets', 'GetPlaybook', 'ListPlaybooks', 'CreatePlaybook', 'DeletePlaybook', 'UpdatePlaybook', 'ExecuteComponent'], 'type' => 'directory', 'title' => 'Response orchestration', ], [ 'children' => ['AbortPlaybookExecution', 'ListComponents'], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [ 'FieldInputConfig' => [ 'description' => 'Configuration of input parameters.', 'type' => 'object', 'properties' => [ 'FieldName' => ['description' => 'Field name.', 'type' => 'string', 'title' => '', 'example' => ''], '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.', 'type' => 'string', 'enumValueTitles' => [], 'title' => '', 'example' => '', ], 'DefaultValue' => ['description' => 'Field default value.', 'type' => 'string', 'title' => '', 'example' => ''], 'Required' => ['description' => 'Is the field mandatory? Possible values are:'."\n" ."\n" .'- **true**: Required.'."\n" .'- **false**: Optional.', 'type' => 'boolean', 'title' => '', 'example' => ''], 'Arrayed' => ['description' => 'Is the field arrayed? Possible values are:'."\n" ."\n" .'- true: Arrayed.'."\n" .'- false: Not Arrayed.', 'type' => 'boolean', 'title' => '', 'example' => ''], 'FieldPath' => ['description' => 'Field path.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldCheckRegex' => ['description' => 'Field check regex.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldExample' => ['description' => 'Field example.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldClass' => ['description' => 'Field types, with the following values:'."\n" ."\n" .'- **normal**: Normal type.'."\n" .'- **custom**: Complex type; in this mode, FieldConfigs can be configured.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldDescription' => ['description' => 'Field description.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldConfigs' => [ 'description' => 'Supports configuring nested input parameters in complex-type scenarios.', 'type' => 'array', 'items' => ['description' => 'Configuration of input parameters.', '$ref' => '#/components/schemas/FieldInputConfig', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'FieldOutputConfig' => [ 'description' => 'Configuration of output parameters.', 'type' => 'object', 'properties' => [ 'FieldName' => [ 'description' => 'Field name.', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'title' => '', 'example' => '', ], '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.', 'type' => 'string', 'enumValueTitles' => [], 'title' => '', 'example' => '', ], 'FieldDescription' => ['description' => 'Field description information.', 'type' => 'string', 'title' => '', 'example' => ''], 'DefaultValue' => ['description' => 'Field default value.', 'type' => 'string', 'title' => '', 'example' => ''], 'FieldExample' => ['description' => 'Field example.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], ], 'apis' => [ 'AbortPlaybookExecution' => [ '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' => 'Lang', 'in' => 'formData', 'schema' => ['description' => 'The language type for receiving messages. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The User ID of a member whose perspective an administrator switches to.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'RoleType', 'in' => 'formData', 'schema' => ['description' => 'The view type. Valid values:'."\n" ."\n" .'- **0**: View of the current Alibaba Cloud account.'."\n" .'- **1**: View of all accounts under the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'PlaybookExecutionUuid', 'in' => 'formData', 'schema' => ['description' => 'The playbook execution ID.', 'type' => 'string', 'required' => true, 'example' => 'e776dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response information.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of this request, which is a Unique Identifier (UUID) generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues.', 'title' => '', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n"], 'Success' => ['description' => 'Indicates whether the job was stopped successfully. Valid values:'."\n" ."\n" .'- *true*: The job was stopped successfully.'."\n" .'- *false*: The job was not stopped successfully.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Stop Playbook Execution', 'summary' => 'Stop the execution of a playbook and its sub-playbooks.', 'description' => 'Before using this API, make sure you fully understand the billing method of Response Orchestration and its [pricing](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"}]', 'translator' => 'machine', ], 'CreateComponentAsset' => [ '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', 'title' => ''], ], [ 'name' => 'ComponentAssetName', 'in' => 'formData', 'schema' => ['description' => 'The asset name.', 'type' => 'string', 'required' => true, 'example' => 'shanghai-log-config', 'title' => ''], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => ['description' => 'The language of the response. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'ComponentAssetValues', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'The configuration information of the asset.', 'type' => 'array', 'items' => [ 'description' => 'The asset field information.', 'type' => 'object', 'properties' => [ 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'endpoint', 'title' => ''], 'FieldValue' => ['description' => 'The field value.', 'type' => 'string', 'required' => true, 'example' => 'http://logs.aliyuncs.com', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The ID of the member account in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'], 'ComponentAssetUuid' => ['description' => 'The UUID of the asset.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557'."\n", 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create an asset', 'summary' => 'Creates an asset for a component.', 'description' => 'Make sure that you are familiar with the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Cloud Threat Detection and Response (CTDR) log ingestion before you call this operation.', 'changeSet' => [], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\\\n\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'CreatePlaybook' => [ 'summary' => 'Create a 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 receiving messages. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The member account ID in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '170*********3093', 'title' => ''], ], [ 'name' => 'PlaybookName', 'in' => 'formData', 'schema' => ['description' => 'The name of the playbook. Special characters are not allowed.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 2, 'example' => 'waftest', 'title' => ''], ], [ 'name' => 'PlaybookDescription', 'in' => 'formData', 'schema' => ['description' => 'The description of the playbook.', 'type' => 'string', 'maxLength' => 512, 'minLength' => 0, 'required' => false, 'example' => 'waf ip block', 'title' => ''], ], [ 'name' => 'PlaybookInputConfigs', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'The input parameter configurations of the playbook.', 'type' => 'array', 'items' => ['description' => 'The input parameter configuration.', '$ref' => '#/components/schemas/FieldInputConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'PlaybookOutputConfigs', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'The output parameter configurations of the playbook.', 'type' => 'array', 'items' => ['description' => 'The output parameter configuration.', '$ref' => '#/components/schemas/FieldOutputConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'SrcPlaybookUuid', 'in' => 'formData', 'schema' => ['description' => 'The UUID of the source playbook to be specified in the copy scenario. When this parameter has a value, all other parameters except the playbook name and playbook description are ignored.', 'type' => 'string', 'required' => false, 'example' => '1B5A9144-****-****-A466-****9D64AA99', 'title' => ''], ], [ 'name' => 'PlaybookTaskFlow', 'in' => 'formData', 'schema' => ['description' => 'The 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":[]}]', 'title' => ''], ], [ 'name' => 'PlaybookParamType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The parameter type of the playbook. Valid 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' => 'custom', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of this request, which is a unique identifier generated by Alibaba Cloud for this request. It can be used for troubleshooting and problem locating.', 'type' => 'string', 'example' => '007BC211-709E-549B-9534-4C8EA0922828'], 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => 'e99dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create a playbook', 'changeSet' => [], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"007BC211-709E-549B-9534-4C8EA0922828\\",\\n \\"PlaybookUuid\\": \\"e99dab31-499b-4307-9248-xxxxxx\\"\\n}","type":"json"}]', 'translator' => 'machine', ], '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' => 'The language of the request and response. Default value: **zh**. Valid values:'."\n" ."\n" .'- **zh**: Chinese'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The ID of the member account in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'ComponentAssetUuid', 'in' => 'formData', 'schema' => ['description' => 'The UUID of the asset.', 'type' => 'string', 'required' => true, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a component asset', 'summary' => 'Deletes a component asset.', 'description' => 'Make sure that you are fully aware of the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Cloud Threat Detection and Response (CTDR) log traffic before you call this operation.', 'changeSet' => [], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'DeletePlaybook' => [ '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 of the request and response. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The ID of the user to whom the administrator switches the view.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.', 'type' => 'string', 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a playbook', 'summary' => 'Deletes a specified custom playbook.', 'changeSet' => [], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'ExecuteComponent' => [ 'summary' => 'Runs a component in a playbook and returns the execution result of the component.', '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' => '', 'description' => 'The UUID of the playbook.'."\n" .'>You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'example' => 'ac343acc-1a61-4084-9a1cxxxxx', 'required' => false], ], [ 'name' => 'PlayBookNodeName', 'in' => 'formData', 'schema' => ['description' => 'The node name of the current component in the playbook.', 'type' => 'string', 'required' => false, 'example' => 'node1', 'title' => ''], ], [ 'name' => 'ComponentName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the component.', 'type' => 'string', 'example' => 'SLS', 'required' => false], ], [ 'name' => 'ComponentActionName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The action name of the component.', 'type' => 'string', 'required' => false, 'example' => 'doRequest'], ], [ 'name' => 'ComponentAssetUuid', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The UUID of the asset.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'required' => false], ], [ 'name' => 'ComponentInput', 'in' => 'formData', 'schema' => ['description' => 'The input parameters of the component.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'Lang', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The language of the request and response. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'zh', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RunResult' => ['description' => 'The execution result of the component.', 'type' => 'string', 'example' => '{'."\n" .' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n" .' "content": {'."\n" .' "resultData": [],'."\n" .' "success": true'."\n" .' }'."\n" .'}', 'title' => ''], 'RequestId' => ['description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.', 'type' => 'string', 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Run a component', 'description' => 'Make sure that you are familiar with the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Cloud Threat Detection and Response (CTDR) before you call this operation.', '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"}]', '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 requesting and receiving messages.'."\n" .'- **zh** (default): Chinese.'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The user ID used by an administrator to switch to the perspective of another member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'e99dab31-499b-4307-9248-xxxxxx', 'title' => ''], ], [ 'name' => 'PlaybookVersionType', 'in' => 'formData', 'schema' => ['description' => 'The version type of the playbook. Valid values:'."\n" ."\n" .'- **Draft**: Draft version.'."\n" .'- **Online**: Online version.'."\n" .'- **History**: Historical version.', 'type' => 'string', 'required' => false, 'example' => 'History', 'title' => ''], ], [ 'name' => 'PlaybookVersion', 'in' => 'formData', 'schema' => ['description' => 'The version ID of the playbook. This parameter takes effect only when **PlaybookVersionType** is set to **History**.', 'type' => 'string', 'required' => false, 'example' => '36c9dcd6-****-4262-****-d508464ebd21', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for this request. It can be used for troubleshooting.', 'type' => 'string', 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F', 'title' => ''], 'Playbook' => [ 'description' => 'The configuration information of the playbook.', 'type' => 'object', 'properties' => [ 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx', 'title' => ''], 'PlaybookName' => ['description' => 'The name of the playbook, which does not contain special characters.', 'type' => 'string', 'example' => 'waftest', 'title' => ''], 'PlaybookDescription' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'waf ip blocked', 'title' => ''], 'PlaybookParamType' => ['description' => 'The parameter type of the playbook. Valid 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', 'title' => ''], 'PlaybookExtension' => ['description' => 'The extension information of the playbook.', 'type' => 'string', 'example' => '{"opCode":1}', 'title' => ''], 'PlaybookStatus' => ['description' => 'The publishing status of the playbook. Valid values:'."\n" ."\n" .'- **0**: Unpublished.'."\n" .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PlaybookTaskFlow' => ['description' => 'The workflow of the playbook.', 'type' => 'string', 'example' => '[]', 'title' => ''], 'PlaybookVersion' => ['description' => 'The version number of the playbook.', 'type' => 'string', 'example' => '36c9dcd6-****-4262-****-d508464ebd21', 'title' => ''], 'PlaybookTaskFlowUuid' => ['description' => 'The UUID of the playbook workflow.', 'type' => 'string', 'example' => '8ea81047-****-4481-****-fcd8557bf242', 'title' => ''], 'PlaybookParamsExample' => ['description' => 'The input example of the playbook.', 'type' => 'string', 'example' => '{"ip":"1.*.*.1"}', 'title' => ''], 'CreateTime' => ['description' => 'The creation time, in millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', 'title' => ''], 'UpdateTime' => ['description' => 'The update time, in millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', 'title' => ''], 'PlaybookInputConfigs' => [ 'description' => 'The list of input parameter configurations of the playbook.', 'type' => 'array', 'items' => ['description' => 'The input parameter configuration of the playbook.', '$ref' => '#/components/schemas/FieldInputConfig', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'PlaybookOutputConfigs' => [ 'description' => 'The list of output parameter configurations of the playbook.', 'type' => 'array', 'items' => ['description' => 'The output parameter configuration of the playbook.', '$ref' => '#/components/schemas/FieldOutputConfig', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'PlaybookType' => ['title' => '', 'description' => 'The type of the playbook. Valid values:'."\n" ."\n" .'- **preset**: Predefined playbook.'."\n" .'- **user**: Custom playbook.'."\n" .'- **component**: Security disposition component.', 'type' => 'string', 'example' => 'x6'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Get playbook details', 'changeSet' => [], 'ramActions' => [], 'translator' => 'machine', '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\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\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"}]', ], 'ListComponentAssets' => [ '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 messages. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The ID of the member account in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'ComponentName', 'in' => 'formData', 'schema' => ['description' => 'The name of the component.', 'type' => 'string', 'required' => false, 'example' => 'SLS', 'title' => ''], ], [ 'name' => 'ComponentAssetUuid', 'in' => 'formData', 'schema' => ['description' => 'The UUID of the asset.', 'type' => 'string', 'required' => false, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['description' => 'The page number for paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page for paging query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The maximum number of results to return. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The pagination token for the next query. You do not need to specify this parameter for the first query or if no more results exist. If more results exist, set this parameter to the NextToken value returned by the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'kt0BLbenY2XCyRfsmoEcVg==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n", 'title' => ''], 'ComponentAssets' => [ 'description' => 'The list of assets.', 'type' => 'array', 'items' => [ 'description' => 'The asset information.', 'type' => 'object', 'properties' => [ 'ComponentName' => ['description' => 'The name of the component.', 'type' => 'string', 'example' => 'SLS', 'title' => ''], 'ComponentAssetName' => ['description' => 'The name of the asset.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'ComponentAssetUuid' => ['description' => 'The UUID of the asset.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], 'ComponentAssetValues' => [ 'description' => 'The configuration information of the asset.', 'type' => 'array', 'items' => [ 'description' => 'The configuration information of the asset.', 'type' => 'object', 'properties' => [ 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'lh_source', 'title' => ''], 'FieldValue' => ['description' => 'The field value.', 'type' => 'string', 'example' => 'device', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744078554000', 'title' => ''], 'UpdateTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1744078554000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '824', 'title' => ''], 'PageNumber' => ['description' => 'The page number for paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page for paging query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of results to return. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'NextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'eyJxdW90YUFjdGlvbkNvZGUiOiJmX2hoODNybiJ9', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve asset list of a component', 'summary' => 'Retrieves the list of assets associated with a component.', '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"}]', 'translator' => 'machine', ], 'ListComponents' => [ '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 messages. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The ID of the resource directory member accounts.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'ComponentName', 'in' => 'formData', 'schema' => ['description' => 'The name of the component.', 'type' => 'string', 'required' => false, 'example' => 'SLS', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['description' => 'The page number for paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page in the paging query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The maximum number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token for the next page query.', 'type' => 'string', 'required' => false, 'example' => 'kt0BLbenY2XCyRfsmoEcVg=='."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '52', 'title' => ''], 'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'."\n", 'title' => ''], 'Components' => [ 'description' => 'The list of components.', 'type' => 'array', 'items' => [ 'description' => 'The component information.', 'type' => 'object', 'properties' => [ 'ComponentName' => ['description' => 'The name of the component.', 'type' => 'string', 'example' => 'SLS', 'title' => ''], 'ComponentAlias' => ['description' => 'The alias of the component.', 'type' => 'string', 'example' => 'Log', 'title' => ''], 'ComponentDescription' => ['description' => 'The description of the component.', 'type' => 'string', 'example' => 'Log query', 'title' => ''], 'ComponentLogo' => ['description' => 'The icon URL of the component.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i1/O1CN01qBUIqk22YyEBQDsha_!!6000000007133-55-tps-200-200.svg', 'title' => ''], 'ComponentExtension' => ['description' => 'The extension information of the component.', 'type' => 'string', 'example' => '{"type":"common"}', 'title' => ''], 'ComponentActions' => [ 'description' => 'The list of component actions.', 'type' => 'array', 'items' => [ 'description' => 'The component action.', 'type' => 'object', 'properties' => [ 'ComponentActionName' => ['description' => 'The name of the component action.', 'type' => 'string', 'example' => 'QueryLogs', 'title' => ''], 'ComponentActionDescription' => ['description' => 'The description of the component action name.', 'type' => 'string', 'example' => 'Query logs from SLS', 'title' => ''], 'InputConfigs' => [ 'description' => 'The input parameter settings of the action.', 'type' => 'array', 'items' => [ 'description' => 'The input parameter of the action.', 'type' => 'object', 'properties' => [ 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'Project', 'title' => ''], 'FieldType' => ['description' => 'The field type. Valid values:'."\n" ."\n" .'- **String**: string.'."\n" .'- **Long**: long integer.'."\n" .'- **Integer**: integer.'."\n" .'- **Double**: floating-point.'."\n" .'- **Boolean**: Boolean.'."\n" .'- **Complex**: key-value pair.', 'type' => 'string', 'example' => 'String', 'title' => ''], 'FieldDescription' => ['description' => 'The description of the field.', 'type' => 'string', 'example' => 'Project Name', 'title' => ''], 'FieldDisplayConfig' => ['description' => 'The display configuration of the field.', 'type' => 'string', 'example' => '{'."\n" .' "height": 200,'."\n" .' "theme": "vs-light",'."\n" .' "language": "markdown",'."\n" .' "editorOptions": {}'."\n" .'}', 'title' => ''], 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Required' => ['description' => 'Indicates whether the parameter is required.'."\n" ."\n" .'- **true**: required.'."\n" .'- **false**: not required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'OutputConfigs' => [ 'description' => 'The output parameter settings of the action.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'lh_source', 'title' => ''], 'FieldType' => ['description' => 'The field type. Valid values:'."\n" ."\n" .'- **String**: string.'."\n" .'- **Long**: long integer.'."\n" .'- **Integer**: integer.'."\n" .'- **Double**: floating-point.'."\n" .'- **Boolean**: Boolean.'."\n" .'- **Complex**: key-value pair.', 'type' => 'string', 'example' => 'String', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ComponentAssetConfigs' => [ 'description' => 'The list of asset field configurations.', 'type' => 'array', 'items' => [ 'description' => 'The asset field configuration.', 'type' => 'object', 'properties' => [ 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'example' => 'project', 'title' => ''], 'FieldType' => ['description' => 'The field type. Valid values:'."\n" ."\n" .'- **String**: string.'."\n" .'- **Long**: long integer.'."\n" .'- **Integer**: integer.'."\n" .'- **Double**: floating-point.'."\n" .'- **Boolean**: Boolean.'."\n" .'- **Complex**: key-value pair.', 'type' => 'string', 'example' => 'String', 'title' => ''], 'FieldDescription' => ['description' => 'The description of the field.', 'type' => 'string', 'example' => 'project name', 'title' => ''], 'Required' => ['description' => 'Indicates whether the parameter is required.'."\n" ."\n" .'- **true**: required.'."\n" .'- **false**: not required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Encrypted' => ['description' => 'Specifies whether the field value needs to be encrypted. Valid values:'."\n" ."\n" .'- true: encrypted.'."\n" .'- false: not encrypted.'."\n" ."\n" .'Default value: false.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757902337000', 'title' => ''], 'UpdateTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757902337000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The page number for paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page in the paging query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of entries returned per request. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'NextToken' => ['description' => 'The token for the next page query.', 'type' => 'string', 'example' => '7fbb1c66d607c1f79a740f039a8dcfda', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve component list', 'summary' => 'Retrieves a list of components.', '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"}]', 'translator' => 'machine', ], 'ListPlaybooks' => [ '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 messages.'."\n" .'- **zh** (default): Chinese.'."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The user ID that the administrator wants to use to switch to the perspective of another member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['description' => 'The page number for a paginated query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page for a paginated query. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The maximum number of entries to return per request. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => '7fbb1c****07c1f79a740f039a8dcfda', 'title' => ''], ], [ 'name' => 'PlaybookStatus', 'in' => 'formData', 'schema' => ['description' => 'The publishing status of the playbook. Valid values:'."\n" ."\n" .'- **0**: Unpublished.'."\n" .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PlaybookUuids', 'in' => 'formData', 'style' => 'simple', 'schema' => [ 'description' => 'The collection of playbook UUIDs.', 'type' => 'array', 'items' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx', 'title' => ''], 'deprecated' => false, 'required' => false, 'maxItems' => 1, 'minItems' => 0, 'title' => '', 'example' => '', ], ], [ 'name' => 'PlaybookName', 'in' => 'formData', 'schema' => ['description' => 'The name of the playbook. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'demo_test', 'title' => ''], ], [ 'name' => 'PlaybookParamTypes', 'in' => 'formData', 'style' => 'simple', 'schema' => [ 'description' => 'The collection of playbook input parameter types.', 'type' => 'array', 'items' => ['description' => 'The parameter type of the playbook. Valid 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', 'required' => false, 'example' => 'template-ip', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'PlaybookExecutionStartTime', 'in' => 'formData', 'schema' => ['description' => 'The start time of the latest playbook execution.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731378251000', 'title' => ''], ], [ 'name' => 'PlaybookExecutionEndTime', 'in' => 'formData', 'schema' => ['description' => 'The end time of the latest playbook execution.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731379251000', 'title' => ''], ], [ 'name' => 'OrderField', 'in' => 'formData', 'schema' => ['description' => 'The sort field. Valid values:'."\n" ."\n" .'- **UpdateTime**: Sort by update time.'."\n" .'- **ExecutionTime**: Sort by the latest execution time.', 'type' => 'string', 'required' => false, 'example' => 'UpdateTime', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'formData', 'schema' => ['description' => 'The sort order. Default value: **desc**. Valid values:'."\n" .'- **desc**: Descending order.'."\n" .'- **asc**: Ascending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'PlaybookType', 'in' => 'formData', 'schema' => ['description' => 'The playbook type. Valid values:'."\n" ."\n" .'- **preset**: Predefined playbook.'."\n" .'- **user**: Custom playbook.'."\n" .'- **component**: Security disposition component.', 'type' => 'string', 'required' => false, 'example' => 'preset', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. It can be used to troubleshoot issues.', 'type' => 'string', 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73', 'title' => ''], 'Playbooks' => [ 'description' => 'The list of playbooks.', 'type' => 'array', 'items' => [ 'description' => 'The information about the playbook.', 'type' => 'object', 'properties' => [ 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx', 'title' => ''], 'PlaybookName' => ['description' => 'The name of the playbook.', 'type' => 'string', 'example' => 'system_aliyun_alb_process_book', 'title' => ''], 'PlaybookDescription' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'alb block', 'title' => ''], 'PlaybookType' => ['description' => 'The playbook type. Valid values:'."\n" ."\n" .'- **preset**: Predefined playbook.'."\n" .'- **user**: Custom playbook.'."\n" .'- **component**: Security disposition component.', 'type' => 'string', 'example' => 'user', 'title' => ''], 'PlaybookParamType' => ['description' => 'The parameter type of the playbook. Valid 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', 'title' => ''], 'PlaybookExtension' => ['description' => 'The extension information of the playbook.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'PlaybookStatus' => ['description' => 'The publishing status of the playbook. Valid values:'."\n" ."\n" .'- **0**: Unpublished.'."\n" .'- **1**: Published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PlaybookInputConfigs' => [ 'description' => 'The list of input parameter configurations of the playbook.', 'type' => 'array', 'items' => ['description' => 'The input parameter configuration of the playbook.', '$ref' => '#/components/schemas/FieldInputConfig', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'PlaybookOutputConfigs' => [ 'description' => 'The list of output parameter configurations of the playbook.', 'type' => 'array', 'items' => ['description' => 'The output parameter configuration of the playbook.', '$ref' => '#/components/schemas/FieldOutputConfig', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'CreateTime' => ['description' => 'The creation time, in milliseconds timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1667792399000', 'title' => ''], 'UpdateTime' => ['description' => 'The update time, in milliseconds timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731378251000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page in a paginated query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of results allowed to be returned. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'NextToken' => ['description' => 'The token for the start of the next page query.', 'type' => 'string', 'example' => '7fbb1c****07c1f79a740f039a8dcfda', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query playbook list', 'summary' => 'Queries the list of playbooks.', 'changeSet' => [], 'ramActions' => [], 'translator' => 'machine', '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\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\n \\"FieldPath\\": \\"\\",\\n \\"FieldCheckRegex\\": \\"\\",\\n \\"FieldExample\\": \\"\\",\\n \\"FieldClass\\": \\"\\",\\n \\"FieldDescription\\": \\"\\",\\n \\"FieldConfigs\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldType\\": \\"\\",\\n \\"DefaultValue\\": \\"\\",\\n \\"Required\\": false,\\n \\"Arrayed\\": false,\\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"}]', ], 'UpdateComponentAsset' => [ '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 of the request and response messages. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'ComponentAssetUuid', 'in' => 'formData', 'schema' => ['description' => 'The asset UUID.', 'type' => 'string', 'required' => true, 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], ], [ 'name' => 'ComponentAssetValues', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'The configuration information of the asset.', 'type' => 'array', 'items' => [ 'description' => 'The configuration information of the asset.', 'type' => 'object', 'properties' => [ 'FieldName' => ['description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => 'lh_source', 'title' => ''], 'FieldValue' => ['description' => 'The field value.', 'type' => 'string', 'required' => false, 'example' => 'device', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The member account ID in the resource directory.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'ComponentAssetName', 'in' => 'formData', 'schema' => ['description' => 'The asset name.', 'type' => 'string', 'required' => false, 'example' => 'test_asset', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier that Alibaba Cloud generates for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0727DAC8-****-51EC-****-14999C62B502'], 'ComponentAssetUuid' => ['description' => 'The asset UUID.', 'type' => 'string', 'example' => '1C5F11E9-****-51F0-****-43BB312A0557', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateComponentAsset', 'summary' => 'Updates a component asset.', 'changeSet' => [], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0727DAC8-****-51EC-****-14999C62B502\\",\\n \\"ComponentAssetUuid\\": \\"1C5F11E9-****-51F0-****-43BB312A0557\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'UpdatePlaybook' => [ '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 of the request and response. Valid values:'."\n" ."\n" .'- **zh** (default): Chinese.'."\n" ."\n" .'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], [ 'name' => 'RoleFor', 'in' => 'formData', 'schema' => ['description' => 'The user ID of the member to which the administrator switches the view.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''], ], [ 'name' => 'PlaybookName', 'in' => 'formData', 'schema' => ['description' => 'The name of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'system_aliyun_alb_process_book', 'title' => ''], ], [ 'name' => 'PlaybookDescription', 'in' => 'formData', 'schema' => ['description' => 'The description of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'alb block', 'title' => ''], ], [ 'name' => 'PlaybookInputConfigs', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The list of input parameter settings of the playbook.', 'type' => 'array', 'items' => ['description' => 'The input parameter settings of the playbook.', '$ref' => '#/components/schemas/FieldInputConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'PlaybookOutputConfigs', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The list of output parameter settings of the playbook.', 'type' => 'array', 'items' => ['description' => 'The output parameter settings of the playbook.', '$ref' => '#/components/schemas/FieldOutputConfig', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'PlaybookTaskFlow', 'in' => 'formData', 'schema' => ['description' => 'The 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":[]}]', 'title' => ''], ], [ 'name' => 'PlaybookParamType', 'in' => 'formData', 'schema' => ['description' => 'The input parameter type of the playbook. Valid 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 name entity.'."\n" .'- **template-container**: container entity.'."\n" .'- **template-incident**: security event.'."\n" .'- **template-alert**: security alert.'."\n" .'- **custom**: custom.', 'type' => 'string', 'required' => false, 'example' => 'template-ip', 'title' => ''], ], [ 'name' => 'PlaybookUuid', 'in' => 'formData', 'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE'], 'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Update a playbook', 'summary' => 'Updates a playbook.', 'changeSet' => [], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PlaybookUuid\\": \\"8f55e76d-b5d5-4720-9cd7-xxxxx\\"\\n}","type":"json"}]', 'translator' => 'machine', ], ], 'endpoints' => [ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'vpc' => 'sophonsoar-vpc.ap-southeast-1.aliyuncs.com'], ['regionId' => 'public', 'regionName' => 'Public network', 'areaId' => 'other', 'areaName' => 'Other', 'public' => 'sophonsoar.aliyuncs.com', 'endpoint' => 'sophonsoar.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'Component.External.NotExist', 'message' => 'Component does not exist.', 'http_code' => 400, 'description' => 'Component does not exist.'], ['code' => 'ComponentAsset.External.NotExist', 'message' => 'The component asset is not exist.', 'http_code' => 400, 'description' => 'The asset corresponding to the component you entered does not exist. Please enter it again.'], ['code' => 'Playbook.Abnormal.ERROR', 'message' => 'Interface call exception, please contact the developer.', 'http_code' => 400, 'description' => ''], ['code' => 'Playbook.External.AccountError', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => 'Parameter error. Please login with an buy user account. Verify the provided parameters and try again.'], ['code' => 'Playbook.External.DebugError', 'message' => 'Debugging the script failed. Please verify whether the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => ''], ['code' => 'Playbook.External.InvalidParameter', 'message' => 'The request parameter is incorrect. Please verify the provided parameters and try again.', 'http_code' => 400, 'description' => 'The request parameter is incorrect. Please verify the provided parameters and try again.'], ['code' => 'Playbook.External.ParamError', 'message' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'http_code' => 400, 'description' => 'The parameters of the request interface are incorrect. Please verify the parameters and request again.'], ['code' => 'Playbook.External.PublishError', 'message' => 'Failed to publish or run the script. Please verify that the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => 'Failed to publish or run the script. Please check whether the status and configuration of the script are correct before trying again.'], ['code' => 'Playbook.External.StatusError', 'message' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.', 'http_code' => 400, 'description' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.'], ['code' => 'Playbook.Internal.MetricsError', 'message' => 'The configuration information is abnormal, please check the relevant configuration.', 'http_code' => 400, 'description' => 'The configuration information is abnormal. You are requested to check the configuration.'], ['code' => 'Playbook.Internal.RecordError', 'message' => 'The data format is abnormal, please check whether the data format meets the requirements.', 'http_code' => 400, 'description' => 'The data format is abnormal. Check whether the data format meets the requirements.'], ['code' => 'SYS_ERROR', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => 'The parameter is incorrect. Please verify the provided parameters and try again: Please use the purchase account to access.'], ], 'changeSet' => [], 'ram' => [ 'productCode' => 'ThreatDetection', 'productName' => 'Security Center', 'ramCodes' => ['threatdetection', 'yundun-aegis', 'yundun-sas'], 'ramLevel' => 'SERVICE', 'ramConditions' => [ [ 'name' => 'acs:ResourceGroupId', 'schema' => ['type' => 'String', 'description' => '资源组ID'], ], ], 'ramActions' => [], 'resourceTypes' => [], ], ];