API overview
Updated at:
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (sophonsoar/2022-07-28) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Playbook Orchestration
|
API |
Title |
Description |
| BatchModifyInstanceStatus | BatchModifyInstanceStatus | Enables or disables a batch of playbooks. |
| RunPython3Script | RunPython3Script | Executes a Python 3 code snippet for data processing. |
| ComparePlaybooks | ComparePlaybooks | Compares the configurations of two published playbook versions. |
| CreatePlaybook | CreatePlaybook | Creates a new playbook. |
| DebugPlaybook | DebugPlaybook | Debugs a playbook. |
| DeleteComponentAsset | DeleteComponentAsset | Deletes a component asset. |
| DeletePlaybook | DeletePlaybook | Deletes a specified custom playbook. |
| DescribeComponentAssetForm | DescribeComponentAssetForm | Obtains the metadata for a component asset, which defines the fields that constitute the asset. |
| DescribeComponentAssets | DescribeComponentAssets | Retrieves the asset list for a component. |
| DescribeComponentList | DescribeComponentList | Retrieves a list of standard components that you can use. |
| DescribeComponentPlaybook | DescribeComponentPlaybook | Retrieves a list of predefined components. |
| DescribeComponentsJs | DescribeComponentsJs | Obtains the JavaScript (JS) file that a component uses to render the page. |
| DescribeDistinctReleases | DescribeDistinctReleases | Retrieves a list of distinct playbook releases. |
| DescribeEnumItems | DescribeEnumItems | Queries the enumeration information for a product. |
| DescribeExecutePlaybooks | DescribeExecutePlaybooks | Queries a list of executable playbooks that are used to configure automated response plans. |
| DescribeField | DescribeField | Retrieves global configuration information for the product. |
| DescribeLatestRecordSchema | DescribeLatestRecordSchema | Describes the output structure of each node in a playbook based on the latest execution record. |
| DescribeNodeParamTags | DescribeNodeParamTags | Returns the reference paths for component inputs in a playbook orchestration. |
| DescribeNodeUsedInfos | DescribeNodeUsedInfos | Queries the nodes that reference a specific node in a playbook. |
| DescribePlaybook | DescribePlaybook | Retrieves the XML configuration of a playbook. |
| DescribePlaybookInputOutput | DescribePlaybookInputOutput | Retrieves the input and output parameter configurations for a playbook. |
| DescribePlaybookMetrics | DescribePlaybookMetrics | Queries playbook metadata, including its name, description, number of runs, and failure rate. |
| DescribePlaybookNodesOutput | DescribePlaybookNodesOutput | Retrieves the historical output data of a component. |
| DescribePlaybookNumberMetrics | DescribePlaybookNumberMetrics | Retrieves metrics for the response orchestration product, including the total number of playbooks and the number of enabled playbooks. |
| DescribePlaybookReleases | DescribePlaybookReleases | Queries a list of published versions of a playbook. |
| DescribePlaybooks | Get Playbook List | Queries a list of playbooks. |
| DescribePopApi | DescribePopApi | Retrieves the details of an OpenAPI. |
| DescribeSoarRecordActionOutputList | DescribeSoarRecordActionOutputList | Retrieves the output data generated by a component for an action in a playbook task. |
| DescribeSoarRecordInOutput | DescribeSoarRecordInOutput | Retrieves the input and output data of a component action after a playbook task is executed. |
| DescribeSoarRecords | DescribeSoarRecords | Queries the execution records for a playbook. |
| DescribeSoarTaskAndActions | DescribeSoarTaskAndActions | Retrieves the component execution records for a single playbook run. |
| DescriberPython3ScriptLogs | DescriberPython3ScriptLogs | After you submit a task for a Python 3 script, use the returned requestUuid to retrieve the operational logs. |
| ModifyComponentAsset | ModifyComponentAsset | You can call this operation to modify the asset information for a component. |
| ModifyPlaybook | ModifyPlaybook | Modifies the configuration of a playbook. |
| ModifyPlaybookInputOutput | ModifyPlaybookInputOutput | Modifies the input and output parameters of a playbook. |
| ModifyPlaybookInstanceStatus | ModifyPlaybookInstanceStatus | Starts or stops a playbook. |
| PublishPlaybook | PublishPlaybook | Publishes a playbook. Once published, the playbook runs with the new logic. |
| QueryTreeData | QueryTreeData | Retrieves a list of all playbooks. |
| RevertPlaybookRelease | RevertPlaybookRelease | Rolls back a playbook to a specified version. You can also specify whether to publish that version after the rollback. |
| TriggerPlaybook | TriggerPlaybook | Triggers an enabled custom or predefined playbook. |
| TriggerSophonPlaybook | TriggerSophonPlaybook | Triggers a playbook or responds to a command. |
| VerifyPlaybook | VerifyPlaybook | Verifies that a playbook configuration is correct and its orchestration logic is valid. |
| VerifyPythonFile | VerifyPythonFile | Verifies the syntax of a Python code snippet. |
Managing tasks
|
API |
Title |
Description |
| DescribeProcessStatistics | DescribeProcessStatistics | Retrieves statistics information. |
| DescribeProcessTasks | DescribeProcessTasks | Retrieves a list of response tasks. |
| DescribeProcessTaskCount | Query the Number of Associated Disposal Tasks by Entity UUID | Queries the count of response tasks associated with an entity UUID. |
| DescribeSophonCommands | DescribeSophonCommands | Queries the commands that are used to manage entities. |
| TriggerProcessTask | TriggerProcessTask | When an event is handled using response orchestration, the response center creates a task. Call this operation to perform follow-up actions on the task, such as unblocking, retrying a block, and removing from isolation. |
Other
|
API |
Title |
Description |
| RunNotifyComponentWithEmail | RunNotifyComponentWithEmail | Runs the notification component to send an email message. |
| RunNotifyComponentWithMessageCenter | Notification Component - Test Message Center Message Sending | Sends a message using the notification component in Message Center. |
| RunNotifyComponentWithWebhook | RunNotifyComponentWithWebhook | Sends a message from a notification component using a webhook. |
Others
|
API |
Title |
Description |
| ConvertPlaybook | Convert Playbook Flowchart Configuration Format | Convert XML configuration. |
| CopyPlaybook | CopyPlaybook | Copies a playbook. |
| DescribeGroupProductions | DescribeGroupProductions | Queries groups of Alibaba Cloud services. |
| DescribeNotifyTemplateList | DescribeNotifyTemplateList | Queries notification templates. |
| DescribeOpenApiInfo | DescribeOpenApiInfo | Queries the details of an API operation. |
| DescribeOpenApiList | DescribeOpenApiList | Queries the API operations of an Alibaba Cloud service. |
| DescribeVendorApiList | DescribeVendorApiList | Queries the API operations of a cloud service provider. |
Is this page helpful?