API overview

Last Updated At: 2026-08-02 00:04:56

API version

V3

Advanced Defense APIs

Interface name Interface function
CreateMaWorkloadLabel CreateMaWorkloadLabel
CreateProtectServer CreateProtectServer
DeleteAttackLogs DeleteAttackLogs
DeleteMaConnEvent DeleteMaConnEvent
DeleteMaCustomPolicy DeleteMaCustomPolicy
DeleteMaLabel DeleteMaLabel
DeleteMaSelfLearnPolicy DeleteMaSelfLearnPolicy
DeleteMaWhitelist DeleteMaWhitelist
DeleteProtectDir DeleteProtectDir
DeleteWebPageEventLog DeleteWebPageEventLog
DescribeAttackEventInfo DescribeAttackEventInfo
DescribeAttackEvents DescribeAttackEvents
DescribeAttackLogInfo DescribeAttackLogInfo
DescribeAttackLogs DescribeAttackLogs
DescribeAttackStatistics DescribeAttackStatistics
DescribeAttackTop DescribeAttackTop
DescribeAttackTrends DescribeAttackTrends
DescribeAttackVulTypeList DescribeAttackVulTypeList
DescribeMaConnEventList DescribeMaConnEventList
DescribeMaCustomPolicyList DescribeMaCustomPolicyList
DescribeMaGlobalConf DescribeMaGlobalConf
DescribeMaHostList DescribeMaHostList
DescribeMaLabel DescribeMaLabel
DescribeMaLabelList DescribeMaLabelList
DescribeMaLabelSourceList DescribeMaLabelSourceList
DescribeMaPodList DescribeMaPodList
DescribeMaSelfLearnConfig DescribeMaSelfLearnConfig
DescribeMaSelfLearnPolicyList DescribeMaSelfLearnPolicyList
DescribeMaSummary DescribeMaSummary
DescribeMaWhitelist DescribeMaWhitelist
DescribeMaWorkloadLabel DescribeMaWorkloadLabel
DescribeMaWorkloadList DescribeMaWorkloadList
DescribeMachineList DescribeMachineList
DescribeNetAttackSetting DescribeNetAttackSetting
DescribeProtectDirList DescribeProtectDirList
DescribeProtectDirRelatedServer DescribeProtectDirRelatedServer
DescribeServerRelatedDirInfo DescribeServerRelatedDirInfo
DescribeWebPageEventList DescribeWebPageEventList
DescribeWebPageGeneralize DescribeWebPageGeneralize
DescribeWebPageProtectStat DescribeWebPageProtectStat
DescribeWebPageServiceInfo DescribeWebPageServiceInfo
DisableSelfLearn DisableSelfLearn
ExportAttackEvents ExportAttackEvents
ExportAttackLogs ExportAttackLogs
ExportMaConnEventList ExportMaConnEventList
ExportMaCustomPolicyList ExportMaCustomPolicyList
ExportMaHostList ExportMaHostList
ExportMaPodList ExportMaPodList
ExportMaSelfLearnPolicyList ExportMaSelfLearnPolicyList
ExportMaWhitelist ExportMaWhitelist
ExportProtectDirList ExportProtectDirList
ExportWebPageEventList ExportWebPageEventList
ModifyMaConnEventType ModifyMaConnEventType
ModifyMaCustomPolicy ModifyMaCustomPolicy
ModifyMaCustomPolicyStatus ModifyMaCustomPolicyStatus
ModifyMaGlobalConf ModifyMaGlobalConf
ModifyMaLabel ModifyMaLabel
ModifyMaSelfLearnConfig ModifyMaSelfLearnConfig
ModifyMaWhitelist ModifyMaWhitelist
ModifyMaWhitelistStatus ModifyMaWhitelistStatus
ModifyMaWorkloadLabel ModifyMaWorkloadLabel
ModifyMaWorkloadMonitor ModifyMaWorkloadMonitor
ModifyMemShellRules ModifyMemShellRules
ModifyNetAttackSetting ModifyNetAttackSetting
ModifyWebPageProtectDir ModifyWebPageProtectDir
ModifyWebPageProtectSetting ModifyWebPageProtectSetting
ModifyWebPageProtectSwitch ModifyWebPageProtectSwitch

Asset Management APIs

Interface name Interface function
CreateIncidentBacktracking CreateIncidentBacktracking
DeleteCloudVendorAccountAK DeleteCloudVendorAccountAK
DeleteMachine DeleteMachine
DeleteMachineTag DeleteMachineTag
DeleteTags DeleteTags
DescribeAccountStatistics DescribeAccountStatistics
DescribeAssetAppList DescribeAssetAppList
DescribeAssetAppProcessList DescribeAssetAppProcessList
DescribeAssetCoreModuleInfo DescribeAssetCoreModuleInfo
DescribeAssetCoreModuleList DescribeAssetCoreModuleList
DescribeAssetDatabaseInfo DescribeAssetDatabaseInfo
DescribeAssetDatabaseList DescribeAssetDatabaseList
DescribeAssetHostTotalCount DescribeAssetHostTotalCount
DescribeAssetInfo DescribeAssetInfo
DescribeAssetInitServiceList DescribeAssetInitServiceList
DescribeAssetJarInfo DescribeAssetJarInfo
DescribeAssetJarList DescribeAssetJarList
DescribeAssetMachineDetail DescribeAssetMachineDetail
DescribeAssetMachineList DescribeAssetMachineList
DescribeAssetPlanTaskList DescribeAssetPlanTaskList
DescribeAssetPortInfoList DescribeAssetPortInfoList
DescribeAssetProcessInfoList DescribeAssetProcessInfoList
DescribeAssetRecentMachineInfo DescribeAssetRecentMachineInfo
DescribeAssetSystemPackageList DescribeAssetSystemPackageList
DescribeAssetUserInfo DescribeAssetUserInfo
DescribeAssetUserList DescribeAssetUserList
DescribeAssetWebAppList DescribeAssetWebAppList
DescribeAssetWebAppPluginList DescribeAssetWebAppPluginList
DescribeAssetWebFrameList DescribeAssetWebFrameList
DescribeAssetWebLocationInfo DescribeAssetWebLocationInfo
DescribeAssetWebLocationList DescribeAssetWebLocationList
DescribeAssetWebServiceInfoList DescribeAssetWebServiceInfoList
DescribeAssetWebServiceProcessList DescribeAssetWebServiceProcessList
DescribeCloudVendorAccountAKList DescribeCloudVendorAccountAKList
DescribeComponentStatistics DescribeComponentStatistics
DescribeComponents DescribeComponents
DescribeExportMachines DescribeExportMachines
DescribeHistoryAccounts DescribeHistoryAccounts
DescribeImportMachineInfo DescribeImportMachineInfo
DescribeMachineInfo DescribeMachineInfo
DescribeMachineOsList DescribeMachineOsList
DescribeMachineRegionList DescribeMachineRegionList
DescribeMachineRegions DescribeMachineRegions
DescribeMachines DescribeMachines
DescribeOpenPortStatistics DescribeOpenPortStatistics
DescribeProcessStatistics DescribeProcessStatistics
DescribeTagMachines DescribeTagMachines
DescribeTags DescribeTags
EditTags EditTags
ExportAssetCoreModuleList ExportAssetCoreModuleList
ExportAssetWebServiceInfoList ExportAssetWebServiceInfoList
ModifyMachineRemark ModifyMachineRemark
ScanAsset ScanAsset
SyncAssetScan SyncAssetScan
UpdateMachineTags UpdateMachineTags

Baseline Management APIs

Interface name Interface function
ChangeRuleEventsIgnoreStatus ChangeRuleEventsIgnoreStatus
CreateBaselineStrategy CreateBaselineStrategy
DeleteBaselineStrategy DeleteBaselineStrategy
DescribeBaselineAnalysisData DescribeBaselineAnalysisData
DescribeBaselineBasicInfo DescribeBaselineBasicInfo
DescribeBaselineDetail DescribeBaselineDetail
DescribeBaselineEffectHostList DescribeBaselineEffectHostList
DescribeBaselineHostTop DescribeBaselineHostTop
DescribeBaselineList DescribeBaselineList
DescribeBaselineRule DescribeBaselineRule
DescribeBaselineScanSchedule DescribeBaselineScanSchedule
DescribeBaselineStrategyDetail DescribeBaselineStrategyDetail
DescribeBaselineStrategyList DescribeBaselineStrategyList
DescribeBaselineTop DescribeBaselineTop
DescribeIgnoreBaselineRule DescribeIgnoreBaselineRule
DescribeIgnoreRuleEffectHostList DescribeIgnoreRuleEffectHostList
DescribeStrategyExist DescribeStrategyExist
ExportBaselineEffectHostList ExportBaselineEffectHostList
ExportBaselineList ExportBaselineList
ExportIgnoreBaselineRule ExportIgnoreBaselineRule
ExportIgnoreRuleEffectHostList ExportIgnoreRuleEffectHostList
UpdateBaselineStrategy UpdateBaselineStrategy

Baseline Management APIs (New)

Interface name Interface function
DeleteBaselinePolicy DeleteBaselinePolicy
DeleteBaselineRule DeleteBaselineRule
DeleteBaselineRuleIgnore DeleteBaselineRuleIgnore
DeleteBaselineWeakPassword DeleteBaselineWeakPassword
DescribeBaselineDetectList DescribeBaselineDetectList
DescribeBaselineDetectOverview DescribeBaselineDetectOverview
DescribeBaselineDownloadList DescribeBaselineDownloadList
DescribeBaselineFixList DescribeBaselineFixList
DescribeBaselineHostDetectList DescribeBaselineHostDetectList
DescribeBaselineHostIgnoreList DescribeBaselineHostIgnoreList
DescribeBaselineHostRiskTop DescribeBaselineHostRiskTop
DescribeBaselineItemDetectList DescribeBaselineItemDetectList
DescribeBaselineItemIgnoreList DescribeBaselineItemIgnoreList
DescribeBaselineItemInfo DescribeBaselineItemInfo
DescribeBaselineItemList DescribeBaselineItemList
DescribeBaselineItemRiskTop DescribeBaselineItemRiskTop
DescribeBaselinePolicyList DescribeBaselinePolicyList
DescribeBaselineRuleCategoryList DescribeBaselineRuleCategoryList
DescribeBaselineRuleDetectList DescribeBaselineRuleDetectList
DescribeBaselineRuleIgnoreList DescribeBaselineRuleIgnoreList
DescribeBaselineRuleList DescribeBaselineRuleList
DescribeBaselineWeakPasswordList DescribeBaselineWeakPasswordList
DescribeHotVulTop DescribeHotVulTop
DescribeIgnoreHostAndItemConfig DescribeIgnoreHostAndItemConfig
DescribeVulStoreList DescribeVulStoreList
ExportBaselineFixList ExportBaselineFixList
ExportBaselineHostDetectList ExportBaselineHostDetectList
ExportBaselineItemDetectList ExportBaselineItemDetectList
ExportBaselineItemList ExportBaselineItemList
ExportBaselineRuleDetectList ExportBaselineRuleDetectList
ExportBaselineWeakPasswordList ExportBaselineWeakPasswordList
FixBaselineDetect FixBaselineDetect
ModifyBaselinePolicy ModifyBaselinePolicy
ModifyBaselinePolicyState ModifyBaselinePolicyState
ModifyBaselineRule ModifyBaselineRule
ModifyBaselineRuleIgnore ModifyBaselineRuleIgnore
ModifyBaselineWeakPassword ModifyBaselineWeakPassword
StartBaselineDetect StartBaselineDetect
StopBaselineDetect StopBaselineDetect
SyncBaselineDetectSummary SyncBaselineDetectSummary

Expert Service APIs

Interface name Interface function
DescribeEmergencyResponseList DescribeEmergencyResponseList
DescribeMonthInspectionReport DescribeMonthInspectionReport

Intrusion Detection - APIs of Logins from Unusual Locations

Interface name Interface function
DeleteLoginWhiteList DeleteLoginWhiteList
DeleteNonlocalLoginPlaces DeleteNonlocalLoginPlaces
DescribeHostLoginList DescribeHostLoginList
DescribeLoginWhiteCombinedList DescribeLoginWhiteCombinedList
DescribeLoginWhiteList DescribeLoginWhiteList
DescribeUsualLoginPlaces DescribeUsualLoginPlaces
ExportNonlocalLoginPlaces ExportNonlocalLoginPlaces

Intrusion Detection - File Scanning and Cleaning APIs

Interface name Interface function
CreateNetAttackWhiteList CreateNetAttackWhiteList
CreateScanMalwareSetting CreateScanMalwareSetting
DeleteMalwareScanTask DeleteMalwareScanTask
DeleteMalwares DeleteMalwares
DeleteNetAttackWhiteList DeleteNetAttackWhiteList
DescribeJavaMemShellList DescribeJavaMemShellList
DescribeMalWareList DescribeMalWareList
DescribeMalwareFile DescribeMalwareFile
DescribeMalwareInfo DescribeMalwareInfo
DescribeMalwareRiskWarning DescribeMalwareRiskWarning
DescribeMalwareTimingScanSetting DescribeMalwareTimingScanSetting
DescribeNetAttackWhiteList DescribeNetAttackWhiteList
DescribeScanMalwareSchedule DescribeScanMalwareSchedule
DescribeServersAndRiskAndFirstInfo DescribeServersAndRiskAndFirstInfo
ExportMalwares ExportMalwares
ModifyMalwareTimingScanSettings ModifyMalwareTimingScanSettings
ModifyNetAttackWhiteList ModifyNetAttackWhiteList
RecoverMalwares RecoverMalwares
SeparateMalwares SeparateMalwares
TrustMalwares TrustMalwares
UntrustMalwares UntrustMalwares

Intrusion Detection - High-Risk Command APIs

Interface name Interface function
CheckBashRuleParams CheckBashRuleParams
DeleteBashEvents DeleteBashEvents
DeleteBashRules DeleteBashRules
DescribeBashEvents DescribeBashEvents
DescribeBashEventsNew DescribeBashEventsNew
DescribeBashRules DescribeBashRules
EditBashRules EditBashRules
ExportBashEvents ExportBashEvents
SetBashEventsStatus SetBashEventsStatus
SwitchBashRules SwitchBashRules

Intrusion Detection - Local Privilege Escalation APIs

Interface name Interface function
DeletePrivilegeEvents DeletePrivilegeEvents
DeletePrivilegeRules DeletePrivilegeRules
DescribePrivilegeEvents DescribePrivilegeEvents
DescribePrivilegeRules DescribePrivilegeRules
ExportPrivilegeEvents ExportPrivilegeEvents

Intrusion Detection - Malicious Request APIs

Interface name Interface function
DeleteMaliciousRequests DeleteMaliciousRequests
DescribeMaliciousRequestWhiteList DescribeMaliciousRequestWhiteList
DescribeRiskDnsList DescribeRiskDnsList
ExportMaliciousRequests ExportMaliciousRequests

Intrusion Detection - Password Cracking APIs

Interface name Interface function
DeleteBruteAttacks DeleteBruteAttacks
DescribeBanMode DescribeBanMode
DescribeBanRegions DescribeBanRegions
DescribeBanStatus DescribeBanStatus
DescribeBanWhiteList DescribeBanWhiteList
DescribeBruteAttackList DescribeBruteAttackList
DescribeBruteAttackRules DescribeBruteAttackRules
ExportBruteAttacks ExportBruteAttacks
ModifyBanMode ModifyBanMode
ModifyBanStatus ModifyBanStatus
ModifyBruteAttackRules ModifyBruteAttackRules
StopNoticeBanTips StopNoticeBanTips

Intrusion Detection - Reverse Shell APIs

Interface name Interface function
DeleteMemShellRules DeleteMemShellRules
DeleteReverseShellEvents DeleteReverseShellEvents
DeleteReverseShellRules DeleteReverseShellRules
DeleteReverseShellRulesAggregation DeleteReverseShellRulesAggregation
DescribeMemShellRules DescribeMemShellRules
DescribeReverseShellEvents DescribeReverseShellEvents
DescribeReverseShellRules DescribeReverseShellRules
DescribeReverseShellRulesAggregation DescribeReverseShellRulesAggregation
DescribeReverseShellSystemPolicyConfig DescribeReverseShellSystemPolicyConfig
DescribeShellPolicyList DescribeShellPolicyList
ExportReverseShellEvents ExportReverseShellEvents
ModifyReverseShellRulesAggregation ModifyReverseShellRulesAggregation
ModifyReverseShellSystemPolicyConfig ModifyReverseShellSystemPolicyConfig
ModifyShellPolicyStatus ModifyShellPolicyStatus

Other APIs

Interface name Interface function
CreateLoginPermissionPush CreateLoginPermissionPush
DeleteLogClsDeliverInfo DeleteLogClsDeliverInfo
DeleteScanTask DeleteScanTask
DescribeAssetEnvList DescribeAssetEnvList
DescribeClientException DescribeClientException
DescribeClsAccountStatus DescribeClsAccountStatus
DescribeClsLogsets DescribeClsLogsets
DescribeClsTopics DescribeClsTopics
DescribeCustomerDetail DescribeCustomerDetail
DescribeGeneralStat DescribeGeneralStat
DescribeLogClsDeliverInfo DescribeLogClsDeliverInfo
DescribeLogStorageConfig DescribeLogStorageConfig
DescribeLogStorageRecord DescribeLogStorageRecord
DescribeLoginPermission DescribeLoginPermission
DescribeMachineInfoByHashKey DescribeMachineInfoByHashKey
DescribeMachineLoginType DescribeMachineLoginType
DescribeMachineLoginTypeStatus DescribeMachineLoginTypeStatus
DescribeOrderList DescribeOrderList
DescribeOverviewStatistics DescribeOverviewStatistics
DescribeProVersionInfo DescribeProVersionInfo
DescribeProVersionStatus DescribeProVersionStatus
DescribeRecommendedProtectCpu DescribeRecommendedProtectCpu
DescribeScanState DescribeScanState
DescribeScanTaskDetails DescribeScanTaskDetails
DescribeSecurityDynamics DescribeSecurityDynamics
DescribeSecurityEventStat DescribeSecurityEventStat
DescribeSecurityEventsCnt DescribeSecurityEventsCnt
DescribeSecurityTrends DescribeSecurityTrends
DescribeTaskDuration DescribeTaskDuration
DescribeTrialReport DescribeTrialReport
DescribeUsersConfig DescribeUsersConfig
DescribeVersionStatistics DescribeVersionStatistics
DescribeVulTrend DescribeVulTrend
ExportScanTaskDetails ExportScanTaskDetails
ExportSecurityTrends ExportSecurityTrends
ExportTasks ExportTasks
ModifyEventAttackStatus ModifyEventAttackStatus
ModifyLogClsDeliverInfo ModifyLogClsDeliverInfo
ModifyLogClsDeliverSwitch ModifyLogClsDeliverSwitch
ModifyLogStorageConfig ModifyLogStorageConfig
ModifyMachineLoginType ModifyMachineLoginType
ModifyOrder ModifyOrder
ModifyUsersConfig ModifyUsersConfig
ModifyVulDefenceSwitch ModifyVulDefenceSwitch

Security Operations APIs

Interface name Interface function
CreateSearchLog CreateSearchLog
CreateSearchTemplate CreateSearchTemplate
DeleteSearchTemplate DeleteSearchTemplate
DescribeESAggregations DescribeESAggregations
DescribeHistoryService DescribeHistoryService
DescribeIndexList DescribeIndexList
DescribeLogStorageStatistic DescribeLogStorageStatistic
DescribeSearchExportList DescribeSearchExportList
DescribeSearchLogs DescribeSearchLogs
DescribeSearchTemplates DescribeSearchTemplates

Settings Center APIs

Interface name Interface function
CreateAgentInstallTask CreateAgentInstallTask
CreateLicenseOrder CreateLicenseOrder
DeleteLicenseRecord DeleteLicenseRecord
DescribeAgentInstallResult DescribeAgentInstallResult
DescribeAgentInstallTaskResult DescribeAgentInstallTaskResult
DescribeChangingAssetInfo DescribeChangingAssetInfo
DescribeLicenseBindList DescribeLicenseBindList
DescribeLicenseBindSchedule DescribeLicenseBindSchedule
DescribeLicenseGeneral DescribeLicenseGeneral
DescribeLicenseList DescribeLicenseList
DescribeSaveOrUpdateWarnings DescribeSaveOrUpdateWarnings
DescribeWarningList DescribeWarningList
DescribeWarningServiceIPList DescribeWarningServiceIPList
DestroyOrder DestroyOrder
ExportLicenseDetail ExportLicenseDetail
ModifyAssetsProtectionStatus ModifyAssetsProtectionStatus
ModifyAutoOpenProVersionConfig ModifyAutoOpenProVersionConfig
ModifyLicenseBinds ModifyLicenseBinds
ModifyLicenseOrder ModifyLicenseOrder
ModifyLicenseUnBinds ModifyLicenseUnBinds
ModifyOrderAttribute ModifyOrderAttribute
ModifyWarningSetting ModifyWarningSetting

Vulnerability Management APIs

Interface name Interface function
CancelIgnoreVul CancelIgnoreVul
CreateEmergencyVulScan CreateEmergencyVulScan
DescribeEmergencyVulList DescribeEmergencyVulList
DescribeInjectRiskyServiceSwitch DescribeInjectRiskyServiceSwitch
DescribeScanSchedule DescribeScanSchedule
DescribeScanVulSetting DescribeScanVulSetting
DescribeUndoVulCounts DescribeUndoVulCounts
DescribeVulCountByDates DescribeVulCountByDates
DescribeVulDefenceOverviewCount DescribeVulDefenceOverviewCount
DescribeVulDefenceSettingList DescribeVulDefenceSettingList
DescribeVulEffectHostList DescribeVulEffectHostList
DescribeVulHostCountScanTime DescribeVulHostCountScanTime
DescribeVulHostTop DescribeVulHostTop
DescribeVulInfoCvss DescribeVulInfoCvss
DescribeVulLevelCount DescribeVulLevelCount
DescribeVulList DescribeVulList
DescribeVulTop DescribeVulTop
ExportVulDetectionExcel ExportVulDetectionExcel
ExportVulDetectionReport ExportVulDetectionReport
ExportVulEffectHostList ExportVulEffectHostList
ExportVulList ExportVulList
IgnoreImpactedHosts IgnoreImpactedHosts
ModifyInjectRiskyServiceSwitch ModifyInjectRiskyServiceSwitch
ScanVul ScanVul
ScanVulAgain ScanVulAgain
ScanVulSetting ScanVulSetting